blob: 4534738f8d7350ffdc9f311558de1396602c6dd4 [file] [log] [blame]
wdenk012771d2002-03-08 21:31:05 +00001/*
2 * (C) Copyright 2001
3 * Denis Peter, MPL AG Switzerland
4 *
5 * See file CREDITS for list of people who contributed to this
6 * project.
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License as
10 * published by the Free Software Foundation; either version 2 of
11 * the License, or (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
wdenk20c98a62004-04-23 20:32:05 +000015 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
wdenk012771d2002-03-08 21:31:05 +000016 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21 * MA 02111-1307 USA
22 *
23 * Note: Part of this code has been derived from linux
24 *
25 */
26#ifndef _USB_H_
27#define _USB_H_
28
29#include <usb_defs.h>
Tom Rix83b9e1d2009-10-31 12:37:38 -050030#include <usbdescriptors.h>
wdenk012771d2002-03-08 21:31:05 +000031
32/* Everything is aribtrary */
wdenk20c98a62004-04-23 20:32:05 +000033#define USB_ALTSETTINGALLOC 4
34#define USB_MAXALTSETTING 128 /* Hard limit */
wdenk012771d2002-03-08 21:31:05 +000035
wdenk20c98a62004-04-23 20:32:05 +000036#define USB_MAX_DEVICE 32
37#define USB_MAXCONFIG 8
38#define USB_MAXINTERFACES 8
39#define USB_MAXENDPOINTS 16
40#define USB_MAXCHILDREN 8 /* This is arbitrary */
41#define USB_MAX_HUB 16
wdenk012771d2002-03-08 21:31:05 +000042
43#define USB_CNTL_TIMEOUT 100 /* 100ms timeout */
44
Simon Glassfd7f5132011-02-07 14:42:16 -080045/*
46 * This is the timeout to allow for submitting an urb in ms. We allow more
47 * time for a BULK device to react - some are slow.
48 */
Jason Cooper0efc2812011-07-31 20:09:58 +000049#define USB_TIMEOUT_MS(pipe) (usb_pipebulk(pipe) ? 5000 : 1000)
Simon Glassfd7f5132011-02-07 14:42:16 -080050
wdenk012771d2002-03-08 21:31:05 +000051/* device request (setup) */
52struct devrequest {
Michael Trimarchi5f2e7fc2008-11-26 17:41:34 +010053 unsigned char requesttype;
54 unsigned char request;
55 unsigned short value;
56 unsigned short index;
57 unsigned short length;
wdenk012771d2002-03-08 21:31:05 +000058} __attribute__ ((packed));
59
wdenk012771d2002-03-08 21:31:05 +000060/* All standard descriptors have these 2 fields in common */
61struct usb_descriptor_header {
Michael Trimarchi5f2e7fc2008-11-26 17:41:34 +010062 unsigned char bLength;
63 unsigned char bDescriptorType;
wdenk012771d2002-03-08 21:31:05 +000064} __attribute__ ((packed));
65
Tom Rix83b9e1d2009-10-31 12:37:38 -050066/* Interface */
67struct usb_interface {
68 struct usb_interface_descriptor desc;
wdenk012771d2002-03-08 21:31:05 +000069
Michael Trimarchi5f2e7fc2008-11-26 17:41:34 +010070 unsigned char no_of_ep;
71 unsigned char num_altsetting;
72 unsigned char act_altsetting;
73
wdenk012771d2002-03-08 21:31:05 +000074 struct usb_endpoint_descriptor ep_desc[USB_MAXENDPOINTS];
75} __attribute__ ((packed));
76
Tom Rix83b9e1d2009-10-31 12:37:38 -050077/* Configuration information.. */
78struct usb_config {
79 struct usb_configuration_descriptor desc;
wdenk012771d2002-03-08 21:31:05 +000080
Michael Trimarchi5f2e7fc2008-11-26 17:41:34 +010081 unsigned char no_of_if; /* number of interfaces */
Tom Rix83b9e1d2009-10-31 12:37:38 -050082 struct usb_interface if_desc[USB_MAXINTERFACES];
wdenk012771d2002-03-08 21:31:05 +000083} __attribute__ ((packed));
84
Remy Bohmer47e72082008-10-10 10:23:21 +020085enum {
86 /* Maximum packet size; encoded as 0,1,2,3 = 8,16,32,64 */
87 PACKET_SIZE_8 = 0,
88 PACKET_SIZE_16 = 1,
89 PACKET_SIZE_32 = 2,
90 PACKET_SIZE_64 = 3,
91};
wdenk012771d2002-03-08 21:31:05 +000092
93struct usb_device {
Michael Trimarchi5f2e7fc2008-11-26 17:41:34 +010094 int devnum; /* Device number on USB bus */
Michael Trimarchi3d189962008-11-28 13:19:19 +010095 int speed; /* full/low/high */
Michael Trimarchi5f2e7fc2008-11-26 17:41:34 +010096 char mf[32]; /* manufacturer */
97 char prod[32]; /* product */
98 char serial[32]; /* serial number */
wdenk012771d2002-03-08 21:31:05 +000099
Remy Bohmer47e72082008-10-10 10:23:21 +0200100 /* Maximum packet size; one of: PACKET_SIZE_* */
101 int maxpacketsize;
102 /* one bit for each endpoint ([0] = IN, [1] = OUT) */
103 unsigned int toggle[2];
Michael Trimarchi5f2e7fc2008-11-26 17:41:34 +0100104 /* endpoint halts; one bit per endpoint # & direction;
105 * [0] = IN, [1] = OUT
106 */
Remy Bohmer47e72082008-10-10 10:23:21 +0200107 unsigned int halted[2];
wdenk012771d2002-03-08 21:31:05 +0000108 int epmaxpacketin[16]; /* INput endpoint specific maximums */
109 int epmaxpacketout[16]; /* OUTput endpoint specific maximums */
110
111 int configno; /* selected config number */
112 struct usb_device_descriptor descriptor; /* Device Descriptor */
Tom Rix83b9e1d2009-10-31 12:37:38 -0500113 struct usb_config config; /* config descriptor */
wdenk012771d2002-03-08 21:31:05 +0000114
115 int have_langid; /* whether string_langid is valid yet */
116 int string_langid; /* language ID for strings */
117 int (*irq_handle)(struct usb_device *dev);
118 unsigned long irq_status;
wdenk20c98a62004-04-23 20:32:05 +0000119 int irq_act_len; /* transfered bytes */
wdenk012771d2002-03-08 21:31:05 +0000120 void *privptr;
121 /*
122 * Child devices - if this is a hub device
123 * Each instance needs its own set of data structures.
124 */
125 unsigned long status;
126 int act_len; /* transfered bytes */
127 int maxchild; /* Number of ports if hub */
Michael Trimarchi3d189962008-11-28 13:19:19 +0100128 int portnr;
wdenk012771d2002-03-08 21:31:05 +0000129 struct usb_device *parent;
130 struct usb_device *children[USB_MAXCHILDREN];
131};
132
133/**********************************************************************
134 * this is how the lowlevel part communicate with the outer world
135 */
136
Rodolfo Giometti2404a2b2007-04-03 14:27:18 +0200137#if defined(CONFIG_USB_UHCI) || defined(CONFIG_USB_OHCI) || \
michael0bf2a032008-12-11 13:43:55 +0100138 defined(CONFIG_USB_EHCI) || defined(CONFIG_USB_OHCI_NEW) || \
Michael Trimarchi3d189962008-11-28 13:19:19 +0100139 defined(CONFIG_USB_SL811HS) || defined(CONFIG_USB_ISP116X_HCD) || \
Tom Rix09c82bc2009-10-31 12:37:41 -0500140 defined(CONFIG_USB_R8A66597_HCD) || defined(CONFIG_USB_DAVINCI) || \
Bryan Wue956f342009-12-16 22:04:02 -0500141 defined(CONFIG_USB_OMAP3) || defined(CONFIG_USB_DA8XX) || \
Ajay Kumar Gupta4e1d4852010-07-09 11:43:48 +0530142 defined(CONFIG_USB_BLACKFIN) || defined(CONFIG_USB_AM35X)
Rodolfo Giometti2404a2b2007-04-03 14:27:18 +0200143
wdenk012771d2002-03-08 21:31:05 +0000144int usb_lowlevel_init(void);
145int usb_lowlevel_stop(void);
Michael Trimarchi5f2e7fc2008-11-26 17:41:34 +0100146int submit_bulk_msg(struct usb_device *dev, unsigned long pipe,
147 void *buffer, int transfer_len);
wdenk012771d2002-03-08 21:31:05 +0000148int submit_control_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
Michael Trimarchi5f2e7fc2008-11-26 17:41:34 +0100149 int transfer_len, struct devrequest *setup);
wdenk012771d2002-03-08 21:31:05 +0000150int submit_int_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
151 int transfer_len, int interval);
152
153/* Defines */
Michael Trimarchi5f2e7fc2008-11-26 17:41:34 +0100154#define USB_UHCI_VEND_ID 0x8086
155#define USB_UHCI_DEV_ID 0x7112
wdenk012771d2002-03-08 21:31:05 +0000156
157#else
158#error USB Lowlevel not defined
159#endif
160
161#ifdef CONFIG_USB_STORAGE
162
163#define USB_MAX_STOR_DEV 5
164block_dev_desc_t *usb_stor_get_dev(int index);
165int usb_stor_scan(int mode);
Anatolij Gustschin18fa7002008-03-26 17:47:44 +0100166int usb_stor_info(void);
wdenk012771d2002-03-08 21:31:05 +0000167
168#endif
169
Simon Glass1e9961d2011-02-16 11:14:33 -0800170#ifdef CONFIG_USB_HOST_ETHER
171
172#define USB_MAX_ETH_DEV 5
173int usb_host_eth_scan(int mode);
174
175#endif
176
wdenk012771d2002-03-08 21:31:05 +0000177#ifdef CONFIG_USB_KEYBOARD
178
179int drv_usb_kbd_init(void);
180int usb_kbd_deregister(void);
181
182#endif
183/* routines */
184int usb_init(void); /* initialize the USB Controller */
185int usb_stop(void); /* stop the USB Controller */
186
187
188int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol);
Michael Trimarchi5f2e7fc2008-11-26 17:41:34 +0100189int usb_set_idle(struct usb_device *dev, int ifnum, int duration,
190 int report_id);
191struct usb_device *usb_get_dev_index(int index);
wdenk012771d2002-03-08 21:31:05 +0000192int usb_control_msg(struct usb_device *dev, unsigned int pipe,
193 unsigned char request, unsigned char requesttype,
194 unsigned short value, unsigned short index,
195 void *data, unsigned short size, int timeout);
196int usb_bulk_msg(struct usb_device *dev, unsigned int pipe,
197 void *data, int len, int *actual_length, int timeout);
198int usb_submit_int_msg(struct usb_device *dev, unsigned long pipe,
Michael Trimarchi5f2e7fc2008-11-26 17:41:34 +0100199 void *buffer, int transfer_len, int interval);
Simon Glass1e9961d2011-02-16 11:14:33 -0800200int usb_disable_asynch(int disable);
Michael Trimarchi5f2e7fc2008-11-26 17:41:34 +0100201int usb_maxpacket(struct usb_device *dev, unsigned long pipe);
202inline void wait_ms(unsigned long ms);
203int usb_get_configuration_no(struct usb_device *dev, unsigned char *buffer,
204 int cfgno);
205int usb_get_report(struct usb_device *dev, int ifnum, unsigned char type,
206 unsigned char id, void *buf, int size);
wdenk012771d2002-03-08 21:31:05 +0000207int usb_get_class_descriptor(struct usb_device *dev, int ifnum,
Michael Trimarchi5f2e7fc2008-11-26 17:41:34 +0100208 unsigned char type, unsigned char id, void *buf,
209 int size);
wdenk012771d2002-03-08 21:31:05 +0000210int usb_clear_halt(struct usb_device *dev, int pipe);
211int usb_string(struct usb_device *dev, int index, char *buf, size_t size);
212int usb_set_interface(struct usb_device *dev, int interface, int alternate);
213
214/* big endian -> little endian conversion */
wdenkde887eb2003-09-10 18:20:28 +0000215/* some CPUs are already little endian e.g. the ARM920T */
Markus Klotzbuecherd209de62006-11-27 11:46:46 +0100216#define __swap_16(x) \
wdenkef893942004-02-23 16:11:30 +0000217 ({ unsigned short x_ = (unsigned short)x; \
218 (unsigned short)( \
Michael Trimarchi5f2e7fc2008-11-26 17:41:34 +0100219 ((x_ & 0x00FFU) << 8) | ((x_ & 0xFF00U) >> 8)); \
wdenkef893942004-02-23 16:11:30 +0000220 })
Markus Klotzbuecherd209de62006-11-27 11:46:46 +0100221#define __swap_32(x) \
wdenkef893942004-02-23 16:11:30 +0000222 ({ unsigned long x_ = (unsigned long)x; \
223 (unsigned long)( \
224 ((x_ & 0x000000FFUL) << 24) | \
wdenk20c98a62004-04-23 20:32:05 +0000225 ((x_ & 0x0000FF00UL) << 8) | \
226 ((x_ & 0x00FF0000UL) >> 8) | \
Michael Trimarchi5f2e7fc2008-11-26 17:41:34 +0100227 ((x_ & 0xFF000000UL) >> 24)); \
wdenkef893942004-02-23 16:11:30 +0000228 })
Markus Klotzbuecherd209de62006-11-27 11:46:46 +0100229
Mike Frysingercc93fc02009-01-01 18:27:27 -0500230#ifdef __LITTLE_ENDIAN
Markus Klotzbuecherd209de62006-11-27 11:46:46 +0100231# define swap_16(x) (x)
232# define swap_32(x) (x)
233#else
234# define swap_16(x) __swap_16(x)
235# define swap_32(x) __swap_32(x)
Mike Frysingercc93fc02009-01-01 18:27:27 -0500236#endif
wdenk012771d2002-03-08 21:31:05 +0000237
238/*
239 * Calling this entity a "pipe" is glorifying it. A USB pipe
240 * is something embarrassingly simple: it basically consists
241 * of the following information:
242 * - device number (7 bits)
243 * - endpoint number (4 bits)
244 * - current Data0/1 state (1 bit)
245 * - direction (1 bit)
Michael Trimarchi3d189962008-11-28 13:19:19 +0100246 * - speed (2 bits)
wdenk012771d2002-03-08 21:31:05 +0000247 * - max packet size (2 bits: 8, 16, 32 or 64)
248 * - pipe type (2 bits: control, interrupt, bulk, isochronous)
249 *
250 * That's 18 bits. Really. Nothing more. And the USB people have
251 * documented these eighteen bits as some kind of glorious
252 * virtual data structure.
253 *
254 * Let's not fall in that trap. We'll just encode it as a simple
255 * unsigned int. The encoding is:
256 *
257 * - max size: bits 0-1 (00 = 8, 01 = 16, 10 = 32, 11 = 64)
Michael Trimarchi5f2e7fc2008-11-26 17:41:34 +0100258 * - direction: bit 7 (0 = Host-to-Device [Out],
259 * (1 = Device-to-Host [In])
wdenk012771d2002-03-08 21:31:05 +0000260 * - device: bits 8-14
261 * - endpoint: bits 15-18
262 * - Data0/1: bit 19
Michael Trimarchi3d189962008-11-28 13:19:19 +0100263 * - speed: bit 26 (0 = Full, 1 = Low Speed, 2 = High)
Michael Trimarchi5f2e7fc2008-11-26 17:41:34 +0100264 * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt,
265 * 10 = control, 11 = bulk)
wdenk012771d2002-03-08 21:31:05 +0000266 *
267 * Why? Because it's arbitrary, and whatever encoding we select is really
268 * up to us. This one happens to share a lot of bit positions with the UHCI
269 * specification, so that much of the uhci driver can just mask the bits
270 * appropriately.
271 */
272/* Create various pipes... */
273#define create_pipe(dev,endpoint) \
Sergei Shtylyovca790852010-05-26 21:26:43 +0400274 (((dev)->devnum << 8) | ((endpoint) << 15) | \
Michael Trimarchi3d189962008-11-28 13:19:19 +0100275 ((dev)->speed << 26) | (dev)->maxpacketsize)
276#define default_pipe(dev) ((dev)->speed << 26)
wdenk012771d2002-03-08 21:31:05 +0000277
Michael Trimarchi5f2e7fc2008-11-26 17:41:34 +0100278#define usb_sndctrlpipe(dev, endpoint) ((PIPE_CONTROL << 30) | \
279 create_pipe(dev, endpoint))
280#define usb_rcvctrlpipe(dev, endpoint) ((PIPE_CONTROL << 30) | \
281 create_pipe(dev, endpoint) | \
282 USB_DIR_IN)
283#define usb_sndisocpipe(dev, endpoint) ((PIPE_ISOCHRONOUS << 30) | \
284 create_pipe(dev, endpoint))
285#define usb_rcvisocpipe(dev, endpoint) ((PIPE_ISOCHRONOUS << 30) | \
286 create_pipe(dev, endpoint) | \
287 USB_DIR_IN)
288#define usb_sndbulkpipe(dev, endpoint) ((PIPE_BULK << 30) | \
289 create_pipe(dev, endpoint))
290#define usb_rcvbulkpipe(dev, endpoint) ((PIPE_BULK << 30) | \
291 create_pipe(dev, endpoint) | \
292 USB_DIR_IN)
293#define usb_sndintpipe(dev, endpoint) ((PIPE_INTERRUPT << 30) | \
294 create_pipe(dev, endpoint))
295#define usb_rcvintpipe(dev, endpoint) ((PIPE_INTERRUPT << 30) | \
296 create_pipe(dev, endpoint) | \
297 USB_DIR_IN)
298#define usb_snddefctrl(dev) ((PIPE_CONTROL << 30) | \
299 default_pipe(dev))
300#define usb_rcvdefctrl(dev) ((PIPE_CONTROL << 30) | \
301 default_pipe(dev) | \
302 USB_DIR_IN)
wdenk012771d2002-03-08 21:31:05 +0000303
304/* The D0/D1 toggle bits */
305#define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> ep) & 1)
wdenk20c98a62004-04-23 20:32:05 +0000306#define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << ep))
Michael Trimarchi5f2e7fc2008-11-26 17:41:34 +0100307#define usb_settoggle(dev, ep, out, bit) ((dev)->toggle[out] = \
308 ((dev)->toggle[out] & \
309 ~(1 << ep)) | ((bit) << ep))
wdenk012771d2002-03-08 21:31:05 +0000310
311/* Endpoint halt control/status */
312#define usb_endpoint_out(ep_dir) (((ep_dir >> 7) & 1) ^ 1)
313#define usb_endpoint_halt(dev, ep, out) ((dev)->halted[out] |= (1 << (ep)))
314#define usb_endpoint_running(dev, ep, out) ((dev)->halted[out] &= ~(1 << (ep)))
315#define usb_endpoint_halted(dev, ep, out) ((dev)->halted[out] & (1 << (ep)))
316
Michael Trimarchi5f2e7fc2008-11-26 17:41:34 +0100317#define usb_packetid(pipe) (((pipe) & USB_DIR_IN) ? USB_PID_IN : \
318 USB_PID_OUT)
wdenk012771d2002-03-08 21:31:05 +0000319
320#define usb_pipeout(pipe) ((((pipe) >> 7) & 1) ^ 1)
321#define usb_pipein(pipe) (((pipe) >> 7) & 1)
322#define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f)
323#define usb_pipe_endpdev(pipe) (((pipe) >> 8) & 0x7ff)
324#define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf)
325#define usb_pipedata(pipe) (((pipe) >> 19) & 1)
Michael Trimarchi3d189962008-11-28 13:19:19 +0100326#define usb_pipespeed(pipe) (((pipe) >> 26) & 3)
327#define usb_pipeslow(pipe) (usb_pipespeed(pipe) == USB_SPEED_LOW)
wdenk012771d2002-03-08 21:31:05 +0000328#define usb_pipetype(pipe) (((pipe) >> 30) & 3)
329#define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
330#define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT)
331#define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL)
332#define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK)
333
334
335/*************************************************************************
336 * Hub Stuff
337 */
338struct usb_port_status {
339 unsigned short wPortStatus;
340 unsigned short wPortChange;
341} __attribute__ ((packed));
342
343struct usb_hub_status {
344 unsigned short wHubStatus;
345 unsigned short wHubChange;
346} __attribute__ ((packed));
347
348
349/* Hub descriptor */
350struct usb_hub_descriptor {
351 unsigned char bLength;
352 unsigned char bDescriptorType;
353 unsigned char bNbrPorts;
354 unsigned short wHubCharacteristics;
355 unsigned char bPwrOn2PwrGood;
356 unsigned char bHubContrCurrent;
357 unsigned char DeviceRemovable[(USB_MAXCHILDREN+1+7)/8];
358 unsigned char PortPowerCtrlMask[(USB_MAXCHILDREN+1+7)/8];
Michael Trimarchi5f2e7fc2008-11-26 17:41:34 +0100359 /* DeviceRemovable and PortPwrCtrlMask want to be variable-length
wdenk012771d2002-03-08 21:31:05 +0000360 bitmaps that hold max 255 entries. (bit0 is ignored) */
361} __attribute__ ((packed));
362
363
364struct usb_hub_device {
365 struct usb_device *pusb_dev;
366 struct usb_hub_descriptor desc;
367};
368
Marek Vasut6da5af32012-02-13 18:58:17 +0000369int usb_hub_probe(struct usb_device *dev, int ifnum);
370void usb_hub_reset(void);
371int hub_port_reset(struct usb_device *dev, int port,
372 unsigned short *portstat);
373
374struct usb_device *usb_alloc_new_device(void);
375int usb_new_device(struct usb_device *dev);
376
wdenk012771d2002-03-08 21:31:05 +0000377#endif /*_USB_H_ */