MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Bus / Usb / UsbBusPei / PeiUsbLib.h

/** @file\r
Common Libarary for PEI USB\r
\r
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved. <BR>\r
\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _PEI_USB_LIB_H_\r
#define _PEI_USB_LIB_H_\r
\r
\r
//\r
// Standard device request and request type\r
// By [Spec-USB20/Chapter-9.4]\r
//\r
#define USB_DEV_GET_STATUS                  0x00\r
#define USB_DEV_GET_STATUS_REQ_TYPE_D       0x80 // Receiver : Device\r
#define USB_DEV_GET_STATUS_REQ_TYPE_I       0x81 // Receiver : Interface\r
#define USB_DEV_GET_STATUS_REQ_TYPE_E       0x82 // Receiver : Endpoint\r
\r
#define USB_DEV_CLEAR_FEATURE               0x01\r
#define USB_DEV_CLEAR_FEATURE_REQ_TYPE_D    0x00 // Receiver : Device\r
#define USB_DEV_CLEAR_FEATURE_REQ_TYPE_I    0x01 // Receiver : Interface\r
#define USB_DEV_CLEAR_FEATURE_REQ_TYPE_E    0x02 // Receiver : Endpoint\r
\r
#define USB_DEV_SET_FEATURE                 0x03\r
#define USB_DEV_SET_FEATURE_REQ_TYPE_D      0x00 // Receiver : Device\r
#define USB_DEV_SET_FEATURE_REQ_TYPE_I      0x01 // Receiver : Interface\r
#define USB_DEV_SET_FEATURE_REQ_TYPE_E      0x02 // Receiver : Endpoint\r
\r
#define USB_DEV_SET_ADDRESS                 0x05\r
#define USB_DEV_SET_ADDRESS_REQ_TYPE        0x00\r
\r
#define USB_DEV_GET_DESCRIPTOR              0x06\r
#define USB_DEV_GET_DESCRIPTOR_REQ_TYPE     0x80\r
\r
#define USB_DEV_SET_DESCRIPTOR              0x07\r
#define USB_DEV_SET_DESCRIPTOR_REQ_TYPE     0x00\r
\r
#define USB_DEV_GET_CONFIGURATION           0x08\r
#define USB_DEV_GET_CONFIGURATION_REQ_TYPE  0x80\r
\r
#define USB_DEV_SET_CONFIGURATION           0x09\r
#define USB_DEV_SET_CONFIGURATION_REQ_TYPE  0x00\r
\r
#define USB_DEV_GET_INTERFACE               0x0A\r
#define USB_DEV_GET_INTERFACE_REQ_TYPE      0x81\r
\r
#define USB_DEV_SET_INTERFACE               0x0B\r
#define USB_DEV_SET_INTERFACE_REQ_TYPE      0x01\r
\r
#define USB_DEV_SYNCH_FRAME                 0x0C\r
#define USB_DEV_SYNCH_FRAME_REQ_TYPE        0x82\r
\r
//\r
// USB Descriptor types\r
//\r
#define USB_DT_DEVICE     0x01\r
#define USB_DT_CONFIG     0x02\r
#define USB_DT_STRING     0x03\r
#define USB_DT_INTERFACE  0x04\r
#define USB_DT_ENDPOINT   0x05\r
#define USB_DT_HUB        0x29\r
#define USB_DT_SUPERSPEED_HUB 0x2A\r
#define USB_DT_HID        0x21\r
\r
//\r
// USB request type\r
//\r
#define USB_TYPE_STANDARD (0x00 << 5)\r
#define USB_TYPE_CLASS    (0x01 << 5)\r
#define USB_TYPE_VENDOR   (0x02 << 5)\r
#define USB_TYPE_RESERVED (0x03 << 5)\r
\r
//\r
// USB request targer device\r
//\r
#define USB_RECIP_DEVICE    0x00\r
#define USB_RECIP_INTERFACE 0x01\r
#define USB_RECIP_ENDPOINT  0x02\r
#define USB_RECIP_OTHER     0x03\r
\r
typedef enum {\r
  EfiUsbEndpointHalt,\r
  EfiUsbDeviceRemoteWakeup\r
} EFI_USB_STANDARD_FEATURE_SELECTOR;\r
\r
//\r
// Usb Data recipient type\r
//\r
typedef enum {\r
  EfiUsbDevice,\r
  EfiUsbInterface,\r
  EfiUsbEndpoint\r
} EFI_USB_RECIPIENT;\r
\r
/**\r
  Get a given usb descriptor.\r
\r
  @param  PeiServices        General-purpose services that are available to every PEIM.\r
  @param  UsbIoPpi           Indicates the PEI_USB_IO_PPI instance.\r
  @param  Value              Request Value.\r
  @param  Index              Request Index.\r
  @param  DescriptorLength   Request descriptor Length.\r
  @param  Descriptor         Request descriptor.\r
\r
\r
  @retval EFI_SUCCESS       Usb descriptor is obtained successfully.\r
  @retval EFI_DEVICE_ERROR  Cannot get the usb descriptor due to a hardware error.\r
  @retval Others            Other failure occurs.\r
\r
**/\r
EFI_STATUS\r
PeiUsbGetDescriptor (\r
  IN  EFI_PEI_SERVICES         **PeiServices,\r
  IN  PEI_USB_IO_PPI           *UsbIoPpi,\r
  IN  UINT16                   Value,\r
  IN  UINT16                   Index,\r
  IN  UINT16                   DescriptorLength,\r
  OUT VOID                     *Descriptor\r
  );\r
