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