blob: 198ecbcbe32a07d1a96927673eb461da3b76c0dc [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
Simon Glassbcbe3d12015-09-28 23:32:01 -060099 * dev_get_parent_priv(dev), where dev is a USB device.
Simon Glassde312132015-03-25 12:21:59 -0600100 *
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
Paul Kocialkowski95de1e22015-08-04 17:04:06 +0200177#if defined(CONFIG_USB_MUSB_HOST) || defined(CONFIG_DM_USB)
Hans de Goede8802f562015-06-17 21:33:48 +0200178int usb_reset_root_port(struct usb_device *dev);
Hans de Goede90cdc102015-01-11 20:34:51 +0100179#else
Hans de Goede8802f562015-06-17 21:33:48 +0200180#define usb_reset_root_port(dev)
Hans de Goede90cdc102015-01-11 20:34:51 +0100181#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
Paul Kocialkowski95de1e22015-08-04 17:04:06 +0200190#if defined CONFIG_USB_EHCI || defined CONFIG_USB_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);
Stefan Brünsc75f57f2015-12-22 01:18:13 +0100269int usb_get_configuration_no(struct usb_device *dev, int cfgno,
270 unsigned char *buffer, int length);
271int usb_get_configuration_len(struct usb_device *dev, int cfgno);
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100272int usb_get_report(struct usb_device *dev, int ifnum, unsigned char type,
273 unsigned char id, void *buf, int size);
wdenk012771d2002-03-08 21:31:05 +0000274int usb_get_class_descriptor(struct usb_device *dev, int ifnum,
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100275 unsigned char type, unsigned char id, void *buf,
276 int size);
wdenk012771d2002-03-08 21:31:05 +0000277int usb_clear_halt(struct usb_device *dev, int pipe);
278int usb_string(struct usb_device *dev, int index, char *buf, size_t size);
279int usb_set_interface(struct usb_device *dev, int interface, int alternate);
Vincent Palatin08f3bb02015-05-04 11:30:54 -0600280int usb_get_port_status(struct usb_device *dev, int port, void *data);
wdenk012771d2002-03-08 21:31:05 +0000281
282/* big endian -> little endian conversion */
wdenk149dded2003-09-10 18:20:28 +0000283/* some CPUs are already little endian e.g. the ARM920T */
Markus Klotzbuecherae3b7702006-11-27 11:46:46 +0100284#define __swap_16(x) \
wdenk3f85ce22004-02-23 16:11:30 +0000285 ({ unsigned short x_ = (unsigned short)x; \
286 (unsigned short)( \
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100287 ((x_ & 0x00FFU) << 8) | ((x_ & 0xFF00U) >> 8)); \
wdenk3f85ce22004-02-23 16:11:30 +0000288 })
Markus Klotzbuecherae3b7702006-11-27 11:46:46 +0100289#define __swap_32(x) \
wdenk3f85ce22004-02-23 16:11:30 +0000290 ({ unsigned long x_ = (unsigned long)x; \
291 (unsigned long)( \
292 ((x_ & 0x000000FFUL) << 24) | \
wdenk5cf91d62004-04-23 20:32:05 +0000293 ((x_ & 0x0000FF00UL) << 8) | \
294 ((x_ & 0x00FF0000UL) >> 8) | \
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100295 ((x_ & 0xFF000000UL) >> 24)); \
wdenk3f85ce22004-02-23 16:11:30 +0000296 })
Markus Klotzbuecherae3b7702006-11-27 11:46:46 +0100297
Mike Frysingerc7d703f2009-01-01 18:27:27 -0500298#ifdef __LITTLE_ENDIAN
Markus Klotzbuecherae3b7702006-11-27 11:46:46 +0100299# define swap_16(x) (x)
300# define swap_32(x) (x)
301#else
302# define swap_16(x) __swap_16(x)
303# define swap_32(x) __swap_32(x)
Mike Frysingerc7d703f2009-01-01 18:27:27 -0500304#endif
wdenk012771d2002-03-08 21:31:05 +0000305
306/*
307 * Calling this entity a "pipe" is glorifying it. A USB pipe
308 * is something embarrassingly simple: it basically consists
309 * of the following information:
310 * - device number (7 bits)
311 * - endpoint number (4 bits)
312 * - current Data0/1 state (1 bit)
313 * - direction (1 bit)
Michael Trimarchi3e126482008-11-28 13:19:19 +0100314 * - speed (2 bits)
wdenk012771d2002-03-08 21:31:05 +0000315 * - max packet size (2 bits: 8, 16, 32 or 64)
316 * - pipe type (2 bits: control, interrupt, bulk, isochronous)
317 *
318 * That's 18 bits. Really. Nothing more. And the USB people have
319 * documented these eighteen bits as some kind of glorious
320 * virtual data structure.
321 *
322 * Let's not fall in that trap. We'll just encode it as a simple
323 * unsigned int. The encoding is:
324 *
325 * - max size: bits 0-1 (00 = 8, 01 = 16, 10 = 32, 11 = 64)
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100326 * - direction: bit 7 (0 = Host-to-Device [Out],
327 * (1 = Device-to-Host [In])
wdenk012771d2002-03-08 21:31:05 +0000328 * - device: bits 8-14
329 * - endpoint: bits 15-18
330 * - Data0/1: bit 19
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100331 * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt,
332 * 10 = control, 11 = bulk)
wdenk012771d2002-03-08 21:31:05 +0000333 *
334 * Why? Because it's arbitrary, and whatever encoding we select is really
335 * up to us. This one happens to share a lot of bit positions with the UHCI
336 * specification, so that much of the uhci driver can just mask the bits
337 * appropriately.
338 */
339/* Create various pipes... */
340#define create_pipe(dev,endpoint) \
Sergei Shtylyovd0fe1122010-05-26 21:26:43 +0400341 (((dev)->devnum << 8) | ((endpoint) << 15) | \
Ilya Yanokc60795f2012-11-06 13:48:20 +0000342 (dev)->maxpacketsize)
Michael Trimarchi3e126482008-11-28 13:19:19 +0100343#define default_pipe(dev) ((dev)->speed << 26)
wdenk012771d2002-03-08 21:31:05 +0000344
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100345#define usb_sndctrlpipe(dev, endpoint) ((PIPE_CONTROL << 30) | \
346 create_pipe(dev, endpoint))
347#define usb_rcvctrlpipe(dev, endpoint) ((PIPE_CONTROL << 30) | \
348 create_pipe(dev, endpoint) | \
349 USB_DIR_IN)
350#define usb_sndisocpipe(dev, endpoint) ((PIPE_ISOCHRONOUS << 30) | \
351 create_pipe(dev, endpoint))
352#define usb_rcvisocpipe(dev, endpoint) ((PIPE_ISOCHRONOUS << 30) | \
353 create_pipe(dev, endpoint) | \
354 USB_DIR_IN)
355#define usb_sndbulkpipe(dev, endpoint) ((PIPE_BULK << 30) | \
356 create_pipe(dev, endpoint))
357#define usb_rcvbulkpipe(dev, endpoint) ((PIPE_BULK << 30) | \
358 create_pipe(dev, endpoint) | \
359 USB_DIR_IN)
360#define usb_sndintpipe(dev, endpoint) ((PIPE_INTERRUPT << 30) | \
361 create_pipe(dev, endpoint))
362#define usb_rcvintpipe(dev, endpoint) ((PIPE_INTERRUPT << 30) | \
363 create_pipe(dev, endpoint) | \
364 USB_DIR_IN)
365#define usb_snddefctrl(dev) ((PIPE_CONTROL << 30) | \
366 default_pipe(dev))
367#define usb_rcvdefctrl(dev) ((PIPE_CONTROL << 30) | \
368 default_pipe(dev) | \
369 USB_DIR_IN)
wdenk012771d2002-03-08 21:31:05 +0000370
371/* The D0/D1 toggle bits */
372#define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> ep) & 1)
wdenk5cf91d62004-04-23 20:32:05 +0000373#define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << ep))
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100374#define usb_settoggle(dev, ep, out, bit) ((dev)->toggle[out] = \
375 ((dev)->toggle[out] & \
376 ~(1 << ep)) | ((bit) << ep))
wdenk012771d2002-03-08 21:31:05 +0000377
378/* Endpoint halt control/status */
379#define usb_endpoint_out(ep_dir) (((ep_dir >> 7) & 1) ^ 1)
380#define usb_endpoint_halt(dev, ep, out) ((dev)->halted[out] |= (1 << (ep)))
381#define usb_endpoint_running(dev, ep, out) ((dev)->halted[out] &= ~(1 << (ep)))
382#define usb_endpoint_halted(dev, ep, out) ((dev)->halted[out] & (1 << (ep)))
383
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100384#define usb_packetid(pipe) (((pipe) & USB_DIR_IN) ? USB_PID_IN : \
385 USB_PID_OUT)
wdenk012771d2002-03-08 21:31:05 +0000386
387#define usb_pipeout(pipe) ((((pipe) >> 7) & 1) ^ 1)
388#define usb_pipein(pipe) (((pipe) >> 7) & 1)
389#define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f)
390#define usb_pipe_endpdev(pipe) (((pipe) >> 8) & 0x7ff)
391#define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf)
392#define usb_pipedata(pipe) (((pipe) >> 19) & 1)
wdenk012771d2002-03-08 21:31:05 +0000393#define usb_pipetype(pipe) (((pipe) >> 30) & 3)
394#define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
395#define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT)
396#define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL)
397#define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK)
398
Vivek Gautam5853e132013-09-14 14:02:45 +0530399#define usb_pipe_ep_index(pipe) \
400 usb_pipecontrol(pipe) ? (usb_pipeendpoint(pipe) * 2) : \
401 ((usb_pipeendpoint(pipe) * 2) - \
402 (usb_pipein(pipe) ? 0 : 1))
wdenk012771d2002-03-08 21:31:05 +0000403
Simon Glass0566e242015-03-25 12:22:30 -0600404/**
405 * struct usb_device_id - identifies USB devices for probing and hotplugging
406 * @match_flags: Bit mask controlling which of the other fields are used to
407 * match against new devices. Any field except for driver_info may be
408 * used, although some only make sense in conjunction with other fields.
409 * This is usually set by a USB_DEVICE_*() macro, which sets all
410 * other fields in this structure except for driver_info.
411 * @idVendor: USB vendor ID for a device; numbers are assigned
412 * by the USB forum to its members.
413 * @idProduct: Vendor-assigned product ID.
414 * @bcdDevice_lo: Low end of range of vendor-assigned product version numbers.
415 * This is also used to identify individual product versions, for
416 * a range consisting of a single device.
417 * @bcdDevice_hi: High end of version number range. The range of product
418 * versions is inclusive.
419 * @bDeviceClass: Class of device; numbers are assigned
420 * by the USB forum. Products may choose to implement classes,
421 * or be vendor-specific. Device classes specify behavior of all
422 * the interfaces on a device.
423 * @bDeviceSubClass: Subclass of device; associated with bDeviceClass.
424 * @bDeviceProtocol: Protocol of device; associated with bDeviceClass.
425 * @bInterfaceClass: Class of interface; numbers are assigned
426 * by the USB forum. Products may choose to implement classes,
427 * or be vendor-specific. Interface classes specify behavior only
428 * of a given interface; other interfaces may support other classes.
429 * @bInterfaceSubClass: Subclass of interface; associated with bInterfaceClass.
430 * @bInterfaceProtocol: Protocol of interface; associated with bInterfaceClass.
431 * @bInterfaceNumber: Number of interface; composite devices may use
432 * fixed interface numbers to differentiate between vendor-specific
433 * interfaces.
434 * @driver_info: Holds information used by the driver. Usually it holds
435 * a pointer to a descriptor understood by the driver, or perhaps
436 * device flags.
437 *
438 * In most cases, drivers will create a table of device IDs by using
439 * USB_DEVICE(), or similar macros designed for that purpose.
440 * They will then export it to userspace using MODULE_DEVICE_TABLE(),
441 * and provide it to the USB core through their usb_driver structure.
442 *
443 * See the usb_match_id() function for information about how matches are
444 * performed. Briefly, you will normally use one of several macros to help
445 * construct these entries. Each entry you provide will either identify
446 * one or more specific products, or will identify a class of products
447 * which have agreed to behave the same. You should put the more specific
448 * matches towards the beginning of your table, so that driver_info can
449 * record quirks of specific products.
450 */
451struct usb_device_id {
452 /* which fields to match against? */
453 u16 match_flags;
454
455 /* Used for product specific matches; range is inclusive */
456 u16 idVendor;
457 u16 idProduct;
458 u16 bcdDevice_lo;
459 u16 bcdDevice_hi;
460
461 /* Used for device class matches */
462 u8 bDeviceClass;
463 u8 bDeviceSubClass;
464 u8 bDeviceProtocol;
465
466 /* Used for interface class matches */
467 u8 bInterfaceClass;
468 u8 bInterfaceSubClass;
469 u8 bInterfaceProtocol;
470
471 /* Used for vendor-specific interface matches */
472 u8 bInterfaceNumber;
473
474 /* not matched against */
475 ulong driver_info;
476};
477
478/* Some useful macros to use to create struct usb_device_id */
479#define USB_DEVICE_ID_MATCH_VENDOR 0x0001
480#define USB_DEVICE_ID_MATCH_PRODUCT 0x0002
481#define USB_DEVICE_ID_MATCH_DEV_LO 0x0004
482#define USB_DEVICE_ID_MATCH_DEV_HI 0x0008
483#define USB_DEVICE_ID_MATCH_DEV_CLASS 0x0010
484#define USB_DEVICE_ID_MATCH_DEV_SUBCLASS 0x0020
485#define USB_DEVICE_ID_MATCH_DEV_PROTOCOL 0x0040
486#define USB_DEVICE_ID_MATCH_INT_CLASS 0x0080
487#define USB_DEVICE_ID_MATCH_INT_SUBCLASS 0x0100
488#define USB_DEVICE_ID_MATCH_INT_PROTOCOL 0x0200
489#define USB_DEVICE_ID_MATCH_INT_NUMBER 0x0400
490
491/* Match anything, indicates this is a valid entry even if everything is 0 */
492#define USB_DEVICE_ID_MATCH_NONE 0x0800
493#define USB_DEVICE_ID_MATCH_ALL 0x07ff
494
495/**
496 * struct usb_driver_entry - Matches a driver to its usb_device_ids
Simon Glassb4839152015-07-06 16:47:47 -0600497 * @driver: Driver to use
498 * @match: List of match records for this driver, terminated by {}
Simon Glass0566e242015-03-25 12:22:30 -0600499 */
500struct usb_driver_entry {
501 struct driver *driver;
502 const struct usb_device_id *match;
503};
504
Simon Glassabb59cf2015-07-06 16:47:51 -0600505#define USB_DEVICE_ID_MATCH_DEVICE \
506 (USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT)
507
508/**
509 * USB_DEVICE - macro used to describe a specific usb device
510 * @vend: the 16 bit USB Vendor ID
511 * @prod: the 16 bit USB Product ID
512 *
513 * This macro is used to create a struct usb_device_id that matches a
514 * specific device.
515 */
516#define USB_DEVICE(vend, prod) \
517 .match_flags = USB_DEVICE_ID_MATCH_DEVICE, \
518 .idVendor = (vend), \
519 .idProduct = (prod)
520
521#define U_BOOT_USB_DEVICE(__name, __match) \
Simon Glass0566e242015-03-25 12:22:30 -0600522 ll_entry_declare(struct usb_driver_entry, __name, usb_driver_entry) = {\
523 .driver = llsym(struct driver, __name, driver), \
524 .match = __match, \
525 }
526
wdenk012771d2002-03-08 21:31:05 +0000527/*************************************************************************
528 * Hub Stuff
529 */
530struct usb_port_status {
531 unsigned short wPortStatus;
532 unsigned short wPortChange;
533} __attribute__ ((packed));
534
535struct usb_hub_status {
536 unsigned short wHubStatus;
537 unsigned short wHubChange;
538} __attribute__ ((packed));
539
540
541/* Hub descriptor */
542struct usb_hub_descriptor {
543 unsigned char bLength;
544 unsigned char bDescriptorType;
545 unsigned char bNbrPorts;
546 unsigned short wHubCharacteristics;
547 unsigned char bPwrOn2PwrGood;
548 unsigned char bHubContrCurrent;
549 unsigned char DeviceRemovable[(USB_MAXCHILDREN+1+7)/8];
550 unsigned char PortPowerCtrlMask[(USB_MAXCHILDREN+1+7)/8];
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100551 /* DeviceRemovable and PortPwrCtrlMask want to be variable-length
wdenk012771d2002-03-08 21:31:05 +0000552 bitmaps that hold max 255 entries. (bit0 is ignored) */
553} __attribute__ ((packed));
554
555
556struct usb_hub_device {
557 struct usb_device *pusb_dev;
558 struct usb_hub_descriptor desc;
559};
560
Simon Glassde312132015-03-25 12:21:59 -0600561#ifdef CONFIG_DM_USB
562/**
563 * struct usb_platdata - Platform data about a USB controller
564 *
565 * Given a USB controller (UCLASS_USB) dev this is dev_get_platdata(dev)
566 */
567struct usb_platdata {
568 enum usb_init_type init_type;
569};
570
571/**
572 * struct usb_dev_platdata - Platform data about a USB device
573 *
574 * Given a USB device dev this structure is dev_get_parent_platdata(dev).
575 * This is used by sandbox to provide emulation data also.
576 *
577 * @id: ID used to match this device
Simon Glassde312132015-03-25 12:21:59 -0600578 * @devnum: Device address on the USB bus
Hans de Goede7f1a0752015-05-05 11:54:32 +0200579 * @udev: usb-uclass internal use only do NOT use
Simon Glassde312132015-03-25 12:21:59 -0600580 * @strings: List of descriptor strings (for sandbox emulation purposes)
581 * @desc_list: List of descriptors (for sandbox emulation purposes)
582 */
583struct usb_dev_platdata {
584 struct usb_device_id id;
Simon Glassde312132015-03-25 12:21:59 -0600585 int devnum;
Hans de Goede7f1a0752015-05-05 11:54:32 +0200586 /*
587 * This pointer is used to pass the usb_device used in usb_scan_device,
588 * to get the usb descriptors before the driver is known, to the
589 * actual udevice once the driver is known and the udevice is created.
590 * This will be NULL except during probe, do NOT use.
591 *
592 * This should eventually go away.
593 */
594 struct usb_device *udev;
Simon Glassde312132015-03-25 12:21:59 -0600595#ifdef CONFIG_SANDBOX
596 struct usb_string *strings;
597 /* NULL-terminated list of descriptor pointers */
598 struct usb_generic_descriptor **desc_list;
599#endif
600 int configno;
601};
602
603/**
604 * struct usb_bus_priv - information about the USB controller
605 *
606 * Given a USB controller (UCLASS_USB) 'dev', this is
607 * dev_get_uclass_priv(dev).
608 *
609 * @next_addr: Next device address to allocate minus 1. Incremented by 1
610 * each time a new device address is set, so this holds the
611 * number of devices on the bus
612 * @desc_before_addr: true if we can read a device descriptor before it
613 * has been assigned an address. For XHCI this is not possible
614 * so this will be false.
Hans de Goedeb6de4d12015-05-10 14:10:20 +0200615 * @companion: True if this is a companion controller to another USB
616 * controller
Simon Glassde312132015-03-25 12:21:59 -0600617 */
618struct usb_bus_priv {
619 int next_addr;
620 bool desc_before_addr;
Hans de Goedeb6de4d12015-05-10 14:10:20 +0200621 bool companion;
Simon Glassde312132015-03-25 12:21:59 -0600622};
623
624/**
625 * struct dm_usb_ops - USB controller operations
626 *
627 * This defines the operations supoorted on a USB controller. Common
628 * arguments are:
629 *
630 * @bus: USB bus (i.e. controller), which is in UCLASS_USB.
631 * @udev: USB device parent data. Controllers are not expected to need
632 * this, since the device address on the bus is encoded in @pipe.
633 * It is used for sandbox, and can be handy for debugging and
634 * logging.
635 * @pipe: An assortment of bitfields which provide address and packet
636 * type information. See create_pipe() above for encoding
637 * details
638 * @buffer: A buffer to use for sending/receiving. This should be
639 * DMA-aligned.
640 * @length: Buffer length in bytes
641 */
642struct dm_usb_ops {
643 /**
644 * control() - Send a control message
645 *
646 * Most parameters are as above.
647 *
648 * @setup: Additional setup information required by the message
649 */
650 int (*control)(struct udevice *bus, struct usb_device *udev,
651 unsigned long pipe, void *buffer, int length,
652 struct devrequest *setup);
653 /**
654 * bulk() - Send a bulk message
655 *
656 * Parameters are as above.
657 */
658 int (*bulk)(struct udevice *bus, struct usb_device *udev,
659 unsigned long pipe, void *buffer, int length);
660 /**
661 * interrupt() - Send an interrupt message
662 *
663 * Most parameters are as above.
664 *
665 * @interval: Interrupt interval
666 */
667 int (*interrupt)(struct udevice *bus, struct usb_device *udev,
668 unsigned long pipe, void *buffer, int length,
669 int interval);
Hans de Goede8a5f0662015-05-10 14:10:18 +0200670
671 /**
672 * create_int_queue() - Create and queue interrupt packets
673 *
674 * Create and queue @queuesize number of interrupt usb packets of
675 * @elementsize bytes each. @buffer must be atleast @queuesize *
676 * @elementsize bytes.
677 *
678 * Note some controllers only support a queuesize of 1.
679 *
680 * @interval: Interrupt interval
681 *
682 * @return A pointer to the created interrupt queue or NULL on error
683 */
684 struct int_queue * (*create_int_queue)(struct udevice *bus,
685 struct usb_device *udev, unsigned long pipe,
686 int queuesize, int elementsize, void *buffer,
687 int interval);
688
689 /**
690 * poll_int_queue() - Poll an interrupt queue for completed packets
691 *
692 * Poll an interrupt queue for completed packets. The return value
693 * points to the part of the buffer passed to create_int_queue()
694 * corresponding to the completed packet.
695 *
696 * @queue: queue to poll
697 *
698 * @return Pointer to the data of the first completed packet, or
699 * NULL if no packets are ready
700 */
701 void * (*poll_int_queue)(struct udevice *bus, struct usb_device *udev,
702 struct int_queue *queue);
703
704 /**
705 * destroy_int_queue() - Destroy an interrupt queue
706 *
707 * Destroy an interrupt queue created by create_int_queue().
708 *
709 * @queue: queue to poll
710 *
711 * @return 0 if OK, -ve on error
712 */
713 int (*destroy_int_queue)(struct udevice *bus, struct usb_device *udev,
714 struct int_queue *queue);
715
Simon Glassde312132015-03-25 12:21:59 -0600716 /**
717 * alloc_device() - Allocate a new device context (XHCI)
718 *
719 * Before sending packets to a new device on an XHCI bus, a device
720 * context must be created. If this method is not NULL it will be
721 * called before the device is enumerated (even before its descriptor
722 * is read). This should be NULL for EHCI, which does not need this.
723 */
724 int (*alloc_device)(struct udevice *bus, struct usb_device *udev);
Hans de Goedeb2f219b2015-06-17 21:33:52 +0200725
726 /**
727 * reset_root_port() - Reset usb root port
728 */
729 int (*reset_root_port)(struct udevice *bus, struct usb_device *udev);
Simon Glassde312132015-03-25 12:21:59 -0600730};
731
732#define usb_get_ops(dev) ((struct dm_usb_ops *)(dev)->driver->ops)
733#define usb_get_emul_ops(dev) ((struct dm_usb_ops *)(dev)->driver->ops)
734
Simon Glassde312132015-03-25 12:21:59 -0600735/**
736 * usb_get_dev_index() - look up a device index number
737 *
738 * Look up devices using their index number (starting at 0). This works since
739 * in U-Boot device addresses are allocated starting at 1 with no gaps.
740 *
741 * TODO(sjg@chromium.org): Remove this function when usb_ether.c is modified
742 * to work better with driver model.
743 *
744 * @bus: USB bus to check
745 * @index: Index number of device to find (0=first). This is just the
746 * device address less 1.
747 */
748struct usb_device *usb_get_dev_index(struct udevice *bus, int index);
749
750/**
Simon Glassde312132015-03-25 12:21:59 -0600751 * usb_setup_device() - set up a device ready for use
752 *
753 * @dev: USB device pointer. This need not be a real device - it is
754 * common for it to just be a local variable with its ->dev
Hans de Goede9eb72dd2015-06-17 21:33:46 +0200755 * member (i.e. @dev->dev) set to the parent device and
756 * dev->portnr set to the port number on the hub (1=first)
Simon Glassde312132015-03-25 12:21:59 -0600757 * @do_read: true to read the device descriptor before an address is set
758 * (should be false for XHCI buses, true otherwise)
759 * @parent: Parent device (either UCLASS_USB or UCLASS_USB_HUB)
Simon Glassde312132015-03-25 12:21:59 -0600760 * @return 0 if OK, -ve on error */
761int usb_setup_device(struct usb_device *dev, bool do_read,
Hans de Goede9eb72dd2015-06-17 21:33:46 +0200762 struct usb_device *parent);
Simon Glassde312132015-03-25 12:21:59 -0600763
764/**
765 * usb_hub_scan() - Scan a hub and find its devices
766 *
767 * @hub: Hub device to scan
768 */
769int usb_hub_scan(struct udevice *hub);
770
771/**
772 * usb_scan_device() - Scan a device on a bus
773 *
774 * Scan a device on a bus. It has already been detected and is ready to
775 * be enumerated. This may be either the root hub (@parent is a bus) or a
776 * normal device (@parent is a hub)
777 *
778 * @parent: Parent device
779 * @port: Hub port number (numbered from 1)
780 * @speed: USB speed to use for this device
781 * @devp: Returns pointer to device if all is well
782 * @return 0 if OK, -ve on error
783 */
784int usb_scan_device(struct udevice *parent, int port,
785 enum usb_device_speed speed, struct udevice **devp);
786
787/**
788 * usb_get_bus() - Find the bus for a device
789 *
790 * Search up through parents to find the bus this device is connected to. This
791 * will be a device with uclass UCLASS_USB.
792 *
793 * @dev: Device to check
Hans de Goedef78a5c02015-05-05 11:54:31 +0200794 * @return The bus, or NULL if not found (this indicates a critical error in
795 * the USB stack
Simon Glassde312132015-03-25 12:21:59 -0600796 */
Hans de Goedef78a5c02015-05-05 11:54:31 +0200797struct udevice *usb_get_bus(struct udevice *dev);
Simon Glassde312132015-03-25 12:21:59 -0600798
799/**
800 * usb_select_config() - Set up a device ready for use
801 *
802 * This function assumes that the device already has an address and a driver
803 * bound, and is ready to be set up.
804 *
805 * This re-reads the device and configuration descriptors and sets the
806 * configuration
807 *
808 * @dev: Device to set up
809 */
810int usb_select_config(struct usb_device *dev);
811
812/**
813 * usb_child_pre_probe() - Pre-probe function for USB devices
814 *
815 * This is called on all children of hubs and USB controllers (i.e. UCLASS_USB
816 * and UCLASS_USB_HUB) when a new device is about to be probed. It sets up the
817 * device from the saved platform data and calls usb_select_config() to
818 * finish set up.
819 *
820 * Once this is done, the device's normal driver can take over, knowing the
821 * device is accessible on the USB bus.
822 *
823 * This function is for use only by the internal USB stack.
824 *
825 * @dev: Device to set up
826 */
827int usb_child_pre_probe(struct udevice *dev);
828
829struct ehci_ctrl;
830
831/**
832 * usb_setup_ehci_gadget() - Set up a USB device as a gadget
833 *
834 * TODO(sjg@chromium.org): Tidy this up when USB gadgets can use driver model
835 *
836 * This provides a way to tell a controller to start up as a USB device
837 * instead of as a host. It is untested.
838 */
839int usb_setup_ehci_gadget(struct ehci_ctrl **ctlrp);
840
841/**
842 * usb_stor_reset() - Prepare to scan USB storage devices
843 *
844 * Empty the list of USB storage devices in preparation for scanning them.
845 * This must be called before a USB scan.
846 */
847void usb_stor_reset(void);
848
849#else /* !CONFIG_DM_USB */
850
851struct usb_device *usb_get_dev_index(int index);
852
853#endif
854
855bool usb_device_has_child_on_port(struct usb_device *parent, int port);
856
Marek Vasut23faf2b2012-02-13 18:58:17 +0000857int usb_hub_probe(struct usb_device *dev, int ifnum);
858void usb_hub_reset(void);
Simon Glass862e75c2015-03-25 12:22:04 -0600859
860/**
861 * legacy_hub_port_reset() - reset a port given its usb_device pointer
862 *
863 * Reset a hub port and see if a device is present on that port, providing
864 * sufficient time for it to show itself. The port status is returned.
865 *
866 * With driver model this moves to hub_port_reset() and is passed a struct
867 * udevice.
868 *
869 * @dev: USB device to reset
870 * @port: Port number to reset (note ports are numbered from 0 here)
871 * @portstat: Returns port status
872 */
873int legacy_hub_port_reset(struct usb_device *dev, int port,
Marek Vasut23faf2b2012-02-13 18:58:17 +0000874 unsigned short *portstat);
875
Simon Glass862e75c2015-03-25 12:22:04 -0600876int hub_port_reset(struct udevice *dev, int port, unsigned short *portstat);
877
Simon Glass79b58882015-03-25 12:22:01 -0600878/**
879 * usb_alloc_new_device() - Allocate a new device
880 *
881 * @devp: returns a pointer of a new device structure. With driver model this
882 * is a device pointer, but with legacy USB this pointer is
883 * driver-specific.
884 * @return 0 if OK, -ENOSPC if we have found out of room for new devices
885 */
886int usb_alloc_new_device(struct udevice *controller, struct usb_device **devp);
887
888/**
889 * usb_free_device() - Free a partially-inited device
890 *
891 * This is an internal function. It is used to reverse the action of
892 * usb_alloc_new_device() when we hit a problem during init.
893 */
894void usb_free_device(struct udevice *controller);
Lucas Stachc7e3b2b2012-09-26 00:14:34 +0200895
Marek Vasut23faf2b2012-02-13 18:58:17 +0000896int usb_new_device(struct usb_device *dev);
Simon Glass79b58882015-03-25 12:22:01 -0600897
Vivek Gautam5853e132013-09-14 14:02:45 +0530898int usb_alloc_device(struct usb_device *dev);
Marek Vasut23faf2b2012-02-13 18:58:17 +0000899
Simon Glass019808f2015-03-25 12:22:37 -0600900/**
901 * usb_emul_setup_device() - Set up a new USB device emulation
902 *
903 * This is normally called when a new emulation device is bound. It tells
904 * the USB emulation uclass about the features of the emulator.
905 *
906 * @dev: Emulation device
907 * @maxpacketsize: Maximum packet size (e.g. PACKET_SIZE_64)
908 * @strings: List of USB string descriptors, terminated by a NULL
909 * entry
910 * @desc_list: List of points or USB descriptors, terminated by NULL.
911 * The first entry must be struct usb_device_descriptor,
912 * and others follow on after that.
913 * @return 0 if OK, -ve on error
914 */
915int usb_emul_setup_device(struct udevice *dev, int maxpacketsize,
916 struct usb_string *strings, void **desc_list);
917
918/**
919 * usb_emul_control() - Send a control packet to an emulator
920 *
921 * @emul: Emulator device
922 * @udev: USB device (which the emulator is causing to appear)
923 * See struct dm_usb_ops for details on other parameters
924 * @return 0 if OK, -ve on error
925 */
926int usb_emul_control(struct udevice *emul, struct usb_device *udev,
927 unsigned long pipe, void *buffer, int length,
928 struct devrequest *setup);
929
930/**
931 * usb_emul_bulk() - Send a bulk packet to an emulator
932 *
933 * @emul: Emulator device
934 * @udev: USB device (which the emulator is causing to appear)
935 * See struct dm_usb_ops for details on other parameters
936 * @return 0 if OK, -ve on error
937 */
938int usb_emul_bulk(struct udevice *emul, struct usb_device *udev,
939 unsigned long pipe, void *buffer, int length);
940
941/**
Simon Glassb70a3fe2015-11-08 23:48:05 -0700942 * usb_emul_int() - Send an interrupt packet to an emulator
943 *
944 * @emul: Emulator device
945 * @udev: USB device (which the emulator is causing to appear)
946 * See struct dm_usb_ops for details on other parameters
947 * @return 0 if OK, -ve on error
948 */
949int usb_emul_int(struct udevice *emul, struct usb_device *udev,
950 unsigned long pipe, void *buffer, int length, int interval);
951
952/**
Simon Glass019808f2015-03-25 12:22:37 -0600953 * usb_emul_find() - Find an emulator for a particular device
954 *
955 * Check @pipe to find a device number on bus @bus and return it.
956 *
957 * @bus: USB bus (controller)
958 * @pipe: Describes pipe being used, and includes the device number
959 * @emulp: Returns pointer to emulator, or NULL if not found
960 * @return 0 if found, -ve on error
961 */
962int usb_emul_find(struct udevice *bus, ulong pipe, struct udevice **emulp);
963
964/**
Simon Glassaf9c7c12015-11-08 23:47:55 -0700965 * usb_emul_find_for_dev() - Find an emulator for a particular device
966 *
967 * @bus: USB bus (controller)
968 * @dev: USB device to check
969 * @emulp: Returns pointer to emulator, or NULL if not found
970 * @return 0 if found, -ve on error
971 */
972int usb_emul_find_for_dev(struct udevice *dev, struct udevice **emulp);
973
974/**
Simon Glass019808f2015-03-25 12:22:37 -0600975 * usb_emul_reset() - Reset all emulators ready for use
976 *
977 * Clear out any address information in the emulators and make then ready for
978 * a new USB scan
979 */
980void usb_emul_reset(struct udevice *dev);
981
Simon Glass45bfa472015-11-08 23:47:51 -0700982/**
983 * usb_show_tree() - show the USB device tree
984 *
985 * This shows a list of active USB devices along with basic information about
986 * each.
987 */
988void usb_show_tree(void);
989
wdenk012771d2002-03-08 21:31:05 +0000990#endif /*_USB_H_ */