MdeModulePkg/UsbBus: Fix various typos

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

/** @file\r
Constants definitions for Usb Hub Peim\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_HUB_PEIM_H_\r
#define _PEI_HUB_PEIM_H_\r
\r
\r
//\r
// Hub feature numbers\r
//\r
#define C_HUB_LOCAL_POWER   0\r
#define C_HUB_OVER_CURRENT  1\r
\r
//\r
// Hub class code & sub class code\r
//\r
#define CLASS_CODE_HUB      0x09\r
#define SUB_CLASS_CODE_HUB  0\r
\r
//\r
// Hub Status & Hub Change bit masks\r
//\r
#define HUB_STATUS_LOCAL_POWER  0x0001\r
#define HUB_STATUS_OVERCURRENT  0x0002\r
\r
#define HUB_CHANGE_LOCAL_POWER  0x0001\r
#define HUB_CHANGE_OVERCURRENT  0x0002\r
\r
//\r
// Hub Characteristics\r
//\r
#define HUB_CHAR_LPSM     0x0003\r
#define HUB_CHAR_COMPOUND 0x0004\r
#define HUB_CHAR_OCPM     0x0018\r
\r
//\r
// Standard hub request and request type\r
// By [Spec-USB20/Chapter-11.24]\r
//\r
#define USB_HUB_CLEAR_FEATURE               0x01\r
#define USB_HUB_CLEAR_FEATURE_REQ_TYPE      0x20\r
\r
#define USB_HUB_CLEAR_FEATURE_PORT          0x01\r
#define USB_HUB_CLEAR_FEATURE_PORT_REQ_TYPE 0x23\r
\r
#define USB_HUB_GET_BUS_STATE               0x02\r
#define USB_HUB_GET_BUS_STATE_REQ_TYPE      0xA3\r
\r
#define USB_HUB_GET_DESCRIPTOR              0x06\r
#define USB_HUB_GET_DESCRIPTOR_REQ_TYPE     0xA0\r
\r
#define USB_HUB_GET_HUB_STATUS              0x00\r
#define USB_HUB_GET_HUB_STATUS_REQ_TYPE     0xA0\r
\r
#define USB_HUB_GET_PORT_STATUS             0x00\r
#define USB_HUB_GET_PORT_STATUS_REQ_TYPE    0xA3\r
\r
#define USB_HUB_SET_DESCRIPTOR              0x07\r
#define USB_HUB_SET_DESCRIPTOR_REQ_TYPE     0x20\r
\r
#define USB_HUB_SET_HUB_FEATURE             0x03\r
#define USB_HUB_SET_HUB_FEATURE_REQ_TYPE    0x20\r
\r
#define USB_HUB_SET_PORT_FEATURE            0x03\r
#define USB_HUB_SET_PORT_FEATURE_REQ_TYPE   0x23\r
\r
#define USB_RT_HUB        (USB_TYPE_CLASS | USB_RECIP_DEVICE)\r
#define USB_RT_PORT       (USB_TYPE_CLASS | USB_RECIP_OTHER)\r
\r
#define USB_HUB_REQ_SET_DEPTH               12\r
\r
#define MAXBYTES  8\r
#pragma pack(1)\r
//\r
// Hub descriptor, the last two fields are of variable length.\r
//\r
typedef struct {\r
  UINT8 Length;\r
  UINT8 DescriptorType;\r
  UINT8 NbrPorts;\r
  UINT8 HubCharacteristics[2];\r
  UINT8 PwrOn2PwrGood;\r
  UINT8 HubContrCurrent;\r
  UINT8 Filler[MAXBYTES];\r
} EFI_USB_HUB_DESCRIPTOR;\r
\r
typedef struct {\r
  UINT16  HubStatus;\r
  UINT16  HubChangeStatus;\r
} EFI_USB_HUB_STATUS;\r
\r
#pragma pack()\r
/**\r
  Get a given hub port status.\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  Port          Usb hub port number (starting from 1).\r
  @param  PortStatus    Current Hub port status and change status.\r
\r
  @retval EFI_SUCCESS       Port status is obtained successfully.\r
  @retval EFI_DEVICE_ERROR  Cannot get the port status due to a hardware error.\r
  @retval Others            Other failure occurs.\r
\r
**/\r
EFI_STATUS\r
PeiHubGetPortStatus (\r
  IN EFI_PEI_SERVICES       **PeiServices,\r
  IN PEI_USB_IO_PPI         *UsbIoPpi,\r
  IN  UINT8                 Port,\r
  OUT UINT32                *PortStatus\r
  );\r
