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
 261 /*
 262  * usb_init() - initialize the USB Controllers
 263  *
 264  * Returns: 0 if OK, -ENOENT if there are no USB devices
 265  */
 266 int usb_init(void);
 267
 268 int usb_stop(void); /* stop the USB Controller */
 269 int usb_detect_change(void); /* detect if a USB device has been (un)plugged */
 270
 271
 272 int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol);
 273 int usb_set_idle(struct usb_device *dev, int ifnum, int duration,
 274                         int report_id);
 275 int usb_control_msg(struct usb_device *dev, unsigned int pipe,
 276                         unsigned char request, unsigned char requesttype,
 277                         unsigned short value, unsigned short index,
 278                         void *data, unsigned short size, int timeout);
 279 int usb_bulk_msg(struct usb_device *dev, unsigned int pipe,
 280                         void *data, int len, int *actual_length, int timeout);
 281 int usb_int_msg(struct usb_device *dev, unsigned long pipe,
 282                 void *buffer, int transfer_len, int interval, bool nonblock);
 283 int usb_lock_async(struct usb_device *dev, int lock);
 284 int usb_disable_asynch(int disable);
 285 int usb_maxpacket(struct usb_device *dev, unsigned long pipe);
 286 int usb_get_configuration_no(struct usb_device *dev, int cfgno,
 287                         unsigned char *buffer, int length);
 288 int usb_get_configuration_len(struct usb_device *dev, int cfgno);
 289 int usb_get_report(struct usb_device *dev, int ifnum, unsigned char type,
 290                         unsigned char id, void *buf, int size);
 291 int usb_get_class_descriptor(struct usb_device *dev, int ifnum,
 292                         unsigned char type, unsigned char id, void *buf,
 293                         int size);
 294 int usb_clear_halt(struct usb_device *dev, int pipe);
 295 int usb_string(struct usb_device *dev, int index, char *buf, size_t size);
 296 int usb_set_interface(struct usb_device *dev, int interface, int alternate);
 297 int usb_get_port_status(struct usb_device *dev, int port, void *data);
 298
 299 /* big endian -> little endian conversion */
 300 /* some CPUs are already little endian e.g. the ARM920T */
 301 #define __swap_16(x) \
 302         ({ unsigned short x_ = (unsigned short)x; \
 303          (unsigned short)( \
 304                 ((x_ & 0x00FFU) << 8) | ((x_ & 0xFF00U) >> 8)); \
 305         })
 306 #define __swap_32(x) \
 307         ({ unsigned long x_ = (unsigned long)x; \
 308          (unsigned long)( \
 309                 ((x_ & 0x000000FFUL) << 24) | \
 310                 ((x_ & 0x0000FF00UL) <<  8) | \
 311                 ((x_ & 0x00FF0000UL) >>  8) | \
 312                 ((x_ & 0xFF000000UL) >> 24)); \
 313         })
 314
 315 #ifdef __LITTLE_ENDIAN
 316 # define swap_16(x) (x)
 317 # define swap_32(x) (x)
 318 #else
 319 # define swap_16(x) __swap_16(x)
 320 # define swap_32(x) __swap_32(x)
 321 #endif
 322
 323 /*
 324  * Calling this entity a "pipe" is glorifying it. A USB pipe
 325  * is something embarrassingly simple: it basically consists
 326  * of the following information:
 327  *  - device number (7 bits)
 328  *  - endpoint number (4 bits)
 329  *  - current Data0/1 state (1 bit)
 330  *  - direction (1 bit)
 331  *  - speed (2 bits)
 332  *  - max packet size (2 bits: 8, 16, 32 or 64)
 333  *  - pipe type (2 bits: control, interrupt, bulk, isochronous)
 334  *
 335  * That's 18 bits. Really. Nothing more. And the USB people have
 336  * documented these eighteen bits as some kind of glorious
 337  * virtual data structure.
 338  *
 339  * Let's not fall in that trap. We'll just encode it as a simple
 340  * unsigned int. The encoding is:
 341  *
 342  *  - max size:         bits 0-1        (00 = 8, 01 = 16, 10 = 32, 11 = 64)
 343  *  - direction:        bit 7           (0 = Host-to-Device [Out],
 344  *                                      (1 = Device-to-Host [In])
 345  *  - device:           bits 8-14
 346  *  - endpoint:         bits 15-18
 347  *  - Data0/1:          bit 19
 348  *  - pipe type:        bits 30-31      (00 = isochronous, 01 = interrupt,
 349  *                                       10 = control, 11 = bulk)
 350  *
 351  * Why? Because it's arbitrary, and whatever encoding we select is really
 352  * up to us. This one happens to share a lot of bit positions with the UHCI
 353  * specification, so that much of the uhci driver can just mask the bits
 354  * appropriately.
 355  */
 356 /* Create various pipes... */
 357 #define create_pipe(dev,endpoint) \
 358                 (((dev)->devnum << 8) | ((endpoint) << 15) | \
 359                 (dev)->maxpacketsize)
 360 #define default_pipe(dev) ((dev)->speed << 26)
 361
 362 #define usb_sndctrlpipe(dev, endpoint)  ((PIPE_CONTROL << 30) | \
 363                                          create_pipe(dev, endpoint))
 364 #define usb_rcvctrlpipe(dev, endpoint)  ((PIPE_CONTROL << 30) | \
 365                                          create_pipe(dev, endpoint) | \
 366                                          USB_DIR_IN)
 367 #define usb_sndisocpipe(dev, endpoint)  ((PIPE_ISOCHRONOUS << 30) | \
 368                                          create_pipe(dev, endpoint))
 369 #define usb_rcvisocpipe(dev, endpoint)  ((PIPE_ISOCHRONOUS << 30) | \
 370                                          create_pipe(dev, endpoint) | \
 371                                          USB_DIR_IN)
 372 #define usb_sndbulkpipe(dev, endpoint)  ((PIPE_BULK << 30) | \
 373                                          create_pipe(dev, endpoint))
 374 #define usb_rcvbulkpipe(dev, endpoint)  ((PIPE_BULK << 30) | \
 375                                          create_pipe(dev, endpoint) | \
 376                                          USB_DIR_IN)
 377 #define usb_sndintpipe(dev, endpoint)   ((PIPE_INTERRUPT << 30) | \
 378                                          create_pipe(dev, endpoint))
 379 #define usb_rcvintpipe(dev, endpoint)   ((PIPE_INTERRUPT << 30) | \
 380                                          create_pipe(dev, endpoint) | \
 381                                          USB_DIR_IN)
 382 #define usb_snddefctrl(dev)             ((PIPE_CONTROL << 30) | \
 383                                          default_pipe(dev))
 384 #define usb_rcvdefctrl(dev)             ((PIPE_CONTROL << 30) | \
 385                                          default_pipe(dev) | \
 386                                          USB_DIR_IN)
 387
 388 /* The D0/D1 toggle bits */
 389 #define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> ep) & 1)
 390 #define usb_dotoggle(dev, ep, out)  ((dev)->toggle[out] ^= (1 << ep))
 391 #define usb_settoggle(dev, ep, out, bit) ((dev)->toggle[out] = \
 392                                                 ((dev)->toggle[out] & \
 393                                                  ~(1 << ep)) | ((bit) << ep))
 394
 395 /* Endpoint halt control/status */
 396 #define usb_endpoint_out(ep_dir)        (((ep_dir >> 7) & 1) ^ 1)
 397 #define usb_endpoint_halt(dev, ep, out) ((dev)->halted[out] |= (1 << (ep)))
 398 #define usb_endpoint_running(dev, ep, out) ((dev)->halted[out] &= ~(1 << (ep)))
 399 #define usb_endpoint_halted(dev, ep, out) ((dev)->halted[out] & (1 << (ep)))
 400
 401 #define usb_packetid(pipe)      (((pipe) & USB_DIR_IN) ? USB_PID_IN : \
 402                                  USB_PID_OUT)
 403
 404 #define usb_pipeout(pipe)       ((((pipe) >> 7) & 1) ^ 1)
 405 #define usb_pipein(pipe)        (((pipe) >> 7) & 1)
 406 #define usb_pipedevice(pipe)    (((pipe) >> 8) & 0x7f)
 407 #define usb_pipe_endpdev(pipe)  (((pipe) >> 8) & 0x7ff)
 408 #define usb_pipeendpoint(pipe)  (((pipe) >> 15) & 0xf)
 409 #define usb_pipedata(pipe)      (((pipe) >> 19) & 1)
 410 #define usb_pipetype(pipe)      (((pipe) >> 30) & 3)
 411 #define usb_pipeisoc(pipe)      (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
 412 #define usb_pipeint(pipe)       (usb_pipetype((pipe)) == PIPE_INTERRUPT)
 413 #define usb_pipecontrol(pipe)   (usb_pipetype((pipe)) == PIPE_CONTROL)
 414 #define usb_pipebulk(pipe)      (usb_pipetype((pipe)) == PIPE_BULK)
 415
 416 #define usb_pipe_ep_index(pipe) \
 417                 usb_pipecontrol(pipe) ? (usb_pipeendpoint(pipe) * 2) : \
 418                                 ((usb_pipeendpoint(pipe) * 2) - \
 419                                  (usb_pipein(pipe) ? 0 : 1))
 420
 421 /**
 422  * struct usb_device_id - identifies USB devices for probing and hotplugging
 423  * @match_flags: Bit mask controlling which of the other fields are used to
 424  *      match against new devices. Any field except for driver_info may be
 425  *      used, although some only make sense in conjunction with other fields.
 426  *      This is usually set by a USB_DEVICE_*() macro, which sets all
 427  *      other fields in this structure except for driver_info.
 428  * @idVendor: USB vendor ID for a device; numbers are assigned
 429  *      by the USB forum to its members.
 430  * @idProduct: Vendor-assigned product ID.
 431  * @bcdDevice_lo: Low end of range of vendor-assigned product version numbers.
 432  *      This is also used to identify individual product versions, for
 433  *      a range consisting of a single device.
 434  * @bcdDevice_hi: High end of version number range.  The range of product
 435  *      versions is inclusive.
 436  * @bDeviceClass: Class of device; numbers are assigned
 437  *      by the USB forum.  Products may choose to implement classes,
 438  *      or be vendor-specific.  Device classes specify behavior of all
 439  *      the interfaces on a device.
 440  * @bDeviceSubClass: Subclass of device; associated with bDeviceClass.
 441  * @bDeviceProtocol: Protocol of device; associated with bDeviceClass.
 442  * @bInterfaceClass: Class of interface; numbers are assigned
 443  *      by the USB forum.  Products may choose to implement classes,
 444  *      or be vendor-specific.  Interface classes specify behavior only
 445  *      of a given interface; other interfaces may support other classes.
 446  * @bInterfaceSubClass: Subclass of interface; associated with bInterfaceClass.
 447  * @bInterfaceProtocol: Protocol of interface; associated with bInterfaceClass.
 448  * @bInterfaceNumber: Number of interface; composite devices may use
 449  *      fixed interface numbers to differentiate between vendor-specific
 450  *      interfaces.
 451  * @driver_info: Holds information used by the driver.  Usually it holds
 452  *      a pointer to a descriptor understood by the driver, or perhaps
 453  *      device flags.
 454  *
 455  * In most cases, drivers will create a table of device IDs by using
 456  * USB_DEVICE(), or similar macros designed for that purpose.
 457  * They will then export it to userspace using MODULE_DEVICE_TABLE(),
 458  * and provide it to the USB core through their usb_driver structure.
 459  *
 460  * See the usb_match_id() function for information about how matches are
 461  * performed.  Briefly, you will normally use one of several macros to help
 462  * construct these entries.  Each entry you provide will either identify
 463  * one or more specific products, or will identify a class of products
 464  * which have agreed to behave the same.  You should put the more specific
 465  * matches towards the beginning of your table, so that driver_info can
 466  * record quirks of specific products.
 467  */
 468 struct usb_device_id {
 469         /* which fields to match against? */
 470         u16 match_flags;
 471
 472         /* Used for product specific matches; range is inclusive */
 473         u16 idVendor;
 474         u16 idProduct;
 475         u16 bcdDevice_lo;
 476         u16 bcdDevice_hi;
 477
 478         /* Used for device class matches */
 479         u8 bDeviceClass;
 480         u8 bDeviceSubClass;
 481         u8 bDeviceProtocol;
 482
 483         /* Used for interface class matches */
 484         u8 bInterfaceClass;
 485         u8 bInterfaceSubClass;
 486         u8 bInterfaceProtocol;
 487
 488         /* Used for vendor-specific interface matches */
 489         u8 bInterfaceNumber;
 490
 491         /* not matched against */
 492         ulong driver_info;
 493 };
 494
 495 /* Some useful macros to use to create struct usb_device_id */
 496 #define USB_DEVICE_ID_MATCH_VENDOR              0x0001
 497 #define USB_DEVICE_ID_MATCH_PRODUCT             0x0002
 498 #define USB_DEVICE_ID_MATCH_DEV_LO              0x0004
 499 #define USB_DEVICE_ID_MATCH_DEV_HI              0x0008
 500 #define USB_DEVICE_ID_MATCH_DEV_CLASS           0x0010
 501 #define USB_DEVICE_ID_MATCH_DEV_SUBCLASS        0x0020
 502 #define USB_DEVICE_ID_MATCH_DEV_PROTOCOL        0x0040
 503 #define USB_DEVICE_ID_MATCH_INT_CLASS           0x0080
 504 #define USB_DEVICE_ID_MATCH_INT_SUBCLASS        0x0100
 505 #define USB_DEVICE_ID_MATCH_INT_PROTOCOL        0x0200
 506 #define USB_DEVICE_ID_MATCH_INT_NUMBER          0x0400
 507
 508 /* Match anything, indicates this is a valid entry even if everything is 0 */
 509 #define USB_DEVICE_ID_MATCH_NONE                0x0800
 510 #define USB_DEVICE_ID_MATCH_ALL                 0x07ff
 511
 512 /**
 513  * struct usb_driver_entry - Matches a driver to its usb_device_ids
 514  * @driver: Driver to use
 515  * @match: List of match records for this driver, terminated by {}
 516  */
 517 struct usb_driver_entry {
 518         struct driver *driver;
 519         const struct usb_device_id *match;
 520 };
 521
 522 #define USB_DEVICE_ID_MATCH_DEVICE \
 523                 (USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT)
 524
 525 /**
 526  * USB_DEVICE - macro used to describe a specific usb device
 527  * @vend: the 16 bit USB Vendor ID
 528  * @prod: the 16 bit USB Product ID
 529  *
 530  * This macro is used to create a struct usb_device_id that matches a
 531  * specific device.
 532  */
 533 #define USB_DEVICE(vend, prod) \
 534         .match_flags = USB_DEVICE_ID_MATCH_DEVICE, \
 535         .idVendor = (vend), \
 536         .idProduct = (prod)
 537
 538 #define U_BOOT_USB_DEVICE(__name, __match) \
 539         ll_entry_declare(struct usb_driver_entry, __name, usb_driver_entry) = {\
 540                 .driver = llsym(struct driver, __name, driver), \
 541                 .match = __match, \
 542                 }
 543
 544 /*************************************************************************
 545  * Hub Stuff
 546  */
 547 struct usb_port_status {
 548         unsigned short wPortStatus;
 549         unsigned short wPortChange;
 550 } __attribute__ ((packed));
 551
 552 struct usb_hub_status {
 553         unsigned short wHubStatus;
 554         unsigned short wHubChange;
 555 } __attribute__ ((packed));
 556
 557 /*
 558  * Hub Device descriptor
 559  * USB Hub class device protocols
 560  */
 561 #define USB_HUB_PR_FS           0 /* Full speed hub */
 562 #define USB_HUB_PR_HS_NO_TT     0 /* Hi-speed hub without TT */
 563 #define USB_HUB_PR_HS_SINGLE_TT 1 /* Hi-speed hub with single TT */
 564 #define USB_HUB_PR_HS_MULTI_TT  2 /* Hi-speed hub with multiple TT */
 565 #define USB_HUB_PR_SS           3 /* Super speed hub */
 566
 567 /* Transaction Translator Think Times, in bits */
 568 #define HUB_TTTT_8_BITS         0x00
 569 #define HUB_TTTT_16_BITS        0x20
 570 #define HUB_TTTT_24_BITS        0x40
 571 #define HUB_TTTT_32_BITS        0x60
 572
 573 /* Hub descriptor */
 574 struct usb_hub_descriptor {
 575         unsigned char  bLength;
 576         unsigned char  bDescriptorType;
 577         unsigned char  bNbrPorts;
 578         unsigned short wHubCharacteristics;
 579         unsigned char  bPwrOn2PwrGood;
 580         unsigned char  bHubContrCurrent;
 581         /* 2.0 and 3.0 hubs differ here */
 582         union {
 583                 struct {
 584                         /* add 1 bit for hub status change; round to bytes */
 585                         __u8 DeviceRemovable[(USB_MAXCHILDREN + 1 + 7) / 8];
 586                         __u8 PortPowerCtrlMask[(USB_MAXCHILDREN + 1 + 7) / 8];
 587                 } __attribute__ ((packed)) hs;
 588
 589                 struct {
 590                         __u8 bHubHdrDecLat;
 591                         __le16 wHubDelay;
 592                         __le16 DeviceRemovable;
 593                 } __attribute__ ((packed)) ss;
 594         } u;
 595 } __attribute__ ((packed));
 596
 597
 598 struct usb_hub_device {
 599         struct usb_device *pusb_dev;
 600         struct usb_hub_descriptor desc;
 601
 602         ulong connect_timeout;          /* Device connection timeout in ms */
 603         ulong query_delay;              /* Device query delay in ms */
 604         int overcurrent_count[USB_MAXCHILDREN]; /* Over-current counter */
 605         int hub_depth;                  /* USB 3.0 hub depth */
 606         struct usb_tt tt;               /* Transaction Translator */
 607 };
 608
 609 #if CONFIG_IS_ENABLED(DM_USB)
 610 /**
 611  * struct usb_plat - Platform data about a USB controller
 612  *
 613  * Given a USB controller (UCLASS_USB) dev this is dev_get_plat(dev)
 614  */
 615 struct usb_plat {
 616         enum usb_init_type init_type;
 617 };
 618
 619 /**
 620  * struct usb_dev_plat - Platform data about a USB device
 621  *
 622  * Given a USB device dev this structure is dev_get_parent_plat(dev).
 623  * This is used by sandbox to provide emulation data also.
 624  *
 625  * @id:         ID used to match this device
 626  * @devnum:     Device address on the USB bus
 627  * @udev:       usb-uclass internal use only do NOT use
 628  * @strings:    List of descriptor strings (for sandbox emulation purposes)
 629  * @desc_list:  List of descriptors (for sandbox emulation purposes)
 630  */
 631 struct usb_dev_plat {
 632         struct usb_device_id id;
 633         int devnum;
 634         /*
 635          * This pointer is used to pass the usb_device used in usb_scan_device,
 636          * to get the usb descriptors before the driver is known, to the
 637          * actual udevice once the driver is known and the udevice is created.
 638          * This will be NULL except during probe, do NOT use.
 639          *
 640          * This should eventually go away.
 641          */
 642         struct usb_device *udev;
 643 #ifdef CONFIG_SANDBOX
 644         struct usb_string *strings;
 645         /* NULL-terminated list of descriptor pointers */
 646         struct usb_generic_descriptor **desc_list;
 647 #endif
 648         int configno;
 649 };
 650
 651 /**
 652  * struct usb_bus_priv - information about the USB controller
 653  *
 654  * Given a USB controller (UCLASS_USB) 'dev', this is
 655  * dev_get_uclass_priv(dev).
 656  *
 657  * @next_addr:  Next device address to allocate minus 1. Incremented by 1
 658  *              each time a new device address is set, so this holds the
 659  *              number of devices on the bus
 660  * @desc_before_addr:   true if we can read a device descriptor before it
 661  *              has been assigned an address. For XHCI this is not possible
 662  *              so this will be false.
 663  * @companion:  True if this is a companion controller to another USB
 664  *              controller
 665  */
 666 struct usb_bus_priv {
 667         int next_addr;
 668         bool desc_before_addr;
 669         bool companion;
 670 };
 671
 672 /**
 673  * struct usb_emul_plat - platform data about the USB emulator
 674  *
 675  * Given a USB emulator (UCLASS_USB_EMUL) 'dev', this is
 676  * dev_get_uclass_plat(dev).
 677  *
 678  * @port1:      USB emulator device port number on the parent hub
 679  */
 680 struct usb_emul_plat {
 681         int port1;      /* Port number (numbered from 1) */
 682 };
 683
 684 /**
 685  * struct dm_usb_ops - USB controller operations
 686  *
 687  * This defines the operations supoorted on a USB controller. Common
 688  * arguments are:
 689  *
 690  * @bus:        USB bus (i.e. controller), which is in UCLASS_USB.
 691  * @udev:       USB device parent data. Controllers are not expected to need
 692  *              this, since the device address on the bus is encoded in @pipe.
 693  *              It is used for sandbox, and can be handy for debugging and
 694  *              logging.
 695  * @pipe:       An assortment of bitfields which provide address and packet
 696  *              type information. See create_pipe() above for encoding
 697  *              details
 698  * @buffer:     A buffer to use for sending/receiving. This should be
 699  *              DMA-aligned.
 700  * @length:     Buffer length in bytes
 701  */
 702 struct dm_usb_ops {
 703         /**
 704          * control() - Send a control message
 705          *
 706          * Most parameters are as above.
 707          *
 708          * @setup: Additional setup information required by the message
 709          */
 710         int (*control)(struct udevice *bus, struct usb_device *udev,
 711                        unsigned long pipe, void *buffer, int length,
 712                        struct devrequest *setup);
 713         /**
 714          * bulk() - Send a bulk message
 715          *
 716          * Parameters are as above.
 717          */
 718         int (*bulk)(struct udevice *bus, struct usb_device *udev,
 719                     unsigned long pipe, void *buffer, int length);
 720         /**
 721          * interrupt() - Send an interrupt message
 722          *
 723          * Most parameters are as above.
 724          *
 725          * @interval: Interrupt interval
 726          */
 727         int (*interrupt)(struct udevice *bus, struct usb_device *udev,
 728                          unsigned long pipe, void *buffer, int length,
 729                          int interval, bool nonblock);
 730
 731         /**
 732          * create_int_queue() - Create and queue interrupt packets
 733          *
 734          * Create and queue @queuesize number of interrupt usb packets of
 735          * @elementsize bytes each. @buffer must be atleast @queuesize *
 736          * @elementsize bytes.
 737          *
 738          * Note some controllers only support a queuesize of 1.
 739          *
 740          * @interval: Interrupt interval
 741          *
 742          * @return A pointer to the created interrupt queue or NULL on error
 743          */
 744         struct int_queue * (*create_int_queue)(struct udevice *bus,
 745                                 struct usb_device *udev, unsigned long pipe,
 746                                 int queuesize, int elementsize, void *buffer,
 747                                 int interval);
 748
 749         /**
 750          * poll_int_queue() - Poll an interrupt queue for completed packets
 751          *
 752          * Poll an interrupt queue for completed packets. The return value
 753          * points to the part of the buffer passed to create_int_queue()
 754          * corresponding to the completed packet.
 755          *
 756          * @queue: queue to poll
 757          *
 758          * @return Pointer to the data of the first completed packet, or
 759          *         NULL if no packets are ready
 760          */
 761         void * (*poll_int_queue)(struct udevice *bus, struct usb_device *udev,
 762                                  struct int_queue *queue);
 763
 764         /**
 765          * destroy_int_queue() - Destroy an interrupt queue
 766          *
 767          * Destroy an interrupt queue created by create_int_queue().
 768          *
 769          * @queue: queue to poll
 770          *
 771          * @return 0 if OK, -ve on error
 772          */
 773         int (*destroy_int_queue)(struct udevice *bus, struct usb_device *udev,
 774                                  struct int_queue *queue);
 775
 776         /**
 777          * alloc_device() - Allocate a new device context (XHCI)
 778          *
 779          * Before sending packets to a new device on an XHCI bus, a device
 780          * context must be created. If this method is not NULL it will be
 781          * called before the device is enumerated (even before its descriptor
 782          * is read). This should be NULL for EHCI, which does not need this.
 783          */
 784         int (*alloc_device)(struct udevice *bus, struct usb_device *udev);
 785
 786         /**
 787          * reset_root_port() - Reset usb root port
 788          */
 789         int (*reset_root_port)(struct udevice *bus, struct usb_device *udev);
 790
 791         /**
 792          * update_hub_device() - Update HCD's internal representation of hub
 793          *
 794          * After a hub descriptor is fetched, notify HCD so that its internal
 795          * representation of this hub can be updated (xHCI)
 796          */
 797         int (*update_hub_device)(struct udevice *bus, struct usb_device *udev);
 798
 799         /**
 800          * get_max_xfer_size() - Get HCD's maximum transfer bytes
 801          *
 802          * The HCD may have limitation on the maximum bytes to be transferred
 803          * in a USB transfer. USB class driver needs to be aware of this.
 804          */
 805         int (*get_max_xfer_size)(struct udevice *bus, size_t *size);
 806
 807         /**
 808          * lock_async() - Keep async schedule after a transfer
 809          *
 810          * It may be desired to keep the asynchronous schedule running even
 811          * after a transfer finishes, usually when doing multiple transfers
 812          * back-to-back. This callback allows signalling the USB controller
 813          * driver to do just that.
 814          */
 815         int (*lock_async)(struct udevice *udev, int lock);
 816 };
 817
 818 #define usb_get_ops(dev)        ((struct dm_usb_ops *)(dev)->driver->ops)
 819 #define usb_get_emul_ops(dev)   ((struct dm_usb_ops *)(dev)->driver->ops)
 820
 821 /**
 822  * usb_setup_device() - set up a device ready for use
 823  *
 824  * @dev:        USB device pointer. This need not be a real device - it is
 825  *              common for it to just be a local variable with its ->dev
 826  *              member (i.e. @dev->dev) set to the parent device and
 827  *              dev->portnr set to the port number on the hub (1=first)
 828  * @do_read:    true to read the device descriptor before an address is set
 829  *              (should be false for XHCI buses, true otherwise)
 830  * @parent:     Parent device (either UCLASS_USB or UCLASS_USB_HUB)
 831  * Return: 0 if OK, -ve on error */
 832 int usb_setup_device(struct usb_device *dev, bool do_read,
 833                      struct usb_device *parent);
 834
 835 /**
 836  * usb_hub_is_root_hub() - Test whether a hub device is root hub or not
 837  *
 838  * @hub:        USB hub device to test
 839  * @return:     true if the hub device is root hub, false otherwise.
 840  */
 841 bool usb_hub_is_root_hub(struct udevice *hub);
 842
 843 /**
 844  * usb_hub_scan() - Scan a hub and find its devices
 845  *
 846  * @hub:        Hub device to scan
 847  */
 848 int usb_hub_scan(struct udevice *hub);
 849
 850 /**
 851  * usb_scan_device() - Scan a device on a bus
 852  *
 853  * Scan a device on a bus. It has already been detected and is ready to
 854  * be enumerated. This may be either the root hub (@parent is a bus) or a
 855  * normal device (@parent is a hub)
 856  *
 857  * @parent:     Parent device
 858  * @port:       Hub port number (numbered from 1)
 859  * @speed:      USB speed to use for this device
 860  * @devp:       Returns pointer to device if all is well
 861  * Return: 0 if OK, -ve on error
 862  */
 863 int usb_scan_device(struct udevice *parent, int port,
 864                     enum usb_device_speed speed, struct udevice **devp);
 865
 866 /**
 867  * usb_get_bus() - Find the bus for a device
 868  *
 869  * Search up through parents to find the bus this device is connected to. This
 870  * will be a device with uclass UCLASS_USB.
 871  *
 872  * @dev:        Device to check
 873  * Return: The bus, or NULL if not found (this indicates a critical error in
 874  *      the USB stack
 875  */
 876 struct udevice *usb_get_bus(struct udevice *dev);
 877
 878 /**
 879  * usb_select_config() - Set up a device ready for use
 880  *
 881  * This function assumes that the device already has an address and a driver
 882  * bound, and is ready to be set up.
 883  *
 884  * This re-reads the device and configuration descriptors and sets the
 885  * configuration
 886  *
 887  * @dev:        Device to set up
 888  */
 889 int usb_select_config(struct usb_device *dev);
 890
 891 /**
 892  * usb_child_pre_probe() - Pre-probe function for USB devices
 893  *
 894  * This is called on all children of hubs and USB controllers (i.e. UCLASS_USB
 895  * and UCLASS_USB_HUB) when a new device is about to be probed. It sets up the
 896  * device from the saved platform data and calls usb_select_config() to
 897  * finish set up.
 898  *
 899  * Once this is done, the device's normal driver can take over, knowing the
 900  * device is accessible on the USB bus.
 901  *
 902  * This function is for use only by the internal USB stack.
 903  *
 904  * @dev:        Device to set up
 905  */
 906 int usb_child_pre_probe(struct udevice *dev);
 907
 908 struct ehci_ctrl;
 909
 910 /**
 911  * usb_setup_ehci_gadget() - Set up a USB device as a gadget
 912  *
 913  * TODO([email protected]): Tidy this up when USB gadgets can use driver model
 914  *
 915  * This provides a way to tell a controller to start up as a USB device
 916  * instead of as a host. It is untested.
 917  */
 918 int usb_setup_ehci_gadget(struct ehci_ctrl **ctlrp);
 919
 920 /**
 921  * usb_remove_ehci_gadget() - Remove a gadget USB device
 922  *
 923  * TODO([email protected]): Tidy this up when USB gadgets can use driver model
 924  *
 925  * This provides a way to tell a controller to remove a USB device
 926  */
 927 int usb_remove_ehci_gadget(struct ehci_ctrl **ctlrp);
 928
 929 /**
 930  * usb_stor_reset() - Prepare to scan USB storage devices
 931  *
 932  * Empty the list of USB storage devices in preparation for scanning them.
 933  * This must be called before a USB scan.
 934  */
 935 void usb_stor_reset(void);
 936
 937 #else /* !CONFIG_IS_ENABLED(DM_USB) */
 938
 939 struct usb_device *usb_get_dev_index(int index);
 940
 941 #endif
 942
 943 bool usb_device_has_child_on_port(struct usb_device *parent, int port);
 944
 945 int usb_hub_probe(struct usb_device *dev, int ifnum);
 946 void usb_hub_reset(void);
 947
 948 /*
 949  * usb_find_usb2_hub_address_port() - Get hub address and port for TT setting
 950  *
 951  * Searches for the first HS hub above the given device. If a
 952  * HS hub is found, the hub address and the port the device is
 953  * connected to is return, as required for SPLIT transactions
 954  *
 955  * @param: udev full speed or low speed device
 956  */
 957 void usb_find_usb2_hub_address_port(struct usb_device *udev,
 958                                     uint8_t *hub_address, uint8_t *hub_port);
 959
 960 /**
 961  * usb_alloc_new_device() - Allocate a new device
 962  *
 963  * @devp: returns a pointer of a new device structure. With driver model this
 964  *              is a device pointer, but with legacy USB this pointer is
 965  *              driver-specific.
 966  * Return: 0 if OK, -ENOSPC if we have found out of room for new devices
 967  */
 968 int usb_alloc_new_device(struct udevice *controller, struct usb_device **devp);
 969
 970 /**
 971  * usb_free_device() - Free a partially-inited device
 972  *
 973  * This is an internal function. It is used to reverse the action of
 974  * usb_alloc_new_device() when we hit a problem during init.
 975  */
 976 void usb_free_device(struct udevice *controller);
 977
 978 int usb_new_device(struct usb_device *dev);
 979
 980 int usb_alloc_device(struct usb_device *dev);
 981
 982 /**
 983  * usb_update_hub_device() - Update HCD's internal representation of hub
 984  *
 985  * After a hub descriptor is fetched, notify HCD so that its internal
 986  * representation of this hub can be updated.
 987  *
 988  * @dev:                Hub device
 989  * Return: 0 if OK, -ve on error
 990  */
 991 int usb_update_hub_device(struct usb_device *dev);
 992
 993 /**
 994  * usb_get_max_xfer_size() - Get HCD's maximum transfer bytes
 995  *
 996  * The HCD may have limitation on the maximum bytes to be transferred
 997  * in a USB transfer. USB class driver needs to be aware of this.
 998  *
 999  * @dev:                USB device
1000  * @size:               maximum transfer bytes
1001  * Return: 0 if OK, -ve on error
1002  */
1003 int usb_get_max_xfer_size(struct usb_device *dev, size_t *size);
1004
1005 /**
1006  * usb_emul_setup_device() - Set up a new USB device emulation
1007  *
1008  * This is normally called when a new emulation device is bound. It tells
1009  * the USB emulation uclass about the features of the emulator.
1010  *
1011  * @dev:                Emulation device
1012  * @strings:            List of USB string descriptors, terminated by a NULL
1013  *                      entry
1014  * @desc_list:          List of points or USB descriptors, terminated by NULL.
1015  *                      The first entry must be struct usb_device_descriptor,
1016  *                      and others follow on after that.
1017  * Return: 0 if OK, -ENOSYS if not implemented, other -ve on error
1018  */
1019 int usb_emul_setup_device(struct udevice *dev, struct usb_string *strings,
1020                           void **desc_list);
1021
1022 /**
1023  * usb_emul_control() - Send a control packet to an emulator
1024  *
1025  * @emul:       Emulator device
1026  * @udev:       USB device (which the emulator is causing to appear)
1027  * See struct dm_usb_ops for details on other parameters
1028  * Return: 0 if OK, -ve on error
1029  */
1030 int usb_emul_control(struct udevice *emul, struct usb_device *udev,
1031                      unsigned long pipe, void *buffer, int length,
1032                      struct devrequest *setup);
1033
1034 /**
1035  * usb_emul_bulk() - Send a bulk packet to an emulator
1036  *
1037  * @emul:       Emulator device
1038  * @udev:       USB device (which the emulator is causing to appear)
1039  * See struct dm_usb_ops for details on other parameters
1040  * Return: 0 if OK, -ve on error
1041  */
1042 int usb_emul_bulk(struct udevice *emul, struct usb_device *udev,
1043                   unsigned long pipe, void *buffer, int length);
1044
1045 /**
1046  * usb_emul_int() - Send an interrupt packet to an emulator
1047  *
1048  * @emul:       Emulator device
1049  * @udev:       USB device (which the emulator is causing to appear)
1050  * See struct dm_usb_ops for details on other parameters
1051  * Return: 0 if OK, -ve on error
1052  */
1053 int usb_emul_int(struct udevice *emul, struct usb_device *udev,
1054                   unsigned long pipe, void *buffer, int length, int interval,
1055                   bool nonblock);
1056
1057 /**
1058  * usb_emul_find() - Find an emulator for a particular device
1059  *
1060  * Check @pipe and @port1 to find a device number on bus @bus and return it.
1061  *
1062  * @bus:        USB bus (controller)
1063  * @pipe:       Describes pipe being used, and includes the device number
1064  * @port1:      Describes port number on the parent hub
1065  * @emulp:      Returns pointer to emulator, or NULL if not found
1066  * Return: 0 if found, -ve on error
1067  */
1068 int usb_emul_find(struct udevice *bus, ulong pipe, int port1,
1069                   struct udevice **emulp);
1070
1071 /**
1072  * usb_emul_find_for_dev() - Find an emulator for a particular device
1073  *
1074  * @dev:        USB device to check
1075  * @emulp:      Returns pointer to emulator, or NULL if not found
1076  * Return: 0 if found, -ve on error
1077  */
1078 int usb_emul_find_for_dev(struct udevice *dev, struct udevice **emulp);
1079
1080 /**
1081  * usb_emul_find_descriptor() - Find a USB descriptor of a particular device
1082  *
1083  * @ptr:        a pointer to a list of USB descriptor pointers
1084  * @type:       type of USB descriptor to find
1085  * @index:      if @type is USB_DT_CONFIG, this is the configuration value
1086  * Return: a pointer to the USB descriptor found, NULL if not found
1087  */
1088 struct usb_generic_descriptor **usb_emul_find_descriptor(
1089                 struct usb_generic_descriptor **ptr, int type, int index);
1090
1091 /**
1092  * usb_show_tree() - show the USB device tree
1093  *
1094  * This shows a list of active USB devices along with basic information about
1095  * each.
1096  */
1097 void usb_show_tree(void);
1098
1099 #endif /*_USB_H_ */