include/usb_defs.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * (C) Copyright 2001
   4  * Denis Peter, MPL AG Switzerland
   5  *
   6  * Note: Part of this code has been derived from linux
   7  */
   8 #ifndef _USB_DEFS_H_
   9 #define _USB_DEFS_H_
  10
  11 /* USB constants */
  12
  13 /* Device and/or Interface Class codes */
  14 #define USB_CLASS_PER_INTERFACE  0      /* for DeviceClass */
  15 #define USB_CLASS_AUDIO          1
  16 #define USB_CLASS_COMM           2
  17 #define USB_CLASS_HID            3
  18 #define USB_CLASS_PRINTER              7
  19 #define USB_CLASS_MASS_STORAGE   8
  20 #define USB_CLASS_HUB            9
  21 #define USB_CLASS_DATA           10
  22 #define USB_CLASS_VENDOR_SPEC    0xff
  23
  24 /* some HID sub classes */
  25 #define USB_SUB_HID_NONE        0
  26 #define USB_SUB_HID_BOOT        1
  27
  28 /* some UID Protocols */
  29 #define USB_PROT_HID_NONE       0
  30 #define USB_PROT_HID_KEYBOARD   1
  31 #define USB_PROT_HID_MOUSE      2
  32
  33 /* Sub STORAGE Classes */
  34 #define US_SC_RBC              1                /* Typically, flash devices */
  35 #define US_SC_8020             2                /* CD-ROM */
  36 #define US_SC_QIC              3                /* QIC-157 Tapes */
  37 #define US_SC_UFI              4                /* Floppy */
  38 #define US_SC_8070             5                /* Removable media */
  39 #define US_SC_SCSI             6                /* Transparent */
  40 #define US_SC_MIN              US_SC_RBC
  41 #define US_SC_MAX              US_SC_SCSI
  42
  43 /* STORAGE Protocols */
  44 #define US_PR_CB               1                /* Control/Bulk w/o interrupt */
  45 #define US_PR_CBI              0                /* Control/Bulk/Interrupt */
  46 #define US_PR_BULK             0x50             /* bulk only */
  47
  48 /* USB types */
  49 #define USB_TYPE_STANDARD   (0x00 << 5)
  50 #define USB_TYPE_CLASS      (0x01 << 5)
  51 #define USB_TYPE_VENDOR     (0x02 << 5)
  52 #define USB_TYPE_RESERVED   (0x03 << 5)
  53
  54 /* USB recipients */
  55 #define USB_RECIP_DEVICE      0x00
  56 #define USB_RECIP_INTERFACE   0x01
  57 #define USB_RECIP_ENDPOINT    0x02
  58 #define USB_RECIP_OTHER       0x03
  59
  60 /* USB directions */
  61 #define USB_DIR_OUT           0
  62 #define USB_DIR_IN            0x80
  63
  64 /*
  65  * bmRequestType: USB Device Requests, table 9.2 USB 2.0 spec.
  66  * (shifted) direction/type/recipient.
  67  */
  68 #define DeviceRequest \
  69         ((USB_DIR_IN | USB_TYPE_STANDARD | USB_RECIP_DEVICE) << 8)
  70
  71 #define DeviceOutRequest \
  72         ((USB_DIR_OUT | USB_TYPE_STANDARD | USB_RECIP_DEVICE) << 8)
  73
  74 #define InterfaceRequest \
  75         ((USB_DIR_IN | USB_TYPE_STANDARD | USB_RECIP_INTERFACE) << 8)
  76
  77 #define EndpointRequest \
  78         ((USB_DIR_IN | USB_TYPE_STANDARD | USB_RECIP_INTERFACE) << 8)
  79
  80 #define EndpointOutRequest \
  81         ((USB_DIR_OUT | USB_TYPE_STANDARD | USB_RECIP_INTERFACE) << 8)
  82
  83 /* class requests from the USB 2.0 hub spec, table 11-15 */
  84 #define HUB_CLASS_REQ(dir, type, request) ((((dir) | (type)) << 8) | (request))
  85 /* GetBusState and SetHubDescriptor are optional, omitted */
  86 #define ClearHubFeature         HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_HUB, \
  87                                               USB_REQ_CLEAR_FEATURE)
  88 #define ClearPortFeature        HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_PORT, \
  89                                               USB_REQ_CLEAR_FEATURE)
  90 #define GetHubDescriptor        HUB_CLASS_REQ(USB_DIR_IN, USB_RT_HUB, \
  91                                               USB_REQ_GET_DESCRIPTOR)
  92 #define GetHubStatus            HUB_CLASS_REQ(USB_DIR_IN, USB_RT_HUB, \
  93                                               USB_REQ_GET_STATUS)
  94 #define GetPortStatus           HUB_CLASS_REQ(USB_DIR_IN, USB_RT_PORT, \
  95                                               USB_REQ_GET_STATUS)
  96 #define SetHubFeature           HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_HUB, \
  97                                               USB_REQ_SET_FEATURE)
  98 #define SetPortFeature          HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_PORT, \
  99                                               USB_REQ_SET_FEATURE)
 100 #define ClearTTBuffer           HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_PORT, \
 101                                               HUB_CLEAR_TT_BUFFER)
 102 #define ResetTT                 HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_PORT, \
 103                                               HUB_RESET_TT)
 104 #define GetTTState              HUB_CLASS_REQ(USB_DIR_IN, USB_RT_PORT, \
 105                                               HUB_GET_TT_STATE)
 106 #define StopTT                  HUB_CLASS_REQ(USB_DIR_OUT, USB_RT_PORT, \
 107                                               HUB_STOP_TT)
 108
 109 /* Descriptor types */
 110 #define USB_DT_DEVICE        0x01
 111 #define USB_DT_CONFIG        0x02
 112 #define USB_DT_STRING        0x03
 113 #define USB_DT_INTERFACE     0x04
 114 #define USB_DT_ENDPOINT      0x05
 115
 116 #define USB_DT_HID          (USB_TYPE_CLASS | 0x01)
 117 #define USB_DT_REPORT       (USB_TYPE_CLASS | 0x02)
 118 #define USB_DT_PHYSICAL     (USB_TYPE_CLASS | 0x03)
 119 #define USB_DT_HUB          (USB_TYPE_CLASS | 0x09)
 120 #define USB_DT_SS_HUB       (USB_TYPE_CLASS | 0x0a)
 121
 122 /* Descriptor sizes per descriptor type */
 123 #define USB_DT_DEVICE_SIZE      18
 124 #define USB_DT_CONFIG_SIZE      9
 125 #define USB_DT_INTERFACE_SIZE   9
 126 #define USB_DT_ENDPOINT_SIZE    7
 127 #define USB_DT_ENDPOINT_AUDIO_SIZE  9   /* Audio extension */
 128 #define USB_DT_HUB_NONVAR_SIZE  7
 129 #define USB_DT_HID_SIZE         9
 130
 131 /* Endpoints */
 132 #define USB_ENDPOINT_NUMBER_MASK  0x0f  /* in bEndpointAddress */
 133 #define USB_ENDPOINT_DIR_MASK     0x80
 134
 135 #define USB_ENDPOINT_XFERTYPE_MASK 0x03 /* in bmAttributes */
 136 #define USB_ENDPOINT_XFER_CONTROL  0
 137 #define USB_ENDPOINT_XFER_ISOC     1
 138 #define USB_ENDPOINT_XFER_BULK     2
 139 #define USB_ENDPOINT_XFER_INT      3
 140
 141 /* USB Packet IDs (PIDs) */
 142 #define USB_PID_UNDEF_0             0xf0
 143 #define USB_PID_OUT                 0xe1
 144 #define USB_PID_ACK                 0xd2
 145 #define USB_PID_DATA0               0xc3
 146 #define USB_PID_UNDEF_4             0xb4
 147 #define USB_PID_SOF                 0xa5
 148 #define USB_PID_UNDEF_6             0x96
 149 #define USB_PID_UNDEF_7             0x87
 150 #define USB_PID_UNDEF_8             0x78
 151 #define USB_PID_IN                  0x69
 152 #define USB_PID_NAK                 0x5a
 153 #define USB_PID_DATA1               0x4b
 154 #define USB_PID_PREAMBLE            0x3c
 155 #define USB_PID_SETUP               0x2d
 156 #define USB_PID_STALL               0x1e
 157 #define USB_PID_UNDEF_F             0x0f
 158
 159 /* Standard requests */
 160 #define USB_REQ_GET_STATUS          0x00
 161 #define USB_REQ_CLEAR_FEATURE       0x01
 162 #define USB_REQ_SET_FEATURE         0x03
 163 #define USB_REQ_SET_ADDRESS         0x05
 164 #define USB_REQ_GET_DESCRIPTOR      0x06
 165 #define USB_REQ_SET_DESCRIPTOR      0x07
 166 #define USB_REQ_GET_CONFIGURATION   0x08
 167 #define USB_REQ_SET_CONFIGURATION   0x09
 168 #define USB_REQ_GET_INTERFACE       0x0A
 169 #define USB_REQ_SET_INTERFACE       0x0B
 170 #define USB_REQ_SYNCH_FRAME         0x0C
 171
 172 /* HID requests */
 173 #define USB_REQ_GET_REPORT          0x01
 174 #define USB_REQ_GET_IDLE            0x02
 175 #define USB_REQ_GET_PROTOCOL        0x03
 176 #define USB_REQ_SET_REPORT          0x09
 177 #define USB_REQ_SET_IDLE            0x0A
 178 #define USB_REQ_SET_PROTOCOL        0x0B
 179
 180 /* Device features */
 181 #define USB_FEAT_HALT               0x00
 182 #define USB_FEAT_WAKEUP             0x01
 183 #define USB_FEAT_TEST               0x02
 184
 185 /* Test modes */
 186 #define USB_TEST_MODE_J             0x01
 187 #define USB_TEST_MODE_K             0x02
 188 #define USB_TEST_MODE_SE0_NAK       0x03
 189 #define USB_TEST_MODE_PACKET        0x04
 190 #define USB_TEST_MODE_FORCE_ENABLE  0x05
 191
 192 /*
 193  * "pipe" definitions, use unsigned so we can compare reliably, since this
 194  * value is shifted up to bits 30/31.
 195  */
 196 #define PIPE_ISOCHRONOUS    0U
 197 #define PIPE_INTERRUPT      1U
 198 #define PIPE_CONTROL        2U
 199 #define PIPE_BULK           3U
 200 #define PIPE_DEVEP_MASK     0x0007ff00
 201
 202 #define USB_ISOCHRONOUS    0
 203 #define USB_INTERRUPT      1
 204 #define USB_CONTROL        2
 205 #define USB_BULK           3
 206
 207 #define USB_PIPE_TYPE_SHIFT     30
 208 #define USB_PIPE_TYPE_MASK      (3 << USB_PIPE_TYPE_SHIFT)
 209
 210 #define USB_PIPE_DEV_SHIFT      8
 211 #define USB_PIPE_DEV_MASK       (0x7f << USB_PIPE_DEV_SHIFT)
 212
 213 #define USB_PIPE_EP_SHIFT       15
 214 #define USB_PIPE_EP_MASK        (0xf << USB_PIPE_EP_SHIFT)
 215
 216 /* USB-status codes: */
 217 #define USB_ST_ACTIVE           0x1             /* TD is active */
 218 #define USB_ST_STALLED          0x2             /* TD is stalled */
 219 #define USB_ST_BUF_ERR          0x4             /* buffer error */
 220 #define USB_ST_BABBLE_DET       0x8             /* Babble detected */
 221 #define USB_ST_NAK_REC          0x10    /* NAK Received*/
 222 #define USB_ST_CRC_ERR          0x20    /* CRC/timeout Error */
 223 #define USB_ST_BIT_ERR          0x40    /* Bitstuff error */
 224 #define USB_ST_NOT_PROC         0x80000000L     /* Not yet processed */
 225
 226 /*************************************************************************
 227  * Hub defines
 228  */
 229
 230 /*
 231  * Hub request types
 232  */
 233
 234 #define USB_RT_HUB      (USB_TYPE_CLASS | USB_RECIP_DEVICE)
 235 #define USB_RT_PORT     (USB_TYPE_CLASS | USB_RECIP_OTHER)
 236
 237 /*
 238  * Hub Class feature numbers
 239  */
 240 #define C_HUB_LOCAL_POWER   0
 241 #define C_HUB_OVER_CURRENT  1
 242
 243 /*
 244  * Port feature numbers
 245  */
 246 #define USB_PORT_FEAT_CONNECTION     0
 247 #define USB_PORT_FEAT_ENABLE         1
 248 #define USB_PORT_FEAT_SUSPEND        2
 249 #define USB_PORT_FEAT_OVER_CURRENT   3
 250 #define USB_PORT_FEAT_RESET          4
 251 #define USB_PORT_FEAT_POWER          8
 252 #define USB_PORT_FEAT_LOWSPEED       9
 253 #define USB_PORT_FEAT_HIGHSPEED      10
 254 #define USB_PORT_FEAT_C_CONNECTION   16
 255 #define USB_PORT_FEAT_C_ENABLE       17
 256 #define USB_PORT_FEAT_C_SUSPEND      18
 257 #define USB_PORT_FEAT_C_OVER_CURRENT 19
 258 #define USB_PORT_FEAT_C_RESET        20
 259 #define USB_PORT_FEAT_TEST           21
 260
 261 /*
 262  * Changes to Port feature numbers for Super speed,
 263  * from USB 3.0 spec Table 10-8
 264  */
 265 #define USB_SS_PORT_FEAT_U1_TIMEOUT     23
 266 #define USB_SS_PORT_FEAT_U2_TIMEOUT     24
 267 #define USB_SS_PORT_FEAT_C_LINK_STATE   25
 268 #define USB_SS_PORT_FEAT_C_CONFIG_ERROR 26
 269 #define USB_SS_PORT_FEAT_BH_RESET       28
 270 #define USB_SS_PORT_FEAT_C_BH_RESET     29
 271
 272 /* wPortStatus bits */
 273 #define USB_PORT_STAT_CONNECTION    0x0001
 274 #define USB_PORT_STAT_ENABLE        0x0002
 275 #define USB_PORT_STAT_SUSPEND       0x0004
 276 #define USB_PORT_STAT_OVERCURRENT   0x0008
 277 #define USB_PORT_STAT_RESET         0x0010
 278 #define USB_PORT_STAT_POWER         0x0100
 279 #define USB_PORT_STAT_LOW_SPEED     0x0200
 280 #define USB_PORT_STAT_HIGH_SPEED    0x0400      /* support for EHCI */
 281 #define USB_PORT_STAT_SUPER_SPEED   0x0600      /* faking support to XHCI */
 282 #define USB_PORT_STAT_SPEED_MASK        \
 283         (USB_PORT_STAT_LOW_SPEED | USB_PORT_STAT_HIGH_SPEED)
 284
 285 /*
 286  * Changes to wPortStatus bit field in USB 3.0
 287  * See USB 3.0 spec Table 10-10
 288  */
 289 #define USB_SS_PORT_STAT_LINK_STATE     0x01e0
 290 #define USB_SS_PORT_STAT_POWER          0x0200
 291 #define USB_SS_PORT_STAT_SPEED          0x1c00
 292 #define USB_SS_PORT_STAT_SPEED_5GBPS    0x0000
 293 /* Bits that are the same from USB 2.0 */
 294 #define USB_SS_PORT_STAT_MASK           (USB_PORT_STAT_CONNECTION | \
 295                                          USB_PORT_STAT_ENABLE | \
 296                                          USB_PORT_STAT_OVERCURRENT | \
 297                                          USB_PORT_STAT_RESET)
 298
 299 /* wPortChange bits */
 300 #define USB_PORT_STAT_C_CONNECTION  0x0001
 301 #define USB_PORT_STAT_C_ENABLE      0x0002
 302 #define USB_PORT_STAT_C_SUSPEND     0x0004
 303 #define USB_PORT_STAT_C_OVERCURRENT 0x0008
 304 #define USB_PORT_STAT_C_RESET       0x0010
 305
 306 /*
 307  * Changes to wPortChange bit fields in USB 3.0
 308  * See USB 3.0 spec Table 10-12
 309  */
 310 #define USB_SS_PORT_STAT_C_BH_RESET     0x0020
 311 #define USB_SS_PORT_STAT_C_LINK_STATE   0x0040
 312 #define USB_SS_PORT_STAT_C_CONFIG_ERROR 0x0080
 313
 314 /* wHubCharacteristics (masks) */
 315 #define HUB_CHAR_COMMON_OCPM        0x0000 /* All ports Over-Current reporting */
 316 #define HUB_CHAR_INDV_PORT_LPSM     0x0001 /* per-port power control */
 317 #define HUB_CHAR_NO_LPSM            0x0002 /* no power switching */
 318 #define HUB_CHAR_LPSM               0x0003
 319 #define HUB_CHAR_COMPOUND           0x0004
 320 #define HUB_CHAR_INDV_PORT_OCPM     0x0008 /* per-port Over-current reporting */
 321 #define HUB_CHAR_NO_OCPM            0x0010 /* No Over-current Protection support */
 322 #define HUB_CHAR_OCPM               0x0018
 323 #define HUB_CHAR_TTTT               0x0060 /* TT Think Time mask */
 324 #define HUB_CHAR_PORTIND            0x0080 /* per-port indicators (LEDs) */
 325
 326 /*
 327  * Hub Status & Hub Change bit masks
 328  */
 329 #define HUB_STATUS_LOCAL_POWER  0x0001
 330 #define HUB_STATUS_OVERCURRENT  0x0002
 331
 332 #define HUB_CHANGE_LOCAL_POWER  0x0001
 333 #define HUB_CHANGE_OVERCURRENT  0x0002
 334
 335 /* Mask for wIndex in get/set port feature */
 336 #define USB_HUB_PORT_MASK       0xf
 337
 338 /* Hub class request codes */
 339 #define USB_REQ_SET_HUB_DEPTH   0x0c
 340
 341 /*
 342  * As of USB 2.0, full/low speed devices are segregated into trees.
 343  * One type grows from USB 1.1 host controllers (OHCI, UHCI etc).
 344  * The other type grows from high speed hubs when they connect to
 345  * full/low speed devices using "Transaction Translators" (TTs).
 346  */
 347 struct usb_tt {
 348         bool            multi;          /* true means one TT per port */
 349         unsigned        think_time;     /* think time in ns */
 350 };
 351
 352 /*
 353  * CBI style
 354  */
 355
 356 #define US_CBI_ADSC             0
 357
 358 /* Command Block Wrapper */
 359 struct umass_bbb_cbw {
 360         __u32           dCBWSignature;
 361 #       define CBWSIGNATURE     0x43425355
 362         __u32           dCBWTag;
 363         __u32           dCBWDataTransferLength;
 364         __u8            bCBWFlags;
 365 #       define CBWFLAGS_OUT     0x00
 366 #       define CBWFLAGS_IN      0x80
 367 #       define CBWFLAGS_SBZ     0x7f
 368         __u8            bCBWLUN;
 369         __u8            bCDBLength;
 370 #       define CBWCDBLENGTH     16
 371         __u8            CBWCDB[CBWCDBLENGTH];
 372 };
 373 #define UMASS_BBB_CBW_SIZE      31
 374
 375 /* Command Status Wrapper */
 376 struct umass_bbb_csw {
 377         __u32           dCSWSignature;
 378 #       define CSWSIGNATURE     0x53425355
 379         __u32           dCSWTag;
 380         __u32           dCSWDataResidue;
 381         __u8            bCSWStatus;
 382 #       define CSWSTATUS_GOOD   0x0
 383 #       define CSWSTATUS_FAILED 0x1
 384 #       define CSWSTATUS_PHASE  0x2
 385 };
 386 #define UMASS_BBB_CSW_SIZE      13
 387
 388 /*
 389  * BULK only
 390  */
 391 #define US_BBB_RESET            0xff
 392 #define US_BBB_GET_MAX_LUN      0xfe
 393
 394 #endif /*_USB_DEFS_H_ */