MdeModulePkg: Apply uncrustify changes

[mirror_edk2.git] / MdeModulePkg / Bus / Usb / UsbBusDxe / UsbHub.h

/** @file\r
\r
    The definition for USB hub.\r
\r
Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _USB_HUB_H_\r
#define _USB_HUB_H_\r
\r
#include <IndustryStandard/Usb.h>\r
\r
#define USB_ENDPOINT_ADDR(EpAddr)  ((EpAddr) & 0x7F)\r
#define USB_ENDPOINT_TYPE(Desc)    ((Desc)->Attributes & USB_ENDPOINT_TYPE_MASK)\r
\r
#define USB_DESC_TYPE_HUB  0x29\r
\r
#define USB_DESC_TYPE_HUB_SUPER_SPEED  0x2a\r
\r
//\r
// Hub class control transfer target\r
//\r
#define USB_HUB_TARGET_HUB   0\r
#define USB_HUB_TARGET_PORT  3\r
//\r
// HUB class specific contrl transfer request type\r
//\r
#define USB_HUB_REQ_GET_STATUS     0\r
#define USB_HUB_REQ_CLEAR_FEATURE  1\r
#define USB_HUB_REQ_SET_FEATURE    3\r
#define USB_HUB_REQ_GET_DESC       6\r
#define USB_HUB_REQ_SET_DESC       7\r
#define USB_HUB_REQ_CLEAR_TT       8\r
#define USB_HUB_REQ_RESET_TT       9\r
#define USB_HUB_REQ_GET_TT_STATE   10\r
#define USB_HUB_REQ_STOP_TT        11\r
\r
#define USB_HUB_REQ_SET_DEPTH  12\r
\r
//\r
// USB hub class feature selector\r
//\r
#define USB_HUB_C_HUB_LOCAL_POWER   0\r
#define USB_HUB_C_HUB_OVER_CURRENT  1\r
#define USB_HUB_PORT_CONNECTION     0\r
#define USB_HUB_PORT_ENABLE         1\r
#define USB_HUB_PORT_SUSPEND        2\r
#define USB_HUB_PORT_OVER_CURRENT   3\r
#define USB_HUB_PORT_RESET          4\r
\r
#define USB_HUB_PORT_LINK_STATE  5\r
\r
#define USB_HUB_PORT_POWER           8\r
#define USB_HUB_PORT_LOW_SPEED       9\r
#define USB_HUB_C_PORT_CONNECT       16\r
#define USB_HUB_C_PORT_ENABLE        17\r
#define USB_HUB_C_PORT_SUSPEND       18\r
#define USB_HUB_C_PORT_OVER_CURRENT  19\r
#define USB_HUB_C_PORT_RESET         20\r
#define USB_HUB_PORT_TEST            21\r
#define USB_HUB_PORT_INDICATOR       22\r
\r
#define USB_HUB_C_PORT_LINK_STATE      25\r
#define USB_HUB_PORT_REMOTE_WAKE_MASK  27\r
#define USB_HUB_BH_PORT_RESET          28\r
#define USB_HUB_C_BH_PORT_RESET        29\r
\r
//\r
// Constant value for Port Status & Port Change Status of SuperSpeed port\r
//\r
#define USB_SS_PORT_STAT_C_BH_RESET         0x0020\r
#define USB_SS_PORT_STAT_C_PORT_LINK_STATE  0x0040\r
//\r
// USB hub power control method. In gang power control\r
//\r
#define USB_HUB_GANG_POWER_CTRL  0\r
#define USB_HUB_PORT_POWER_CTRL  0x01\r
//\r
// USB hub status bits\r
//\r
#define USB_HUB_STAT_LOCAL_POWER     0x01\r
#define USB_HUB_STAT_OVER_CURRENT    0x02\r
#define USB_HUB_STAT_C_LOCAL_POWER   0x01\r
#define USB_HUB_STAT_C_OVER_CURRENT  0x02\r
\r
#define USB_HUB_CLASS_CODE     0x09\r
#define USB_HUB_SUBCLASS_CODE  0x00\r
\r
//\r
// Host software return timeout if port status doesn't change\r
// after 500ms(LOOP * STALL = 5000 * 0.1ms), set by experience\r
//\r
#define USB_WAIT_PORT_STS_CHANGE_LOOP  5000\r
\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     DescType;\r
  UINT8     NumPorts;\r
  UINT16    HubCharacter;\r
  UINT8     PwrOn2PwrGood;\r
  UINT8     HubContrCurrent;\r
  UINT8     Filler[16];\r
} EFI_USB_HUB_DESCRIPTOR;\r
\r
#pragma pack()\r
\r
typedef struct {\r
  UINT16                  ChangedBit;\r
  EFI_USB_PORT_FEATURE    Feature;\r
} USB_CHANGE_FEATURE_MAP;\r
\r
/**\r
  Clear the transaction translate buffer if full/low\r
  speed control/bulk transfer failed and the transfer\r
  uses this hub as translator.Remember to clear the TT\r
  buffer of transaction translator, not that of the\r
  parent.\r
\r
  @param  UsbDev                The Usb device.\r
  @param  Port                  The port of the hub.\r
  @param  DevAddr               Address of the failed transaction.\r
  @param  EpNum                 The endpoint number of the failed transaction.\r
  @param  EpType                The type of failed transaction.\r
\r
  @retval EFI_SUCCESS           The TT buffer is cleared.\r
  @retval Others                Failed to clear the TT buffer.\r
\r
**/\r
EFI_STATUS\r
UsbHubCtrlClearTTBuffer (\r
  IN USB_DEVICE  *UsbDev,\r
  IN UINT8       Port,\r
  IN UINT16      DevAddr,\r
  IN UINT16      EpNum,\r
  IN UINT16      EpType\r
  );\r
\r
/**\r
  Test whether the interface is a hub interface.\r
\r
  @param  UsbIf                 The interface to test.\r
\r
  @retval TRUE                  The interface is a hub interface.\r
  @retval FALSE                 The interface isn't a hub interface.\r
\r
**/\r
BOOLEAN\r
UsbIsHubInterface (\r
  IN USB_INTERFACE  *UsbIf\r
  );\r
\r
/**\r
  Ack the hub change bits. If these bits are not ACKed, Hub will\r
  always return changed bit map from its interrupt endpoint.\r
\r
  @param  UsbDev                The Usb device.\r
\r
  @retval EFI_SUCCESS           The hub change status is ACKed.\r
  @retval Others                Failed to ACK the hub status.\r
\r
**/\r
EFI_STATUS\r
UsbHubAckHubStatus (\r
  IN  USB_DEVICE  *UsbDev\r
  );\r
\r
extern USB_HUB_API  mUsbHubApi;\r
extern USB_HUB_API  mUsbRootHubApi;\r
#endif\r