3 * Denis Peter, MPL AG Switzerland
5 * SPDX-License-Identifier: GPL-2.0+
6 * Note: Part of this code has been derived from linux
13 #include <linux/usb/ch9.h>
14 #include <asm/cache.h>
18 * The EHCI spec says that we must align to at least 32 bytes. However,
19 * some platforms require larger alignment.
21 #if ARCH_DMA_MINALIGN > 32
22 #define USB_DMA_MINALIGN ARCH_DMA_MINALIGN
24 #define USB_DMA_MINALIGN 32
27 /* Everything is aribtrary */
28 #define USB_ALTSETTINGALLOC 4
29 #define USB_MAXALTSETTING 128 /* Hard limit */
31 #define USB_MAX_DEVICE 32
32 #define USB_MAXCONFIG 8
33 #define USB_MAXINTERFACES 8
34 #define USB_MAXENDPOINTS 16
35 #define USB_MAXCHILDREN 8 /* This is arbitrary */
36 #define USB_MAX_HUB 16
38 #define USB_CNTL_TIMEOUT 100 /* 100ms timeout */
41 * This is the timeout to allow for submitting an urb in ms. We allow more
42 * time for a BULK device to react - some are slow.
44 #define USB_TIMEOUT_MS(pipe) (usb_pipebulk(pipe) ? 5000 : 1000)
46 /* device request (setup) */
48 unsigned char requesttype
;
49 unsigned char request
;
52 unsigned short length
;
53 } __attribute__ ((packed
));
56 struct usb_interface
{
57 struct usb_interface_descriptor desc
;
59 unsigned char no_of_ep
;
60 unsigned char num_altsetting
;
61 unsigned char act_altsetting
;
63 struct usb_endpoint_descriptor ep_desc
[USB_MAXENDPOINTS
];
65 * Super Speed Device will have Super Speed Endpoint
66 * Companion Descriptor (section 9.6.7 of usb 3.0 spec)
67 * Revision 1.0 June 6th 2011
69 struct usb_ss_ep_comp_descriptor ss_ep_comp_desc
[USB_MAXENDPOINTS
];
70 } __attribute__ ((packed
));
72 /* Configuration information.. */
74 struct usb_config_descriptor desc
;
76 unsigned char no_of_if
; /* number of interfaces */
77 struct usb_interface if_desc
[USB_MAXINTERFACES
];
78 } __attribute__ ((packed
));
81 /* Maximum packet size; encoded as 0,1,2,3 = 8,16,32,64 */
89 int devnum
; /* Device number on USB bus */
90 int speed
; /* full/low/high */
91 char mf
[32]; /* manufacturer */
92 char prod
[32]; /* product */
93 char serial
[32]; /* serial number */
95 /* Maximum packet size; one of: PACKET_SIZE_* */
97 /* one bit for each endpoint ([0] = IN, [1] = OUT) */
98 unsigned int toggle
[2];
99 /* endpoint halts; one bit per endpoint # & direction;
100 * [0] = IN, [1] = OUT
102 unsigned int halted
[2];
103 int epmaxpacketin
[16]; /* INput endpoint specific maximums */
104 int epmaxpacketout
[16]; /* OUTput endpoint specific maximums */
106 int configno
; /* selected config number */
107 /* Device Descriptor */
108 struct usb_device_descriptor descriptor
109 __attribute__((aligned(ARCH_DMA_MINALIGN
)));
110 struct usb_config config
; /* config descriptor */
112 int have_langid
; /* whether string_langid is valid yet */
113 int string_langid
; /* language ID for strings */
114 int (*irq_handle
)(struct usb_device
*dev
);
115 unsigned long irq_status
;
116 int irq_act_len
; /* transfered bytes */
119 * Child devices - if this is a hub device
120 * Each instance needs its own set of data structures.
122 unsigned long status
;
123 unsigned long int_pending
; /* 1 bit per ep, used by int_queue */
124 int act_len
; /* transfered bytes */
125 int maxchild
; /* Number of ports if hub */
127 struct usb_device
*parent
;
128 struct usb_device
*children
[USB_MAXCHILDREN
];
130 void *controller
; /* hardware controller private data */
131 /* slot_id - for xHCI enabled devices */
132 unsigned int slot_id
;
138 * You can initialize platform's USB host or device
139 * ports by passing this enum as an argument to
147 /**********************************************************************
148 * this is how the lowlevel part communicate with the outer world
151 #if defined(CONFIG_USB_UHCI) || defined(CONFIG_USB_OHCI) || \
152 defined(CONFIG_USB_EHCI) || defined(CONFIG_USB_OHCI_NEW) || \
153 defined(CONFIG_USB_SL811HS) || defined(CONFIG_USB_ISP116X_HCD) || \
154 defined(CONFIG_USB_R8A66597_HCD) || defined(CONFIG_USB_DAVINCI) || \
155 defined(CONFIG_USB_OMAP3) || defined(CONFIG_USB_DA8XX) || \
156 defined(CONFIG_USB_BLACKFIN) || defined(CONFIG_USB_AM35X) || \
157 defined(CONFIG_USB_MUSB_DSPS) || defined(CONFIG_USB_MUSB_AM35X) || \
158 defined(CONFIG_USB_MUSB_OMAP2PLUS) || defined(CONFIG_USB_MUSB_SUNXI) || \
159 defined(CONFIG_USB_XHCI) || defined(CONFIG_USB_DWC2)
161 int usb_lowlevel_init(int index
, enum usb_init_type init
, void **controller
);
162 int usb_lowlevel_stop(int index
);
163 #ifdef CONFIG_MUSB_HOST
164 void usb_reset_root_port(void);
166 #define usb_reset_root_port()
169 int submit_bulk_msg(struct usb_device
*dev
, unsigned long pipe
,
170 void *buffer
, int transfer_len
);
171 int submit_control_msg(struct usb_device
*dev
, unsigned long pipe
, void *buffer
,
172 int transfer_len
, struct devrequest
*setup
);
173 int submit_int_msg(struct usb_device
*dev
, unsigned long pipe
, void *buffer
,
174 int transfer_len
, int interval
);
176 #if defined CONFIG_USB_EHCI || defined CONFIG_MUSB_HOST
177 struct int_queue
*create_int_queue(struct usb_device
*dev
, unsigned long pipe
,
178 int queuesize
, int elementsize
, void *buffer
, int interval
);
179 int destroy_int_queue(struct usb_device
*dev
, struct int_queue
*queue
);
180 void *poll_int_queue(struct usb_device
*dev
, struct int_queue
*queue
);
184 #define USB_UHCI_VEND_ID 0x8086
185 #define USB_UHCI_DEV_ID 0x7112
188 * PXA25x can only act as USB device. There are drivers
189 * which works with USB CDC gadgets implementations.
190 * Some of them have common routines which can be used
191 * in boards init functions e.g. udc_disconnect() used for
192 * forced device disconnection from host.
194 #elif defined(CONFIG_USB_GADGET_PXA2XX)
196 extern void udc_disconnect(void);
201 * board-specific hardware initialization, called by
202 * usb drivers and u-boot commands
204 * @param index USB controller number
205 * @param init initializes controller as USB host or device
207 int board_usb_init(int index
, enum usb_init_type init
);
210 * can be used to clean up after failed USB initialization attempt
211 * vide: board_usb_init()
213 * @param index USB controller number for selective cleanup
214 * @param init usb_init_type passed to board_usb_init()
216 int board_usb_cleanup(int index
, enum usb_init_type init
);
218 #ifdef CONFIG_USB_STORAGE
220 #define USB_MAX_STOR_DEV 5
221 block_dev_desc_t
*usb_stor_get_dev(int index
);
222 int usb_stor_scan(int mode
);
223 int usb_stor_info(void);
227 #ifdef CONFIG_USB_HOST_ETHER
229 #define USB_MAX_ETH_DEV 5
230 int usb_host_eth_scan(int mode
);
234 #ifdef CONFIG_USB_KEYBOARD
236 int drv_usb_kbd_init(void);
237 int usb_kbd_deregister(int force
);
241 int usb_init(void); /* initialize the USB Controller */
242 int usb_stop(void); /* stop the USB Controller */
245 int usb_set_protocol(struct usb_device
*dev
, int ifnum
, int protocol
);
246 int usb_set_idle(struct usb_device
*dev
, int ifnum
, int duration
,
248 struct usb_device
*usb_get_dev_index(int index
);
249 int usb_control_msg(struct usb_device
*dev
, unsigned int pipe
,
250 unsigned char request
, unsigned char requesttype
,
251 unsigned short value
, unsigned short index
,
252 void *data
, unsigned short size
, int timeout
);
253 int usb_bulk_msg(struct usb_device
*dev
, unsigned int pipe
,
254 void *data
, int len
, int *actual_length
, int timeout
);
255 int usb_submit_int_msg(struct usb_device
*dev
, unsigned long pipe
,
256 void *buffer
, int transfer_len
, int interval
);
257 int usb_disable_asynch(int disable
);
258 int usb_maxpacket(struct usb_device
*dev
, unsigned long pipe
);
259 int usb_get_configuration_no(struct usb_device
*dev
, unsigned char *buffer
,
261 int usb_get_report(struct usb_device
*dev
, int ifnum
, unsigned char type
,
262 unsigned char id
, void *buf
, int size
);
263 int usb_get_class_descriptor(struct usb_device
*dev
, int ifnum
,
264 unsigned char type
, unsigned char id
, void *buf
,
266 int usb_clear_halt(struct usb_device
*dev
, int pipe
);
267 int usb_string(struct usb_device
*dev
, int index
, char *buf
, size_t size
);
268 int usb_set_interface(struct usb_device
*dev
, int interface
, int alternate
);
270 /* big endian -> little endian conversion */
271 /* some CPUs are already little endian e.g. the ARM920T */
272 #define __swap_16(x) \
273 ({ unsigned short x_ = (unsigned short)x; \
275 ((x_ & 0x00FFU) << 8) | ((x_ & 0xFF00U) >> 8)); \
277 #define __swap_32(x) \
278 ({ unsigned long x_ = (unsigned long)x; \
280 ((x_ & 0x000000FFUL) << 24) | \
281 ((x_ & 0x0000FF00UL) << 8) | \
282 ((x_ & 0x00FF0000UL) >> 8) | \
283 ((x_ & 0xFF000000UL) >> 24)); \
286 #ifdef __LITTLE_ENDIAN
287 # define swap_16(x) (x)
288 # define swap_32(x) (x)
290 # define swap_16(x) __swap_16(x)
291 # define swap_32(x) __swap_32(x)
295 * Calling this entity a "pipe" is glorifying it. A USB pipe
296 * is something embarrassingly simple: it basically consists
297 * of the following information:
298 * - device number (7 bits)
299 * - endpoint number (4 bits)
300 * - current Data0/1 state (1 bit)
301 * - direction (1 bit)
303 * - max packet size (2 bits: 8, 16, 32 or 64)
304 * - pipe type (2 bits: control, interrupt, bulk, isochronous)
306 * That's 18 bits. Really. Nothing more. And the USB people have
307 * documented these eighteen bits as some kind of glorious
308 * virtual data structure.
310 * Let's not fall in that trap. We'll just encode it as a simple
311 * unsigned int. The encoding is:
313 * - max size: bits 0-1 (00 = 8, 01 = 16, 10 = 32, 11 = 64)
314 * - direction: bit 7 (0 = Host-to-Device [Out],
315 * (1 = Device-to-Host [In])
316 * - device: bits 8-14
317 * - endpoint: bits 15-18
319 * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt,
320 * 10 = control, 11 = bulk)
322 * Why? Because it's arbitrary, and whatever encoding we select is really
323 * up to us. This one happens to share a lot of bit positions with the UHCI
324 * specification, so that much of the uhci driver can just mask the bits
327 /* Create various pipes... */
328 #define create_pipe(dev,endpoint) \
329 (((dev)->devnum << 8) | ((endpoint) << 15) | \
330 (dev)->maxpacketsize)
331 #define default_pipe(dev) ((dev)->speed << 26)
333 #define usb_sndctrlpipe(dev, endpoint) ((PIPE_CONTROL << 30) | \
334 create_pipe(dev, endpoint))
335 #define usb_rcvctrlpipe(dev, endpoint) ((PIPE_CONTROL << 30) | \
336 create_pipe(dev, endpoint) | \
338 #define usb_sndisocpipe(dev, endpoint) ((PIPE_ISOCHRONOUS << 30) | \
339 create_pipe(dev, endpoint))
340 #define usb_rcvisocpipe(dev, endpoint) ((PIPE_ISOCHRONOUS << 30) | \
341 create_pipe(dev, endpoint) | \
343 #define usb_sndbulkpipe(dev, endpoint) ((PIPE_BULK << 30) | \
344 create_pipe(dev, endpoint))
345 #define usb_rcvbulkpipe(dev, endpoint) ((PIPE_BULK << 30) | \
346 create_pipe(dev, endpoint) | \
348 #define usb_sndintpipe(dev, endpoint) ((PIPE_INTERRUPT << 30) | \
349 create_pipe(dev, endpoint))
350 #define usb_rcvintpipe(dev, endpoint) ((PIPE_INTERRUPT << 30) | \
351 create_pipe(dev, endpoint) | \
353 #define usb_snddefctrl(dev) ((PIPE_CONTROL << 30) | \
355 #define usb_rcvdefctrl(dev) ((PIPE_CONTROL << 30) | \
356 default_pipe(dev) | \
359 /* The D0/D1 toggle bits */
360 #define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> ep) & 1)
361 #define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << ep))
362 #define usb_settoggle(dev, ep, out, bit) ((dev)->toggle[out] = \
363 ((dev)->toggle[out] & \
364 ~(1 << ep)) | ((bit) << ep))
366 /* Endpoint halt control/status */
367 #define usb_endpoint_out(ep_dir) (((ep_dir >> 7) & 1) ^ 1)
368 #define usb_endpoint_halt(dev, ep, out) ((dev)->halted[out] |= (1 << (ep)))
369 #define usb_endpoint_running(dev, ep, out) ((dev)->halted[out] &= ~(1 << (ep)))
370 #define usb_endpoint_halted(dev, ep, out) ((dev)->halted[out] & (1 << (ep)))
372 #define usb_packetid(pipe) (((pipe) & USB_DIR_IN) ? USB_PID_IN : \
375 #define usb_pipeout(pipe) ((((pipe) >> 7) & 1) ^ 1)
376 #define usb_pipein(pipe) (((pipe) >> 7) & 1)
377 #define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f)
378 #define usb_pipe_endpdev(pipe) (((pipe) >> 8) & 0x7ff)
379 #define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf)
380 #define usb_pipedata(pipe) (((pipe) >> 19) & 1)
381 #define usb_pipetype(pipe) (((pipe) >> 30) & 3)
382 #define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
383 #define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT)
384 #define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL)
385 #define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK)
387 #define usb_pipe_ep_index(pipe) \
388 usb_pipecontrol(pipe) ? (usb_pipeendpoint(pipe) * 2) : \
389 ((usb_pipeendpoint(pipe) * 2) - \
390 (usb_pipein(pipe) ? 0 : 1))
392 /*************************************************************************
395 struct usb_port_status
{
396 unsigned short wPortStatus
;
397 unsigned short wPortChange
;
398 } __attribute__ ((packed
));
400 struct usb_hub_status
{
401 unsigned short wHubStatus
;
402 unsigned short wHubChange
;
403 } __attribute__ ((packed
));
407 struct usb_hub_descriptor
{
408 unsigned char bLength
;
409 unsigned char bDescriptorType
;
410 unsigned char bNbrPorts
;
411 unsigned short wHubCharacteristics
;
412 unsigned char bPwrOn2PwrGood
;
413 unsigned char bHubContrCurrent
;
414 unsigned char DeviceRemovable
[(USB_MAXCHILDREN
+1+7)/8];
415 unsigned char PortPowerCtrlMask
[(USB_MAXCHILDREN
+1+7)/8];
416 /* DeviceRemovable and PortPwrCtrlMask want to be variable-length
417 bitmaps that hold max 255 entries. (bit0 is ignored) */
418 } __attribute__ ((packed
));
421 struct usb_hub_device
{
422 struct usb_device
*pusb_dev
;
423 struct usb_hub_descriptor desc
;
426 int usb_hub_probe(struct usb_device
*dev
, int ifnum
);
427 void usb_hub_reset(void);
428 int hub_port_reset(struct usb_device
*dev
, int port
,
429 unsigned short *portstat
);
431 struct usb_device
*usb_alloc_new_device(void *controller
);
433 int usb_new_device(struct usb_device
*dev
);
434 void usb_free_device(void);
435 int usb_alloc_device(struct usb_device
*dev
);