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 184 int usb_lowlevel_init(int index, enum usb_init_type init, void **controller); 185 int usb_lowlevel_stop(int index); 186 187 #if defined(CONFIG_MUSB_HOST) || defined(CONFIG_DM_USB) 188 int usb_reset_root_port(void); 189 #else 190 #define usb_reset_root_port() 191 #endif 192 193 int submit_bulk_msg(struct usb_device *dev, unsigned long pipe, 194 void *buffer, int transfer_len); 195 int submit_control_msg(struct usb_device *dev, unsigned long pipe, void *buffer, 196 int transfer_len, struct devrequest *setup); 197 int submit_int_msg(struct usb_device *dev, unsigned long pipe, void *buffer, 198 int transfer_len, int interval); 199 200 #if defined CONFIG_USB_EHCI || defined CONFIG_MUSB_HOST 201 struct int_queue *create_int_queue(struct usb_device *dev, unsigned long pipe, 202 int queuesize, int elementsize, void *buffer, int interval); 203 int destroy_int_queue(struct usb_device *dev, struct int_queue *queue); 204 void *poll_int_queue(struct usb_device *dev, struct int_queue *queue); 205 #endif 206 207 /* Defines */ 208 #define USB_UHCI_VEND_ID 0x8086 209 #define USB_UHCI_DEV_ID 0x7112 210 211 /* 212 * PXA25x can only act as USB device. There are drivers 213 * which works with USB CDC gadgets implementations. 214 * Some of them have common routines which can be used 215 * in boards init functions e.g. udc_disconnect() used for 216 * forced device disconnection from host. 217 */ 218 #elif defined(CONFIG_USB_GADGET_PXA2XX) 219 220 extern void udc_disconnect(void); 221 222 #endif 223 224 /* 225 * board-specific hardware initialization, called by 226 * usb drivers and u-boot commands 227 * 228 * @param index USB controller number 229 * @param init initializes controller as USB host or device 230 */ 231 int board_usb_init(int index, enum usb_init_type init); 232 233 /* 234 * can be used to clean up after failed USB initialization attempt 235 * vide: board_usb_init() 236 * 237 * @param index USB controller number for selective cleanup 238 * @param init usb_init_type passed to board_usb_init() 239 */ 240 int board_usb_cleanup(int index, enum usb_init_type init); 241 242 #ifdef CONFIG_USB_STORAGE 243 244 #define USB_MAX_STOR_DEV 5 245 block_dev_desc_t *usb_stor_get_dev(int index); 246 int usb_stor_scan(int mode); 247 int usb_stor_info(void); 248 249 #endif 250 251 #ifdef CONFIG_USB_HOST_ETHER 252 253 #define USB_MAX_ETH_DEV 5 254 int usb_host_eth_scan(int mode); 255 256 #endif 257 258 #ifdef CONFIG_USB_KEYBOARD 259 260 int drv_usb_kbd_init(void); 261 int usb_kbd_deregister(int force); 262 263 #endif 264 /* routines */ 265 int usb_init(void); /* initialize the USB Controller */ 266 int usb_stop(void); /* stop the USB Controller */ 267 268 269 int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol); 270 int usb_set_idle(struct usb_device *dev, int ifnum, int duration, 271 int report_id); 272 int usb_control_msg(struct usb_device *dev, unsigned int pipe, 273 unsigned char request, unsigned char requesttype, 274 unsigned short value, unsigned short index, 275 void *data, unsigned short size, int timeout); 276 int usb_bulk_msg(struct usb_device *dev, unsigned int pipe, 277 void *data, int len, int *actual_length, int timeout); 278 int usb_submit_int_msg(struct usb_device *dev, unsigned long pipe, 279 void *buffer, int transfer_len, int interval); 280 int usb_disable_asynch(int disable); 281 int usb_maxpacket(struct usb_device *dev, unsigned long pipe); 282 int usb_get_configuration_no(struct usb_device *dev, unsigned char *buffer, 283 int cfgno); 284 int usb_get_report(struct usb_device *dev, int ifnum, unsigned char type, 285 unsigned char id, void *buf, int size); 286 int usb_get_class_descriptor(struct usb_device *dev, int ifnum, 287 unsigned char type, unsigned char id, void *buf, 288 int size); 289 int usb_clear_halt(struct usb_device *dev, int pipe); 290 int usb_string(struct usb_device *dev, int index, char *buf, size_t size); 291 int usb_set_interface(struct usb_device *dev, int interface, int alternate); 292 293 /* big endian -> little endian conversion */ 294 /* some CPUs are already little endian e.g. the ARM920T */ 295 #define __swap_16(x) \ 296 ({ unsigned short x_ = (unsigned short)x; \ 297 (unsigned short)( \ 298 ((x_ & 0x00FFU) << 8) | ((x_ & 0xFF00U) >> 8)); \ 299 }) 300 #define __swap_32(x) \ 301 ({ unsigned long x_ = (unsigned long)x; \ 302 (unsigned long)( \ 303 ((x_ & 0x000000FFUL) << 24) | \ 304 ((x_ & 0x0000FF00UL) << 8) | \ 305 ((x_ & 0x00FF0000UL) >> 8) | \ 306 ((x_ & 0xFF000000UL) >> 24)); \ 307 }) 308 309 #ifdef __LITTLE_ENDIAN 310 # define swap_16(x) (x) 311 # define swap_32(x) (x) 312 #else 313 # define swap_16(x) __swap_16(x) 314 # define swap_32(x) __swap_32(x) 315 #endif 316 317 /* 318 * Calling this entity a "pipe" is glorifying it. A USB pipe 319 * is something embarrassingly simple: it basically consists 320 * of the following information: 321 * - device number (7 bits) 322 * - endpoint number (4 bits) 323 * - current Data0/1 state (1 bit) 324 * - direction (1 bit) 325 * - speed (2 bits) 326 * - max packet size (2 bits: 8, 16, 32 or 64) 327 * - pipe type (2 bits: control, interrupt, bulk, isochronous) 328 * 329 * That's 18 bits. Really. Nothing more. And the USB people have 330 * documented these eighteen bits as some kind of glorious 331 * virtual data structure. 332 * 333 * Let's not fall in that trap. We'll just encode it as a simple 334 * unsigned int. The encoding is: 335 * 336 * - max size: bits 0-1 (00 = 8, 01 = 16, 10 = 32, 11 = 64) 337 * - direction: bit 7 (0 = Host-to-Device [Out], 338 * (1 = Device-to-Host [In]) 339 * - device: bits 8-14 340 * - endpoint: bits 15-18 341 * - Data0/1: bit 19 342 * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt, 343 * 10 = control, 11 = bulk) 344 * 345 * Why? Because it's arbitrary, and whatever encoding we select is really 346 * up to us. This one happens to share a lot of bit positions with the UHCI 347 * specification, so that much of the uhci driver can just mask the bits 348 * appropriately. 349 */ 350 /* Create various pipes... */ 351 #define create_pipe(dev,endpoint) \ 352 (((dev)->devnum << 8) | ((endpoint) << 15) | \ 353 (dev)->maxpacketsize) 354 #define default_pipe(dev) ((dev)->speed << 26) 355 356 #define usb_sndctrlpipe(dev, endpoint) ((PIPE_CONTROL << 30) | \ 357 create_pipe(dev, endpoint)) 358 #define usb_rcvctrlpipe(dev, endpoint) ((PIPE_CONTROL << 30) | \ 359 create_pipe(dev, endpoint) | \ 360 USB_DIR_IN) 361 #define usb_sndisocpipe(dev, endpoint) ((PIPE_ISOCHRONOUS << 30) | \ 362 create_pipe(dev, endpoint)) 363 #define usb_rcvisocpipe(dev, endpoint) ((PIPE_ISOCHRONOUS << 30) | \ 364 create_pipe(dev, endpoint) | \ 365 USB_DIR_IN) 366 #define usb_sndbulkpipe(dev, endpoint) ((PIPE_BULK << 30) | \ 367 create_pipe(dev, endpoint)) 368 #define usb_rcvbulkpipe(dev, endpoint) ((PIPE_BULK << 30) | \ 369 create_pipe(dev, endpoint) | \ 370 USB_DIR_IN) 371 #define usb_sndintpipe(dev, endpoint) ((PIPE_INTERRUPT << 30) | \ 372 create_pipe(dev, endpoint)) 373 #define usb_rcvintpipe(dev, endpoint) ((PIPE_INTERRUPT << 30) | \ 374 create_pipe(dev, endpoint) | \ 375 USB_DIR_IN) 376 #define usb_snddefctrl(dev) ((PIPE_CONTROL << 30) | \ 377 default_pipe(dev)) 378 #define usb_rcvdefctrl(dev) ((PIPE_CONTROL << 30) | \ 379 default_pipe(dev) | \ 380 USB_DIR_IN) 381 382 /* The D0/D1 toggle bits */ 383 #define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> ep) & 1) 384 #define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << ep)) 385 #define usb_settoggle(dev, ep, out, bit) ((dev)->toggle[out] = \ 386 ((dev)->toggle[out] & \ 387 ~(1 << ep)) | ((bit) << ep)) 388 389 /* Endpoint halt control/status */ 390 #define usb_endpoint_out(ep_dir) (((ep_dir >> 7) & 1) ^ 1) 391 #define usb_endpoint_halt(dev, ep, out) ((dev)->halted[out] |= (1 << (ep))) 392 #define usb_endpoint_running(dev, ep, out) ((dev)->halted[out] &= ~(1 << (ep))) 393 #define usb_endpoint_halted(dev, ep, out) ((dev)->halted[out] & (1 << (ep))) 394 395 #define usb_packetid(pipe) (((pipe) & USB_DIR_IN) ? USB_PID_IN : \ 396 USB_PID_OUT) 397 398 #define usb_pipeout(pipe) ((((pipe) >> 7) & 1) ^ 1) 399 #define usb_pipein(pipe) (((pipe) >> 7) & 1) 400 #define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f) 401 #define usb_pipe_endpdev(pipe) (((pipe) >> 8) & 0x7ff) 402 #define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf) 403 #define usb_pipedata(pipe) (((pipe) >> 19) & 1) 404 #define usb_pipetype(pipe) (((pipe) >> 30) & 3) 405 #define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS) 406 #define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT) 407 #define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL) 408 #define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK) 409 410 #define usb_pipe_ep_index(pipe) \ 411 usb_pipecontrol(pipe) ? (usb_pipeendpoint(pipe) * 2) : \ 412 ((usb_pipeendpoint(pipe) * 2) - \ 413 (usb_pipein(pipe) ? 0 : 1)) 414 415 /************************************************************************* 416 * Hub Stuff 417 */ 418 struct usb_port_status { 419 unsigned short wPortStatus; 420 unsigned short wPortChange; 421 } __attribute__ ((packed)); 422 423 struct usb_hub_status { 424 unsigned short wHubStatus; 425 unsigned short wHubChange; 426 } __attribute__ ((packed)); 427 428 429 /* Hub descriptor */ 430 struct usb_hub_descriptor { 431 unsigned char bLength; 432 unsigned char bDescriptorType; 433 unsigned char bNbrPorts; 434 unsigned short wHubCharacteristics; 435 unsigned char bPwrOn2PwrGood; 436 unsigned char bHubContrCurrent; 437 unsigned char DeviceRemovable[(USB_MAXCHILDREN+1+7)/8]; 438 unsigned char PortPowerCtrlMask[(USB_MAXCHILDREN+1+7)/8]; 439 /* DeviceRemovable and PortPwrCtrlMask want to be variable-length 440 bitmaps that hold max 255 entries. (bit0 is ignored) */ 441 } __attribute__ ((packed)); 442 443 444 struct usb_hub_device { 445 struct usb_device *pusb_dev; 446 struct usb_hub_descriptor desc; 447 }; 448 449 #ifdef CONFIG_DM_USB 450 /** 451 * struct usb_platdata - Platform data about a USB controller 452 * 453 * Given a USB controller (UCLASS_USB) dev this is dev_get_platdata(dev) 454 */ 455 struct usb_platdata { 456 enum usb_init_type init_type; 457 }; 458 459 /** 460 * struct usb_dev_platdata - Platform data about a USB device 461 * 462 * Given a USB device dev this structure is dev_get_parent_platdata(dev). 463 * This is used by sandbox to provide emulation data also. 464 * 465 * @id: ID used to match this device 466 * @speed: Stores the speed associated with a USB device 467 * @devnum: Device address on the USB bus 468 * @slot_id: USB3 slot ID, which is separate from the device address 469 * @portnr: Port number of this device on its parent hub, numbered from 1 470 * (0 mean this device is the root hub) 471 * @strings: List of descriptor strings (for sandbox emulation purposes) 472 * @desc_list: List of descriptors (for sandbox emulation purposes) 473 */ 474 struct usb_dev_platdata { 475 struct usb_device_id id; 476 enum usb_device_speed speed; 477 int devnum; 478 int slot_id; 479 int portnr; /* Hub port number, 1..n */ 480 #ifdef CONFIG_SANDBOX 481 struct usb_string *strings; 482 /* NULL-terminated list of descriptor pointers */ 483 struct usb_generic_descriptor **desc_list; 484 #endif 485 int configno; 486 }; 487 488 /** 489 * struct usb_bus_priv - information about the USB controller 490 * 491 * Given a USB controller (UCLASS_USB) 'dev', this is 492 * dev_get_uclass_priv(dev). 493 * 494 * @next_addr: Next device address to allocate minus 1. Incremented by 1 495 * each time a new device address is set, so this holds the 496 * number of devices on the bus 497 * @desc_before_addr: true if we can read a device descriptor before it 498 * has been assigned an address. For XHCI this is not possible 499 * so this will be false. 500 */ 501 struct usb_bus_priv { 502 int next_addr; 503 bool desc_before_addr; 504 }; 505 506 /** 507 * struct dm_usb_ops - USB controller operations 508 * 509 * This defines the operations supoorted on a USB controller. Common 510 * arguments are: 511 * 512 * @bus: USB bus (i.e. controller), which is in UCLASS_USB. 513 * @udev: USB device parent data. Controllers are not expected to need 514 * this, since the device address on the bus is encoded in @pipe. 515 * It is used for sandbox, and can be handy for debugging and 516 * logging. 517 * @pipe: An assortment of bitfields which provide address and packet 518 * type information. See create_pipe() above for encoding 519 * details 520 * @buffer: A buffer to use for sending/receiving. This should be 521 * DMA-aligned. 522 * @length: Buffer length in bytes 523 */ 524 struct dm_usb_ops { 525 /** 526 * control() - Send a control message 527 * 528 * Most parameters are as above. 529 * 530 * @setup: Additional setup information required by the message 531 */ 532 int (*control)(struct udevice *bus, struct usb_device *udev, 533 unsigned long pipe, void *buffer, int length, 534 struct devrequest *setup); 535 /** 536 * bulk() - Send a bulk message 537 * 538 * Parameters are as above. 539 */ 540 int (*bulk)(struct udevice *bus, struct usb_device *udev, 541 unsigned long pipe, void *buffer, int length); 542 /** 543 * interrupt() - Send an interrupt message 544 * 545 * Most parameters are as above. 546 * 547 * @interval: Interrupt interval 548 */ 549 int (*interrupt)(struct udevice *bus, struct usb_device *udev, 550 unsigned long pipe, void *buffer, int length, 551 int interval); 552 /** 553 * alloc_device() - Allocate a new device context (XHCI) 554 * 555 * Before sending packets to a new device on an XHCI bus, a device 556 * context must be created. If this method is not NULL it will be 557 * called before the device is enumerated (even before its descriptor 558 * is read). This should be NULL for EHCI, which does not need this. 559 */ 560 int (*alloc_device)(struct udevice *bus, struct usb_device *udev); 561 }; 562 563 #define usb_get_ops(dev) ((struct dm_usb_ops *)(dev)->driver->ops) 564 #define usb_get_emul_ops(dev) ((struct dm_usb_ops *)(dev)->driver->ops) 565 566 #ifdef CONFIG_MUSB_HOST 567 int usb_reset_root_port(void); 568 #endif 569 570 /** 571 * usb_get_dev_index() - look up a device index number 572 * 573 * Look up devices using their index number (starting at 0). This works since 574 * in U-Boot device addresses are allocated starting at 1 with no gaps. 575 * 576 * TODO(sjg@chromium.org): Remove this function when usb_ether.c is modified 577 * to work better with driver model. 578 * 579 * @bus: USB bus to check 580 * @index: Index number of device to find (0=first). This is just the 581 * device address less 1. 582 */ 583 struct usb_device *usb_get_dev_index(struct udevice *bus, int index); 584 585 /** 586 * usb_legacy_port_reset() - Legacy function to reset a hub port 587 * 588 * @hub: Hub device 589 * @portnr: Port number (1=first) 590 */ 591 int usb_legacy_port_reset(struct usb_device *hub, int portnr); 592 593 /** 594 * usb_setup_device() - set up a device ready for use 595 * 596 * @dev: USB device pointer. This need not be a real device - it is 597 * common for it to just be a local variable with its ->dev 598 * member (i.e. @dev->dev) set to the parent device 599 * @do_read: true to read the device descriptor before an address is set 600 * (should be false for XHCI buses, true otherwise) 601 * @parent: Parent device (either UCLASS_USB or UCLASS_USB_HUB) 602 * @portnr: Port number on hub (1=first) or 0 for none 603 * @return 0 if OK, -ve on error */ 604 int usb_setup_device(struct usb_device *dev, bool do_read, 605 struct usb_device *parent, int portnr); 606 607 /** 608 * usb_hub_scan() - Scan a hub and find its devices 609 * 610 * @hub: Hub device to scan 611 */ 612 int usb_hub_scan(struct udevice *hub); 613 614 /** 615 * usb_scan_device() - Scan a device on a bus 616 * 617 * Scan a device on a bus. It has already been detected and is ready to 618 * be enumerated. This may be either the root hub (@parent is a bus) or a 619 * normal device (@parent is a hub) 620 * 621 * @parent: Parent device 622 * @port: Hub port number (numbered from 1) 623 * @speed: USB speed to use for this device 624 * @devp: Returns pointer to device if all is well 625 * @return 0 if OK, -ve on error 626 */ 627 int usb_scan_device(struct udevice *parent, int port, 628 enum usb_device_speed speed, struct udevice **devp); 629 630 /** 631 * usb_get_bus() - Find the bus for a device 632 * 633 * Search up through parents to find the bus this device is connected to. This 634 * will be a device with uclass UCLASS_USB. 635 * 636 * @dev: Device to check 637 * @busp: Returns bus, or NULL if not found 638 * @return 0 if OK, -EXDEV is somehow this bus does not have a controller (this 639 * indicates a critical error in the USB stack 640 */ 641 int usb_get_bus(struct udevice *dev, struct udevice **busp); 642 643 /** 644 * usb_select_config() - Set up a device ready for use 645 * 646 * This function assumes that the device already has an address and a driver 647 * bound, and is ready to be set up. 648 * 649 * This re-reads the device and configuration descriptors and sets the 650 * configuration 651 * 652 * @dev: Device to set up 653 */ 654 int usb_select_config(struct usb_device *dev); 655 656 /** 657 * usb_child_pre_probe() - Pre-probe function for USB devices 658 * 659 * This is called on all children of hubs and USB controllers (i.e. UCLASS_USB 660 * and UCLASS_USB_HUB) when a new device is about to be probed. It sets up the 661 * device from the saved platform data and calls usb_select_config() to 662 * finish set up. 663 * 664 * Once this is done, the device's normal driver can take over, knowing the 665 * device is accessible on the USB bus. 666 * 667 * This function is for use only by the internal USB stack. 668 * 669 * @dev: Device to set up 670 */ 671 int usb_child_pre_probe(struct udevice *dev); 672 673 struct ehci_ctrl; 674 675 /** 676 * usb_setup_ehci_gadget() - Set up a USB device as a gadget 677 * 678 * TODO(sjg@chromium.org): Tidy this up when USB gadgets can use driver model 679 * 680 * This provides a way to tell a controller to start up as a USB device 681 * instead of as a host. It is untested. 682 */ 683 int usb_setup_ehci_gadget(struct ehci_ctrl **ctlrp); 684 685 /** 686 * usb_stor_reset() - Prepare to scan USB storage devices 687 * 688 * Empty the list of USB storage devices in preparation for scanning them. 689 * This must be called before a USB scan. 690 */ 691 void usb_stor_reset(void); 692 693 #else /* !CONFIG_DM_USB */ 694 695 struct usb_device *usb_get_dev_index(int index); 696 697 #endif 698 699 bool usb_device_has_child_on_port(struct usb_device *parent, int port); 700 701 int usb_hub_probe(struct usb_device *dev, int ifnum); 702 void usb_hub_reset(void); 703 704 /** 705 * legacy_hub_port_reset() - reset a port given its usb_device pointer 706 * 707 * Reset a hub port and see if a device is present on that port, providing 708 * sufficient time for it to show itself. The port status is returned. 709 * 710 * With driver model this moves to hub_port_reset() and is passed a struct 711 * udevice. 712 * 713 * @dev: USB device to reset 714 * @port: Port number to reset (note ports are numbered from 0 here) 715 * @portstat: Returns port status 716 */ 717 int legacy_hub_port_reset(struct usb_device *dev, int port, 718 unsigned short *portstat); 719 720 int hub_port_reset(struct udevice *dev, int port, unsigned short *portstat); 721 722 /** 723 * usb_alloc_new_device() - Allocate a new device 724 * 725 * @devp: returns a pointer of a new device structure. With driver model this 726 * is a device pointer, but with legacy USB this pointer is 727 * driver-specific. 728 * @return 0 if OK, -ENOSPC if we have found out of room for new devices 729 */ 730 int usb_alloc_new_device(struct udevice *controller, struct usb_device **devp); 731 732 /** 733 * usb_free_device() - Free a partially-inited device 734 * 735 * This is an internal function. It is used to reverse the action of 736 * usb_alloc_new_device() when we hit a problem during init. 737 */ 738 void usb_free_device(struct udevice *controller); 739 740 int usb_new_device(struct usb_device *dev); 741 742 int usb_alloc_device(struct usb_device *dev); 743 744 #endif /*_USB_H_ */ 745