xref: /utopia/UTPA2-700.0.x/modules/usb/drv/usb_ecos/usbhost/drvUSBHwCtl.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 //Copyright (C) 2008 MStar  All Rights Reserved.
79 
80 /*! \file  drvUSBHwCtl.h
81 	\brief  Functions for accessing the USB hardware.
82 
83 
84  \n\b History:
85 	\n\b Date: 2008/11/20
86 	\n\b Author: Colin Tsai
87 	\n\b Reason: Create
88 	\n
89 */
90 //=============================================================================
91 
92 #ifndef DRV_USB_HWCTL_H
93 #define DRV_USB_HWCTL_H
94 #include "drvUsbHostConfig.h"
95 
96 #define usb_readb(addr)    (*(volatile unsigned char *) (addr))
97 #define usb_readw(addr)    (*(volatile unsigned short *) (addr))
98 #define usb_readl(addr)    (*(volatile unsigned int *) (addr))
99 #define usb_writeb(b,addr) ((*(volatile unsigned char *) (addr)) = (b))
100 #define usb_writew(b,addr) ((*(volatile unsigned short *) (addr)) = (b))
101 #define usb_writel(b,addr) ((*(volatile unsigned int *) (addr)) = (b))
102 
103 #define HOST20_USBCMD_FrameListSize_1024                  0x00
104 #define HOST20_USBCMD_FrameListSize_512                   0x01
105 #define HOST20_USBCMD_FrameListSize_256                   0x02
106 
107 #define HOST20_Enable                  0x01
108 #define HOST20_Disable                 0x00
109 
110 #define HOST20_USBEVENT_USB_CDC_CTRL                      0x100
111 #define HOST20_USBEVENT_USB_CDC_BUILK_IN                  0x80
112 #define HOST20_USBEVENT_USB_CDC_BUILK_OUT                 0x40
113 #define HOST20_USBINTR_IntOnAsyncAdvance                  0x20
114 #define HOST20_USBINTR_SystemError                        0x10
115 #define HOST20_USBINTR_FrameRollover                      0x08
116 #define HOST20_USBINTR_PortChangeDetect                   0x04
117 #define HOST20_USBINTR_USBError                           0x02
118 #define HOST20_USBINTR_CompletionOfTransaction            0x01
119 #define USBWAITEVENTS   (HOST20_USBINTR_CompletionOfTransaction|HOST20_USBINTR_USBError|HOST20_USBINTR_PortChangeDetect|HOST20_USBINTR_SystemError)
120 
121 #define USBCINTR_IDChange                                 0x08
122 #define USBCINTR_BValidChange                             0x04
123 #define USBCINTR_AValidChange                             0x02
124 #define USBCINTR_VBusValidChange                          0x01
125 
126 extern void UTMI_ORXBYTE_EX(MS_U8 offset,MS_U8 val, MS_U32 base);
127 extern void UTMI_ANDXBYTE_EX(MS_U8 offset,MS_U8 val, MS_U32 base);
128 extern void UTMI_SETXBYTE_EX(MS_U8 offset,MS_U8 val, MS_U32 base);
129 extern MS_U8 UTMI_READXBYTE_EX(MS_U8 offset, MS_U32 base);
130 
131 //#define Enable_Issue_TestPacket
132 //#define Issue_TestPacket
133 //#define Enable_Burning_Test
134 //#define Enable_SOF_Only
135 
136 #ifdef MS_NOSAPI
137 #define USB_MSEC_LOOP              ( CPU_CLOCK_FREQ/1000/4 )
138 #define USB_USEC_LOOP              ( CPU_CLOCK_FREQ / 1000 / 1000 / 4 )   //micro seconds
139 #define USB_DELAY(_loop)     { volatile int i; for (i=0; i<(_loop)*USB_MSEC_LOOP; i++); }
140 #define USB_DELAY_USEC(_loop)     { volatile int i; for (i=0; i<(_loop)*USB_USEC_LOOP; i++); }
141 #define USB_TIME(_stamp, _loop)    { _stamp = (_loop); }
142 #define USB_EXPIRE(_stamp)         ( !(--_stamp) )
143 #else
144 #define USB_DELAY(_msec)           MsOS_DelayTask(_msec)
145 #define USB_DELAY_USEC(_usec)           MsOS_DelayTaskUs(_usec)
146 #define USB_TIME(_stamp, _loop)    { _stamp = (_loop); }
147 #define USB_EXPIRE(_stamp)         ( !(--_stamp) )
148 
149 #endif
150 
151 #endif  //#define DRV_USB_HWCTL_H
152 
153