blob: e68e98eadc70d9eaa7f11479e4c06e599a4ab302 [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>
30
31/* Everything is aribtrary */
wdenk5cf91d62004-04-23 20:32:05 +000032#define USB_ALTSETTINGALLOC 4
33#define USB_MAXALTSETTING 128 /* Hard limit */
wdenk012771d2002-03-08 21:31:05 +000034
wdenk5cf91d62004-04-23 20:32:05 +000035#define USB_MAX_DEVICE 32
36#define USB_MAXCONFIG 8
37#define USB_MAXINTERFACES 8
38#define USB_MAXENDPOINTS 16
39#define USB_MAXCHILDREN 8 /* This is arbitrary */
40#define USB_MAX_HUB 16
wdenk012771d2002-03-08 21:31:05 +000041
42#define USB_CNTL_TIMEOUT 100 /* 100ms timeout */
43
wdenk012771d2002-03-08 21:31:05 +000044/* String descriptor */
45struct usb_string_descriptor {
46 unsigned char bLength;
47 unsigned char bDescriptorType;
48 unsigned short wData[1];
49} __attribute__ ((packed));
50
51/* device request (setup) */
52struct devrequest {
53 unsigned char requesttype;
54 unsigned char request;
55 unsigned short value;
56 unsigned short index;
57 unsigned short length;
58} __attribute__ ((packed));
59
60
wdenk012771d2002-03-08 21:31:05 +000061/* All standard descriptors have these 2 fields in common */
62struct usb_descriptor_header {
63 unsigned char bLength;
64 unsigned char bDescriptorType;
65} __attribute__ ((packed));
66
67/* Device descriptor */
68struct usb_device_descriptor {
69 unsigned char bLength;
70 unsigned char bDescriptorType;
71 unsigned short bcdUSB;
72 unsigned char bDeviceClass;
73 unsigned char bDeviceSubClass;
74 unsigned char bDeviceProtocol;
75 unsigned char bMaxPacketSize0;
76 unsigned short idVendor;
77 unsigned short idProduct;
78 unsigned short bcdDevice;
79 unsigned char iManufacturer;
80 unsigned char iProduct;
81 unsigned char iSerialNumber;
82 unsigned char bNumConfigurations;
83} __attribute__ ((packed));
84
85
86/* Endpoint descriptor */
87struct usb_endpoint_descriptor {
88 unsigned char bLength;
89 unsigned char bDescriptorType;
90 unsigned char bEndpointAddress;
91 unsigned char bmAttributes;
92 unsigned short wMaxPacketSize;
93 unsigned char bInterval;
94 unsigned char bRefresh;
95 unsigned char bSynchAddress;
96
97} __attribute__ ((packed));
98/* Interface descriptor */
99struct usb_interface_descriptor {
100 unsigned char bLength;
101 unsigned char bDescriptorType;
102 unsigned char bInterfaceNumber;
103 unsigned char bAlternateSetting;
104 unsigned char bNumEndpoints;
105 unsigned char bInterfaceClass;
106 unsigned char bInterfaceSubClass;
107 unsigned char bInterfaceProtocol;
108 unsigned char iInterface;
109
110 unsigned char no_of_ep;
Bartlomiej Sieka7455af42006-08-02 00:54:18 +0200111 unsigned char num_altsetting;
wdenk012771d2002-03-08 21:31:05 +0000112 unsigned char act_altsetting;
113 struct usb_endpoint_descriptor ep_desc[USB_MAXENDPOINTS];
114} __attribute__ ((packed));
115
116
117/* Configuration descriptor information.. */
118struct usb_config_descriptor {
119 unsigned char bLength;
120 unsigned char bDescriptorType;
121 unsigned short wTotalLength;
122 unsigned char bNumInterfaces;
123 unsigned char bConfigurationValue;
124 unsigned char iConfiguration;
125 unsigned char bmAttributes;
126 unsigned char MaxPower;
127
wdenk5cf91d62004-04-23 20:32:05 +0000128 unsigned char no_of_if; /* number of interfaces */
wdenk012771d2002-03-08 21:31:05 +0000129 struct usb_interface_descriptor if_desc[USB_MAXINTERFACES];
130} __attribute__ ((packed));
131
132
133struct usb_device {
wdenk5cf91d62004-04-23 20:32:05 +0000134 int devnum; /* Device number on USB bus */
135 int slow; /* Slow device? */
136 char mf[32]; /* manufacturer */
137 char prod[32]; /* product */
138 char serial[32]; /* serial number */
wdenk012771d2002-03-08 21:31:05 +0000139
wdenk5cf91d62004-04-23 20:32:05 +0000140 int maxpacketsize; /* Maximum packet size; encoded as 0,1,2,3 = 8,16,32,64 */
wdenk012771d2002-03-08 21:31:05 +0000141 unsigned int toggle[2]; /* one bit for each endpoint ([0] = IN, [1] = OUT) */
142 unsigned int halted[2]; /* endpoint halts; one bit per endpoint # & direction; */
wdenk8bde7f72003-06-27 21:31:46 +0000143 /* [0] = IN, [1] = OUT */
wdenk012771d2002-03-08 21:31:05 +0000144 int epmaxpacketin[16]; /* INput endpoint specific maximums */
145 int epmaxpacketout[16]; /* OUTput endpoint specific maximums */
146
147 int configno; /* selected config number */
148 struct usb_device_descriptor descriptor; /* Device Descriptor */
149 struct usb_config_descriptor config; /* config descriptor */
150
151 int have_langid; /* whether string_langid is valid yet */
152 int string_langid; /* language ID for strings */
153 int (*irq_handle)(struct usb_device *dev);
154 unsigned long irq_status;
wdenk5cf91d62004-04-23 20:32:05 +0000155 int irq_act_len; /* transfered bytes */
wdenk012771d2002-03-08 21:31:05 +0000156 void *privptr;
157 /*
158 * Child devices - if this is a hub device
159 * Each instance needs its own set of data structures.
160 */
161 unsigned long status;
162 int act_len; /* transfered bytes */
163 int maxchild; /* Number of ports if hub */
164 struct usb_device *parent;
165 struct usb_device *children[USB_MAXCHILDREN];
166};
167
168/**********************************************************************
169 * this is how the lowlevel part communicate with the outer world
170 */
171
Rodolfo Giometti822af352007-04-03 14:27:18 +0200172#if defined(CONFIG_USB_UHCI) || defined(CONFIG_USB_OHCI) || \
173 defined(CONFIG_USB_OHCI_NEW) || defined (CONFIG_USB_SL811HS) || \
Yoshihiro Shimodafd0f2f32008-07-09 21:07:38 +0900174 defined(CONFIG_USB_ISP116X_HCD) || defined(CONFIG_USB_R8A66597_HCD)
Rodolfo Giometti822af352007-04-03 14:27:18 +0200175
wdenk012771d2002-03-08 21:31:05 +0000176int usb_lowlevel_init(void);
177int usb_lowlevel_stop(void);
178int submit_bulk_msg(struct usb_device *dev, unsigned long pipe, void *buffer,int transfer_len);
179int submit_control_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
180 int transfer_len,struct devrequest *setup);
181int submit_int_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
182 int transfer_len, int interval);
Zhang Weifdcfaa12007-06-06 10:08:13 +0200183void usb_event_poll(void);
wdenk012771d2002-03-08 21:31:05 +0000184
185/* Defines */
186#define USB_UHCI_VEND_ID 0x8086
wdenk5cf91d62004-04-23 20:32:05 +0000187#define USB_UHCI_DEV_ID 0x7112
wdenk012771d2002-03-08 21:31:05 +0000188
189#else
190#error USB Lowlevel not defined
191#endif
192
193#ifdef CONFIG_USB_STORAGE
194
195#define USB_MAX_STOR_DEV 5
196block_dev_desc_t *usb_stor_get_dev(int index);
197int usb_stor_scan(int mode);
Anatolij Gustschine813eae2008-03-26 17:47:44 +0100198int usb_stor_info(void);
wdenk012771d2002-03-08 21:31:05 +0000199
200#endif
201
202#ifdef CONFIG_USB_KEYBOARD
203
204int drv_usb_kbd_init(void);
205int usb_kbd_deregister(void);
206
207#endif
208/* routines */
209int usb_init(void); /* initialize the USB Controller */
210int usb_stop(void); /* stop the USB Controller */
211
212
213int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol);
214int usb_set_idle(struct usb_device *dev, int ifnum, int duration, int report_id);
215struct usb_device * usb_get_dev_index(int index);
216int usb_control_msg(struct usb_device *dev, unsigned int pipe,
217 unsigned char request, unsigned char requesttype,
218 unsigned short value, unsigned short index,
219 void *data, unsigned short size, int timeout);
220int usb_bulk_msg(struct usb_device *dev, unsigned int pipe,
221 void *data, int len, int *actual_length, int timeout);
222int usb_submit_int_msg(struct usb_device *dev, unsigned long pipe,
223 void *buffer,int transfer_len, int interval);
224void usb_disable_asynch(int disable);
225int usb_maxpacket(struct usb_device *dev,unsigned long pipe);
226void __inline__ wait_ms(unsigned long ms);
227int usb_get_configuration_no(struct usb_device *dev,unsigned char *buffer,int cfgno);
228int usb_get_report(struct usb_device *dev, int ifnum, unsigned char type, unsigned char id, void *buf, int size);
229int usb_get_class_descriptor(struct usb_device *dev, int ifnum,
230 unsigned char type, unsigned char id, void *buf, int size);
231int 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)( \
240 ((x_ & 0x00FFU) << 8) | ((x_ & 0xFF00U) >> 8) ); \
241 })
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) | \
wdenk3f85ce22004-02-23 16:11:30 +0000248 ((x_ & 0xFF000000UL) >> 24) ); \
249 })
Markus Klotzbuecherae3b7702006-11-27 11:46:46 +0100250
251#ifdef LITTLEENDIAN
252# 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)
wdenk149dded2003-09-10 18:20:28 +0000257#endif /* LITTLEENDIAN */
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)
267 * - speed (1 bit)
268 * - 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)
279 * - direction: bit 7 (0 = Host-to-Device [Out], 1 = Device-to-Host [In])
280 * - device: bits 8-14
281 * - endpoint: bits 15-18
282 * - Data0/1: bit 19
283 * - speed: bit 26 (0 = Full, 1 = Low Speed)
284 * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt, 10 = control, 11 = bulk)
285 *
286 * Why? Because it's arbitrary, and whatever encoding we select is really
287 * up to us. This one happens to share a lot of bit positions with the UHCI
288 * specification, so that much of the uhci driver can just mask the bits
289 * appropriately.
290 */
291/* Create various pipes... */
292#define create_pipe(dev,endpoint) \
293 (((dev)->devnum << 8) | (endpoint << 15) | ((dev)->slow << 26) | (dev)->maxpacketsize)
294#define default_pipe(dev) ((dev)->slow <<26)
295
296#define usb_sndctrlpipe(dev,endpoint) ((PIPE_CONTROL << 30) | create_pipe(dev,endpoint))
297#define usb_rcvctrlpipe(dev,endpoint) ((PIPE_CONTROL << 30) | create_pipe(dev,endpoint) | USB_DIR_IN)
298#define usb_sndisocpipe(dev,endpoint) ((PIPE_ISOCHRONOUS << 30) | create_pipe(dev,endpoint))
299#define usb_rcvisocpipe(dev,endpoint) ((PIPE_ISOCHRONOUS << 30) | create_pipe(dev,endpoint) | USB_DIR_IN)
300#define usb_sndbulkpipe(dev,endpoint) ((PIPE_BULK << 30) | create_pipe(dev,endpoint))
301#define usb_rcvbulkpipe(dev,endpoint) ((PIPE_BULK << 30) | create_pipe(dev,endpoint) | USB_DIR_IN)
302#define usb_sndintpipe(dev,endpoint) ((PIPE_INTERRUPT << 30) | create_pipe(dev,endpoint))
303#define usb_rcvintpipe(dev,endpoint) ((PIPE_INTERRUPT << 30) | create_pipe(dev,endpoint) | USB_DIR_IN)
304#define usb_snddefctrl(dev) ((PIPE_CONTROL << 30) | default_pipe(dev))
305#define usb_rcvdefctrl(dev) ((PIPE_CONTROL << 30) | default_pipe(dev) | USB_DIR_IN)
306
307/* The D0/D1 toggle bits */
308#define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> ep) & 1)
wdenk5cf91d62004-04-23 20:32:05 +0000309#define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << ep))
wdenk012771d2002-03-08 21:31:05 +0000310#define usb_settoggle(dev, ep, out, bit) ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << ep)) | ((bit) << ep))
311
312/* Endpoint halt control/status */
313#define usb_endpoint_out(ep_dir) (((ep_dir >> 7) & 1) ^ 1)
314#define usb_endpoint_halt(dev, ep, out) ((dev)->halted[out] |= (1 << (ep)))
315#define usb_endpoint_running(dev, ep, out) ((dev)->halted[out] &= ~(1 << (ep)))
316#define usb_endpoint_halted(dev, ep, out) ((dev)->halted[out] & (1 << (ep)))
317
318#define usb_packetid(pipe) (((pipe) & USB_DIR_IN) ? USB_PID_IN : USB_PID_OUT)
319
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)
326#define usb_pipeslow(pipe) (((pipe) >> 26) & 1)
327#define usb_pipetype(pipe) (((pipe) >> 30) & 3)
328#define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
329#define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT)
330#define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL)
331#define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK)
332
333
334/*************************************************************************
335 * Hub Stuff
336 */
337struct usb_port_status {
338 unsigned short wPortStatus;
339 unsigned short wPortChange;
340} __attribute__ ((packed));
341
342struct usb_hub_status {
343 unsigned short wHubStatus;
344 unsigned short wHubChange;
345} __attribute__ ((packed));
346
347
348/* Hub descriptor */
349struct usb_hub_descriptor {
350 unsigned char bLength;
351 unsigned char bDescriptorType;
352 unsigned char bNbrPorts;
353 unsigned short wHubCharacteristics;
354 unsigned char bPwrOn2PwrGood;
355 unsigned char bHubContrCurrent;
356 unsigned char DeviceRemovable[(USB_MAXCHILDREN+1+7)/8];
357 unsigned char PortPowerCtrlMask[(USB_MAXCHILDREN+1+7)/8];
358 /* DeviceRemovable and PortPwrCtrlMask want to be variable-length
359 bitmaps that hold max 255 entries. (bit0 is ignored) */
360} __attribute__ ((packed));
361
362
363struct usb_hub_device {
364 struct usb_device *pusb_dev;
365 struct usb_hub_descriptor desc;
366};
367
368#endif /*_USB_H_ */