xref: /utopia/UTPA2-700.0.x/modules/usb/drv/usbhost/source2/drvHost200_2.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 //	File name: Host20_AP.H
81 //	Version: 1.0
82 //	Date: 2003/7/13
83 //
84 //	Author: Bruce
85 //	Email:
86 //	Phone: (03) 578-7888
87 //	Company: Faraday Tech. Corp.
88 //
89 //	Description:
90 ///////////////////////////////////////////////////////////////////////////////
91  #ifndef HOST200_AP__H
92 
93  #define HOST200_AP__H
94 
95  #define OTGH_PT_ADVANCE_TEST	                 0
96 
97 //=================== 1.Condition Definition  ============================================================
98 //========================================================================================================
99  #define OTGH_PT_DataStart	                     0x04000000
100  #define OTGH_PT_AUTO_TEST
101 
102 
103 //=================== 2.Define Data Type  ================================================================
104 //========================================================================================================
105  #define OTGH_PT_CBW_SIGNATE	                 0x43425355
106  #define OTGH_PT_CSW_SIGNATE 	                 0x53425355
107  #define OTGH_PT_CSW_PASS          			     0x00
108  #define OTGH_Dir_IN 	                         0x01
109  #define OTGH_Dir_Out 	                         0x00
110 
111 //=================== 3.Structure Definition =============================================================
112 //========================================================================================================
113  typedef struct
114  {
115  	UINT8  bDataCounter_IN;	         //0~255
116  	UINT8  bDataCounter_OUT;	     //0~255
117  	UINT32 wMaxSize;
118     //UINT8 *pbDataPage[5];
119 
120  }OTGH_PT_CONTROL_Struct;
121 
122 
123  typedef struct
124  {
125  	UINT8 bDataCounterIn;	         //0~255
126  	UINT8 bDataCounterOut;	         //0~255
127  	UINT8 bMaxSize;              //Assume 13
128     UINT8 bINT_Dir;             //0:Init 1:IN 2:Out
129  	UINT8 bInQHDArrayNum;
130  	UINT8 bOutQHDArrayNum;
131  }OTGH_PT_INT_Struct;
132 
133  #define OTGH_PT_ISO_DATABUFFER_NUM                600
134 
135  typedef struct
136  {
137  	UINT8       bDataMax;	      //252
138  	UINT8       bDataCounter;     //Dynamic index
139     UINT32      aDataBufferArray[OTGH_PT_ISO_DATABUFFER_NUM];//Max support 600*4K=2.4M
140 
141  }OTGH_PT_ISO_Struct;
142 
143  typedef struct CommandBlockWrapper
144  {
145  	UINT32 u32Signature;
146  	UINT32 u32Tag;
147  	UINT32 u32DataTransferLength;
148  	UINT8 u8Flags;
149  	UINT8 u8LUN;
150  	UINT8 u8CBLength;
151  	UINT8 u8CB[16];
152  }OTGH_PT_CBW;
153 
154  typedef struct CommandStatusWrapper
155  {
156  	UINT32 u32Signature;
157  	UINT32 u32Tag;
158  	UINT32 u32DataResidue;
159  	UINT8 u8Status;
160  }OTGH_PT_CSW;
161 
162  typedef struct
163  {
164  	OTGH_PT_CBW sCBW;	                 //31 bytes
165  	OTGH_PT_CSW sCSW;                    //13bytes
166     //UINT32      wDataRange;
167  	UINT8        bInQHDArrayNum;
168  	UINT8        bOutQHDArrayNum;
169     UINT8        bStatus;
170  }OTGH_PT_BLK_Struct;
171 
172 //=================== 4.Extern Function Definition =======================================================
173 //========================================================================================================
174  extern void OTGH_AP_Main(void);
175  extern void OTGH_PT_CV(void);
176  extern void OTGH_PT_Bulk(void);
177  extern void OTGH_PT_Interrupt_In_Out_RandomSize(void);
178  extern void OTGH_PT_Interrupt_In_Out_FixSize(void);
179  extern void OTGH_PT_GetDescriptor (UINT8 bCounter);
180 
181  extern void OTGH_PT_Bulk_SendCBW(UINT32 wLength, UINT16 hwStartAdd,  UINT32 wTagNum , UINT8 bDataDir);
182  extern void OTGH_PT_Bulk_ReceiveCSW(void);
183  extern void OTGH_PathTest_BULK_INT(void);
184  extern void OTGH_PathTest_ISO_IN(void);
185  extern void OTGH_PathTest_ISO_OUT(void);
186  extern void OTGH_PathTest_Control(void);
187  extern void OTGH_Suspend_Test(void);
188  extern UINT8 OTGH_SetDescriptor_Test(void);
189  extern void OTGH_PT_Control_Path(void);
190  extern void OTGH_PT_Control_Command(void);
191  extern void OTGH_PT_FrameNumber(void);
192  extern void OTGH_PT_CV_Like(void);
193 
194 
195 extern void OTGC_A_Bus_Drop(void);
196 extern void OTGC_A_Bus_Drive(void);
197 
198 extern void OTGH_Hub_Main(void);
199 extern void OTGH_AP_Faraday(void);
200 extern void OTGH_PT_Init(void);
201 extern void Host20_MSCD_MassStorage_Main(void);
202 
203 extern void OTGH_PT_Bulk_Close(void);
204 
205 extern void OTGH_AP_RemoteWakeUp_Test(void);
206 extern void OTGH_AP_Suspend_Resume_Test(void);
207 extern BOOLEAN MassStorage_Init_Port2(void);
208 
209 void OTGH_Error_Handle(void);
210 
211 //=================== 5.Extern Variable Definition =======================================================
212 //========================================================================================================
213  extern  OTGH_PT_BLK_Struct   xdata   *sOTGH_PT_BLK_PORT2;
214  extern  OTGH_PT_BLK_Struct   xdata   *pOTGH_PT_BLK_Port2;
215 
216 #endif //HOST200_AP__H
217 
218 
219