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