include/usb.h

   1 /*
   2  * (C) Copyright 2001
   3  * Denis Peter, MPL AG Switzerland
   4  *
   5  * SPDX-License-Identifier:     GPL-2.0+
   6  * Note: Part of this code has been derived from linux
   7  *
   8  */
   9 #ifndef _USB_H_
  10 #define _USB_H_
  11
  12 #include <usb_defs.h>
  13 #include <linux/usb/ch9.h>
  14
  15 /*
  16  * The EHCI spec says that we must align to at least 32 bytes.  However,
  17  * some platforms require larger alignment.
  18  */
  19 #if ARCH_DMA_MINALIGN > 32
  20 #define USB_DMA_MINALIGN        ARCH_DMA_MINALIGN
  21 #else
  22 #define USB_DMA_MINALIGN        32
  23 #endif
  24
  25 /* Everything is aribtrary */
  26 #define USB_ALTSETTINGALLOC             4
  27 #define USB_MAXALTSETTING               128     /* Hard limit */
  28
  29 #define USB_MAX_DEVICE                  32
  30 #define USB_MAXCONFIG                   8
  31 #define USB_MAXINTERFACES               8
  32 #define USB_MAXENDPOINTS                16
  33 #define USB_MAXCHILDREN                 8       /* This is arbitrary */
  34 #define USB_MAX_HUB                     16
  35
  36 #define USB_CNTL_TIMEOUT 100 /* 100ms timeout */
  37
  38 /*
  39  * This is the timeout to allow for submitting an urb in ms. We allow more
  40  * time for a BULK device to react - some are slow.
  41  */
  42 #define USB_TIMEOUT_MS(pipe) (usb_pipebulk(pipe) ? 5000 : 1000)
  43
  44 /* device request (setup) */
  45 struct devrequest {
  46         unsigned char   requesttype;
  47         unsigned char   request;
  48         unsigned short  value;
  49         unsigned short  index;
  50         unsigned short  length;
  51 } __attribute__ ((packed));
  52
  53 /* Interface */
  54 struct usb_interface {
  55         struct usb_interface_descriptor desc;
  56
  57         unsigned char   no_of_ep;
  58         unsigned char   num_altsetting;
  59         unsigned char   act_altsetting;
  60
  61         struct usb_endpoint_descriptor ep_desc[USB_MAXENDPOINTS];
  62         /*
  63          * Super Speed Device will have Super Speed Endpoint
  64          * Companion Descriptor  (section 9.6.7 of usb 3.0 spec)
  65          * Revision 1.0 June 6th 2011
  66          */
  67         struct usb_ss_ep_comp_descriptor ss_ep_comp_desc[USB_MAXENDPOINTS];
  68 } __attribute__ ((packed));
  69
  70 /* Configuration information.. */
  71 struct usb_config {
  72         struct usb_config_descriptor desc;
  73
  74         unsigned char   no_of_if;       /* number of interfaces */
  75         struct usb_interface if_desc[USB_MAXINTERFACES];
  76 } __attribute__ ((packed));
  77
  78 enum {
  79         /* Maximum packet size; encoded as 0,1,2,3 = 8,16,32,64 */
  80         PACKET_SIZE_8   = 0,
  81         PACKET_SIZE_16  = 1,
  82         PACKET_SIZE_32  = 2,
  83         PACKET_SIZE_64  = 3,
  84 };
  85
  86 struct usb_device {
  87         int     devnum;                 /* Device number on USB bus */
  88         int     speed;                  /* full/low/high */
  89         char    mf[32];                 /* manufacturer */
  90         char    prod[32];               /* product */
  91         char    serial[32];             /* serial number */
  92
  93         /* Maximum packet size; one of: PACKET_SIZE_* */
  94         int maxpacketsize;
  95         /* one bit for each endpoint ([0] = IN, [1] = OUT) */
  96         unsigned int toggle[2];
  97         /* endpoint halts; one bit per endpoint # & direction;
  98          * [0] = IN, [1] = OUT
  99          */
 100         unsigned int halted[2];
 101         int epmaxpacketin[16];          /* INput endpoint specific maximums */
 102         int epmaxpacketout[16];         /* OUTput endpoint specific maximums */
 103
 104         int configno;                   /* selected config number */
 105         /* Device Descriptor */
 106         struct usb_device_descriptor descriptor
 107                 __attribute__((aligned(ARCH_DMA_MINALIGN)));
 108         struct usb_config config; /* config descriptor */
 109
 110         int have_langid;                /* whether string_langid is valid yet */
 111         int string_langid;              /* language ID for strings */
 112         int (*irq_handle)(struct usb_device *dev);
 113         unsigned long irq_status;
 114         int irq_act_len;                /* transfered bytes */
 115         void *privptr;
 116         /*
 117          * Child devices -  if this is a hub device
 118          * Each instance needs its own set of data structures.
 119          */
 120         unsigned long status;
 121         int act_len;                    /* transfered bytes */
 122         int maxchild;                   /* Number of ports if hub */
 123         int portnr;
 124         struct usb_device *parent;
 125         struct usb_device *children[USB_MAXCHILDREN];
 126
 127         void *controller;               /* hardware controller private data */
 128         /* slot_id - for xHCI enabled devices */
 129         unsigned int slot_id;
 130 };
 131
 132 /*
 133  * You can initialize platform's USB host or device
 134  * ports by passing this enum as an argument to
 135  * board_usb_init().
 136  */
 137 enum usb_init_type {
 138         USB_INIT_HOST,
 139         USB_INIT_DEVICE
 140 };
 141
 142 /**********************************************************************
 143  * this is how the lowlevel part communicate with the outer world
 144  */
 145
 146 #if defined(CONFIG_USB_UHCI) || defined(CONFIG_USB_OHCI) || \
 147         defined(CONFIG_USB_EHCI) || defined(CONFIG_USB_OHCI_NEW) || \
 148         defined(CONFIG_USB_SL811HS) || defined(CONFIG_USB_ISP116X_HCD) || \
 149         defined(CONFIG_USB_R8A66597_HCD) || defined(CONFIG_USB_DAVINCI) || \
 150         defined(CONFIG_USB_OMAP3) || defined(CONFIG_USB_DA8XX) || \
 151         defined(CONFIG_USB_BLACKFIN) || defined(CONFIG_USB_AM35X) || \
 152         defined(CONFIG_USB_MUSB_DSPS) || defined(CONFIG_USB_MUSB_AM35X) || \
 153         defined(CONFIG_USB_MUSB_OMAP2PLUS) || defined(CONFIG_USB_XHCI)
 154
 155 int usb_lowlevel_init(int index, enum usb_init_type init, void **controller);
 156 int usb_lowlevel_stop(int index);
 157
 158 int submit_bulk_msg(struct usb_device *dev, unsigned long pipe,
 159                         void *buffer, int transfer_len);
 160 int submit_control_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
 161                         int transfer_len, struct devrequest *setup);
 162 int submit_int_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
 163                         int transfer_len, int interval);
 164
 165 /* Defines */
 166 #define USB_UHCI_VEND_ID        0x8086
 167 #define USB_UHCI_DEV_ID         0x7112
 168
 169 /*
 170  * PXA25x can only act as USB device. There are drivers
 171  * which works with USB CDC gadgets implementations.
 172  * Some of them have common routines which can be used
 173  * in boards init functions e.g. udc_disconnect() used for
 174  * forced device disconnection from host.
 175  */
 176 #elif defined(CONFIG_USB_GADGET_PXA2XX)
 177
 178 extern void udc_disconnect(void);
 179
 180 #endif
 181
 182 /*
 183  * board-specific hardware initialization, called by
 184  * usb drivers and u-boot commands
 185  *
 186  * @param index USB controller number
 187  * @param init initializes controller as USB host or device
 188  */
 189 int board_usb_init(int index, enum usb_init_type init);
 190
 191 /*
 192  * can be used to clean up after failed USB initialization attempt
 193  * vide: board_usb_init()
 194  *
 195  * @param index USB controller number for selective cleanup
 196  * @param init usb_init_type passed to board_usb_init()
 197  */
 198 int board_usb_cleanup(int index, enum usb_init_type init);
 199
 200 #ifdef CONFIG_USB_STORAGE
 201
 202 #define USB_MAX_STOR_DEV 5
 203 block_dev_desc_t *usb_stor_get_dev(int index);
 204 int usb_stor_scan(int mode);
 205 int usb_stor_info(void);
 206
 207 #endif
 208
 209 #ifdef CONFIG_USB_HOST_ETHER
 210
 211 #define USB_MAX_ETH_DEV 5
 212 int usb_host_eth_scan(int mode);
 213
 214 #endif
 215
 216 #ifdef CONFIG_USB_KEYBOARD
 217
 218 int drv_usb_kbd_init(void);
 219 int usb_kbd_deregister(void);
 220
 221 #endif
 222 /* routines */
 223 int usb_init(void); /* initialize the USB Controller */
 224 int usb_stop(void); /* stop the USB Controller */
 225
 226
 227 int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol);
 228 int usb_set_idle(struct usb_device *dev, int ifnum, int duration,
 229                         int report_id);
 230 struct usb_device *usb_get_dev_index(int index);
 231 int usb_control_msg(struct usb_device *dev, unsigned int pipe,
 232                         unsigned char request, unsigned char requesttype,
 233                         unsigned short value, unsigned short index,
 234                         void *data, unsigned short size, int timeout);
 235 int usb_bulk_msg(struct usb_device *dev, unsigned int pipe,
 236                         void *data, int len, int *actual_length, int timeout);
 237 int usb_submit_int_msg(struct usb_device *dev, unsigned long pipe,
 238                         void *buffer, int transfer_len, int interval);
 239 int usb_disable_asynch(int disable);
 240 int usb_maxpacket(struct usb_device *dev, unsigned long pipe);
 241 int usb_get_configuration_no(struct usb_device *dev, unsigned char *buffer,
 242                                 int cfgno);
 243 int usb_get_report(struct usb_device *dev, int ifnum, unsigned char type,
 244                         unsigned char id, void *buf, int size);
 245 int usb_get_class_descriptor(struct usb_device *dev, int ifnum,
 246                         unsigned char type, unsigned char id, void *buf,
 247                         int size);
 248 int usb_clear_halt(struct usb_device *dev, int pipe);
 249 int usb_string(struct usb_device *dev, int index, char *buf, size_t size);
 250 int usb_set_interface(struct usb_device *dev, int interface, int alternate);
 251
 252 /* big endian -> little endian conversion */
 253 /* some CPUs are already little endian e.g. the ARM920T */
 254 #define __swap_16(x) \
 255         ({ unsigned short x_ = (unsigned short)x; \
 256          (unsigned short)( \
 257                 ((x_ & 0x00FFU) << 8) | ((x_ & 0xFF00U) >> 8)); \
 258         })
 259 #define __swap_32(x) \
 260         ({ unsigned long x_ = (unsigned long)x; \
 261          (unsigned long)( \
 262                 ((x_ & 0x000000FFUL) << 24) | \
 263                 ((x_ & 0x0000FF00UL) <<  8) | \
 264                 ((x_ & 0x00FF0000UL) >>  8) | \
 265                 ((x_ & 0xFF000000UL) >> 24)); \
 266         })
 267
 268 #ifdef __LITTLE_ENDIAN
 269 # define swap_16(x) (x)
 270 # define swap_32(x) (x)
 271 #else
 272 # define swap_16(x) __swap_16(x)
 273 # define swap_32(x) __swap_32(x)
 274 #endif
 275
 276 /*
 277  * Calling this entity a "pipe" is glorifying it. A USB pipe
 278  * is something embarrassingly simple: it basically consists
 279  * of the following information:
 280  *  - device number (7 bits)
 281  *  - endpoint number (4 bits)
 282  *  - current Data0/1 state (1 bit)
 283  *  - direction (1 bit)
 284  *  - speed (2 bits)
 285  *  - max packet size (2 bits: 8, 16, 32 or 64)
 286  *  - pipe type (2 bits: control, interrupt, bulk, isochronous)
 287  *
 288  * That's 18 bits. Really. Nothing more. And the USB people have
 289  * documented these eighteen bits as some kind of glorious
 290  * virtual data structure.
 291  *
 292  * Let's not fall in that trap. We'll just encode it as a simple
 293  * unsigned int. The encoding is:
 294  *
 295  *  - max size:         bits 0-1        (00 = 8, 01 = 16, 10 = 32, 11 = 64)
 296  *  - direction:        bit 7           (0 = Host-to-Device [Out],
 297  *                                      (1 = Device-to-Host [In])
 298  *  - device:           bits 8-14
 299  *  - endpoint:         bits 15-18
 300  *  - Data0/1:          bit 19
 301  *  - pipe type:        bits 30-31      (00 = isochronous, 01 = interrupt,
 302  *                                       10 = control, 11 = bulk)
 303  *
 304  * Why? Because it's arbitrary, and whatever encoding we select is really
 305  * up to us. This one happens to share a lot of bit positions with the UHCI
 306  * specification, so that much of the uhci driver can just mask the bits
 307  * appropriately.
 308  */
 309 /* Create various pipes... */
 310 #define create_pipe(dev,endpoint) \
 311                 (((dev)->devnum << 8) | ((endpoint) << 15) | \
 312                 (dev)->maxpacketsize)
 313 #define default_pipe(dev) ((dev)->speed << 26)
 314
 315 #define usb_sndctrlpipe(dev, endpoint)  ((PIPE_CONTROL << 30) | \
 316                                          create_pipe(dev, endpoint))
 317 #define usb_rcvctrlpipe(dev, endpoint)  ((PIPE_CONTROL << 30) | \
 318                                          create_pipe(dev, endpoint) | \
 319                                          USB_DIR_IN)
 320 #define usb_sndisocpipe(dev, endpoint)  ((PIPE_ISOCHRONOUS << 30) | \
 321                                          create_pipe(dev, endpoint))
 322 #define usb_rcvisocpipe(dev, endpoint)  ((PIPE_ISOCHRONOUS << 30) | \
 323                                          create_pipe(dev, endpoint) | \
 324                                          USB_DIR_IN)
 325 #define usb_sndbulkpipe(dev, endpoint)  ((PIPE_BULK << 30) | \
 326                                          create_pipe(dev, endpoint))
 327 #define usb_rcvbulkpipe(dev, endpoint)  ((PIPE_BULK << 30) | \
 328                                          create_pipe(dev, endpoint) | \
 329                                          USB_DIR_IN)
 330 #define usb_sndintpipe(dev, endpoint)   ((PIPE_INTERRUPT << 30) | \
 331                                          create_pipe(dev, endpoint))
 332 #define usb_rcvintpipe(dev, endpoint)   ((PIPE_INTERRUPT << 30) | \
 333                                          create_pipe(dev, endpoint) | \
 334                                          USB_DIR_IN)
 335 #define usb_snddefctrl(dev)             ((PIPE_CONTROL << 30) | \
 336                                          default_pipe(dev))
 337 #define usb_rcvdefctrl(dev)             ((PIPE_CONTROL << 30) | \
 338                                          default_pipe(dev) | \
 339                                          USB_DIR_IN)
 340
 341 /* The D0/D1 toggle bits */
 342 #define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> ep) & 1)
 343 #define usb_dotoggle(dev, ep, out)  ((dev)->toggle[out] ^= (1 << ep))
 344 #define usb_settoggle(dev, ep, out, bit) ((dev)->toggle[out] = \
 345                                                 ((dev)->toggle[out] & \
 346                                                  ~(1 << ep)) | ((bit) << ep))
 347
 348 /* Endpoint halt control/status */
 349 #define usb_endpoint_out(ep_dir)        (((ep_dir >> 7) & 1) ^ 1)
 350 #define usb_endpoint_halt(dev, ep, out) ((dev)->halted[out] |= (1 << (ep)))
 351 #define usb_endpoint_running(dev, ep, out) ((dev)->halted[out] &= ~(1 << (ep)))
 352 #define usb_endpoint_halted(dev, ep, out) ((dev)->halted[out] & (1 << (ep)))
 353
 354 #define usb_packetid(pipe)      (((pipe) & USB_DIR_IN) ? USB_PID_IN : \
 355                                  USB_PID_OUT)
 356
 357 #define usb_pipeout(pipe)       ((((pipe) >> 7) & 1) ^ 1)
 358 #define usb_pipein(pipe)        (((pipe) >> 7) & 1)
 359 #define usb_pipedevice(pipe)    (((pipe) >> 8) & 0x7f)
 360 #define usb_pipe_endpdev(pipe)  (((pipe) >> 8) & 0x7ff)
 361 #define usb_pipeendpoint(pipe)  (((pipe) >> 15) & 0xf)
 362 #define usb_pipedata(pipe)      (((pipe) >> 19) & 1)
 363 #define usb_pipetype(pipe)      (((pipe) >> 30) & 3)
 364 #define usb_pipeisoc(pipe)      (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
 365 #define usb_pipeint(pipe)       (usb_pipetype((pipe)) == PIPE_INTERRUPT)
 366 #define usb_pipecontrol(pipe)   (usb_pipetype((pipe)) == PIPE_CONTROL)
 367 #define usb_pipebulk(pipe)      (usb_pipetype((pipe)) == PIPE_BULK)
 368
 369 #define usb_pipe_ep_index(pipe) \
 370                 usb_pipecontrol(pipe) ? (usb_pipeendpoint(pipe) * 2) : \
 371                                 ((usb_pipeendpoint(pipe) * 2) - \
 372                                  (usb_pipein(pipe) ? 0 : 1))
 373
 374 /*************************************************************************
 375  * Hub Stuff
 376  */
 377 struct usb_port_status {
 378         unsigned short wPortStatus;
 379         unsigned short wPortChange;
 380 } __attribute__ ((packed));
 381
 382 struct usb_hub_status {
 383         unsigned short wHubStatus;
 384         unsigned short wHubChange;
 385 } __attribute__ ((packed));
 386
 387
 388 /* Hub descriptor */
 389 struct usb_hub_descriptor {
 390         unsigned char  bLength;
 391         unsigned char  bDescriptorType;
 392         unsigned char  bNbrPorts;
 393         unsigned short wHubCharacteristics;
 394         unsigned char  bPwrOn2PwrGood;
 395         unsigned char  bHubContrCurrent;
 396         unsigned char  DeviceRemovable[(USB_MAXCHILDREN+1+7)/8];
 397         unsigned char  PortPowerCtrlMask[(USB_MAXCHILDREN+1+7)/8];
 398         /* DeviceRemovable and PortPwrCtrlMask want to be variable-length
 399            bitmaps that hold max 255 entries. (bit0 is ignored) */
 400 } __attribute__ ((packed));
 401
 402
 403 struct usb_hub_device {
 404         struct usb_device *pusb_dev;
 405         struct usb_hub_descriptor desc;
 406 };
 407
 408 int usb_hub_probe(struct usb_device *dev, int ifnum);
 409 void usb_hub_reset(void);
 410 int hub_port_reset(struct usb_device *dev, int port,
 411                           unsigned short *portstat);
 412
 413 struct usb_device *usb_alloc_new_device(void *controller);
 414
 415 int usb_new_device(struct usb_device *dev);
 416 void usb_free_device(void);
 417 int usb_alloc_device(struct usb_device *dev);
 418
 419 #endif /*_USB_H_ */