blob: b3851fdb4f969bcfb3b47639c700fcc205172b51 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
wdenk012771d2002-03-08 21:31:05 +00002/*
3 * (C) Copyright 2001
4 * Denis Peter, MPL AG Switzerland
5 *
Simon Glassde312132015-03-25 12:21:59 -06006 * Adapted for U-Boot driver model
7 * (C) Copyright 2015 Google, Inc
wdenk012771d2002-03-08 21:31:05 +00008 * Note: Part of this code has been derived from linux
9 *
10 */
11#ifndef _USB_H_
12#define _USB_H_
13
Simon Glassde312132015-03-25 12:21:59 -060014#include <fdtdec.h>
wdenk012771d2002-03-08 21:31:05 +000015#include <usb_defs.h>
Ilya Yanokc60795f2012-11-06 13:48:20 +000016#include <linux/usb/ch9.h>
Masahiro Yamadaa8c2ebc2014-11-07 18:34:55 +090017#include <asm/cache.h>
18#include <part.h>
wdenk012771d2002-03-08 21:31:05 +000019
Tom Rini71c5de42012-07-15 22:14:24 +000020/*
21 * The EHCI spec says that we must align to at least 32 bytes. However,
22 * some platforms require larger alignment.
23 */
24#if ARCH_DMA_MINALIGN > 32
25#define USB_DMA_MINALIGN ARCH_DMA_MINALIGN
26#else
27#define USB_DMA_MINALIGN 32
28#endif
29
wdenk012771d2002-03-08 21:31:05 +000030/* Everything is aribtrary */
wdenk5cf91d62004-04-23 20:32:05 +000031#define USB_ALTSETTINGALLOC 4
32#define USB_MAXALTSETTING 128 /* Hard limit */
wdenk012771d2002-03-08 21:31:05 +000033
wdenk5cf91d62004-04-23 20:32:05 +000034#define USB_MAX_DEVICE 32
35#define USB_MAXCONFIG 8
36#define USB_MAXINTERFACES 8
37#define USB_MAXENDPOINTS 16
38#define USB_MAXCHILDREN 8 /* This is arbitrary */
39#define USB_MAX_HUB 16
wdenk012771d2002-03-08 21:31:05 +000040
41#define USB_CNTL_TIMEOUT 100 /* 100ms timeout */
42
Simon Glass96820a32011-02-07 14:42:16 -080043/*
44 * This is the timeout to allow for submitting an urb in ms. We allow more
45 * time for a BULK device to react - some are slow.
46 */
Jason Cooper80b350a2011-07-31 20:09:58 +000047#define USB_TIMEOUT_MS(pipe) (usb_pipebulk(pipe) ? 5000 : 1000)
Simon Glass96820a32011-02-07 14:42:16 -080048
wdenk012771d2002-03-08 21:31:05 +000049/* device request (setup) */
50struct devrequest {
Sergey Temerkhanovb12242a2015-04-01 17:18:44 +030051 __u8 requesttype;
52 __u8 request;
53 __le16 value;
54 __le16 index;
55 __le16 length;
wdenk012771d2002-03-08 21:31:05 +000056} __attribute__ ((packed));
57
Tom Rix8f8bd562009-10-31 12:37:38 -050058/* Interface */
59struct usb_interface {
60 struct usb_interface_descriptor desc;
wdenk012771d2002-03-08 21:31:05 +000061
Sergey Temerkhanovb12242a2015-04-01 17:18:44 +030062 __u8 no_of_ep;
63 __u8 num_altsetting;
64 __u8 act_altsetting;
Michael Trimarchide39f8c2008-11-26 17:41:34 +010065
wdenk012771d2002-03-08 21:31:05 +000066 struct usb_endpoint_descriptor ep_desc[USB_MAXENDPOINTS];
Vivek Gautam6497c662013-04-12 16:34:38 +053067 /*
68 * Super Speed Device will have Super Speed Endpoint
69 * Companion Descriptor (section 9.6.7 of usb 3.0 spec)
70 * Revision 1.0 June 6th 2011
71 */
72 struct usb_ss_ep_comp_descriptor ss_ep_comp_desc[USB_MAXENDPOINTS];
wdenk012771d2002-03-08 21:31:05 +000073} __attribute__ ((packed));
74
Tom Rix8f8bd562009-10-31 12:37:38 -050075/* Configuration information.. */
76struct usb_config {
Ilya Yanokc60795f2012-11-06 13:48:20 +000077 struct usb_config_descriptor desc;
wdenk012771d2002-03-08 21:31:05 +000078
Sergey Temerkhanovb12242a2015-04-01 17:18:44 +030079 __u8 no_of_if; /* number of interfaces */
Tom Rix8f8bd562009-10-31 12:37:38 -050080 struct usb_interface if_desc[USB_MAXINTERFACES];
wdenk012771d2002-03-08 21:31:05 +000081} __attribute__ ((packed));
82
Remy Bohmer48867202008-10-10 10:23:21 +020083enum {
84 /* Maximum packet size; encoded as 0,1,2,3 = 8,16,32,64 */
85 PACKET_SIZE_8 = 0,
86 PACKET_SIZE_16 = 1,
87 PACKET_SIZE_32 = 2,
88 PACKET_SIZE_64 = 3,
89};
wdenk012771d2002-03-08 21:31:05 +000090
Simon Glassde312132015-03-25 12:21:59 -060091/**
92 * struct usb_device - information about a USB device
93 *
94 * With driver model both UCLASS_USB (the USB controllers) and UCLASS_USB_HUB
95 * (the hubs) have this as parent data. Hubs are children of controllers or
96 * other hubs and there is always a single root hub for each controller.
97 * Therefore struct usb_device can always be accessed with
Simon Glassbcbe3d12015-09-28 23:32:01 -060098 * dev_get_parent_priv(dev), where dev is a USB device.
Simon Glassde312132015-03-25 12:21:59 -060099 *
100 * Pointers exist for obtaining both the device (could be any uclass) and
101 * controller (UCLASS_USB) from this structure. The controller does not have
102 * a struct usb_device since it is not a device.
103 */
wdenk012771d2002-03-08 21:31:05 +0000104struct usb_device {
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100105 int devnum; /* Device number on USB bus */
Simon Glass25a83812020-05-10 10:26:53 -0600106 enum usb_device_speed speed; /* full/low/high */
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100107 char mf[32]; /* manufacturer */
108 char prod[32]; /* product */
109 char serial[32]; /* serial number */
wdenk012771d2002-03-08 21:31:05 +0000110
Remy Bohmer48867202008-10-10 10:23:21 +0200111 /* Maximum packet size; one of: PACKET_SIZE_* */
112 int maxpacketsize;
113 /* one bit for each endpoint ([0] = IN, [1] = OUT) */
114 unsigned int toggle[2];
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100115 /* endpoint halts; one bit per endpoint # & direction;
116 * [0] = IN, [1] = OUT
117 */
Remy Bohmer48867202008-10-10 10:23:21 +0200118 unsigned int halted[2];
wdenk012771d2002-03-08 21:31:05 +0000119 int epmaxpacketin[16]; /* INput endpoint specific maximums */
120 int epmaxpacketout[16]; /* OUTput endpoint specific maximums */
121
122 int configno; /* selected config number */
Puneet Saxenaf5766132012-04-03 14:56:06 +0530123 /* Device Descriptor */
124 struct usb_device_descriptor descriptor
125 __attribute__((aligned(ARCH_DMA_MINALIGN)));
Tom Rix8f8bd562009-10-31 12:37:38 -0500126 struct usb_config config; /* config descriptor */
wdenk012771d2002-03-08 21:31:05 +0000127
128 int have_langid; /* whether string_langid is valid yet */
129 int string_langid; /* language ID for strings */
130 int (*irq_handle)(struct usb_device *dev);
131 unsigned long irq_status;
Vagrant Cascadiana6f70a32016-03-15 12:16:39 -0700132 int irq_act_len; /* transferred bytes */
wdenk012771d2002-03-08 21:31:05 +0000133 void *privptr;
134 /*
135 * Child devices - if this is a hub device
136 * Each instance needs its own set of data structures.
137 */
138 unsigned long status;
Hans de Goede904f2a82015-01-11 20:34:54 +0100139 unsigned long int_pending; /* 1 bit per ep, used by int_queue */
Vagrant Cascadiana6f70a32016-03-15 12:16:39 -0700140 int act_len; /* transferred bytes */
wdenk012771d2002-03-08 21:31:05 +0000141 int maxchild; /* Number of ports if hub */
Simon Glassde312132015-03-25 12:21:59 -0600142 int portnr; /* Port number, 1=first */
Sven Schwermerfd09c202018-11-21 08:43:56 +0100143#if !CONFIG_IS_ENABLED(DM_USB)
Simon Glassde312132015-03-25 12:21:59 -0600144 /* parent hub, or NULL if this is the root hub */
wdenk012771d2002-03-08 21:31:05 +0000145 struct usb_device *parent;
146 struct usb_device *children[USB_MAXCHILDREN];
Lucas Stachc7e3b2b2012-09-26 00:14:34 +0200147 void *controller; /* hardware controller private data */
Simon Glassde312132015-03-25 12:21:59 -0600148#endif
Vivek Gautam5853e132013-09-14 14:02:45 +0530149 /* slot_id - for xHCI enabled devices */
150 unsigned int slot_id;
Sven Schwermerfd09c202018-11-21 08:43:56 +0100151#if CONFIG_IS_ENABLED(DM_USB)
Simon Glassde312132015-03-25 12:21:59 -0600152 struct udevice *dev; /* Pointer to associated device */
153 struct udevice *controller_dev; /* Pointer to associated controller */
154#endif
wdenk012771d2002-03-08 21:31:05 +0000155};
156
Hans de Goede8460b892014-09-24 14:06:06 +0200157struct int_queue;
158
Troy Kiskybba67912013-10-10 15:27:55 -0700159/*
160 * You can initialize platform's USB host or device
161 * ports by passing this enum as an argument to
162 * board_usb_init().
163 */
164enum usb_init_type {
165 USB_INIT_HOST,
166 USB_INIT_DEVICE
167};
168
wdenk012771d2002-03-08 21:31:05 +0000169/**********************************************************************
170 * this is how the lowlevel part communicate with the outer world
171 */
172
Troy Kisky06d513e2013-10-10 15:27:56 -0700173int usb_lowlevel_init(int index, enum usb_init_type init, void **controller);
Lucas Stachc7e3b2b2012-09-26 00:14:34 +0200174int usb_lowlevel_stop(int index);
Simon Glassde312132015-03-25 12:21:59 -0600175
Sven Schwermerfd09c202018-11-21 08:43:56 +0100176#if defined(CONFIG_USB_MUSB_HOST) || CONFIG_IS_ENABLED(DM_USB)
Hans de Goede8802f562015-06-17 21:33:48 +0200177int usb_reset_root_port(struct usb_device *dev);
Hans de Goede90cdc102015-01-11 20:34:51 +0100178#else
Hans de Goede8802f562015-06-17 21:33:48 +0200179#define usb_reset_root_port(dev)
Hans de Goede90cdc102015-01-11 20:34:51 +0100180#endif
Lucas Stachc7e3b2b2012-09-26 00:14:34 +0200181
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100182int submit_bulk_msg(struct usb_device *dev, unsigned long pipe,
183 void *buffer, int transfer_len);
wdenk012771d2002-03-08 21:31:05 +0000184int submit_control_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100185 int transfer_len, struct devrequest *setup);
wdenk012771d2002-03-08 21:31:05 +0000186int submit_int_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
Michal Suchanek34371212019-08-18 10:55:27 +0200187 int transfer_len, int interval, bool nonblock);
wdenk012771d2002-03-08 21:31:05 +0000188
Tom Rini8850c5d2017-05-12 22:33:27 -0400189#if defined CONFIG_USB_EHCI_HCD || defined CONFIG_USB_MUSB_HOST \
Sven Schwermerfd09c202018-11-21 08:43:56 +0100190 || CONFIG_IS_ENABLED(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
Simon Glass70caa972016-01-03 13:50:30 -0700230#define USB_MAX_STOR_DEV 7
wdenk012771d2002-03-08 21:31:05 +0000231int usb_stor_scan(int mode);
Anatolij Gustschine813eae2008-03-26 17:47:44 +0100232int usb_stor_info(void);
wdenk012771d2002-03-08 21:31:05 +0000233
234#endif
235
Simon Glass89d48362011-02-16 11:14:33 -0800236#ifdef CONFIG_USB_HOST_ETHER
237
238#define USB_MAX_ETH_DEV 5
239int usb_host_eth_scan(int mode);
240
241#endif
242
wdenk012771d2002-03-08 21:31:05 +0000243#ifdef CONFIG_USB_KEYBOARD
244
Heinrich Schuchardte91a4112019-11-23 18:15:22 +0100245/*
246 * USB Keyboard reports are 8 bytes in boot protocol.
247 * Appendix B of HID Device Class Definition 1.11
248 */
249#define USB_KBD_BOOT_REPORT_SIZE 8
250
wdenk012771d2002-03-08 21:31:05 +0000251int drv_usb_kbd_init(void);
Hans de Goede8a8a2252014-09-20 16:54:38 +0200252int usb_kbd_deregister(int force);
wdenk012771d2002-03-08 21:31:05 +0000253
254#endif
255/* routines */
256int usb_init(void); /* initialize the USB Controller */
257int usb_stop(void); /* stop the USB Controller */
Vincent Palatin08f3bb02015-05-04 11:30:54 -0600258int usb_detect_change(void); /* detect if a USB device has been (un)plugged */
wdenk012771d2002-03-08 21:31:05 +0000259
260
261int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol);
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100262int usb_set_idle(struct usb_device *dev, int ifnum, int duration,
263 int report_id);
wdenk012771d2002-03-08 21:31:05 +0000264int usb_control_msg(struct usb_device *dev, unsigned int pipe,
265 unsigned char request, unsigned char requesttype,
266 unsigned short value, unsigned short index,
267 void *data, unsigned short size, int timeout);
268int usb_bulk_msg(struct usb_device *dev, unsigned int pipe,
269 void *data, int len, int *actual_length, int timeout);
Michal Suchanekfdd135b2019-08-18 10:55:25 +0200270int usb_int_msg(struct usb_device *dev, unsigned long pipe,
Michal Suchanek34371212019-08-18 10:55:27 +0200271 void *buffer, int transfer_len, int interval, bool nonblock);
Marek Vasut31232de2020-04-06 14:29:44 +0200272int usb_lock_async(struct usb_device *dev, int lock);
Simon Glass89d48362011-02-16 11:14:33 -0800273int usb_disable_asynch(int disable);
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100274int usb_maxpacket(struct usb_device *dev, unsigned long pipe);
Stefan BrĂ¼nsc75f57f2015-12-22 01:18:13 +0100275int usb_get_configuration_no(struct usb_device *dev, int cfgno,
276 unsigned char *buffer, int length);
277int usb_get_configuration_len(struct usb_device *dev, int cfgno);
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100278int usb_get_report(struct usb_device *dev, int ifnum, unsigned char type,
279 unsigned char id, void *buf, int size);
wdenk012771d2002-03-08 21:31:05 +0000280int usb_get_class_descriptor(struct usb_device *dev, int ifnum,
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100281 unsigned char type, unsigned char id, void *buf,
282 int size);
wdenk012771d2002-03-08 21:31:05 +0000283int usb_clear_halt(struct usb_device *dev, int pipe);
284int usb_string(struct usb_device *dev, int index, char *buf, size_t size);
285int usb_set_interface(struct usb_device *dev, int interface, int alternate);
Vincent Palatin08f3bb02015-05-04 11:30:54 -0600286int usb_get_port_status(struct usb_device *dev, int port, void *data);
wdenk012771d2002-03-08 21:31:05 +0000287
288/* big endian -> little endian conversion */
wdenk149dded2003-09-10 18:20:28 +0000289/* some CPUs are already little endian e.g. the ARM920T */
Markus Klotzbuecherae3b7702006-11-27 11:46:46 +0100290#define __swap_16(x) \
wdenk3f85ce22004-02-23 16:11:30 +0000291 ({ unsigned short x_ = (unsigned short)x; \
292 (unsigned short)( \
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100293 ((x_ & 0x00FFU) << 8) | ((x_ & 0xFF00U) >> 8)); \
wdenk3f85ce22004-02-23 16:11:30 +0000294 })
Markus Klotzbuecherae3b7702006-11-27 11:46:46 +0100295#define __swap_32(x) \
wdenk3f85ce22004-02-23 16:11:30 +0000296 ({ unsigned long x_ = (unsigned long)x; \
297 (unsigned long)( \
298 ((x_ & 0x000000FFUL) << 24) | \
wdenk5cf91d62004-04-23 20:32:05 +0000299 ((x_ & 0x0000FF00UL) << 8) | \
300 ((x_ & 0x00FF0000UL) >> 8) | \
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100301 ((x_ & 0xFF000000UL) >> 24)); \
wdenk3f85ce22004-02-23 16:11:30 +0000302 })
Markus Klotzbuecherae3b7702006-11-27 11:46:46 +0100303
Mike Frysingerc7d703f2009-01-01 18:27:27 -0500304#ifdef __LITTLE_ENDIAN
Markus Klotzbuecherae3b7702006-11-27 11:46:46 +0100305# define swap_16(x) (x)
306# define swap_32(x) (x)
307#else
308# define swap_16(x) __swap_16(x)
309# define swap_32(x) __swap_32(x)
Mike Frysingerc7d703f2009-01-01 18:27:27 -0500310#endif
wdenk012771d2002-03-08 21:31:05 +0000311
312/*
313 * Calling this entity a "pipe" is glorifying it. A USB pipe
314 * is something embarrassingly simple: it basically consists
315 * of the following information:
316 * - device number (7 bits)
317 * - endpoint number (4 bits)
318 * - current Data0/1 state (1 bit)
319 * - direction (1 bit)
Michael Trimarchi3e126482008-11-28 13:19:19 +0100320 * - speed (2 bits)
wdenk012771d2002-03-08 21:31:05 +0000321 * - max packet size (2 bits: 8, 16, 32 or 64)
322 * - pipe type (2 bits: control, interrupt, bulk, isochronous)
323 *
324 * That's 18 bits. Really. Nothing more. And the USB people have
325 * documented these eighteen bits as some kind of glorious
326 * virtual data structure.
327 *
328 * Let's not fall in that trap. We'll just encode it as a simple
329 * unsigned int. The encoding is:
330 *
331 * - max size: bits 0-1 (00 = 8, 01 = 16, 10 = 32, 11 = 64)
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100332 * - direction: bit 7 (0 = Host-to-Device [Out],
333 * (1 = Device-to-Host [In])
wdenk012771d2002-03-08 21:31:05 +0000334 * - device: bits 8-14
335 * - endpoint: bits 15-18
336 * - Data0/1: bit 19
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100337 * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt,
338 * 10 = control, 11 = bulk)
wdenk012771d2002-03-08 21:31:05 +0000339 *
340 * Why? Because it's arbitrary, and whatever encoding we select is really
341 * up to us. This one happens to share a lot of bit positions with the UHCI
342 * specification, so that much of the uhci driver can just mask the bits
343 * appropriately.
344 */
345/* Create various pipes... */
346#define create_pipe(dev,endpoint) \
Sergei Shtylyovd0fe1122010-05-26 21:26:43 +0400347 (((dev)->devnum << 8) | ((endpoint) << 15) | \
Ilya Yanokc60795f2012-11-06 13:48:20 +0000348 (dev)->maxpacketsize)
Michael Trimarchi3e126482008-11-28 13:19:19 +0100349#define default_pipe(dev) ((dev)->speed << 26)
wdenk012771d2002-03-08 21:31:05 +0000350
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100351#define usb_sndctrlpipe(dev, endpoint) ((PIPE_CONTROL << 30) | \
352 create_pipe(dev, endpoint))
353#define usb_rcvctrlpipe(dev, endpoint) ((PIPE_CONTROL << 30) | \
354 create_pipe(dev, endpoint) | \
355 USB_DIR_IN)
356#define usb_sndisocpipe(dev, endpoint) ((PIPE_ISOCHRONOUS << 30) | \
357 create_pipe(dev, endpoint))
358#define usb_rcvisocpipe(dev, endpoint) ((PIPE_ISOCHRONOUS << 30) | \
359 create_pipe(dev, endpoint) | \
360 USB_DIR_IN)
361#define usb_sndbulkpipe(dev, endpoint) ((PIPE_BULK << 30) | \
362 create_pipe(dev, endpoint))
363#define usb_rcvbulkpipe(dev, endpoint) ((PIPE_BULK << 30) | \
364 create_pipe(dev, endpoint) | \
365 USB_DIR_IN)
366#define usb_sndintpipe(dev, endpoint) ((PIPE_INTERRUPT << 30) | \
367 create_pipe(dev, endpoint))
368#define usb_rcvintpipe(dev, endpoint) ((PIPE_INTERRUPT << 30) | \
369 create_pipe(dev, endpoint) | \
370 USB_DIR_IN)
371#define usb_snddefctrl(dev) ((PIPE_CONTROL << 30) | \
372 default_pipe(dev))
373#define usb_rcvdefctrl(dev) ((PIPE_CONTROL << 30) | \
374 default_pipe(dev) | \
375 USB_DIR_IN)
wdenk012771d2002-03-08 21:31:05 +0000376
377/* The D0/D1 toggle bits */
378#define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> ep) & 1)
wdenk5cf91d62004-04-23 20:32:05 +0000379#define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << ep))
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100380#define usb_settoggle(dev, ep, out, bit) ((dev)->toggle[out] = \
381 ((dev)->toggle[out] & \
382 ~(1 << ep)) | ((bit) << ep))
wdenk012771d2002-03-08 21:31:05 +0000383
384/* Endpoint halt control/status */
385#define usb_endpoint_out(ep_dir) (((ep_dir >> 7) & 1) ^ 1)
386#define usb_endpoint_halt(dev, ep, out) ((dev)->halted[out] |= (1 << (ep)))
387#define usb_endpoint_running(dev, ep, out) ((dev)->halted[out] &= ~(1 << (ep)))
388#define usb_endpoint_halted(dev, ep, out) ((dev)->halted[out] & (1 << (ep)))
389
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100390#define usb_packetid(pipe) (((pipe) & USB_DIR_IN) ? USB_PID_IN : \
391 USB_PID_OUT)
wdenk012771d2002-03-08 21:31:05 +0000392
393#define usb_pipeout(pipe) ((((pipe) >> 7) & 1) ^ 1)
394#define usb_pipein(pipe) (((pipe) >> 7) & 1)
395#define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f)
396#define usb_pipe_endpdev(pipe) (((pipe) >> 8) & 0x7ff)
397#define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf)
398#define usb_pipedata(pipe) (((pipe) >> 19) & 1)
wdenk012771d2002-03-08 21:31:05 +0000399#define usb_pipetype(pipe) (((pipe) >> 30) & 3)
400#define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
401#define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT)
402#define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL)
403#define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK)
404
Vivek Gautam5853e132013-09-14 14:02:45 +0530405#define usb_pipe_ep_index(pipe) \
406 usb_pipecontrol(pipe) ? (usb_pipeendpoint(pipe) * 2) : \
407 ((usb_pipeendpoint(pipe) * 2) - \
408 (usb_pipein(pipe) ? 0 : 1))
wdenk012771d2002-03-08 21:31:05 +0000409
Simon Glass0566e242015-03-25 12:22:30 -0600410/**
411 * struct usb_device_id - identifies USB devices for probing and hotplugging
412 * @match_flags: Bit mask controlling which of the other fields are used to
413 * match against new devices. Any field except for driver_info may be
414 * used, although some only make sense in conjunction with other fields.
415 * This is usually set by a USB_DEVICE_*() macro, which sets all
416 * other fields in this structure except for driver_info.
417 * @idVendor: USB vendor ID for a device; numbers are assigned
418 * by the USB forum to its members.
419 * @idProduct: Vendor-assigned product ID.
420 * @bcdDevice_lo: Low end of range of vendor-assigned product version numbers.
421 * This is also used to identify individual product versions, for
422 * a range consisting of a single device.
423 * @bcdDevice_hi: High end of version number range. The range of product
424 * versions is inclusive.
425 * @bDeviceClass: Class of device; numbers are assigned
426 * by the USB forum. Products may choose to implement classes,
427 * or be vendor-specific. Device classes specify behavior of all
428 * the interfaces on a device.
429 * @bDeviceSubClass: Subclass of device; associated with bDeviceClass.
430 * @bDeviceProtocol: Protocol of device; associated with bDeviceClass.
431 * @bInterfaceClass: Class of interface; numbers are assigned
432 * by the USB forum. Products may choose to implement classes,
433 * or be vendor-specific. Interface classes specify behavior only
434 * of a given interface; other interfaces may support other classes.
435 * @bInterfaceSubClass: Subclass of interface; associated with bInterfaceClass.
436 * @bInterfaceProtocol: Protocol of interface; associated with bInterfaceClass.
437 * @bInterfaceNumber: Number of interface; composite devices may use
438 * fixed interface numbers to differentiate between vendor-specific
439 * interfaces.
440 * @driver_info: Holds information used by the driver. Usually it holds
441 * a pointer to a descriptor understood by the driver, or perhaps
442 * device flags.
443 *
444 * In most cases, drivers will create a table of device IDs by using
445 * USB_DEVICE(), or similar macros designed for that purpose.
446 * They will then export it to userspace using MODULE_DEVICE_TABLE(),
447 * and provide it to the USB core through their usb_driver structure.
448 *
449 * See the usb_match_id() function for information about how matches are
450 * performed. Briefly, you will normally use one of several macros to help
451 * construct these entries. Each entry you provide will either identify
452 * one or more specific products, or will identify a class of products
453 * which have agreed to behave the same. You should put the more specific
454 * matches towards the beginning of your table, so that driver_info can
455 * record quirks of specific products.
456 */
457struct usb_device_id {
458 /* which fields to match against? */
459 u16 match_flags;
460
461 /* Used for product specific matches; range is inclusive */
462 u16 idVendor;
463 u16 idProduct;
464 u16 bcdDevice_lo;
465 u16 bcdDevice_hi;
466
467 /* Used for device class matches */
468 u8 bDeviceClass;
469 u8 bDeviceSubClass;
470 u8 bDeviceProtocol;
471
472 /* Used for interface class matches */
473 u8 bInterfaceClass;
474 u8 bInterfaceSubClass;
475 u8 bInterfaceProtocol;
476
477 /* Used for vendor-specific interface matches */
478 u8 bInterfaceNumber;
479
480 /* not matched against */
481 ulong driver_info;
482};
483
484/* Some useful macros to use to create struct usb_device_id */
485#define USB_DEVICE_ID_MATCH_VENDOR 0x0001
486#define USB_DEVICE_ID_MATCH_PRODUCT 0x0002
487#define USB_DEVICE_ID_MATCH_DEV_LO 0x0004
488#define USB_DEVICE_ID_MATCH_DEV_HI 0x0008
489#define USB_DEVICE_ID_MATCH_DEV_CLASS 0x0010
490#define USB_DEVICE_ID_MATCH_DEV_SUBCLASS 0x0020
491#define USB_DEVICE_ID_MATCH_DEV_PROTOCOL 0x0040
492#define USB_DEVICE_ID_MATCH_INT_CLASS 0x0080
493#define USB_DEVICE_ID_MATCH_INT_SUBCLASS 0x0100
494#define USB_DEVICE_ID_MATCH_INT_PROTOCOL 0x0200
495#define USB_DEVICE_ID_MATCH_INT_NUMBER 0x0400
496
497/* Match anything, indicates this is a valid entry even if everything is 0 */
498#define USB_DEVICE_ID_MATCH_NONE 0x0800
499#define USB_DEVICE_ID_MATCH_ALL 0x07ff
500
501/**
502 * struct usb_driver_entry - Matches a driver to its usb_device_ids
Simon Glassb4839152015-07-06 16:47:47 -0600503 * @driver: Driver to use
504 * @match: List of match records for this driver, terminated by {}
Simon Glass0566e242015-03-25 12:22:30 -0600505 */
506struct usb_driver_entry {
507 struct driver *driver;
508 const struct usb_device_id *match;
509};
510
Simon Glassabb59cf2015-07-06 16:47:51 -0600511#define USB_DEVICE_ID_MATCH_DEVICE \
512 (USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT)
513
514/**
515 * USB_DEVICE - macro used to describe a specific usb device
516 * @vend: the 16 bit USB Vendor ID
517 * @prod: the 16 bit USB Product ID
518 *
519 * This macro is used to create a struct usb_device_id that matches a
520 * specific device.
521 */
522#define USB_DEVICE(vend, prod) \
523 .match_flags = USB_DEVICE_ID_MATCH_DEVICE, \
524 .idVendor = (vend), \
525 .idProduct = (prod)
526
527#define U_BOOT_USB_DEVICE(__name, __match) \
Simon Glass0566e242015-03-25 12:22:30 -0600528 ll_entry_declare(struct usb_driver_entry, __name, usb_driver_entry) = {\
529 .driver = llsym(struct driver, __name, driver), \
530 .match = __match, \
531 }
532
wdenk012771d2002-03-08 21:31:05 +0000533/*************************************************************************
534 * Hub Stuff
535 */
536struct usb_port_status {
537 unsigned short wPortStatus;
538 unsigned short wPortChange;
539} __attribute__ ((packed));
540
541struct usb_hub_status {
542 unsigned short wHubStatus;
543 unsigned short wHubChange;
544} __attribute__ ((packed));
545
Bin Meng5624dfd2017-07-19 21:51:16 +0800546/*
547 * Hub Device descriptor
548 * USB Hub class device protocols
549 */
550#define USB_HUB_PR_FS 0 /* Full speed hub */
551#define USB_HUB_PR_HS_NO_TT 0 /* Hi-speed hub without TT */
552#define USB_HUB_PR_HS_SINGLE_TT 1 /* Hi-speed hub with single TT */
553#define USB_HUB_PR_HS_MULTI_TT 2 /* Hi-speed hub with multiple TT */
554#define USB_HUB_PR_SS 3 /* Super speed hub */
555
556/* Transaction Translator Think Times, in bits */
557#define HUB_TTTT_8_BITS 0x00
558#define HUB_TTTT_16_BITS 0x20
559#define HUB_TTTT_24_BITS 0x40
560#define HUB_TTTT_32_BITS 0x60
wdenk012771d2002-03-08 21:31:05 +0000561
562/* Hub descriptor */
563struct usb_hub_descriptor {
564 unsigned char bLength;
565 unsigned char bDescriptorType;
566 unsigned char bNbrPorts;
567 unsigned short wHubCharacteristics;
568 unsigned char bPwrOn2PwrGood;
569 unsigned char bHubContrCurrent;
Bin Meng337fc7e2017-07-19 21:50:00 +0800570 /* 2.0 and 3.0 hubs differ here */
571 union {
572 struct {
573 /* add 1 bit for hub status change; round to bytes */
574 __u8 DeviceRemovable[(USB_MAXCHILDREN + 1 + 7) / 8];
575 __u8 PortPowerCtrlMask[(USB_MAXCHILDREN + 1 + 7) / 8];
576 } __attribute__ ((packed)) hs;
577
578 struct {
579 __u8 bHubHdrDecLat;
580 __le16 wHubDelay;
581 __le16 DeviceRemovable;
582 } __attribute__ ((packed)) ss;
583 } u;
wdenk012771d2002-03-08 21:31:05 +0000584} __attribute__ ((packed));
585
586
587struct usb_hub_device {
588 struct usb_device *pusb_dev;
589 struct usb_hub_descriptor desc;
Stefan Roesec998da02016-03-15 13:59:15 +0100590
591 ulong connect_timeout; /* Device connection timeout in ms */
592 ulong query_delay; /* Device query delay in ms */
593 int overcurrent_count[USB_MAXCHILDREN]; /* Over-current counter */
Bin Mengbbc6f062017-07-19 21:51:13 +0800594 int hub_depth; /* USB 3.0 hub depth */
Bin Meng5624dfd2017-07-19 21:51:16 +0800595 struct usb_tt tt; /* Transaction Translator */
wdenk012771d2002-03-08 21:31:05 +0000596};
597
Sven Schwermerfd09c202018-11-21 08:43:56 +0100598#if CONFIG_IS_ENABLED(DM_USB)
Simon Glassde312132015-03-25 12:21:59 -0600599/**
Simon Glass8a8d24b2020-12-03 16:55:23 -0700600 * struct usb_plat - Platform data about a USB controller
Simon Glassde312132015-03-25 12:21:59 -0600601 *
Simon Glassc69cda22020-12-03 16:55:20 -0700602 * Given a USB controller (UCLASS_USB) dev this is dev_get_plat(dev)
Simon Glassde312132015-03-25 12:21:59 -0600603 */
Simon Glass8a8d24b2020-12-03 16:55:23 -0700604struct usb_plat {
Simon Glassde312132015-03-25 12:21:59 -0600605 enum usb_init_type init_type;
606};
607
608/**
Simon Glass8a8d24b2020-12-03 16:55:23 -0700609 * struct usb_dev_plat - Platform data about a USB device
Simon Glassde312132015-03-25 12:21:59 -0600610 *
Simon Glasscaa4daa2020-12-03 16:55:18 -0700611 * Given a USB device dev this structure is dev_get_parent_plat(dev).
Simon Glassde312132015-03-25 12:21:59 -0600612 * This is used by sandbox to provide emulation data also.
613 *
614 * @id: ID used to match this device
Simon Glassde312132015-03-25 12:21:59 -0600615 * @devnum: Device address on the USB bus
Hans de Goede7f1a0752015-05-05 11:54:32 +0200616 * @udev: usb-uclass internal use only do NOT use
Simon Glassde312132015-03-25 12:21:59 -0600617 * @strings: List of descriptor strings (for sandbox emulation purposes)
618 * @desc_list: List of descriptors (for sandbox emulation purposes)
619 */
Simon Glass8a8d24b2020-12-03 16:55:23 -0700620struct usb_dev_plat {
Simon Glassde312132015-03-25 12:21:59 -0600621 struct usb_device_id id;
Simon Glassde312132015-03-25 12:21:59 -0600622 int devnum;
Hans de Goede7f1a0752015-05-05 11:54:32 +0200623 /*
624 * This pointer is used to pass the usb_device used in usb_scan_device,
625 * to get the usb descriptors before the driver is known, to the
626 * actual udevice once the driver is known and the udevice is created.
627 * This will be NULL except during probe, do NOT use.
628 *
629 * This should eventually go away.
630 */
631 struct usb_device *udev;
Simon Glassde312132015-03-25 12:21:59 -0600632#ifdef CONFIG_SANDBOX
633 struct usb_string *strings;
634 /* NULL-terminated list of descriptor pointers */
635 struct usb_generic_descriptor **desc_list;
636#endif
637 int configno;
638};
639
640/**
641 * struct usb_bus_priv - information about the USB controller
642 *
643 * Given a USB controller (UCLASS_USB) 'dev', this is
644 * dev_get_uclass_priv(dev).
645 *
646 * @next_addr: Next device address to allocate minus 1. Incremented by 1
647 * each time a new device address is set, so this holds the
648 * number of devices on the bus
649 * @desc_before_addr: true if we can read a device descriptor before it
650 * has been assigned an address. For XHCI this is not possible
651 * so this will be false.
Hans de Goedeb6de4d12015-05-10 14:10:20 +0200652 * @companion: True if this is a companion controller to another USB
653 * controller
Simon Glassde312132015-03-25 12:21:59 -0600654 */
655struct usb_bus_priv {
656 int next_addr;
657 bool desc_before_addr;
Hans de Goedeb6de4d12015-05-10 14:10:20 +0200658 bool companion;
Simon Glassde312132015-03-25 12:21:59 -0600659};
660
661/**
Simon Glass8a8d24b2020-12-03 16:55:23 -0700662 * struct usb_emul_plat - platform data about the USB emulator
Bin Meng84aa8532017-10-01 06:19:39 -0700663 *
664 * Given a USB emulator (UCLASS_USB_EMUL) 'dev', this is
Simon Glasscaa4daa2020-12-03 16:55:18 -0700665 * dev_get_uclass_plat(dev).
Bin Meng84aa8532017-10-01 06:19:39 -0700666 *
667 * @port1: USB emulator device port number on the parent hub
668 */
Simon Glass8a8d24b2020-12-03 16:55:23 -0700669struct usb_emul_plat {
Bin Meng84aa8532017-10-01 06:19:39 -0700670 int port1; /* Port number (numbered from 1) */
671};
672
673/**
Simon Glassde312132015-03-25 12:21:59 -0600674 * struct dm_usb_ops - USB controller operations
675 *
676 * This defines the operations supoorted on a USB controller. Common
677 * arguments are:
678 *
679 * @bus: USB bus (i.e. controller), which is in UCLASS_USB.
680 * @udev: USB device parent data. Controllers are not expected to need
681 * this, since the device address on the bus is encoded in @pipe.
682 * It is used for sandbox, and can be handy for debugging and
683 * logging.
684 * @pipe: An assortment of bitfields which provide address and packet
685 * type information. See create_pipe() above for encoding
686 * details
687 * @buffer: A buffer to use for sending/receiving. This should be
688 * DMA-aligned.
689 * @length: Buffer length in bytes
690 */
691struct dm_usb_ops {
692 /**
693 * control() - Send a control message
694 *
695 * Most parameters are as above.
696 *
697 * @setup: Additional setup information required by the message
698 */
699 int (*control)(struct udevice *bus, struct usb_device *udev,
700 unsigned long pipe, void *buffer, int length,
701 struct devrequest *setup);
702 /**
703 * bulk() - Send a bulk message
704 *
705 * Parameters are as above.
706 */
707 int (*bulk)(struct udevice *bus, struct usb_device *udev,
708 unsigned long pipe, void *buffer, int length);
709 /**
710 * interrupt() - Send an interrupt message
711 *
712 * Most parameters are as above.
713 *
714 * @interval: Interrupt interval
715 */
716 int (*interrupt)(struct udevice *bus, struct usb_device *udev,
717 unsigned long pipe, void *buffer, int length,
Michal Suchanek34371212019-08-18 10:55:27 +0200718 int interval, bool nonblock);
Hans de Goede8a5f0662015-05-10 14:10:18 +0200719
720 /**
721 * create_int_queue() - Create and queue interrupt packets
722 *
723 * Create and queue @queuesize number of interrupt usb packets of
724 * @elementsize bytes each. @buffer must be atleast @queuesize *
725 * @elementsize bytes.
726 *
727 * Note some controllers only support a queuesize of 1.
728 *
729 * @interval: Interrupt interval
730 *
731 * @return A pointer to the created interrupt queue or NULL on error
732 */
733 struct int_queue * (*create_int_queue)(struct udevice *bus,
734 struct usb_device *udev, unsigned long pipe,
735 int queuesize, int elementsize, void *buffer,
736 int interval);
737
738 /**
739 * poll_int_queue() - Poll an interrupt queue for completed packets
740 *
741 * Poll an interrupt queue for completed packets. The return value
742 * points to the part of the buffer passed to create_int_queue()
743 * corresponding to the completed packet.
744 *
745 * @queue: queue to poll
746 *
747 * @return Pointer to the data of the first completed packet, or
748 * NULL if no packets are ready
749 */
750 void * (*poll_int_queue)(struct udevice *bus, struct usb_device *udev,
751 struct int_queue *queue);
752
753 /**
754 * destroy_int_queue() - Destroy an interrupt queue
755 *
756 * Destroy an interrupt queue created by create_int_queue().
757 *
758 * @queue: queue to poll
759 *
760 * @return 0 if OK, -ve on error
761 */
762 int (*destroy_int_queue)(struct udevice *bus, struct usb_device *udev,
763 struct int_queue *queue);
764
Simon Glassde312132015-03-25 12:21:59 -0600765 /**
766 * alloc_device() - Allocate a new device context (XHCI)
767 *
768 * Before sending packets to a new device on an XHCI bus, a device
769 * context must be created. If this method is not NULL it will be
770 * called before the device is enumerated (even before its descriptor
771 * is read). This should be NULL for EHCI, which does not need this.
772 */
773 int (*alloc_device)(struct udevice *bus, struct usb_device *udev);
Hans de Goedeb2f219b2015-06-17 21:33:52 +0200774
775 /**
776 * reset_root_port() - Reset usb root port
777 */
778 int (*reset_root_port)(struct udevice *bus, struct usb_device *udev);
Bin Meng9ca1b4b2017-07-19 21:51:17 +0800779
780 /**
781 * update_hub_device() - Update HCD's internal representation of hub
782 *
783 * After a hub descriptor is fetched, notify HCD so that its internal
784 * representation of this hub can be updated (xHCI)
785 */
786 int (*update_hub_device)(struct udevice *bus, struct usb_device *udev);
Bin Meng3e59f592017-09-07 06:13:17 -0700787
788 /**
789 * get_max_xfer_size() - Get HCD's maximum transfer bytes
790 *
791 * The HCD may have limitation on the maximum bytes to be transferred
792 * in a USB transfer. USB class driver needs to be aware of this.
793 */
794 int (*get_max_xfer_size)(struct udevice *bus, size_t *size);
Marek Vasut31232de2020-04-06 14:29:44 +0200795
796 /**
797 * lock_async() - Keep async schedule after a transfer
798 *
799 * It may be desired to keep the asynchronous schedule running even
800 * after a transfer finishes, usually when doing multiple transfers
801 * back-to-back. This callback allows signalling the USB controller
802 * driver to do just that.
803 */
804 int (*lock_async)(struct udevice *udev, int lock);
Simon Glassde312132015-03-25 12:21:59 -0600805};
806
807#define usb_get_ops(dev) ((struct dm_usb_ops *)(dev)->driver->ops)
808#define usb_get_emul_ops(dev) ((struct dm_usb_ops *)(dev)->driver->ops)
809
Simon Glassde312132015-03-25 12:21:59 -0600810/**
811 * usb_get_dev_index() - look up a device index number
812 *
813 * Look up devices using their index number (starting at 0). This works since
814 * in U-Boot device addresses are allocated starting at 1 with no gaps.
815 *
816 * TODO(sjg@chromium.org): Remove this function when usb_ether.c is modified
817 * to work better with driver model.
818 *
819 * @bus: USB bus to check
820 * @index: Index number of device to find (0=first). This is just the
821 * device address less 1.
822 */
823struct usb_device *usb_get_dev_index(struct udevice *bus, int index);
824
825/**
Simon Glassde312132015-03-25 12:21:59 -0600826 * usb_setup_device() - set up a device ready for use
827 *
828 * @dev: USB device pointer. This need not be a real device - it is
829 * common for it to just be a local variable with its ->dev
Hans de Goede9eb72dd2015-06-17 21:33:46 +0200830 * member (i.e. @dev->dev) set to the parent device and
831 * dev->portnr set to the port number on the hub (1=first)
Simon Glassde312132015-03-25 12:21:59 -0600832 * @do_read: true to read the device descriptor before an address is set
833 * (should be false for XHCI buses, true otherwise)
834 * @parent: Parent device (either UCLASS_USB or UCLASS_USB_HUB)
Simon Glassde312132015-03-25 12:21:59 -0600835 * @return 0 if OK, -ve on error */
836int usb_setup_device(struct usb_device *dev, bool do_read,
Hans de Goede9eb72dd2015-06-17 21:33:46 +0200837 struct usb_device *parent);
Simon Glassde312132015-03-25 12:21:59 -0600838
839/**
Bin Meng46c1d492017-07-19 21:51:11 +0800840 * usb_hub_is_root_hub() - Test whether a hub device is root hub or not
841 *
842 * @hub: USB hub device to test
843 * @return: true if the hub device is root hub, false otherwise.
844 */
845bool usb_hub_is_root_hub(struct udevice *hub);
846
847/**
Simon Glassde312132015-03-25 12:21:59 -0600848 * usb_hub_scan() - Scan a hub and find its devices
849 *
850 * @hub: Hub device to scan
851 */
852int usb_hub_scan(struct udevice *hub);
853
854/**
855 * usb_scan_device() - Scan a device on a bus
856 *
857 * Scan a device on a bus. It has already been detected and is ready to
858 * be enumerated. This may be either the root hub (@parent is a bus) or a
859 * normal device (@parent is a hub)
860 *
861 * @parent: Parent device
862 * @port: Hub port number (numbered from 1)
863 * @speed: USB speed to use for this device
864 * @devp: Returns pointer to device if all is well
865 * @return 0 if OK, -ve on error
866 */
867int usb_scan_device(struct udevice *parent, int port,
868 enum usb_device_speed speed, struct udevice **devp);
869
870/**
871 * usb_get_bus() - Find the bus for a device
872 *
873 * Search up through parents to find the bus this device is connected to. This
874 * will be a device with uclass UCLASS_USB.
875 *
876 * @dev: Device to check
Hans de Goedef78a5c02015-05-05 11:54:31 +0200877 * @return The bus, or NULL if not found (this indicates a critical error in
878 * the USB stack
Simon Glassde312132015-03-25 12:21:59 -0600879 */
Hans de Goedef78a5c02015-05-05 11:54:31 +0200880struct udevice *usb_get_bus(struct udevice *dev);
Simon Glassde312132015-03-25 12:21:59 -0600881
882/**
883 * usb_select_config() - Set up a device ready for use
884 *
885 * This function assumes that the device already has an address and a driver
886 * bound, and is ready to be set up.
887 *
888 * This re-reads the device and configuration descriptors and sets the
889 * configuration
890 *
891 * @dev: Device to set up
892 */
893int usb_select_config(struct usb_device *dev);
894
895/**
896 * usb_child_pre_probe() - Pre-probe function for USB devices
897 *
898 * This is called on all children of hubs and USB controllers (i.e. UCLASS_USB
899 * and UCLASS_USB_HUB) when a new device is about to be probed. It sets up the
900 * device from the saved platform data and calls usb_select_config() to
901 * finish set up.
902 *
903 * Once this is done, the device's normal driver can take over, knowing the
904 * device is accessible on the USB bus.
905 *
906 * This function is for use only by the internal USB stack.
907 *
908 * @dev: Device to set up
909 */
910int usb_child_pre_probe(struct udevice *dev);
911
912struct ehci_ctrl;
913
914/**
915 * usb_setup_ehci_gadget() - Set up a USB device as a gadget
916 *
917 * TODO(sjg@chromium.org): Tidy this up when USB gadgets can use driver model
918 *
919 * This provides a way to tell a controller to start up as a USB device
920 * instead of as a host. It is untested.
921 */
922int usb_setup_ehci_gadget(struct ehci_ctrl **ctlrp);
923
924/**
Ye Li1468a1c2020-06-29 10:12:59 +0800925 * usb_remove_ehci_gadget() - Remove a gadget USB device
926 *
927 * TODO(sjg@chromium.org): Tidy this up when USB gadgets can use driver model
928 *
929 * This provides a way to tell a controller to remove a USB device
930 */
931int usb_remove_ehci_gadget(struct ehci_ctrl **ctlrp);
932
933/**
Simon Glassde312132015-03-25 12:21:59 -0600934 * usb_stor_reset() - Prepare to scan USB storage devices
935 *
936 * Empty the list of USB storage devices in preparation for scanning them.
937 * This must be called before a USB scan.
938 */
939void usb_stor_reset(void);
940
Sven Schwermerfd09c202018-11-21 08:43:56 +0100941#else /* !CONFIG_IS_ENABLED(DM_USB) */
Simon Glassde312132015-03-25 12:21:59 -0600942
943struct usb_device *usb_get_dev_index(int index);
944
945#endif
946
947bool usb_device_has_child_on_port(struct usb_device *parent, int port);
948
Marek Vasut23faf2b2012-02-13 18:58:17 +0000949int usb_hub_probe(struct usb_device *dev, int ifnum);
950void usb_hub_reset(void);
Simon Glass862e75c2015-03-25 12:22:04 -0600951
Stefan BrĂ¼nsfaa7db22015-12-22 01:21:03 +0100952/*
953 * usb_find_usb2_hub_address_port() - Get hub address and port for TT setting
954 *
955 * Searches for the first HS hub above the given device. If a
956 * HS hub is found, the hub address and the port the device is
957 * connected to is return, as required for SPLIT transactions
958 *
959 * @param: udev full speed or low speed device
960 */
961void usb_find_usb2_hub_address_port(struct usb_device *udev,
962 uint8_t *hub_address, uint8_t *hub_port);
963
Simon Glass79b58882015-03-25 12:22:01 -0600964/**
965 * usb_alloc_new_device() - Allocate a new device
966 *
967 * @devp: returns a pointer of a new device structure. With driver model this
968 * is a device pointer, but with legacy USB this pointer is
969 * driver-specific.
970 * @return 0 if OK, -ENOSPC if we have found out of room for new devices
971 */
972int usb_alloc_new_device(struct udevice *controller, struct usb_device **devp);
973
974/**
975 * usb_free_device() - Free a partially-inited device
976 *
977 * This is an internal function. It is used to reverse the action of
978 * usb_alloc_new_device() when we hit a problem during init.
979 */
980void usb_free_device(struct udevice *controller);
Lucas Stachc7e3b2b2012-09-26 00:14:34 +0200981
Marek Vasut23faf2b2012-02-13 18:58:17 +0000982int usb_new_device(struct usb_device *dev);
Simon Glass79b58882015-03-25 12:22:01 -0600983
Vivek Gautam5853e132013-09-14 14:02:45 +0530984int usb_alloc_device(struct usb_device *dev);
Marek Vasut23faf2b2012-02-13 18:58:17 +0000985
Simon Glass019808f2015-03-25 12:22:37 -0600986/**
Bin Meng3e59f592017-09-07 06:13:17 -0700987 * usb_update_hub_device() - Update HCD's internal representation of hub
Bin Meng9ca1b4b2017-07-19 21:51:17 +0800988 *
989 * After a hub descriptor is fetched, notify HCD so that its internal
990 * representation of this hub can be updated.
991 *
992 * @dev: Hub device
993 * @return 0 if OK, -ve on error
994 */
995int usb_update_hub_device(struct usb_device *dev);
996
997/**
Bin Meng3e59f592017-09-07 06:13:17 -0700998 * usb_get_max_xfer_size() - Get HCD's maximum transfer bytes
999 *
1000 * The HCD may have limitation on the maximum bytes to be transferred
1001 * in a USB transfer. USB class driver needs to be aware of this.
1002 *
1003 * @dev: USB device
1004 * @size: maximum transfer bytes
1005 * @return 0 if OK, -ve on error
1006 */
1007int usb_get_max_xfer_size(struct usb_device *dev, size_t *size);
1008
1009/**
Simon Glass019808f2015-03-25 12:22:37 -06001010 * usb_emul_setup_device() - Set up a new USB device emulation
1011 *
1012 * This is normally called when a new emulation device is bound. It tells
1013 * the USB emulation uclass about the features of the emulator.
1014 *
1015 * @dev: Emulation device
Simon Glass019808f2015-03-25 12:22:37 -06001016 * @strings: List of USB string descriptors, terminated by a NULL
1017 * entry
1018 * @desc_list: List of points or USB descriptors, terminated by NULL.
1019 * The first entry must be struct usb_device_descriptor,
1020 * and others follow on after that.
Bin Meng9ca1b4b2017-07-19 21:51:17 +08001021 * @return 0 if OK, -ENOSYS if not implemented, other -ve on error
Simon Glass019808f2015-03-25 12:22:37 -06001022 */
Bin Meng98b639f2017-10-01 06:19:36 -07001023int usb_emul_setup_device(struct udevice *dev, struct usb_string *strings,
1024 void **desc_list);
Simon Glass019808f2015-03-25 12:22:37 -06001025
1026/**
1027 * usb_emul_control() - Send a control packet to an emulator
1028 *
1029 * @emul: Emulator device
1030 * @udev: USB device (which the emulator is causing to appear)
1031 * See struct dm_usb_ops for details on other parameters
1032 * @return 0 if OK, -ve on error
1033 */
1034int usb_emul_control(struct udevice *emul, struct usb_device *udev,
1035 unsigned long pipe, void *buffer, int length,
1036 struct devrequest *setup);
1037
1038/**
1039 * usb_emul_bulk() - Send a bulk packet to an emulator
1040 *
1041 * @emul: Emulator device
1042 * @udev: USB device (which the emulator is causing to appear)
1043 * See struct dm_usb_ops for details on other parameters
1044 * @return 0 if OK, -ve on error
1045 */
1046int usb_emul_bulk(struct udevice *emul, struct usb_device *udev,
1047 unsigned long pipe, void *buffer, int length);
1048
1049/**
Simon Glassb70a3fe2015-11-08 23:48:05 -07001050 * usb_emul_int() - Send an interrupt packet to an emulator
1051 *
1052 * @emul: Emulator device
1053 * @udev: USB device (which the emulator is causing to appear)
1054 * See struct dm_usb_ops for details on other parameters
1055 * @return 0 if OK, -ve on error
1056 */
1057int usb_emul_int(struct udevice *emul, struct usb_device *udev,
Michal Suchanek34371212019-08-18 10:55:27 +02001058 unsigned long pipe, void *buffer, int length, int interval,
1059 bool nonblock);
Simon Glassb70a3fe2015-11-08 23:48:05 -07001060
1061/**
Simon Glass019808f2015-03-25 12:22:37 -06001062 * usb_emul_find() - Find an emulator for a particular device
1063 *
Bin Meng84aa8532017-10-01 06:19:39 -07001064 * Check @pipe and @port1 to find a device number on bus @bus and return it.
Simon Glass019808f2015-03-25 12:22:37 -06001065 *
1066 * @bus: USB bus (controller)
1067 * @pipe: Describes pipe being used, and includes the device number
Bin Meng84aa8532017-10-01 06:19:39 -07001068 * @port1: Describes port number on the parent hub
Simon Glass019808f2015-03-25 12:22:37 -06001069 * @emulp: Returns pointer to emulator, or NULL if not found
1070 * @return 0 if found, -ve on error
1071 */
Bin Meng84aa8532017-10-01 06:19:39 -07001072int usb_emul_find(struct udevice *bus, ulong pipe, int port1,
1073 struct udevice **emulp);
Simon Glass019808f2015-03-25 12:22:37 -06001074
1075/**
Simon Glassaf9c7c12015-11-08 23:47:55 -07001076 * usb_emul_find_for_dev() - Find an emulator for a particular device
1077 *
Simon Glassaf9c7c12015-11-08 23:47:55 -07001078 * @dev: USB device to check
1079 * @emulp: Returns pointer to emulator, or NULL if not found
1080 * @return 0 if found, -ve on error
1081 */
1082int usb_emul_find_for_dev(struct udevice *dev, struct udevice **emulp);
1083
1084/**
Bin Meng848436a2017-10-01 06:19:40 -07001085 * usb_emul_find_descriptor() - Find a USB descriptor of a particular device
1086 *
1087 * @ptr: a pointer to a list of USB descriptor pointers
1088 * @type: type of USB descriptor to find
1089 * @index: if @type is USB_DT_CONFIG, this is the configuration value
1090 * @return a pointer to the USB descriptor found, NULL if not found
1091 */
1092struct usb_generic_descriptor **usb_emul_find_descriptor(
1093 struct usb_generic_descriptor **ptr, int type, int index);
1094
1095/**
Simon Glass45bfa472015-11-08 23:47:51 -07001096 * usb_show_tree() - show the USB device tree
1097 *
1098 * This shows a list of active USB devices along with basic information about
1099 * each.
1100 */
1101void usb_show_tree(void);
1102
wdenk012771d2002-03-08 21:31:05 +00001103#endif /*_USB_H_ */