blob: 510df95d628e887fc49eaf3b9c58367f254e43e0 [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 {
Michael Trimarchide39f8c2008-11-26 17:41:34 +010046 unsigned char bLength;
47 unsigned char bDescriptorType;
48 unsigned short wData[1];
wdenk012771d2002-03-08 21:31:05 +000049} __attribute__ ((packed));
50
51/* device request (setup) */
52struct devrequest {
Michael Trimarchide39f8c2008-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 Trimarchide39f8c2008-11-26 17:41:34 +010062 unsigned char bLength;
63 unsigned char bDescriptorType;
wdenk012771d2002-03-08 21:31:05 +000064} __attribute__ ((packed));
65
66/* Device descriptor */
67struct usb_device_descriptor {
Michael Trimarchide39f8c2008-11-26 17:41:34 +010068 unsigned char bLength;
69 unsigned char bDescriptorType;
70 unsigned short bcdUSB;
71 unsigned char bDeviceClass;
72 unsigned char bDeviceSubClass;
73 unsigned char bDeviceProtocol;
74 unsigned char bMaxPacketSize0;
75 unsigned short idVendor;
76 unsigned short idProduct;
77 unsigned short bcdDevice;
78 unsigned char iManufacturer;
79 unsigned char iProduct;
80 unsigned char iSerialNumber;
81 unsigned char bNumConfigurations;
wdenk012771d2002-03-08 21:31:05 +000082} __attribute__ ((packed));
83
wdenk012771d2002-03-08 21:31:05 +000084/* Endpoint descriptor */
85struct usb_endpoint_descriptor {
Michael Trimarchide39f8c2008-11-26 17:41:34 +010086 unsigned char bLength;
87 unsigned char bDescriptorType;
88 unsigned char bEndpointAddress;
89 unsigned char bmAttributes;
90 unsigned short wMaxPacketSize;
91 unsigned char bInterval;
92 unsigned char bRefresh;
93 unsigned char bSynchAddress;
Stefan Althoeferd2776822008-12-07 19:39:11 +010094} __attribute__ ((packed)) __attribute__ ((aligned(2)));
Michael Trimarchide39f8c2008-11-26 17:41:34 +010095
wdenk012771d2002-03-08 21:31:05 +000096/* Interface descriptor */
97struct usb_interface_descriptor {
Michael Trimarchide39f8c2008-11-26 17:41:34 +010098 unsigned char bLength;
99 unsigned char bDescriptorType;
100 unsigned char bInterfaceNumber;
101 unsigned char bAlternateSetting;
102 unsigned char bNumEndpoints;
103 unsigned char bInterfaceClass;
104 unsigned char bInterfaceSubClass;
105 unsigned char bInterfaceProtocol;
106 unsigned char iInterface;
wdenk012771d2002-03-08 21:31:05 +0000107
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100108 unsigned char no_of_ep;
109 unsigned char num_altsetting;
110 unsigned char act_altsetting;
111
wdenk012771d2002-03-08 21:31:05 +0000112 struct usb_endpoint_descriptor ep_desc[USB_MAXENDPOINTS];
113} __attribute__ ((packed));
114
115
116/* Configuration descriptor information.. */
117struct usb_config_descriptor {
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100118 unsigned char bLength;
119 unsigned char bDescriptorType;
120 unsigned short wTotalLength;
121 unsigned char bNumInterfaces;
122 unsigned char bConfigurationValue;
123 unsigned char iConfiguration;
124 unsigned char bmAttributes;
125 unsigned char MaxPower;
wdenk012771d2002-03-08 21:31:05 +0000126
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100127 unsigned char no_of_if; /* number of interfaces */
wdenk012771d2002-03-08 21:31:05 +0000128 struct usb_interface_descriptor if_desc[USB_MAXINTERFACES];
129} __attribute__ ((packed));
130
Remy Bohmer48867202008-10-10 10:23:21 +0200131enum {
132 /* Maximum packet size; encoded as 0,1,2,3 = 8,16,32,64 */
133 PACKET_SIZE_8 = 0,
134 PACKET_SIZE_16 = 1,
135 PACKET_SIZE_32 = 2,
136 PACKET_SIZE_64 = 3,
137};
wdenk012771d2002-03-08 21:31:05 +0000138
139struct usb_device {
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100140 int devnum; /* Device number on USB bus */
141 int slow; /* Slow device? */
142 char mf[32]; /* manufacturer */
143 char prod[32]; /* product */
144 char serial[32]; /* serial number */
wdenk012771d2002-03-08 21:31:05 +0000145
Remy Bohmer48867202008-10-10 10:23:21 +0200146 /* Maximum packet size; one of: PACKET_SIZE_* */
147 int maxpacketsize;
148 /* one bit for each endpoint ([0] = IN, [1] = OUT) */
149 unsigned int toggle[2];
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100150 /* endpoint halts; one bit per endpoint # & direction;
151 * [0] = IN, [1] = OUT
152 */
Remy Bohmer48867202008-10-10 10:23:21 +0200153 unsigned int halted[2];
wdenk012771d2002-03-08 21:31:05 +0000154 int epmaxpacketin[16]; /* INput endpoint specific maximums */
155 int epmaxpacketout[16]; /* OUTput endpoint specific maximums */
156
157 int configno; /* selected config number */
158 struct usb_device_descriptor descriptor; /* Device Descriptor */
159 struct usb_config_descriptor config; /* config descriptor */
160
161 int have_langid; /* whether string_langid is valid yet */
162 int string_langid; /* language ID for strings */
163 int (*irq_handle)(struct usb_device *dev);
164 unsigned long irq_status;
wdenk5cf91d62004-04-23 20:32:05 +0000165 int irq_act_len; /* transfered bytes */
wdenk012771d2002-03-08 21:31:05 +0000166 void *privptr;
167 /*
168 * Child devices - if this is a hub device
169 * Each instance needs its own set of data structures.
170 */
171 unsigned long status;
172 int act_len; /* transfered bytes */
173 int maxchild; /* Number of ports if hub */
174 struct usb_device *parent;
175 struct usb_device *children[USB_MAXCHILDREN];
176};
177
178/**********************************************************************
179 * this is how the lowlevel part communicate with the outer world
180 */
181
Rodolfo Giometti822af352007-04-03 14:27:18 +0200182#if defined(CONFIG_USB_UHCI) || defined(CONFIG_USB_OHCI) || \
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100183 defined(CONFIG_USB_OHCI_NEW) || defined(CONFIG_USB_SL811HS) || \
Yoshihiro Shimodafd0f2f32008-07-09 21:07:38 +0900184 defined(CONFIG_USB_ISP116X_HCD) || defined(CONFIG_USB_R8A66597_HCD)
Rodolfo Giometti822af352007-04-03 14:27:18 +0200185
wdenk012771d2002-03-08 21:31:05 +0000186int usb_lowlevel_init(void);
187int usb_lowlevel_stop(void);
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100188int submit_bulk_msg(struct usb_device *dev, unsigned long pipe,
189 void *buffer, int transfer_len);
wdenk012771d2002-03-08 21:31:05 +0000190int submit_control_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100191 int transfer_len, struct devrequest *setup);
wdenk012771d2002-03-08 21:31:05 +0000192int submit_int_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
193 int transfer_len, int interval);
Zhang Weifdcfaa12007-06-06 10:08:13 +0200194void usb_event_poll(void);
wdenk012771d2002-03-08 21:31:05 +0000195
196/* Defines */
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100197#define USB_UHCI_VEND_ID 0x8086
198#define USB_UHCI_DEV_ID 0x7112
wdenk012771d2002-03-08 21:31:05 +0000199
200#else
201#error USB Lowlevel not defined
202#endif
203
204#ifdef CONFIG_USB_STORAGE
205
206#define USB_MAX_STOR_DEV 5
207block_dev_desc_t *usb_stor_get_dev(int index);
208int usb_stor_scan(int mode);
Anatolij Gustschine813eae2008-03-26 17:47:44 +0100209int usb_stor_info(void);
wdenk012771d2002-03-08 21:31:05 +0000210
211#endif
212
213#ifdef CONFIG_USB_KEYBOARD
214
215int drv_usb_kbd_init(void);
216int usb_kbd_deregister(void);
217
218#endif
219/* routines */
220int usb_init(void); /* initialize the USB Controller */
221int usb_stop(void); /* stop the USB Controller */
222
223
224int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol);
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100225int usb_set_idle(struct usb_device *dev, int ifnum, int duration,
226 int report_id);
227struct usb_device *usb_get_dev_index(int index);
wdenk012771d2002-03-08 21:31:05 +0000228int usb_control_msg(struct usb_device *dev, unsigned int pipe,
229 unsigned char request, unsigned char requesttype,
230 unsigned short value, unsigned short index,
231 void *data, unsigned short size, int timeout);
232int usb_bulk_msg(struct usb_device *dev, unsigned int pipe,
233 void *data, int len, int *actual_length, int timeout);
234int usb_submit_int_msg(struct usb_device *dev, unsigned long pipe,
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100235 void *buffer, int transfer_len, int interval);
wdenk012771d2002-03-08 21:31:05 +0000236void usb_disable_asynch(int disable);
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100237int usb_maxpacket(struct usb_device *dev, unsigned long pipe);
238inline void wait_ms(unsigned long ms);
239int usb_get_configuration_no(struct usb_device *dev, unsigned char *buffer,
240 int cfgno);
241int usb_get_report(struct usb_device *dev, int ifnum, unsigned char type,
242 unsigned char id, void *buf, int size);
wdenk012771d2002-03-08 21:31:05 +0000243int usb_get_class_descriptor(struct usb_device *dev, int ifnum,
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100244 unsigned char type, unsigned char id, void *buf,
245 int size);
wdenk012771d2002-03-08 21:31:05 +0000246int usb_clear_halt(struct usb_device *dev, int pipe);
247int usb_string(struct usb_device *dev, int index, char *buf, size_t size);
248int usb_set_interface(struct usb_device *dev, int interface, int alternate);
249
250/* big endian -> little endian conversion */
wdenk149dded2003-09-10 18:20:28 +0000251/* some CPUs are already little endian e.g. the ARM920T */
Markus Klotzbuecherae3b7702006-11-27 11:46:46 +0100252#define __swap_16(x) \
wdenk3f85ce22004-02-23 16:11:30 +0000253 ({ unsigned short x_ = (unsigned short)x; \
254 (unsigned short)( \
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100255 ((x_ & 0x00FFU) << 8) | ((x_ & 0xFF00U) >> 8)); \
wdenk3f85ce22004-02-23 16:11:30 +0000256 })
Markus Klotzbuecherae3b7702006-11-27 11:46:46 +0100257#define __swap_32(x) \
wdenk3f85ce22004-02-23 16:11:30 +0000258 ({ unsigned long x_ = (unsigned long)x; \
259 (unsigned long)( \
260 ((x_ & 0x000000FFUL) << 24) | \
wdenk5cf91d62004-04-23 20:32:05 +0000261 ((x_ & 0x0000FF00UL) << 8) | \
262 ((x_ & 0x00FF0000UL) >> 8) | \
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100263 ((x_ & 0xFF000000UL) >> 24)); \
wdenk3f85ce22004-02-23 16:11:30 +0000264 })
Markus Klotzbuecherae3b7702006-11-27 11:46:46 +0100265
266#ifdef LITTLEENDIAN
267# define swap_16(x) (x)
268# define swap_32(x) (x)
269#else
270# define swap_16(x) __swap_16(x)
271# define swap_32(x) __swap_32(x)
wdenk149dded2003-09-10 18:20:28 +0000272#endif /* LITTLEENDIAN */
wdenk012771d2002-03-08 21:31:05 +0000273
274/*
275 * Calling this entity a "pipe" is glorifying it. A USB pipe
276 * is something embarrassingly simple: it basically consists
277 * of the following information:
278 * - device number (7 bits)
279 * - endpoint number (4 bits)
280 * - current Data0/1 state (1 bit)
281 * - direction (1 bit)
282 * - speed (1 bit)
283 * - max packet size (2 bits: 8, 16, 32 or 64)
284 * - pipe type (2 bits: control, interrupt, bulk, isochronous)
285 *
286 * That's 18 bits. Really. Nothing more. And the USB people have
287 * documented these eighteen bits as some kind of glorious
288 * virtual data structure.
289 *
290 * Let's not fall in that trap. We'll just encode it as a simple
291 * unsigned int. The encoding is:
292 *
293 * - max size: bits 0-1 (00 = 8, 01 = 16, 10 = 32, 11 = 64)
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100294 * - direction: bit 7 (0 = Host-to-Device [Out],
295 * (1 = Device-to-Host [In])
wdenk012771d2002-03-08 21:31:05 +0000296 * - device: bits 8-14
297 * - endpoint: bits 15-18
298 * - Data0/1: bit 19
299 * - speed: bit 26 (0 = Full, 1 = Low Speed)
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100300 * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt,
301 * 10 = control, 11 = bulk)
wdenk012771d2002-03-08 21:31:05 +0000302 *
303 * Why? Because it's arbitrary, and whatever encoding we select is really
304 * up to us. This one happens to share a lot of bit positions with the UHCI
305 * specification, so that much of the uhci driver can just mask the bits
306 * appropriately.
307 */
308/* Create various pipes... */
309#define create_pipe(dev,endpoint) \
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100310 (((dev)->devnum << 8) | (endpoint << 15) | \
311 ((dev)->slow << 26) | (dev)->maxpacketsize)
312#define default_pipe(dev) ((dev)->slow << 26)
wdenk012771d2002-03-08 21:31:05 +0000313
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100314#define usb_sndctrlpipe(dev, endpoint) ((PIPE_CONTROL << 30) | \
315 create_pipe(dev, endpoint))
316#define usb_rcvctrlpipe(dev, endpoint) ((PIPE_CONTROL << 30) | \
317 create_pipe(dev, endpoint) | \
318 USB_DIR_IN)
319#define usb_sndisocpipe(dev, endpoint) ((PIPE_ISOCHRONOUS << 30) | \
320 create_pipe(dev, endpoint))
321#define usb_rcvisocpipe(dev, endpoint) ((PIPE_ISOCHRONOUS << 30) | \
322 create_pipe(dev, endpoint) | \
323 USB_DIR_IN)
324#define usb_sndbulkpipe(dev, endpoint) ((PIPE_BULK << 30) | \
325 create_pipe(dev, endpoint))
326#define usb_rcvbulkpipe(dev, endpoint) ((PIPE_BULK << 30) | \
327 create_pipe(dev, endpoint) | \
328 USB_DIR_IN)
329#define usb_sndintpipe(dev, endpoint) ((PIPE_INTERRUPT << 30) | \
330 create_pipe(dev, endpoint))
331#define usb_rcvintpipe(dev, endpoint) ((PIPE_INTERRUPT << 30) | \
332 create_pipe(dev, endpoint) | \
333 USB_DIR_IN)
334#define usb_snddefctrl(dev) ((PIPE_CONTROL << 30) | \
335 default_pipe(dev))
336#define usb_rcvdefctrl(dev) ((PIPE_CONTROL << 30) | \
337 default_pipe(dev) | \
338 USB_DIR_IN)
wdenk012771d2002-03-08 21:31:05 +0000339
340/* The D0/D1 toggle bits */
341#define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> ep) & 1)
wdenk5cf91d62004-04-23 20:32:05 +0000342#define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << ep))
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100343#define usb_settoggle(dev, ep, out, bit) ((dev)->toggle[out] = \
344 ((dev)->toggle[out] & \
345 ~(1 << ep)) | ((bit) << ep))
wdenk012771d2002-03-08 21:31:05 +0000346
347/* Endpoint halt control/status */
348#define usb_endpoint_out(ep_dir) (((ep_dir >> 7) & 1) ^ 1)
349#define usb_endpoint_halt(dev, ep, out) ((dev)->halted[out] |= (1 << (ep)))
350#define usb_endpoint_running(dev, ep, out) ((dev)->halted[out] &= ~(1 << (ep)))
351#define usb_endpoint_halted(dev, ep, out) ((dev)->halted[out] & (1 << (ep)))
352
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100353#define usb_packetid(pipe) (((pipe) & USB_DIR_IN) ? USB_PID_IN : \
354 USB_PID_OUT)
wdenk012771d2002-03-08 21:31:05 +0000355
356#define usb_pipeout(pipe) ((((pipe) >> 7) & 1) ^ 1)
357#define usb_pipein(pipe) (((pipe) >> 7) & 1)
358#define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f)
359#define usb_pipe_endpdev(pipe) (((pipe) >> 8) & 0x7ff)
360#define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf)
361#define usb_pipedata(pipe) (((pipe) >> 19) & 1)
362#define usb_pipeslow(pipe) (((pipe) >> 26) & 1)
363#define usb_pipetype(pipe) (((pipe) >> 30) & 3)
364#define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
365#define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT)
366#define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL)
367#define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK)
368
369
370/*************************************************************************
371 * Hub Stuff
372 */
373struct usb_port_status {
374 unsigned short wPortStatus;
375 unsigned short wPortChange;
376} __attribute__ ((packed));
377
378struct usb_hub_status {
379 unsigned short wHubStatus;
380 unsigned short wHubChange;
381} __attribute__ ((packed));
382
383
384/* Hub descriptor */
385struct usb_hub_descriptor {
386 unsigned char bLength;
387 unsigned char bDescriptorType;
388 unsigned char bNbrPorts;
389 unsigned short wHubCharacteristics;
390 unsigned char bPwrOn2PwrGood;
391 unsigned char bHubContrCurrent;
392 unsigned char DeviceRemovable[(USB_MAXCHILDREN+1+7)/8];
393 unsigned char PortPowerCtrlMask[(USB_MAXCHILDREN+1+7)/8];
Michael Trimarchide39f8c2008-11-26 17:41:34 +0100394 /* DeviceRemovable and PortPwrCtrlMask want to be variable-length
wdenk012771d2002-03-08 21:31:05 +0000395 bitmaps that hold max 255 entries. (bit0 is ignored) */
396} __attribute__ ((packed));
397
398
399struct usb_hub_device {
400 struct usb_device *pusb_dev;
401 struct usb_hub_descriptor desc;
402};
403
404#endif /*_USB_H_ */