xref: /utopia/UTPA2-700.0.x/modules/usb/drv/usb_ecos/newhost/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 #include "drvUsbd.h"
96 
97 #define usb_readb(addr)    (*(volatile unsigned char *) (addr))
98 #define usb_readw(addr)    (*(volatile unsigned short *) (addr))
99 #define usb_readl(addr)    (*(volatile unsigned int *) (addr))
100 #define usb_writeb(b,addr) ((*(volatile unsigned char *) (addr)) = (b))
101 #define usb_writew(b,addr) ((*(volatile unsigned short *) (addr)) = (b))
102 #define usb_writel(b,addr) ((*(volatile unsigned int *) (addr)) = (b))
103 
104 #define HOST20_USBCMD_FrameListSize_1024                  0x00
105 #define HOST20_USBCMD_FrameListSize_512                   0x01
106 #define HOST20_USBCMD_FrameListSize_256                   0x02
107 
108 #define HOST20_Enable                  0x01
109 #define HOST20_Disable                 0x00
110 
111 #define HOST20_USBEVENT_USB_CDC_CTRL                      0x100
112 #define HOST20_USBEVENT_USB_CDC_BUILK_IN                  0x80
113 #define HOST20_USBEVENT_USB_CDC_BUILK_OUT                 0x40
114 #define HOST20_USBINTR_IntOnAsyncAdvance                  0x20
115 #define HOST20_USBINTR_SystemError                        0x10
116 #define HOST20_USBINTR_FrameRollover                      0x08
117 #define HOST20_USBINTR_PortChangeDetect                   0x04
118 #define HOST20_USBINTR_USBError                           0x02
119 #define HOST20_USBINTR_CompletionOfTransaction            0x01
120 #define USBWAITEVENTS   (HOST20_USBINTR_CompletionOfTransaction|HOST20_USBINTR_USBError|HOST20_USBINTR_PortChangeDetect|HOST20_USBINTR_SystemError)
121 
122 #define USBCINTR_IDChange                                 0x08
123 #define USBCINTR_BValidChange                             0x04
124 #define USBCINTR_AValidChange                             0x02
125 #define USBCINTR_VBusValidChange                          0x01
126 
127 extern void ms_UTMI_ORXBYTE_EX(MS_U8 offset,MS_U8 val, MS_U32 base);
128 extern void ms_UTMI_ANDXBYTE_EX(MS_U8 offset,MS_U8 val, MS_U32 base);
129 extern void ms_UTMI_SETXBYTE_EX(MS_U8 offset,MS_U8 val, MS_U32 base);
130 extern MS_U8 ms_UTMI_READXBYTE_EX(MS_U8 offset, MS_U32 base);
131 extern void ms_ehci_interrupt_enable (struct usb_hcd *hcd, int str_on);
132 extern void ms_ehci_interrupt_disable (struct usb_hcd *hcd);
133 extern void ms_RH_force_FSmode(struct usb_hcd *, int);
134 extern void ms_ResetMstarUsb(struct usb_hcd *);
135 extern BOOL ms_RoothubPortConnected(struct usb_hcd *hcd);
136 extern BOOL ms_RoothubPortConnectChg(struct usb_hcd *hcd);
137 extern BOOL ms_RoothubPortEnabled(struct usb_hcd *hcd);
138 extern BOOL ms_isHcdRunning(struct usb_hcd *hcd);
139 extern void ms_forceHcdRun(struct usb_hcd *hcd);
140 extern void ms_roothub_disconn_reinit(struct usb_hcd *);
141 #ifdef _USB_ENABLE_BDMA_PATCH
142 extern void m_BDMA_write(unsigned int, unsigned int);
143 extern void set_64bit_OBF_cipher(void);
144 extern int get_64bit_OBF_cipher(void);
145 #endif
146 
147 #define USB_DELAY(_msec)           MsOS_DelayTask(_msec)
148 #define USB_DELAY_USEC(_usec)           MsOS_DelayTaskUs(_usec)
149 #define USB_TIME(_stamp, _loop)    { _stamp = (_loop); }
150 #define USB_EXPIRE(_stamp)         ( !(--_stamp) )
151 
152 #ifdef ENABLE_XHC_COMPANION
153 //------- xHCI --------
154 #define PORT_PE                 (1 << 1)
155 #define PORT_PLS_MASK           (0xf << 5)
156 #define PORT_LINK_STROBE        (1 << 16)
157 
158 #define XHCI_PORT_RO    ((1<<0) | (1<<3) | (0xf<<10) | (1<<30))
159 #define XHCI_PORT_RWS   ((0xf<<5) | (1<<9) | (0x3<<14) | (0x7<<25))
160 
161 #define USB_SS_PORT_LS_SS_DISABLED      0x0080
162 #define USB_SS_PORT_LS_RX_DETECT        0x00a0
163 
164 void xhci_ppc(struct xhc_comp *xhci, int bOn);
165 void xhci_enable_clock(void);
166 void xhci_ssport_set_state(struct xhc_comp *xhci, int bOn);
167 //--------------------
168 #endif
169 #endif  //#define DRV_USB_HWCTL_H
170 
171