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