xref: /utopia/UTPA2-700.0.x/modules/usb/drv/usb_ecos/usbhost/include/drvKernel.h (revision 53ee8cc121a030b8d368113ac3e966b4705770ef)
1*53ee8cc1Swenshuai.xi //<MStar Software>
2*53ee8cc1Swenshuai.xi //******************************************************************************
3*53ee8cc1Swenshuai.xi // MStar Software
4*53ee8cc1Swenshuai.xi // Copyright (c) 2010 - 2012 MStar Semiconductor, Inc. All rights reserved.
5*53ee8cc1Swenshuai.xi // All software, firmware and related documentation herein ("MStar Software") are
6*53ee8cc1Swenshuai.xi // intellectual property of MStar Semiconductor, Inc. ("MStar") and protected by
7*53ee8cc1Swenshuai.xi // law, including, but not limited to, copyright law and international treaties.
8*53ee8cc1Swenshuai.xi // Any use, modification, reproduction, retransmission, or republication of all
9*53ee8cc1Swenshuai.xi // or part of MStar Software is expressly prohibited, unless prior written
10*53ee8cc1Swenshuai.xi // permission has been granted by MStar.
11*53ee8cc1Swenshuai.xi //
12*53ee8cc1Swenshuai.xi // By accessing, browsing and/or using MStar Software, you acknowledge that you
13*53ee8cc1Swenshuai.xi // have read, understood, and agree, to be bound by below terms ("Terms") and to
14*53ee8cc1Swenshuai.xi // comply with all applicable laws and regulations:
15*53ee8cc1Swenshuai.xi //
16*53ee8cc1Swenshuai.xi // 1. MStar shall retain any and all right, ownership and interest to MStar
17*53ee8cc1Swenshuai.xi //    Software and any modification/derivatives thereof.
18*53ee8cc1Swenshuai.xi //    No right, ownership, or interest to MStar Software and any
19*53ee8cc1Swenshuai.xi //    modification/derivatives thereof is transferred to you under Terms.
20*53ee8cc1Swenshuai.xi //
21*53ee8cc1Swenshuai.xi // 2. You understand that MStar Software might include, incorporate or be
22*53ee8cc1Swenshuai.xi //    supplied together with third party`s software and the use of MStar
23*53ee8cc1Swenshuai.xi //    Software may require additional licenses from third parties.
24*53ee8cc1Swenshuai.xi //    Therefore, you hereby agree it is your sole responsibility to separately
25*53ee8cc1Swenshuai.xi //    obtain any and all third party right and license necessary for your use of
26*53ee8cc1Swenshuai.xi //    such third party`s software.
27*53ee8cc1Swenshuai.xi //
28*53ee8cc1Swenshuai.xi // 3. MStar Software and any modification/derivatives thereof shall be deemed as
29*53ee8cc1Swenshuai.xi //    MStar`s confidential information and you agree to keep MStar`s
30*53ee8cc1Swenshuai.xi //    confidential information in strictest confidence and not disclose to any
31*53ee8cc1Swenshuai.xi //    third party.
32*53ee8cc1Swenshuai.xi //
33*53ee8cc1Swenshuai.xi // 4. MStar Software is provided on an "AS IS" basis without warranties of any
34*53ee8cc1Swenshuai.xi //    kind. Any warranties are hereby expressly disclaimed by MStar, including
35*53ee8cc1Swenshuai.xi //    without limitation, any warranties of merchantability, non-infringement of
36*53ee8cc1Swenshuai.xi //    intellectual property rights, fitness for a particular purpose, error free
37*53ee8cc1Swenshuai.xi //    and in conformity with any international standard.  You agree to waive any
38*53ee8cc1Swenshuai.xi //    claim against MStar for any loss, damage, cost or expense that you may
39*53ee8cc1Swenshuai.xi //    incur related to your use of MStar Software.
40*53ee8cc1Swenshuai.xi //    In no event shall MStar be liable for any direct, indirect, incidental or
41*53ee8cc1Swenshuai.xi //    consequential damages, including without limitation, lost of profit or
42*53ee8cc1Swenshuai.xi //    revenues, lost or damage of data, and unauthorized system use.
43*53ee8cc1Swenshuai.xi //    You agree that this Section 4 shall still apply without being affected
44*53ee8cc1Swenshuai.xi //    even if MStar Software has been modified by MStar in accordance with your
45*53ee8cc1Swenshuai.xi //    request or instruction for your use, except otherwise agreed by both
46*53ee8cc1Swenshuai.xi //    parties in writing.
47*53ee8cc1Swenshuai.xi //
48*53ee8cc1Swenshuai.xi // 5. If requested, MStar may from time to time provide technical supports or
49*53ee8cc1Swenshuai.xi //    services in relation with MStar Software to you for your use of
50*53ee8cc1Swenshuai.xi //    MStar Software in conjunction with your or your customer`s product
51*53ee8cc1Swenshuai.xi //    ("Services").
52*53ee8cc1Swenshuai.xi //    You understand and agree that, except otherwise agreed by both parties in
53*53ee8cc1Swenshuai.xi //    writing, Services are provided on an "AS IS" basis and the warranty
54*53ee8cc1Swenshuai.xi //    disclaimer set forth in Section 4 above shall apply.
55*53ee8cc1Swenshuai.xi //
56*53ee8cc1Swenshuai.xi // 6. Nothing contained herein shall be construed as by implication, estoppels
57*53ee8cc1Swenshuai.xi //    or otherwise:
58*53ee8cc1Swenshuai.xi //    (a) conferring any license or right to use MStar name, trademark, service
59*53ee8cc1Swenshuai.xi //        mark, symbol or any other identification;
60*53ee8cc1Swenshuai.xi //    (b) obligating MStar or any of its affiliates to furnish any person,
61*53ee8cc1Swenshuai.xi //        including without limitation, you and your customers, any assistance
62*53ee8cc1Swenshuai.xi //        of any kind whatsoever, or any information; or
63*53ee8cc1Swenshuai.xi //    (c) conferring any license or right under any intellectual property right.
64*53ee8cc1Swenshuai.xi //
65*53ee8cc1Swenshuai.xi // 7. These terms shall be governed by and construed in accordance with the laws
66*53ee8cc1Swenshuai.xi //    of Taiwan, R.O.C., excluding its conflict of law rules.
67*53ee8cc1Swenshuai.xi //    Any and all dispute arising out hereof or related hereto shall be finally
68*53ee8cc1Swenshuai.xi //    settled by arbitration referred to the Chinese Arbitration Association,
69*53ee8cc1Swenshuai.xi //    Taipei in accordance with the ROC Arbitration Law and the Arbitration
70*53ee8cc1Swenshuai.xi //    Rules of the Association by three (3) arbitrators appointed in accordance
71*53ee8cc1Swenshuai.xi //    with the said Rules.
72*53ee8cc1Swenshuai.xi //    The place of arbitration shall be in Taipei, Taiwan and the language shall
73*53ee8cc1Swenshuai.xi //    be English.
74*53ee8cc1Swenshuai.xi //    The arbitration award shall be final and binding to both parties.
75*53ee8cc1Swenshuai.xi //
76*53ee8cc1Swenshuai.xi //******************************************************************************
77*53ee8cc1Swenshuai.xi //<MStar Software>
78*53ee8cc1Swenshuai.xi 
79*53ee8cc1Swenshuai.xi #ifndef _KERNEL_H_
80*53ee8cc1Swenshuai.xi #define _KERNEL_H_
81*53ee8cc1Swenshuai.xi 
82*53ee8cc1Swenshuai.xi #include "MsCommon.h"
83*53ee8cc1Swenshuai.xi 
84*53ee8cc1Swenshuai.xi #include "drvPorts.h"
85*53ee8cc1Swenshuai.xi #include "drvUSB.h"
86*53ee8cc1Swenshuai.xi #include <cyg/hal/plf_intr.h>
87*53ee8cc1Swenshuai.xi #include <cyg/hal/drv_api.h>
88*53ee8cc1Swenshuai.xi 
89*53ee8cc1Swenshuai.xi #ifdef PR_DEBUG
90*53ee8cc1Swenshuai.xi #define pr_debug diag_printf
91*53ee8cc1Swenshuai.xi #else
92*53ee8cc1Swenshuai.xi #define pr_debug(fmt,...) \
93*53ee8cc1Swenshuai.xi   do { } while (0)
94*53ee8cc1Swenshuai.xi #endif
95*53ee8cc1Swenshuai.xi 
96*53ee8cc1Swenshuai.xi // Funtion for Protecting shared data (solve synchronisation by the easiest way)
97*53ee8cc1Swenshuai.xi //#define     MSOS_WAIT_FOREVER   (20000)
98*53ee8cc1Swenshuai.xi 
99*53ee8cc1Swenshuai.xi #define INT_DISABLED  0
100*53ee8cc1Swenshuai.xi #define INT_ENABLED   1
101*53ee8cc1Swenshuai.xi 
102*53ee8cc1Swenshuai.xi extern int CPU_Int_State;
103*53ee8cc1Swenshuai.xi 
104*53ee8cc1Swenshuai.xi 
105*53ee8cc1Swenshuai.xi 
106*53ee8cc1Swenshuai.xi #define USB_STOR_BLK_COMPLETE	1
107*53ee8cc1Swenshuai.xi #define USB_PTP_COMPLETE			2
108*53ee8cc1Swenshuai.xi #define USB_STOR_BLK_ASYNC    	4
109*53ee8cc1Swenshuai.xi 
110*53ee8cc1Swenshuai.xi 
unlock_usb_core(void)111*53ee8cc1Swenshuai.xi static __inline__ void unlock_usb_core(void)
112*53ee8cc1Swenshuai.xi {
113*53ee8cc1Swenshuai.xi   USB_core_lock = 0;
114*53ee8cc1Swenshuai.xi }
115*53ee8cc1Swenshuai.xi 
lock_usb_core(void)116*53ee8cc1Swenshuai.xi static __inline__ void lock_usb_core(void)
117*53ee8cc1Swenshuai.xi {
118*53ee8cc1Swenshuai.xi   //Lokc ISR ==> don't process USB ISR when USB interrupt occurs
119*53ee8cc1Swenshuai.xi   USB_core_lock = 1;
120*53ee8cc1Swenshuai.xi }
121*53ee8cc1Swenshuai.xi 
lock_TmrTaskDispatch(void)122*53ee8cc1Swenshuai.xi static __inline__  void lock_TmrTaskDispatch(void)
123*53ee8cc1Swenshuai.xi {
124*53ee8cc1Swenshuai.xi   //Lock ==> don't dispatch registered software timer tasks
125*53ee8cc1Swenshuai.xi   Timer_task_lock = 1;
126*53ee8cc1Swenshuai.xi }
127*53ee8cc1Swenshuai.xi 
unlock_TmrTaskDispatch(void)128*53ee8cc1Swenshuai.xi static __inline__  void unlock_TmrTaskDispatch(void)
129*53ee8cc1Swenshuai.xi {
130*53ee8cc1Swenshuai.xi   Timer_task_lock = 0;
131*53ee8cc1Swenshuai.xi }
132*53ee8cc1Swenshuai.xi 
133*53ee8cc1Swenshuai.xi 
134*53ee8cc1Swenshuai.xi 
135*53ee8cc1Swenshuai.xi 
136*53ee8cc1Swenshuai.xi #define TIMER_TASK_LOCK Timer_task_lock
137*53ee8cc1Swenshuai.xi 
138*53ee8cc1Swenshuai.xi // Note, need to be modified
check_usb_lock(void)139*53ee8cc1Swenshuai.xi static __inline__ void check_usb_lock(void)
140*53ee8cc1Swenshuai.xi {
141*53ee8cc1Swenshuai.xi 	if ( USB_core_lock <= 0 )		// None use the USB_Core, we can lock it
142*53ee8cc1Swenshuai.xi 		USB_core_lock = 1;
143*53ee8cc1Swenshuai.xi 	else
144*53ee8cc1Swenshuai.xi 	{
145*53ee8cc1Swenshuai.xi 		// Locked, Someone is using usb core
146*53ee8cc1Swenshuai.xi 		while( USB_core_lock > 0 )
147*53ee8cc1Swenshuai.xi 			MsOS_DelayTask(100);
148*53ee8cc1Swenshuai.xi 
149*53ee8cc1Swenshuai.xi 	    // Got the lock
150*53ee8cc1Swenshuai.xi        USB_core_lock = 1;
151*53ee8cc1Swenshuai.xi      }
152*53ee8cc1Swenshuai.xi }
153*53ee8cc1Swenshuai.xi 
154*53ee8cc1Swenshuai.xi //Disable IRQ and FIQ and store cpsr
save_and_disable_firqs(U32 * flag)155*53ee8cc1Swenshuai.xi static __inline__ void save_and_disable_firqs(U32 *flag)
156*53ee8cc1Swenshuai.xi {
157*53ee8cc1Swenshuai.xi 	//HAL_DISABLE_INTERRUPTS(flag);
158*53ee8cc1Swenshuai.xi }
159*53ee8cc1Swenshuai.xi 
160*53ee8cc1Swenshuai.xi //Restore stored cpsr
restore_firqs(U32 * flag)161*53ee8cc1Swenshuai.xi static __inline__ void restore_firqs(U32 *flag)
162*53ee8cc1Swenshuai.xi {
163*53ee8cc1Swenshuai.xi 	//HAL_RESTORE_INTERRUPTS(*flag);
164*53ee8cc1Swenshuai.xi }
165*53ee8cc1Swenshuai.xi 
166*53ee8cc1Swenshuai.xi //#define sti()
167*53ee8cc1Swenshuai.xi //#define cli()
168*53ee8cc1Swenshuai.xi 
sti(void)169*53ee8cc1Swenshuai.xi static __inline__ void sti(void)
170*53ee8cc1Swenshuai.xi {
171*53ee8cc1Swenshuai.xi 	//MsOS_EnableInterrupt(E_IRQ_USB);
172*53ee8cc1Swenshuai.xi 
173*53ee8cc1Swenshuai.xi 
174*53ee8cc1Swenshuai.xi 	unlock_TmrTaskDispatch();
175*53ee8cc1Swenshuai.xi }
176*53ee8cc1Swenshuai.xi 
cli(void)177*53ee8cc1Swenshuai.xi static __inline__ void cli(void)
178*53ee8cc1Swenshuai.xi {
179*53ee8cc1Swenshuai.xi 	//MsOS_DisableInterrupt(E_IRQ_USB);
180*53ee8cc1Swenshuai.xi 
181*53ee8cc1Swenshuai.xi 	lock_TmrTaskDispatch();
182*53ee8cc1Swenshuai.xi }
183*53ee8cc1Swenshuai.xi 
184*53ee8cc1Swenshuai.xi extern void *ncmem_alloc_page(dma_addr_t *dma_addr);
185*53ee8cc1Swenshuai.xi extern void ncmem_free_page(U32 addr);
186*53ee8cc1Swenshuai.xi extern void Destory_NC_mem(void);
187*53ee8cc1Swenshuai.xi #endif
188