sandbox: usb: Allow finding a USB emulator for a device
[platform/kernel/u-boot.git] / include / usb.h
1 /*
2  * (C) Copyright 2001
3  * Denis Peter, MPL AG Switzerland
4  *
5  * Adapted for U-Boot driver model
6  * (C) Copyright 2015 Google, Inc
7  *
8  * SPDX-License-Identifier:     GPL-2.0+
9  * Note: Part of this code has been derived from linux
10  *
11  */
12 #ifndef _USB_H_
13 #define _USB_H_
14
15 #include <fdtdec.h>
16 #include <usb_defs.h>
17 #include <linux/usb/ch9.h>
18 #include <asm/cache.h>
19 #include <part.h>
20
21 /*
22  * The EHCI spec says that we must align to at least 32 bytes.  However,
23  * some platforms require larger alignment.
24  */
25 #if ARCH_DMA_MINALIGN > 32
26 #define USB_DMA_MINALIGN        ARCH_DMA_MINALIGN
27 #else
28 #define USB_DMA_MINALIGN        32
29 #endif
30
31 /* Everything is aribtrary */
32 #define USB_ALTSETTINGALLOC             4
33 #define USB_MAXALTSETTING               128     /* Hard limit */
34
35 #define USB_MAX_DEVICE                  32
36 #define USB_MAXCONFIG                   8
37 #define USB_MAXINTERFACES               8
38 #define USB_MAXENDPOINTS                16
39 #define USB_MAXCHILDREN                 8       /* This is arbitrary */
40 #define USB_MAX_HUB                     16
41
42 #define USB_CNTL_TIMEOUT 100 /* 100ms timeout */
43
44 /*
45  * This is the timeout to allow for submitting an urb in ms. We allow more
46  * time for a BULK device to react - some are slow.
47  */
48 #define USB_TIMEOUT_MS(pipe) (usb_pipebulk(pipe) ? 5000 : 1000)
49
50 /* device request (setup) */
51 struct devrequest {
52         __u8    requesttype;
53         __u8    request;
54         __le16  value;
55         __le16  index;
56         __le16  length;
57 } __attribute__ ((packed));
58
59 /* Interface */
60 struct usb_interface {
61         struct usb_interface_descriptor desc;
62
63         __u8    no_of_ep;
64         __u8    num_altsetting;
65         __u8    act_altsetting;
66
67         struct usb_endpoint_descriptor ep_desc[USB_MAXENDPOINTS];
68         /*
69          * Super Speed Device will have Super Speed Endpoint
70          * Companion Descriptor  (section 9.6.7 of usb 3.0 spec)
71          * Revision 1.0 June 6th 2011
72          */
73         struct usb_ss_ep_comp_descriptor ss_ep_comp_desc[USB_MAXENDPOINTS];
74 } __attribute__ ((packed));
75
76 /* Configuration information.. */
77 struct usb_config {
78         struct usb_config_descriptor desc;
79
80         __u8    no_of_if;       /* number of interfaces */
81         struct usb_interface if_desc[USB_MAXINTERFACES];
82 } __attribute__ ((packed));
83
84 enum {
85         /* Maximum packet size; encoded as 0,1,2,3 = 8,16,32,64 */
86         PACKET_SIZE_8   = 0,
87         PACKET_SIZE_16  = 1,
88         PACKET_SIZE_32  = 2,
89         PACKET_SIZE_64  = 3,
90 };
91
92 /**
93  * struct usb_device - information about a USB device
94  *
95  * With driver model both UCLASS_USB (the USB controllers) and UCLASS_USB_HUB
96  * (the hubs) have this as parent data. Hubs are children of controllers or
97  * other hubs and there is always a single root hub for each controller.
98  * Therefore struct usb_device can always be accessed with
99  * dev_get_parent_priv(dev), where dev is a USB device.
100  *
101  * Pointers exist for obtaining both the device (could be any uclass) and
102  * controller (UCLASS_USB) from this structure. The controller does not have
103  * a struct usb_device since it is not a device.
104  */
105 struct usb_device {
106         int     devnum;                 /* Device number on USB bus */
107         int     speed;                  /* full/low/high */
108         char    mf[32];                 /* manufacturer */
109         char    prod[32];               /* product */
110         char    serial[32];             /* serial number */
111
112         /* Maximum packet size; one of: PACKET_SIZE_* */
113         int maxpacketsize;
114         /* one bit for each endpoint ([0] = IN, [1] = OUT) */
115         unsigned int toggle[2];
116         /* endpoint halts; one bit per endpoint # & direction;
117          * [0] = IN, [1] = OUT
118          */
119         unsigned int halted[2];
120         int epmaxpacketin[16];          /* INput endpoint specific maximums */
121         int epmaxpacketout[16];         /* OUTput endpoint specific maximums */
122
123         int configno;                   /* selected config number */
124         /* Device Descriptor */
125         struct usb_device_descriptor descriptor
126                 __attribute__((aligned(ARCH_DMA_MINALIGN)));
127         struct usb_config config; /* config descriptor */
128
129         int have_langid;                /* whether string_langid is valid yet */
130         int string_langid;              /* language ID for strings */
131         int (*irq_handle)(struct usb_device *dev);
132         unsigned long irq_status;
133         int irq_act_len;                /* 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 int usb_lowlevel_init(int index, enum usb_init_type init, void **controller);
175 int usb_lowlevel_stop(int index);
176
177 #if defined(CONFIG_USB_MUSB_HOST) || defined(CONFIG_DM_USB)
178 int usb_reset_root_port(struct usb_device *dev);
179 #else
180 #define usb_reset_root_port(dev)
181 #endif
182
183 int submit_bulk_msg(struct usb_device *dev, unsigned long pipe,
184                         void *buffer, int transfer_len);
185 int submit_control_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
186                         int transfer_len, struct devrequest *setup);
187 int submit_int_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
188                         int transfer_len, int interval);
189
190 #if defined CONFIG_USB_EHCI || defined CONFIG_USB_MUSB_HOST || defined(CONFIG_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 5
231 block_dev_desc_t *usb_stor_get_dev(int index);
232 int usb_stor_scan(int mode);
233 int usb_stor_info(void);
234
235 #endif
236
237 #ifdef CONFIG_USB_HOST_ETHER
238
239 #define USB_MAX_ETH_DEV 5
240 int usb_host_eth_scan(int mode);
241
242 #endif
243
244 #ifdef CONFIG_USB_KEYBOARD
245
246 int drv_usb_kbd_init(void);
247 int usb_kbd_deregister(int force);
248
249 #endif
250 /* routines */
251 int usb_init(void); /* initialize the USB Controller */
252 int usb_stop(void); /* stop the USB Controller */
253 int usb_detect_change(void); /* detect if a USB device has been (un)plugged */
254
255
256 int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol);
257 int usb_set_idle(struct usb_device *dev, int ifnum, int duration,
258                         int report_id);
259 int usb_control_msg(struct usb_device *dev, unsigned int pipe,
260                         unsigned char request, unsigned char requesttype,
261                         unsigned short value, unsigned short index,
262                         void *data, unsigned short size, int timeout);
263 int usb_bulk_msg(struct usb_device *dev, unsigned int pipe,
264                         void *data, int len, int *actual_length, int timeout);
265 int usb_submit_int_msg(struct usb_device *dev, unsigned long pipe,
266                         void *buffer, int transfer_len, int interval);
267 int usb_disable_asynch(int disable);
268 int usb_maxpacket(struct usb_device *dev, unsigned long pipe);
269 int usb_get_configuration_no(struct usb_device *dev, unsigned char *buffer,
270                                 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 descriptor */
541 struct usb_hub_descriptor {
542         unsigned char  bLength;
543         unsigned char  bDescriptorType;
544         unsigned char  bNbrPorts;
545         unsigned short wHubCharacteristics;
546         unsigned char  bPwrOn2PwrGood;
547         unsigned char  bHubContrCurrent;
548         unsigned char  DeviceRemovable[(USB_MAXCHILDREN+1+7)/8];
549         unsigned char  PortPowerCtrlMask[(USB_MAXCHILDREN+1+7)/8];
550         /* DeviceRemovable and PortPwrCtrlMask want to be variable-length
551            bitmaps that hold max 255 entries. (bit0 is ignored) */
552 } __attribute__ ((packed));
553
554
555 struct usb_hub_device {
556         struct usb_device *pusb_dev;
557         struct usb_hub_descriptor desc;
558 };
559
560 #ifdef CONFIG_DM_USB
561 /**
562  * struct usb_platdata - Platform data about a USB controller
563  *
564  * Given a USB controller (UCLASS_USB) dev this is dev_get_platdata(dev)
565  */
566 struct usb_platdata {
567         enum usb_init_type init_type;
568 };
569
570 /**
571  * struct usb_dev_platdata - Platform data about a USB device
572  *
573  * Given a USB device dev this structure is dev_get_parent_platdata(dev).
574  * This is used by sandbox to provide emulation data also.
575  *
576  * @id:         ID used to match this device
577  * @devnum:     Device address on the USB bus
578  * @udev:       usb-uclass internal use only do NOT use
579  * @strings:    List of descriptor strings (for sandbox emulation purposes)
580  * @desc_list:  List of descriptors (for sandbox emulation purposes)
581  */
582 struct usb_dev_platdata {
583         struct usb_device_id id;
584         int devnum;
585         /*
586          * This pointer is used to pass the usb_device used in usb_scan_device,
587          * to get the usb descriptors before the driver is known, to the
588          * actual udevice once the driver is known and the udevice is created.
589          * This will be NULL except during probe, do NOT use.
590          *
591          * This should eventually go away.
592          */
593         struct usb_device *udev;
594 #ifdef CONFIG_SANDBOX
595         struct usb_string *strings;
596         /* NULL-terminated list of descriptor pointers */
597         struct usb_generic_descriptor **desc_list;
598 #endif
599         int configno;
600 };
601
602 /**
603  * struct usb_bus_priv - information about the USB controller
604  *
605  * Given a USB controller (UCLASS_USB) 'dev', this is
606  * dev_get_uclass_priv(dev).
607  *
608  * @next_addr:  Next device address to allocate minus 1. Incremented by 1
609  *              each time a new device address is set, so this holds the
610  *              number of devices on the bus
611  * @desc_before_addr:   true if we can read a device descriptor before it
612  *              has been assigned an address. For XHCI this is not possible
613  *              so this will be false.
614  * @companion:  True if this is a companion controller to another USB
615  *              controller
616  */
617 struct usb_bus_priv {
618         int next_addr;
619         bool desc_before_addr;
620         bool companion;
621 };
622
623 /**
624  * struct dm_usb_ops - USB controller operations
625  *
626  * This defines the operations supoorted on a USB controller. Common
627  * arguments are:
628  *
629  * @bus:        USB bus (i.e. controller), which is in UCLASS_USB.
630  * @udev:       USB device parent data. Controllers are not expected to need
631  *              this, since the device address on the bus is encoded in @pipe.
632  *              It is used for sandbox, and can be handy for debugging and
633  *              logging.
634  * @pipe:       An assortment of bitfields which provide address and packet
635  *              type information. See create_pipe() above for encoding
636  *              details
637  * @buffer:     A buffer to use for sending/receiving. This should be
638  *              DMA-aligned.
639  * @length:     Buffer length in bytes
640  */
641 struct dm_usb_ops {
642         /**
643          * control() - Send a control message
644          *
645          * Most parameters are as above.
646          *
647          * @setup: Additional setup information required by the message
648          */
649         int (*control)(struct udevice *bus, struct usb_device *udev,
650                        unsigned long pipe, void *buffer, int length,
651                        struct devrequest *setup);
652         /**
653          * bulk() - Send a bulk message
654          *
655          * Parameters are as above.
656          */
657         int (*bulk)(struct udevice *bus, struct usb_device *udev,
658                     unsigned long pipe, void *buffer, int length);
659         /**
660          * interrupt() - Send an interrupt message
661          *
662          * Most parameters are as above.
663          *
664          * @interval: Interrupt interval
665          */
666         int (*interrupt)(struct udevice *bus, struct usb_device *udev,
667                          unsigned long pipe, void *buffer, int length,
668                          int interval);
669
670         /**
671          * create_int_queue() - Create and queue interrupt packets
672          *
673          * Create and queue @queuesize number of interrupt usb packets of
674          * @elementsize bytes each. @buffer must be atleast @queuesize *
675          * @elementsize bytes.
676          *
677          * Note some controllers only support a queuesize of 1.
678          *
679          * @interval: Interrupt interval
680          *
681          * @return A pointer to the created interrupt queue or NULL on error
682          */
683         struct int_queue * (*create_int_queue)(struct udevice *bus,
684                                 struct usb_device *udev, unsigned long pipe,
685                                 int queuesize, int elementsize, void *buffer,
686                                 int interval);
687
688         /**
689          * poll_int_queue() - Poll an interrupt queue for completed packets
690          *
691          * Poll an interrupt queue for completed packets. The return value
692          * points to the part of the buffer passed to create_int_queue()
693          * corresponding to the completed packet.
694          *
695          * @queue: queue to poll
696          *
697          * @return Pointer to the data of the first completed packet, or
698          *         NULL if no packets are ready
699          */
700         void * (*poll_int_queue)(struct udevice *bus, struct usb_device *udev,
701                                  struct int_queue *queue);
702
703         /**
704          * destroy_int_queue() - Destroy an interrupt queue
705          *
706          * Destroy an interrupt queue created by create_int_queue().
707          *
708          * @queue: queue to poll
709          *
710          * @return 0 if OK, -ve on error
711          */
712         int (*destroy_int_queue)(struct udevice *bus, struct usb_device *udev,
713                                  struct int_queue *queue);
714
715         /**
716          * alloc_device() - Allocate a new device context (XHCI)
717          *
718          * Before sending packets to a new device on an XHCI bus, a device
719          * context must be created. If this method is not NULL it will be
720          * called before the device is enumerated (even before its descriptor
721          * is read). This should be NULL for EHCI, which does not need this.
722          */
723         int (*alloc_device)(struct udevice *bus, struct usb_device *udev);
724
725         /**
726          * reset_root_port() - Reset usb root port
727          */
728         int (*reset_root_port)(struct udevice *bus, struct usb_device *udev);
729 };
730
731 #define usb_get_ops(dev)        ((struct dm_usb_ops *)(dev)->driver->ops)
732 #define usb_get_emul_ops(dev)   ((struct dm_usb_ops *)(dev)->driver->ops)
733
734 /**
735  * usb_get_dev_index() - look up a device index number
736  *
737  * Look up devices using their index number (starting at 0). This works since
738  * in U-Boot device addresses are allocated starting at 1 with no gaps.
739  *
740  * TODO(sjg@chromium.org): Remove this function when usb_ether.c is modified
741  * to work better with driver model.
742  *
743  * @bus:        USB bus to check
744  * @index:      Index number of device to find (0=first). This is just the
745  *              device address less 1.
746  */
747 struct usb_device *usb_get_dev_index(struct udevice *bus, int index);
748
749 /**
750  * usb_setup_device() - set up a device ready for use
751  *
752  * @dev:        USB device pointer. This need not be a real device - it is
753  *              common for it to just be a local variable with its ->dev
754  *              member (i.e. @dev->dev) set to the parent device and
755  *              dev->portnr set to the port number on the hub (1=first)
756  * @do_read:    true to read the device descriptor before an address is set
757  *              (should be false for XHCI buses, true otherwise)
758  * @parent:     Parent device (either UCLASS_USB or UCLASS_USB_HUB)
759  * @return 0 if OK, -ve on error */
760 int usb_setup_device(struct usb_device *dev, bool do_read,
761                      struct usb_device *parent);
762
763 /**
764  * usb_hub_scan() - Scan a hub and find its devices
765  *
766  * @hub:        Hub device to scan
767  */
768 int usb_hub_scan(struct udevice *hub);
769
770 /**
771  * usb_scan_device() - Scan a device on a bus
772  *
773  * Scan a device on a bus. It has already been detected and is ready to
774  * be enumerated. This may be either the root hub (@parent is a bus) or a
775  * normal device (@parent is a hub)
776  *
777  * @parent:     Parent device
778  * @port:       Hub port number (numbered from 1)
779  * @speed:      USB speed to use for this device
780  * @devp:       Returns pointer to device if all is well
781  * @return 0 if OK, -ve on error
782  */
783 int usb_scan_device(struct udevice *parent, int port,
784                     enum usb_device_speed speed, struct udevice **devp);
785
786 /**
787  * usb_get_bus() - Find the bus for a device
788  *
789  * Search up through parents to find the bus this device is connected to. This
790  * will be a device with uclass UCLASS_USB.
791  *
792  * @dev:        Device to check
793  * @return The bus, or NULL if not found (this indicates a critical error in
794  *      the USB stack
795  */
796 struct udevice *usb_get_bus(struct udevice *dev);
797
798 /**
799  * usb_select_config() - Set up a device ready for use
800  *
801  * This function assumes that the device already has an address and a driver
802  * bound, and is ready to be set up.
803  *
804  * This re-reads the device and configuration descriptors and sets the
805  * configuration
806  *
807  * @dev:        Device to set up
808  */
809 int usb_select_config(struct usb_device *dev);
810
811 /**
812  * usb_child_pre_probe() - Pre-probe function for USB devices
813  *
814  * This is called on all children of hubs and USB controllers (i.e. UCLASS_USB
815  * and UCLASS_USB_HUB) when a new device is about to be probed. It sets up the
816  * device from the saved platform data and calls usb_select_config() to
817  * finish set up.
818  *
819  * Once this is done, the device's normal driver can take over, knowing the
820  * device is accessible on the USB bus.
821  *
822  * This function is for use only by the internal USB stack.
823  *
824  * @dev:        Device to set up
825  */
826 int usb_child_pre_probe(struct udevice *dev);
827
828 struct ehci_ctrl;
829
830 /**
831  * usb_setup_ehci_gadget() - Set up a USB device as a gadget
832  *
833  * TODO(sjg@chromium.org): Tidy this up when USB gadgets can use driver model
834  *
835  * This provides a way to tell a controller to start up as a USB device
836  * instead of as a host. It is untested.
837  */
838 int usb_setup_ehci_gadget(struct ehci_ctrl **ctlrp);
839
840 /**
841  * usb_stor_reset() - Prepare to scan USB storage devices
842  *
843  * Empty the list of USB storage devices in preparation for scanning them.
844  * This must be called before a USB scan.
845  */
846 void usb_stor_reset(void);
847
848 #else /* !CONFIG_DM_USB */
849
850 struct usb_device *usb_get_dev_index(int index);
851
852 #endif
853
854 bool usb_device_has_child_on_port(struct usb_device *parent, int port);
855
856 int usb_hub_probe(struct usb_device *dev, int ifnum);
857 void usb_hub_reset(void);
858
859 /**
860  * legacy_hub_port_reset() - reset a port given its usb_device pointer
861  *
862  * Reset a hub port and see if a device is present on that port, providing
863  * sufficient time for it to show itself. The port status is returned.
864  *
865  * With driver model this moves to hub_port_reset() and is passed a struct
866  * udevice.
867  *
868  * @dev:        USB device to reset
869  * @port:       Port number to reset (note ports are numbered from 0 here)
870  * @portstat:   Returns port status
871  */
872 int legacy_hub_port_reset(struct usb_device *dev, int port,
873                           unsigned short *portstat);
874
875 int hub_port_reset(struct udevice *dev, int port, unsigned short *portstat);
876
877 /**
878  * usb_alloc_new_device() - Allocate a new device
879  *
880  * @devp: returns a pointer of a new device structure. With driver model this
881  *              is a device pointer, but with legacy USB this pointer is
882  *              driver-specific.
883  * @return 0 if OK, -ENOSPC if we have found out of room for new devices
884  */
885 int usb_alloc_new_device(struct udevice *controller, struct usb_device **devp);
886
887 /**
888  * usb_free_device() - Free a partially-inited device
889  *
890  * This is an internal function. It is used to reverse the action of
891  * usb_alloc_new_device() when we hit a problem during init.
892  */
893 void usb_free_device(struct udevice *controller);
894
895 int usb_new_device(struct usb_device *dev);
896
897 int usb_alloc_device(struct usb_device *dev);
898
899 /**
900  * usb_emul_setup_device() - Set up a new USB device emulation
901  *
902  * This is normally called when a new emulation device is bound. It tells
903  * the USB emulation uclass about the features of the emulator.
904  *
905  * @dev:                Emulation device
906  * @maxpacketsize:      Maximum packet size (e.g. PACKET_SIZE_64)
907  * @strings:            List of USB string descriptors, terminated by a NULL
908  *                      entry
909  * @desc_list:          List of points or USB descriptors, terminated by NULL.
910  *                      The first entry must be struct usb_device_descriptor,
911  *                      and others follow on after that.
912  * @return 0 if OK, -ve on error
913  */
914 int usb_emul_setup_device(struct udevice *dev, int maxpacketsize,
915                           struct usb_string *strings, void **desc_list);
916
917 /**
918  * usb_emul_control() - Send a control packet to an emulator
919  *
920  * @emul:       Emulator device
921  * @udev:       USB device (which the emulator is causing to appear)
922  * See struct dm_usb_ops for details on other parameters
923  * @return 0 if OK, -ve on error
924  */
925 int usb_emul_control(struct udevice *emul, struct usb_device *udev,
926                      unsigned long pipe, void *buffer, int length,
927                      struct devrequest *setup);
928
929 /**
930  * usb_emul_bulk() - Send a bulk packet to an emulator
931  *
932  * @emul:       Emulator device
933  * @udev:       USB device (which the emulator is causing to appear)
934  * See struct dm_usb_ops for details on other parameters
935  * @return 0 if OK, -ve on error
936  */
937 int usb_emul_bulk(struct udevice *emul, struct usb_device *udev,
938                   unsigned long pipe, void *buffer, int length);
939
940 /**
941  * usb_emul_find() - Find an emulator for a particular device
942  *
943  * Check @pipe to find a device number on bus @bus and return it.
944  *
945  * @bus:        USB bus (controller)
946  * @pipe:       Describes pipe being used, and includes the device number
947  * @emulp:      Returns pointer to emulator, or NULL if not found
948  * @return 0 if found, -ve on error
949  */
950 int usb_emul_find(struct udevice *bus, ulong pipe, struct udevice **emulp);
951
952 /**
953  * usb_emul_find_for_dev() - Find an emulator for a particular device
954  *
955  * @bus:        USB bus (controller)
956  * @dev:        USB device to check
957  * @emulp:      Returns pointer to emulator, or NULL if not found
958  * @return 0 if found, -ve on error
959  */
960 int usb_emul_find_for_dev(struct udevice *dev, struct udevice **emulp);
961
962 /**
963  * usb_emul_reset() - Reset all emulators ready for use
964  *
965  * Clear out any address information in the emulators and make then ready for
966  * a new USB scan
967  */
968 void usb_emul_reset(struct udevice *dev);
969
970 /**
971  * usb_show_tree() - show the USB device tree
972  *
973  * This shows a list of active USB devices along with basic information about
974  * each.
975  */
976 void usb_show_tree(void);
977
978 #endif /*_USB_H_ */