MdeModulePkg/Bus/Usb/UsbBusDxe/UsbHub.h

   1 /** @file
   2
   3     The definition for USB hub.
   4
   5 Copyright (c) 2007, Intel Corporation
   6 All rights reserved. This program and the accompanying materials
   7 are licensed and made available under the terms and conditions of the BSD License
   8 which accompanies this distribution.  The full text of the license may be found at
   9 http://opensource.org/licenses/bsd-license.php
  10
  11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #ifndef _USB_HUB_H_
  17 #define _USB_HUB_H_
  18
  19 #include <IndustryStandard/Usb.h>
  20
  21 #define USB_ENDPOINT_ADDR(EpAddr) ((EpAddr) & 0x7F)
  22 #define USB_ENDPOINT_TYPE(Desc)   ((Desc)->Attributes & USB_ENDPOINT_TYPE_MASK)
  23
  24 typedef enum {
  25   USB_DESC_TYPE_HUB           = 0x29,
  26
  27   //
  28   // Hub class control transfer target
  29   //
  30   USB_HUB_TARGET_HUB          = 0,
  31   USB_HUB_TARGET_PORT         = 3,
  32
  33   //
  34   // HUB class specific contrl transfer request type
  35   //
  36   USB_HUB_REQ_GET_STATUS      = 0,
  37   USB_HUB_REQ_CLEAR_FEATURE   = 1,
  38   USB_HUB_REQ_SET_FEATURE     = 3,
  39   USB_HUB_REQ_GET_DESC        = 6,
  40   USB_HUB_REQ_SET_DESC        = 7,
  41   USB_HUB_REQ_CLEAR_TT        = 8,
  42   USB_HUB_REQ_RESET_TT        = 9,
  43   USB_HUB_REQ_GET_TT_STATE    = 10,
  44   USB_HUB_REQ_STOP_TT         = 11,
  45
  46
  47   //
  48   // USB hub class feature selector
  49   //
  50   USB_HUB_C_HUB_LOCAL_POWER   = 0,
  51   USB_HUB_C_HUB_OVER_CURRENT  = 1,
  52   USB_HUB_PORT_CONNECTION     = 0,
  53   USB_HUB_PORT_ENABLE         = 1,
  54   USB_HUB_PORT_SUSPEND        = 2,
  55   USB_HUB_PORT_OVER_CURRENT   = 3,
  56   USB_HUB_PORT_RESET          = 4,
  57   USB_HUB_PORT_POWER          = 8,
  58   USB_HUB_PORT_LOW_SPEED      = 9,
  59   USB_HUB_C_PORT_CONNECT      = 16,
  60   USB_HUB_C_PORT_ENABLE       = 17,
  61   USB_HUB_C_PORT_SUSPEND      = 18,
  62   USB_HUB_C_PORT_OVER_CURRENT = 19,
  63   USB_HUB_C_PORT_RESET        = 20,
  64   USB_HUB_PORT_TEST           = 21,
  65   USB_HUB_PORT_INDICATOR      = 22,
  66
  67   //
  68   // USB hub power control method. In gang power control
  69   //
  70   USB_HUB_GANG_POWER_CTRL     = 0,
  71   USB_HUB_PORT_POWER_CTRL     = 0x01,
  72
  73   //
  74   // USB hub status bits
  75   //
  76   USB_HUB_STAT_LOCAL_POWER    = 0x01,
  77   USB_HUB_STAT_OVER_CURRENT   = 0x02,
  78   USB_HUB_STAT_C_LOCAL_POWER  = 0x01,
  79   USB_HUB_STAT_C_OVER_CURRENT = 0x02,
  80
  81   USB_HUB_CLASS_CODE          = 0x09,
  82   USB_HUB_SUBCLASS_CODE       = 0x00,
  83
  84   //
  85   // Host software return timeout if port status doesn't change
  86   // after 500ms(LOOP * STALL = 100 * 5ms), set by experience
  87   //
  88   USB_WAIT_PORT_STS_CHANGE_LOOP   = 100
  89 }USB_HUB_FLAGS_VALUE;
  90
  91 #pragma pack(1)
  92 //
  93 // Hub descriptor, the last two fields are of variable lenght.
  94 //
  95 typedef struct {
  96   UINT8           Length;
  97   UINT8           DescType;
  98   UINT8           NumPorts;
  99   UINT16          HubCharacter;
 100   UINT8           PwrOn2PwrGood;
 101   UINT8           HubContrCurrent;
 102   UINT8           Filler[16];
 103 } EFI_USB_HUB_DESCRIPTOR;
 104 #pragma pack()
 105
 106
 107 typedef struct {
 108   UINT16                ChangedBit;
 109   EFI_USB_PORT_FEATURE  Feature;
 110 } USB_CHANGE_FEATURE_MAP;
 111
 112
 113 /**
 114   Clear the transaction translate buffer if full/low
 115   speed control/bulk transfer failed and the transfer
 116   uses this hub as translator.Remember to clear the TT
 117   buffer of transaction translator, not that of the
 118   parent.
 119
 120   @param  UsbDev                The Usb device.
 121   @param  Port                  The port of the hub.
 122   @param  DevAddr               Address of the failed transaction.
 123   @param  EpNum                 The endpoint number of the failed transaction.
 124   @param  EpType                The type of failed transaction.
 125
 126   @retval EFI_SUCCESS           The TT buffer is cleared.
 127   @retval Others                Failed to clear the TT buffer.
 128
 129 **/
 130 EFI_STATUS
 131 UsbHubCtrlClearTTBuffer (
 132   IN USB_DEVICE           *UsbDev,
 133   IN UINT8                Port,
 134   IN UINT16               DevAddr,
 135   IN UINT16               EpNum,
 136   IN UINT16               EpType
 137   );
 138
 139
 140 /**
 141   Test whether the interface is a hub interface.
 142
 143   @param  UsbIf                 The interface to test.
 144
 145   @retval TRUE                  The interface is a hub interface.
 146   @retval FALSE                 The interface isn't a hub interface.
 147
 148 **/
 149 BOOLEAN
 150 UsbIsHubInterface (
 151   IN USB_INTERFACE        *UsbIf
 152   );
 153
 154
 155 /**
 156   Ack the hub change bits. If these bits are not ACKed, Hub will
 157   always return changed bit map from its interrupt endpoint.
 158
 159   @param  UsbDev                The Usb device.
 160
 161   @retval EFI_SUCCESS           The hub change status is ACKed.
 162   @retval Others                Failed to ACK the hub status.
 163
 164 **/
 165 EFI_STATUS
 166 UsbHubAckHubStatus (
 167   IN  USB_DEVICE         *UsbDev
 168   );
 169
 170 extern USB_HUB_API        mUsbHubApi;
 171 extern USB_HUB_API        mUsbRootHubApi;
 172 #endif
 173