xref: /utopia/UTPA2-700.0.x/modules/irq/drv/irq/drvIRQ.c (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 
95 ///////////////////////////////////////////////////////////////////////////////////////////////////
96 ///
97 /// file    drvIRQ.c
98 /// @brief  IRQ Driver Interface
99 /// @author MStar Semiconductor Inc.
100 ///////////////////////////////////////////////////////////////////////////////////////////////////
101 
102 
103 //-------------------------------------------------------------------------------------------------
104 //  Include Files
105 //-------------------------------------------------------------------------------------------------
106 // Common Definition
107 #include "MsCommon.h"
108 #include "drvIRQ.h"
109 #include "halIRQ.h"
110 #include "drvMMIO.h"
111 #include "MsVersion.h"
112 #include "regIRQ.h"
113 
114 #if defined(MSOS_TYPE_NUTTX)
115 #include "debug.h"
116 #endif
117 #include "utopia.h"
118 
119 #include "ULog.h"
120 
121 //-------------------------------------------------------------------------------------------------
122 //  Driver Compiler Options
123 //-------------------------------------------------------------------------------------------------
124 
125 
126 //-------------------------------------------------------------------------------------------------
127 //  Local Defines
128 //-------------------------------------------------------------------------------------------------
129 
130 
131 //-------------------------------------------------------------------------------------------------
132 //  Local Structurs
133 //-------------------------------------------------------------------------------------------------
134 
135 
136 //-------------------------------------------------------------------------------------------------
137 //  Global Variables
138 //-------------------------------------------------------------------------------------------------
139 MS_BOOL gbIRQ_InitFg=FALSE;
140 
141 //-------------------------------------------------------------------------------------------------
142 //  Local Variables
143 //-------------------------------------------------------------------------------------------------
144 
145 
146 //-------------------------------------------------------------------------------------------------
147 //  External Functions
148 //-------------------------------------------------------------------------------------------------
149 
150 //-------------------------------------------------------------------------------------------------
151 //  Local Functions
152 //-------------------------------------------------------------------------------------------------
153 static MSIF_Version _drv_drvirq_version = {
154     .DDI = { DRVIRQ_DRV_VERSION },
155 };
156 ////////////////////////////////////////////////////////////////////////////////
157 /// @brief \b Function  \b Name: MDrv_MSOS_GetLibVer
158 /// @brief \b Function  \b Description: Show the MSOS driver version
159 /// @param ppVersion    \b Out: Library version string
160 /// @return             \b Result
161 ////////////////////////////////////////////////////////////////////////////////
MDrv_IRQ_GetLibVer(const MSIF_Version ** ppVersion)162 MS_BOOL MDrv_IRQ_GetLibVer(const MSIF_Version **ppVersion)
163 {
164     if (!ppVersion)
165         return FALSE;
166 
167     *ppVersion = &_drv_drvirq_version;
168     return TRUE;
169 }
170 
171 //-------------------------------------------------------------------------------------------------
172 //  Global Functions
173 //-------------------------------------------------------------------------------------------------
MDrv_IRQ_Init()174 MS_BOOL MDrv_IRQ_Init()
175 {
176 #if defined(MSOS_TYPE_NOS) || defined(MSOS_TYPE_NUTTX)
177     MS_VIRT u32Base = 0;
178     MS_PHY u32Size = 0;
179 
180     if (gbIRQ_InitFg)
181         return true;
182     if (MDrv_MMIO_GetBASE(&u32Base, &u32Size, MS_MODULE_IRQ))
183     {
184         HAL_IRQ_Set_IOMap(u32Base);
185         HAL_IRQ_Init();
186         gbIRQ_InitFg=true;
187         return TRUE;
188     }
189 #endif // #if defined(MSOS_TYPE_NOS) || defined(MSOS_TYPE_NUTTX)
190     return FALSE;
191 }
192 
MDrv_IRQ_Attach(MS_U32 u32Vector,void * pIntCb)193 void MDrv_IRQ_Attach(MS_U32 u32Vector, void *pIntCb)
194 {
195 #if defined(MSOS_TYPE_NOS) || defined(MSOS_TYPE_NUTTX)
196     HAL_IRQ_Attach(u32Vector, pIntCb,0);
197 #endif // #if defined(MSOS_TYPE_NOS) || defined(MSOS_TYPE_NUTTX)
198 }
199 
MDrv_IRQ_Detech(MS_U32 u32Vector)200 void MDrv_IRQ_Detech(MS_U32 u32Vector)
201 {
202 #if defined(MSOS_TYPE_NOS) || defined(MSOS_TYPE_NUTTX)
203     HAL_IRQ_Detech(u32Vector);
204 #endif // #if defined(MSOS_TYPE_NOS) || defined(MSOS_TYPE_NUTTX)
205 }
206 
MDrv_IRQ_Restore()207 void MDrv_IRQ_Restore()
208 {
209 #if defined(MSOS_TYPE_NOS) || defined(MSOS_TYPE_NUTTX)
210     HAL_IRQ_Restore();
211 #endif // #if defined(MSOS_TYPE_NOS) || defined(MSOS_TYPE_NUTTX)
212 }
213 
MDrv_IRQ_MaskAll()214 void MDrv_IRQ_MaskAll()
215 {
216 #if defined(MSOS_TYPE_NOS) || defined(MSOS_TYPE_NUTTX)
217     HAL_IRQ_MaskAll(TRUE);
218 #endif // #if defined(MSOS_TYPE_NOS) || defined(MSOS_TYPE_NUTTX)
219 }
220 
MDrv_IRQ_Mask(MS_U32 u32Vector)221 void MDrv_IRQ_Mask(MS_U32 u32Vector)
222 {
223 #if defined(MSOS_TYPE_NOS) || defined(MSOS_TYPE_NUTTX)
224     HAL_IRQ_Mask(u32Vector);
225 #endif // #if defined(MSOS_TYPE_NOS) || defined(MSOS_TYPE_NUTTX)
226 }
227 
MDrv_IRQ_UnMaskAll()228 void MDrv_IRQ_UnMaskAll( )
229 {
230 #if defined(MSOS_TYPE_NOS) || defined(MSOS_TYPE_NUTTX)
231     HAL_IRQ_MaskAll(FALSE);
232 #endif // #if defined(MSOS_TYPE_NOS) || defined(MSOS_TYPE_NUTTX)
233 }
234 
MDrv_IRQ_UnMask(MS_U32 u32Vector)235 void MDrv_IRQ_UnMask(MS_U32 u32Vector)
236 {
237 #if defined(MSOS_TYPE_NOS) || defined(MSOS_TYPE_NUTTX)
238     HAL_IRQ_UnMask(u32Vector);
239 #endif // #if defined(MSOS_TYPE_NOS) || defined(MSOS_TYPE_NUTTX)
240 }
241 
MDrv_IRQ_NotifyCpu(IRQ_CPU_TYPE eType)242 void MDrv_IRQ_NotifyCpu(IRQ_CPU_TYPE eType)
243 {
244 #if defined(MSOS_TYPE_NOS) || defined(MSOS_TYPE_NUTTX)
245     HAL_IRQ_NotifyCpu(eType);
246 #endif // #if defined(MSOS_TYPE_NOS) || defined(MSOS_TYPE_NUTTX)
247 }
248 
MDrv_IRQ_InISR()249 MS_BOOL MDrv_IRQ_InISR()
250 {
251 #if defined(MSOS_TYPE_NOS) || defined(MSOS_TYPE_NUTTX)
252     return HAL_IRQ_InISR();
253 #else
254     return FALSE;
255 #endif // #if defined(MSOS_TYPE_NOS) || defined(MSOS_TYPE_NUTTX)
256 }
257 
MDrv_IRQ_SetPowerState(EN_POWER_MODE u16PowerState)258 MS_U32 MDrv_IRQ_SetPowerState(EN_POWER_MODE u16PowerState)
259 {
260 	static EN_POWER_MODE _prev_u16PowerState = E_POWER_MECHANICAL;
261 	MS_U16 u16Return = UTOPIA_STATUS_FAIL;
262 
263 	if (u16PowerState == E_POWER_SUSPEND)
264 	{
265 		_prev_u16PowerState = u16PowerState;
266 		u16Return = UTOPIA_STATUS_SUCCESS;//SUSPEND_OK;
267 	}
268 	else if (u16PowerState == E_POWER_RESUME)
269 	{
270 
271 		if (_prev_u16PowerState == E_POWER_SUSPEND)
272 		{
273             MDrv_IRQ_Init();
274 
275 			_prev_u16PowerState = u16PowerState;
276 			u16Return = UTOPIA_STATUS_SUCCESS;//RESUME_OK;
277 		}
278 		else
279 		{
280 			ULOGE("IRQ", "[%s,%5d]It is not suspended yet. We shouldn't resume\n",__FUNCTION__,__LINE__);
281 			u16Return = UTOPIA_STATUS_FAIL;//SUSPEND_FAILED;
282 		}
283 	}
284 	else
285 	{
286 		ULOGE("IRQ", "[%s,%5d]Do Nothing: %d\n",__FUNCTION__,__LINE__,u16PowerState);
287 		u16Return = UTOPIA_STATUS_FAIL;
288 	}
289 
290 	return u16Return;// for success
291 }
292 
293 
294 
295