include/uapi/linux/usb/ch11.h

   1 /*
   2  * This file holds Hub protocol constants and data structures that are
   3  * defined in chapter 11 (Hub Specification) of the USB 2.0 specification.
   4  *
   5  * It is used/shared between the USB core, the HCDs and couple of other USB
   6  * drivers.
   7  */
   8
   9 #ifndef __LINUX_CH11_H
  10 #define __LINUX_CH11_H
  11
  12 #include <linux/types.h>        /* __u8 etc */
  13
  14 /*
  15  * Hub request types
  16  */
  17
  18 #define USB_RT_HUB      (USB_TYPE_CLASS | USB_RECIP_DEVICE)
  19 #define USB_RT_PORT     (USB_TYPE_CLASS | USB_RECIP_OTHER)
  20
  21 /*
  22  * Hub class requests
  23  * See USB 2.0 spec Table 11-16
  24  */
  25 #define HUB_CLEAR_TT_BUFFER     8
  26 #define HUB_RESET_TT            9
  27 #define HUB_GET_TT_STATE        10
  28 #define HUB_STOP_TT             11
  29
  30 /*
  31  * Hub class additional requests defined by USB 3.0 spec
  32  * See USB 3.0 spec Table 10-6
  33  */
  34 #define HUB_SET_DEPTH           12
  35 #define HUB_GET_PORT_ERR_COUNT  13
  36
  37 /*
  38  * Hub Class feature numbers
  39  * See USB 2.0 spec Table 11-17
  40  */
  41 #define C_HUB_LOCAL_POWER       0
  42 #define C_HUB_OVER_CURRENT      1
  43
  44 /*
  45  * Port feature numbers
  46  * See USB 2.0 spec Table 11-17
  47  */
  48 #define USB_PORT_FEAT_CONNECTION        0
  49 #define USB_PORT_FEAT_ENABLE            1
  50 #define USB_PORT_FEAT_SUSPEND           2       /* L2 suspend */
  51 #define USB_PORT_FEAT_OVER_CURRENT      3
  52 #define USB_PORT_FEAT_RESET             4
  53 #define USB_PORT_FEAT_L1                5       /* L1 suspend */
  54 #define USB_PORT_FEAT_POWER             8
  55 #define USB_PORT_FEAT_LOWSPEED          9       /* Should never be used */
  56 #define USB_PORT_FEAT_C_CONNECTION      16
  57 #define USB_PORT_FEAT_C_ENABLE          17
  58 #define USB_PORT_FEAT_C_SUSPEND         18
  59 #define USB_PORT_FEAT_C_OVER_CURRENT    19
  60 #define USB_PORT_FEAT_C_RESET           20
  61 #define USB_PORT_FEAT_TEST              21
  62 #define USB_PORT_FEAT_INDICATOR         22
  63 #define USB_PORT_FEAT_C_PORT_L1         23
  64
  65 /*
  66  * Port feature selectors added by USB 3.0 spec.
  67  * See USB 3.0 spec Table 10-7
  68  */
  69 #define USB_PORT_FEAT_LINK_STATE                5
  70 #define USB_PORT_FEAT_U1_TIMEOUT                23
  71 #define USB_PORT_FEAT_U2_TIMEOUT                24
  72 #define USB_PORT_FEAT_C_PORT_LINK_STATE         25
  73 #define USB_PORT_FEAT_C_PORT_CONFIG_ERROR       26
  74 #define USB_PORT_FEAT_REMOTE_WAKE_MASK          27
  75 #define USB_PORT_FEAT_BH_PORT_RESET             28
  76 #define USB_PORT_FEAT_C_BH_PORT_RESET           29
  77 #define USB_PORT_FEAT_FORCE_LINKPM_ACCEPT       30
  78
  79 #define USB_PORT_LPM_TIMEOUT(p)                 (((p) & 0xff) << 8)
  80
  81 /* USB 3.0 hub remote wake mask bits, see table 10-14 */
  82 #define USB_PORT_FEAT_REMOTE_WAKE_CONNECT       (1 << 8)
  83 #define USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT    (1 << 9)
  84 #define USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT  (1 << 10)
  85
  86 /*
  87  * Hub Status and Hub Change results
  88  * See USB 2.0 spec Table 11-19 and Table 11-20
  89  */
  90 struct usb_port_status {
  91         __le16 wPortStatus;
  92         __le16 wPortChange;
  93 } __attribute__ ((packed));
  94
  95 /*
  96  * wPortStatus bit field
  97  * See USB 2.0 spec Table 11-21
  98  */
  99 #define USB_PORT_STAT_CONNECTION        0x0001
 100 #define USB_PORT_STAT_ENABLE            0x0002
 101 #define USB_PORT_STAT_SUSPEND           0x0004
 102 #define USB_PORT_STAT_OVERCURRENT       0x0008
 103 #define USB_PORT_STAT_RESET             0x0010
 104 #define USB_PORT_STAT_L1                0x0020
 105 /* bits 6 to 7 are reserved */
 106 #define USB_PORT_STAT_POWER             0x0100
 107 #define USB_PORT_STAT_LOW_SPEED         0x0200
 108 #define USB_PORT_STAT_HIGH_SPEED        0x0400
 109 #define USB_PORT_STAT_TEST              0x0800
 110 #define USB_PORT_STAT_INDICATOR         0x1000
 111 /* bits 13 to 15 are reserved */
 112
 113 /*
 114  * Additions to wPortStatus bit field from USB 3.0
 115  * See USB 3.0 spec Table 10-10
 116  */
 117 #define USB_PORT_STAT_LINK_STATE        0x01e0
 118 #define USB_SS_PORT_STAT_POWER          0x0200
 119 #define USB_SS_PORT_STAT_SPEED          0x1c00
 120 #define USB_PORT_STAT_SPEED_5GBPS       0x0000
 121 /* Valid only if port is enabled */
 122 /* Bits that are the same from USB 2.0 */
 123 #define USB_SS_PORT_STAT_MASK (USB_PORT_STAT_CONNECTION |           \
 124                                 USB_PORT_STAT_ENABLE |      \
 125                                 USB_PORT_STAT_OVERCURRENT | \
 126                                 USB_PORT_STAT_RESET)
 127
 128 /*
 129  * Definitions for PORT_LINK_STATE values
 130  * (bits 5-8) in wPortStatus
 131  */
 132 #define USB_SS_PORT_LS_U0               0x0000
 133 #define USB_SS_PORT_LS_U1               0x0020
 134 #define USB_SS_PORT_LS_U2               0x0040
 135 #define USB_SS_PORT_LS_U3               0x0060
 136 #define USB_SS_PORT_LS_SS_DISABLED      0x0080
 137 #define USB_SS_PORT_LS_RX_DETECT        0x00a0
 138 #define USB_SS_PORT_LS_SS_INACTIVE      0x00c0
 139 #define USB_SS_PORT_LS_POLLING          0x00e0
 140 #define USB_SS_PORT_LS_RECOVERY         0x0100
 141 #define USB_SS_PORT_LS_HOT_RESET        0x0120
 142 #define USB_SS_PORT_LS_COMP_MOD         0x0140
 143 #define USB_SS_PORT_LS_LOOPBACK         0x0160
 144
 145 /*
 146  * wPortChange bit field
 147  * See USB 2.0 spec Table 11-22 and USB 2.0 LPM ECN Table-4.10
 148  * Bits 0 to 5 shown, bits 6 to 15 are reserved
 149  */
 150 #define USB_PORT_STAT_C_CONNECTION      0x0001
 151 #define USB_PORT_STAT_C_ENABLE          0x0002
 152 #define USB_PORT_STAT_C_SUSPEND         0x0004
 153 #define USB_PORT_STAT_C_OVERCURRENT     0x0008
 154 #define USB_PORT_STAT_C_RESET           0x0010
 155 #define USB_PORT_STAT_C_L1              0x0020
 156 /*
 157  * USB 3.0 wPortChange bit fields
 158  * See USB 3.0 spec Table 10-11
 159  */
 160 #define USB_PORT_STAT_C_BH_RESET        0x0020
 161 #define USB_PORT_STAT_C_LINK_STATE      0x0040
 162 #define USB_PORT_STAT_C_CONFIG_ERROR    0x0080
 163
 164 /*
 165  * wHubCharacteristics (masks)
 166  * See USB 2.0 spec Table 11-13, offset 3
 167  */
 168 #define HUB_CHAR_LPSM           0x0003 /* Logical Power Switching Mode mask */
 169 #define HUB_CHAR_COMMON_LPSM    0x0000 /* All ports power control at once */
 170 #define HUB_CHAR_INDV_PORT_LPSM 0x0001 /* per-port power control */
 171 #define HUB_CHAR_NO_LPSM        0x0002 /* no power switching */
 172
 173 #define HUB_CHAR_COMPOUND       0x0004 /* hub is part of a compound device */
 174
 175 #define HUB_CHAR_OCPM           0x0018 /* Over-Current Protection Mode mask */
 176 #define HUB_CHAR_COMMON_OCPM    0x0000 /* All ports Over-Current reporting */
 177 #define HUB_CHAR_INDV_PORT_OCPM 0x0008 /* per-port Over-current reporting */
 178 #define HUB_CHAR_NO_OCPM        0x0010 /* No Over-current Protection support */
 179
 180 #define HUB_CHAR_TTTT           0x0060 /* TT Think Time mask */
 181 #define HUB_CHAR_PORTIND        0x0080 /* per-port indicators (LEDs) */
 182
 183 struct usb_hub_status {
 184         __le16 wHubStatus;
 185         __le16 wHubChange;
 186 } __attribute__ ((packed));
 187
 188 /*
 189  * Hub Status & Hub Change bit masks
 190  * See USB 2.0 spec Table 11-19 and Table 11-20
 191  * Bits 0 and 1 for wHubStatus and wHubChange
 192  * Bits 2 to 15 are reserved for both
 193  */
 194 #define HUB_STATUS_LOCAL_POWER  0x0001
 195 #define HUB_STATUS_OVERCURRENT  0x0002
 196 #define HUB_CHANGE_LOCAL_POWER  0x0001
 197 #define HUB_CHANGE_OVERCURRENT  0x0002
 198
 199
 200 /*
 201  * Hub descriptor
 202  * See USB 2.0 spec Table 11-13
 203  */
 204
 205 #define USB_DT_HUB                      (USB_TYPE_CLASS | 0x09)
 206 #define USB_DT_SS_HUB                   (USB_TYPE_CLASS | 0x0a)
 207 #define USB_DT_HUB_NONVAR_SIZE          7
 208 #define USB_DT_SS_HUB_SIZE              12
 209
 210 /*
 211  * Hub Device descriptor
 212  * USB Hub class device protocols
 213  */
 214
 215 #define USB_HUB_PR_FS           0 /* Full speed hub */
 216 #define USB_HUB_PR_HS_NO_TT     0 /* Hi-speed hub without TT */
 217 #define USB_HUB_PR_HS_SINGLE_TT 1 /* Hi-speed hub with single TT */
 218 #define USB_HUB_PR_HS_MULTI_TT  2 /* Hi-speed hub with multiple TT */
 219 #define USB_HUB_PR_SS           3 /* Super speed hub */
 220
 221 struct usb_hub_descriptor {
 222         __u8  bDescLength;
 223         __u8  bDescriptorType;
 224         __u8  bNbrPorts;
 225         __le16 wHubCharacteristics;
 226         __u8  bPwrOn2PwrGood;
 227         __u8  bHubContrCurrent;
 228
 229         /* 2.0 and 3.0 hubs differ here */
 230         union {
 231                 struct {
 232                         /* add 1 bit for hub status change; round to bytes */
 233                         __u8  DeviceRemovable[(USB_MAXCHILDREN + 1 + 7) / 8];
 234                         __u8  PortPwrCtrlMask[(USB_MAXCHILDREN + 1 + 7) / 8];
 235                 }  __attribute__ ((packed)) hs;
 236
 237                 struct {
 238                         __u8 bHubHdrDecLat;
 239                         __le16 wHubDelay;
 240                         __le16 DeviceRemovable;
 241                 }  __attribute__ ((packed)) ss;
 242         } u;
 243 } __attribute__ ((packed));
 244
 245 /* port indicator status selectors, tables 11-7 and 11-25 */
 246 #define HUB_LED_AUTO    0
 247 #define HUB_LED_AMBER   1
 248 #define HUB_LED_GREEN   2
 249 #define HUB_LED_OFF     3
 250
 251 enum hub_led_mode {
 252         INDICATOR_AUTO = 0,
 253         INDICATOR_CYCLE,
 254         /* software blinks for attention:  software, hardware, reserved */
 255         INDICATOR_GREEN_BLINK, INDICATOR_GREEN_BLINK_OFF,
 256         INDICATOR_AMBER_BLINK, INDICATOR_AMBER_BLINK_OFF,
 257         INDICATOR_ALT_BLINK, INDICATOR_ALT_BLINK_OFF
 258 } __attribute__ ((packed));
 259
 260 /* Transaction Translator Think Times, in bits */
 261 #define HUB_TTTT_8_BITS         0x00
 262 #define HUB_TTTT_16_BITS        0x20
 263 #define HUB_TTTT_24_BITS        0x40
 264 #define HUB_TTTT_32_BITS        0x60
 265
 266 #endif /* __LINUX_CH11_H */