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