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