Merge branch 'master' of /home/wd/git/u-boot/custodians
[platform/kernel/u-boot.git] / include / usb.h
1 /*
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
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * 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 */
32 #define USB_ALTSETTINGALLOC             4
33 #define USB_MAXALTSETTING               128     /* Hard limit */
34
35 #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
41
42 #define USB_CNTL_TIMEOUT 100 /* 100ms timeout */
43
44 /* String descriptor */
45 struct usb_string_descriptor {
46         unsigned char   bLength;
47         unsigned char   bDescriptorType;
48         unsigned short  wData[1];
49 } __attribute__ ((packed));
50
51 /* device request (setup) */
52 struct 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 /* All standard descriptors have these 2 fields in common */
61 struct usb_descriptor_header {
62         unsigned char   bLength;
63         unsigned char   bDescriptorType;
64 } __attribute__ ((packed));
65
66 /* Device descriptor */
67 struct usb_device_descriptor {
68         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;
82 } __attribute__ ((packed));
83
84 /* Endpoint descriptor */
85 struct usb_endpoint_descriptor {
86         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;
94 } __attribute__ ((packed)) __attribute__ ((aligned(2)));
95
96 /* Interface descriptor */
97 struct usb_interface_descriptor {
98         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;
107
108         unsigned char   no_of_ep;
109         unsigned char   num_altsetting;
110         unsigned char   act_altsetting;
111
112         struct usb_endpoint_descriptor ep_desc[USB_MAXENDPOINTS];
113 } __attribute__ ((packed));
114
115
116 /* Configuration descriptor information.. */
117 struct usb_config_descriptor {
118         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;
126
127         unsigned char   no_of_if;       /* number of interfaces */
128         struct usb_interface_descriptor if_desc[USB_MAXINTERFACES];
129 } __attribute__ ((packed));
130
131 enum {
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 };
138
139 struct usb_device {
140         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 */
145
146         /* 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];
150         /* endpoint halts; one bit per endpoint # & direction;
151          * [0] = IN, [1] = OUT
152          */
153         unsigned int halted[2];
154         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;
165         int irq_act_len;                /* transfered bytes */
166         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
182 #if defined(CONFIG_USB_UHCI) || defined(CONFIG_USB_OHCI) || \
183         defined(CONFIG_USB_OHCI_NEW) || defined(CONFIG_USB_SL811HS) || \
184         defined(CONFIG_USB_ISP116X_HCD) || defined(CONFIG_USB_R8A66597_HCD)
185
186 int usb_lowlevel_init(void);
187 int usb_lowlevel_stop(void);
188 int submit_bulk_msg(struct usb_device *dev, unsigned long pipe,
189                         void *buffer, int transfer_len);
190 int submit_control_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
191                         int transfer_len, struct devrequest *setup);
192 int submit_int_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
193                         int transfer_len, int interval);
194 void usb_event_poll(void);
195
196 /* Defines */
197 #define USB_UHCI_VEND_ID        0x8086
198 #define USB_UHCI_DEV_ID         0x7112
199
200 #else
201 #error USB Lowlevel not defined
202 #endif
203
204 #ifdef CONFIG_USB_STORAGE
205
206 #define USB_MAX_STOR_DEV 5
207 block_dev_desc_t *usb_stor_get_dev(int index);
208 int usb_stor_scan(int mode);
209 int usb_stor_info(void);
210
211 #endif
212
213 #ifdef CONFIG_USB_KEYBOARD
214
215 int drv_usb_kbd_init(void);
216 int usb_kbd_deregister(void);
217
218 #endif
219 /* routines */
220 int usb_init(void); /* initialize the USB Controller */
221 int usb_stop(void); /* stop the USB Controller */
222
223
224 int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol);
225 int usb_set_idle(struct usb_device *dev, int ifnum, int duration,
226                         int report_id);
227 struct usb_device *usb_get_dev_index(int index);
228 int 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);
232 int usb_bulk_msg(struct usb_device *dev, unsigned int pipe,
233                         void *data, int len, int *actual_length, int timeout);
234 int usb_submit_int_msg(struct usb_device *dev, unsigned long pipe,
235                         void *buffer, int transfer_len, int interval);
236 void usb_disable_asynch(int disable);
237 int usb_maxpacket(struct usb_device *dev, unsigned long pipe);
238 inline void wait_ms(unsigned long ms);
239 int usb_get_configuration_no(struct usb_device *dev, unsigned char *buffer,
240                                 int cfgno);
241 int usb_get_report(struct usb_device *dev, int ifnum, unsigned char type,
242                         unsigned char id, void *buf, int size);
243 int usb_get_class_descriptor(struct usb_device *dev, int ifnum,
244                         unsigned char type, unsigned char id, void *buf,
245                         int size);
246 int usb_clear_halt(struct usb_device *dev, int pipe);
247 int usb_string(struct usb_device *dev, int index, char *buf, size_t size);
248 int usb_set_interface(struct usb_device *dev, int interface, int alternate);
249
250 /* big endian -> little endian conversion */
251 /* some CPUs are already little endian e.g. the ARM920T */
252 #define __swap_16(x) \
253         ({ unsigned short x_ = (unsigned short)x; \
254          (unsigned short)( \
255                 ((x_ & 0x00FFU) << 8) | ((x_ & 0xFF00U) >> 8)); \
256         })
257 #define __swap_32(x) \
258         ({ unsigned long x_ = (unsigned long)x; \
259          (unsigned long)( \
260                 ((x_ & 0x000000FFUL) << 24) | \
261                 ((x_ & 0x0000FF00UL) <<  8) | \
262                 ((x_ & 0x00FF0000UL) >>  8) | \
263                 ((x_ & 0xFF000000UL) >> 24)); \
264         })
265
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)
272 #endif /* LITTLEENDIAN */
273
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)
294  *  - direction:        bit 7           (0 = Host-to-Device [Out],
295  *                                      (1 = Device-to-Host [In])
296  *  - device:           bits 8-14
297  *  - endpoint:         bits 15-18
298  *  - Data0/1:          bit 19
299  *  - speed:            bit 26          (0 = Full, 1 = Low Speed)
300  *  - pipe type:        bits 30-31      (00 = isochronous, 01 = interrupt,
301  *                                       10 = control, 11 = bulk)
302  *
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) \
310                 (((dev)->devnum << 8) | (endpoint << 15) | \
311                 ((dev)->slow << 26) | (dev)->maxpacketsize)
312 #define default_pipe(dev) ((dev)->slow << 26)
313
314 #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)
339
340 /* The D0/D1 toggle bits */
341 #define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> ep) & 1)
342 #define usb_dotoggle(dev, ep, out)  ((dev)->toggle[out] ^= (1 << ep))
343 #define usb_settoggle(dev, ep, out, bit) ((dev)->toggle[out] = \
344                                                 ((dev)->toggle[out] & \
345                                                  ~(1 << ep)) | ((bit) << ep))
346
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
353 #define usb_packetid(pipe)      (((pipe) & USB_DIR_IN) ? USB_PID_IN : \
354                                  USB_PID_OUT)
355
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  */
373 struct usb_port_status {
374         unsigned short wPortStatus;
375         unsigned short wPortChange;
376 } __attribute__ ((packed));
377
378 struct usb_hub_status {
379         unsigned short wHubStatus;
380         unsigned short wHubChange;
381 } __attribute__ ((packed));
382
383
384 /* Hub descriptor */
385 struct 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];
394         /* DeviceRemovable and PortPwrCtrlMask want to be variable-length
395            bitmaps that hold max 255 entries. (bit0 is ignored) */
396 } __attribute__ ((packed));
397
398
399 struct usb_hub_device {
400         struct usb_device *pusb_dev;
401         struct usb_hub_descriptor desc;
402 };
403
404 #endif /*_USB_H_ */