MdePkg/Include/Protocol/Usb2HostController.h

   1 /** @file
   2   EFI_USB2_HC_PROTOCOL as defined in UEFI 2.0.
   3
   4   Copyright (c) 2006, Intel Corporation
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13   Module Name:  Usb2HostController.h
  14
  15 **/
  16
  17 #ifndef _USB2_HOSTCONTROLLER_H_
  18 #define _USB2_HOSTCONTROLLER_H_
  19
  20 #include <IndustryStandard/Usb.h>
  21 #include <Protocol/UsbIo.h>
  22
  23 #define EFI_USB2_HC_PROTOCOL_GUID \
  24   { \
  25     0x3e745226, 0x9818, 0x45b6, {0xa2, 0xac, 0xd7, 0xcd, 0xe, 0x8b, 0xa2, 0xbc } \
  26   }
  27
  28 //
  29 // Forward reference for pure ANSI compatability
  30 //
  31 typedef struct _EFI_USB2_HC_PROTOCOL EFI_USB2_HC_PROTOCOL;
  32
  33 #define EFI_USB_SPEED_FULL      0x0000  // 12 Mb/s, USB 1.1 OHCI and UHCI HC.
  34 #define EFI_USB_SPEED_LOW       0x0001  // 1 Mb/s, USB 1.1 OHCI and UHCI HC.
  35 #define EFI_USB_SPEED_HIGH      0x0002  // 480 Mb/s, USB 2.0 EHCI HC.
  36
  37 typedef struct {
  38   UINT8      TranslatorHubAddress;
  39   UINT8      TranslatorPortNumber;
  40 } EFI_USB2_HC_TRANSACTION_TRANSLATOR;
  41
  42 //
  43 // Protocol definitions
  44 //
  45
  46 /**
  47   Retrieves the Host Controller capabilities.
  48
  49   @param  This           A pointer to the EFI_USB2_HC_PROTOCOL instance.
  50   @param  MaxSpeed       Host controller data transfer speed.
  51   @param  PortNumber     Number of the root hub ports.
  52   @param  Is64BitCapable TRUE if controller supports 64-bit memory addressing,
  53                          FALSE otherwise.
  54
  55   @retval EFI_SUCCESS           The host controller capabilities were retrieved successfully.
  56   @retval EFI_INVALID_PARAMETER One of the input args was NULL.
  57   @retval EFI_DEVICE_ERROR      An error was encountered while attempting to
  58                                 retrieve the capabilities.
  59
  60 **/
  61 typedef
  62 EFI_STATUS
  63 (EFIAPI *EFI_USB2_HC_PROTOCOL_GET_CAPABILITY) (
  64   IN  EFI_USB2_HC_PROTOCOL  *This,
  65   OUT UINT8                 *MaxSpeed,
  66   OUT UINT8                 *PortNumber,
  67   OUT UINT8                 *Is64BitCapable
  68   )
  69 ;
  70
  71 /**
  72   Provides software reset for the USB host controller.
  73
  74   @param  This       A pointer to the EFI_USB2_HC_PROTOCOL instance.
  75   @param  Attributes A bit mask of the reset operation to perform.
  76
  77   @retval EFI_SUCCESS           The reset operation succeeded.
  78   @retval EFI_INVALID_PARAMETER Attributes is not valid.
  79   @retval EFI_UNSUPPORTED       The type of reset specified by Attributes is not currently
  80                                 supported by the host controller hardware.
  81   @retval EFI_ACCESS_DENIED     Reset operation is rejected due to the debug port being configured
  82                                 and active; only EFI_USB_HC_RESET_GLOBAL_WITH_DEBUG or
  83                                 EFI_USB_HC_RESET_HOST_WITH_DEBUG reset Attributes can be used to
  84                                 perform reset operation for this host controller.
  85   @retval EFI_DEVICE_ERROR      An error was encountered while attempting to
  86                                 retrieve the capabilities.
  87
  88 **/
  89 typedef
  90 EFI_STATUS
  91 (EFIAPI *EFI_USB2_HC_PROTOCOL_RESET) (
  92   IN EFI_USB2_HC_PROTOCOL   *This,
  93   IN UINT16                 Attributes
  94   )
  95 ;
  96
  97 /**
  98
  99   @param EfiUsbHcStateHalt  The host controller is in halt
 100                             state. No USB transactions can occur
 101                             while in this state. The host
 102                             controller can enter this state for
 103                             three reasons: 1) After host
 104                             controller hardware reset. 2)
 105                             Explicitly set by software. 3)
 106                             Triggered by a fatal error such as
 107                             consistency check failure.
 108
 109
 110   @param EfiUsbHcStateOperational   The host controller is in an
 111                                     operational state. When in
 112                                     this state, the host
 113                                     controller can execute bus
 114                                     traffic. This state must be
 115                                     explicitly set to enable the
 116                                     USB bus traffic.
 117
 118
 119   @param EfiUsbHcStateSuspend   The host controller is in the
 120                                 suspend state. No USB
 121                                 transactions can occur while in
 122                                 this state. The host controller
 123                                 enters this state for the
 124                                 following reasons: 1) Explicitly
 125                                 set by software. 2) Triggered
 126                                 when there is no bus traffic for
 127                                 3 microseconds.
 128
 129 **/
 130 typedef enum {
 131   EfiUsbHcStateHalt,
 132   EfiUsbHcStateOperational,
 133   EfiUsbHcStateSuspend,
 134   EfiUsbHcStateMaximum
 135 } EFI_USB_HC_STATE;
 136
 137 /**
 138   Retrieves current state of the USB host controller.
 139
 140   @param  This  A pointer to the EFI_USB2_HC_PROTOCOL instance.
 141   @param  State A pointer to the EFI_USB_HC_STATE data structure that
 142                 indicates current state of the USB host controller.
 143
 144   @retval EFI_SUCCESS           The state information of the host controller was returned in State.
 145   @retval EFI_INVALID_PARAMETER State is NULL.
 146   @retval EFI_DEVICE_ERROR      An error was encountered while attempting to retrieve the
 147                                 host controller's current state.
 148
 149 **/
 150 typedef
 151 EFI_STATUS
 152 (EFIAPI *EFI_USB2_HC_PROTOCOL_GET_STATE) (
 153   IN CONST  EFI_USB2_HC_PROTOCOL    *This,
 154   OUT       EFI_USB_HC_STATE        *State
 155 )
 156 ;
 157
 158 /**
 159   Sets the USB host controller to a specific state.
 160
 161   @param  This  A pointer to the EFI_USB2_HC_PROTOCOL instance.
 162   @param  State Indicates the state of the host controller that will be set.
 163
 164   @retval EFI_SUCCESS           The USB host controller was successfully placed in the state
 165                                 specified by State.
 166   @retval EFI_INVALID_PARAMETER State is not valid.
 167   @retval EFI_DEVICE_ERROR      Failed to set the state specified by State due to device error.
 168
 169 **/
 170 typedef
 171 EFI_STATUS
 172 (EFIAPI *EFI_USB2_HC_PROTOCOL_SET_STATE) (
 173   IN EFI_USB2_HC_PROTOCOL    *This,
 174   IN EFI_USB_HC_STATE        State
 175   )
 176 ;
 177
 178 /**
 179   Submits control transfer to a target USB device.
 180
 181   @param  This                A pointer to the EFI_USB2_HC_PROTOCOL instance.
 182   @param  DeviceAddress       Represents the address of the target device on the USB.
 183   @param  DeviceSpeed         Indicates device speed.
 184   @param  MaximumPacketLength Indicates the maximum packet size that the default control transfer
 185                               endpoint is capable of sending or receiving.
 186   @param  Request             A pointer to the USB device request that will be sent to the USB device.
 187   @param  TransferDirection   Specifies the data direction for the transfer. There are three values
 188                               available, EfiUsbDataIn, EfiUsbDataOut and EfiUsbNoData.
 189   @param  Data                A pointer to the buffer of data that will be transmitted to USB device or
 190                               received from USB device.
 191   @param  DataLength          On input, indicates the size, in bytes, of the data buffer specified by Data.
 192                               On output, indicates the amount of data actually transferred.
 193   @param  Translator          A pointer to the transaction translator data.
 194   @param  TimeOut             Indicates the maximum time, in milliseconds, which the transfer is
 195                               allowed to complete.
 196   @param  TransferResult      A pointer to the detailed result information generated by this control
 197                               transfer.
 198
 199   @retval EFI_SUCCESS           The control transfer was completed successfully.
 200   @retval EFI_INVALID_PARAMETER Some parameters are invalid.
 201   @retval EFI_OUT_OF_RESOURCES  The control transfer could not be completed due to a lack of resources.
 202   @retval EFI_TIMEOUT           The control transfer failed due to timeout.
 203   @retval EFI_DEVICE_ERROR      The control transfer failed due to host controller or device error.
 204                                 Caller should check TransferResult for detailed error information.
 205
 206 **/
 207 typedef
 208 EFI_STATUS
 209 (EFIAPI *EFI_USB2_HC_PROTOCOL_CONTROL_TRANSFER) (
 210   IN     EFI_USB2_HC_PROTOCOL               *This,
 211   IN     UINT8                              DeviceAddress,
 212   IN     UINT8                              DeviceSpeed,
 213   IN     UINTN                              MaximumPacketLength,
 214   IN     EFI_USB_DEVICE_REQUEST             *Request,
 215   IN     EFI_USB_DATA_DIRECTION             TransferDirection,
 216   IN OUT VOID                               *Data       OPTIONAL,
 217   IN OUT UINTN                              *DataLength OPTIONAL,
 218   IN     UINTN                              TimeOut,
 219   IN     EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator,
 220   OUT    UINT32                             *TransferResult
 221   )
 222 ;
 223
 224 #define EFI_USB_MAX_BULK_BUFFER_NUM 10
 225
 226 /**
 227   Submits bulk transfer to a bulk endpoint of a USB device.
 228
 229   @param  This                A pointer to the EFI_USB2_HC_PROTOCOL instance.
 230   @param  DeviceAddress       Represents the address of the target device on the USB.
 231   @param  EndPointAddress     The combination of an endpoint number and an endpoint direction of the
 232                               target USB device.
 233   @param  DeviceSpeed         Indicates device speed.
 234   @param  MaximumPacketLength Indicates the maximum packet size the target endpoint is capable of
 235                               sending or receiving.
 236   @param  DataBuffersNumber   Number of data buffers prepared for the transfer.
 237   @param  Data                Array of pointers to the buffers of data that will be transmitted to USB
 238                               device or received from USB device.
 239   @param  DataLength          When input, indicates the size, in bytes, of the data buffers specified by
 240                               Data. When output, indicates the actually transferred data size.
 241   @param  DataToggle          A pointer to the data toggle value.
 242   @param  Translator          A pointer to the transaction translator data.
 243   @param  TimeOut             Indicates the maximum time, in milliseconds, which the transfer is
 244                               allowed to complete.
 245   @param  TransferResult      A pointer to the detailed result information of the bulk transfer.
 246
 247   @retval EFI_SUCCESS           The bulk transfer was completed successfully.
 248   @retval EFI_INVALID_PARAMETER Some parameters are invalid.
 249   @retval EFI_OUT_OF_RESOURCES  The bulk transfer could not be submitted due to a lack of resources.
 250   @retval EFI_TIMEOUT           The bulk transfer failed due to timeout.
 251   @retval EFI_DEVICE_ERROR      The bulk transfer failed due to host controller or device error.
 252                                 Caller should check TransferResult for detailed error information.
 253
 254 **/
 255 typedef
 256 EFI_STATUS
 257 (EFIAPI *EFI_USB2_HC_PROTOCOL_BULK_TRANSFER) (
 258   IN     EFI_USB2_HC_PROTOCOL               *This,
 259   IN     UINT8                              DeviceAddress,
 260   IN     UINT8                              EndPointAddress,
 261   IN     UINT8                              DeviceSpeed,
 262   IN     UINTN                              MaximumPacketLength,
 263   IN     UINT8                              DataBuffersNumber,
 264   IN OUT VOID                               *Data[EFI_USB_MAX_BULK_BUFFER_NUM],
 265   IN OUT UINTN                              *DataLength,
 266   IN OUT UINT8                              *DataToggle,
 267   IN     UINTN                              TimeOut,
 268   IN     EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator,
 269   OUT    UINT32                             *TransferResult
 270   )
 271 ;
 272
 273 /**
 274   Submits an asynchronous interrupt transfer to an interrupt endpoint of a USB device.
 275   Translator parameter doesn't exist in UEFI2.0 spec, but it will be updated in the following specification version.
 276
 277   @param  This                A pointer to the EFI_USB2_HC_PROTOCOL instance.
 278   @param  DeviceAddress       Represents the address of the target device on the USB.
 279   @param  EndPointAddress     The combination of an endpoint number and an endpoint direction of the
 280                               target USB device.
 281   @param  DeviceSpeed         Indicates device speed.
 282   @param  MaximumPacketLength Indicates the maximum packet size the target endpoint is capable of
 283                               sending or receiving.
 284   @param  IsNewTransfer       If TRUE, an asynchronous interrupt pipe is built between the host and the
 285                               target interrupt endpoint. If FALSE, the specified asynchronous interrupt
 286                               pipe is canceled. If TRUE, and an interrupt transfer exists for the target
 287                               end point, then EFI_INVALID_PARAMETER is returned.
 288   @param  DataToggle          A pointer to the data toggle value.
 289   @param  PollingInterval     Indicates the interval, in milliseconds, that the asynchronous interrupt
 290                               transfer is polled.
 291   @param  DataLength          Indicates the length of data to be received at the rate specified by
 292                               PollingInterval from the target asynchronous interrupt endpoint.
 293   @param  Translator          A pointr to the transaction translator data.
 294   @param  CallBackFunction    The Callback function. This function is called at the rate specified by
 295                               PollingInterval.
 296   @param  Context             The context that is passed to the CallBackFunction. This is an
 297                               optional parameter and may be NULL.
 298
 299   @retval EFI_SUCCESS           The asynchronous interrupt transfer request has been successfully
 300                                 submitted or canceled.
 301   @retval EFI_INVALID_PARAMETER Some parameters are invalid.
 302   @retval EFI_OUT_OF_RESOURCES  The request could not be completed due to a lack of resources.
 303
 304 **/
 305 typedef
 306 EFI_STATUS
 307 (EFIAPI *EFI_USB2_HC_PROTOCOL_ASYNC_INTERRUPT_TRANSFER) (
 308   IN     EFI_USB2_HC_PROTOCOL                                *This,
 309   IN     UINT8                                               DeviceAddress,
 310   IN     UINT8                                               EndPointAddress,
 311   IN     UINT8                                               DeviceSpeed,
 312   IN     UINTN                                               MaxiumPacketLength,
 313   IN     BOOLEAN                                             IsNewTransfer,
 314   IN OUT UINT8                                               *DataToggle,
 315   IN     UINTN                                               PollingInterval  OPTIONAL,
 316   IN     UINTN                                               DataLength       OPTIONAL,
 317   IN     EFI_USB2_HC_TRANSACTION_TRANSLATOR                  *Translator      OPTIONAL,
 318   IN     EFI_ASYNC_USB_TRANSFER_CALLBACK                     CallBackFunction OPTIONAL,
 319   IN     VOID                                                *Context         OPTIONAL
 320   )
 321 ;
 322
 323 /**
 324   Submits synchronous interrupt transfer to an interrupt endpoint of a USB device.
 325   Translator parameter doesn't exist in UEFI2.0 spec, but it will be updated in the following specification version.
 326
 327   @param  This                  A pointer to the EFI_USB2_HC_PROTOCOL instance.
 328   @param  DeviceAddress         Represents the address of the target device on the USB.
 329   @param  EndPointAddress       The combination of an endpoint number and an endpoint direction of the
 330                                 target USB device.
 331   @param  DeviceSpeed           Indicates device speed.
 332   @param  MaximumPacketLength   Indicates the maximum packet size the target endpoint is capable of
 333                                 sending or receiving.
 334   @param  Data                  A pointer to the buffer of data that will be transmitted to USB device or
 335                                 received from USB device.
 336   @param  DataLength            On input, the size, in bytes, of the data buffer specified by Data. On
 337                                 output, the number of bytes transferred.
 338   @param  DataToggle            A pointer to the data toggle value.
 339   @param  TimeOut               Indicates the maximum time, in milliseconds, which the transfer is
 340                                 allowed to complete.
 341   @param  Translator            A pointr to the transaction translator data.
 342   @param  TransferResult        A pointer to the detailed result information from the synchronous
 343                                 interrupt transfer.
 344
 345   @retval EFI_SUCCESS           The synchronous interrupt transfer was completed successfully.
 346   @retval EFI_INVALID_PARAMETER Some parameters are invalid.
 347   @retval EFI_OUT_OF_RESOURCES  The synchronous interrupt transfer could not be submitted due to a lack of resources.
 348   @retval EFI_TIMEOUT           The synchronous interrupt transfer failed due to timeout.
 349   @retval EFI_DEVICE_ERROR      The synchronous interrupt transfer failed due to host controller or device error.
 350                                 Caller should check TransferResult for detailed error information.
 351
 352 **/
 353 typedef
 354 EFI_STATUS
 355 (EFIAPI *EFI_USB2_HC_PROTOCOL_SYNC_INTERRUPT_TRANSFER) (
 356   IN     EFI_USB2_HC_PROTOCOL                        *This,
 357   IN     UINT8                                       DeviceAddress,
 358   IN     UINT8                                       EndPointAddress,
 359   IN     UINT8                                       DeviceSpeed,
 360   IN     UINTN                                       MaximumPacketLength,
 361   IN OUT VOID                                        *Data,
 362   IN OUT UINTN                                       *DataLength,
 363   IN OUT UINT8                                       *DataToggle,
 364   IN     UINTN                                       TimeOut,
 365   IN     EFI_USB2_HC_TRANSACTION_TRANSLATOR          *Translator,
 366   OUT    UINT32                                      *TransferResult
 367   )
 368 ;
 369
 370 #define EFI_USB_MAX_ISO_BUFFER_NUM  7
 371 #define EFI_USB_MAX_ISO_BUFFER_NUM1 2
 372
 373 /**
 374   Submits isochronous transfer to an isochronous endpoint of a USB device.
 375
 376   @param  This                  A pointer to the EFI_USB2_HC_PROTOCOL instance.
 377   @param  DeviceAddress         Represents the address of the target device on the USB.
 378   @param  EndPointAddress       The combination of an endpoint number and an endpoint direction of the
 379                                 target USB device.
 380   @param  DeviceSpeed           Indicates device speed.
 381   @param  MaximumPacketLength   Indicates the maximum packet size the target endpoint is capable of
 382                                 sending or receiving.
 383   @param  DataBuffersNumber     Number of data buffers prepared for the transfer.
 384   @param  Data                  Array of pointers to the buffers of data that will be transmitted to USB
 385                                 device or received from USB device.
 386   @param  DataLength            Specifies the length, in bytes, of the data to be sent to or received from
 387                                 the USB device.
 388   @param  Translator            A pointer to the transaction translator data.
 389   @param  TransferResult        A pointer to the detailed result information of the isochronous transfer.
 390
 391   @retval EFI_SUCCESS           The isochronous transfer was completed successfully.
 392   @retval EFI_INVALID_PARAMETER Some parameters are invalid.
 393   @retval EFI_OUT_OF_RESOURCES  The isochronous transfer could not be submitted due to a lack of resources.
 394   @retval EFI_TIMEOUT           The isochronous transfer cannot be completed within the one USB frame time.
 395   @retval EFI_DEVICE_ERROR      The isochronous transfer failed due to host controller or device error.
 396                                 Caller should check TransferResult for detailed error information.
 397
 398 **/
 399 typedef
 400 EFI_STATUS
 401 (EFIAPI *EFI_USB2_HC_PROTOCOL_ISOCHRONOUS_TRANSFER) (
 402   IN     EFI_USB2_HC_PROTOCOL               *This,
 403   IN     UINT8                              DeviceAddress,
 404   IN     UINT8                              EndPointAddress,
 405   IN     UINT8                              DeviceSpeed,
 406   IN     UINTN                              MaximumPacketLength,
 407   IN     UINT8                              DataBuffersNumber,
 408   IN OUT VOID                               *Data[EFI_USB_MAX_ISO_BUFFER_NUM],
 409   IN     UINTN                              DataLength,
 410   IN     EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator,
 411   OUT    UINT32                             *TransferResult
 412   )
 413 ;
 414
 415 /**
 416   Submits nonblocking isochronous transfer to an isochronous endpoint of a USB device.
 417
 418   @param  This                  A pointer to the EFI_USB2_HC_PROTOCOL instance.
 419   @param  DeviceAddress         Represents the address of the target device on the USB.
 420   @param  EndPointAddress       The combination of an endpoint number and an endpoint direction of the
 421                                 target USB device.
 422   @param  DeviceSpeed           Indicates device speed.
 423   @param  MaximumPacketLength   Indicates the maximum packet size the target endpoint is capable of
 424                                 sending or receiving.
 425   @param  DataBuffersNumber     Number of data buffers prepared for the transfer.
 426   @param  Data                  Array of pointers to the buffers of data that will be transmitted to USB
 427                                 device or received from USB device.
 428   @param  DataLength            Specifies the length, in bytes, of the data to be sent to or received from
 429                                 the USB device.
 430   @param  Translator            A pointer to the transaction translator data.
 431   @param  IsochronousCallback   The Callback function. This function is called if the requested
 432                                 isochronous transfer is completed.
 433   @param  Context               Data passed to the IsochronousCallback function. This is an
 434                                 optional parameter and may be NULL.
 435
 436   @retval EFI_SUCCESS           The asynchronous isochronous transfer request has been successfully
 437                                 submitted or canceled.
 438   @retval EFI_INVALID_PARAMETER Some parameters are invalid.
 439   @retval EFI_OUT_OF_RESOURCES  The asynchronous isochronous transfer could not be submitted due to
 440                                 a lack of resources.
 441
 442 **/
 443 typedef
 444 EFI_STATUS
 445 (EFIAPI *EFI_USB2_HC_PROTOCOL_ASYNC_ISOCHRONOUS_TRANSFER) (
 446   IN     EFI_USB2_HC_PROTOCOL               *This,
 447   IN     UINT8                              DeviceAddress,
 448   IN     UINT8                              EndPointAddress,
 449   IN     UINT8                              DeviceSpeed,
 450   IN     UINTN                              MaximumPacketLength,
 451   IN     UINT8                              DataBuffersNumber,
 452   IN OUT VOID                               *Data[EFI_USB_MAX_ISO_BUFFER_NUM],
 453   IN     UINTN                              DataLength,
 454   IN     EFI_USB2_HC_TRANSACTION_TRANSLATOR *Translator,
 455   IN     EFI_ASYNC_USB_TRANSFER_CALLBACK    IsochronousCallBack,
 456   IN     VOID                               *Context OPTIONAL
 457   )
 458 ;
 459
 460 /**
 461   Retrieves the current status of a USB root hub port.
 462
 463   @param  This       A pointer to the EFI_USB2_HC_PROTOCOL instance.
 464   @param  PortNumber Specifies the root hub port from which the status is to be retrieved.
 465                      This value is zero based.
 466   @param  PortStatus A pointer to the current port status bits and port status change bits.
 467
 468   @retval EFI_SUCCESS           The status of the USB root hub port specified by PortNumber
 469                                 was returned in PortStatus.
 470   @retval EFI_INVALID_PARAMETER PortNumber is invalid.
 471
 472 **/
 473 typedef
 474 EFI_STATUS
 475 (EFIAPI *EFI_USB2_HC_PROTOCOL_GET_ROOTHUB_PORT_STATUS) (
 476   IN CONST  EFI_USB2_HC_PROTOCOL    *This,
 477   IN CONST  UINT8                   PortNumber,
 478   OUT       EFI_USB_PORT_STATUS     *PortStatus
 479   )
 480 ;
 481
 482 /**
 483   Sets a feature for the specified root hub port.
 484
 485   @param  This        A pointer to the EFI_USB2_HC_PROTOCOL instance.
 486   @param  PortNumber  Specifies the root hub port whose feature is requested to be set. This
 487                       value is zero based.
 488   @param  PortFeature Indicates the feature selector associated with the feature set request.
 489
 490   @retval EFI_SUCCESS           The feature specified by PortFeature was set for the USB
 491                                 root hub port specified by PortNumber.
 492   @retval EFI_INVALID_PARAMETER PortNumber is invalid or PortFeature is invalid for this function.
 493
 494 **/
 495 typedef
 496 EFI_STATUS
 497 (EFIAPI *EFI_USB2_HC_PROTOCOL_SET_ROOTHUB_PORT_FEATURE) (
 498   IN EFI_USB2_HC_PROTOCOL    *This,
 499   IN UINT8                   PortNumber,
 500   IN EFI_USB_PORT_FEATURE    PortFeature
 501   )
 502 ;
 503
 504 /**
 505   Clears a feature for the specified root hub port.
 506
 507   @param  This        A pointer to the EFI_USB2_HC_PROTOCOL instance.
 508   @param  PortNumber  Specifies the root hub port whose feature is requested to be cleared. This
 509                       value is zero based.
 510   @param  PortFeature Indicates the feature selector associated with the feature clear request.
 511
 512   @retval EFI_SUCCESS           The feature specified by PortFeature was cleared for the USB
 513                                 root hub port specified by PortNumber.
 514   @retval EFI_INVALID_PARAMETER PortNumber is invalid or PortFeature is invalid for this function.
 515
 516 **/
 517 typedef
 518 EFI_STATUS
 519 (EFIAPI *EFI_USB2_HC_PROTOCOL_CLEAR_ROOTHUB_PORT_FEATURE) (
 520   IN EFI_USB2_HC_PROTOCOL    *This,
 521   IN UINT8                   PortNumber,
 522   IN EFI_USB_PORT_FEATURE    PortFeature
 523   )
 524 ;
 525
 526 struct _EFI_USB2_HC_PROTOCOL {
 527   EFI_USB2_HC_PROTOCOL_GET_CAPABILITY              GetCapability;
 528   EFI_USB2_HC_PROTOCOL_RESET                       Reset;
 529   EFI_USB2_HC_PROTOCOL_GET_STATE                   GetState;
 530   EFI_USB2_HC_PROTOCOL_SET_STATE                   SetState;
 531   EFI_USB2_HC_PROTOCOL_CONTROL_TRANSFER            ControlTransfer;
 532   EFI_USB2_HC_PROTOCOL_BULK_TRANSFER               BulkTransfer;
 533   EFI_USB2_HC_PROTOCOL_ASYNC_INTERRUPT_TRANSFER    AsyncInterruptTransfer;
 534   EFI_USB2_HC_PROTOCOL_SYNC_INTERRUPT_TRANSFER     SyncInterruptTransfer;
 535   EFI_USB2_HC_PROTOCOL_ISOCHRONOUS_TRANSFER        IsochronousTransfer;
 536   EFI_USB2_HC_PROTOCOL_ASYNC_ISOCHRONOUS_TRANSFER  AsyncIsochronousTransfer;
 537   EFI_USB2_HC_PROTOCOL_GET_ROOTHUB_PORT_STATUS     GetRootHubPortStatus;
 538   EFI_USB2_HC_PROTOCOL_SET_ROOTHUB_PORT_FEATURE    SetRootHubPortFeature;
 539   EFI_USB2_HC_PROTOCOL_CLEAR_ROOTHUB_PORT_FEATURE  ClearRootHubPortFeature;
 540   UINT16                                           MajorRevision;
 541   UINT16                                           MinorRevision;
 542 };
 543
 544 extern EFI_GUID gEfiUsb2HcProtocolGuid;
 545
 546 #endif