\r
/**\r
  Set a usb device with a specified address.\r
\r
  @param  PeiServices        General-purpose services that are available to every PEIM.\r
  @param  UsbIoPpi           Indicates the PEI_USB_IO_PPI instance.\r
  @param  AddressValue       The address to assign.\r
\r
  @retval EFI_SUCCESS        Usb device address is set successfully.\r
  @retval EFI_DEVICE_ERROR   Cannot set the usb address due to a hardware error.\r
  @retval Others             Other failure occurs.\r
\r
**/\r
EFI_STATUS\r
PeiUsbSetDeviceAddress (\r
  IN EFI_PEI_SERVICES         **PeiServices,\r
  IN PEI_USB_IO_PPI           *UsbIoPpi,\r
  IN UINT16                   AddressValue\r
  );\r
\r
\r
/**\r
  Configure a usb device to Configuration 1.\r
\r
  @param  PeiServices        General-purpose services that are available to every PEIM.\r
  @param  UsbIoPpi           Indicates the PEI_USB_IO_PPI instance.\r
\r
  @retval EFI_SUCCESS        Usb device is set to use Configuration 1 successfully.\r
  @retval EFI_DEVICE_ERROR   Cannot set the usb device due to a hardware error.\r
  @retval Others             Other failure occurs.\r
\r
**/\r
EFI_STATUS\r
PeiUsbSetConfiguration (\r
  IN EFI_PEI_SERVICES         **PeiServices,\r
  IN PEI_USB_IO_PPI           *UsbIoPpi\r
  );\r
\r
/**\r
  Judge if the port is connected with a usb device or not.\r
\r
  @param  PortStatus  The usb port status gotten.\r
\r
  @retval TRUE        A usb device is connected with the port.\r
  @retval FALSE       No usb device is connected with the port.\r
\r
**/\r
BOOLEAN\r
IsPortConnect (\r
  IN UINT16  PortStatus\r
  );\r
\r
/**\r
  Get device speed according to port status.\r
\r
  @param    PortStatus  The usb port status gotten.\r
\r
  @return   Device speed value.\r
\r
**/\r
UINTN\r
PeiUsbGetDeviceSpeed (\r
  IN UINT16 PortStatus\r
  );\r
\r
#endif\r