blob: 8d8a2c9b9da63421b59a7eeb9e02c6a2be285c76 [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
wdenk5cf91d62004-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>
Ilya Yanokc60795f2012-11-06 13:48:20 +000030#include <linux/usb/ch9.h>
wdenk012771d2002-03-08 21:31:05 +000031
Tom Rini71c5de42012-07-15 22:14:24 +000032/*
33 * The EHCI spec says that we must align to at least 32 bytes. However,
34 * some platforms require larger alignment.
35 */
36#if ARCH_DMA_MINALIGN > 32
37#define USB_DMA_MINALIGN ARCH_DMA_MINALIGN
38#else
39#define USB_DMA_MINALIGN 32
40#endif
41
wdenk012771d2002-03-08 21:31:05 +000042/* Everything is aribtrary */
wdenk5cf91d62004-04-23 20:32:05 +000043#define USB_ALTSETTINGALLOC 4
44#define USB_MAXALTSETTING 128 /* Hard limit */
wdenk012771d2002-03-08 21:31:05 +000045
wdenk5cf91d62004-04-23 20:32:05 +000046#define USB_MAX_DEVICE 32
47#define USB_MAXCONFIG 8
48#define USB_MAXINTERFACES 8
49#define USB_MAXENDPOINTS 16
50#define USB_MAXCHILDREN 8 /* This is arbitrary */
51#define USB_MAX_HUB 16
wdenk012771d2002-03-08 21:31:05 +000052
53#define USB_CNTL_TIMEOUT 100 /* 100ms timeout */
54
Simon Glass96820a32011-02-07 14:42:16 -080055/*
56 * This is the timeout to allow for submitting an urb in ms. We allow more
57 * time for a BULK device to react - some are slow.
58 */
Jason Cooper80b350a2011-07-31 20:09:58 +000059#define USB_TIMEOUT_MS(pipe) (usb_pipebulk(pipe) ? 5000 : 1000)
Simon Glass96820a32011-02-07 14:42:16 -080060
wdenk012771d2002-03-08 21:31:05 +000061/* device request (setup) */
62struct devrequest {
Michael Trimarchide39f8c2008-11-26 17:41:34 +010063 unsigned char requesttype;
64 unsigned char request;
65 unsigned short value;
66 unsigned short index;
67 unsigned short length;
wdenk012771d2002-03-08 21:31:05 +000068} __attribute__ ((packed));
69
Tom Rix8f8bd562009-10-31 12:37:38 -050070/* Interface */
71struct usb_interface {
72 struct usb_interface_descriptor desc;
wdenk012771d2002-03-08 21:31:05 +000073
Michael Trimarchide39f8c2008-11-26 17:41:34 +010074 unsigned char no_of_ep;
75 unsigned char num_altsetting;
76 unsigned char act_altsetting;
77
wdenk012771d2002-03-08 21:31:05 +000078 struct usb_endpoint_descriptor ep_desc[USB_MAXENDPOINTS];
79} __attribute__ ((packed));
80
Tom Rix8f8bd562009-10-31 12:37:38 -050081/* Configuration information.. */
82struct usb_config {
Ilya Yanokc60795f2012-11-06 13:48:20 +000083 struct usb_config_descriptor desc;
wdenk012771d2002-03-08 21:31:05 +000084
Michael Trimarchide39f8c2008-11-26 17:41:34 +010085 unsigned char no_of_if; /* number of interfaces */
Tom Rix8f8bd562009-10-31 12:37:38 -050086 struct usb_interface if_desc[USB_MAXINTERFACES];
wdenk012771d2002-03-08 21:31:05 +000087} __attribute__ ((packed));
88
Remy Bohmer48867202008-10-10 10:23:21 +020089enum {
90 /* Maximum packet size; encoded as 0,1,2,3 = 8,16,32,64 */
91 PACKET_SIZE_8 = 0,
92 PACKET_SIZE_16 = 1,
93 PACKET_SIZE_32 = 2,
94 PACKET_SIZE_64 = 3,
95};
wdenk012771d2002-03-08 21:31:05 +000096
97struct usb_device {
Michael Trimarchide39f8c2008-11-26 17:41:34 +010098 int devnum; /* Device number on USB bus */
Michael Trimarchi3e126482008-11-28 13:19:19 +010099 int speed; /* full/low/high */
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100100 char mf[32]; /* manufacturer */
101 char prod[32]; /* product */
102 char serial[32]; /* serial number */
wdenk012771d2002-03-08 21:31:05 +0000103
Remy Bohmer48867202008-10-10 10:23:21 +0200104 /* Maximum packet size; one of: PACKET_SIZE_* */
105 int maxpacketsize;
106 /* one bit for each endpoint ([0] = IN, [1] = OUT) */
107 unsigned int toggle[2];
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100108 /* endpoint halts; one bit per endpoint # & direction;
109 * [0] = IN, [1] = OUT
110 */
Remy Bohmer48867202008-10-10 10:23:21 +0200111 unsigned int halted[2];
wdenk012771d2002-03-08 21:31:05 +0000112 int epmaxpacketin[16]; /* INput endpoint specific maximums */
113 int epmaxpacketout[16]; /* OUTput endpoint specific maximums */
114
115 int configno; /* selected config number */
Puneet Saxenaf5766132012-04-03 14:56:06 +0530116 /* Device Descriptor */
117 struct usb_device_descriptor descriptor
118 __attribute__((aligned(ARCH_DMA_MINALIGN)));
Tom Rix8f8bd562009-10-31 12:37:38 -0500119 struct usb_config config; /* config descriptor */
wdenk012771d2002-03-08 21:31:05 +0000120
121 int have_langid; /* whether string_langid is valid yet */
122 int string_langid; /* language ID for strings */
123 int (*irq_handle)(struct usb_device *dev);
124 unsigned long irq_status;
wdenk5cf91d62004-04-23 20:32:05 +0000125 int irq_act_len; /* transfered bytes */
wdenk012771d2002-03-08 21:31:05 +0000126 void *privptr;
127 /*
128 * Child devices - if this is a hub device
129 * Each instance needs its own set of data structures.
130 */
131 unsigned long status;
132 int act_len; /* transfered bytes */
133 int maxchild; /* Number of ports if hub */
Michael Trimarchi3e126482008-11-28 13:19:19 +0100134 int portnr;
wdenk012771d2002-03-08 21:31:05 +0000135 struct usb_device *parent;
136 struct usb_device *children[USB_MAXCHILDREN];
Lucas Stachc7e3b2b2012-09-26 00:14:34 +0200137
138 void *controller; /* hardware controller private data */
wdenk012771d2002-03-08 21:31:05 +0000139};
140
141/**********************************************************************
142 * this is how the lowlevel part communicate with the outer world
143 */
144
Rodolfo Giometti822af352007-04-03 14:27:18 +0200145#if defined(CONFIG_USB_UHCI) || defined(CONFIG_USB_OHCI) || \
michael51ab1422008-12-11 13:43:55 +0100146 defined(CONFIG_USB_EHCI) || defined(CONFIG_USB_OHCI_NEW) || \
Michael Trimarchi3e126482008-11-28 13:19:19 +0100147 defined(CONFIG_USB_SL811HS) || defined(CONFIG_USB_ISP116X_HCD) || \
Tom Rixf298e4b2009-10-31 12:37:41 -0500148 defined(CONFIG_USB_R8A66597_HCD) || defined(CONFIG_USB_DAVINCI) || \
Bryan Wue608f222009-12-16 22:04:02 -0500149 defined(CONFIG_USB_OMAP3) || defined(CONFIG_USB_DA8XX) || \
Ilya Yanok37931f02012-11-06 13:48:22 +0000150 defined(CONFIG_USB_BLACKFIN) || defined(CONFIG_USB_AM35X) || \
Ilya Yanok673a5242012-11-06 13:48:29 +0000151 defined(CONFIG_USB_MUSB_DSPS) || defined(CONFIG_USB_MUSB_AM35X) || \
152 defined(CONFIG_USB_MUSB_OMAP2PLUS)
Rodolfo Giometti822af352007-04-03 14:27:18 +0200153
Lucas Stachc7e3b2b2012-09-26 00:14:34 +0200154int usb_lowlevel_init(int index, void **controller);
155int usb_lowlevel_stop(int index);
156
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100157int submit_bulk_msg(struct usb_device *dev, unsigned long pipe,
158 void *buffer, int transfer_len);
wdenk012771d2002-03-08 21:31:05 +0000159int submit_control_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100160 int transfer_len, struct devrequest *setup);
wdenk012771d2002-03-08 21:31:05 +0000161int submit_int_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
162 int transfer_len, int interval);
163
164/* Defines */
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100165#define USB_UHCI_VEND_ID 0x8086
166#define USB_UHCI_DEV_ID 0x7112
wdenk012771d2002-03-08 21:31:05 +0000167
Lukasz Daleke5f24752012-10-02 17:04:33 +0200168/*
169 * PXA25x can only act as USB device. There are drivers
170 * which works with USB CDC gadgets implementations.
171 * Some of them have common routines which can be used
172 * in boards init functions e.g. udc_disconnect() used for
173 * forced device disconnection from host.
174 */
175#elif defined(CONFIG_USB_GADGET_PXA2XX)
176
177extern void udc_disconnect(void);
178
wdenk012771d2002-03-08 21:31:05 +0000179#else
180#error USB Lowlevel not defined
181#endif
182
183#ifdef CONFIG_USB_STORAGE
184
185#define USB_MAX_STOR_DEV 5
186block_dev_desc_t *usb_stor_get_dev(int index);
187int usb_stor_scan(int mode);
Anatolij Gustschine813eae2008-03-26 17:47:44 +0100188int usb_stor_info(void);
wdenk012771d2002-03-08 21:31:05 +0000189
190#endif
191
Simon Glass89d48362011-02-16 11:14:33 -0800192#ifdef CONFIG_USB_HOST_ETHER
193
194#define USB_MAX_ETH_DEV 5
195int usb_host_eth_scan(int mode);
196
197#endif
198
wdenk012771d2002-03-08 21:31:05 +0000199#ifdef CONFIG_USB_KEYBOARD
200
201int drv_usb_kbd_init(void);
202int usb_kbd_deregister(void);
203
204#endif
205/* routines */
206int usb_init(void); /* initialize the USB Controller */
207int usb_stop(void); /* stop the USB Controller */
208
209
210int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol);
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100211int usb_set_idle(struct usb_device *dev, int ifnum, int duration,
212 int report_id);
213struct usb_device *usb_get_dev_index(int index);
wdenk012771d2002-03-08 21:31:05 +0000214int usb_control_msg(struct usb_device *dev, unsigned int pipe,
215 unsigned char request, unsigned char requesttype,
216 unsigned short value, unsigned short index,
217 void *data, unsigned short size, int timeout);
218int usb_bulk_msg(struct usb_device *dev, unsigned int pipe,
219 void *data, int len, int *actual_length, int timeout);
220int usb_submit_int_msg(struct usb_device *dev, unsigned long pipe,
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100221 void *buffer, int transfer_len, int interval);
Simon Glass89d48362011-02-16 11:14:33 -0800222int usb_disable_asynch(int disable);
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100223int usb_maxpacket(struct usb_device *dev, unsigned long pipe);
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100224int usb_get_configuration_no(struct usb_device *dev, unsigned char *buffer,
225 int cfgno);
226int usb_get_report(struct usb_device *dev, int ifnum, unsigned char type,
227 unsigned char id, void *buf, int size);
wdenk012771d2002-03-08 21:31:05 +0000228int usb_get_class_descriptor(struct usb_device *dev, int ifnum,
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100229 unsigned char type, unsigned char id, void *buf,
230 int size);
wdenk012771d2002-03-08 21:31:05 +0000231int usb_clear_halt(struct usb_device *dev, int pipe);
232int usb_string(struct usb_device *dev, int index, char *buf, size_t size);
233int usb_set_interface(struct usb_device *dev, int interface, int alternate);
234
235/* big endian -> little endian conversion */
wdenk149dded2003-09-10 18:20:28 +0000236/* some CPUs are already little endian e.g. the ARM920T */
Markus Klotzbuecherae3b7702006-11-27 11:46:46 +0100237#define __swap_16(x) \
wdenk3f85ce22004-02-23 16:11:30 +0000238 ({ unsigned short x_ = (unsigned short)x; \
239 (unsigned short)( \
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100240 ((x_ & 0x00FFU) << 8) | ((x_ & 0xFF00U) >> 8)); \
wdenk3f85ce22004-02-23 16:11:30 +0000241 })
Markus Klotzbuecherae3b7702006-11-27 11:46:46 +0100242#define __swap_32(x) \
wdenk3f85ce22004-02-23 16:11:30 +0000243 ({ unsigned long x_ = (unsigned long)x; \
244 (unsigned long)( \
245 ((x_ & 0x000000FFUL) << 24) | \
wdenk5cf91d62004-04-23 20:32:05 +0000246 ((x_ & 0x0000FF00UL) << 8) | \
247 ((x_ & 0x00FF0000UL) >> 8) | \
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100248 ((x_ & 0xFF000000UL) >> 24)); \
wdenk3f85ce22004-02-23 16:11:30 +0000249 })
Markus Klotzbuecherae3b7702006-11-27 11:46:46 +0100250
Mike Frysingerc7d703f2009-01-01 18:27:27 -0500251#ifdef __LITTLE_ENDIAN
Markus Klotzbuecherae3b7702006-11-27 11:46:46 +0100252# define swap_16(x) (x)
253# define swap_32(x) (x)
254#else
255# define swap_16(x) __swap_16(x)
256# define swap_32(x) __swap_32(x)
Mike Frysingerc7d703f2009-01-01 18:27:27 -0500257#endif
wdenk012771d2002-03-08 21:31:05 +0000258
259/*
260 * Calling this entity a "pipe" is glorifying it. A USB pipe
261 * is something embarrassingly simple: it basically consists
262 * of the following information:
263 * - device number (7 bits)
264 * - endpoint number (4 bits)
265 * - current Data0/1 state (1 bit)
266 * - direction (1 bit)
Michael Trimarchi3e126482008-11-28 13:19:19 +0100267 * - speed (2 bits)
wdenk012771d2002-03-08 21:31:05 +0000268 * - max packet size (2 bits: 8, 16, 32 or 64)
269 * - pipe type (2 bits: control, interrupt, bulk, isochronous)
270 *
271 * That's 18 bits. Really. Nothing more. And the USB people have
272 * documented these eighteen bits as some kind of glorious
273 * virtual data structure.
274 *
275 * Let's not fall in that trap. We'll just encode it as a simple
276 * unsigned int. The encoding is:
277 *
278 * - max size: bits 0-1 (00 = 8, 01 = 16, 10 = 32, 11 = 64)
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100279 * - direction: bit 7 (0 = Host-to-Device [Out],
280 * (1 = Device-to-Host [In])
wdenk012771d2002-03-08 21:31:05 +0000281 * - device: bits 8-14
282 * - endpoint: bits 15-18
283 * - Data0/1: bit 19
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100284 * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt,
285 * 10 = control, 11 = bulk)
wdenk012771d2002-03-08 21:31:05 +0000286 *
287 * Why? Because it's arbitrary, and whatever encoding we select is really
288 * up to us. This one happens to share a lot of bit positions with the UHCI
289 * specification, so that much of the uhci driver can just mask the bits
290 * appropriately.
291 */
292/* Create various pipes... */
293#define create_pipe(dev,endpoint) \
Sergei Shtylyovd0fe1122010-05-26 21:26:43 +0400294 (((dev)->devnum << 8) | ((endpoint) << 15) | \
Ilya Yanokc60795f2012-11-06 13:48:20 +0000295 (dev)->maxpacketsize)
Michael Trimarchi3e126482008-11-28 13:19:19 +0100296#define default_pipe(dev) ((dev)->speed << 26)
wdenk012771d2002-03-08 21:31:05 +0000297
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100298#define usb_sndctrlpipe(dev, endpoint) ((PIPE_CONTROL << 30) | \
299 create_pipe(dev, endpoint))
300#define usb_rcvctrlpipe(dev, endpoint) ((PIPE_CONTROL << 30) | \
301 create_pipe(dev, endpoint) | \
302 USB_DIR_IN)
303#define usb_sndisocpipe(dev, endpoint) ((PIPE_ISOCHRONOUS << 30) | \
304 create_pipe(dev, endpoint))
305#define usb_rcvisocpipe(dev, endpoint) ((PIPE_ISOCHRONOUS << 30) | \
306 create_pipe(dev, endpoint) | \
307 USB_DIR_IN)
308#define usb_sndbulkpipe(dev, endpoint) ((PIPE_BULK << 30) | \
309 create_pipe(dev, endpoint))
310#define usb_rcvbulkpipe(dev, endpoint) ((PIPE_BULK << 30) | \
311 create_pipe(dev, endpoint) | \
312 USB_DIR_IN)
313#define usb_sndintpipe(dev, endpoint) ((PIPE_INTERRUPT << 30) | \
314 create_pipe(dev, endpoint))
315#define usb_rcvintpipe(dev, endpoint) ((PIPE_INTERRUPT << 30) | \
316 create_pipe(dev, endpoint) | \
317 USB_DIR_IN)
318#define usb_snddefctrl(dev) ((PIPE_CONTROL << 30) | \
319 default_pipe(dev))
320#define usb_rcvdefctrl(dev) ((PIPE_CONTROL << 30) | \
321 default_pipe(dev) | \
322 USB_DIR_IN)
wdenk012771d2002-03-08 21:31:05 +0000323
324/* The D0/D1 toggle bits */
325#define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> ep) & 1)
wdenk5cf91d62004-04-23 20:32:05 +0000326#define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << ep))
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100327#define usb_settoggle(dev, ep, out, bit) ((dev)->toggle[out] = \
328 ((dev)->toggle[out] & \
329 ~(1 << ep)) | ((bit) << ep))
wdenk012771d2002-03-08 21:31:05 +0000330
331/* Endpoint halt control/status */
332#define usb_endpoint_out(ep_dir) (((ep_dir >> 7) & 1) ^ 1)
333#define usb_endpoint_halt(dev, ep, out) ((dev)->halted[out] |= (1 << (ep)))
334#define usb_endpoint_running(dev, ep, out) ((dev)->halted[out] &= ~(1 << (ep)))
335#define usb_endpoint_halted(dev, ep, out) ((dev)->halted[out] & (1 << (ep)))
336
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100337#define usb_packetid(pipe) (((pipe) & USB_DIR_IN) ? USB_PID_IN : \
338 USB_PID_OUT)
wdenk012771d2002-03-08 21:31:05 +0000339
340#define usb_pipeout(pipe) ((((pipe) >> 7) & 1) ^ 1)
341#define usb_pipein(pipe) (((pipe) >> 7) & 1)
342#define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f)
343#define usb_pipe_endpdev(pipe) (((pipe) >> 8) & 0x7ff)
344#define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf)
345#define usb_pipedata(pipe) (((pipe) >> 19) & 1)
wdenk012771d2002-03-08 21:31:05 +0000346#define usb_pipetype(pipe) (((pipe) >> 30) & 3)
347#define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
348#define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT)
349#define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL)
350#define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK)
351
352
353/*************************************************************************
354 * Hub Stuff
355 */
356struct usb_port_status {
357 unsigned short wPortStatus;
358 unsigned short wPortChange;
359} __attribute__ ((packed));
360
361struct usb_hub_status {
362 unsigned short wHubStatus;
363 unsigned short wHubChange;
364} __attribute__ ((packed));
365
366
367/* Hub descriptor */
368struct usb_hub_descriptor {
369 unsigned char bLength;
370 unsigned char bDescriptorType;
371 unsigned char bNbrPorts;
372 unsigned short wHubCharacteristics;
373 unsigned char bPwrOn2PwrGood;
374 unsigned char bHubContrCurrent;
375 unsigned char DeviceRemovable[(USB_MAXCHILDREN+1+7)/8];
376 unsigned char PortPowerCtrlMask[(USB_MAXCHILDREN+1+7)/8];
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100377 /* DeviceRemovable and PortPwrCtrlMask want to be variable-length
wdenk012771d2002-03-08 21:31:05 +0000378 bitmaps that hold max 255 entries. (bit0 is ignored) */
379} __attribute__ ((packed));
380
381
382struct usb_hub_device {
383 struct usb_device *pusb_dev;
384 struct usb_hub_descriptor desc;
385};
386
Marek Vasut23faf2b2012-02-13 18:58:17 +0000387int usb_hub_probe(struct usb_device *dev, int ifnum);
388void usb_hub_reset(void);
389int hub_port_reset(struct usb_device *dev, int port,
390 unsigned short *portstat);
391
Lucas Stachc7e3b2b2012-09-26 00:14:34 +0200392struct usb_device *usb_alloc_new_device(void *controller);
393
Marek Vasut23faf2b2012-02-13 18:58:17 +0000394int usb_new_device(struct usb_device *dev);
395
wdenk012771d2002-03-08 21:31:05 +0000396#endif /*_USB_H_ */