]> git.proxmox.com Git - mirror_edk2.git/blame_incremental - MdeModulePkg/Bus/Pci/EhciDxe/EhciReg.h
1. Correct File header to ## @file
[mirror_edk2.git] / MdeModulePkg / Bus / Pci / EhciDxe / EhciReg.h
... / ...
CommitLineData
1/** @file\r
2\r
3 This file contains the definination for host controller register operation routines.\r
4\r
5Copyright (c) 2007 - 2010, Intel Corporation\r
6All rights reserved. This program and the accompanying materials\r
7are licensed and made available under the terms and conditions of the BSD License\r
8which accompanies this distribution. The full text of the license may be found at\r
9http://opensource.org/licenses/bsd-license.php\r
10\r
11THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
12WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
13\r
14**/\r
15\r
16#ifndef _EFI_EHCI_REG_H_\r
17#define _EFI_EHCI_REG_H_\r
18\r
19//\r
20// EHCI register offset\r
21//\r
22\r
23\r
24//\r
25// Capability register offset\r
26//\r
27#define EHC_CAPLENGTH_OFFSET 0 // Capability register length offset\r
28#define EHC_HCSPARAMS_OFFSET 0x04 // Structural Parameters 04-07h\r
29#define EHC_HCCPARAMS_OFFSET 0x08 // Capability parameters offset\r
30\r
31//\r
32// Capability register bit definition\r
33//\r
34#define HCSP_NPORTS 0x0F // Number of root hub port\r
35#define HCCP_64BIT 0x01 // 64-bit addressing capability\r
36\r
37//\r
38// Operational register offset\r
39//\r
40#define EHC_USBCMD_OFFSET 0x0 // USB command register offset\r
41#define EHC_USBSTS_OFFSET 0x04 // Statue register offset\r
42#define EHC_USBINTR_OFFSET 0x08 // USB interrutp offset\r
43#define EHC_FRINDEX_OFFSET 0x0C // Frame index offset\r
44#define EHC_CTRLDSSEG_OFFSET 0x10 // Control data structure segment offset\r
45#define EHC_FRAME_BASE_OFFSET 0x14 // Frame list base address offset\r
46#define EHC_ASYNC_HEAD_OFFSET 0x18 // Next asynchronous list address offset\r
47#define EHC_CONFIG_FLAG_OFFSET 0x40 // Configure flag register offset\r
48#define EHC_PORT_STAT_OFFSET 0x44 // Port status/control offset\r
49\r
50#define EHC_FRAME_LEN 1024\r
51\r
52//\r
53// Register bit definition\r
54//\r
55#define CONFIGFLAG_ROUTE_EHC 0x01 // Route port to EHC\r
56\r
57#define USBCMD_RUN 0x01 // Run/stop\r
58#define USBCMD_RESET 0x02 // Start the host controller reset\r
59#define USBCMD_ENABLE_PERIOD 0x10 // Enable periodic schedule\r
60#define USBCMD_ENABLE_ASYNC 0x20 // Enable asynchronous schedule\r
61#define USBCMD_IAAD 0x40 // Interrupt on async advance doorbell\r
62\r
63#define USBSTS_IAA 0x20 // Interrupt on async advance\r
64#define USBSTS_PERIOD_ENABLED 0x4000 // Periodic schedule status\r
65#define USBSTS_ASYNC_ENABLED 0x8000 // Asynchronous schedule status\r
66#define USBSTS_HALT 0x1000 // Host controller halted\r
67#define USBSTS_SYS_ERROR 0x10 // Host system error\r
68#define USBSTS_INTACK_MASK 0x003F // Mask for the interrupt ACK, the WC\r
69 // (write clean) bits in USBSTS register\r
70\r
71#define PORTSC_CONN 0x01 // Current Connect Status\r
72#define PORTSC_CONN_CHANGE 0x02 // Connect Status Change\r
73#define PORTSC_ENABLED 0x04 // Port Enable / Disable\r
74#define PORTSC_ENABLE_CHANGE 0x08 // Port Enable / Disable Change\r
75#define PORTSC_OVERCUR 0x10 // Over current Active\r
76#define PORTSC_OVERCUR_CHANGE 0x20 // Over current Change\r
77#define PORSTSC_RESUME 0x40 // Force Port Resume\r
78#define PORTSC_SUSPEND 0x80 // Port Suspend State\r
79#define PORTSC_RESET 0x100 // Port Reset\r
80#define PORTSC_LINESTATE_K 0x400 // Line Status K-state\r
81#define PORTSC_LINESTATE_J 0x800 // Line Status J-state\r
82#define PORTSC_POWER 0x1000 // Port Power\r
83#define PORTSC_OWNER 0x2000 // Port Owner\r
84#define PORTSC_CHANGE_MASK 0x2A // Mask of the port change bits,\r
85 // they are WC (write clean)\r
86//\r
87// PCI Configuration Registers\r
88//\r
89#define EHC_BAR_INDEX 0 // how many bytes away from USB_BASE to 0x10\r
90\r
91#define EHC_LINK_TERMINATED(Link) (((Link) & 0x01) != 0)\r
92\r
93#define EHC_ADDR(High, QhHw32) \\r
94 ((VOID *) (UINTN) (LShiftU64 ((High), 32) | ((QhHw32) & 0xFFFFFFF0)))\r
95\r
96#define EHCI_IS_DATAIN(EndpointAddr) EHC_BIT_IS_SET((EndpointAddr), 0x80)\r
97\r
98//\r
99// Structure to map the hardware port states to the\r
100// UEFI's port states.\r
101//\r
102typedef struct {\r
103 UINT16 HwState;\r
104 UINT16 UefiState;\r
105} USB_PORT_STATE_MAP;\r
106\r
107//\r
108// Ehci Data and Ctrl Structures\r
109//\r
110#pragma pack(1)\r
111typedef struct {\r
112 UINT8 ProgInterface;\r
113 UINT8 SubClassCode;\r
114 UINT8 BaseCode;\r
115} USB_CLASSC;\r
116#pragma pack()\r
117\r
118/**\r
119 Read EHCI capability register.\r
120\r
121 @param Ehc The EHCI device.\r
122 @param Offset Capability register address.\r
123\r
124 @return The register content.\r
125\r
126**/\r
127UINT32\r
128EhcReadCapRegister (\r
129 IN USB2_HC_DEV *Ehc,\r
130 IN UINT32 Offset\r
131 );\r
132\r
133\r
134/**\r
135 Read EHCI Operation register.\r
136\r
137 @param Ehc The EHCI device.\r
138 @param Offset The operation register offset.\r
139\r
140 @return The register content.\r
141\r
142**/\r
143UINT32\r
144EhcReadOpReg (\r
145 IN USB2_HC_DEV *Ehc,\r
146 IN UINT32 Offset\r
147 );\r
148\r
149\r
150/**\r
151 Write the data to the EHCI operation register.\r
152\r
153 @param Ehc The EHCI device.\r
154 @param Offset EHCI operation register offset.\r
155 @param Data The data to write.\r
156\r
157**/\r
158VOID\r
159EhcWriteOpReg (\r
160 IN USB2_HC_DEV *Ehc,\r
161 IN UINT32 Offset,\r
162 IN UINT32 Data\r
163 );\r
164\r
165/**\r
166 Set one bit of the operational register while keeping other bits.\r
167\r
168 @param Ehc The EHCI device.\r
169 @param Offset The offset of the operational register.\r
170 @param Bit The bit mask of the register to set.\r
171\r
172**/\r
173VOID\r
174EhcSetOpRegBit (\r
175 IN USB2_HC_DEV *Ehc,\r
176 IN UINT32 Offset,\r
177 IN UINT32 Bit\r
178 );\r
179\r
180/**\r
181 Clear one bit of the operational register while keeping other bits.\r
182\r
183 @param Ehc The EHCI device.\r
184 @param Offset The offset of the operational register.\r
185 @param Bit The bit mask of the register to clear.\r
186\r
187**/\r
188VOID\r
189EhcClearOpRegBit (\r
190 IN USB2_HC_DEV *Ehc,\r
191 IN UINT32 Offset,\r
192 IN UINT32 Bit\r
193 );\r
194\r
195/**\r
196 Add support for UEFI Over Legacy (UoL) feature, stop\r
197 the legacy USB SMI support.\r
198\r
199 @param Ehc The EHCI device.\r
200\r
201**/\r
202VOID\r
203EhcClearLegacySupport (\r
204 IN USB2_HC_DEV *Ehc\r
205 );\r
206\r
207\r
208\r
209/**\r
210 Set door bell and wait it to be ACKed by host controller.\r
211 This function is used to synchronize with the hardware.\r
212\r
213 @param Ehc The EHCI device.\r
214 @param Timeout The time to wait before abort (in millisecond, ms).\r
215\r
216 @retval EFI_SUCCESS Synchronized with the hardware.\r
217 @retval EFI_TIMEOUT Time out happened while waiting door bell to set.\r
218\r
219**/\r
220EFI_STATUS\r
221EhcSetAndWaitDoorBell (\r
222 IN USB2_HC_DEV *Ehc,\r
223 IN UINT32 Timeout\r
224 );\r
225\r
226\r
227/**\r
228 Clear all the interrutp status bits, these bits are Write-Clean.\r
229\r
230 @param Ehc The EHCI device.\r
231\r
232**/\r
233VOID\r
234EhcAckAllInterrupt (\r
235 IN USB2_HC_DEV *Ehc\r
236 );\r
237\r
238\r
239\r
240/**\r
241 Whether Ehc is halted.\r
242\r
243 @param Ehc The EHCI device.\r
244\r
245 @retval TRUE The controller is halted.\r
246 @retval FALSE It isn't halted.\r
247\r
248**/\r
249BOOLEAN\r
250EhcIsHalt (\r
251 IN USB2_HC_DEV *Ehc\r
252 );\r
253\r
254\r
255/**\r
256 Whether system error occurred.\r
257\r
258 @param Ehc The EHCI device.\r
259\r
260 @retval TRUE System error happened.\r
261 @retval FALSE No system error.\r
262\r
263**/\r
264BOOLEAN\r
265EhcIsSysError (\r
266 IN USB2_HC_DEV *Ehc\r
267 );\r
268\r
269\r
270/**\r
271 Reset the host controller.\r
272\r
273 @param Ehc The EHCI device.\r
274 @param Timeout Time to wait before abort (in millisecond, ms).\r
275\r
276 @retval EFI_SUCCESS The host controller is reset.\r
277 @return Others Failed to reset the host.\r
278\r
279**/\r
280EFI_STATUS\r
281EhcResetHC (\r
282 IN USB2_HC_DEV *Ehc,\r
283 IN UINT32 Timeout\r
284 );\r
285\r
286\r
287/**\r
288 Halt the host controller.\r
289\r
290 @param Ehc The EHCI device.\r
291 @param Timeout Time to wait before abort.\r
292\r
293 @return EFI_SUCCESS The EHCI is halt.\r
294 @return EFI_TIMEOUT Failed to halt the controller before Timeout.\r
295\r
296**/\r
297EFI_STATUS\r
298EhcHaltHC (\r
299 IN USB2_HC_DEV *Ehc,\r
300 IN UINT32 Timeout\r
301 );\r
302\r
303\r
304/**\r
305 Set the EHCI to run.\r
306\r
307 @param Ehc The EHCI device.\r
308 @param Timeout Time to wait before abort.\r
309\r
310 @return EFI_SUCCESS The EHCI is running.\r
311 @return Others Failed to set the EHCI to run.\r
312\r
313**/\r
314EFI_STATUS\r
315EhcRunHC (\r
316 IN USB2_HC_DEV *Ehc,\r
317 IN UINT32 Timeout\r
318 );\r
319\r
320\r
321\r
322/**\r
323 Initialize the HC hardware.\r
324 EHCI spec lists the five things to do to initialize the hardware:\r
325 1. Program CTRLDSSEGMENT\r
326 2. Set USBINTR to enable interrupts\r
327 3. Set periodic list base\r
328 4. Set USBCMD, interrupt threshold, frame list size etc\r
329 5. Write 1 to CONFIGFLAG to route all ports to EHCI\r
330\r
331 @param Ehc The EHCI device.\r
332\r
333 @return EFI_SUCCESS The EHCI has come out of halt state.\r
334 @return EFI_TIMEOUT Time out happened.\r
335\r
336**/\r
337EFI_STATUS\r
338EhcInitHC (\r
339 IN USB2_HC_DEV *Ehc\r
340 );\r
341\r
342#endif\r