blob: 8a71e2825334bcf5ebd4c06a7259dedbe6c2ee90 [file] [log] [blame]
wdenk012771d2002-03-08 21:31:05 +00001/*
2 * (C) Copyright 2001
3 * Denis Peter, MPL AG Switzerland
4 *
Simon Glassde312132015-03-25 12:21:59 -06005 * Adapted for U-Boot driver model
6 * (C) Copyright 2015 Google, Inc
7 *
Wolfgang Denk1a459662013-07-08 09:37:19 +02008 * SPDX-License-Identifier: GPL-2.0+
wdenk012771d2002-03-08 21:31:05 +00009 * Note: Part of this code has been derived from linux
10 *
11 */
12#ifndef _USB_H_
13#define _USB_H_
14
Simon Glassde312132015-03-25 12:21:59 -060015#include <fdtdec.h>
wdenk012771d2002-03-08 21:31:05 +000016#include <usb_defs.h>
Ilya Yanokc60795f2012-11-06 13:48:20 +000017#include <linux/usb/ch9.h>
Masahiro Yamadaa8c2ebc2014-11-07 18:34:55 +090018#include <asm/cache.h>
19#include <part.h>
wdenk012771d2002-03-08 21:31:05 +000020
Tom Rini71c5de42012-07-15 22:14:24 +000021/*
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
wdenk012771d2002-03-08 21:31:05 +000031/* Everything is aribtrary */
wdenk5cf91d62004-04-23 20:32:05 +000032#define USB_ALTSETTINGALLOC 4
33#define USB_MAXALTSETTING 128 /* Hard limit */
wdenk012771d2002-03-08 21:31:05 +000034
wdenk5cf91d62004-04-23 20:32:05 +000035#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
wdenk012771d2002-03-08 21:31:05 +000041
42#define USB_CNTL_TIMEOUT 100 /* 100ms timeout */
43
Simon Glass96820a32011-02-07 14:42:16 -080044/*
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 */
Jason Cooper80b350a2011-07-31 20:09:58 +000048#define USB_TIMEOUT_MS(pipe) (usb_pipebulk(pipe) ? 5000 : 1000)
Simon Glass96820a32011-02-07 14:42:16 -080049
wdenk012771d2002-03-08 21:31:05 +000050/* device request (setup) */
51struct devrequest {
Sergey Temerkhanovb12242a2015-04-01 17:18:44 +030052 __u8 requesttype;
53 __u8 request;
54 __le16 value;
55 __le16 index;
56 __le16 length;
wdenk012771d2002-03-08 21:31:05 +000057} __attribute__ ((packed));
58
Tom Rix8f8bd562009-10-31 12:37:38 -050059/* Interface */
60struct usb_interface {
61 struct usb_interface_descriptor desc;
wdenk012771d2002-03-08 21:31:05 +000062
Sergey Temerkhanovb12242a2015-04-01 17:18:44 +030063 __u8 no_of_ep;
64 __u8 num_altsetting;
65 __u8 act_altsetting;
Michael Trimarchide39f8c2008-11-26 17:41:34 +010066
wdenk012771d2002-03-08 21:31:05 +000067 struct usb_endpoint_descriptor ep_desc[USB_MAXENDPOINTS];
Vivek Gautam6497c662013-04-12 16:34:38 +053068 /*
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];
wdenk012771d2002-03-08 21:31:05 +000074} __attribute__ ((packed));
75
Tom Rix8f8bd562009-10-31 12:37:38 -050076/* Configuration information.. */
77struct usb_config {
Ilya Yanokc60795f2012-11-06 13:48:20 +000078 struct usb_config_descriptor desc;
wdenk012771d2002-03-08 21:31:05 +000079
Sergey Temerkhanovb12242a2015-04-01 17:18:44 +030080 __u8 no_of_if; /* number of interfaces */
Tom Rix8f8bd562009-10-31 12:37:38 -050081 struct usb_interface if_desc[USB_MAXINTERFACES];
wdenk012771d2002-03-08 21:31:05 +000082} __attribute__ ((packed));
83
Remy Bohmer48867202008-10-10 10:23:21 +020084enum {
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};
wdenk012771d2002-03-08 21:31:05 +000091
Simon Glassde312132015-03-25 12:21:59 -060092/**
93 * struct usb_device - information about a USB device
94 *
95 * With driver model both UCLASS_USB (the USB controllers) and UCLASS_USB_HUB
96 * (the hubs) have this as parent data. Hubs are children of controllers or
97 * other hubs and there is always a single root hub for each controller.
98 * Therefore struct usb_device can always be accessed with
99 * dev_get_parentdata(dev), where dev is a USB device.
100 *
101 * Pointers exist for obtaining both the device (could be any uclass) and
102 * controller (UCLASS_USB) from this structure. The controller does not have
103 * a struct usb_device since it is not a device.
104 */
wdenk012771d2002-03-08 21:31:05 +0000105struct usb_device {
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100106 int devnum; /* Device number on USB bus */
Michael Trimarchi3e126482008-11-28 13:19:19 +0100107 int speed; /* full/low/high */
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100108 char mf[32]; /* manufacturer */
109 char prod[32]; /* product */
110 char serial[32]; /* serial number */
wdenk012771d2002-03-08 21:31:05 +0000111
Remy Bohmer48867202008-10-10 10:23:21 +0200112 /* 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];
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100116 /* endpoint halts; one bit per endpoint # & direction;
117 * [0] = IN, [1] = OUT
118 */
Remy Bohmer48867202008-10-10 10:23:21 +0200119 unsigned int halted[2];
wdenk012771d2002-03-08 21:31:05 +0000120 int epmaxpacketin[16]; /* INput endpoint specific maximums */
121 int epmaxpacketout[16]; /* OUTput endpoint specific maximums */
122
123 int configno; /* selected config number */
Puneet Saxenaf5766132012-04-03 14:56:06 +0530124 /* Device Descriptor */
125 struct usb_device_descriptor descriptor
126 __attribute__((aligned(ARCH_DMA_MINALIGN)));
Tom Rix8f8bd562009-10-31 12:37:38 -0500127 struct usb_config config; /* config descriptor */
wdenk012771d2002-03-08 21:31:05 +0000128
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;
wdenk5cf91d62004-04-23 20:32:05 +0000133 int irq_act_len; /* transfered bytes */
wdenk012771d2002-03-08 21:31:05 +0000134 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;
Hans de Goede904f2a82015-01-11 20:34:54 +0100140 unsigned long int_pending; /* 1 bit per ep, used by int_queue */
wdenk012771d2002-03-08 21:31:05 +0000141 int act_len; /* transfered bytes */
142 int maxchild; /* Number of ports if hub */
Simon Glassde312132015-03-25 12:21:59 -0600143 int portnr; /* Port number, 1=first */
144#ifndef CONFIG_DM_USB
145 /* parent hub, or NULL if this is the root hub */
wdenk012771d2002-03-08 21:31:05 +0000146 struct usb_device *parent;
147 struct usb_device *children[USB_MAXCHILDREN];
Lucas Stachc7e3b2b2012-09-26 00:14:34 +0200148 void *controller; /* hardware controller private data */
Simon Glassde312132015-03-25 12:21:59 -0600149#endif
Vivek Gautam5853e132013-09-14 14:02:45 +0530150 /* slot_id - for xHCI enabled devices */
151 unsigned int slot_id;
Simon Glassde312132015-03-25 12:21:59 -0600152#ifdef CONFIG_DM_USB
153 struct udevice *dev; /* Pointer to associated device */
154 struct udevice *controller_dev; /* Pointer to associated controller */
155#endif
wdenk012771d2002-03-08 21:31:05 +0000156};
157
Hans de Goede8460b892014-09-24 14:06:06 +0200158struct int_queue;
159
Troy Kiskybba67912013-10-10 15:27:55 -0700160/*
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 */
165enum usb_init_type {
166 USB_INIT_HOST,
167 USB_INIT_DEVICE
168};
169
wdenk012771d2002-03-08 21:31:05 +0000170/**********************************************************************
171 * this is how the lowlevel part communicate with the outer world
172 */
173
Troy Kisky06d513e2013-10-10 15:27:56 -0700174int usb_lowlevel_init(int index, enum usb_init_type init, void **controller);
Lucas Stachc7e3b2b2012-09-26 00:14:34 +0200175int usb_lowlevel_stop(int index);
Simon Glassde312132015-03-25 12:21:59 -0600176
177#if defined(CONFIG_MUSB_HOST) || defined(CONFIG_DM_USB)
178int usb_reset_root_port(void);
Hans de Goede90cdc102015-01-11 20:34:51 +0100179#else
180#define usb_reset_root_port()
181#endif
Lucas Stachc7e3b2b2012-09-26 00:14:34 +0200182
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100183int submit_bulk_msg(struct usb_device *dev, unsigned long pipe,
184 void *buffer, int transfer_len);
wdenk012771d2002-03-08 21:31:05 +0000185int submit_control_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100186 int transfer_len, struct devrequest *setup);
wdenk012771d2002-03-08 21:31:05 +0000187int submit_int_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
188 int transfer_len, int interval);
189
Hans de Goede8a5f0662015-05-10 14:10:18 +0200190#if defined CONFIG_USB_EHCI || defined CONFIG_MUSB_HOST || defined(CONFIG_DM_USB)
Hans de Goede8460b892014-09-24 14:06:06 +0200191struct int_queue *create_int_queue(struct usb_device *dev, unsigned long pipe,
Hans de Goede8bb6c1d2015-01-11 20:38:28 +0100192 int queuesize, int elementsize, void *buffer, int interval);
Hans de Goede8460b892014-09-24 14:06:06 +0200193int destroy_int_queue(struct usb_device *dev, struct int_queue *queue);
194void *poll_int_queue(struct usb_device *dev, struct int_queue *queue);
195#endif
196
wdenk012771d2002-03-08 21:31:05 +0000197/* Defines */
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100198#define USB_UHCI_VEND_ID 0x8086
199#define USB_UHCI_DEV_ID 0x7112
wdenk012771d2002-03-08 21:31:05 +0000200
Lukasz Daleke5f24752012-10-02 17:04:33 +0200201/*
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 */
Lukasz Daleke5f24752012-10-02 17:04:33 +0200208extern void udc_disconnect(void);
209
Mateusz Zalega16297cf2013-10-04 19:22:26 +0200210/*
Mateusz Zalega16297cf2013-10-04 19:22:26 +0200211 * 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 */
Troy Kiskybba67912013-10-10 15:27:55 -0700217int board_usb_init(int index, enum usb_init_type init);
Mateusz Zalega16297cf2013-10-04 19:22:26 +0200218
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
Troy Kiskybba67912013-10-10 15:27:55 -0700224 * @param init usb_init_type passed to board_usb_init()
Mateusz Zalega16297cf2013-10-04 19:22:26 +0200225 */
Troy Kiskybba67912013-10-10 15:27:55 -0700226int board_usb_cleanup(int index, enum usb_init_type init);
Mateusz Zalega16297cf2013-10-04 19:22:26 +0200227
wdenk012771d2002-03-08 21:31:05 +0000228#ifdef CONFIG_USB_STORAGE
229
230#define USB_MAX_STOR_DEV 5
231block_dev_desc_t *usb_stor_get_dev(int index);
232int usb_stor_scan(int mode);
Anatolij Gustschine813eae2008-03-26 17:47:44 +0100233int usb_stor_info(void);
wdenk012771d2002-03-08 21:31:05 +0000234
235#endif
236
Simon Glass89d48362011-02-16 11:14:33 -0800237#ifdef CONFIG_USB_HOST_ETHER
238
239#define USB_MAX_ETH_DEV 5
240int usb_host_eth_scan(int mode);
241
242#endif
243
wdenk012771d2002-03-08 21:31:05 +0000244#ifdef CONFIG_USB_KEYBOARD
245
246int drv_usb_kbd_init(void);
Hans de Goede8a8a2252014-09-20 16:54:38 +0200247int usb_kbd_deregister(int force);
wdenk012771d2002-03-08 21:31:05 +0000248
249#endif
250/* routines */
251int usb_init(void); /* initialize the USB Controller */
252int usb_stop(void); /* stop the USB Controller */
Vincent Palatin08f3bb02015-05-04 11:30:54 -0600253int usb_detect_change(void); /* detect if a USB device has been (un)plugged */
wdenk012771d2002-03-08 21:31:05 +0000254
255
256int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol);
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100257int usb_set_idle(struct usb_device *dev, int ifnum, int duration,
258 int report_id);
wdenk012771d2002-03-08 21:31:05 +0000259int 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);
263int usb_bulk_msg(struct usb_device *dev, unsigned int pipe,
264 void *data, int len, int *actual_length, int timeout);
265int usb_submit_int_msg(struct usb_device *dev, unsigned long pipe,
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100266 void *buffer, int transfer_len, int interval);
Simon Glass89d48362011-02-16 11:14:33 -0800267int usb_disable_asynch(int disable);
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100268int usb_maxpacket(struct usb_device *dev, unsigned long pipe);
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100269int usb_get_configuration_no(struct usb_device *dev, unsigned char *buffer,
270 int cfgno);
271int usb_get_report(struct usb_device *dev, int ifnum, unsigned char type,
272 unsigned char id, void *buf, int size);
wdenk012771d2002-03-08 21:31:05 +0000273int usb_get_class_descriptor(struct usb_device *dev, int ifnum,
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100274 unsigned char type, unsigned char id, void *buf,
275 int size);
wdenk012771d2002-03-08 21:31:05 +0000276int usb_clear_halt(struct usb_device *dev, int pipe);
277int usb_string(struct usb_device *dev, int index, char *buf, size_t size);
278int usb_set_interface(struct usb_device *dev, int interface, int alternate);
Vincent Palatin08f3bb02015-05-04 11:30:54 -0600279int usb_get_port_status(struct usb_device *dev, int port, void *data);
wdenk012771d2002-03-08 21:31:05 +0000280
281/* big endian -> little endian conversion */
wdenk149dded2003-09-10 18:20:28 +0000282/* some CPUs are already little endian e.g. the ARM920T */
Markus Klotzbuecherae3b7702006-11-27 11:46:46 +0100283#define __swap_16(x) \
wdenk3f85ce22004-02-23 16:11:30 +0000284 ({ unsigned short x_ = (unsigned short)x; \
285 (unsigned short)( \
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100286 ((x_ & 0x00FFU) << 8) | ((x_ & 0xFF00U) >> 8)); \
wdenk3f85ce22004-02-23 16:11:30 +0000287 })
Markus Klotzbuecherae3b7702006-11-27 11:46:46 +0100288#define __swap_32(x) \
wdenk3f85ce22004-02-23 16:11:30 +0000289 ({ unsigned long x_ = (unsigned long)x; \
290 (unsigned long)( \
291 ((x_ & 0x000000FFUL) << 24) | \
wdenk5cf91d62004-04-23 20:32:05 +0000292 ((x_ & 0x0000FF00UL) << 8) | \
293 ((x_ & 0x00FF0000UL) >> 8) | \
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100294 ((x_ & 0xFF000000UL) >> 24)); \
wdenk3f85ce22004-02-23 16:11:30 +0000295 })
Markus Klotzbuecherae3b7702006-11-27 11:46:46 +0100296
Mike Frysingerc7d703f2009-01-01 18:27:27 -0500297#ifdef __LITTLE_ENDIAN
Markus Klotzbuecherae3b7702006-11-27 11:46:46 +0100298# 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)
Mike Frysingerc7d703f2009-01-01 18:27:27 -0500303#endif
wdenk012771d2002-03-08 21:31:05 +0000304
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)
Michael Trimarchi3e126482008-11-28 13:19:19 +0100313 * - speed (2 bits)
wdenk012771d2002-03-08 21:31:05 +0000314 * - 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)
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100325 * - direction: bit 7 (0 = Host-to-Device [Out],
326 * (1 = Device-to-Host [In])
wdenk012771d2002-03-08 21:31:05 +0000327 * - device: bits 8-14
328 * - endpoint: bits 15-18
329 * - Data0/1: bit 19
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100330 * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt,
331 * 10 = control, 11 = bulk)
wdenk012771d2002-03-08 21:31:05 +0000332 *
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) \
Sergei Shtylyovd0fe1122010-05-26 21:26:43 +0400340 (((dev)->devnum << 8) | ((endpoint) << 15) | \
Ilya Yanokc60795f2012-11-06 13:48:20 +0000341 (dev)->maxpacketsize)
Michael Trimarchi3e126482008-11-28 13:19:19 +0100342#define default_pipe(dev) ((dev)->speed << 26)
wdenk012771d2002-03-08 21:31:05 +0000343
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100344#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)
wdenk012771d2002-03-08 21:31:05 +0000369
370/* The D0/D1 toggle bits */
371#define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> ep) & 1)
wdenk5cf91d62004-04-23 20:32:05 +0000372#define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << ep))
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100373#define usb_settoggle(dev, ep, out, bit) ((dev)->toggle[out] = \
374 ((dev)->toggle[out] & \
375 ~(1 << ep)) | ((bit) << ep))
wdenk012771d2002-03-08 21:31:05 +0000376
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
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100383#define usb_packetid(pipe) (((pipe) & USB_DIR_IN) ? USB_PID_IN : \
384 USB_PID_OUT)
wdenk012771d2002-03-08 21:31:05 +0000385
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)
wdenk012771d2002-03-08 21:31:05 +0000392#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
Vivek Gautam5853e132013-09-14 14:02:45 +0530398#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))
wdenk012771d2002-03-08 21:31:05 +0000402
Simon Glass0566e242015-03-25 12:22:30 -0600403/**
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 */
450struct 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 * @compatible: Compatible string
497 * @data: Data for this compatible string
498 */
499struct usb_driver_entry {
500 struct driver *driver;
501 const struct usb_device_id *match;
502};
503
504#define USB_DEVICE(__name, __match) \
505 ll_entry_declare(struct usb_driver_entry, __name, usb_driver_entry) = {\
506 .driver = llsym(struct driver, __name, driver), \
507 .match = __match, \
508 }
509
wdenk012771d2002-03-08 21:31:05 +0000510/*************************************************************************
511 * Hub Stuff
512 */
513struct usb_port_status {
514 unsigned short wPortStatus;
515 unsigned short wPortChange;
516} __attribute__ ((packed));
517
518struct usb_hub_status {
519 unsigned short wHubStatus;
520 unsigned short wHubChange;
521} __attribute__ ((packed));
522
523
524/* Hub descriptor */
525struct usb_hub_descriptor {
526 unsigned char bLength;
527 unsigned char bDescriptorType;
528 unsigned char bNbrPorts;
529 unsigned short wHubCharacteristics;
530 unsigned char bPwrOn2PwrGood;
531 unsigned char bHubContrCurrent;
532 unsigned char DeviceRemovable[(USB_MAXCHILDREN+1+7)/8];
533 unsigned char PortPowerCtrlMask[(USB_MAXCHILDREN+1+7)/8];
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100534 /* DeviceRemovable and PortPwrCtrlMask want to be variable-length
wdenk012771d2002-03-08 21:31:05 +0000535 bitmaps that hold max 255 entries. (bit0 is ignored) */
536} __attribute__ ((packed));
537
538
539struct usb_hub_device {
540 struct usb_device *pusb_dev;
541 struct usb_hub_descriptor desc;
542};
543
Simon Glassde312132015-03-25 12:21:59 -0600544#ifdef CONFIG_DM_USB
545/**
546 * struct usb_platdata - Platform data about a USB controller
547 *
548 * Given a USB controller (UCLASS_USB) dev this is dev_get_platdata(dev)
549 */
550struct usb_platdata {
551 enum usb_init_type init_type;
552};
553
554/**
555 * struct usb_dev_platdata - Platform data about a USB device
556 *
557 * Given a USB device dev this structure is dev_get_parent_platdata(dev).
558 * This is used by sandbox to provide emulation data also.
559 *
560 * @id: ID used to match this device
Simon Glassde312132015-03-25 12:21:59 -0600561 * @devnum: Device address on the USB bus
Hans de Goede7f1a0752015-05-05 11:54:32 +0200562 * @udev: usb-uclass internal use only do NOT use
Simon Glassde312132015-03-25 12:21:59 -0600563 * @strings: List of descriptor strings (for sandbox emulation purposes)
564 * @desc_list: List of descriptors (for sandbox emulation purposes)
565 */
566struct usb_dev_platdata {
567 struct usb_device_id id;
Simon Glassde312132015-03-25 12:21:59 -0600568 int devnum;
Hans de Goede7f1a0752015-05-05 11:54:32 +0200569 /*
570 * This pointer is used to pass the usb_device used in usb_scan_device,
571 * to get the usb descriptors before the driver is known, to the
572 * actual udevice once the driver is known and the udevice is created.
573 * This will be NULL except during probe, do NOT use.
574 *
575 * This should eventually go away.
576 */
577 struct usb_device *udev;
Simon Glassde312132015-03-25 12:21:59 -0600578#ifdef CONFIG_SANDBOX
579 struct usb_string *strings;
580 /* NULL-terminated list of descriptor pointers */
581 struct usb_generic_descriptor **desc_list;
582#endif
583 int configno;
584};
585
586/**
587 * struct usb_bus_priv - information about the USB controller
588 *
589 * Given a USB controller (UCLASS_USB) 'dev', this is
590 * dev_get_uclass_priv(dev).
591 *
592 * @next_addr: Next device address to allocate minus 1. Incremented by 1
593 * each time a new device address is set, so this holds the
594 * number of devices on the bus
595 * @desc_before_addr: true if we can read a device descriptor before it
596 * has been assigned an address. For XHCI this is not possible
597 * so this will be false.
Hans de Goedeb6de4d12015-05-10 14:10:20 +0200598 * @companion: True if this is a companion controller to another USB
599 * controller
Simon Glassde312132015-03-25 12:21:59 -0600600 */
601struct usb_bus_priv {
602 int next_addr;
603 bool desc_before_addr;
Hans de Goedeb6de4d12015-05-10 14:10:20 +0200604 bool companion;
Simon Glassde312132015-03-25 12:21:59 -0600605};
606
607/**
608 * struct dm_usb_ops - USB controller operations
609 *
610 * This defines the operations supoorted on a USB controller. Common
611 * arguments are:
612 *
613 * @bus: USB bus (i.e. controller), which is in UCLASS_USB.
614 * @udev: USB device parent data. Controllers are not expected to need
615 * this, since the device address on the bus is encoded in @pipe.
616 * It is used for sandbox, and can be handy for debugging and
617 * logging.
618 * @pipe: An assortment of bitfields which provide address and packet
619 * type information. See create_pipe() above for encoding
620 * details
621 * @buffer: A buffer to use for sending/receiving. This should be
622 * DMA-aligned.
623 * @length: Buffer length in bytes
624 */
625struct dm_usb_ops {
626 /**
627 * control() - Send a control message
628 *
629 * Most parameters are as above.
630 *
631 * @setup: Additional setup information required by the message
632 */
633 int (*control)(struct udevice *bus, struct usb_device *udev,
634 unsigned long pipe, void *buffer, int length,
635 struct devrequest *setup);
636 /**
637 * bulk() - Send a bulk message
638 *
639 * Parameters are as above.
640 */
641 int (*bulk)(struct udevice *bus, struct usb_device *udev,
642 unsigned long pipe, void *buffer, int length);
643 /**
644 * interrupt() - Send an interrupt message
645 *
646 * Most parameters are as above.
647 *
648 * @interval: Interrupt interval
649 */
650 int (*interrupt)(struct udevice *bus, struct usb_device *udev,
651 unsigned long pipe, void *buffer, int length,
652 int interval);
Hans de Goede8a5f0662015-05-10 14:10:18 +0200653
654 /**
655 * create_int_queue() - Create and queue interrupt packets
656 *
657 * Create and queue @queuesize number of interrupt usb packets of
658 * @elementsize bytes each. @buffer must be atleast @queuesize *
659 * @elementsize bytes.
660 *
661 * Note some controllers only support a queuesize of 1.
662 *
663 * @interval: Interrupt interval
664 *
665 * @return A pointer to the created interrupt queue or NULL on error
666 */
667 struct int_queue * (*create_int_queue)(struct udevice *bus,
668 struct usb_device *udev, unsigned long pipe,
669 int queuesize, int elementsize, void *buffer,
670 int interval);
671
672 /**
673 * poll_int_queue() - Poll an interrupt queue for completed packets
674 *
675 * Poll an interrupt queue for completed packets. The return value
676 * points to the part of the buffer passed to create_int_queue()
677 * corresponding to the completed packet.
678 *
679 * @queue: queue to poll
680 *
681 * @return Pointer to the data of the first completed packet, or
682 * NULL if no packets are ready
683 */
684 void * (*poll_int_queue)(struct udevice *bus, struct usb_device *udev,
685 struct int_queue *queue);
686
687 /**
688 * destroy_int_queue() - Destroy an interrupt queue
689 *
690 * Destroy an interrupt queue created by create_int_queue().
691 *
692 * @queue: queue to poll
693 *
694 * @return 0 if OK, -ve on error
695 */
696 int (*destroy_int_queue)(struct udevice *bus, struct usb_device *udev,
697 struct int_queue *queue);
698
Simon Glassde312132015-03-25 12:21:59 -0600699 /**
700 * alloc_device() - Allocate a new device context (XHCI)
701 *
702 * Before sending packets to a new device on an XHCI bus, a device
703 * context must be created. If this method is not NULL it will be
704 * called before the device is enumerated (even before its descriptor
705 * is read). This should be NULL for EHCI, which does not need this.
706 */
707 int (*alloc_device)(struct udevice *bus, struct usb_device *udev);
708};
709
710#define usb_get_ops(dev) ((struct dm_usb_ops *)(dev)->driver->ops)
711#define usb_get_emul_ops(dev) ((struct dm_usb_ops *)(dev)->driver->ops)
712
713#ifdef CONFIG_MUSB_HOST
714int usb_reset_root_port(void);
715#endif
716
717/**
718 * usb_get_dev_index() - look up a device index number
719 *
720 * Look up devices using their index number (starting at 0). This works since
721 * in U-Boot device addresses are allocated starting at 1 with no gaps.
722 *
723 * TODO(sjg@chromium.org): Remove this function when usb_ether.c is modified
724 * to work better with driver model.
725 *
726 * @bus: USB bus to check
727 * @index: Index number of device to find (0=first). This is just the
728 * device address less 1.
729 */
730struct usb_device *usb_get_dev_index(struct udevice *bus, int index);
731
732/**
Simon Glassde312132015-03-25 12:21:59 -0600733 * usb_setup_device() - set up a device ready for use
734 *
735 * @dev: USB device pointer. This need not be a real device - it is
736 * common for it to just be a local variable with its ->dev
Hans de Goede9eb72dd2015-06-17 21:33:46 +0200737 * member (i.e. @dev->dev) set to the parent device and
738 * dev->portnr set to the port number on the hub (1=first)
Simon Glassde312132015-03-25 12:21:59 -0600739 * @do_read: true to read the device descriptor before an address is set
740 * (should be false for XHCI buses, true otherwise)
741 * @parent: Parent device (either UCLASS_USB or UCLASS_USB_HUB)
Simon Glassde312132015-03-25 12:21:59 -0600742 * @return 0 if OK, -ve on error */
743int usb_setup_device(struct usb_device *dev, bool do_read,
Hans de Goede9eb72dd2015-06-17 21:33:46 +0200744 struct usb_device *parent);
Simon Glassde312132015-03-25 12:21:59 -0600745
746/**
747 * usb_hub_scan() - Scan a hub and find its devices
748 *
749 * @hub: Hub device to scan
750 */
751int usb_hub_scan(struct udevice *hub);
752
753/**
754 * usb_scan_device() - Scan a device on a bus
755 *
756 * Scan a device on a bus. It has already been detected and is ready to
757 * be enumerated. This may be either the root hub (@parent is a bus) or a
758 * normal device (@parent is a hub)
759 *
760 * @parent: Parent device
761 * @port: Hub port number (numbered from 1)
762 * @speed: USB speed to use for this device
763 * @devp: Returns pointer to device if all is well
764 * @return 0 if OK, -ve on error
765 */
766int usb_scan_device(struct udevice *parent, int port,
767 enum usb_device_speed speed, struct udevice **devp);
768
769/**
770 * usb_get_bus() - Find the bus for a device
771 *
772 * Search up through parents to find the bus this device is connected to. This
773 * will be a device with uclass UCLASS_USB.
774 *
775 * @dev: Device to check
Hans de Goedef78a5c02015-05-05 11:54:31 +0200776 * @return The bus, or NULL if not found (this indicates a critical error in
777 * the USB stack
Simon Glassde312132015-03-25 12:21:59 -0600778 */
Hans de Goedef78a5c02015-05-05 11:54:31 +0200779struct udevice *usb_get_bus(struct udevice *dev);
Simon Glassde312132015-03-25 12:21:59 -0600780
781/**
782 * usb_select_config() - Set up a device ready for use
783 *
784 * This function assumes that the device already has an address and a driver
785 * bound, and is ready to be set up.
786 *
787 * This re-reads the device and configuration descriptors and sets the
788 * configuration
789 *
790 * @dev: Device to set up
791 */
792int usb_select_config(struct usb_device *dev);
793
794/**
795 * usb_child_pre_probe() - Pre-probe function for USB devices
796 *
797 * This is called on all children of hubs and USB controllers (i.e. UCLASS_USB
798 * and UCLASS_USB_HUB) when a new device is about to be probed. It sets up the
799 * device from the saved platform data and calls usb_select_config() to
800 * finish set up.
801 *
802 * Once this is done, the device's normal driver can take over, knowing the
803 * device is accessible on the USB bus.
804 *
805 * This function is for use only by the internal USB stack.
806 *
807 * @dev: Device to set up
808 */
809int usb_child_pre_probe(struct udevice *dev);
810
811struct ehci_ctrl;
812
813/**
814 * usb_setup_ehci_gadget() - Set up a USB device as a gadget
815 *
816 * TODO(sjg@chromium.org): Tidy this up when USB gadgets can use driver model
817 *
818 * This provides a way to tell a controller to start up as a USB device
819 * instead of as a host. It is untested.
820 */
821int usb_setup_ehci_gadget(struct ehci_ctrl **ctlrp);
822
823/**
824 * usb_stor_reset() - Prepare to scan USB storage devices
825 *
826 * Empty the list of USB storage devices in preparation for scanning them.
827 * This must be called before a USB scan.
828 */
829void usb_stor_reset(void);
830
831#else /* !CONFIG_DM_USB */
832
833struct usb_device *usb_get_dev_index(int index);
834
835#endif
836
837bool usb_device_has_child_on_port(struct usb_device *parent, int port);
838
Marek Vasut23faf2b2012-02-13 18:58:17 +0000839int usb_hub_probe(struct usb_device *dev, int ifnum);
840void usb_hub_reset(void);
Simon Glass862e75c2015-03-25 12:22:04 -0600841
842/**
843 * legacy_hub_port_reset() - reset a port given its usb_device pointer
844 *
845 * Reset a hub port and see if a device is present on that port, providing
846 * sufficient time for it to show itself. The port status is returned.
847 *
848 * With driver model this moves to hub_port_reset() and is passed a struct
849 * udevice.
850 *
851 * @dev: USB device to reset
852 * @port: Port number to reset (note ports are numbered from 0 here)
853 * @portstat: Returns port status
854 */
855int legacy_hub_port_reset(struct usb_device *dev, int port,
Marek Vasut23faf2b2012-02-13 18:58:17 +0000856 unsigned short *portstat);
857
Simon Glass862e75c2015-03-25 12:22:04 -0600858int hub_port_reset(struct udevice *dev, int port, unsigned short *portstat);
859
Simon Glass79b58882015-03-25 12:22:01 -0600860/**
861 * usb_alloc_new_device() - Allocate a new device
862 *
863 * @devp: returns a pointer of a new device structure. With driver model this
864 * is a device pointer, but with legacy USB this pointer is
865 * driver-specific.
866 * @return 0 if OK, -ENOSPC if we have found out of room for new devices
867 */
868int usb_alloc_new_device(struct udevice *controller, struct usb_device **devp);
869
870/**
871 * usb_free_device() - Free a partially-inited device
872 *
873 * This is an internal function. It is used to reverse the action of
874 * usb_alloc_new_device() when we hit a problem during init.
875 */
876void usb_free_device(struct udevice *controller);
Lucas Stachc7e3b2b2012-09-26 00:14:34 +0200877
Marek Vasut23faf2b2012-02-13 18:58:17 +0000878int usb_new_device(struct usb_device *dev);
Simon Glass79b58882015-03-25 12:22:01 -0600879
Vivek Gautam5853e132013-09-14 14:02:45 +0530880int usb_alloc_device(struct usb_device *dev);
Marek Vasut23faf2b2012-02-13 18:58:17 +0000881
Simon Glass019808f2015-03-25 12:22:37 -0600882/**
883 * usb_emul_setup_device() - Set up a new USB device emulation
884 *
885 * This is normally called when a new emulation device is bound. It tells
886 * the USB emulation uclass about the features of the emulator.
887 *
888 * @dev: Emulation device
889 * @maxpacketsize: Maximum packet size (e.g. PACKET_SIZE_64)
890 * @strings: List of USB string descriptors, terminated by a NULL
891 * entry
892 * @desc_list: List of points or USB descriptors, terminated by NULL.
893 * The first entry must be struct usb_device_descriptor,
894 * and others follow on after that.
895 * @return 0 if OK, -ve on error
896 */
897int usb_emul_setup_device(struct udevice *dev, int maxpacketsize,
898 struct usb_string *strings, void **desc_list);
899
900/**
901 * usb_emul_control() - Send a control packet to an emulator
902 *
903 * @emul: Emulator device
904 * @udev: USB device (which the emulator is causing to appear)
905 * See struct dm_usb_ops for details on other parameters
906 * @return 0 if OK, -ve on error
907 */
908int usb_emul_control(struct udevice *emul, struct usb_device *udev,
909 unsigned long pipe, void *buffer, int length,
910 struct devrequest *setup);
911
912/**
913 * usb_emul_bulk() - Send a bulk packet to an emulator
914 *
915 * @emul: Emulator device
916 * @udev: USB device (which the emulator is causing to appear)
917 * See struct dm_usb_ops for details on other parameters
918 * @return 0 if OK, -ve on error
919 */
920int usb_emul_bulk(struct udevice *emul, struct usb_device *udev,
921 unsigned long pipe, void *buffer, int length);
922
923/**
924 * usb_emul_find() - Find an emulator for a particular device
925 *
926 * Check @pipe to find a device number on bus @bus and return it.
927 *
928 * @bus: USB bus (controller)
929 * @pipe: Describes pipe being used, and includes the device number
930 * @emulp: Returns pointer to emulator, or NULL if not found
931 * @return 0 if found, -ve on error
932 */
933int usb_emul_find(struct udevice *bus, ulong pipe, struct udevice **emulp);
934
935/**
936 * usb_emul_reset() - Reset all emulators ready for use
937 *
938 * Clear out any address information in the emulators and make then ready for
939 * a new USB scan
940 */
941void usb_emul_reset(struct udevice *dev);
942
wdenk012771d2002-03-08 21:31:05 +0000943#endif /*_USB_H_ */