]>
Commit | Line | Data |
---|---|---|
d1f95000 | 1 | /** @file\r |
2 | EFI_USB_HC_PROTOCOL as defined in EFI 1.10.\r | |
3 | \r | |
4ca9b6c4 LG |
4 | The USB Host Controller Protocol is used by code, typically USB bus drivers, \r |
5 | running in the EFI boot services environment, to perform data transactions \r | |
6 | over a USB bus. In addition, it provides an abstraction for the root hub of the USB bus.\r | |
7 | \r | |
8 | Copyright (c) 2006 - 2008, Intel Corporation \r | |
d1f95000 | 9 | All rights reserved. This program and the accompanying materials \r |
10 | are licensed and made available under the terms and conditions of the BSD License \r | |
11 | which accompanies this distribution. The full text of the license may be found at \r | |
12 | http://opensource.org/licenses/bsd-license.php \r | |
13 | \r | |
14 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
15 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
16 | \r | |
d1f95000 | 17 | **/\r |
18 | \r | |
19 | #ifndef _USB_HOSTCONTROLLER_H_\r | |
20 | #define _USB_HOSTCONTROLLER_H_\r | |
21 | \r | |
22 | #include <Protocol/Usb2HostController.h>\r | |
23 | \r | |
24 | #define EFI_USB_HC_PROTOCOL_GUID \\r | |
25 | { \\r | |
26 | 0xf5089266, 0x1aa0, 0x4953, {0x97, 0xd8, 0x56, 0x2f, 0x8a, 0x73, 0xb5, 0x19 } \\r | |
27 | }\r | |
28 | \r | |
99e8ed21 | 29 | ///\r |
30 | /// Forward reference for pure ANSI compatability\r | |
31 | ///\r | |
d1f95000 | 32 | typedef struct _EFI_USB_HC_PROTOCOL EFI_USB_HC_PROTOCOL;\r |
33 | \r | |
34 | //\r | |
35 | // Protocol definitions\r | |
36 | //\r | |
37 | \r | |
38 | /** \r | |
39 | Provides software reset for the USB host controller.\r | |
40 | \r | |
41 | @param This A pointer to the EFI_USB_HC_PROTOCOL instance.\r | |
42 | @param Attributes A bit mask of the reset operation to perform.\r | |
43 | \r | |
44 | @retval EFI_SUCCESS The reset operation succeeded.\r | |
45 | @retval EFI_UNSUPPORTED The type of reset specified by Attributes is not currently supported\r | |
46 | by the host controller hardware. \r | |
47 | @retval EFI_INVALID_PARAMETER Attributes is not valid.\r | |
48 | @retval EFI_DEVICE_ERROR An error was encountered while attempting to perform the reset operation.\r | |
49 | \r | |
50 | **/\r | |
51 | typedef\r | |
52 | EFI_STATUS\r | |
8b13229b | 53 | (EFIAPI *EFI_USB_HC_PROTOCOL_RESET)(\r |
d1f95000 | 54 | IN EFI_USB_HC_PROTOCOL *This,\r |
55 | IN UINT16 Attributes\r | |
56 | );\r | |
57 | \r | |
58 | /** \r | |
59 | Retrieves current state of the USB host controller.\r | |
60 | \r | |
61 | @param This A pointer to the EFI_USB_HC_PROTOCOL instance.\r | |
62 | @param State A pointer to the EFI_USB_HC_STATE data structure that\r | |
63 | indicates current state of the USB host controller. \r | |
64 | \r | |
65 | @retval EFI_SUCCESS The state information of the host controller was returned in State.\r | |
66 | @retval EFI_INVALID_PARAMETER State is NULL.\r | |
67 | @retval EFI_DEVICE_ERROR An error was encountered while attempting to retrieve the host controller's\r | |
68 | current state. \r | |
69 | \r | |
70 | **/\r | |
71 | typedef\r | |
72 | EFI_STATUS\r | |
8b13229b | 73 | (EFIAPI *EFI_USB_HC_PROTOCOL_GET_STATE)(\r |
d1f95000 | 74 | IN EFI_USB_HC_PROTOCOL *This,\r |
75 | OUT EFI_USB_HC_STATE *State\r | |
76 | );\r | |
77 | \r | |
78 | /** \r | |
79 | Sets the USB host controller to a specific state.\r | |
80 | \r | |
81 | @param This A pointer to the EFI_USB_HC_PROTOCOL instance.\r | |
82 | @param State Indicates the state of the host controller that will be set. \r | |
83 | \r | |
84 | @retval EFI_SUCCESS The USB host controller was successfully placed in the state specified by\r | |
85 | State. \r | |
86 | @retval EFI_INVALID_PARAMETER State is NULL.\r | |
87 | @retval EFI_DEVICE_ERROR Failed to set the state specified by State due to device error. \r | |
88 | \r | |
89 | **/\r | |
90 | typedef\r | |
91 | EFI_STATUS\r | |
8b13229b | 92 | (EFIAPI *EFI_USB_HC_PROTOCOL_SET_STATE)(\r |
d1f95000 | 93 | IN EFI_USB_HC_PROTOCOL *This,\r |
94 | IN EFI_USB_HC_STATE State\r | |
95 | );\r | |
96 | \r | |
97 | /** \r | |
98 | Submits control transfer to a target USB device.\r | |
99 | \r | |
100 | @param This A pointer to the EFI_USB_HC_PROTOCOL instance.\r | |
101 | @param DeviceAddress Represents the address of the target device on the USB, which is\r | |
102 | assigned during USB enumeration. \r | |
103 | @param IsSlowDevice Indicates whether the target device is slow device or full-speed\r | |
104 | device. \r | |
105 | @param MaximumPacketLength Indicates the maximum packet size that the default control \r | |
106 | transfer endpoint is capable of sending or receiving. \r | |
107 | @param Request A pointer to the USB device request that will be sent to the USB\r | |
108 | device.\r | |
109 | @param TransferDirection Specifies the data direction for the transfer. \r | |
110 | @param Data A pointer to the buffer of data that will be transmitted to USB \r | |
111 | device or received from USB device. \r | |
112 | @param DataLength On input, indicates the size, in bytes, of the data buffer specified\r | |
113 | by Data. On output, indicates the amount of data actually \r | |
114 | transferred. \r | |
115 | @param TimeOut Indicates the maximum time, in milliseconds, which the transfer\r | |
116 | is allowed to complete. \r | |
117 | @param TransferResult A pointer to the detailed result information generated by this \r | |
118 | control transfer.\r | |
119 | \r | |
120 | @retval EFI_SUCCESS The control transfer was completed successfully.\r | |
121 | @retval EFI_OUT_OF_RESOURCES The control transfer could not be completed due to a lack of resources. \r | |
122 | @retval EFI_INVALID_PARAMETER Some parameters are invalid.\r | |
123 | @retval EFI_TIMEOUT The control transfer failed due to timeout.\r | |
124 | @retval EFI_DEVICE_ERROR The control transfer failed due to host controller or device error.\r | |
125 | \r | |
126 | **/\r | |
127 | typedef\r | |
128 | EFI_STATUS\r | |
8b13229b | 129 | (EFIAPI *EFI_USB_HC_PROTOCOL_CONTROL_TRANSFER)(\r |
d1f95000 | 130 | IN EFI_USB_HC_PROTOCOL *This,\r |
131 | IN UINT8 DeviceAddress,\r | |
132 | IN BOOLEAN IsSlowDevice,\r | |
133 | IN UINT8 MaximumPacketLength,\r | |
134 | IN EFI_USB_DEVICE_REQUEST *Request,\r | |
135 | IN EFI_USB_DATA_DIRECTION TransferDirection,\r | |
136 | IN OUT VOID *Data OPTIONAL,\r | |
137 | IN OUT UINTN *DataLength OPTIONAL,\r | |
138 | IN UINTN TimeOut,\r | |
139 | OUT UINT32 *TransferResult\r | |
140 | );\r | |
141 | \r | |
142 | /** \r | |
143 | Submits bulk transfer to a bulk endpoint of a USB device.\r | |
144 | \r | |
145 | @param This A pointer to the EFI_USB_HC_PROTOCOL instance.\r | |
146 | @param DeviceAddress Represents the address of the target device on the USB, which is\r | |
147 | assigned during USB enumeration. \r | |
148 | @param EndPointAddress The combination of an endpoint number and an endpoint\r | |
149 | direction of the target USB device. \r | |
150 | @param MaximumPacketLength Indicates the maximum packet size that the default control \r | |
151 | transfer endpoint is capable of sending or receiving. \r | |
152 | @param Data A pointer to the buffer of data that will be transmitted to USB \r | |
153 | device or received from USB device. \r | |
154 | @param DataLength On input, indicates the size, in bytes, of the data buffer specified\r | |
155 | by Data. On output, indicates the amount of data actually \r | |
156 | transferred. \r | |
157 | @param DataToggle A pointer to the data toggle value. \r | |
158 | @param TimeOut Indicates the maximum time, in milliseconds, which the transfer\r | |
159 | is allowed to complete. \r | |
160 | @param TransferResult A pointer to the detailed result information of the bulk transfer.\r | |
161 | \r | |
162 | @retval EFI_SUCCESS The bulk transfer was completed successfully.\r | |
163 | @retval EFI_OUT_OF_RESOURCES The bulk transfer could not be completed due to a lack of resources. \r | |
164 | @retval EFI_INVALID_PARAMETER Some parameters are invalid.\r | |
165 | @retval EFI_TIMEOUT The bulk transfer failed due to timeout.\r | |
166 | @retval EFI_DEVICE_ERROR The bulk transfer failed due to host controller or device error.\r | |
167 | \r | |
168 | **/\r | |
169 | typedef\r | |
170 | EFI_STATUS\r | |
8b13229b | 171 | (EFIAPI *EFI_USB_HC_PROTOCOL_BULK_TRANSFER)(\r |
d1f95000 | 172 | IN EFI_USB_HC_PROTOCOL *This,\r |
173 | IN UINT8 DeviceAddress,\r | |
174 | IN UINT8 EndPointAddress,\r | |
175 | IN UINT8 MaximumPacketLength,\r | |
176 | IN OUT VOID *Data,\r | |
177 | IN OUT UINTN *DataLength,\r | |
178 | IN OUT UINT8 *DataToggle,\r | |
179 | IN UINTN TimeOut,\r | |
180 | OUT UINT32 *TransferResult\r | |
181 | );\r | |
182 | \r | |
183 | /** \r | |
184 | Submits an asynchronous interrupt transfer to an interrupt endpoint of a USB device.\r | |
185 | \r | |
186 | @param This A pointer to the EFI_USB_HC_PROTOCOL instance.\r | |
187 | @param DeviceAddress Represents the address of the target device on the USB, which is\r | |
188 | assigned during USB enumeration. \r | |
189 | @param EndPointAddress The combination of an endpoint number and an endpoint\r | |
190 | direction of the target USB device. \r | |
191 | @param IsSlowDevice Indicates whether the target device is slow device or full-speed\r | |
192 | device. \r | |
193 | @param MaximumPacketLength Indicates the maximum packet size that the default control \r | |
194 | transfer endpoint is capable of sending or receiving. \r | |
195 | @param IsNewTransfer If TRUE, an asynchronous interrupt pipe is built between the host \r | |
196 | and the target interrupt endpoint. If FALSE, the specified \r | |
197 | @param DataToggle A pointer to the data toggle value. \r | |
198 | @param PollingInterval Indicates the interval, in milliseconds, that the asynchronous\r | |
199 | interrupt transfer is polled. asynchronous interrupt pipe is canceled. \r | |
200 | @param DataLength Indicates the length of data to be received at the rate specified by\r | |
201 | PollingInterval from the target asynchronous interrupt \r | |
202 | endpoint. \r | |
203 | @param CallBackFunction The Callback function. \r | |
204 | @param Context The context that is passed to the CallBackFunction.\r | |
205 | \r | |
206 | @retval EFI_SUCCESS The asynchronous interrupt transfer request has been successfully\r | |
207 | submitted or canceled. \r | |
208 | @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. \r | |
209 | @retval EFI_INVALID_PARAMETER Some parameters are invalid.\r | |
210 | @retval EFI_TIMEOUT The bulk transfer failed due to timeout.\r | |
211 | @retval EFI_DEVICE_ERROR The bulk transfer failed due to host controller or device error.\r | |
212 | \r | |
213 | **/\r | |
214 | typedef\r | |
215 | EFI_STATUS\r | |
8b13229b | 216 | (EFIAPI *EFI_USB_HC_PROTOCOL_ASYNC_INTERRUPT_TRANSFER)(\r |
d1f95000 | 217 | IN EFI_USB_HC_PROTOCOL *This,\r |
218 | IN UINT8 DeviceAddress,\r | |
219 | IN UINT8 EndPointAddress,\r | |
220 | IN BOOLEAN IsSlowDevice,\r | |
221 | IN UINT8 MaxiumPacketLength,\r | |
222 | IN BOOLEAN IsNewTransfer,\r | |
223 | IN OUT UINT8 *DataToggle,\r | |
224 | IN UINTN PollingInterval OPTIONAL,\r | |
225 | IN UINTN DataLength OPTIONAL,\r | |
226 | IN EFI_ASYNC_USB_TRANSFER_CALLBACK CallBackFunction OPTIONAL,\r | |
227 | IN VOID *Context OPTIONAL\r | |
228 | );\r | |
229 | \r | |
230 | /** \r | |
231 | Submits synchronous interrupt transfer to an interrupt endpoint of a USB device.\r | |
232 | \r | |
233 | @param This A pointer to the EFI_USB_HC_PROTOCOL instance.\r | |
234 | @param DeviceAddress Represents the address of the target device on the USB, which is\r | |
235 | assigned during USB enumeration. \r | |
236 | @param EndPointAddress The combination of an endpoint number and an endpoint\r | |
237 | direction of the target USB device. \r | |
238 | @param IsSlowDevice Indicates whether the target device is slow device or full-speed\r | |
239 | device. \r | |
240 | @param MaximumPacketLength Indicates the maximum packet size that the default control \r | |
241 | transfer endpoint is capable of sending or receiving. \r | |
242 | @param Data A pointer to the buffer of data that will be transmitted to USB\r | |
243 | device or received from USB device. asynchronous interrupt pipe is canceled. \r | |
244 | @param DataLength On input, the size, in bytes, of the data buffer specified by Data.\r | |
245 | On output, the number of bytes transferred. \r | |
246 | @param DataToggle A pointer to the data toggle value. \r | |
247 | @param TimeOut Indicates the maximum time, in milliseconds, which the transfer \r | |
248 | is allowed to complete. \r | |
249 | @param TransferResult A pointer to the detailed result information from the synchronous\r | |
250 | interrupt transfer.\r | |
251 | \r | |
252 | @retval EFI_SUCCESS The synchronous interrupt transfer was completed successfully.\r | |
253 | @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. \r | |
254 | @retval EFI_INVALID_PARAMETER Some parameters are invalid.\r | |
255 | @retval EFI_TIMEOUT The synchronous interrupt transfer failed due to timeout.\r | |
256 | @retval EFI_DEVICE_ERROR The synchronous interrupt transfer failed due to host controller or device error.\r | |
257 | \r | |
258 | **/\r | |
259 | typedef\r | |
260 | EFI_STATUS\r | |
8b13229b | 261 | (EFIAPI *EFI_USB_HC_PROTOCOL_SYNC_INTERRUPT_TRANSFER)(\r |
d1f95000 | 262 | IN EFI_USB_HC_PROTOCOL *This,\r |
263 | IN UINT8 DeviceAddress,\r | |
264 | IN UINT8 EndPointAddress,\r | |
265 | IN BOOLEAN IsSlowDevice,\r | |
266 | IN UINT8 MaximumPacketLength,\r | |
267 | IN OUT VOID *Data,\r | |
268 | IN OUT UINTN *DataLength,\r | |
269 | IN OUT UINT8 *DataToggle,\r | |
270 | IN UINTN TimeOut,\r | |
271 | OUT UINT32 *TransferResult\r | |
272 | );\r | |
273 | \r | |
274 | /** \r | |
275 | Submits isochronous transfer to an isochronous endpoint of a USB device.\r | |
276 | \r | |
277 | @param This A pointer to the EFI_USB_HC_PROTOCOL instance.\r | |
278 | @param DeviceAddress Represents the address of the target device on the USB, which is\r | |
279 | assigned during USB enumeration. \r | |
280 | @param EndPointAddress The combination of an endpoint number and an endpoint\r | |
281 | direction of the target USB device. \r | |
282 | @param MaximumPacketLength Indicates the maximum packet size that the default control \r | |
283 | transfer endpoint is capable of sending or receiving. \r | |
284 | @param Data A pointer to the buffer of data that will be transmitted to USB\r | |
285 | device or received from USB device. asynchronous interrupt pipe is canceled. \r | |
286 | @param DataLength Specifies the length, in bytes, of the data to be sent to or received\r | |
287 | from the USB device. \r | |
288 | @param TransferResult A pointer to the detailed result information from the isochronous\r | |
289 | transfer.\r | |
290 | \r | |
291 | @retval EFI_SUCCESS The isochronous transfer was completed successfully.\r | |
292 | @retval EFI_OUT_OF_RESOURCES The isochronous could not be completed due to a lack of resources. \r | |
293 | @retval EFI_INVALID_PARAMETER Some parameters are invalid.\r | |
294 | @retval EFI_TIMEOUT The isochronous transfer failed due to timeout.\r | |
295 | @retval EFI_DEVICE_ERROR The isochronous transfer failed due to host controller or device error.\r | |
296 | \r | |
297 | **/\r | |
298 | typedef\r | |
299 | EFI_STATUS\r | |
8b13229b | 300 | (EFIAPI *EFI_USB_HC_PROTOCOL_ISOCHRONOUS_TRANSFER)(\r |
d1f95000 | 301 | IN EFI_USB_HC_PROTOCOL *This,\r |
302 | IN UINT8 DeviceAddress,\r | |
303 | IN UINT8 EndPointAddress,\r | |
304 | IN UINT8 MaximumPacketLength,\r | |
305 | IN OUT VOID *Data,\r | |
306 | IN UINTN DataLength,\r | |
307 | OUT UINT32 *TransferResult\r | |
308 | );\r | |
309 | \r | |
310 | /** \r | |
311 | Submits nonblocking isochronous transfer to an isochronous endpoint of a USB device.\r | |
312 | \r | |
313 | @param This A pointer to the EFI_USB_HC_PROTOCOL instance.\r | |
314 | @param DeviceAddress Represents the address of the target device on the USB, which is\r | |
315 | assigned during USB enumeration. \r | |
316 | @param EndPointAddress The combination of an endpoint number and an endpoint\r | |
317 | direction of the target USB device. \r | |
318 | @param MaximumPacketLength Indicates the maximum packet size that the default control \r | |
319 | transfer endpoint is capable of sending or receiving. \r | |
320 | @param Data A pointer to the buffer of data that will be transmitted to USB\r | |
321 | device or received from USB device. asynchronous interrupt pipe is canceled. \r | |
322 | @param DataLength Specifies the length, in bytes, of the data to be sent to or received\r | |
323 | from the USB device. \r | |
324 | @param IsochronousCallback The Callback function.\r | |
325 | @param Context Data passed to the IsochronousCallback function. This is\r | |
326 | an optional parameter and may be NULL.\r | |
327 | \r | |
328 | @retval EFI_SUCCESS The asynchronous isochronous transfer was completed successfully.\r | |
329 | @retval EFI_OUT_OF_RESOURCES The asynchronous isochronous could not be completed due to a lack of resources. \r | |
330 | @retval EFI_INVALID_PARAMETER Some parameters are invalid.\r | |
331 | \r | |
332 | **/\r | |
333 | typedef\r | |
334 | EFI_STATUS\r | |
8b13229b | 335 | (EFIAPI *EFI_USB_HC_PROTOCOL_ASYNC_ISOCHRONOUS_TRANSFER)(\r |
d1f95000 | 336 | IN EFI_USB_HC_PROTOCOL *This,\r |
337 | IN UINT8 DeviceAddress,\r | |
338 | IN UINT8 EndPointAddress,\r | |
339 | IN UINT8 MaximumPacketLength,\r | |
340 | IN OUT VOID *Data,\r | |
341 | IN UINTN DataLength,\r | |
342 | IN EFI_ASYNC_USB_TRANSFER_CALLBACK IsochronousCallBack,\r | |
343 | IN VOID *Context OPTIONAL\r | |
344 | );\r | |
345 | \r | |
346 | /** \r | |
347 | Retrieves the number of root hub ports.\r | |
348 | \r | |
349 | @param This A pointer to the EFI_USB_HC_PROTOCOL instance.\r | |
350 | @param PortNumber A pointer to the number of the root hub ports. \r | |
351 | \r | |
352 | @retval EFI_SUCCESS The port number was retrieved successfully.\r | |
353 | @retval EFI_DEVICE_ERROR An error was encountered while attempting to retrieve the port number.\r | |
354 | @retval EFI_INVALID_PARAMETER PortNumber is NULL.\r | |
355 | \r | |
356 | **/\r | |
357 | typedef\r | |
358 | EFI_STATUS\r | |
8b13229b | 359 | (EFIAPI *EFI_USB_HC_PROTOCOL_GET_ROOTHUB_PORT_NUMBER)(\r |
d1f95000 | 360 | IN EFI_USB_HC_PROTOCOL *This,\r |
361 | OUT UINT8 *PortNumber\r | |
362 | );\r | |
363 | \r | |
364 | /** \r | |
365 | Retrieves the current status of a USB root hub port.\r | |
366 | \r | |
367 | @param This A pointer to the EFI_USB_HC_PROTOCOL instance.\r | |
368 | @param PortNumber Specifies the root hub port from which the status is to be retrieved.\r | |
369 | This value is zero based.\r | |
370 | @param PortStatus A pointer to the current port status bits and port status change bits. \r | |
371 | \r | |
372 | @retval EFI_SUCCESS The status of the USB root hub port specified by PortNumber\r | |
373 | was returned in PortStatus. \r | |
374 | @retval EFI_INVALID_PARAMETER PortNumber is invalid.\r | |
375 | \r | |
376 | **/\r | |
377 | typedef\r | |
378 | EFI_STATUS\r | |
8b13229b | 379 | (EFIAPI *EFI_USB_HC_PROTOCOL_GET_ROOTHUB_PORT_STATUS)(\r |
d1f95000 | 380 | IN EFI_USB_HC_PROTOCOL *This,\r |
381 | IN UINT8 PortNumber,\r | |
382 | OUT EFI_USB_PORT_STATUS *PortStatus\r | |
383 | );\r | |
384 | \r | |
385 | /** \r | |
386 | Sets a feature for the specified root hub port.\r | |
387 | \r | |
388 | @param This A pointer to the EFI_USB_HC_PROTOCOL instance.\r | |
389 | @param PortNumber Specifies the root hub port from which the status is to be retrieved.\r | |
390 | This value is zero based.\r | |
391 | @param PortFeature Indicates the feature selector associated with the feature set\r | |
392 | request.\r | |
393 | \r | |
394 | @retval EFI_SUCCESS The feature specified by PortFeature was set for the USB\r | |
395 | root hub port specified by PortNumber. \r | |
396 | @retval EFI_INVALID_PARAMETER PortNumber is invalid or PortFeature is invalid for this function.\r | |
397 | \r | |
398 | **/\r | |
399 | typedef\r | |
400 | EFI_STATUS\r | |
8b13229b | 401 | (EFIAPI *EFI_USB_HC_PROTOCOL_SET_ROOTHUB_PORT_FEATURE)(\r |
d1f95000 | 402 | IN EFI_USB_HC_PROTOCOL *This,\r |
403 | IN UINT8 PortNumber,\r | |
404 | IN EFI_USB_PORT_FEATURE PortFeature\r | |
405 | );\r | |
406 | \r | |
407 | /** \r | |
408 | Clears a feature for the specified root hub port.\r | |
409 | \r | |
410 | @param This A pointer to the EFI_USB_HC_PROTOCOL instance.\r | |
411 | @param PortNumber Specifies the root hub port from which the status is to be cleared.\r | |
412 | This value is zero based.\r | |
413 | @param PortFeature Indicates the feature selector associated with the feature clear\r | |
414 | request.\r | |
415 | \r | |
416 | @retval EFI_SUCCESS The feature specified by PortFeature was cleared for the USB\r | |
417 | root hub port specified by PortNumber. \r | |
418 | @retval EFI_INVALID_PARAMETER PortNumber is invalid or PortFeature is invalid for this function.\r | |
419 | \r | |
420 | **/\r | |
421 | typedef\r | |
422 | EFI_STATUS\r | |
8b13229b | 423 | (EFIAPI *EFI_USB_HC_PROTOCOL_CLEAR_ROOTHUB_PORT_FEATURE)(\r |
d1f95000 | 424 | IN EFI_USB_HC_PROTOCOL *This,\r |
425 | IN UINT8 PortNumber,\r | |
426 | IN EFI_USB_PORT_FEATURE PortFeature\r | |
427 | );\r | |
428 | \r | |
4ca9b6c4 LG |
429 | \r |
430 | /** \r | |
431 | @par Protocol Description:\r | |
432 | The EFI_USB_HC_PROTOCOL provides USB host controller management, basic data transactions\r | |
433 | over a USB bus, and USB root hub access. A device driver that wishes to manage a USB bus in a\r | |
434 | system retrieves the EFI_USB_HC_PROTOCOL instance that is associated with the USB bus to be\r | |
435 | managed. A device handle for a USB host controller will minimally contain an\r | |
436 | EFI_DEVICE_PATH_PROTOCOL instance, and an EFI_USB_HC_PROTOCOL instance. \r | |
437 | \r | |
438 | @param Reset \r | |
439 | Software reset of USB. \r | |
440 | \r | |
441 | @param GetState \r | |
442 | Retrieves the current state of the USB host controller. \r | |
443 | \r | |
444 | @param SetState \r | |
445 | Sets the USB host controller to a specific state. \r | |
446 | \r | |
447 | @param ControlTransfer \r | |
448 | Submits a control transfer to a target USB device. \r | |
449 | \r | |
450 | @param BulkTransfer \r | |
451 | Submits a bulk transfer to a bulk endpoint of a USB device. \r | |
452 | \r | |
453 | @param AsyncInterruptTransfer\r | |
454 | Submits an asynchronous interrupt transfer to an interrupt endpoint\r | |
455 | of a USB device. \r | |
456 | \r | |
457 | @param SyncInterruptTransfer\r | |
458 | Submits a synchronous interrupt transfer to an interrupt endpoint\r | |
459 | of a USB device.\r | |
460 | \r | |
461 | @param IsochronousTransfer \r | |
462 | Submits isochronous transfer to an isochronous endpoint of a USB device.\r | |
463 | \r | |
464 | @param AsyncIsochronousTransfer\r | |
465 | Submits nonblocking USB isochronous transfer.\r | |
466 | \r | |
467 | @param GetRootHubPortNumber \r | |
468 | Retrieves the number of root hub ports that are produced by the\r | |
469 | USB host controller. \r | |
470 | \r | |
471 | @param GetRootHubPortStatus \r | |
472 | Retrieves the status of the specified root hub port. \r | |
473 | \r | |
474 | @param SetRootHubPortFeature\r | |
475 | Sets the feature for the specified root hub port.\r | |
476 | \r | |
477 | @param ClearRootHubPortFeature\r | |
478 | Clears the feature for the specified root hub port. \r | |
479 | \r | |
480 | @param MajorRevision \r | |
481 | The major revision number of the USB host controller. The\r | |
482 | revision information indicates the release of the Universal Serial\r | |
483 | Bus Specification with which the host controller is compliant.\r | |
484 | \r | |
485 | @param MinorRevision \r | |
486 | The minor revision number of the USB host controller. The\r | |
487 | revision information indicates the release of the Universal Serial\r | |
488 | Bus Specification with which the host controller is compliant.\r | |
489 | \r | |
490 | **/\r | |
d1f95000 | 491 | struct _EFI_USB_HC_PROTOCOL {\r |
492 | EFI_USB_HC_PROTOCOL_RESET Reset;\r | |
493 | EFI_USB_HC_PROTOCOL_GET_STATE GetState;\r | |
494 | EFI_USB_HC_PROTOCOL_SET_STATE SetState;\r | |
495 | EFI_USB_HC_PROTOCOL_CONTROL_TRANSFER ControlTransfer;\r | |
496 | EFI_USB_HC_PROTOCOL_BULK_TRANSFER BulkTransfer;\r | |
497 | EFI_USB_HC_PROTOCOL_ASYNC_INTERRUPT_TRANSFER AsyncInterruptTransfer;\r | |
498 | EFI_USB_HC_PROTOCOL_SYNC_INTERRUPT_TRANSFER SyncInterruptTransfer;\r | |
499 | EFI_USB_HC_PROTOCOL_ISOCHRONOUS_TRANSFER IsochronousTransfer;\r | |
500 | EFI_USB_HC_PROTOCOL_ASYNC_ISOCHRONOUS_TRANSFER AsyncIsochronousTransfer;\r | |
501 | EFI_USB_HC_PROTOCOL_GET_ROOTHUB_PORT_NUMBER GetRootHubPortNumber;\r | |
502 | EFI_USB_HC_PROTOCOL_GET_ROOTHUB_PORT_STATUS GetRootHubPortStatus;\r | |
503 | EFI_USB_HC_PROTOCOL_SET_ROOTHUB_PORT_FEATURE SetRootHubPortFeature;\r | |
504 | EFI_USB_HC_PROTOCOL_CLEAR_ROOTHUB_PORT_FEATURE ClearRootHubPortFeature;\r | |
505 | UINT16 MajorRevision;\r | |
506 | UINT16 MinorRevision;\r | |
507 | };\r | |
508 | \r | |
509 | extern EFI_GUID gEfiUsbHcProtocolGuid;\r | |
510 | \r | |
511 | #endif\r |