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_parentdata(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; /* transfered 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; /* transfered 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 #if defined(CONFIG_USB_UHCI) || defined(CONFIG_USB_OHCI) || \ 175 defined(CONFIG_USB_EHCI) || defined(CONFIG_USB_OHCI_NEW) || \ 176 defined(CONFIG_USB_SL811HS) || defined(CONFIG_USB_ISP116X_HCD) || \ 177 defined(CONFIG_USB_R8A66597_HCD) || defined(CONFIG_USB_DAVINCI) || \ 178 defined(CONFIG_USB_OMAP3) || defined(CONFIG_USB_DA8XX) || \ 179 defined(CONFIG_USB_BLACKFIN) || defined(CONFIG_USB_AM35X) || \ 180 defined(CONFIG_USB_MUSB_DSPS) || defined(CONFIG_USB_MUSB_AM35X) || \ 181 defined(CONFIG_USB_MUSB_OMAP2PLUS) || defined(CONFIG_USB_MUSB_SUNXI) || \ 182 defined(CONFIG_USB_XHCI) || defined(CONFIG_USB_DWC2) || \ 183 defined(CONFIG_USB_EMUL) 184 185 int usb_lowlevel_init(int index, enum usb_init_type init, void **controller); 186 int usb_lowlevel_stop(int index); 187 188 #if defined(CONFIG_MUSB_HOST) || defined(CONFIG_DM_USB) 189 int usb_reset_root_port(void); 190 #else 191 #define usb_reset_root_port() 192 #endif 193 194 int submit_bulk_msg(struct usb_device *dev, unsigned long pipe, 195 void *buffer, int transfer_len); 196 int submit_control_msg(struct usb_device *dev, unsigned long pipe, void *buffer, 197 int transfer_len, struct devrequest *setup); 198 int submit_int_msg(struct usb_device *dev, unsigned long pipe, void *buffer, 199 int transfer_len, int interval); 200 201 #if defined CONFIG_USB_EHCI || defined CONFIG_MUSB_HOST 202 struct int_queue *create_int_queue(struct usb_device *dev, unsigned long pipe, 203 int queuesize, int elementsize, void *buffer, int interval); 204 int destroy_int_queue(struct usb_device *dev, struct int_queue *queue); 205 void *poll_int_queue(struct usb_device *dev, struct int_queue *queue); 206 #endif 207 208 /* Defines */ 209 #define USB_UHCI_VEND_ID 0x8086 210 #define USB_UHCI_DEV_ID 0x7112 211 212 /* 213 * PXA25x can only act as USB device. There are drivers 214 * which works with USB CDC gadgets implementations. 215 * Some of them have common routines which can be used 216 * in boards init functions e.g. udc_disconnect() used for 217 * forced device disconnection from host. 218 */ 219 #elif defined(CONFIG_USB_GADGET_PXA2XX) 220 221 extern void udc_disconnect(void); 222 223 #endif 224 225 /* 226 * board-specific hardware initialization, called by 227 * usb drivers and u-boot commands 228 * 229 * @param index USB controller number 230 * @param init initializes controller as USB host or device 231 */ 232 int board_usb_init(int index, enum usb_init_type init); 233 234 /* 235 * can be used to clean up after failed USB initialization attempt 236 * vide: board_usb_init() 237 * 238 * @param index USB controller number for selective cleanup 239 * @param init usb_init_type passed to board_usb_init() 240 */ 241 int board_usb_cleanup(int index, enum usb_init_type init); 242 243 #ifdef CONFIG_USB_STORAGE 244 245 #define USB_MAX_STOR_DEV 5 246 block_dev_desc_t *usb_stor_get_dev(int index); 247 int usb_stor_scan(int mode); 248 int usb_stor_info(void); 249 250 #endif 251 252 #ifdef CONFIG_USB_HOST_ETHER 253 254 #define USB_MAX_ETH_DEV 5 255 int usb_host_eth_scan(int mode); 256 257 #endif 258 259 #ifdef CONFIG_USB_KEYBOARD 260 261 int drv_usb_kbd_init(void); 262 int usb_kbd_deregister(int force); 263 264 #endif 265 /* routines */ 266 int usb_init(void); /* initialize the USB Controller */ 267 int usb_stop(void); /* stop the USB Controller */ 268 269 270 int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol); 271 int usb_set_idle(struct usb_device *dev, int ifnum, int duration, 272 int report_id); 273 int usb_control_msg(struct usb_device *dev, unsigned int pipe, 274 unsigned char request, unsigned char requesttype, 275 unsigned short value, unsigned short index, 276 void *data, unsigned short size, int timeout); 277 int usb_bulk_msg(struct usb_device *dev, unsigned int pipe, 278 void *data, int len, int *actual_length, int timeout); 279 int usb_submit_int_msg(struct usb_device *dev, unsigned long pipe, 280 void *buffer, int transfer_len, int interval); 281 int usb_disable_asynch(int disable); 282 int usb_maxpacket(struct usb_device *dev, unsigned long pipe); 283 int usb_get_configuration_no(struct usb_device *dev, unsigned char *buffer, 284 int cfgno); 285 int usb_get_report(struct usb_device *dev, int ifnum, unsigned char type, 286 unsigned char id, void *buf, int size); 287 int usb_get_class_descriptor(struct usb_device *dev, int ifnum, 288 unsigned char type, unsigned char id, void *buf, 289 int size); 290 int usb_clear_halt(struct usb_device *dev, int pipe); 291 int usb_string(struct usb_device *dev, int index, char *buf, size_t size); 292 int usb_set_interface(struct usb_device *dev, int interface, int alternate); 293 294 /* big endian -> little endian conversion */ 295 /* some CPUs are already little endian e.g. the ARM920T */ 296 #define __swap_16(x) \ 297 ({ unsigned short x_ = (unsigned short)x; \ 298 (unsigned short)( \ 299 ((x_ & 0x00FFU) << 8) | ((x_ & 0xFF00U) >> 8)); \ 300 }) 301 #define __swap_32(x) \ 302 ({ unsigned long x_ = (unsigned long)x; \ 303 (unsigned long)( \ 304 ((x_ & 0x000000FFUL) << 24) | \ 305 ((x_ & 0x0000FF00UL) << 8) | \ 306 ((x_ & 0x00FF0000UL) >> 8) | \ 307 ((x_ & 0xFF000000UL) >> 24)); \ 308 }) 309 310 #ifdef __LITTLE_ENDIAN 311 # define swap_16(x) (x) 312 # define swap_32(x) (x) 313 #else 314 # define swap_16(x) __swap_16(x) 315 # define swap_32(x) __swap_32(x) 316 #endif 317 318 /* 319 * Calling this entity a "pipe" is glorifying it. A USB pipe 320 * is something embarrassingly simple: it basically consists 321 * of the following information: 322 * - device number (7 bits) 323 * - endpoint number (4 bits) 324 * - current Data0/1 state (1 bit) 325 * - direction (1 bit) 326 * - speed (2 bits) 327 * - max packet size (2 bits: 8, 16, 32 or 64) 328 * - pipe type (2 bits: control, interrupt, bulk, isochronous) 329 * 330 * That's 18 bits. Really. Nothing more. And the USB people have 331 * documented these eighteen bits as some kind of glorious 332 * virtual data structure. 333 * 334 * Let's not fall in that trap. We'll just encode it as a simple 335 * unsigned int. The encoding is: 336 * 337 * - max size: bits 0-1 (00 = 8, 01 = 16, 10 = 32, 11 = 64) 338 * - direction: bit 7 (0 = Host-to-Device [Out], 339 * (1 = Device-to-Host [In]) 340 * - device: bits 8-14 341 * - endpoint: bits 15-18 342 * - Data0/1: bit 19 343 * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt, 344 * 10 = control, 11 = bulk) 345 * 346 * Why? Because it's arbitrary, and whatever encoding we select is really 347 * up to us. This one happens to share a lot of bit positions with the UHCI 348 * specification, so that much of the uhci driver can just mask the bits 349 * appropriately. 350 */ 351 /* Create various pipes... */ 352 #define create_pipe(dev,endpoint) \ 353 (((dev)->devnum << 8) | ((endpoint) << 15) | \ 354 (dev)->maxpacketsize) 355 #define default_pipe(dev) ((dev)->speed << 26) 356 357 #define usb_sndctrlpipe(dev, endpoint) ((PIPE_CONTROL << 30) | \ 358 create_pipe(dev, endpoint)) 359 #define usb_rcvctrlpipe(dev, endpoint) ((PIPE_CONTROL << 30) | \ 360 create_pipe(dev, endpoint) | \ 361 USB_DIR_IN) 362 #define usb_sndisocpipe(dev, endpoint) ((PIPE_ISOCHRONOUS << 30) | \ 363 create_pipe(dev, endpoint)) 364 #define usb_rcvisocpipe(dev, endpoint) ((PIPE_ISOCHRONOUS << 30) | \ 365 create_pipe(dev, endpoint) | \ 366 USB_DIR_IN) 367 #define usb_sndbulkpipe(dev, endpoint) ((PIPE_BULK << 30) | \ 368 create_pipe(dev, endpoint)) 369 #define usb_rcvbulkpipe(dev, endpoint) ((PIPE_BULK << 30) | \ 370 create_pipe(dev, endpoint) | \ 371 USB_DIR_IN) 372 #define usb_sndintpipe(dev, endpoint) ((PIPE_INTERRUPT << 30) | \ 373 create_pipe(dev, endpoint)) 374 #define usb_rcvintpipe(dev, endpoint) ((PIPE_INTERRUPT << 30) | \ 375 create_pipe(dev, endpoint) | \ 376 USB_DIR_IN) 377 #define usb_snddefctrl(dev) ((PIPE_CONTROL << 30) | \ 378 default_pipe(dev)) 379 #define usb_rcvdefctrl(dev) ((PIPE_CONTROL << 30) | \ 380 default_pipe(dev) | \ 381 USB_DIR_IN) 382 383 /* The D0/D1 toggle bits */ 384 #define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> ep) & 1) 385 #define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << ep)) 386 #define usb_settoggle(dev, ep, out, bit) ((dev)->toggle[out] = \ 387 ((dev)->toggle[out] & \ 388 ~(1 << ep)) | ((bit) << ep)) 389 390 /* Endpoint halt control/status */ 391 #define usb_endpoint_out(ep_dir) (((ep_dir >> 7) & 1) ^ 1) 392 #define usb_endpoint_halt(dev, ep, out) ((dev)->halted[out] |= (1 << (ep))) 393 #define usb_endpoint_running(dev, ep, out) ((dev)->halted[out] &= ~(1 << (ep))) 394 #define usb_endpoint_halted(dev, ep, out) ((dev)->halted[out] & (1 << (ep))) 395 396 #define usb_packetid(pipe) (((pipe) & USB_DIR_IN) ? USB_PID_IN : \ 397 USB_PID_OUT) 398 399 #define usb_pipeout(pipe) ((((pipe) >> 7) & 1) ^ 1) 400 #define usb_pipein(pipe) (((pipe) >> 7) & 1) 401 #define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f) 402 #define usb_pipe_endpdev(pipe) (((pipe) >> 8) & 0x7ff) 403 #define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf) 404 #define usb_pipedata(pipe) (((pipe) >> 19) & 1) 405 #define usb_pipetype(pipe) (((pipe) >> 30) & 3) 406 #define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS) 407 #define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT) 408 #define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL) 409 #define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK) 410 411 #define usb_pipe_ep_index(pipe) \ 412 usb_pipecontrol(pipe) ? (usb_pipeendpoint(pipe) * 2) : \ 413 ((usb_pipeendpoint(pipe) * 2) - \ 414 (usb_pipein(pipe) ? 0 : 1)) 415 416 /** 417 * struct usb_device_id - identifies USB devices for probing and hotplugging 418 * @match_flags: Bit mask controlling which of the other fields are used to 419 * match against new devices. Any field except for driver_info may be 420 * used, although some only make sense in conjunction with other fields. 421 * This is usually set by a USB_DEVICE_*() macro, which sets all 422 * other fields in this structure except for driver_info. 423 * @idVendor: USB vendor ID for a device; numbers are assigned 424 * by the USB forum to its members. 425 * @idProduct: Vendor-assigned product ID. 426 * @bcdDevice_lo: Low end of range of vendor-assigned product version numbers. 427 * This is also used to identify individual product versions, for 428 * a range consisting of a single device. 429 * @bcdDevice_hi: High end of version number range. The range of product 430 * versions is inclusive. 431 * @bDeviceClass: Class of device; numbers are assigned 432 * by the USB forum. Products may choose to implement classes, 433 * or be vendor-specific. Device classes specify behavior of all 434 * the interfaces on a device. 435 * @bDeviceSubClass: Subclass of device; associated with bDeviceClass. 436 * @bDeviceProtocol: Protocol of device; associated with bDeviceClass. 437 * @bInterfaceClass: Class of interface; numbers are assigned 438 * by the USB forum. Products may choose to implement classes, 439 * or be vendor-specific. Interface classes specify behavior only 440 * of a given interface; other interfaces may support other classes. 441 * @bInterfaceSubClass: Subclass of interface; associated with bInterfaceClass. 442 * @bInterfaceProtocol: Protocol of interface; associated with bInterfaceClass. 443 * @bInterfaceNumber: Number of interface; composite devices may use 444 * fixed interface numbers to differentiate between vendor-specific 445 * interfaces. 446 * @driver_info: Holds information used by the driver. Usually it holds 447 * a pointer to a descriptor understood by the driver, or perhaps 448 * device flags. 449 * 450 * In most cases, drivers will create a table of device IDs by using 451 * USB_DEVICE(), or similar macros designed for that purpose. 452 * They will then export it to userspace using MODULE_DEVICE_TABLE(), 453 * and provide it to the USB core through their usb_driver structure. 454 * 455 * See the usb_match_id() function for information about how matches are 456 * performed. Briefly, you will normally use one of several macros to help 457 * construct these entries. Each entry you provide will either identify 458 * one or more specific products, or will identify a class of products 459 * which have agreed to behave the same. You should put the more specific 460 * matches towards the beginning of your table, so that driver_info can 461 * record quirks of specific products. 462 */ 463 struct usb_device_id { 464 /* which fields to match against? */ 465 u16 match_flags; 466 467 /* Used for product specific matches; range is inclusive */ 468 u16 idVendor; 469 u16 idProduct; 470 u16 bcdDevice_lo; 471 u16 bcdDevice_hi; 472 473 /* Used for device class matches */ 474 u8 bDeviceClass; 475 u8 bDeviceSubClass; 476 u8 bDeviceProtocol; 477 478 /* Used for interface class matches */ 479 u8 bInterfaceClass; 480 u8 bInterfaceSubClass; 481 u8 bInterfaceProtocol; 482 483 /* Used for vendor-specific interface matches */ 484 u8 bInterfaceNumber; 485 486 /* not matched against */ 487 ulong driver_info; 488 }; 489 490 /* Some useful macros to use to create struct usb_device_id */ 491 #define USB_DEVICE_ID_MATCH_VENDOR 0x0001 492 #define USB_DEVICE_ID_MATCH_PRODUCT 0x0002 493 #define USB_DEVICE_ID_MATCH_DEV_LO 0x0004 494 #define USB_DEVICE_ID_MATCH_DEV_HI 0x0008 495 #define USB_DEVICE_ID_MATCH_DEV_CLASS 0x0010 496 #define USB_DEVICE_ID_MATCH_DEV_SUBCLASS 0x0020 497 #define USB_DEVICE_ID_MATCH_DEV_PROTOCOL 0x0040 498 #define USB_DEVICE_ID_MATCH_INT_CLASS 0x0080 499 #define USB_DEVICE_ID_MATCH_INT_SUBCLASS 0x0100 500 #define USB_DEVICE_ID_MATCH_INT_PROTOCOL 0x0200 501 #define USB_DEVICE_ID_MATCH_INT_NUMBER 0x0400 502 503 /* Match anything, indicates this is a valid entry even if everything is 0 */ 504 #define USB_DEVICE_ID_MATCH_NONE 0x0800 505 #define USB_DEVICE_ID_MATCH_ALL 0x07ff 506 507 /** 508 * struct usb_driver_entry - Matches a driver to its usb_device_ids 509 * @compatible: Compatible string 510 * @data: Data for this compatible string 511 */ 512 struct usb_driver_entry { 513 struct driver *driver; 514 const struct usb_device_id *match; 515 }; 516 517 #define USB_DEVICE(__name, __match) \ 518 ll_entry_declare(struct usb_driver_entry, __name, usb_driver_entry) = {\ 519 .driver = llsym(struct driver, __name, driver), \ 520 .match = __match, \ 521 } 522 523 /************************************************************************* 524 * Hub Stuff 525 */ 526 struct usb_port_status { 527 unsigned short wPortStatus; 528 unsigned short wPortChange; 529 } __attribute__ ((packed)); 530 531 struct usb_hub_status { 532 unsigned short wHubStatus; 533 unsigned short wHubChange; 534 } __attribute__ ((packed)); 535 536 537 /* Hub descriptor */ 538 struct usb_hub_descriptor { 539 unsigned char bLength; 540 unsigned char bDescriptorType; 541 unsigned char bNbrPorts; 542 unsigned short wHubCharacteristics; 543 unsigned char bPwrOn2PwrGood; 544 unsigned char bHubContrCurrent; 545 unsigned char DeviceRemovable[(USB_MAXCHILDREN+1+7)/8]; 546 unsigned char PortPowerCtrlMask[(USB_MAXCHILDREN+1+7)/8]; 547 /* DeviceRemovable and PortPwrCtrlMask want to be variable-length 548 bitmaps that hold max 255 entries. (bit0 is ignored) */ 549 } __attribute__ ((packed)); 550 551 552 struct usb_hub_device { 553 struct usb_device *pusb_dev; 554 struct usb_hub_descriptor desc; 555 }; 556 557 #ifdef CONFIG_DM_USB 558 /** 559 * struct usb_platdata - Platform data about a USB controller 560 * 561 * Given a USB controller (UCLASS_USB) dev this is dev_get_platdata(dev) 562 */ 563 struct usb_platdata { 564 enum usb_init_type init_type; 565 }; 566 567 /** 568 * struct usb_dev_platdata - Platform data about a USB device 569 * 570 * Given a USB device dev this structure is dev_get_parent_platdata(dev). 571 * This is used by sandbox to provide emulation data also. 572 * 573 * @id: ID used to match this device 574 * @speed: Stores the speed associated with a USB device 575 * @devnum: Device address on the USB bus 576 * @slot_id: USB3 slot ID, which is separate from the device address 577 * @portnr: Port number of this device on its parent hub, numbered from 1 578 * (0 mean this device is the root hub) 579 * @strings: List of descriptor strings (for sandbox emulation purposes) 580 * @desc_list: List of descriptors (for sandbox emulation purposes) 581 */ 582 struct usb_dev_platdata { 583 struct usb_device_id id; 584 enum usb_device_speed speed; 585 int devnum; 586 int slot_id; 587 int portnr; /* Hub port number, 1..n */ 588 #ifdef CONFIG_SANDBOX 589 struct usb_string *strings; 590 /* NULL-terminated list of descriptor pointers */ 591 struct usb_generic_descriptor **desc_list; 592 #endif 593 int configno; 594 }; 595 596 /** 597 * struct usb_bus_priv - information about the USB controller 598 * 599 * Given a USB controller (UCLASS_USB) 'dev', this is 600 * dev_get_uclass_priv(dev). 601 * 602 * @next_addr: Next device address to allocate minus 1. Incremented by 1 603 * each time a new device address is set, so this holds the 604 * number of devices on the bus 605 * @desc_before_addr: true if we can read a device descriptor before it 606 * has been assigned an address. For XHCI this is not possible 607 * so this will be false. 608 */ 609 struct usb_bus_priv { 610 int next_addr; 611 bool desc_before_addr; 612 }; 613 614 /** 615 * struct dm_usb_ops - USB controller operations 616 * 617 * This defines the operations supoorted on a USB controller. Common 618 * arguments are: 619 * 620 * @bus: USB bus (i.e. controller), which is in UCLASS_USB. 621 * @udev: USB device parent data. Controllers are not expected to need 622 * this, since the device address on the bus is encoded in @pipe. 623 * It is used for sandbox, and can be handy for debugging and 624 * logging. 625 * @pipe: An assortment of bitfields which provide address and packet 626 * type information. See create_pipe() above for encoding 627 * details 628 * @buffer: A buffer to use for sending/receiving. This should be 629 * DMA-aligned. 630 * @length: Buffer length in bytes 631 */ 632 struct dm_usb_ops { 633 /** 634 * control() - Send a control message 635 * 636 * Most parameters are as above. 637 * 638 * @setup: Additional setup information required by the message 639 */ 640 int (*control)(struct udevice *bus, struct usb_device *udev, 641 unsigned long pipe, void *buffer, int length, 642 struct devrequest *setup); 643 /** 644 * bulk() - Send a bulk message 645 * 646 * Parameters are as above. 647 */ 648 int (*bulk)(struct udevice *bus, struct usb_device *udev, 649 unsigned long pipe, void *buffer, int length); 650 /** 651 * interrupt() - Send an interrupt message 652 * 653 * Most parameters are as above. 654 * 655 * @interval: Interrupt interval 656 */ 657 int (*interrupt)(struct udevice *bus, struct usb_device *udev, 658 unsigned long pipe, void *buffer, int length, 659 int interval); 660 /** 661 * alloc_device() - Allocate a new device context (XHCI) 662 * 663 * Before sending packets to a new device on an XHCI bus, a device 664 * context must be created. If this method is not NULL it will be 665 * called before the device is enumerated (even before its descriptor 666 * is read). This should be NULL for EHCI, which does not need this. 667 */ 668 int (*alloc_device)(struct udevice *bus, struct usb_device *udev); 669 }; 670 671 #define usb_get_ops(dev) ((struct dm_usb_ops *)(dev)->driver->ops) 672 #define usb_get_emul_ops(dev) ((struct dm_usb_ops *)(dev)->driver->ops) 673 674 #ifdef CONFIG_MUSB_HOST 675 int usb_reset_root_port(void); 676 #endif 677 678 /** 679 * usb_get_dev_index() - look up a device index number 680 * 681 * Look up devices using their index number (starting at 0). This works since 682 * in U-Boot device addresses are allocated starting at 1 with no gaps. 683 * 684 * TODO(sjg@chromium.org): Remove this function when usb_ether.c is modified 685 * to work better with driver model. 686 * 687 * @bus: USB bus to check 688 * @index: Index number of device to find (0=first). This is just the 689 * device address less 1. 690 */ 691 struct usb_device *usb_get_dev_index(struct udevice *bus, int index); 692 693 /** 694 * usb_legacy_port_reset() - Legacy function to reset a hub port 695 * 696 * @hub: Hub device 697 * @portnr: Port number (1=first) 698 */ 699 int usb_legacy_port_reset(struct usb_device *hub, int portnr); 700 701 /** 702 * usb_setup_device() - set up a device ready for use 703 * 704 * @dev: USB device pointer. This need not be a real device - it is 705 * common for it to just be a local variable with its ->dev 706 * member (i.e. @dev->dev) set to the parent device 707 * @do_read: true to read the device descriptor before an address is set 708 * (should be false for XHCI buses, true otherwise) 709 * @parent: Parent device (either UCLASS_USB or UCLASS_USB_HUB) 710 * @portnr: Port number on hub (1=first) or 0 for none 711 * @return 0 if OK, -ve on error */ 712 int usb_setup_device(struct usb_device *dev, bool do_read, 713 struct usb_device *parent, int portnr); 714 715 /** 716 * usb_hub_scan() - Scan a hub and find its devices 717 * 718 * @hub: Hub device to scan 719 */ 720 int usb_hub_scan(struct udevice *hub); 721 722 /** 723 * usb_scan_device() - Scan a device on a bus 724 * 725 * Scan a device on a bus. It has already been detected and is ready to 726 * be enumerated. This may be either the root hub (@parent is a bus) or a 727 * normal device (@parent is a hub) 728 * 729 * @parent: Parent device 730 * @port: Hub port number (numbered from 1) 731 * @speed: USB speed to use for this device 732 * @devp: Returns pointer to device if all is well 733 * @return 0 if OK, -ve on error 734 */ 735 int usb_scan_device(struct udevice *parent, int port, 736 enum usb_device_speed speed, struct udevice **devp); 737 738 /** 739 * usb_get_bus() - Find the bus for a device 740 * 741 * Search up through parents to find the bus this device is connected to. This 742 * will be a device with uclass UCLASS_USB. 743 * 744 * @dev: Device to check 745 * @busp: Returns bus, or NULL if not found 746 * @return 0 if OK, -EXDEV is somehow this bus does not have a controller (this 747 * indicates a critical error in the USB stack 748 */ 749 int usb_get_bus(struct udevice *dev, struct udevice **busp); 750 751 /** 752 * usb_select_config() - Set up a device ready for use 753 * 754 * This function assumes that the device already has an address and a driver 755 * bound, and is ready to be set up. 756 * 757 * This re-reads the device and configuration descriptors and sets the 758 * configuration 759 * 760 * @dev: Device to set up 761 */ 762 int usb_select_config(struct usb_device *dev); 763 764 /** 765 * usb_child_pre_probe() - Pre-probe function for USB devices 766 * 767 * This is called on all children of hubs and USB controllers (i.e. UCLASS_USB 768 * and UCLASS_USB_HUB) when a new device is about to be probed. It sets up the 769 * device from the saved platform data and calls usb_select_config() to 770 * finish set up. 771 * 772 * Once this is done, the device's normal driver can take over, knowing the 773 * device is accessible on the USB bus. 774 * 775 * This function is for use only by the internal USB stack. 776 * 777 * @dev: Device to set up 778 */ 779 int usb_child_pre_probe(struct udevice *dev); 780 781 struct ehci_ctrl; 782 783 /** 784 * usb_setup_ehci_gadget() - Set up a USB device as a gadget 785 * 786 * TODO(sjg@chromium.org): Tidy this up when USB gadgets can use driver model 787 * 788 * This provides a way to tell a controller to start up as a USB device 789 * instead of as a host. It is untested. 790 */ 791 int usb_setup_ehci_gadget(struct ehci_ctrl **ctlrp); 792 793 /** 794 * usb_stor_reset() - Prepare to scan USB storage devices 795 * 796 * Empty the list of USB storage devices in preparation for scanning them. 797 * This must be called before a USB scan. 798 */ 799 void usb_stor_reset(void); 800 801 #else /* !CONFIG_DM_USB */ 802 803 struct usb_device *usb_get_dev_index(int index); 804 805 #endif 806 807 bool usb_device_has_child_on_port(struct usb_device *parent, int port); 808 809 int usb_hub_probe(struct usb_device *dev, int ifnum); 810 void usb_hub_reset(void); 811 812 /** 813 * legacy_hub_port_reset() - reset a port given its usb_device pointer 814 * 815 * Reset a hub port and see if a device is present on that port, providing 816 * sufficient time for it to show itself. The port status is returned. 817 * 818 * With driver model this moves to hub_port_reset() and is passed a struct 819 * udevice. 820 * 821 * @dev: USB device to reset 822 * @port: Port number to reset (note ports are numbered from 0 here) 823 * @portstat: Returns port status 824 */ 825 int legacy_hub_port_reset(struct usb_device *dev, int port, 826 unsigned short *portstat); 827 828 int hub_port_reset(struct udevice *dev, int port, unsigned short *portstat); 829 830 /** 831 * usb_alloc_new_device() - Allocate a new device 832 * 833 * @devp: returns a pointer of a new device structure. With driver model this 834 * is a device pointer, but with legacy USB this pointer is 835 * driver-specific. 836 * @return 0 if OK, -ENOSPC if we have found out of room for new devices 837 */ 838 int usb_alloc_new_device(struct udevice *controller, struct usb_device **devp); 839 840 /** 841 * usb_free_device() - Free a partially-inited device 842 * 843 * This is an internal function. It is used to reverse the action of 844 * usb_alloc_new_device() when we hit a problem during init. 845 */ 846 void usb_free_device(struct udevice *controller); 847 848 int usb_new_device(struct usb_device *dev); 849 850 int usb_alloc_device(struct usb_device *dev); 851 852 /** 853 * usb_emul_setup_device() - Set up a new USB device emulation 854 * 855 * This is normally called when a new emulation device is bound. It tells 856 * the USB emulation uclass about the features of the emulator. 857 * 858 * @dev: Emulation device 859 * @maxpacketsize: Maximum packet size (e.g. PACKET_SIZE_64) 860 * @strings: List of USB string descriptors, terminated by a NULL 861 * entry 862 * @desc_list: List of points or USB descriptors, terminated by NULL. 863 * The first entry must be struct usb_device_descriptor, 864 * and others follow on after that. 865 * @return 0 if OK, -ve on error 866 */ 867 int usb_emul_setup_device(struct udevice *dev, int maxpacketsize, 868 struct usb_string *strings, void **desc_list); 869 870 /** 871 * usb_emul_control() - Send a control packet to an emulator 872 * 873 * @emul: Emulator device 874 * @udev: USB device (which the emulator is causing to appear) 875 * See struct dm_usb_ops for details on other parameters 876 * @return 0 if OK, -ve on error 877 */ 878 int usb_emul_control(struct udevice *emul, struct usb_device *udev, 879 unsigned long pipe, void *buffer, int length, 880 struct devrequest *setup); 881 882 /** 883 * usb_emul_bulk() - Send a bulk packet to an emulator 884 * 885 * @emul: Emulator device 886 * @udev: USB device (which the emulator is causing to appear) 887 * See struct dm_usb_ops for details on other parameters 888 * @return 0 if OK, -ve on error 889 */ 890 int usb_emul_bulk(struct udevice *emul, struct usb_device *udev, 891 unsigned long pipe, void *buffer, int length); 892 893 /** 894 * usb_emul_find() - Find an emulator for a particular device 895 * 896 * Check @pipe to find a device number on bus @bus and return it. 897 * 898 * @bus: USB bus (controller) 899 * @pipe: Describes pipe being used, and includes the device number 900 * @emulp: Returns pointer to emulator, or NULL if not found 901 * @return 0 if found, -ve on error 902 */ 903 int usb_emul_find(struct udevice *bus, ulong pipe, struct udevice **emulp); 904 905 /** 906 * usb_emul_reset() - Reset all emulators ready for use 907 * 908 * Clear out any address information in the emulators and make then ready for 909 * a new USB scan 910 */ 911 void usb_emul_reset(struct udevice *dev); 912 913 #endif /*_USB_H_ */ 914