]>
Commit | Line | Data |
---|---|---|
012771d8 WD |
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 | |
5cf91d6b | 15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
012771d8 WD |
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> | |
8f8bd565 | 30 | #include <usbdescriptors.h> |
012771d8 | 31 | |
71c5de4f TR |
32 | /* |
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 | ||
012771d8 | 42 | /* Everything is aribtrary */ |
5cf91d6b WD |
43 | #define USB_ALTSETTINGALLOC 4 |
44 | #define USB_MAXALTSETTING 128 /* Hard limit */ | |
012771d8 | 45 | |
5cf91d6b WD |
46 | #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 | |
012771d8 WD |
52 | |
53 | #define USB_CNTL_TIMEOUT 100 /* 100ms timeout */ | |
54 | ||
96820a35 SG |
55 | /* |
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 | */ | |
80b350a7 | 59 | #define USB_TIMEOUT_MS(pipe) (usb_pipebulk(pipe) ? 5000 : 1000) |
96820a35 | 60 | |
012771d8 WD |
61 | /* device request (setup) */ |
62 | struct devrequest { | |
de39f8c1 MT |
63 | unsigned char requesttype; |
64 | unsigned char request; | |
65 | unsigned short value; | |
66 | unsigned short index; | |
67 | unsigned short length; | |
012771d8 WD |
68 | } __attribute__ ((packed)); |
69 | ||
012771d8 WD |
70 | /* All standard descriptors have these 2 fields in common */ |
71 | struct usb_descriptor_header { | |
de39f8c1 MT |
72 | unsigned char bLength; |
73 | unsigned char bDescriptorType; | |
012771d8 WD |
74 | } __attribute__ ((packed)); |
75 | ||
8f8bd565 TR |
76 | /* Interface */ |
77 | struct usb_interface { | |
78 | struct usb_interface_descriptor desc; | |
de39f8c1 MT |
79 | |
80 | unsigned char no_of_ep; | |
81 | unsigned char num_altsetting; | |
82 | unsigned char act_altsetting; | |
83 | ||
012771d8 WD |
84 | struct usb_endpoint_descriptor ep_desc[USB_MAXENDPOINTS]; |
85 | } __attribute__ ((packed)); | |
86 | ||
8f8bd565 TR |
87 | /* Configuration information.. */ |
88 | struct usb_config { | |
89 | struct usb_configuration_descriptor desc; | |
de39f8c1 MT |
90 | |
91 | unsigned char no_of_if; /* number of interfaces */ | |
8f8bd565 | 92 | struct usb_interface if_desc[USB_MAXINTERFACES]; |
012771d8 WD |
93 | } __attribute__ ((packed)); |
94 | ||
48867208 RB |
95 | enum { |
96 | /* Maximum packet size; encoded as 0,1,2,3 = 8,16,32,64 */ | |
97 | PACKET_SIZE_8 = 0, | |
98 | PACKET_SIZE_16 = 1, | |
99 | PACKET_SIZE_32 = 2, | |
100 | PACKET_SIZE_64 = 3, | |
101 | }; | |
012771d8 WD |
102 | |
103 | struct usb_device { | |
de39f8c1 | 104 | int devnum; /* Device number on USB bus */ |
3e126484 | 105 | int speed; /* full/low/high */ |
de39f8c1 MT |
106 | char mf[32]; /* manufacturer */ |
107 | char prod[32]; /* product */ | |
108 | char serial[32]; /* serial number */ | |
012771d8 | 109 | |
48867208 RB |
110 | /* Maximum packet size; one of: PACKET_SIZE_* */ |
111 | int maxpacketsize; | |
112 | /* one bit for each endpoint ([0] = IN, [1] = OUT) */ | |
113 | unsigned int toggle[2]; | |
de39f8c1 MT |
114 | /* endpoint halts; one bit per endpoint # & direction; |
115 | * [0] = IN, [1] = OUT | |
116 | */ | |
48867208 | 117 | unsigned int halted[2]; |
012771d8 WD |
118 | int epmaxpacketin[16]; /* INput endpoint specific maximums */ |
119 | int epmaxpacketout[16]; /* OUTput endpoint specific maximums */ | |
120 | ||
121 | int configno; /* selected config number */ | |
f5766139 PS |
122 | /* Device Descriptor */ |
123 | struct usb_device_descriptor descriptor | |
124 | __attribute__((aligned(ARCH_DMA_MINALIGN))); | |
8f8bd565 | 125 | struct usb_config config; /* config descriptor */ |
012771d8 WD |
126 | |
127 | int have_langid; /* whether string_langid is valid yet */ | |
128 | int string_langid; /* language ID for strings */ | |
129 | int (*irq_handle)(struct usb_device *dev); | |
130 | unsigned long irq_status; | |
5cf91d6b | 131 | int irq_act_len; /* transfered bytes */ |
012771d8 WD |
132 | void *privptr; |
133 | /* | |
134 | * Child devices - if this is a hub device | |
135 | * Each instance needs its own set of data structures. | |
136 | */ | |
137 | unsigned long status; | |
138 | int act_len; /* transfered bytes */ | |
139 | int maxchild; /* Number of ports if hub */ | |
3e126484 | 140 | int portnr; |
012771d8 WD |
141 | struct usb_device *parent; |
142 | struct usb_device *children[USB_MAXCHILDREN]; | |
c7e3b2b5 LS |
143 | |
144 | void *controller; /* hardware controller private data */ | |
012771d8 WD |
145 | }; |
146 | ||
147 | /********************************************************************** | |
148 | * this is how the lowlevel part communicate with the outer world | |
149 | */ | |
150 | ||
822af351 | 151 | #if defined(CONFIG_USB_UHCI) || defined(CONFIG_USB_OHCI) || \ |
51ab142b | 152 | defined(CONFIG_USB_EHCI) || defined(CONFIG_USB_OHCI_NEW) || \ |
3e126484 | 153 | defined(CONFIG_USB_SL811HS) || defined(CONFIG_USB_ISP116X_HCD) || \ |
f298e4b6 | 154 | defined(CONFIG_USB_R8A66597_HCD) || defined(CONFIG_USB_DAVINCI) || \ |
e608f221 | 155 | defined(CONFIG_USB_OMAP3) || defined(CONFIG_USB_DA8XX) || \ |
dbea3242 | 156 | defined(CONFIG_USB_BLACKFIN) || defined(CONFIG_USB_AM35X) |
822af351 | 157 | |
c7e3b2b5 LS |
158 | int usb_lowlevel_init(int index, void **controller); |
159 | int usb_lowlevel_stop(int index); | |
160 | ||
de39f8c1 MT |
161 | int submit_bulk_msg(struct usb_device *dev, unsigned long pipe, |
162 | void *buffer, int transfer_len); | |
012771d8 | 163 | int submit_control_msg(struct usb_device *dev, unsigned long pipe, void *buffer, |
de39f8c1 | 164 | int transfer_len, struct devrequest *setup); |
012771d8 WD |
165 | int submit_int_msg(struct usb_device *dev, unsigned long pipe, void *buffer, |
166 | int transfer_len, int interval); | |
167 | ||
168 | /* Defines */ | |
de39f8c1 MT |
169 | #define USB_UHCI_VEND_ID 0x8086 |
170 | #define USB_UHCI_DEV_ID 0x7112 | |
012771d8 | 171 | |
e5f24753 LD |
172 | /* |
173 | * PXA25x can only act as USB device. There are drivers | |
174 | * which works with USB CDC gadgets implementations. | |
175 | * Some of them have common routines which can be used | |
176 | * in boards init functions e.g. udc_disconnect() used for | |
177 | * forced device disconnection from host. | |
178 | */ | |
179 | #elif defined(CONFIG_USB_GADGET_PXA2XX) | |
180 | ||
181 | extern void udc_disconnect(void); | |
182 | ||
012771d8 WD |
183 | #else |
184 | #error USB Lowlevel not defined | |
185 | #endif | |
186 | ||
187 | #ifdef CONFIG_USB_STORAGE | |
188 | ||
189 | #define USB_MAX_STOR_DEV 5 | |
190 | block_dev_desc_t *usb_stor_get_dev(int index); | |
191 | int usb_stor_scan(int mode); | |
e813eae3 | 192 | int usb_stor_info(void); |
012771d8 WD |
193 | |
194 | #endif | |
195 | ||
89d48367 SG |
196 | #ifdef CONFIG_USB_HOST_ETHER |
197 | ||
198 | #define USB_MAX_ETH_DEV 5 | |
199 | int usb_host_eth_scan(int mode); | |
200 | ||
201 | #endif | |
202 | ||
012771d8 WD |
203 | #ifdef CONFIG_USB_KEYBOARD |
204 | ||
205 | int drv_usb_kbd_init(void); | |
206 | int usb_kbd_deregister(void); | |
207 | ||
208 | #endif | |
209 | /* routines */ | |
210 | int usb_init(void); /* initialize the USB Controller */ | |
211 | int usb_stop(void); /* stop the USB Controller */ | |
212 | ||
213 | ||
214 | int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol); | |
de39f8c1 MT |
215 | int usb_set_idle(struct usb_device *dev, int ifnum, int duration, |
216 | int report_id); | |
217 | struct usb_device *usb_get_dev_index(int index); | |
012771d8 WD |
218 | int usb_control_msg(struct usb_device *dev, unsigned int pipe, |
219 | unsigned char request, unsigned char requesttype, | |
220 | unsigned short value, unsigned short index, | |
221 | void *data, unsigned short size, int timeout); | |
222 | int usb_bulk_msg(struct usb_device *dev, unsigned int pipe, | |
223 | void *data, int len, int *actual_length, int timeout); | |
224 | int usb_submit_int_msg(struct usb_device *dev, unsigned long pipe, | |
de39f8c1 | 225 | void *buffer, int transfer_len, int interval); |
89d48367 | 226 | int usb_disable_asynch(int disable); |
de39f8c1 | 227 | int usb_maxpacket(struct usb_device *dev, unsigned long pipe); |
de39f8c1 MT |
228 | int usb_get_configuration_no(struct usb_device *dev, unsigned char *buffer, |
229 | int cfgno); | |
230 | int usb_get_report(struct usb_device *dev, int ifnum, unsigned char type, | |
231 | unsigned char id, void *buf, int size); | |
012771d8 | 232 | int usb_get_class_descriptor(struct usb_device *dev, int ifnum, |
de39f8c1 MT |
233 | unsigned char type, unsigned char id, void *buf, |
234 | int size); | |
012771d8 WD |
235 | int usb_clear_halt(struct usb_device *dev, int pipe); |
236 | int usb_string(struct usb_device *dev, int index, char *buf, size_t size); | |
237 | int usb_set_interface(struct usb_device *dev, int interface, int alternate); | |
238 | ||
239 | /* big endian -> little endian conversion */ | |
149dded2 | 240 | /* some CPUs are already little endian e.g. the ARM920T */ |
ae3b770e | 241 | #define __swap_16(x) \ |
3f85ce27 WD |
242 | ({ unsigned short x_ = (unsigned short)x; \ |
243 | (unsigned short)( \ | |
de39f8c1 | 244 | ((x_ & 0x00FFU) << 8) | ((x_ & 0xFF00U) >> 8)); \ |
3f85ce27 | 245 | }) |
ae3b770e | 246 | #define __swap_32(x) \ |
3f85ce27 WD |
247 | ({ unsigned long x_ = (unsigned long)x; \ |
248 | (unsigned long)( \ | |
249 | ((x_ & 0x000000FFUL) << 24) | \ | |
5cf91d6b WD |
250 | ((x_ & 0x0000FF00UL) << 8) | \ |
251 | ((x_ & 0x00FF0000UL) >> 8) | \ | |
de39f8c1 | 252 | ((x_ & 0xFF000000UL) >> 24)); \ |
3f85ce27 | 253 | }) |
ae3b770e | 254 | |
c7d703f3 | 255 | #ifdef __LITTLE_ENDIAN |
ae3b770e MK |
256 | # define swap_16(x) (x) |
257 | # define swap_32(x) (x) | |
258 | #else | |
259 | # define swap_16(x) __swap_16(x) | |
260 | # define swap_32(x) __swap_32(x) | |
c7d703f3 | 261 | #endif |
012771d8 WD |
262 | |
263 | /* | |
264 | * Calling this entity a "pipe" is glorifying it. A USB pipe | |
265 | * is something embarrassingly simple: it basically consists | |
266 | * of the following information: | |
267 | * - device number (7 bits) | |
268 | * - endpoint number (4 bits) | |
269 | * - current Data0/1 state (1 bit) | |
270 | * - direction (1 bit) | |
3e126484 | 271 | * - speed (2 bits) |
012771d8 WD |
272 | * - max packet size (2 bits: 8, 16, 32 or 64) |
273 | * - pipe type (2 bits: control, interrupt, bulk, isochronous) | |
274 | * | |
275 | * That's 18 bits. Really. Nothing more. And the USB people have | |
276 | * documented these eighteen bits as some kind of glorious | |
277 | * virtual data structure. | |
278 | * | |
279 | * Let's not fall in that trap. We'll just encode it as a simple | |
280 | * unsigned int. The encoding is: | |
281 | * | |
282 | * - max size: bits 0-1 (00 = 8, 01 = 16, 10 = 32, 11 = 64) | |
de39f8c1 MT |
283 | * - direction: bit 7 (0 = Host-to-Device [Out], |
284 | * (1 = Device-to-Host [In]) | |
012771d8 WD |
285 | * - device: bits 8-14 |
286 | * - endpoint: bits 15-18 | |
287 | * - Data0/1: bit 19 | |
3e126484 | 288 | * - speed: bit 26 (0 = Full, 1 = Low Speed, 2 = High) |
de39f8c1 MT |
289 | * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt, |
290 | * 10 = control, 11 = bulk) | |
012771d8 WD |
291 | * |
292 | * Why? Because it's arbitrary, and whatever encoding we select is really | |
293 | * up to us. This one happens to share a lot of bit positions with the UHCI | |
294 | * specification, so that much of the uhci driver can just mask the bits | |
295 | * appropriately. | |
296 | */ | |
297 | /* Create various pipes... */ | |
298 | #define create_pipe(dev,endpoint) \ | |
d0fe1128 | 299 | (((dev)->devnum << 8) | ((endpoint) << 15) | \ |
3e126484 MT |
300 | ((dev)->speed << 26) | (dev)->maxpacketsize) |
301 | #define default_pipe(dev) ((dev)->speed << 26) | |
de39f8c1 MT |
302 | |
303 | #define usb_sndctrlpipe(dev, endpoint) ((PIPE_CONTROL << 30) | \ | |
304 | create_pipe(dev, endpoint)) | |
305 | #define usb_rcvctrlpipe(dev, endpoint) ((PIPE_CONTROL << 30) | \ | |
306 | create_pipe(dev, endpoint) | \ | |
307 | USB_DIR_IN) | |
308 | #define usb_sndisocpipe(dev, endpoint) ((PIPE_ISOCHRONOUS << 30) | \ | |
309 | create_pipe(dev, endpoint)) | |
310 | #define usb_rcvisocpipe(dev, endpoint) ((PIPE_ISOCHRONOUS << 30) | \ | |
311 | create_pipe(dev, endpoint) | \ | |
312 | USB_DIR_IN) | |
313 | #define usb_sndbulkpipe(dev, endpoint) ((PIPE_BULK << 30) | \ | |
314 | create_pipe(dev, endpoint)) | |
315 | #define usb_rcvbulkpipe(dev, endpoint) ((PIPE_BULK << 30) | \ | |
316 | create_pipe(dev, endpoint) | \ | |
317 | USB_DIR_IN) | |
318 | #define usb_sndintpipe(dev, endpoint) ((PIPE_INTERRUPT << 30) | \ | |
319 | create_pipe(dev, endpoint)) | |
320 | #define usb_rcvintpipe(dev, endpoint) ((PIPE_INTERRUPT << 30) | \ | |
321 | create_pipe(dev, endpoint) | \ | |
322 | USB_DIR_IN) | |
323 | #define usb_snddefctrl(dev) ((PIPE_CONTROL << 30) | \ | |
324 | default_pipe(dev)) | |
325 | #define usb_rcvdefctrl(dev) ((PIPE_CONTROL << 30) | \ | |
326 | default_pipe(dev) | \ | |
327 | USB_DIR_IN) | |
012771d8 WD |
328 | |
329 | /* The D0/D1 toggle bits */ | |
330 | #define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> ep) & 1) | |
5cf91d6b | 331 | #define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << ep)) |
de39f8c1 MT |
332 | #define usb_settoggle(dev, ep, out, bit) ((dev)->toggle[out] = \ |
333 | ((dev)->toggle[out] & \ | |
334 | ~(1 << ep)) | ((bit) << ep)) | |
012771d8 WD |
335 | |
336 | /* Endpoint halt control/status */ | |
337 | #define usb_endpoint_out(ep_dir) (((ep_dir >> 7) & 1) ^ 1) | |
338 | #define usb_endpoint_halt(dev, ep, out) ((dev)->halted[out] |= (1 << (ep))) | |
339 | #define usb_endpoint_running(dev, ep, out) ((dev)->halted[out] &= ~(1 << (ep))) | |
340 | #define usb_endpoint_halted(dev, ep, out) ((dev)->halted[out] & (1 << (ep))) | |
341 | ||
de39f8c1 MT |
342 | #define usb_packetid(pipe) (((pipe) & USB_DIR_IN) ? USB_PID_IN : \ |
343 | USB_PID_OUT) | |
012771d8 WD |
344 | |
345 | #define usb_pipeout(pipe) ((((pipe) >> 7) & 1) ^ 1) | |
346 | #define usb_pipein(pipe) (((pipe) >> 7) & 1) | |
347 | #define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f) | |
348 | #define usb_pipe_endpdev(pipe) (((pipe) >> 8) & 0x7ff) | |
349 | #define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf) | |
350 | #define usb_pipedata(pipe) (((pipe) >> 19) & 1) | |
3e126484 MT |
351 | #define usb_pipespeed(pipe) (((pipe) >> 26) & 3) |
352 | #define usb_pipeslow(pipe) (usb_pipespeed(pipe) == USB_SPEED_LOW) | |
012771d8 WD |
353 | #define usb_pipetype(pipe) (((pipe) >> 30) & 3) |
354 | #define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS) | |
355 | #define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT) | |
356 | #define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL) | |
357 | #define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK) | |
358 | ||
359 | ||
360 | /************************************************************************* | |
361 | * Hub Stuff | |
362 | */ | |
363 | struct usb_port_status { | |
364 | unsigned short wPortStatus; | |
365 | unsigned short wPortChange; | |
366 | } __attribute__ ((packed)); | |
367 | ||
368 | struct usb_hub_status { | |
369 | unsigned short wHubStatus; | |
370 | unsigned short wHubChange; | |
371 | } __attribute__ ((packed)); | |
372 | ||
373 | ||
374 | /* Hub descriptor */ | |
375 | struct usb_hub_descriptor { | |
376 | unsigned char bLength; | |
377 | unsigned char bDescriptorType; | |
378 | unsigned char bNbrPorts; | |
379 | unsigned short wHubCharacteristics; | |
380 | unsigned char bPwrOn2PwrGood; | |
381 | unsigned char bHubContrCurrent; | |
382 | unsigned char DeviceRemovable[(USB_MAXCHILDREN+1+7)/8]; | |
383 | unsigned char PortPowerCtrlMask[(USB_MAXCHILDREN+1+7)/8]; | |
de39f8c1 | 384 | /* DeviceRemovable and PortPwrCtrlMask want to be variable-length |
012771d8 WD |
385 | bitmaps that hold max 255 entries. (bit0 is ignored) */ |
386 | } __attribute__ ((packed)); | |
387 | ||
388 | ||
389 | struct usb_hub_device { | |
390 | struct usb_device *pusb_dev; | |
391 | struct usb_hub_descriptor desc; | |
392 | }; | |
393 | ||
23faf2bc MV |
394 | int usb_hub_probe(struct usb_device *dev, int ifnum); |
395 | void usb_hub_reset(void); | |
396 | int hub_port_reset(struct usb_device *dev, int port, | |
397 | unsigned short *portstat); | |
398 | ||
c7e3b2b5 LS |
399 | struct usb_device *usb_alloc_new_device(void *controller); |
400 | ||
23faf2bc MV |
401 | int usb_new_device(struct usb_device *dev); |
402 | ||
012771d8 | 403 | #endif /*_USB_H_ */ |