HwSpinLock: Pull in the ti.gates.hwspinlock module from omapzoom sysbios-rpmsg.
[ipc/ipcdev.git] / packages / ti / gates / hwspinlock / _HwSpinlock.h
1 /*
2  * Copyright (c) 2011-2013, Texas Instruments Incorporated
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * *  Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  *
12  * *  Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * *  Neither the name of Texas Instruments Incorporated nor the names of
17  *    its contributors may be used to endorse or promote products derived
18  *    from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 /** ============================================================================
33  *  @file       _HwSpinlock.h
34  *  ============================================================================
35  */
37 #ifndef ti_gates__HwSpinlock__include
38 #define ti_gates__HwSpinlock__include
40 #if defined (__cplusplus)
41 extern "C" {
42 #endif
44 #include <xdc/runtime/GateNull.h>
45 #include <ti/sysbios/gates/GateMutexPri.h>
46 #include <ti/sysbios/gates/GateHwi.h>
47 #include <ti/sysbios/gates/GateSwi.h>
48 #include <ti/sysbios/gates/GateTask.h>
51 /* =============================================================================
52  *  Structures & Definitions
53  * =============================================================================
54  */
56 typedef Void * (*HwSpinlock_createFxn)(IGateProvider_Params *, Error_Block *);
57 typedef Void * (*HwSpinlock_deleteFxn)(IGateProvider_Handle *);
59 /*!
60  *  @brief  HwSpinlock_PreemptGateFxn
61  */
62 typedef struct {
63     HwSpinlock_createFxn create;
64     HwSpinlock_deleteFxn delete;
65 } HwSpinlock_PreemptGateFxn;
67 /*!
68  *  @brief HwSpinlock GateFxns
69  */
70 HwSpinlock_PreemptGateFxn HwSpinlock_GateFxns[] = {
71     {(HwSpinlock_createFxn)GateNull_create,
72                                         (HwSpinlock_deleteFxn)GateNull_delete},
73     {(HwSpinlock_createFxn)GateHwi_create,
74                                         (HwSpinlock_deleteFxn)GateHwi_delete},
75     {(HwSpinlock_createFxn)GateSwi_create,
76                                         (HwSpinlock_deleteFxn)GateSwi_delete},
77     {(HwSpinlock_createFxn)GateTask_create,
78                                         (HwSpinlock_deleteFxn)GateTask_delete},
79 };
81 #ifdef DSPC674
82 #define HwSpinlock_NUMLOCKS         128
83 #define HwSpinlock_BASEADDR         0x480CA800
84 #else
85 #define HwSpinlock_NUMLOCKS         32
86 #ifdef DSP
87 #define HwSpinlock_BASEADDR         0x4A0F6800
88 #else
89 #define HwSpinlock_BASEADDR         0xAA0F6800
90 #endif
91 #endif
92 #define HwSpinlock_NUMPREEMPTGATES  (sizeof(HwSpinlock_GateFxns) / \
93                                         sizeof(HwSpinlock_PreemptGateFxn))
96 /*!
97  *  @brief  HwSpinlock_Module_State type
98  */
99 typedef struct {
100     HwSpinlock_Handle        locks[HwSpinlock_NUMLOCKS];
101 } HwSpinlock_Module_State;
103 /*!
104  *  @brief  HwSpinlock_Object type
105  */
106 struct HwSpinlock_Object {
107     HwSpinlock_Params        params;
108     volatile UInt32          *baseAddr;
109     Int                      lockNum;   /* The lock number being used */
110     HwSpinlock_PreemptGate   pType;
111     IArg                     mkey;
112     IGateProvider_Handle     preemptGates[HwSpinlock_NUMPREEMPTGATES];
113     GateMutexPri_Handle      mutex;
114     Int                      refCnt;
115     HwSpinlock_State         state;
116 };
118 #if defined (__cplusplus)
120 #endif /* defined (__cplusplus) */
122 #endif /* ti_gates__HwSpinlock__include */