blob: 6940d3251095b0b05802f195f41cba70b3fdc3c7 [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
44
45/* String descriptor */
46struct usb_string_descriptor {
47 unsigned char bLength;
48 unsigned char bDescriptorType;
49 unsigned short wData[1];
50} __attribute__ ((packed));
51
52/* device request (setup) */
53struct devrequest {
54 unsigned char requesttype;
55 unsigned char request;
56 unsigned short value;
57 unsigned short index;
58 unsigned short length;
59} __attribute__ ((packed));
60
61
wdenk012771d2002-03-08 21:31:05 +000062/* All standard descriptors have these 2 fields in common */
63struct usb_descriptor_header {
64 unsigned char bLength;
65 unsigned char bDescriptorType;
66} __attribute__ ((packed));
67
68/* Device descriptor */
69struct usb_device_descriptor {
70 unsigned char bLength;
71 unsigned char bDescriptorType;
72 unsigned short bcdUSB;
73 unsigned char bDeviceClass;
74 unsigned char bDeviceSubClass;
75 unsigned char bDeviceProtocol;
76 unsigned char bMaxPacketSize0;
77 unsigned short idVendor;
78 unsigned short idProduct;
79 unsigned short bcdDevice;
80 unsigned char iManufacturer;
81 unsigned char iProduct;
82 unsigned char iSerialNumber;
83 unsigned char bNumConfigurations;
84} __attribute__ ((packed));
85
86
87/* Endpoint descriptor */
88struct usb_endpoint_descriptor {
89 unsigned char bLength;
90 unsigned char bDescriptorType;
91 unsigned char bEndpointAddress;
92 unsigned char bmAttributes;
93 unsigned short wMaxPacketSize;
94 unsigned char bInterval;
95 unsigned char bRefresh;
96 unsigned char bSynchAddress;
97
98} __attribute__ ((packed));
99/* Interface descriptor */
100struct usb_interface_descriptor {
101 unsigned char bLength;
102 unsigned char bDescriptorType;
103 unsigned char bInterfaceNumber;
104 unsigned char bAlternateSetting;
105 unsigned char bNumEndpoints;
106 unsigned char bInterfaceClass;
107 unsigned char bInterfaceSubClass;
108 unsigned char bInterfaceProtocol;
109 unsigned char iInterface;
110
111 unsigned char no_of_ep;
112 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
wdenk5cf91d62004-04-23 20:32:05 +0000172#if defined(CONFIG_USB_UHCI) || defined(CONFIG_USB_OHCI) || defined (CONFIG_USB_SL811HS)
wdenk012771d2002-03-08 21:31:05 +0000173int usb_lowlevel_init(void);
174int usb_lowlevel_stop(void);
175int submit_bulk_msg(struct usb_device *dev, unsigned long pipe, void *buffer,int transfer_len);
176int submit_control_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
177 int transfer_len,struct devrequest *setup);
178int submit_int_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
179 int transfer_len, int interval);
180
181/* Defines */
182#define USB_UHCI_VEND_ID 0x8086
wdenk5cf91d62004-04-23 20:32:05 +0000183#define USB_UHCI_DEV_ID 0x7112
wdenk012771d2002-03-08 21:31:05 +0000184
185#else
186#error USB Lowlevel not defined
187#endif
188
189#ifdef CONFIG_USB_STORAGE
190
191#define USB_MAX_STOR_DEV 5
192block_dev_desc_t *usb_stor_get_dev(int index);
193int usb_stor_scan(int mode);
194
195#endif
196
197#ifdef CONFIG_USB_KEYBOARD
198
199int drv_usb_kbd_init(void);
200int usb_kbd_deregister(void);
201
202#endif
203/* routines */
204int usb_init(void); /* initialize the USB Controller */
205int usb_stop(void); /* stop the USB Controller */
206
207
208int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol);
209int usb_set_idle(struct usb_device *dev, int ifnum, int duration, int report_id);
210struct usb_device * usb_get_dev_index(int index);
211int usb_control_msg(struct usb_device *dev, unsigned int pipe,
212 unsigned char request, unsigned char requesttype,
213 unsigned short value, unsigned short index,
214 void *data, unsigned short size, int timeout);
215int usb_bulk_msg(struct usb_device *dev, unsigned int pipe,
216 void *data, int len, int *actual_length, int timeout);
217int usb_submit_int_msg(struct usb_device *dev, unsigned long pipe,
218 void *buffer,int transfer_len, int interval);
219void usb_disable_asynch(int disable);
220int usb_maxpacket(struct usb_device *dev,unsigned long pipe);
221void __inline__ wait_ms(unsigned long ms);
222int usb_get_configuration_no(struct usb_device *dev,unsigned char *buffer,int cfgno);
223int usb_get_report(struct usb_device *dev, int ifnum, unsigned char type, unsigned char id, void *buf, int size);
224int usb_get_class_descriptor(struct usb_device *dev, int ifnum,
225 unsigned char type, unsigned char id, void *buf, int size);
226int usb_clear_halt(struct usb_device *dev, int pipe);
227int usb_string(struct usb_device *dev, int index, char *buf, size_t size);
228int usb_set_interface(struct usb_device *dev, int interface, int alternate);
229
230/* big endian -> little endian conversion */
wdenk149dded2003-09-10 18:20:28 +0000231/* some CPUs are already little endian e.g. the ARM920T */
232#ifdef LITTLEENDIAN
233#define swap_16(x) ((unsigned short)(x))
234#define swap_32(x) ((unsigned long)(x))
235#else
wdenk012771d2002-03-08 21:31:05 +0000236#define swap_16(x) \
wdenk3f85ce22004-02-23 16:11:30 +0000237 ({ unsigned short x_ = (unsigned short)x; \
238 (unsigned short)( \
239 ((x_ & 0x00FFU) << 8) | ((x_ & 0xFF00U) >> 8) ); \
240 })
wdenk012771d2002-03-08 21:31:05 +0000241#define swap_32(x) \
wdenk3f85ce22004-02-23 16:11:30 +0000242 ({ unsigned long x_ = (unsigned long)x; \
243 (unsigned long)( \
244 ((x_ & 0x000000FFUL) << 24) | \
wdenk5cf91d62004-04-23 20:32:05 +0000245 ((x_ & 0x0000FF00UL) << 8) | \
246 ((x_ & 0x00FF0000UL) >> 8) | \
wdenk3f85ce22004-02-23 16:11:30 +0000247 ((x_ & 0xFF000000UL) >> 24) ); \
248 })
wdenk149dded2003-09-10 18:20:28 +0000249#endif /* LITTLEENDIAN */
wdenk012771d2002-03-08 21:31:05 +0000250
251/*
252 * Calling this entity a "pipe" is glorifying it. A USB pipe
253 * is something embarrassingly simple: it basically consists
254 * of the following information:
255 * - device number (7 bits)
256 * - endpoint number (4 bits)
257 * - current Data0/1 state (1 bit)
258 * - direction (1 bit)
259 * - speed (1 bit)
260 * - max packet size (2 bits: 8, 16, 32 or 64)
261 * - pipe type (2 bits: control, interrupt, bulk, isochronous)
262 *
263 * That's 18 bits. Really. Nothing more. And the USB people have
264 * documented these eighteen bits as some kind of glorious
265 * virtual data structure.
266 *
267 * Let's not fall in that trap. We'll just encode it as a simple
268 * unsigned int. The encoding is:
269 *
270 * - max size: bits 0-1 (00 = 8, 01 = 16, 10 = 32, 11 = 64)
271 * - direction: bit 7 (0 = Host-to-Device [Out], 1 = Device-to-Host [In])
272 * - device: bits 8-14
273 * - endpoint: bits 15-18
274 * - Data0/1: bit 19
275 * - speed: bit 26 (0 = Full, 1 = Low Speed)
276 * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt, 10 = control, 11 = bulk)
277 *
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
281 * appropriately.
282 */
283/* Create various pipes... */
284#define create_pipe(dev,endpoint) \
285 (((dev)->devnum << 8) | (endpoint << 15) | ((dev)->slow << 26) | (dev)->maxpacketsize)
286#define default_pipe(dev) ((dev)->slow <<26)
287
288#define usb_sndctrlpipe(dev,endpoint) ((PIPE_CONTROL << 30) | create_pipe(dev,endpoint))
289#define usb_rcvctrlpipe(dev,endpoint) ((PIPE_CONTROL << 30) | create_pipe(dev,endpoint) | USB_DIR_IN)
290#define usb_sndisocpipe(dev,endpoint) ((PIPE_ISOCHRONOUS << 30) | create_pipe(dev,endpoint))
291#define usb_rcvisocpipe(dev,endpoint) ((PIPE_ISOCHRONOUS << 30) | create_pipe(dev,endpoint) | USB_DIR_IN)
292#define usb_sndbulkpipe(dev,endpoint) ((PIPE_BULK << 30) | create_pipe(dev,endpoint))
293#define usb_rcvbulkpipe(dev,endpoint) ((PIPE_BULK << 30) | create_pipe(dev,endpoint) | USB_DIR_IN)
294#define usb_sndintpipe(dev,endpoint) ((PIPE_INTERRUPT << 30) | create_pipe(dev,endpoint))
295#define usb_rcvintpipe(dev,endpoint) ((PIPE_INTERRUPT << 30) | create_pipe(dev,endpoint) | USB_DIR_IN)
296#define usb_snddefctrl(dev) ((PIPE_CONTROL << 30) | default_pipe(dev))
297#define usb_rcvdefctrl(dev) ((PIPE_CONTROL << 30) | default_pipe(dev) | USB_DIR_IN)
298
299/* The D0/D1 toggle bits */
300#define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> ep) & 1)
wdenk5cf91d62004-04-23 20:32:05 +0000301#define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << ep))
wdenk012771d2002-03-08 21:31:05 +0000302#define usb_settoggle(dev, ep, out, bit) ((dev)->toggle[out] = ((dev)->toggle[out] & ~(1 << ep)) | ((bit) << ep))
303
304/* Endpoint halt control/status */
305#define usb_endpoint_out(ep_dir) (((ep_dir >> 7) & 1) ^ 1)
306#define usb_endpoint_halt(dev, ep, out) ((dev)->halted[out] |= (1 << (ep)))
307#define usb_endpoint_running(dev, ep, out) ((dev)->halted[out] &= ~(1 << (ep)))
308#define usb_endpoint_halted(dev, ep, out) ((dev)->halted[out] & (1 << (ep)))
309
310#define usb_packetid(pipe) (((pipe) & USB_DIR_IN) ? USB_PID_IN : USB_PID_OUT)
311
312#define usb_pipeout(pipe) ((((pipe) >> 7) & 1) ^ 1)
313#define usb_pipein(pipe) (((pipe) >> 7) & 1)
314#define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f)
315#define usb_pipe_endpdev(pipe) (((pipe) >> 8) & 0x7ff)
316#define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf)
317#define usb_pipedata(pipe) (((pipe) >> 19) & 1)
318#define usb_pipeslow(pipe) (((pipe) >> 26) & 1)
319#define usb_pipetype(pipe) (((pipe) >> 30) & 3)
320#define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
321#define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT)
322#define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL)
323#define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK)
324
325
326/*************************************************************************
327 * Hub Stuff
328 */
329struct usb_port_status {
330 unsigned short wPortStatus;
331 unsigned short wPortChange;
332} __attribute__ ((packed));
333
334struct usb_hub_status {
335 unsigned short wHubStatus;
336 unsigned short wHubChange;
337} __attribute__ ((packed));
338
339
340/* Hub descriptor */
341struct usb_hub_descriptor {
342 unsigned char bLength;
343 unsigned char bDescriptorType;
344 unsigned char bNbrPorts;
345 unsigned short wHubCharacteristics;
346 unsigned char bPwrOn2PwrGood;
347 unsigned char bHubContrCurrent;
348 unsigned char DeviceRemovable[(USB_MAXCHILDREN+1+7)/8];
349 unsigned char PortPowerCtrlMask[(USB_MAXCHILDREN+1+7)/8];
350 /* DeviceRemovable and PortPwrCtrlMask want to be variable-length
351 bitmaps that hold max 255 entries. (bit0 is ignored) */
352} __attribute__ ((packed));
353
354
355struct usb_hub_device {
356 struct usb_device *pusb_dev;
357 struct usb_hub_descriptor desc;
358};
359
360#endif /*_USB_H_ */