\r
/**\r
  Set specified feature to a given hub port.\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  Port          Usb hub port number (starting from 1).\r
  @param  Value         New feature value.\r
\r
  @retval EFI_SUCCESS       Port feature is set successfully.\r
  @retval EFI_DEVICE_ERROR  Cannot set the port feature due to a hardware error.\r
  @retval Others            Other failure occurs.\r
\r
**/\r
EFI_STATUS\r
PeiHubSetPortFeature (\r
  IN EFI_PEI_SERVICES       **PeiServices,\r
  IN PEI_USB_IO_PPI         *UsbIoPpi,\r
  IN  UINT8                 Port,\r
  IN  UINT8                 Value\r
  );\r
\r
\r
/**\r
  Get a given hub status.\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  HubStatus     Current Hub status and change status.\r
\r
  @retval EFI_SUCCESS       Hub status is obtained successfully.\r
  @retval EFI_DEVICE_ERROR  Cannot get the hub status due to a hardware error.\r
  @retval Others            Other failure occurs.\r
\r
**/\r
EFI_STATUS\r
PeiHubGetHubStatus (\r
  IN EFI_PEI_SERVICES       **PeiServices,\r
  IN PEI_USB_IO_PPI         *UsbIoPpi,\r
  OUT UINT32                *HubStatus\r
  );\r
\r
/**\r
  Clear specified feature on a given hub port.\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  Port          Usb hub port number (starting from 1).\r
  @param  Value         Feature value that will be cleared from the hub port.\r
\r
  @retval EFI_SUCCESS       Port feature is cleared successfully.\r
  @retval EFI_DEVICE_ERROR  Cannot clear the port feature due to a hardware error.\r
  @retval Others            Other failure occurs.\r
\r
**/\r
EFI_STATUS\r
PeiHubClearPortFeature (\r
  IN EFI_PEI_SERVICES       **PeiServices,\r
  IN PEI_USB_IO_PPI         *UsbIoPpi,\r
  IN  UINT8                 Port,\r
  IN  UINT8                 Value\r
  );\r
\r
/**\r
  Clear specified feature on a given hub.\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         Feature value that will be cleared from the hub port.\r
\r
  @retval EFI_SUCCESS       Hub feature is cleared successfully.\r
  @retval EFI_DEVICE_ERROR  Cannot clear the hub feature due to a hardware error.\r
  @retval Others            Other failure occurs.\r
\r
**/\r
EFI_STATUS\r
PeiHubClearHubFeature (\r
  IN EFI_PEI_SERVICES       **PeiServices,\r
  IN PEI_USB_IO_PPI         *UsbIoPpi,\r
  IN  UINT8                 Value\r
  );\r
\r
/**\r
  Get a given hub descriptor.\r
\r
  @param  PeiServices    General-purpose services that are available to every PEIM.\r
  @param  PeiUsbDevice   Indicates the hub controller device.\r
  @param  UsbIoPpi       Indicates the PEI_USB_IO_PPI instance.\r
  @param  DescriptorSize The length of Hub Descriptor buffer.\r
  @param  HubDescriptor  Caller allocated buffer to store the hub descriptor if\r
                         successfully returned.\r
\r
  @retval EFI_SUCCESS       Hub descriptor is obtained successfully.\r
  @retval EFI_DEVICE_ERROR  Cannot get the hub descriptor due to a hardware error.\r
  @retval Others            Other failure occurs.\r
\r
**/\r
EFI_STATUS\r
PeiGetHubDescriptor (\r
  IN EFI_PEI_SERVICES         **PeiServices,\r
  IN PEI_USB_DEVICE           *PeiUsbDevice,\r
  IN PEI_USB_IO_PPI           *UsbIoPpi,\r
  IN UINTN                    DescriptorSize,\r
  OUT EFI_USB_HUB_DESCRIPTOR  *HubDescriptor\r
  );\r
\r
/**\r
  Configure a given hub.\r
\r
  @param  PeiServices    General-purpose services that are available to every PEIM.\r
  @param  PeiUsbDevice   Indicating the hub controller device that will be configured\r
\r
  @retval EFI_SUCCESS       Hub configuration is done successfully.\r
  @retval EFI_DEVICE_ERROR  Cannot configure the hub due to a hardware error.\r
\r
**/\r
EFI_STATUS\r
PeiDoHubConfig (\r
  IN EFI_PEI_SERVICES         **PeiServices,\r
  IN PEI_USB_DEVICE           *PeiUsbDevice\r
  );\r
\r
/**\r
  Send reset signal over the given root hub port.\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  PortNum        Usb hub port number (starting from 1).\r
\r
**/\r
VOID\r
PeiResetHubPort (\r
  IN EFI_PEI_SERVICES    **PeiServices,\r
  IN PEI_USB_IO_PPI      *UsbIoPpi,\r
  IN UINT8               PortNum\r
  );\r
\r
#endif\r
\r
\r