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>
16 * The EHCI spec says that we must align to at least 32 bytes. However,
17 * some platforms require larger alignment.
19 #if ARCH_DMA_MINALIGN > 32
20 #define USB_DMA_MINALIGN ARCH_DMA_MINALIGN
22 #define USB_DMA_MINALIGN 32
25 /* Everything is aribtrary */
26 #define USB_ALTSETTINGALLOC 4
27 #define USB_MAXALTSETTING 128 /* Hard limit */
29 #define USB_MAX_DEVICE 32
30 #define USB_MAXCONFIG 8
31 #define USB_MAXINTERFACES 8
32 #define USB_MAXENDPOINTS 16
33 #define USB_MAXCHILDREN 8 /* This is arbitrary */
34 #define USB_MAX_HUB 16
36 #define USB_CNTL_TIMEOUT 100 /* 100ms timeout */
39 * This is the timeout to allow for submitting an urb in ms. We allow more
40 * time for a BULK device to react - some are slow.
42 #define USB_TIMEOUT_MS(pipe) (usb_pipebulk(pipe) ? 5000 : 1000)
44 /* device request (setup) */
46 unsigned char requesttype;
47 unsigned char request;
50 unsigned short length;
51 } __attribute__ ((packed));
54 struct usb_interface {
55 struct usb_interface_descriptor desc;
57 unsigned char no_of_ep;
58 unsigned char num_altsetting;
59 unsigned char act_altsetting;
61 struct usb_endpoint_descriptor ep_desc[USB_MAXENDPOINTS];
63 * Super Speed Device will have Super Speed Endpoint
64 * Companion Descriptor (section 9.6.7 of usb 3.0 spec)
65 * Revision 1.0 June 6th 2011
67 struct usb_ss_ep_comp_descriptor ss_ep_comp_desc[USB_MAXENDPOINTS];
68 } __attribute__ ((packed));
70 /* Configuration information.. */
72 struct usb_config_descriptor desc;
74 unsigned char no_of_if; /* number of interfaces */
75 struct usb_interface if_desc[USB_MAXINTERFACES];
76 } __attribute__ ((packed));
79 /* Maximum packet size; encoded as 0,1,2,3 = 8,16,32,64 */
87 int devnum; /* Device number on USB bus */
88 int speed; /* full/low/high */
89 char mf[32]; /* manufacturer */
90 char prod[32]; /* product */
91 char serial[32]; /* serial number */
93 /* Maximum packet size; one of: PACKET_SIZE_* */
95 /* one bit for each endpoint ([0] = IN, [1] = OUT) */
96 unsigned int toggle[2];
97 /* endpoint halts; one bit per endpoint # & direction;
100 unsigned int halted[2];
101 int epmaxpacketin[16]; /* INput endpoint specific maximums */
102 int epmaxpacketout[16]; /* OUTput endpoint specific maximums */
104 int configno; /* selected config number */
105 /* Device Descriptor */
106 struct usb_device_descriptor descriptor
107 __attribute__((aligned(ARCH_DMA_MINALIGN)));
108 struct usb_config config; /* config descriptor */
110 int have_langid; /* whether string_langid is valid yet */
111 int string_langid; /* language ID for strings */
112 int (*irq_handle)(struct usb_device *dev);
113 unsigned long irq_status;
114 int irq_act_len; /* transfered bytes */
117 * Child devices - if this is a hub device
118 * Each instance needs its own set of data structures.
120 unsigned long status;
121 int act_len; /* transfered bytes */
122 int maxchild; /* Number of ports if hub */
124 struct usb_device *parent;
125 struct usb_device *children[USB_MAXCHILDREN];
127 void *controller; /* hardware controller private data */
128 /* slot_id - for xHCI enabled devices */
129 unsigned int slot_id;
132 /**********************************************************************
133 * this is how the lowlevel part communicate with the outer world
136 #if defined(CONFIG_USB_UHCI) || defined(CONFIG_USB_OHCI) || \
137 defined(CONFIG_USB_EHCI) || defined(CONFIG_USB_OHCI_NEW) || \
138 defined(CONFIG_USB_SL811HS) || defined(CONFIG_USB_ISP116X_HCD) || \
139 defined(CONFIG_USB_R8A66597_HCD) || defined(CONFIG_USB_DAVINCI) || \
140 defined(CONFIG_USB_OMAP3) || defined(CONFIG_USB_DA8XX) || \
141 defined(CONFIG_USB_BLACKFIN) || defined(CONFIG_USB_AM35X) || \
142 defined(CONFIG_USB_MUSB_DSPS) || defined(CONFIG_USB_MUSB_AM35X) || \
143 defined(CONFIG_USB_MUSB_OMAP2PLUS) || defined(CONFIG_USB_XHCI)
145 int usb_lowlevel_init(int index, void **controller);
146 int usb_lowlevel_stop(int index);
148 int submit_bulk_msg(struct usb_device *dev, unsigned long pipe,
149 void *buffer, int transfer_len);
150 int submit_control_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
151 int transfer_len, struct devrequest *setup);
152 int submit_int_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
153 int transfer_len, int interval);
156 #define USB_UHCI_VEND_ID 0x8086
157 #define USB_UHCI_DEV_ID 0x7112
160 * PXA25x can only act as USB device. There are drivers
161 * which works with USB CDC gadgets implementations.
162 * Some of them have common routines which can be used
163 * in boards init functions e.g. udc_disconnect() used for
164 * forced device disconnection from host.
166 #elif defined(CONFIG_USB_GADGET_PXA2XX)
168 extern void udc_disconnect(void);
171 #error USB Lowlevel not defined
174 #ifdef CONFIG_USB_STORAGE
176 #define USB_MAX_STOR_DEV 5
177 block_dev_desc_t *usb_stor_get_dev(int index);
178 int usb_stor_scan(int mode);
179 int usb_stor_info(void);
183 #ifdef CONFIG_USB_HOST_ETHER
185 #define USB_MAX_ETH_DEV 5
186 int usb_host_eth_scan(int mode);
190 #ifdef CONFIG_USB_KEYBOARD
192 int drv_usb_kbd_init(void);
193 int usb_kbd_deregister(void);
197 int usb_init(void); /* initialize the USB Controller */
198 int usb_stop(void); /* stop the USB Controller */
201 int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol);
202 int usb_set_idle(struct usb_device *dev, int ifnum, int duration,
204 struct usb_device *usb_get_dev_index(int index);
205 int usb_control_msg(struct usb_device *dev, unsigned int pipe,
206 unsigned char request, unsigned char requesttype,
207 unsigned short value, unsigned short index,
208 void *data, unsigned short size, int timeout);
209 int usb_bulk_msg(struct usb_device *dev, unsigned int pipe,
210 void *data, int len, int *actual_length, int timeout);
211 int usb_submit_int_msg(struct usb_device *dev, unsigned long pipe,
212 void *buffer, int transfer_len, int interval);
213 int usb_disable_asynch(int disable);
214 int usb_maxpacket(struct usb_device *dev, unsigned long pipe);
215 int usb_get_configuration_no(struct usb_device *dev, unsigned char *buffer,
217 int usb_get_report(struct usb_device *dev, int ifnum, unsigned char type,
218 unsigned char id, void *buf, int size);
219 int usb_get_class_descriptor(struct usb_device *dev, int ifnum,
220 unsigned char type, unsigned char id, void *buf,
222 int usb_clear_halt(struct usb_device *dev, int pipe);
223 int usb_string(struct usb_device *dev, int index, char *buf, size_t size);
224 int usb_set_interface(struct usb_device *dev, int interface, int alternate);
226 /* big endian -> little endian conversion */
227 /* some CPUs are already little endian e.g. the ARM920T */
228 #define __swap_16(x) \
229 ({ unsigned short x_ = (unsigned short)x; \
231 ((x_ & 0x00FFU) << 8) | ((x_ & 0xFF00U) >> 8)); \
233 #define __swap_32(x) \
234 ({ unsigned long x_ = (unsigned long)x; \
236 ((x_ & 0x000000FFUL) << 24) | \
237 ((x_ & 0x0000FF00UL) << 8) | \
238 ((x_ & 0x00FF0000UL) >> 8) | \
239 ((x_ & 0xFF000000UL) >> 24)); \
242 #ifdef __LITTLE_ENDIAN
243 # define swap_16(x) (x)
244 # define swap_32(x) (x)
246 # define swap_16(x) __swap_16(x)
247 # define swap_32(x) __swap_32(x)
251 * Calling this entity a "pipe" is glorifying it. A USB pipe
252 * is something embarrassingly simple: it basically consists
253 * of the following information:
254 * - device number (7 bits)
255 * - endpoint number (4 bits)
256 * - current Data0/1 state (1 bit)
257 * - direction (1 bit)
259 * - max packet size (2 bits: 8, 16, 32 or 64)
260 * - pipe type (2 bits: control, interrupt, bulk, isochronous)
262 * That's 18 bits. Really. Nothing more. And the USB people have
263 * documented these eighteen bits as some kind of glorious
264 * virtual data structure.
266 * Let's not fall in that trap. We'll just encode it as a simple
267 * unsigned int. The encoding is:
269 * - max size: bits 0-1 (00 = 8, 01 = 16, 10 = 32, 11 = 64)
270 * - direction: bit 7 (0 = Host-to-Device [Out],
271 * (1 = Device-to-Host [In])
272 * - device: bits 8-14
273 * - endpoint: bits 15-18
275 * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt,
276 * 10 = control, 11 = bulk)
278 * Why? Because it's arbitrary, and whatever encoding we select is really
279 * up to us. This one happens to share a lot of bit positions with the UHCI
280 * specification, so that much of the uhci driver can just mask the bits
283 /* Create various pipes... */
284 #define create_pipe(dev,endpoint) \
285 (((dev)->devnum << 8) | ((endpoint) << 15) | \
286 (dev)->maxpacketsize)
287 #define default_pipe(dev) ((dev)->speed << 26)
289 #define usb_sndctrlpipe(dev, endpoint) ((PIPE_CONTROL << 30) | \
290 create_pipe(dev, endpoint))
291 #define usb_rcvctrlpipe(dev, endpoint) ((PIPE_CONTROL << 30) | \
292 create_pipe(dev, endpoint) | \
294 #define usb_sndisocpipe(dev, endpoint) ((PIPE_ISOCHRONOUS << 30) | \
295 create_pipe(dev, endpoint))
296 #define usb_rcvisocpipe(dev, endpoint) ((PIPE_ISOCHRONOUS << 30) | \
297 create_pipe(dev, endpoint) | \
299 #define usb_sndbulkpipe(dev, endpoint) ((PIPE_BULK << 30) | \
300 create_pipe(dev, endpoint))
301 #define usb_rcvbulkpipe(dev, endpoint) ((PIPE_BULK << 30) | \
302 create_pipe(dev, endpoint) | \
304 #define usb_sndintpipe(dev, endpoint) ((PIPE_INTERRUPT << 30) | \
305 create_pipe(dev, endpoint))
306 #define usb_rcvintpipe(dev, endpoint) ((PIPE_INTERRUPT << 30) | \
307 create_pipe(dev, endpoint) | \
309 #define usb_snddefctrl(dev) ((PIPE_CONTROL << 30) | \
311 #define usb_rcvdefctrl(dev) ((PIPE_CONTROL << 30) | \
312 default_pipe(dev) | \
315 /* The D0/D1 toggle bits */
316 #define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> ep) & 1)
317 #define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << ep))
318 #define usb_settoggle(dev, ep, out, bit) ((dev)->toggle[out] = \
319 ((dev)->toggle[out] & \
320 ~(1 << ep)) | ((bit) << ep))
322 /* Endpoint halt control/status */
323 #define usb_endpoint_out(ep_dir) (((ep_dir >> 7) & 1) ^ 1)
324 #define usb_endpoint_halt(dev, ep, out) ((dev)->halted[out] |= (1 << (ep)))
325 #define usb_endpoint_running(dev, ep, out) ((dev)->halted[out] &= ~(1 << (ep)))
326 #define usb_endpoint_halted(dev, ep, out) ((dev)->halted[out] & (1 << (ep)))
328 #define usb_packetid(pipe) (((pipe) & USB_DIR_IN) ? USB_PID_IN : \
331 #define usb_pipeout(pipe) ((((pipe) >> 7) & 1) ^ 1)
332 #define usb_pipein(pipe) (((pipe) >> 7) & 1)
333 #define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f)
334 #define usb_pipe_endpdev(pipe) (((pipe) >> 8) & 0x7ff)
335 #define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf)
336 #define usb_pipedata(pipe) (((pipe) >> 19) & 1)
337 #define usb_pipetype(pipe) (((pipe) >> 30) & 3)
338 #define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
339 #define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT)
340 #define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL)
341 #define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK)
343 #define usb_pipe_ep_index(pipe) \
344 usb_pipecontrol(pipe) ? (usb_pipeendpoint(pipe) * 2) : \
345 ((usb_pipeendpoint(pipe) * 2) - \
346 (usb_pipein(pipe) ? 0 : 1))
348 /*************************************************************************
351 struct usb_port_status {
352 unsigned short wPortStatus;
353 unsigned short wPortChange;
354 } __attribute__ ((packed));
356 struct usb_hub_status {
357 unsigned short wHubStatus;
358 unsigned short wHubChange;
359 } __attribute__ ((packed));
363 struct usb_hub_descriptor {
364 unsigned char bLength;
365 unsigned char bDescriptorType;
366 unsigned char bNbrPorts;
367 unsigned short wHubCharacteristics;
368 unsigned char bPwrOn2PwrGood;
369 unsigned char bHubContrCurrent;
370 unsigned char DeviceRemovable[(USB_MAXCHILDREN+1+7)/8];
371 unsigned char PortPowerCtrlMask[(USB_MAXCHILDREN+1+7)/8];
372 /* DeviceRemovable and PortPwrCtrlMask want to be variable-length
373 bitmaps that hold max 255 entries. (bit0 is ignored) */
374 } __attribute__ ((packed));
377 struct usb_hub_device {
378 struct usb_device *pusb_dev;
379 struct usb_hub_descriptor desc;
382 int usb_hub_probe(struct usb_device *dev, int ifnum);
383 void usb_hub_reset(void);
384 int hub_port_reset(struct usb_device *dev, int port,
385 unsigned short *portstat);
387 struct usb_device *usb_alloc_new_device(void *controller);
389 int usb_new_device(struct usb_device *dev);
390 void usb_free_device(void);
391 int usb_alloc_device(struct usb_device *dev);