xref: /openbmc/u-boot/include/usb.h (revision 174245b9)
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;		/* transferred 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;			/* transferred 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 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_submit_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 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 	ulong connect_timeout;		/* Device connection timeout in ms */
560 	ulong query_delay;		/* Device query delay in ms */
561 	int overcurrent_count[USB_MAXCHILDREN];	/* Over-current counter */
562 };
563 
564 #ifdef CONFIG_DM_USB
565 /**
566  * struct usb_platdata - Platform data about a USB controller
567  *
568  * Given a USB controller (UCLASS_USB) dev this is dev_get_platdata(dev)
569  */
570 struct usb_platdata {
571 	enum usb_init_type init_type;
572 };
573 
574 /**
575  * struct usb_dev_platdata - Platform data about a USB device
576  *
577  * Given a USB device dev this structure is dev_get_parent_platdata(dev).
578  * This is used by sandbox to provide emulation data also.
579  *
580  * @id:		ID used to match this device
581  * @devnum:	Device address on the USB bus
582  * @udev:	usb-uclass internal use only do NOT use
583  * @strings:	List of descriptor strings (for sandbox emulation purposes)
584  * @desc_list:	List of descriptors (for sandbox emulation purposes)
585  */
586 struct usb_dev_platdata {
587 	struct usb_device_id id;
588 	int devnum;
589 	/*
590 	 * This pointer is used to pass the usb_device used in usb_scan_device,
591 	 * to get the usb descriptors before the driver is known, to the
592 	 * actual udevice once the driver is known and the udevice is created.
593 	 * This will be NULL except during probe, do NOT use.
594 	 *
595 	 * This should eventually go away.
596 	 */
597 	struct usb_device *udev;
598 #ifdef CONFIG_SANDBOX
599 	struct usb_string *strings;
600 	/* NULL-terminated list of descriptor pointers */
601 	struct usb_generic_descriptor **desc_list;
602 #endif
603 	int configno;
604 };
605 
606 /**
607  * struct usb_bus_priv - information about the USB controller
608  *
609  * Given a USB controller (UCLASS_USB) 'dev', this is
610  * dev_get_uclass_priv(dev).
611  *
612  * @next_addr:	Next device address to allocate minus 1. Incremented by 1
613  *		each time a new device address is set, so this holds the
614  *		number of devices on the bus
615  * @desc_before_addr:	true if we can read a device descriptor before it
616  *		has been assigned an address. For XHCI this is not possible
617  *		so this will be false.
618  * @companion:  True if this is a companion controller to another USB
619  *		controller
620  */
621 struct usb_bus_priv {
622 	int next_addr;
623 	bool desc_before_addr;
624 	bool companion;
625 };
626 
627 /**
628  * struct dm_usb_ops - USB controller operations
629  *
630  * This defines the operations supoorted on a USB controller. Common
631  * arguments are:
632  *
633  * @bus:	USB bus (i.e. controller), which is in UCLASS_USB.
634  * @udev:	USB device parent data. Controllers are not expected to need
635  *		this, since the device address on the bus is encoded in @pipe.
636  *		It is used for sandbox, and can be handy for debugging and
637  *		logging.
638  * @pipe:	An assortment of bitfields which provide address and packet
639  *		type information. See create_pipe() above for encoding
640  *		details
641  * @buffer:	A buffer to use for sending/receiving. This should be
642  *		DMA-aligned.
643  * @length:	Buffer length in bytes
644  */
645 struct dm_usb_ops {
646 	/**
647 	 * control() - Send a control message
648 	 *
649 	 * Most parameters are as above.
650 	 *
651 	 * @setup: Additional setup information required by the message
652 	 */
653 	int (*control)(struct udevice *bus, struct usb_device *udev,
654 		       unsigned long pipe, void *buffer, int length,
655 		       struct devrequest *setup);
656 	/**
657 	 * bulk() - Send a bulk message
658 	 *
659 	 * Parameters are as above.
660 	 */
661 	int (*bulk)(struct udevice *bus, struct usb_device *udev,
662 		    unsigned long pipe, void *buffer, int length);
663 	/**
664 	 * interrupt() - Send an interrupt message
665 	 *
666 	 * Most parameters are as above.
667 	 *
668 	 * @interval: Interrupt interval
669 	 */
670 	int (*interrupt)(struct udevice *bus, struct usb_device *udev,
671 			 unsigned long pipe, void *buffer, int length,
672 			 int interval);
673 
674 	/**
675 	 * create_int_queue() - Create and queue interrupt packets
676 	 *
677 	 * Create and queue @queuesize number of interrupt usb packets of
678 	 * @elementsize bytes each. @buffer must be atleast @queuesize *
679 	 * @elementsize bytes.
680 	 *
681 	 * Note some controllers only support a queuesize of 1.
682 	 *
683 	 * @interval: Interrupt interval
684 	 *
685 	 * @return A pointer to the created interrupt queue or NULL on error
686 	 */
687 	struct int_queue * (*create_int_queue)(struct udevice *bus,
688 				struct usb_device *udev, unsigned long pipe,
689 				int queuesize, int elementsize, void *buffer,
690 				int interval);
691 
692 	/**
693 	 * poll_int_queue() - Poll an interrupt queue for completed packets
694 	 *
695 	 * Poll an interrupt queue for completed packets. The return value
696 	 * points to the part of the buffer passed to create_int_queue()
697 	 * corresponding to the completed packet.
698 	 *
699 	 * @queue: queue to poll
700 	 *
701 	 * @return Pointer to the data of the first completed packet, or
702 	 *         NULL if no packets are ready
703 	 */
704 	void * (*poll_int_queue)(struct udevice *bus, struct usb_device *udev,
705 				 struct int_queue *queue);
706 
707 	/**
708 	 * destroy_int_queue() - Destroy an interrupt queue
709 	 *
710 	 * Destroy an interrupt queue created by create_int_queue().
711 	 *
712 	 * @queue: queue to poll
713 	 *
714 	 * @return 0 if OK, -ve on error
715 	 */
716 	int (*destroy_int_queue)(struct udevice *bus, struct usb_device *udev,
717 				 struct int_queue *queue);
718 
719 	/**
720 	 * alloc_device() - Allocate a new device context (XHCI)
721 	 *
722 	 * Before sending packets to a new device on an XHCI bus, a device
723 	 * context must be created. If this method is not NULL it will be
724 	 * called before the device is enumerated (even before its descriptor
725 	 * is read). This should be NULL for EHCI, which does not need this.
726 	 */
727 	int (*alloc_device)(struct udevice *bus, struct usb_device *udev);
728 
729 	/**
730 	 * reset_root_port() - Reset usb root port
731 	 */
732 	int (*reset_root_port)(struct udevice *bus, struct usb_device *udev);
733 };
734 
735 #define usb_get_ops(dev)	((struct dm_usb_ops *)(dev)->driver->ops)
736 #define usb_get_emul_ops(dev)	((struct dm_usb_ops *)(dev)->driver->ops)
737 
738 /**
739  * usb_get_dev_index() - look up a device index number
740  *
741  * Look up devices using their index number (starting at 0). This works since
742  * in U-Boot device addresses are allocated starting at 1 with no gaps.
743  *
744  * TODO(sjg@chromium.org): Remove this function when usb_ether.c is modified
745  * to work better with driver model.
746  *
747  * @bus:	USB bus to check
748  * @index:	Index number of device to find (0=first). This is just the
749  *		device address less 1.
750  */
751 struct usb_device *usb_get_dev_index(struct udevice *bus, int index);
752 
753 /**
754  * usb_setup_device() - set up a device ready for use
755  *
756  * @dev:	USB device pointer. This need not be a real device - it is
757  *		common for it to just be a local variable with its ->dev
758  *		member (i.e. @dev->dev) set to the parent device and
759  *		dev->portnr set to the port number on the hub (1=first)
760  * @do_read:	true to read the device descriptor before an address is set
761  *		(should be false for XHCI buses, true otherwise)
762  * @parent:	Parent device (either UCLASS_USB or UCLASS_USB_HUB)
763  * @return 0 if OK, -ve on error */
764 int usb_setup_device(struct usb_device *dev, bool do_read,
765 		     struct usb_device *parent);
766 
767 /**
768  * usb_hub_scan() - Scan a hub and find its devices
769  *
770  * @hub:	Hub device to scan
771  */
772 int usb_hub_scan(struct udevice *hub);
773 
774 /**
775  * usb_scan_device() - Scan a device on a bus
776  *
777  * Scan a device on a bus. It has already been detected and is ready to
778  * be enumerated. This may be either the root hub (@parent is a bus) or a
779  * normal device (@parent is a hub)
780  *
781  * @parent:	Parent device
782  * @port:	Hub port number (numbered from 1)
783  * @speed:	USB speed to use for this device
784  * @devp:	Returns pointer to device if all is well
785  * @return 0 if OK, -ve on error
786  */
787 int usb_scan_device(struct udevice *parent, int port,
788 		    enum usb_device_speed speed, struct udevice **devp);
789 
790 /**
791  * usb_get_bus() - Find the bus for a device
792  *
793  * Search up through parents to find the bus this device is connected to. This
794  * will be a device with uclass UCLASS_USB.
795  *
796  * @dev:	Device to check
797  * @return The bus, or NULL if not found (this indicates a critical error in
798  *	the USB stack
799  */
800 struct udevice *usb_get_bus(struct udevice *dev);
801 
802 /**
803  * usb_select_config() - Set up a device ready for use
804  *
805  * This function assumes that the device already has an address and a driver
806  * bound, and is ready to be set up.
807  *
808  * This re-reads the device and configuration descriptors and sets the
809  * configuration
810  *
811  * @dev:	Device to set up
812  */
813 int usb_select_config(struct usb_device *dev);
814 
815 /**
816  * usb_child_pre_probe() - Pre-probe function for USB devices
817  *
818  * This is called on all children of hubs and USB controllers (i.e. UCLASS_USB
819  * and UCLASS_USB_HUB) when a new device is about to be probed. It sets up the
820  * device from the saved platform data and calls usb_select_config() to
821  * finish set up.
822  *
823  * Once this is done, the device's normal driver can take over, knowing the
824  * device is accessible on the USB bus.
825  *
826  * This function is for use only by the internal USB stack.
827  *
828  * @dev:	Device to set up
829  */
830 int usb_child_pre_probe(struct udevice *dev);
831 
832 struct ehci_ctrl;
833 
834 /**
835  * usb_setup_ehci_gadget() - Set up a USB device as a gadget
836  *
837  * TODO(sjg@chromium.org): Tidy this up when USB gadgets can use driver model
838  *
839  * This provides a way to tell a controller to start up as a USB device
840  * instead of as a host. It is untested.
841  */
842 int usb_setup_ehci_gadget(struct ehci_ctrl **ctlrp);
843 
844 /**
845  * usb_stor_reset() - Prepare to scan USB storage devices
846  *
847  * Empty the list of USB storage devices in preparation for scanning them.
848  * This must be called before a USB scan.
849  */
850 void usb_stor_reset(void);
851 
852 #else /* !CONFIG_DM_USB */
853 
854 struct usb_device *usb_get_dev_index(int index);
855 
856 #endif
857 
858 bool usb_device_has_child_on_port(struct usb_device *parent, int port);
859 
860 int usb_hub_probe(struct usb_device *dev, int ifnum);
861 void usb_hub_reset(void);
862 
863 /**
864  * legacy_hub_port_reset() - reset a port given its usb_device pointer
865  *
866  * Reset a hub port and see if a device is present on that port, providing
867  * sufficient time for it to show itself. The port status is returned.
868  *
869  * With driver model this moves to hub_port_reset() and is passed a struct
870  * udevice.
871  *
872  * @dev:	USB device to reset
873  * @port:	Port number to reset (note ports are numbered from 0 here)
874  * @portstat:	Returns port status
875  */
876 int legacy_hub_port_reset(struct usb_device *dev, int port,
877 			  unsigned short *portstat);
878 
879 int hub_port_reset(struct udevice *dev, int port, unsigned short *portstat);
880 
881 /*
882  * usb_find_usb2_hub_address_port() - Get hub address and port for TT setting
883  *
884  * Searches for the first HS hub above the given device. If a
885  * HS hub is found, the hub address and the port the device is
886  * connected to is return, as required for SPLIT transactions
887  *
888  * @param: udev full speed or low speed device
889  */
890 void usb_find_usb2_hub_address_port(struct usb_device *udev,
891 				    uint8_t *hub_address, uint8_t *hub_port);
892 
893 /**
894  * usb_alloc_new_device() - Allocate a new device
895  *
896  * @devp: returns a pointer of a new device structure. With driver model this
897  *		is a device pointer, but with legacy USB this pointer is
898  *		driver-specific.
899  * @return 0 if OK, -ENOSPC if we have found out of room for new devices
900  */
901 int usb_alloc_new_device(struct udevice *controller, struct usb_device **devp);
902 
903 /**
904  * usb_free_device() - Free a partially-inited device
905  *
906  * This is an internal function. It is used to reverse the action of
907  * usb_alloc_new_device() when we hit a problem during init.
908  */
909 void usb_free_device(struct udevice *controller);
910 
911 int usb_new_device(struct usb_device *dev);
912 
913 int usb_alloc_device(struct usb_device *dev);
914 
915 /**
916  * usb_emul_setup_device() - Set up a new USB device emulation
917  *
918  * This is normally called when a new emulation device is bound. It tells
919  * the USB emulation uclass about the features of the emulator.
920  *
921  * @dev:		Emulation device
922  * @maxpacketsize:	Maximum packet size (e.g. PACKET_SIZE_64)
923  * @strings:		List of USB string descriptors, terminated by a NULL
924  *			entry
925  * @desc_list:		List of points or USB descriptors, terminated by NULL.
926  *			The first entry must be struct usb_device_descriptor,
927  *			and others follow on after that.
928  * @return 0 if OK, -ve on error
929  */
930 int usb_emul_setup_device(struct udevice *dev, int maxpacketsize,
931 			  struct usb_string *strings, void **desc_list);
932 
933 /**
934  * usb_emul_control() - Send a control packet to an emulator
935  *
936  * @emul:	Emulator device
937  * @udev:	USB device (which the emulator is causing to appear)
938  * See struct dm_usb_ops for details on other parameters
939  * @return 0 if OK, -ve on error
940  */
941 int usb_emul_control(struct udevice *emul, struct usb_device *udev,
942 		     unsigned long pipe, void *buffer, int length,
943 		     struct devrequest *setup);
944 
945 /**
946  * usb_emul_bulk() - Send a bulk packet to an emulator
947  *
948  * @emul:	Emulator device
949  * @udev:	USB device (which the emulator is causing to appear)
950  * See struct dm_usb_ops for details on other parameters
951  * @return 0 if OK, -ve on error
952  */
953 int usb_emul_bulk(struct udevice *emul, struct usb_device *udev,
954 		  unsigned long pipe, void *buffer, int length);
955 
956 /**
957  * usb_emul_int() - Send an interrupt packet to an emulator
958  *
959  * @emul:	Emulator device
960  * @udev:	USB device (which the emulator is causing to appear)
961  * See struct dm_usb_ops for details on other parameters
962  * @return 0 if OK, -ve on error
963  */
964 int usb_emul_int(struct udevice *emul, struct usb_device *udev,
965 		  unsigned long pipe, void *buffer, int length, int interval);
966 
967 /**
968  * usb_emul_find() - Find an emulator for a particular device
969  *
970  * Check @pipe to find a device number on bus @bus and return it.
971  *
972  * @bus:	USB bus (controller)
973  * @pipe:	Describes pipe being used, and includes the device number
974  * @emulp:	Returns pointer to emulator, or NULL if not found
975  * @return 0 if found, -ve on error
976  */
977 int usb_emul_find(struct udevice *bus, ulong pipe, struct udevice **emulp);
978 
979 /**
980  * usb_emul_find_for_dev() - Find an emulator for a particular device
981  *
982  * @bus:	USB bus (controller)
983  * @dev:	USB device to check
984  * @emulp:	Returns pointer to emulator, or NULL if not found
985  * @return 0 if found, -ve on error
986  */
987 int usb_emul_find_for_dev(struct udevice *dev, struct udevice **emulp);
988 
989 /**
990  * usb_emul_reset() - Reset all emulators ready for use
991  *
992  * Clear out any address information in the emulators and make then ready for
993  * a new USB scan
994  */
995 void usb_emul_reset(struct udevice *dev);
996 
997 /**
998  * usb_show_tree() - show the USB device tree
999  *
1000  * This shows a list of active USB devices along with basic information about
1001  * each.
1002  */
1003 void usb_show_tree(void);
1004 
1005 #endif /*_USB_H_ */
1006