3 * Denis Peter, MPL AG Switzerland
5 * See file CREDITS for list of people who contributed to this
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.
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.
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,
23 * Note: Part of this code has been derived from linux
30 #include <linux/usb/ch9.h>
33 * The EHCI spec says that we must align to at least 32 bytes. However,
34 * some platforms require larger alignment.
36 #if ARCH_DMA_MINALIGN > 32
37 #define USB_DMA_MINALIGN ARCH_DMA_MINALIGN
39 #define USB_DMA_MINALIGN 32
42 /* Everything is aribtrary */
43 #define USB_ALTSETTINGALLOC 4
44 #define USB_MAXALTSETTING 128 /* Hard limit */
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
53 #define USB_CNTL_TIMEOUT 100 /* 100ms timeout */
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.
59 #define USB_TIMEOUT_MS(pipe) (usb_pipebulk(pipe) ? 5000 : 1000)
61 /* device request (setup) */
63 unsigned char requesttype
;
64 unsigned char request
;
67 unsigned short length
;
68 } __attribute__ ((packed
));
71 struct usb_interface
{
72 struct usb_interface_descriptor desc
;
74 unsigned char no_of_ep
;
75 unsigned char num_altsetting
;
76 unsigned char act_altsetting
;
78 struct usb_endpoint_descriptor ep_desc
[USB_MAXENDPOINTS
];
79 } __attribute__ ((packed
));
81 /* Configuration information.. */
83 struct usb_config_descriptor desc
;
85 unsigned char no_of_if
; /* number of interfaces */
86 struct usb_interface if_desc
[USB_MAXINTERFACES
];
87 } __attribute__ ((packed
));
90 /* Maximum packet size; encoded as 0,1,2,3 = 8,16,32,64 */
98 int devnum
; /* Device number on USB bus */
99 int speed
; /* full/low/high */
100 char mf
[32]; /* manufacturer */
101 char prod
[32]; /* product */
102 char serial
[32]; /* serial number */
104 /* Maximum packet size; one of: PACKET_SIZE_* */
106 /* one bit for each endpoint ([0] = IN, [1] = OUT) */
107 unsigned int toggle
[2];
108 /* endpoint halts; one bit per endpoint # & direction;
109 * [0] = IN, [1] = OUT
111 unsigned int halted
[2];
112 int epmaxpacketin
[16]; /* INput endpoint specific maximums */
113 int epmaxpacketout
[16]; /* OUTput endpoint specific maximums */
115 int configno
; /* selected config number */
116 /* Device Descriptor */
117 struct usb_device_descriptor descriptor
118 __attribute__((aligned(ARCH_DMA_MINALIGN
)));
119 struct usb_config config
; /* config descriptor */
121 int have_langid
; /* whether string_langid is valid yet */
122 int string_langid
; /* language ID for strings */
123 int (*irq_handle
)(struct usb_device
*dev
);
124 unsigned long irq_status
;
125 int irq_act_len
; /* transfered bytes */
128 * Child devices - if this is a hub device
129 * Each instance needs its own set of data structures.
131 unsigned long status
;
132 int act_len
; /* transfered bytes */
133 int maxchild
; /* Number of ports if hub */
135 struct usb_device
*parent
;
136 struct usb_device
*children
[USB_MAXCHILDREN
];
138 void *controller
; /* hardware controller private data */
141 /**********************************************************************
142 * this is how the lowlevel part communicate with the outer world
145 #if defined(CONFIG_USB_UHCI) || defined(CONFIG_USB_OHCI) || \
146 defined(CONFIG_USB_EHCI) || defined(CONFIG_USB_OHCI_NEW) || \
147 defined(CONFIG_USB_SL811HS) || defined(CONFIG_USB_ISP116X_HCD) || \
148 defined(CONFIG_USB_R8A66597_HCD) || defined(CONFIG_USB_DAVINCI) || \
149 defined(CONFIG_USB_OMAP3) || defined(CONFIG_USB_DA8XX) || \
150 defined(CONFIG_USB_BLACKFIN) || defined(CONFIG_USB_AM35X)
152 int usb_lowlevel_init(int index
, void **controller
);
153 int usb_lowlevel_stop(int index
);
155 int submit_bulk_msg(struct usb_device
*dev
, unsigned long pipe
,
156 void *buffer
, int transfer_len
);
157 int submit_control_msg(struct usb_device
*dev
, unsigned long pipe
, void *buffer
,
158 int transfer_len
, struct devrequest
*setup
);
159 int submit_int_msg(struct usb_device
*dev
, unsigned long pipe
, void *buffer
,
160 int transfer_len
, int interval
);
163 #define USB_UHCI_VEND_ID 0x8086
164 #define USB_UHCI_DEV_ID 0x7112
167 * PXA25x can only act as USB device. There are drivers
168 * which works with USB CDC gadgets implementations.
169 * Some of them have common routines which can be used
170 * in boards init functions e.g. udc_disconnect() used for
171 * forced device disconnection from host.
173 #elif defined(CONFIG_USB_GADGET_PXA2XX)
175 extern void udc_disconnect(void);
178 #error USB Lowlevel not defined
181 #ifdef CONFIG_USB_STORAGE
183 #define USB_MAX_STOR_DEV 5
184 block_dev_desc_t
*usb_stor_get_dev(int index
);
185 int usb_stor_scan(int mode
);
186 int usb_stor_info(void);
190 #ifdef CONFIG_USB_HOST_ETHER
192 #define USB_MAX_ETH_DEV 5
193 int usb_host_eth_scan(int mode
);
197 #ifdef CONFIG_USB_KEYBOARD
199 int drv_usb_kbd_init(void);
200 int usb_kbd_deregister(void);
204 int usb_init(void); /* initialize the USB Controller */
205 int usb_stop(void); /* stop the USB Controller */
208 int usb_set_protocol(struct usb_device
*dev
, int ifnum
, int protocol
);
209 int usb_set_idle(struct usb_device
*dev
, int ifnum
, int duration
,
211 struct usb_device
*usb_get_dev_index(int index
);
212 int usb_control_msg(struct usb_device
*dev
, unsigned int pipe
,
213 unsigned char request
, unsigned char requesttype
,
214 unsigned short value
, unsigned short index
,
215 void *data
, unsigned short size
, int timeout
);
216 int usb_bulk_msg(struct usb_device
*dev
, unsigned int pipe
,
217 void *data
, int len
, int *actual_length
, int timeout
);
218 int usb_submit_int_msg(struct usb_device
*dev
, unsigned long pipe
,
219 void *buffer
, int transfer_len
, int interval
);
220 int usb_disable_asynch(int disable
);
221 int usb_maxpacket(struct usb_device
*dev
, unsigned long pipe
);
222 int usb_get_configuration_no(struct usb_device
*dev
, unsigned char *buffer
,
224 int usb_get_report(struct usb_device
*dev
, int ifnum
, unsigned char type
,
225 unsigned char id
, void *buf
, int size
);
226 int usb_get_class_descriptor(struct usb_device
*dev
, int ifnum
,
227 unsigned char type
, unsigned char id
, void *buf
,
229 int usb_clear_halt(struct usb_device
*dev
, int pipe
);
230 int usb_string(struct usb_device
*dev
, int index
, char *buf
, size_t size
);
231 int usb_set_interface(struct usb_device
*dev
, int interface
, int alternate
);
233 /* big endian -> little endian conversion */
234 /* some CPUs are already little endian e.g. the ARM920T */
235 #define __swap_16(x) \
236 ({ unsigned short x_ = (unsigned short)x; \
238 ((x_ & 0x00FFU) << 8) | ((x_ & 0xFF00U) >> 8)); \
240 #define __swap_32(x) \
241 ({ unsigned long x_ = (unsigned long)x; \
243 ((x_ & 0x000000FFUL) << 24) | \
244 ((x_ & 0x0000FF00UL) << 8) | \
245 ((x_ & 0x00FF0000UL) >> 8) | \
246 ((x_ & 0xFF000000UL) >> 24)); \
249 #ifdef __LITTLE_ENDIAN
250 # define swap_16(x) (x)
251 # define swap_32(x) (x)
253 # define swap_16(x) __swap_16(x)
254 # define swap_32(x) __swap_32(x)
258 * Calling this entity a "pipe" is glorifying it. A USB pipe
259 * is something embarrassingly simple: it basically consists
260 * of the following information:
261 * - device number (7 bits)
262 * - endpoint number (4 bits)
263 * - current Data0/1 state (1 bit)
264 * - direction (1 bit)
266 * - max packet size (2 bits: 8, 16, 32 or 64)
267 * - pipe type (2 bits: control, interrupt, bulk, isochronous)
269 * That's 18 bits. Really. Nothing more. And the USB people have
270 * documented these eighteen bits as some kind of glorious
271 * virtual data structure.
273 * Let's not fall in that trap. We'll just encode it as a simple
274 * unsigned int. The encoding is:
276 * - max size: bits 0-1 (00 = 8, 01 = 16, 10 = 32, 11 = 64)
277 * - direction: bit 7 (0 = Host-to-Device [Out],
278 * (1 = Device-to-Host [In])
279 * - device: bits 8-14
280 * - endpoint: bits 15-18
282 * - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt,
283 * 10 = control, 11 = bulk)
285 * Why? Because it's arbitrary, and whatever encoding we select is really
286 * up to us. This one happens to share a lot of bit positions with the UHCI
287 * specification, so that much of the uhci driver can just mask the bits
290 /* Create various pipes... */
291 #define create_pipe(dev,endpoint) \
292 (((dev)->devnum << 8) | ((endpoint) << 15) | \
293 (dev)->maxpacketsize)
294 #define default_pipe(dev) ((dev)->speed << 26)
296 #define usb_sndctrlpipe(dev, endpoint) ((PIPE_CONTROL << 30) | \
297 create_pipe(dev, endpoint))
298 #define usb_rcvctrlpipe(dev, endpoint) ((PIPE_CONTROL << 30) | \
299 create_pipe(dev, endpoint) | \
301 #define usb_sndisocpipe(dev, endpoint) ((PIPE_ISOCHRONOUS << 30) | \
302 create_pipe(dev, endpoint))
303 #define usb_rcvisocpipe(dev, endpoint) ((PIPE_ISOCHRONOUS << 30) | \
304 create_pipe(dev, endpoint) | \
306 #define usb_sndbulkpipe(dev, endpoint) ((PIPE_BULK << 30) | \
307 create_pipe(dev, endpoint))
308 #define usb_rcvbulkpipe(dev, endpoint) ((PIPE_BULK << 30) | \
309 create_pipe(dev, endpoint) | \
311 #define usb_sndintpipe(dev, endpoint) ((PIPE_INTERRUPT << 30) | \
312 create_pipe(dev, endpoint))
313 #define usb_rcvintpipe(dev, endpoint) ((PIPE_INTERRUPT << 30) | \
314 create_pipe(dev, endpoint) | \
316 #define usb_snddefctrl(dev) ((PIPE_CONTROL << 30) | \
318 #define usb_rcvdefctrl(dev) ((PIPE_CONTROL << 30) | \
319 default_pipe(dev) | \
322 /* The D0/D1 toggle bits */
323 #define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> ep) & 1)
324 #define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << ep))
325 #define usb_settoggle(dev, ep, out, bit) ((dev)->toggle[out] = \
326 ((dev)->toggle[out] & \
327 ~(1 << ep)) | ((bit) << ep))
329 /* Endpoint halt control/status */
330 #define usb_endpoint_out(ep_dir) (((ep_dir >> 7) & 1) ^ 1)
331 #define usb_endpoint_halt(dev, ep, out) ((dev)->halted[out] |= (1 << (ep)))
332 #define usb_endpoint_running(dev, ep, out) ((dev)->halted[out] &= ~(1 << (ep)))
333 #define usb_endpoint_halted(dev, ep, out) ((dev)->halted[out] & (1 << (ep)))
335 #define usb_packetid(pipe) (((pipe) & USB_DIR_IN) ? USB_PID_IN : \
338 #define usb_pipeout(pipe) ((((pipe) >> 7) & 1) ^ 1)
339 #define usb_pipein(pipe) (((pipe) >> 7) & 1)
340 #define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f)
341 #define usb_pipe_endpdev(pipe) (((pipe) >> 8) & 0x7ff)
342 #define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf)
343 #define usb_pipedata(pipe) (((pipe) >> 19) & 1)
344 #define usb_pipetype(pipe) (((pipe) >> 30) & 3)
345 #define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
346 #define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT)
347 #define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL)
348 #define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK)
351 /*************************************************************************
354 struct usb_port_status
{
355 unsigned short wPortStatus
;
356 unsigned short wPortChange
;
357 } __attribute__ ((packed
));
359 struct usb_hub_status
{
360 unsigned short wHubStatus
;
361 unsigned short wHubChange
;
362 } __attribute__ ((packed
));
366 struct usb_hub_descriptor
{
367 unsigned char bLength
;
368 unsigned char bDescriptorType
;
369 unsigned char bNbrPorts
;
370 unsigned short wHubCharacteristics
;
371 unsigned char bPwrOn2PwrGood
;
372 unsigned char bHubContrCurrent
;
373 unsigned char DeviceRemovable
[(USB_MAXCHILDREN
+1+7)/8];
374 unsigned char PortPowerCtrlMask
[(USB_MAXCHILDREN
+1+7)/8];
375 /* DeviceRemovable and PortPwrCtrlMask want to be variable-length
376 bitmaps that hold max 255 entries. (bit0 is ignored) */
377 } __attribute__ ((packed
));
380 struct usb_hub_device
{
381 struct usb_device
*pusb_dev
;
382 struct usb_hub_descriptor desc
;
385 int usb_hub_probe(struct usb_device
*dev
, int ifnum
);
386 void usb_hub_reset(void);
387 int hub_port_reset(struct usb_device
*dev
, int port
,
388 unsigned short *portstat
);
390 struct usb_device
*usb_alloc_new_device(void *controller
);
392 int usb_new_device(struct usb_device
*dev
);