iPXE
UsbHostController.h
Go to the documentation of this file.
1 /** @file
2  EFI_USB_HC_PROTOCOL as defined in EFI 1.10.
3 
4  The USB Host Controller Protocol is used by code, typically USB bus drivers,
5  running in the EFI boot services environment, to perform data transactions
6  over a USB bus. In addition, it provides an abstraction for the root hub of the USB bus.
7 
8  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
9  SPDX-License-Identifier: BSD-2-Clause-Patent
10 
11 **/
12 
13 #ifndef _USB_HOSTCONTROLLER_H_
14 #define _USB_HOSTCONTROLLER_H_
15 
16 FILE_LICENCE ( BSD2_PATENT );
17 
19 
20 #define EFI_USB_HC_PROTOCOL_GUID \
21  { \
22  0xf5089266, 0x1aa0, 0x4953, {0x97, 0xd8, 0x56, 0x2f, 0x8a, 0x73, 0xb5, 0x19 } \
23  }
24 
25 ///
26 /// Forward reference for pure ANSI compatability
27 ///
29 
30 //
31 // Protocol definitions
32 //
33 
34 /**
35  Provides software reset for the USB host controller.
36 
37  @param This A pointer to the EFI_USB_HC_PROTOCOL instance.
38  @param Attributes A bit mask of the reset operation to perform.
39 
40  @retval EFI_SUCCESS The reset operation succeeded.
41  @retval EFI_UNSUPPORTED The type of reset specified by Attributes is not currently supported
42  by the host controller hardware.
43  @retval EFI_INVALID_PARAMETER Attributes is not valid.
44  @retval EFI_DEVICE_ERROR An error was encountered while attempting to perform the reset operation.
45 
46 **/
47 typedef
50  IN EFI_USB_HC_PROTOCOL *This,
51  IN UINT16 Attributes
52  );
53 
54 /**
55  Retrieves current state of the USB host controller.
56 
57  @param This A pointer to the EFI_USB_HC_PROTOCOL instance.
58  @param State A pointer to the EFI_USB_HC_STATE data structure that
59  indicates current state of the USB host controller.
60 
61  @retval EFI_SUCCESS The state information of the host controller was returned in State.
62  @retval EFI_INVALID_PARAMETER State is NULL.
63  @retval EFI_DEVICE_ERROR An error was encountered while attempting to retrieve the host controller's
64  current state.
65 
66 **/
67 typedef
70  IN EFI_USB_HC_PROTOCOL *This,
71  OUT EFI_USB_HC_STATE *State
72  );
73 
74 /**
75  Sets the USB host controller to a specific state.
76 
77  @param This A pointer to the EFI_USB_HC_PROTOCOL instance.
78  @param State Indicates the state of the host controller that will be set.
79 
80  @retval EFI_SUCCESS The USB host controller was successfully placed in the state specified by
81  State.
82  @retval EFI_INVALID_PARAMETER State is NULL.
83  @retval EFI_DEVICE_ERROR Failed to set the state specified by State due to device error.
84 
85 **/
86 typedef
89  IN EFI_USB_HC_PROTOCOL *This,
90  IN EFI_USB_HC_STATE State
91  );
92 
93 /**
94  Submits control transfer to a target USB device.
95 
96  @param This A pointer to the EFI_USB_HC_PROTOCOL instance.
97  @param DeviceAddress Represents the address of the target device on the USB, which is
98  assigned during USB enumeration.
99  @param IsSlowDevice Indicates whether the target device is slow device or full-speed
100  device.
101  @param MaximumPacketLength Indicates the maximum packet size that the default control
102  transfer endpoint is capable of sending or receiving.
103  @param Request A pointer to the USB device request that will be sent to the USB
104  device.
105  @param TransferDirection Specifies the data direction for the transfer. There are three
106  values available, EfiUsbDataIn, EfiUsbDataOut and EfiUsbNoData.
107  @param Data A pointer to the buffer of data that will be transmitted to USB
108  device or received from USB device.
109  @param DataLength On input, indicates the size, in bytes, of the data buffer specified
110  by Data. On output, indicates the amount of data actually
111  transferred.
112  @param TimeOut Indicates the maximum time, in milliseconds, which the transfer
113  is allowed to complete.
114  @param TransferResult A pointer to the detailed result information generated by this
115  control transfer.
116 
117  @retval EFI_SUCCESS The control transfer was completed successfully.
118  @retval EFI_OUT_OF_RESOURCES The control transfer could not be completed due to a lack of resources.
119  @retval EFI_INVALID_PARAMETER Some parameters are invalid.
120  @retval EFI_TIMEOUT The control transfer failed due to timeout.
121  @retval EFI_DEVICE_ERROR The control transfer failed due to host controller or device error.
122 
123 **/
124 typedef
127  IN EFI_USB_HC_PROTOCOL *This,
128  IN UINT8 DeviceAddress,
129  IN BOOLEAN IsSlowDevice,
130  IN UINT8 MaximumPacketLength,
131  IN EFI_USB_DEVICE_REQUEST *Request,
132  IN EFI_USB_DATA_DIRECTION TransferDirection,
133  IN OUT VOID *Data OPTIONAL,
135  IN UINTN TimeOut,
136  OUT UINT32 *TransferResult
137  );
138 
139 /**
140  Submits bulk transfer to a bulk endpoint of a USB device.
141 
142  @param This A pointer to the EFI_USB_HC_PROTOCOL instance.
143  @param DeviceAddress Represents the address of the target device on the USB, which is
144  assigned during USB enumeration.
145  @param EndPointAddress The combination of an endpoint number and an endpoint
146  direction of the target USB device. Each endpoint address
147  supports data transfer in one direction except the control
148  endpoint (whose default endpoint address is 0). It is the
149  caller's responsibility to make sure that the EndPointAddress
150  represents a bulk endpoint.
151  @param MaximumPacketLength Indicates the maximum packet size that the default control
152  transfer endpoint is capable of sending or receiving.
153  @param Data A pointer to the buffer of data that will be transmitted to USB
154  device or received from USB device.
155  @param DataLength On input, indicates the size, in bytes, of the data buffer specified
156  by Data. On output, indicates the amount of data actually
157  transferred.
158  @param DataToggle A pointer to the data toggle value.
159  @param TimeOut Indicates the maximum time, in milliseconds, which the transfer
160  is allowed to complete.
161  @param TransferResult A pointer to the detailed result information of the bulk transfer.
162 
163  @retval EFI_SUCCESS The bulk transfer was completed successfully.
164  @retval EFI_OUT_OF_RESOURCES The bulk transfer could not be completed due to a lack of resources.
165  @retval EFI_INVALID_PARAMETER Some parameters are invalid.
166  @retval EFI_TIMEOUT The bulk transfer failed due to timeout.
167  @retval EFI_DEVICE_ERROR The bulk transfer failed due to host controller or device error.
168 
169 **/
170 typedef
173  IN EFI_USB_HC_PROTOCOL *This,
174  IN UINT8 DeviceAddress,
175  IN UINT8 EndPointAddress,
176  IN UINT8 MaximumPacketLength,
177  IN OUT VOID *Data,
179  IN OUT UINT8 *DataToggle,
180  IN UINTN TimeOut,
181  OUT UINT32 *TransferResult
182  );
183 
184 /**
185  Submits an asynchronous interrupt transfer to an interrupt endpoint of a USB device.
186 
187  @param This A pointer to the EFI_USB_HC_PROTOCOL instance.
188  @param DeviceAddress Represents the address of the target device on the USB, which is
189  assigned during USB enumeration.
190  @param EndPointAddress The combination of an endpoint number and an endpoint
191  direction of the target USB device. Each endpoint address
192  supports data transfer in one direction except the control
193  endpoint (whose default endpoint address is zero). It is the
194  caller's responsibility to make sure that the
195  EndPointAddress represents an interrupt endpoint.
196  @param IsSlowDevice Indicates whether the target device is slow device or full-speed
197  device.
198  @param MaximumPacketLength Indicates the maximum packet size that the default control
199  transfer endpoint is capable of sending or receiving.
200  @param IsNewTransfer If TRUE, an asynchronous interrupt pipe is built between the host
201  and the target interrupt endpoint. If FALSE, the specified asynchronous
202  interrupt pipe is canceled. If TRUE, and an interrupt transfer exists
203  for the target end point, then EFI_INVALID_PARAMETER is returned.
204  @param DataToggle A pointer to the data toggle value. On input, it is valid when
205  IsNewTransfer is TRUE, and it indicates the initial data toggle
206  value the asynchronous interrupt transfer should adopt. On output,
207  it is valid when IsNewTransfer is FALSE, and it is updated to indicate
208  the data toggle value of the subsequent asynchronous interrupt transfer.
209  @param PollingInterval Indicates the interval, in milliseconds, that the asynchronous
210  interrupt transfer is polled.
211  @param DataLength Indicates the length of data to be received at the rate specified by
212  PollingInterval from the target asynchronous interrupt
213  endpoint. This parameter is only required when IsNewTransfer is TRUE.
214  @param CallBackFunction The Callback function. This function is called at the rate specified by
215  PollingInterval. This parameter is only required when IsNewTransfer is TRUE.
216  @param Context The context that is passed to the CallBackFunction.
217 
218  @retval EFI_SUCCESS The asynchronous interrupt transfer request has been successfully
219  submitted or canceled.
220  @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
221  @retval EFI_INVALID_PARAMETER Some parameters are invalid.
222  @retval EFI_TIMEOUT The bulk transfer failed due to timeout.
223  @retval EFI_DEVICE_ERROR The bulk transfer failed due to host controller or device error.
224 
225 **/
226 typedef
229  IN EFI_USB_HC_PROTOCOL *This,
230  IN UINT8 DeviceAddress,
231  IN UINT8 EndPointAddress,
232  IN BOOLEAN IsSlowDevice,
233  IN UINT8 MaxiumPacketLength,
234  IN BOOLEAN IsNewTransfer,
235  IN OUT UINT8 *DataToggle,
236  IN UINTN PollingInterval OPTIONAL,
239  IN VOID *Context OPTIONAL
240  );
241 
242 /**
243  Submits synchronous interrupt transfer to an interrupt endpoint of a USB device.
244 
245  @param This A pointer to the EFI_USB_HC_PROTOCOL instance.
246  @param DeviceAddress Represents the address of the target device on the USB, which is
247  assigned during USB enumeration.
248  @param EndPointAddress The combination of an endpoint number and an endpoint
249  direction of the target USB device. Each endpoint address
250  supports data transfer in one direction except the control
251  endpoint (whose default endpoint address is zero). It is the
252  caller's responsibility to make sure that the
253  EndPointAddress represents an interrupt endpoint.
254  @param IsSlowDevice Indicates whether the target device is slow device or full-speed
255  device.
256  @param MaximumPacketLength Indicates the maximum packet size that the default control
257  transfer endpoint is capable of sending or receiving.
258  @param Data A pointer to the buffer of data that will be transmitted to USB
259  device or received from USB device. asynchronous interrupt pipe is canceled.
260  @param DataLength On input, the size, in bytes, of the data buffer specified by Data.
261  On output, the number of bytes transferred.
262  @param DataToggle A pointer to the data toggle value. On input, it indicates the initial
263  data toggle value the synchronous interrupt transfer should adopt;
264  on output, it is updated to indicate the data toggle value of the
265  subsequent synchronous interrupt transfer.
266  @param TimeOut Indicates the maximum time, in milliseconds, which the transfer
267  is allowed to complete.
268  @param TransferResult A pointer to the detailed result information from the synchronous
269  interrupt transfer.
270 
271  @retval EFI_SUCCESS The synchronous interrupt transfer was completed successfully.
272  @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
273  @retval EFI_INVALID_PARAMETER Some parameters are invalid.
274  @retval EFI_TIMEOUT The synchronous interrupt transfer failed due to timeout.
275  @retval EFI_DEVICE_ERROR The synchronous interrupt transfer failed due to host controller or device error.
276 
277 **/
278 typedef
281  IN EFI_USB_HC_PROTOCOL *This,
282  IN UINT8 DeviceAddress,
283  IN UINT8 EndPointAddress,
284  IN BOOLEAN IsSlowDevice,
285  IN UINT8 MaximumPacketLength,
286  IN OUT VOID *Data,
288  IN OUT UINT8 *DataToggle,
289  IN UINTN TimeOut,
290  OUT UINT32 *TransferResult
291  );
292 
293 /**
294  Submits isochronous transfer to an isochronous endpoint of a USB device.
295 
296  @param This A pointer to the EFI_USB_HC_PROTOCOL instance.
297  @param DeviceAddress Represents the address of the target device on the USB, which is
298  assigned during USB enumeration.
299  @param EndPointAddress The combination of an endpoint number and an endpoint
300  direction of the target USB device. Each endpoint address
301  supports data transfer in one direction except the control
302  endpoint (whose default endpoint address is 0). It is the caller's
303  responsibility to make sure that the EndPointAddress
304  represents an isochronous endpoint.
305  @param MaximumPacketLength Indicates the maximum packet size that the default control
306  transfer endpoint is capable of sending or receiving.
307  @param Data A pointer to the buffer of data that will be transmitted to USB
308  device or received from USB device. asynchronous interrupt pipe is canceled.
309  @param DataLength Specifies the length, in bytes, of the data to be sent to or received
310  from the USB device.
311  @param TransferResult A pointer to the detailed result information from the isochronous
312  transfer.
313 
314  @retval EFI_SUCCESS The isochronous transfer was completed successfully.
315  @retval EFI_OUT_OF_RESOURCES The isochronous could not be completed due to a lack of resources.
316  @retval EFI_INVALID_PARAMETER Some parameters are invalid.
317  @retval EFI_TIMEOUT The isochronous transfer failed due to timeout.
318  @retval EFI_DEVICE_ERROR The isochronous transfer failed due to host controller or device error.
319 
320 **/
321 typedef
324  IN EFI_USB_HC_PROTOCOL *This,
325  IN UINT8 DeviceAddress,
326  IN UINT8 EndPointAddress,
327  IN UINT8 MaximumPacketLength,
328  IN OUT VOID *Data,
330  OUT UINT32 *TransferResult
331  );
332 
333 /**
334  Submits nonblocking isochronous transfer to an isochronous endpoint of a USB device.
335 
336  @param This A pointer to the EFI_USB_HC_PROTOCOL instance.
337  @param DeviceAddress Represents the address of the target device on the USB, which is
338  assigned during USB enumeration.
339  @param EndPointAddress The combination of an endpoint number and an endpoint
340  direction of the target USB device. Each endpoint address
341  supports data transfer in one direction except the control
342  endpoint (whose default endpoint address is zero). It is the
343  caller's responsibility to make sure that the
344  EndPointAddress represents an isochronous endpoint.
345  @param MaximumPacketLength Indicates the maximum packet size that the default control
346  transfer endpoint is capable of sending or receiving. For isochronous
347  endpoints, this value is used to reserve the bus time in the schedule,
348  required for the perframe data payloads. The pipe may, on an ongoing basis,
349  actually use less bandwidth than that reserved.
350  @param Data A pointer to the buffer of data that will be transmitted to USB
351  device or received from USB device. asynchronous interrupt pipe is canceled.
352  @param DataLength Specifies the length, in bytes, of the data to be sent to or received
353  from the USB device.
354  @param IsochronousCallback The Callback function.This function is called if the requested
355  isochronous transfer is completed.
356  @param Context Data passed to the IsochronousCallback function. This is
357  an optional parameter and may be NULL.
358 
359  @retval EFI_SUCCESS The asynchronous isochronous transfer was completed successfully.
360  @retval EFI_OUT_OF_RESOURCES The asynchronous isochronous could not be completed due to a lack of resources.
361  @retval EFI_INVALID_PARAMETER Some parameters are invalid.
362 
363 **/
364 typedef
367  IN EFI_USB_HC_PROTOCOL *This,
368  IN UINT8 DeviceAddress,
369  IN UINT8 EndPointAddress,
370  IN UINT8 MaximumPacketLength,
371  IN OUT VOID *Data,
373  IN EFI_ASYNC_USB_TRANSFER_CALLBACK IsochronousCallBack,
374  IN VOID *Context OPTIONAL
375  );
376 
377 /**
378  Retrieves the number of root hub ports.
379 
380  @param This A pointer to the EFI_USB_HC_PROTOCOL instance.
381  @param PortNumber A pointer to the number of the root hub ports.
382 
383  @retval EFI_SUCCESS The port number was retrieved successfully.
384  @retval EFI_DEVICE_ERROR An error was encountered while attempting to retrieve the port number.
385  @retval EFI_INVALID_PARAMETER PortNumber is NULL.
386 
387 **/
388 typedef
391  IN EFI_USB_HC_PROTOCOL *This,
392  OUT UINT8 *PortNumber
393  );
394 
395 /**
396  Retrieves the current status of a USB root hub port.
397 
398  @param This A pointer to the EFI_USB_HC_PROTOCOL instance.
399  @param PortNumber Specifies the root hub port from which the status is to be retrieved.
400  This value is zero based. For example, if a root hub has two ports,
401  then the first port is numbered 0, and the second port is
402  numbered 1.
403  @param PortStatus A pointer to the current port status bits and port status change bits.
404 
405  @retval EFI_SUCCESS The status of the USB root hub port specified by PortNumber
406  was returned in PortStatus.
407  @retval EFI_INVALID_PARAMETER PortNumber is invalid.
408 
409 **/
410 typedef
413  IN EFI_USB_HC_PROTOCOL *This,
414  IN UINT8 PortNumber,
415  OUT EFI_USB_PORT_STATUS *PortStatus
416  );
417 
418 /**
419  Sets a feature for the specified root hub port.
420 
421  @param This A pointer to the EFI_USB_HC_PROTOCOL instance.
422  @param PortNumber Specifies the root hub port from which the status is to be retrieved.
423  This value is zero based. For example, if a root hub has two ports,
424  then the first port is numbered 0, and the second port is
425  numbered 1.
426  @param PortFeature Indicates the feature selector associated with the feature set
427  request.
428 
429  @retval EFI_SUCCESS The feature specified by PortFeature was set for the USB
430  root hub port specified by PortNumber.
431  @retval EFI_INVALID_PARAMETER PortNumber is invalid or PortFeature is invalid for this function.
432 
433 **/
434 typedef
437  IN EFI_USB_HC_PROTOCOL *This,
438  IN UINT8 PortNumber,
439  IN EFI_USB_PORT_FEATURE PortFeature
440  );
441 
442 /**
443  Clears a feature for the specified root hub port.
444 
445  @param This A pointer to the EFI_USB_HC_PROTOCOL instance.
446  @param PortNumber Specifies the root hub port from which the status is to be retrieved.
447  This value is zero based. For example, if a root hub has two ports,
448  then the first port is numbered 0, and the second port is
449  numbered 1.
450  @param PortFeature Indicates the feature selector associated with the feature clear
451  request.
452 
453  @retval EFI_SUCCESS The feature specified by PortFeature was cleared for the USB
454  root hub port specified by PortNumber.
455  @retval EFI_INVALID_PARAMETER PortNumber is invalid or PortFeature is invalid for this function.
456 
457 **/
458 typedef
461  IN EFI_USB_HC_PROTOCOL *This,
462  IN UINT8 PortNumber,
463  IN EFI_USB_PORT_FEATURE PortFeature
464  );
465 
466 ///
467 /// The EFI_USB_HC_PROTOCOL provides USB host controller management, basic data transactions
468 /// over a USB bus, and USB root hub access. A device driver that wishes to manage a USB bus in a
469 /// system retrieves the EFI_USB_HC_PROTOCOL instance that is associated with the USB bus to be
470 /// managed. A device handle for a USB host controller will minimally contain an
471 /// EFI_DEVICE_PATH_PROTOCOL instance, and an EFI_USB_HC_PROTOCOL instance.
472 ///
487  ///
488  /// The major revision number of the USB host controller. The revision information
489  /// indicates the release of the Universal Serial Bus Specification with which the
490  /// host controller is compliant.
491  ///
493  ///
494  /// The minor revision number of the USB host controller. The revision information
495  /// indicates the release of the Universal Serial Bus Specification with which the
496  /// host controller is compliant.
497  ///
499 };
500 
502 
503 #endif
#define OPTIONAL
Passing the datum to the function is optional, and a NULL is passed if the value is not supplied.
Definition: Base.h:292
EFI_STATUS(EFIAPI * EFI_USB_HC_PROTOCOL_GET_STATE)(IN EFI_USB_HC_PROTOCOL *This, OUT EFI_USB_HC_STATE *State)
Retrieves current state of the USB host controller.
EFI_STATUS(EFIAPI * EFI_USB_HC_PROTOCOL_ISOCHRONOUS_TRANSFER)(IN EFI_USB_HC_PROTOCOL *This, IN UINT8 DeviceAddress, IN UINT8 EndPointAddress, IN UINT8 MaximumPacketLength, IN OUT VOID *Data, IN UINTN DataLength, OUT UINT32 *TransferResult)
Submits isochronous transfer to an isochronous endpoint of a USB device.
EFI_USB_HC_PROTOCOL_GET_ROOTHUB_PORT_STATUS GetRootHubPortStatus
EFI_STATUS(EFIAPI * EFI_USB_HC_PROTOCOL_GET_ROOTHUB_PORT_NUMBER)(IN EFI_USB_HC_PROTOCOL *This, OUT UINT8 *PortNumber)
Retrieves the number of root hub ports.
128 bit buffer containing a unique identifier value.
Definition: Base.h:215
EFI_USB_HC_PROTOCOL_BULK_TRANSFER BulkTransfer
unsigned char BOOLEAN
unsigned int UINT32
Definition: ProcessorBind.h:98
EFI_STATUS(EFIAPI * EFI_USB_HC_PROTOCOL_SYNC_INTERRUPT_TRANSFER)(IN EFI_USB_HC_PROTOCOL *This, IN UINT8 DeviceAddress, IN UINT8 EndPointAddress, IN BOOLEAN IsSlowDevice, IN UINT8 MaximumPacketLength, IN OUT VOID *Data, IN OUT UINTN *DataLength, IN OUT UINT8 *DataToggle, IN UINTN TimeOut, OUT UINT32 *TransferResult)
Submits synchronous interrupt transfer to an interrupt endpoint of a USB device.
UINT16 MajorRevision
The major revision number of the USB host controller.
EFI_USB_DATA_DIRECTION
USB data transfer direction.
Definition: UsbIo.h:46
EFI_STATUS(EFIAPI * EFI_USB_HC_PROTOCOL_SET_STATE)(IN EFI_USB_HC_PROTOCOL *This, IN EFI_USB_HC_STATE State)
Sets the USB host controller to a specific state.
unsigned char UINT8
EFI_USB_HC_PROTOCOL_CLEAR_ROOTHUB_PORT_FEATURE ClearRootHubPortFeature
The EFI_USB_HC_PROTOCOL provides USB host controller management, basic data transactions over a USB b...
EFI_USB_HC_PROTOCOL_ASYNC_INTERRUPT_TRANSFER AsyncInterruptTransfer
EFI_USB_HC_PROTOCOL_CONTROL_TRANSFER ControlTransfer
#define OUT
Definition: mlx_utils.h:29
Format of Setup Data for USB Device Requests USB 2.0 spec, Section 9.3.
Definition: Usb.h:92
EFI_USB_HC_PROTOCOL_SET_STATE SetState
EFI_STATUS(EFIAPI * EFI_USB_HC_PROTOCOL_BULK_TRANSFER)(IN EFI_USB_HC_PROTOCOL *This, IN UINT8 DeviceAddress, IN UINT8 EndPointAddress, IN UINT8 MaximumPacketLength, IN OUT VOID *Data, IN OUT UINTN *DataLength, IN OUT UINT8 *DataToggle, IN UINTN TimeOut, OUT UINT32 *TransferResult)
Submits bulk transfer to a bulk endpoint of a USB device.
EFI_USB_HC_PROTOCOL_SET_ROOTHUB_PORT_FEATURE SetRootHubPortFeature
EFI_USB_PORT_FEATURE
Usb port features value Each value indicates its bit index in the port status and status change bitma...
EFI_STATUS(EFIAPI * EFI_USB_HC_PROTOCOL_GET_ROOTHUB_PORT_STATUS)(IN EFI_USB_HC_PROTOCOL *This, IN UINT8 PortNumber, OUT EFI_USB_PORT_STATUS *PortStatus)
Retrieves the current status of a USB root hub port.
EFI_USB_HC_PROTOCOL_ISOCHRONOUS_TRANSFER IsochronousTransfer
unsigned short UINT16
#define EFIAPI
EFI_USB2_HC_PROTOCOL as defined in UEFI 2.0.
EFI_GUID gEfiUsbHcProtocolGuid
UINT64 UINTN
Unsigned value of native width.
#define VOID
Undeclared type.
Definition: Base.h:271
EFI_USB_HC_PROTOCOL_SYNC_INTERRUPT_TRANSFER SyncInterruptTransfer
EFI_STATUS(EFIAPI * EFI_USB_HC_PROTOCOL_SET_ROOTHUB_PORT_FEATURE)(IN EFI_USB_HC_PROTOCOL *This, IN UINT8 PortNumber, IN EFI_USB_PORT_FEATURE PortFeature)
Sets a feature for the specified root hub port.
EFI_USB_HC_PROTOCOL_GET_ROOTHUB_PORT_NUMBER GetRootHubPortNumber
#define IN
Definition: mlx_utils.h:28
FILE_LICENCE(BSD2_PATENT)
EFI_STATUS(EFIAPI * EFI_USB_HC_PROTOCOL_CONTROL_TRANSFER)(IN EFI_USB_HC_PROTOCOL *This, IN UINT8 DeviceAddress, IN BOOLEAN IsSlowDevice, IN UINT8 MaximumPacketLength, IN EFI_USB_DEVICE_REQUEST *Request, IN EFI_USB_DATA_DIRECTION TransferDirection, IN OUT VOID *Data OPTIONAL, IN OUT UINTN *DataLength OPTIONAL, IN UINTN TimeOut, OUT UINT32 *TransferResult)
Submits control transfer to a target USB device.
EFI_USB_HC_STATE
Enumration value for status of USB HC.
EFI_USB_HC_PROTOCOL_GET_STATE GetState
RETURN_STATUS EFI_STATUS
Function return status for EFI API.
Definition: UefiBaseType.h:31
EFI_STATUS(EFIAPI * EFI_USB_HC_PROTOCOL_CLEAR_ROOTHUB_PORT_FEATURE)(IN EFI_USB_HC_PROTOCOL *This, IN UINT8 PortNumber, IN EFI_USB_PORT_FEATURE PortFeature)
Clears a feature for the specified root hub port.
EFI_STATUS(EFIAPI * EFI_USB_HC_PROTOCOL_ASYNC_ISOCHRONOUS_TRANSFER)(IN EFI_USB_HC_PROTOCOL *This, IN UINT8 DeviceAddress, IN UINT8 EndPointAddress, IN UINT8 MaximumPacketLength, IN OUT VOID *Data, IN UINTN DataLength, IN EFI_ASYNC_USB_TRANSFER_CALLBACK IsochronousCallBack, IN VOID *Context OPTIONAL)
Submits nonblocking isochronous transfer to an isochronous endpoint of a USB device.
volatile unsigned int DataLength
Definition: 3c90x.h:52
EFI_USB_HC_PROTOCOL_RESET Reset
EFI_USB_HC_PROTOCOL_ASYNC_ISOCHRONOUS_TRANSFER AsyncIsochronousTransfer
EFI_STATUS(EFIAPI * EFI_USB_HC_PROTOCOL_RESET)(IN EFI_USB_HC_PROTOCOL *This, IN UINT16 Attributes)
Provides software reset for the USB host controller.
EFI_STATUS(EFIAPI * EFI_USB_HC_PROTOCOL_ASYNC_INTERRUPT_TRANSFER)(IN EFI_USB_HC_PROTOCOL *This, IN UINT8 DeviceAddress, IN UINT8 EndPointAddress, IN BOOLEAN IsSlowDevice, IN UINT8 MaxiumPacketLength, IN BOOLEAN IsNewTransfer, IN OUT UINT8 *DataToggle, IN UINTN PollingInterval OPTIONAL, IN UINTN DataLength OPTIONAL, IN EFI_ASYNC_USB_TRANSFER_CALLBACK CallBackFunction OPTIONAL, IN VOID *Context OPTIONAL)
Submits an asynchronous interrupt transfer to an interrupt endpoint of a USB device.
EFI_STATUS(EFIAPI * EFI_ASYNC_USB_TRANSFER_CALLBACK)(IN VOID *Data, IN UINTN DataLength, IN VOID *Context, IN UINT32 Status)
Async USB transfer callback routine.
Definition: UsbIo.h:82
UINT16 MinorRevision
The minor revision number of the USB host controller.