include/usb.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * (C) Copyright 2001
   4  * Denis Peter, MPL AG Switzerland
   5  *
   6  * Adapted for U-Boot driver model
   7  * (C) Copyright 2015 Google, Inc
   8  * Note: Part of this code has been derived from linux
   9  *
  10  */
  11 #ifndef _USB_H_
  12 #define _USB_H_
  13
  14 #include <stdbool.h>
  15 #include <fdtdec.h>
  16 #include <usb_defs.h>
  17 #include <linux/usb/ch9.h>
  18 #include <asm/cache.h>
  19 #include <part.h>
  20
  21 extern bool usb_started; /* flag for the started/stopped USB status */
  22
  23 /*
  24  * The EHCI spec says that we must align to at least 32 bytes.  However,
  25  * some platforms require larger alignment.
  26  */
  27 #if ARCH_DMA_MINALIGN > 32
  28 #define USB_DMA_MINALIGN        ARCH_DMA_MINALIGN
  29 #else
  30 #define USB_DMA_MINALIGN        32
  31 #endif
  32
  33 /* Everything is aribtrary */
  34 #define USB_ALTSETTINGALLOC             4
  35 #define USB_MAXALTSETTING               128     /* Hard limit */
  36
  37 #define USB_MAX_DEVICE                  32
  38 #define USB_MAXCONFIG                   8
  39 #define USB_MAXINTERFACES               8
  40 #define USB_MAXENDPOINTS                16
  41 #define USB_MAXCHILDREN                 8       /* This is arbitrary */
  42 #define USB_MAX_HUB                     16
  43
  44 #define USB_CNTL_TIMEOUT 100 /* 100ms timeout */
  45
  46 /*
  47  * This is the timeout to allow for submitting an urb in ms. We allow more
  48  * time for a BULK device to react - some are slow.
  49  */
  50 #define USB_TIMEOUT_MS(pipe) (usb_pipebulk(pipe) ? 5000 : 1000)
  51
  52 /* device request (setup) */
  53 struct devrequest {
  54         __u8    requesttype;
  55         __u8    request;
  56         __le16  value;
  57         __le16  index;
  58         __le16  length;
  59 } __attribute__ ((packed));
  60
  61 /* Interface */
  62 struct usb_interface {
  63         struct usb_interface_descriptor desc;
  64
  65         __u8    no_of_ep;
  66         __u8    num_altsetting;
  67         __u8    act_altsetting;
  68
  69         struct usb_endpoint_descriptor ep_desc[USB_MAXENDPOINTS];
  70         /*
  71          * Super Speed Device will have Super Speed Endpoint
  72          * Companion Descriptor  (section 9.6.7 of usb 3.0 spec)
  73          * Revision 1.0 June 6th 2011
  74          */
  75         struct usb_ss_ep_comp_descriptor ss_ep_comp_desc[USB_MAXENDPOINTS];
  76 } __attribute__ ((packed));
  77
  78 /* Configuration information.. */
  79 struct usb_config {
  80         struct usb_config_descriptor desc;
  81
  82         __u8    no_of_if;       /* number of interfaces */
  83         struct usb_interface if_desc[USB_MAXINTERFACES];
  84 } __attribute__ ((packed));
  85
  86 enum {
  87         /* Maximum packet size; encoded as 0,1,2,3 = 8,16,32,64 */
  88         PACKET_SIZE_8   = 0,
  89         PACKET_SIZE_16  = 1,
  90         PACKET_SIZE_32  = 2,
  91         PACKET_SIZE_64  = 3,
  92 };
  93
  94 /**
  95  * struct usb_device - information about a USB device
  96  *
  97  * With driver model both UCLASS_USB (the USB controllers) and UCLASS_USB_HUB
  98  * (the hubs) have this as parent data. Hubs are children of controllers or
  99  * other hubs and there is always a single root hub for each controller.
 100  * Therefore struct usb_device can always be accessed with
 101  * dev_get_parent_priv(dev), where dev is a USB device.
 102  *
 103  * Pointers exist for obtaining both the device (could be any uclass) and
 104  * controller (UCLASS_USB) from this structure. The controller does not have
 105  * a struct usb_device since it is not a device.
 106  */
 107 struct usb_device {
 108         int     devnum;                 /* Device number on USB bus */
 109         enum usb_device_speed speed;    /* full/low/high */
 110         char    mf[32];                 /* manufacturer */
 111         char    prod[32];               /* product */
 112         char    serial[32];             /* serial number */
 113
 114         /* Maximum packet size; one of: PACKET_SIZE_* */
 115         int maxpacketsize;
 116         /* one bit for each endpoint ([0] = IN, [1] = OUT) */
 117         unsigned int toggle[2];
 118         /* endpoint halts; one bit per endpoint # & direction;
 119          * [0] = IN, [1] = OUT
 120          */
 121         unsigned int halted[2];
 122         int epmaxpacketin[16];          /* INput endpoint specific maximums */
 123         int epmaxpacketout[16];         /* OUTput endpoint specific maximums */
 124
 125         int configno;                   /* selected config number */
 126         /* Device Descriptor */
 127         struct usb_device_descriptor descriptor
 128                 __attribute__((aligned(ARCH_DMA_MINALIGN)));
 129         struct usb_config config; /* config descriptor */
 130
 131         int have_langid;                /* whether string_langid is valid yet */
 132         int string_langid;              /* language ID for strings */
 133         int (*irq_handle)(struct usb_device *dev);
 134         unsigned long irq_status;
 135         int irq_act_len;                /* transferred bytes */
 136         void *privptr;
 137         /*
 138          * Child devices -  if this is a hub device
 139          * Each instance needs its own set of data structures.
 140          */
 141         unsigned long status;
 142         unsigned long int_pending;      /* 1 bit per ep, used by int_queue */
 143         int act_len;                    /* transferred bytes */
 144         int maxchild;                   /* Number of ports if hub */
 145         int portnr;                     /* Port number, 1=first */
 146 #if !CONFIG_IS_ENABLED(DM_USB)
 147         /* parent hub, or NULL if this is the root hub */
 148         struct usb_device *parent;
 149         struct usb_device *children[USB_MAXCHILDREN];
 150         void *controller;               /* hardware controller private data */
 151 #endif
 152         /* slot_id - for xHCI enabled devices */
 153         unsigned int slot_id;
 154 #if CONFIG_IS_ENABLED(DM_USB)
 155         struct udevice *dev;            /* Pointer to associated device */
 156         struct udevice *controller_dev; /* Pointer to associated controller */
 157 #endif
 158 };
 159
 160 struct int_queue;
 161
 162 /*
 163  * You can initialize platform's USB host or device
 164  * ports by passing this enum as an argument to
 165  * board_usb_init().
 166  */
 167 enum usb_init_type {
 168         USB_INIT_HOST,
 169         USB_INIT_DEVICE,
 170         USB_INIT_UNKNOWN,
 171 };
 172
 173 /**********************************************************************
 174  * this is how the lowlevel part communicate with the outer world
 175  */
 176
 177 int usb_lowlevel_init(int index, enum usb_init_type init, void **controller);
 178 int usb_lowlevel_stop(int index);
 179
 180 #if defined(CONFIG_USB_MUSB_HOST) || CONFIG_IS_ENABLED(DM_USB)
 181 int usb_reset_root_port(struct usb_device *dev);
 182 #else
 183 #define usb_reset_root_port(dev)
 184 #endif
 185
 186 int submit_bulk_msg(struct usb_device *dev, unsigned long pipe,
 187                         void *buffer, int transfer_len);
 188 int submit_control_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
 189                         int transfer_len, struct devrequest *setup);
 190 int submit_int_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
 191                         int transfer_len, int interval, bool nonblock);
 192
 193 #if defined CONFIG_USB_EHCI_HCD || defined CONFIG_USB_MUSB_HOST \
 194         || CONFIG_IS_ENABLED(DM_USB)
 195 struct int_queue *create_int_queue(struct usb_device *dev, unsigned long pipe,
 196         int queuesize, int elementsize, void *buffer, int interval);
 197 int destroy_int_queue(struct usb_device *dev, struct int_queue *queue);
 198 void *poll_int_queue(struct usb_device *dev, struct int_queue *queue);
 199 #endif
 200
 201 /* Defines */
 202 #define USB_UHCI_VEND_ID        0x8086
 203 #define USB_UHCI_DEV_ID         0x7112
 204
 205 /*
 206  * PXA25x can only act as USB device. There are drivers
 207  * which works with USB CDC gadgets implementations.
 208  * Some of them have common routines which can be used
 209  * in boards init functions e.g. udc_disconnect() used for
 210  * forced device disconnection from host.
 211  */
 212 extern void udc_disconnect(void);
 213
 214 /*
 215  * board-specific hardware initialization, called by
 216  * usb drivers and u-boot commands
 217  *
 218  * @param index USB controller number
 219  * @param init initializes controller as USB host or device
 220  */
 221 int board_usb_init(int index, enum usb_init_type init);
 222
 223 /*
 224  * can be used to clean up after failed USB initialization attempt
 225  * vide: board_usb_init()
 226  *
 227  * @param index USB controller number for selective cleanup
 228  * @param init usb_init_type passed to board_usb_init()
 229  */
 230 int board_usb_cleanup(int index, enum usb_init_type init);
 231
 232 #ifdef CONFIG_USB_STORAGE
 233
 234 #define USB_MAX_STOR_DEV 7
 235 int usb_stor_scan(int mode);
 236 int usb_stor_info(void);
 237
 238 #endif
 239
 240 #ifdef CONFIG_USB_HOST_ETHER
 241
 242 #define USB_MAX_ETH_DEV 5
 243 int usb_host_eth_scan(int mode);
 244
 245 #endif
 246
 247 #ifdef CONFIG_USB_KEYBOARD
 248
 249 /*
 250  * USB Keyboard reports are 8 bytes in boot protocol.
 251  * Appendix B of HID Device Class Definition 1.11
 252  */
 253 #define USB_KBD_BOOT_REPORT_SIZE 8
 254
 255 int drv_usb_kbd_init(void);
 256 int usb_kbd_deregister(int force);
 257
 258 #endif
 259 /* routines */
 260 int usb_init(void); /* initialize the USB Controller */
 261 int usb_stop(void); /* stop the USB Controller */
 262 int usb_detect_change(void); /* detect if a USB device has been (un)plugged */
 263
 264
 265 int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol);
 266 int usb_set_idle(struct usb_device *dev, int ifnum, int duration,
 267                         int report_id);
 268 int usb_control_msg(struct usb_device *dev, unsigned int pipe,
 269                         unsigned char request, unsigned char requesttype,
 270                         unsigned short value, unsigned short index,
 271                         void *data, unsigned short size, int timeout);
 272 int usb_bulk_msg(struct usb_device *dev, unsigned int pipe,
 273                         void *data, int len, int *actual_length, int timeout);
 274 int usb_int_msg(struct usb_device *dev, unsigned long pipe,
 275                 void *buffer, int transfer_len, int interval, bool nonblock);
 276 int usb_lock_async(struct usb_device *dev, int lock);
 277 int usb_disable_asynch(int disable);
 278 int usb_maxpacket(struct usb_device *dev, unsigned long pipe);
 279 int usb_get_configuration_no(struct usb_device *dev, int cfgno,
 280                         unsigned char *buffer, int length);
 281 int usb_get_configuration_len(struct usb_device *dev, int cfgno);
 282 int usb_get_report(struct usb_device *dev, int ifnum, unsigned char type,
 283                         unsigned char id, void *buf, int size);
 284 int usb_get_class_descriptor(struct usb_device *dev, int ifnum,
 285                         unsigned char type, unsigned char id, void *buf,
 286                         int size);
 287 int usb_clear_halt(struct usb_device *dev, int pipe);
 288 int usb_string(struct usb_device *dev, int index, char *buf, size_t size);
 289 int usb_set_interface(struct usb_device *dev, int interface, int alternate);
 290 int usb_get_port_status(struct usb_device *dev, int port, void *data);
 291
 292 /* big endian -> little endian conversion */
 293 /* some CPUs are already little endian e.g. the ARM920T */
 294 #define __swap_16(x) \
 295         ({ unsigned short x_ = (unsigned short)x; \
 296          (unsigned short)( \
 297                 ((x_ & 0x00FFU) << 8) | ((x_ & 0xFF00U) >> 8)); \
 298         })
 299 #define __swap_32(x) \
 300         ({ unsigned long x_ = (unsigned long)x; \
 301          (unsigned long)( \
 302                 ((x_ & 0x000000FFUL) << 24) | \
 303                 ((x_ & 0x0000FF00UL) <<  8) | \
 304                 ((x_ & 0x00FF0000UL) >>  8) | \
 305                 ((x_ & 0xFF000000UL) >> 24)); \
 306         })
 307
 308 #ifdef __LITTLE_ENDIAN
 309 # define swap_16(x) (x)
 310 # define swap_32(x) (x)
 311 #else
 312 # define swap_16(x) __swap_16(x)
 313 # define swap_32(x) __swap_32(x)
 314 #endif
 315
 316 /*
 317  * Calling this entity a "pipe" is glorifying it. A USB pipe
 318  * is something embarrassingly simple: it basically consists
 319  * of the following information:
 320  *  - device number (7 bits)
 321  *  - endpoint number (4 bits)
 322  *  - current Data0/1 state (1 bit)
 323  *  - direction (1 bit)
 324  *  - speed (2 bits)
 325  *  - max packet size (2 bits: 8, 16, 32 or 64)
 326  *  - pipe type (2 bits: control, interrupt, bulk, isochronous)
 327  *
 328  * That's 18 bits. Really. Nothing more. And the USB people have
 329  * documented these eighteen bits as some kind of glorious
 330  * virtual data structure.
 331  *
 332  * Let's not fall in that trap. We'll just encode it as a simple
 333  * unsigned int. The encoding is:
 334  *
 335  *  - max size:         bits 0-1        (00 = 8, 01 = 16, 10 = 32, 11 = 64)
 336  *  - direction:        bit 7           (0 = Host-to-Device [Out],
 337  *                                      (1 = Device-to-Host [In])
 338  *  - device:           bits 8-14
 339  *  - endpoint:         bits 15-18
 340  *  - Data0/1:          bit 19
 341  *  - pipe type:        bits 30-31      (00 = isochronous, 01 = interrupt,
 342  *                                       10 = control, 11 = bulk)
 343  *
 344  * Why? Because it's arbitrary, and whatever encoding we select is really
 345  * up to us. This one happens to share a lot of bit positions with the UHCI
 346  * specification, so that much of the uhci driver can just mask the bits
 347  * appropriately.
 348  */
 349 /* Create various pipes... */
 350 #define create_pipe(dev,endpoint) \
 351                 (((dev)->devnum << 8) | ((endpoint) << 15) | \
 352                 (dev)->maxpacketsize)
 353 #define default_pipe(dev) ((dev)->speed << 26)
 354
 355 #define usb_sndctrlpipe(dev, endpoint)  ((PIPE_CONTROL << 30) | \
 356                                          create_pipe(dev, endpoint))
 357 #define usb_rcvctrlpipe(dev, endpoint)  ((PIPE_CONTROL << 30) | \
 358                                          create_pipe(dev, endpoint) | \
 359                                          USB_DIR_IN)
 360 #define usb_sndisocpipe(dev, endpoint)  ((PIPE_ISOCHRONOUS << 30) | \
 361                                          create_pipe(dev, endpoint))
 362 #define usb_rcvisocpipe(dev, endpoint)  ((PIPE_ISOCHRONOUS << 30) | \
 363                                          create_pipe(dev, endpoint) | \
 364                                          USB_DIR_IN)
 365 #define usb_sndbulkpipe(dev, endpoint)  ((PIPE_BULK << 30) | \
 366                                          create_pipe(dev, endpoint))
 367 #define usb_rcvbulkpipe(dev, endpoint)  ((PIPE_BULK << 30) | \
 368                                          create_pipe(dev, endpoint) | \
 369                                          USB_DIR_IN)
 370 #define usb_sndintpipe(dev, endpoint)   ((PIPE_INTERRUPT << 30) | \
 371                                          create_pipe(dev, endpoint))
 372 #define usb_rcvintpipe(dev, endpoint)   ((PIPE_INTERRUPT << 30) | \
 373                                          create_pipe(dev, endpoint) | \
 374                                          USB_DIR_IN)
 375 #define usb_snddefctrl(dev)             ((PIPE_CONTROL << 30) | \
 376                                          default_pipe(dev))
 377 #define usb_rcvdefctrl(dev)             ((PIPE_CONTROL << 30) | \
 378                                          default_pipe(dev) | \
 379                                          USB_DIR_IN)
 380
 381 /* The D0/D1 toggle bits */
 382 #define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> ep) & 1)
 383 #define usb_dotoggle(dev, ep, out)  ((dev)->toggle[out] ^= (1 << ep))
 384 #define usb_settoggle(dev, ep, out, bit) ((dev)->toggle[out] = \
 385                                                 ((dev)->toggle[out] & \
 386                                                  ~(1 << ep)) | ((bit) << ep))
 387
 388 /* Endpoint halt control/status */
 389 #define usb_endpoint_out(ep_dir)        (((ep_dir >> 7) & 1) ^ 1)
 390 #define usb_endpoint_halt(dev, ep, out) ((dev)->halted[out] |= (1 << (ep)))
 391 #define usb_endpoint_running(dev, ep, out) ((dev)->halted[out] &= ~(1 << (ep)))
 392 #define usb_endpoint_halted(dev, ep, out) ((dev)->halted[out] & (1 << (ep)))
 393
 394 #define usb_packetid(pipe)      (((pipe) & USB_DIR_IN) ? USB_PID_IN : \
 395                                  USB_PID_OUT)
 396
 397 #define usb_pipeout(pipe)       ((((pipe) >> 7) & 1) ^ 1)
 398 #define usb_pipein(pipe)        (((pipe) >> 7) & 1)
 399 #define usb_pipedevice(pipe)    (((pipe) >> 8) & 0x7f)
 400 #define usb_pipe_endpdev(pipe)  (((pipe) >> 8) & 0x7ff)
 401 #define usb_pipeendpoint(pipe)  (((pipe) >> 15) & 0xf)
 402 #define usb_pipedata(pipe)      (((pipe) >> 19) & 1)
 403 #define usb_pipetype(pipe)      (((pipe) >> 30) & 3)
 404 #define usb_pipeisoc(pipe)      (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
 405 #define usb_pipeint(pipe)       (usb_pipetype((pipe)) == PIPE_INTERRUPT)
 406 #define usb_pipecontrol(pipe)   (usb_pipetype((pipe)) == PIPE_CONTROL)
 407 #define usb_pipebulk(pipe)      (usb_pipetype((pipe)) == PIPE_BULK)
 408
 409 #define usb_pipe_ep_index(pipe) \
 410                 usb_pipecontrol(pipe) ? (usb_pipeendpoint(pipe) * 2) : \
 411                                 ((usb_pipeendpoint(pipe) * 2) - \
 412                                  (usb_pipein(pipe) ? 0 : 1))
 413
 414 /**
 415  * struct usb_device_id - identifies USB devices for probing and hotplugging
 416  * @match_flags: Bit mask controlling which of the other fields are used to
 417  *      match against new devices. Any field except for driver_info may be
 418  *      used, although some only make sense in conjunction with other fields.
 419  *      This is usually set by a USB_DEVICE_*() macro, which sets all
 420  *      other fields in this structure except for driver_info.
 421  * @idVendor: USB vendor ID for a device; numbers are assigned
 422  *      by the USB forum to its members.
 423  * @idProduct: Vendor-assigned product ID.
 424  * @bcdDevice_lo: Low end of range of vendor-assigned product version numbers.
 425  *      This is also used to identify individual product versions, for
 426  *      a range consisting of a single device.
 427  * @bcdDevice_hi: High end of version number range.  The range of product
 428  *      versions is inclusive.
 429  * @bDeviceClass: Class of device; numbers are assigned
 430  *      by the USB forum.  Products may choose to implement classes,
 431  *      or be vendor-specific.  Device classes specify behavior of all
 432  *      the interfaces on a device.
 433  * @bDeviceSubClass: Subclass of device; associated with bDeviceClass.
 434  * @bDeviceProtocol: Protocol of device; associated with bDeviceClass.
 435  * @bInterfaceClass: Class of interface; numbers are assigned
 436  *      by the USB forum.  Products may choose to implement classes,
 437  *      or be vendor-specific.  Interface classes specify behavior only
 438  *      of a given interface; other interfaces may support other classes.
 439  * @bInterfaceSubClass: Subclass of interface; associated with bInterfaceClass.
 440  * @bInterfaceProtocol: Protocol of interface; associated with bInterfaceClass.
 441  * @bInterfaceNumber: Number of interface; composite devices may use
 442  *      fixed interface numbers to differentiate between vendor-specific
 443  *      interfaces.
 444  * @driver_info: Holds information used by the driver.  Usually it holds
 445  *      a pointer to a descriptor understood by the driver, or perhaps
 446  *      device flags.
 447  *
 448  * In most cases, drivers will create a table of device IDs by using
 449  * USB_DEVICE(), or similar macros designed for that purpose.
 450  * They will then export it to userspace using MODULE_DEVICE_TABLE(),
 451  * and provide it to the USB core through their usb_driver structure.
 452  *
 453  * See the usb_match_id() function for information about how matches are
 454  * performed.  Briefly, you will normally use one of several macros to help
 455  * construct these entries.  Each entry you provide will either identify
 456  * one or more specific products, or will identify a class of products
 457  * which have agreed to behave the same.  You should put the more specific
 458  * matches towards the beginning of your table, so that driver_info can
 459  * record quirks of specific products.
 460  */
 461 struct usb_device_id {
 462         /* which fields to match against? */
 463         u16 match_flags;
 464
 465         /* Used for product specific matches; range is inclusive */
 466         u16 idVendor;
 467         u16 idProduct;
 468         u16 bcdDevice_lo;
 469         u16 bcdDevice_hi;
 470
 471         /* Used for device class matches */
 472         u8 bDeviceClass;
 473         u8 bDeviceSubClass;
 474         u8 bDeviceProtocol;
 475
 476         /* Used for interface class matches */
 477         u8 bInterfaceClass;
 478         u8 bInterfaceSubClass;
 479         u8 bInterfaceProtocol;
 480
 481         /* Used for vendor-specific interface matches */
 482         u8 bInterfaceNumber;
 483
 484         /* not matched against */
 485         ulong driver_info;
 486 };
 487
 488 /* Some useful macros to use to create struct usb_device_id */
 489 #define USB_DEVICE_ID_MATCH_VENDOR              0x0001
 490 #define USB_DEVICE_ID_MATCH_PRODUCT             0x0002
 491 #define USB_DEVICE_ID_MATCH_DEV_LO              0x0004
 492 #define USB_DEVICE_ID_MATCH_DEV_HI              0x0008
 493 #define USB_DEVICE_ID_MATCH_DEV_CLASS           0x0010
 494 #define USB_DEVICE_ID_MATCH_DEV_SUBCLASS        0x0020
 495 #define USB_DEVICE_ID_MATCH_DEV_PROTOCOL        0x0040
 496 #define USB_DEVICE_ID_MATCH_INT_CLASS           0x0080
 497 #define USB_DEVICE_ID_MATCH_INT_SUBCLASS        0x0100
 498 #define USB_DEVICE_ID_MATCH_INT_PROTOCOL        0x0200
 499 #define USB_DEVICE_ID_MATCH_INT_NUMBER          0x0400
 500
 501 /* Match anything, indicates this is a valid entry even if everything is 0 */
 502 #define USB_DEVICE_ID_MATCH_NONE                0x0800
 503 #define USB_DEVICE_ID_MATCH_ALL                 0x07ff
 504
 505 /**
 506  * struct usb_driver_entry - Matches a driver to its usb_device_ids
 507  * @driver: Driver to use
 508  * @match: List of match records for this driver, terminated by {}
 509  */
 510 struct usb_driver_entry {
 511         struct driver *driver;
 512         const struct usb_device_id *match;
 513 };
 514
 515 #define USB_DEVICE_ID_MATCH_DEVICE \
 516                 (USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT)
 517
 518 /**
 519  * USB_DEVICE - macro used to describe a specific usb device
 520  * @vend: the 16 bit USB Vendor ID
 521  * @prod: the 16 bit USB Product ID
 522  *
 523  * This macro is used to create a struct usb_device_id that matches a
 524  * specific device.
 525  */
 526 #define USB_DEVICE(vend, prod) \
 527         .match_flags = USB_DEVICE_ID_MATCH_DEVICE, \
 528         .idVendor = (vend), \
 529         .idProduct = (prod)
 530
 531 #define U_BOOT_USB_DEVICE(__name, __match) \
 532         ll_entry_declare(struct usb_driver_entry, __name, usb_driver_entry) = {\
 533                 .driver = llsym(struct driver, __name, driver), \
 534                 .match = __match, \
 535                 }
 536
 537 /*************************************************************************
 538  * Hub Stuff
 539  */
 540 struct usb_port_status {
 541         unsigned short wPortStatus;
 542         unsigned short wPortChange;
 543 } __attribute__ ((packed));
 544
 545 struct usb_hub_status {
 546         unsigned short wHubStatus;
 547         unsigned short wHubChange;
 548 } __attribute__ ((packed));
 549
 550 /*
 551  * Hub Device descriptor
 552  * USB Hub class device protocols
 553  */
 554 #define USB_HUB_PR_FS           0 /* Full speed hub */
 555 #define USB_HUB_PR_HS_NO_TT     0 /* Hi-speed hub without TT */
 556 #define USB_HUB_PR_HS_SINGLE_TT 1 /* Hi-speed hub with single TT */
 557 #define USB_HUB_PR_HS_MULTI_TT  2 /* Hi-speed hub with multiple TT */
 558 #define USB_HUB_PR_SS           3 /* Super speed hub */
 559
 560 /* Transaction Translator Think Times, in bits */
 561 #define HUB_TTTT_8_BITS         0x00
 562 #define HUB_TTTT_16_BITS        0x20
 563 #define HUB_TTTT_24_BITS        0x40
 564 #define HUB_TTTT_32_BITS        0x60
 565
 566 /* Hub descriptor */
 567 struct usb_hub_descriptor {
 568         unsigned char  bLength;
 569         unsigned char  bDescriptorType;
 570         unsigned char  bNbrPorts;
 571         unsigned short wHubCharacteristics;
 572         unsigned char  bPwrOn2PwrGood;
 573         unsigned char  bHubContrCurrent;
 574         /* 2.0 and 3.0 hubs differ here */
 575         union {
 576                 struct {
 577                         /* add 1 bit for hub status change; round to bytes */
 578                         __u8 DeviceRemovable[(USB_MAXCHILDREN + 1 + 7) / 8];
 579                         __u8 PortPowerCtrlMask[(USB_MAXCHILDREN + 1 + 7) / 8];
 580                 } __attribute__ ((packed)) hs;
 581
 582                 struct {
 583                         __u8 bHubHdrDecLat;
 584                         __le16 wHubDelay;
 585                         __le16 DeviceRemovable;
 586                 } __attribute__ ((packed)) ss;
 587         } u;
 588 } __attribute__ ((packed));
 589
 590
 591 struct usb_hub_device {
 592         struct usb_device *pusb_dev;
 593         struct usb_hub_descriptor desc;
 594
 595         ulong connect_timeout;          /* Device connection timeout in ms */
 596         ulong query_delay;              /* Device query delay in ms */
 597         int overcurrent_count[USB_MAXCHILDREN]; /* Over-current counter */
 598         int hub_depth;                  /* USB 3.0 hub depth */
 599         struct usb_tt tt;               /* Transaction Translator */
 600 };
 601
 602 #if CONFIG_IS_ENABLED(DM_USB)
 603 /**
 604  * struct usb_plat - Platform data about a USB controller
 605  *
 606  * Given a USB controller (UCLASS_USB) dev this is dev_get_plat(dev)
 607  */
 608 struct usb_plat {
 609         enum usb_init_type init_type;
 610 };
 611
 612 /**
 613  * struct usb_dev_plat - Platform data about a USB device
 614  *
 615  * Given a USB device dev this structure is dev_get_parent_plat(dev).
 616  * This is used by sandbox to provide emulation data also.
 617  *
 618  * @id:         ID used to match this device
 619  * @devnum:     Device address on the USB bus
 620  * @udev:       usb-uclass internal use only do NOT use
 621  * @strings:    List of descriptor strings (for sandbox emulation purposes)
 622  * @desc_list:  List of descriptors (for sandbox emulation purposes)
 623  */
 624 struct usb_dev_plat {
 625         struct usb_device_id id;
 626         int devnum;
 627         /*
 628          * This pointer is used to pass the usb_device used in usb_scan_device,
 629          * to get the usb descriptors before the driver is known, to the
 630          * actual udevice once the driver is known and the udevice is created.
 631          * This will be NULL except during probe, do NOT use.
 632          *
 633          * This should eventually go away.
 634          */
 635         struct usb_device *udev;
 636 #ifdef CONFIG_SANDBOX
 637         struct usb_string *strings;
 638         /* NULL-terminated list of descriptor pointers */
 639         struct usb_generic_descriptor **desc_list;
 640 #endif
 641         int configno;
 642 };
 643
 644 /**
 645  * struct usb_bus_priv - information about the USB controller
 646  *
 647  * Given a USB controller (UCLASS_USB) 'dev', this is
 648  * dev_get_uclass_priv(dev).
 649  *
 650  * @next_addr:  Next device address to allocate minus 1. Incremented by 1
 651  *              each time a new device address is set, so this holds the
 652  *              number of devices on the bus
 653  * @desc_before_addr:   true if we can read a device descriptor before it
 654  *              has been assigned an address. For XHCI this is not possible
 655  *              so this will be false.
 656  * @companion:  True if this is a companion controller to another USB
 657  *              controller
 658  */
 659 struct usb_bus_priv {
 660         int next_addr;
 661         bool desc_before_addr;
 662         bool companion;
 663 };
 664
 665 /**
 666  * struct usb_emul_plat - platform data about the USB emulator
 667  *
 668  * Given a USB emulator (UCLASS_USB_EMUL) 'dev', this is
 669  * dev_get_uclass_plat(dev).
 670  *
 671  * @port1:      USB emulator device port number on the parent hub
 672  */
 673 struct usb_emul_plat {
 674         int port1;      /* Port number (numbered from 1) */
 675 };
 676
 677 /**
 678  * struct dm_usb_ops - USB controller operations
 679  *
 680  * This defines the operations supoorted on a USB controller. Common
 681  * arguments are:
 682  *
 683  * @bus:        USB bus (i.e. controller), which is in UCLASS_USB.
 684  * @udev:       USB device parent data. Controllers are not expected to need
 685  *              this, since the device address on the bus is encoded in @pipe.
 686  *              It is used for sandbox, and can be handy for debugging and
 687  *              logging.
 688  * @pipe:       An assortment of bitfields which provide address and packet
 689  *              type information. See create_pipe() above for encoding
 690  *              details
 691  * @buffer:     A buffer to use for sending/receiving. This should be
 692  *              DMA-aligned.
 693  * @length:     Buffer length in bytes
 694  */
 695 struct dm_usb_ops {
 696         /**
 697          * control() - Send a control message
 698          *
 699          * Most parameters are as above.
 700          *
 701          * @setup: Additional setup information required by the message
 702          */
 703         int (*control)(struct udevice *bus, struct usb_device *udev,
 704                        unsigned long pipe, void *buffer, int length,
 705                        struct devrequest *setup);
 706         /**
 707          * bulk() - Send a bulk message
 708          *
 709          * Parameters are as above.
 710          */
 711         int (*bulk)(struct udevice *bus, struct usb_device *udev,
 712                     unsigned long pipe, void *buffer, int length);
 713         /**
 714          * interrupt() - Send an interrupt message
 715          *
 716          * Most parameters are as above.
 717          *
 718          * @interval: Interrupt interval
 719          */
 720         int (*interrupt)(struct udevice *bus, struct usb_device *udev,
 721                          unsigned long pipe, void *buffer, int length,
 722                          int interval, bool nonblock);
 723
 724         /**
 725          * create_int_queue() - Create and queue interrupt packets
 726          *
 727          * Create and queue @queuesize number of interrupt usb packets of
 728          * @elementsize bytes each. @buffer must be atleast @queuesize *
 729          * @elementsize bytes.
 730          *
 731          * Note some controllers only support a queuesize of 1.
 732          *
 733          * @interval: Interrupt interval
 734          *
 735          * @return A pointer to the created interrupt queue or NULL on error
 736          */
 737         struct int_queue * (*create_int_queue)(struct udevice *bus,
 738                                 struct usb_device *udev, unsigned long pipe,
 739                                 int queuesize, int elementsize, void *buffer,
 740                                 int interval);
 741
 742         /**
 743          * poll_int_queue() - Poll an interrupt queue for completed packets
 744          *
 745          * Poll an interrupt queue for completed packets. The return value
 746          * points to the part of the buffer passed to create_int_queue()
 747          * corresponding to the completed packet.
 748          *
 749          * @queue: queue to poll
 750          *
 751          * @return Pointer to the data of the first completed packet, or
 752          *         NULL if no packets are ready
 753          */
 754         void * (*poll_int_queue)(struct udevice *bus, struct usb_device *udev,
 755                                  struct int_queue *queue);
 756
 757         /**
 758          * destroy_int_queue() - Destroy an interrupt queue
 759          *
 760          * Destroy an interrupt queue created by create_int_queue().
 761          *
 762          * @queue: queue to poll
 763          *
 764          * @return 0 if OK, -ve on error
 765          */
 766         int (*destroy_int_queue)(struct udevice *bus, struct usb_device *udev,
 767                                  struct int_queue *queue);
 768
 769         /**
 770          * alloc_device() - Allocate a new device context (XHCI)
 771          *
 772          * Before sending packets to a new device on an XHCI bus, a device
 773          * context must be created. If this method is not NULL it will be
 774          * called before the device is enumerated (even before its descriptor
 775          * is read). This should be NULL for EHCI, which does not need this.
 776          */
 777         int (*alloc_device)(struct udevice *bus, struct usb_device *udev);
 778
 779         /**
 780          * reset_root_port() - Reset usb root port
 781          */
 782         int (*reset_root_port)(struct udevice *bus, struct usb_device *udev);
 783
 784         /**
 785          * update_hub_device() - Update HCD's internal representation of hub
 786          *
 787          * After a hub descriptor is fetched, notify HCD so that its internal
 788          * representation of this hub can be updated (xHCI)
 789          */
 790         int (*update_hub_device)(struct udevice *bus, struct usb_device *udev);
 791
 792         /**
 793          * get_max_xfer_size() - Get HCD's maximum transfer bytes
 794          *
 795          * The HCD may have limitation on the maximum bytes to be transferred
 796          * in a USB transfer. USB class driver needs to be aware of this.
 797          */
 798         int (*get_max_xfer_size)(struct udevice *bus, size_t *size);
 799
 800         /**
 801          * lock_async() - Keep async schedule after a transfer
 802          *
 803          * It may be desired to keep the asynchronous schedule running even
 804          * after a transfer finishes, usually when doing multiple transfers
 805          * back-to-back. This callback allows signalling the USB controller
 806          * driver to do just that.
 807          */
 808         int (*lock_async)(struct udevice *udev, int lock);
 809 };
 810
 811 #define usb_get_ops(dev)        ((struct dm_usb_ops *)(dev)->driver->ops)
 812 #define usb_get_emul_ops(dev)   ((struct dm_usb_ops *)(dev)->driver->ops)
 813
 814 /**
 815  * usb_setup_device() - set up a device ready for use
 816  *
 817  * @dev:        USB device pointer. This need not be a real device - it is
 818  *              common for it to just be a local variable with its ->dev
 819  *              member (i.e. @dev->dev) set to the parent device and
 820  *              dev->portnr set to the port number on the hub (1=first)
 821  * @do_read:    true to read the device descriptor before an address is set
 822  *              (should be false for XHCI buses, true otherwise)
 823  * @parent:     Parent device (either UCLASS_USB or UCLASS_USB_HUB)
 824  * Return: 0 if OK, -ve on error */
 825 int usb_setup_device(struct usb_device *dev, bool do_read,
 826                      struct usb_device *parent);
 827
 828 /**
 829  * usb_hub_is_root_hub() - Test whether a hub device is root hub or not
 830  *
 831  * @hub:        USB hub device to test
 832  * @return:     true if the hub device is root hub, false otherwise.
 833  */
 834 bool usb_hub_is_root_hub(struct udevice *hub);
 835
 836 /**
 837  * usb_hub_scan() - Scan a hub and find its devices
 838  *
 839  * @hub:        Hub device to scan
 840  */
 841 int usb_hub_scan(struct udevice *hub);
 842
 843 /**
 844  * usb_scan_device() - Scan a device on a bus
 845  *
 846  * Scan a device on a bus. It has already been detected and is ready to
 847  * be enumerated. This may be either the root hub (@parent is a bus) or a
 848  * normal device (@parent is a hub)
 849  *
 850  * @parent:     Parent device
 851  * @port:       Hub port number (numbered from 1)
 852  * @speed:      USB speed to use for this device
 853  * @devp:       Returns pointer to device if all is well
 854  * Return: 0 if OK, -ve on error
 855  */
 856 int usb_scan_device(struct udevice *parent, int port,
 857                     enum usb_device_speed speed, struct udevice **devp);
 858
 859 /**
 860  * usb_get_bus() - Find the bus for a device
 861  *
 862  * Search up through parents to find the bus this device is connected to. This
 863  * will be a device with uclass UCLASS_USB.
 864  *
 865  * @dev:        Device to check
 866  * Return: The bus, or NULL if not found (this indicates a critical error in
 867  *      the USB stack
 868  */
 869 struct udevice *usb_get_bus(struct udevice *dev);
 870
 871 /**
 872  * usb_select_config() - Set up a device ready for use
 873  *
 874  * This function assumes that the device already has an address and a driver
 875  * bound, and is ready to be set up.
 876  *
 877  * This re-reads the device and configuration descriptors and sets the
 878  * configuration
 879  *
 880  * @dev:        Device to set up
 881  */
 882 int usb_select_config(struct usb_device *dev);
 883
 884 /**
 885  * usb_child_pre_probe() - Pre-probe function for USB devices
 886  *
 887  * This is called on all children of hubs and USB controllers (i.e. UCLASS_USB
 888  * and UCLASS_USB_HUB) when a new device is about to be probed. It sets up the
 889  * device from the saved platform data and calls usb_select_config() to
 890  * finish set up.
 891  *
 892  * Once this is done, the device's normal driver can take over, knowing the
 893  * device is accessible on the USB bus.
 894  *
 895  * This function is for use only by the internal USB stack.
 896  *
 897  * @dev:        Device to set up
 898  */
 899 int usb_child_pre_probe(struct udevice *dev);
 900
 901 struct ehci_ctrl;
 902
 903 /**
 904  * usb_setup_ehci_gadget() - Set up a USB device as a gadget
 905  *
 906  * TODO(sjg@chromium.org): Tidy this up when USB gadgets can use driver model
 907  *
 908  * This provides a way to tell a controller to start up as a USB device
 909  * instead of as a host. It is untested.
 910  */
 911 int usb_setup_ehci_gadget(struct ehci_ctrl **ctlrp);
 912
 913 /**
 914  * usb_remove_ehci_gadget() - Remove a gadget USB device
 915  *
 916  * TODO(sjg@chromium.org): Tidy this up when USB gadgets can use driver model
 917  *
 918  * This provides a way to tell a controller to remove a USB device
 919  */
 920 int usb_remove_ehci_gadget(struct ehci_ctrl **ctlrp);
 921
 922 /**
 923  * usb_stor_reset() - Prepare to scan USB storage devices
 924  *
 925  * Empty the list of USB storage devices in preparation for scanning them.
 926  * This must be called before a USB scan.
 927  */
 928 void usb_stor_reset(void);
 929
 930 #else /* !CONFIG_IS_ENABLED(DM_USB) */
 931
 932 struct usb_device *usb_get_dev_index(int index);
 933
 934 #endif
 935
 936 bool usb_device_has_child_on_port(struct usb_device *parent, int port);
 937
 938 int usb_hub_probe(struct usb_device *dev, int ifnum);
 939 void usb_hub_reset(void);
 940
 941 /*
 942  * usb_find_usb2_hub_address_port() - Get hub address and port for TT setting
 943  *
 944  * Searches for the first HS hub above the given device. If a
 945  * HS hub is found, the hub address and the port the device is
 946  * connected to is return, as required for SPLIT transactions
 947  *
 948  * @param: udev full speed or low speed device
 949  */
 950 void usb_find_usb2_hub_address_port(struct usb_device *udev,
 951                                     uint8_t *hub_address, uint8_t *hub_port);
 952
 953 /**
 954  * usb_alloc_new_device() - Allocate a new device
 955  *
 956  * @devp: returns a pointer of a new device structure. With driver model this
 957  *              is a device pointer, but with legacy USB this pointer is
 958  *              driver-specific.
 959  * Return: 0 if OK, -ENOSPC if we have found out of room for new devices
 960  */
 961 int usb_alloc_new_device(struct udevice *controller, struct usb_device **devp);
 962
 963 /**
 964  * usb_free_device() - Free a partially-inited device
 965  *
 966  * This is an internal function. It is used to reverse the action of
 967  * usb_alloc_new_device() when we hit a problem during init.
 968  */
 969 void usb_free_device(struct udevice *controller);
 970
 971 int usb_new_device(struct usb_device *dev);
 972
 973 int usb_alloc_device(struct usb_device *dev);
 974
 975 /**
 976  * usb_update_hub_device() - Update HCD's internal representation of hub
 977  *
 978  * After a hub descriptor is fetched, notify HCD so that its internal
 979  * representation of this hub can be updated.
 980  *
 981  * @dev:                Hub device
 982  * Return: 0 if OK, -ve on error
 983  */
 984 int usb_update_hub_device(struct usb_device *dev);
 985
 986 /**
 987  * usb_get_max_xfer_size() - Get HCD's maximum transfer bytes
 988  *
 989  * The HCD may have limitation on the maximum bytes to be transferred
 990  * in a USB transfer. USB class driver needs to be aware of this.
 991  *
 992  * @dev:                USB device
 993  * @size:               maximum transfer bytes
 994  * Return: 0 if OK, -ve on error
 995  */
 996 int usb_get_max_xfer_size(struct usb_device *dev, size_t *size);
 997
 998 /**
 999  * usb_emul_setup_device() - Set up a new USB device emulation
1000  *
1001  * This is normally called when a new emulation device is bound. It tells
1002  * the USB emulation uclass about the features of the emulator.
1003  *
1004  * @dev:                Emulation device
1005  * @strings:            List of USB string descriptors, terminated by a NULL
1006  *                      entry
1007  * @desc_list:          List of points or USB descriptors, terminated by NULL.
1008  *                      The first entry must be struct usb_device_descriptor,
1009  *                      and others follow on after that.
1010  * Return: 0 if OK, -ENOSYS if not implemented, other -ve on error
1011  */
1012 int usb_emul_setup_device(struct udevice *dev, struct usb_string *strings,
1013                           void **desc_list);
1014
1015 /**
1016  * usb_emul_control() - Send a control packet to an emulator
1017  *
1018  * @emul:       Emulator device
1019  * @udev:       USB device (which the emulator is causing to appear)
1020  * See struct dm_usb_ops for details on other parameters
1021  * Return: 0 if OK, -ve on error
1022  */
1023 int usb_emul_control(struct udevice *emul, struct usb_device *udev,
1024                      unsigned long pipe, void *buffer, int length,
1025                      struct devrequest *setup);
1026
1027 /**
1028  * usb_emul_bulk() - Send a bulk packet to an emulator
1029  *
1030  * @emul:       Emulator device
1031  * @udev:       USB device (which the emulator is causing to appear)
1032  * See struct dm_usb_ops for details on other parameters
1033  * Return: 0 if OK, -ve on error
1034  */
1035 int usb_emul_bulk(struct udevice *emul, struct usb_device *udev,
1036                   unsigned long pipe, void *buffer, int length);
1037
1038 /**
1039  * usb_emul_int() - Send an interrupt packet to an emulator
1040  *
1041  * @emul:       Emulator device
1042  * @udev:       USB device (which the emulator is causing to appear)
1043  * See struct dm_usb_ops for details on other parameters
1044  * Return: 0 if OK, -ve on error
1045  */
1046 int usb_emul_int(struct udevice *emul, struct usb_device *udev,
1047                   unsigned long pipe, void *buffer, int length, int interval,
1048                   bool nonblock);
1049
1050 /**
1051  * usb_emul_find() - Find an emulator for a particular device
1052  *
1053  * Check @pipe and @port1 to find a device number on bus @bus and return it.
1054  *
1055  * @bus:        USB bus (controller)
1056  * @pipe:       Describes pipe being used, and includes the device number
1057  * @port1:      Describes port number on the parent hub
1058  * @emulp:      Returns pointer to emulator, or NULL if not found
1059  * Return: 0 if found, -ve on error
1060  */
1061 int usb_emul_find(struct udevice *bus, ulong pipe, int port1,
1062                   struct udevice **emulp);
1063
1064 /**
1065  * usb_emul_find_for_dev() - Find an emulator for a particular device
1066  *
1067  * @dev:        USB device to check
1068  * @emulp:      Returns pointer to emulator, or NULL if not found
1069  * Return: 0 if found, -ve on error
1070  */
1071 int usb_emul_find_for_dev(struct udevice *dev, struct udevice **emulp);
1072
1073 /**
1074  * usb_emul_find_descriptor() - Find a USB descriptor of a particular device
1075  *
1076  * @ptr:        a pointer to a list of USB descriptor pointers
1077  * @type:       type of USB descriptor to find
1078  * @index:      if @type is USB_DT_CONFIG, this is the configuration value
1079  * Return: a pointer to the USB descriptor found, NULL if not found
1080  */
1081 struct usb_generic_descriptor **usb_emul_find_descriptor(
1082                 struct usb_generic_descriptor **ptr, int type, int index);
1083
1084 /**
1085  * usb_show_tree() - show the USB device tree
1086  *
1087  * This shows a list of active USB devices along with basic information about
1088  * each.
1089  */
1090 void usb_show_tree(void);
1091
1092 #endif /*_USB_H_ */