xref: /utopia/UTPA2-700.0.x/modules/gpio/drv/gpio/drvGPIO_private.h (revision 53ee8cc121a030b8d368113ac3e966b4705770ef)
1 //<MStar Software>
2 //******************************************************************************
3 // MStar Software
4 // Copyright (c) 2010 - 2012 MStar Semiconductor, Inc. All rights reserved.
5 // All software, firmware and related documentation herein ("MStar Software") are
6 // intellectual property of MStar Semiconductor, Inc. ("MStar") and protected by
7 // law, including, but not limited to, copyright law and international treaties.
8 // Any use, modification, reproduction, retransmission, or republication of all
9 // or part of MStar Software is expressly prohibited, unless prior written
10 // permission has been granted by MStar.
11 //
12 // By accessing, browsing and/or using MStar Software, you acknowledge that you
13 // have read, understood, and agree, to be bound by below terms ("Terms") and to
14 // comply with all applicable laws and regulations:
15 //
16 // 1. MStar shall retain any and all right, ownership and interest to MStar
17 //    Software and any modification/derivatives thereof.
18 //    No right, ownership, or interest to MStar Software and any
19 //    modification/derivatives thereof is transferred to you under Terms.
20 //
21 // 2. You understand that MStar Software might include, incorporate or be
22 //    supplied together with third party`s software and the use of MStar
23 //    Software may require additional licenses from third parties.
24 //    Therefore, you hereby agree it is your sole responsibility to separately
25 //    obtain any and all third party right and license necessary for your use of
26 //    such third party`s software.
27 //
28 // 3. MStar Software and any modification/derivatives thereof shall be deemed as
29 //    MStar`s confidential information and you agree to keep MStar`s
30 //    confidential information in strictest confidence and not disclose to any
31 //    third party.
32 //
33 // 4. MStar Software is provided on an "AS IS" basis without warranties of any
34 //    kind. Any warranties are hereby expressly disclaimed by MStar, including
35 //    without limitation, any warranties of merchantability, non-infringement of
36 //    intellectual property rights, fitness for a particular purpose, error free
37 //    and in conformity with any international standard.  You agree to waive any
38 //    claim against MStar for any loss, damage, cost or expense that you may
39 //    incur related to your use of MStar Software.
40 //    In no event shall MStar be liable for any direct, indirect, incidental or
41 //    consequential damages, including without limitation, lost of profit or
42 //    revenues, lost or damage of data, and unauthorized system use.
43 //    You agree that this Section 4 shall still apply without being affected
44 //    even if MStar Software has been modified by MStar in accordance with your
45 //    request or instruction for your use, except otherwise agreed by both
46 //    parties in writing.
47 //
48 // 5. If requested, MStar may from time to time provide technical supports or
49 //    services in relation with MStar Software to you for your use of
50 //    MStar Software in conjunction with your or your customer`s product
51 //    ("Services").
52 //    You understand and agree that, except otherwise agreed by both parties in
53 //    writing, Services are provided on an "AS IS" basis and the warranty
54 //    disclaimer set forth in Section 4 above shall apply.
55 //
56 // 6. Nothing contained herein shall be construed as by implication, estoppels
57 //    or otherwise:
58 //    (a) conferring any license or right to use MStar name, trademark, service
59 //        mark, symbol or any other identification;
60 //    (b) obligating MStar or any of its affiliates to furnish any person,
61 //        including without limitation, you and your customers, any assistance
62 //        of any kind whatsoever, or any information; or
63 //    (c) conferring any license or right under any intellectual property right.
64 //
65 // 7. These terms shall be governed by and construed in accordance with the laws
66 //    of Taiwan, R.O.C., excluding its conflict of law rules.
67 //    Any and all dispute arising out hereof or related hereto shall be finally
68 //    settled by arbitration referred to the Chinese Arbitration Association,
69 //    Taipei in accordance with the ROC Arbitration Law and the Arbitration
70 //    Rules of the Association by three (3) arbitrators appointed in accordance
71 //    with the said Rules.
72 //    The place of arbitration shall be in Taipei, Taiwan and the language shall
73 //    be English.
74 //    The arbitration award shall be final and binding to both parties.
75 //
76 //******************************************************************************
77 //<MStar Software>
78 ////////////////////////////////////////////////////////////////////////////////
79 //
80 // Copyright (c) 2008-2009 MStar Semiconductor, Inc.
81 // All rights reserved.
82 //
83 // Unless otherwise stipulated in writing, any and all information contained
84 // herein regardless in any format shall remain the sole proprietary of
85 // MStar Semiconductor Inc. and be kept in strict confidence
86 // ("MStar Confidential Information") by the recipient.
87 // Any unauthorized act including without limitation unauthorized disclosure,
88 // copying, use, reproduction, sale, distribution, modification, disassembling,
89 // reverse engineering and compiling of the contents of MStar Confidential
90 // Information is unlawful and strictly prohibited. MStar hereby reserves the
91 // rights to any and all damages, losses, costs and expenses resulting therefrom.
92 ////////////////////////////////////////////////////////////////////////////////
93 
94 #ifndef _DRVGPIO_PRIV_H_
95 #define _DRVGPIO_PRIV_H_
96 
97 ////////////////////////////////////////////////////////////////////////////////
98 /// @file drvBDMA.h
99 /// @author MStar Semiconductor Inc.
100 /// @brief Byte DMA control driver
101 ////////////////////////////////////////////////////////////////////////////////
102 
103 ////////////////////////////////////////////////////////////////////////////////
104 // Header Files
105 ////////////////////////////////////////////////////////////////////////////////
106 #ifdef __cplusplus
107 extern "C"
108 {
109 #endif
110 
111 #include "MsTypes.h"
112 #include "drvGPIO.h"
113 
114 typedef enum {
115     MDrv_CMD_GPIO_Init,
116     MDrv_CMD_GPIO_GetStauts,
117     MDrv_CMD_GPIO_Set_High,
118     MDrv_CMD_GPIO_Set_Low,
119     MDrv_CMD_GPIO_Set_Input,
120     MDrv_CMD_GPIO_Get_Inout,
121     MDrv_CMD_GPIO_Get_Level,
122     MDrv_CMD_GPIO_Attach_Interrupt,
123     MDrv_CMD_GPIO_Detach_Interrupt,
124     MDrv_CMD_GPIO_En_Interrupt,
125     MDrv_CMD_GPIO_Dis_Interrupt,
126     MDrv_CMD_GPIO_Dis_Interrupt_All,
127     MDrv_CMD_GPIO_En_Interrupt_All,
128     MDrv_CMD_GPIO_Interrupt_Action,
129 } eGpioIoctlOpt;
130 
131 
132 typedef struct _GPIO_RESOURCE_PRIVATE
133 {
134     MS_U32 Dummy;
135 }GPIO_RESOURCE_PRIVATE;
136 
137 typedef struct _GPIO_GET_STS_PARAM
138 {
139     GPIO_Status *pSts;
140 }GPIO_GET_STS_PARAM, *PGPIO_GET_STS_PARAM;
141 
142 typedef struct _GPIO_SET_HIGH_PARAM
143 {
144     MS_GPIO_NUM gpio_num;
145 }GPIO_SET_HIGH_PARAM, *PGPIO_SET_HIGH_PARAM;
146 
147 typedef struct _GPIO_SET_LOW_PARAM
148 {
149     MS_GPIO_NUM gpio_num;
150 }GPIO_SET_LOW_PARAM, *PGPIO_SET_LOW_PARAM;
151 
152 typedef struct _GPIO_SET_INPUT_PARAM
153 {
154 		MS_GPIO_NUM gpio_num;
155 }GPIO_SET_INPUT_PARAM, *PGPIO_SET_INPUT_PARAM;
156 
157 typedef struct _GPIO_GET_INOUT_PARAM
158 {
159     MS_U32 u32InOut;
160     MS_GPIO_NUM gpio_num;
161 }GPIO_GET_INOUT_PARAM, *PGPIO_GET_INOUT_PARAM;
162 
163 typedef struct _GPIO_GET_LEVEL_PARAM
164 {
165     MS_U32 u32Level;
166     MS_GPIO_NUM gpio_num;
167 }GPIO_GET_LEVEL_PARAM, *PGPIO_GET_LEVEL_PARAM;
168 
169 typedef struct _GPIO_ATTACH_INTERRUPT_PARAM
170 {
171 		MS_GPIO_NUM gpio_num;
172 		GPIO_Edge gpio_edge_type;
173 		void* GPIO_Callback;
174 }GPIO_ATTACH_INTERRUPT_PARAM, *PGPIO_ATTACH_INTERRUPT_PARAM;
175 
176 typedef struct _GPIO_DETACH_INTERRUPT_PARAM
177 {
178     MS_GPIO_NUM gpio_num;
179 }GPIO_DETACH_INTERRUPT_PARAM, *PGPIO_DETACH_INTERRUPT_PARAM;
180 
181 typedef struct _GPIO_ENABLE_INTERRUPT_PARAM
182 {
183 	MS_GPIO_NUM gpio_num;
184 }GPIO_ENABLE_INTERRUPT_PARAM, *PGPIO_ENABLE_INTERRUPT_PARAM;
185 
186 typedef struct _GPIO_DISABLE_INTERRUPT_PARAM
187 {
188 	MS_GPIO_NUM gpio_num;
189 }GPIO_DISABLE_INTERRUPT_PARAM, *PGPIO_DISABLE_INTERRUPT_PARAM;
190 
191 
192 typedef union _GPIO_PRIVATE_PARAM
193 {
194 	 GPIO_GET_STS_PARAM							privatGpioSts;
195 	 GPIO_SET_HIGH_PARAM						privateGpioSetHigh;
196 	 GPIO_SET_LOW_PARAM							privateGpioSetLow;
197 	 GPIO_SET_INPUT_PARAM						privateGpioInput;
198 	 GPIO_GET_INOUT_PARAM						privateGpioGetInout;
199 	 GPIO_GET_LEVEL_PARAM						privateGpioGetLevel;
200 	 GPIO_ATTACH_INTERRUPT_PARAM		privateGpioAttachInterrupt;
201 	 GPIO_DETACH_INTERRUPT_PARAM		privateGpioDetachInterrupt;
202 	 GPIO_ENABLE_INTERRUPT_PARAM		privateGpioEnableInterrupt;
203 	 GPIO_DISABLE_INTERRUPT_PARAM		privateGpioDisableInterrupt;
204 }GPIO_PRIVATE_PARAM;
205 
206 typedef void (*IOCTL_GPIO_GET_STS)(GPIO_Status*);
207 typedef void (*IOCTL_GPIO_INIT)(void);
208 typedef void (*IOCTL_GPIO_SET_H)(MS_GPIO_NUM);
209 typedef void (*IOCTL_GPIO_SET_L)(MS_GPIO_NUM);
210 typedef void (*IOCTL_GPIO_SET_INPUT)(MS_GPIO_NUM);
211 typedef int  (*IOCTL_GPIO_GET_INOUT)(MS_GPIO_NUM);
212 typedef int  (*IOCTL_GPIO_GET_LEVEL)(MS_GPIO_NUM);
213 typedef GPIO_Result (*IOCTL_GPIO_ATTACH_INTERRUPT)(MS_GPIO_NUM,GPIO_Edge,void* GPIO_Callback);
214 typedef GPIO_Result (*IOCTL_GPIO_DETACH_INTERRUPT)(MS_GPIO_NUM);
215 typedef GPIO_Result (*IOCTL_GPIO_ENALBE_INTERRUPT)(MS_GPIO_NUM);
216 typedef GPIO_Result (*IOCTL_GPIO_DISABLE_INTERRUPT)(MS_GPIO_NUM);
217 typedef void (*IOCTL_GPIO_DISABLE_INTERRUPT_ALL)(void);
218 typedef void (*IOCTL_GPIO_ENABLE_INTERRUPT_ALL)(void);
219 typedef void (*IOCTL_GPIO_INTERRUPT_ACTION)(void);
220 
221 typedef struct _GPIO_INSTANT_PRIVATE
222 {
223 	IOCTL_GPIO_GET_STS								fpGpioGetSts;
224 	IOCTL_GPIO_INIT  									fpGpioInit;
225 	IOCTL_GPIO_SET_H									fpGpioSetH;
226 	IOCTL_GPIO_SET_L									fpGpioSetL;
227 	IOCTL_GPIO_SET_INPUT							fpGpioSetInput;
228 	IOCTL_GPIO_GET_INOUT							fpGpioGetInout;
229 	IOCTL_GPIO_GET_LEVEL							fpGpioGetLevel;
230 	IOCTL_GPIO_ATTACH_INTERRUPT				fpGpioAttachInterrupt;
231 	IOCTL_GPIO_DETACH_INTERRUPT				fpGpioDetachInterrupt;
232 	IOCTL_GPIO_DISABLE_INTERRUPT				fpGpioDisableInterrupt;
233 	IOCTL_GPIO_ENALBE_INTERRUPT				fpGpioEnableInterrupt;
234 	IOCTL_GPIO_DISABLE_INTERRUPT_ALL		fpGpioDisableInterruptAll;
235 	IOCTL_GPIO_ENABLE_INTERRUPT_ALL		fpGpioEnableInterruptAll;
236 	IOCTL_GPIO_INTERRUPT_ACTION				fpGpioInterruptAction;
237 }GPIO_INSTANT_PRIVATE;
238 
239 void GPIORegisterToUtopia(FUtopiaOpen ModuleType);
240 MS_U32 GPIOOpen(void** ppInstance, MS_U32 u32ModuleVersion, void* pAttribute);
241 MS_U32 GPIOClose(void* pInstance);
242 MS_U32 GPIOIoctl(void* pInstance, MS_U32 u32Cmd, void* pArgs);
243 MS_U32 GPIOStr(MS_U32 u32PowerState, void* pModule);
244 
245 void MDrv_GPIO_GetStatus_U2K(GPIO_Status *pStatus);
246 void mdrv_gpio_init_U2K(void);
247 void mdrv_gpio_set_high_U2K(MS_GPIO_NUM gpio);
248 void mdrv_gpio_set_low_U2K(MS_GPIO_NUM gpio);
249 void mdrv_gpio_set_input_U2K(MS_GPIO_NUM gpio);
250 int mdrv_gpio_get_inout_U2K(MS_GPIO_NUM gpio);
251 int mdrv_gpio_get_level_U2K(MS_GPIO_NUM gpio);
252 GPIO_Result mdrv_gpio_attach_interrupt_U2K(MS_GPIO_NUM gpio_num,GPIO_Edge gpio_edge_type,GPIO_Callback pCallback);
253 GPIO_Result mdrv_gpio_detach_interrupt_U2K(MS_GPIO_NUM gpio_num);
254 GPIO_Result mdrv_gpio_enable_interrupt_U2K(MS_GPIO_NUM gpio);
255 GPIO_Result mdrv_gpio_disable_interrupt_U2K(MS_GPIO_NUM gpio);
256 void mdrv_gpio_disable_interrupt_all_U2K(void);
257 void mdrv_gpio_enable_interrupt_all_U2K(void);
258 void mdrv_gpio_interrupt_action_U2K(void);
259 
260 #ifdef __cplusplus
261 }
262 #endif
263 #endif // _DRVGPIO_PRIV_H_
264