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