Merge tag 'renesas-soc-r8a7790-for-v3.10' of git://git.kernel.org/pub/scm/linux/kerne...
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / drivers / usb / gadget / pxa25x_udc.c
CommitLineData
1da177e4 1/*
91987693 2 * Intel PXA25x and IXP4xx on-chip full speed USB device controllers
1da177e4
LT
3 *
4 * Copyright (C) 2002 Intrinsyc, Inc. (Frank Becker)
5 * Copyright (C) 2003 Robert Schwebel, Pengutronix
6 * Copyright (C) 2003 Benedikt Spranger, Pengutronix
7 * Copyright (C) 2003 David Brownell
8 * Copyright (C) 2003 Joshua Wise
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
1da177e4
LT
14 */
15
040fa1b9 16/* #define VERBOSE_DEBUG */
1da177e4 17
9068a4c6 18#include <linux/device.h>
1da177e4
LT
19#include <linux/module.h>
20#include <linux/kernel.h>
21#include <linux/ioport.h>
22#include <linux/types.h>
1da177e4 23#include <linux/errno.h>
ded017ee 24#include <linux/err.h>
1da177e4 25#include <linux/delay.h>
1da177e4
LT
26#include <linux/slab.h>
27#include <linux/init.h>
28#include <linux/timer.h>
29#include <linux/list.h>
30#include <linux/interrupt.h>
1da177e4 31#include <linux/mm.h>
46000065 32#include <linux/platform_data/pxa2xx_udc.h>
d052d1be 33#include <linux/platform_device.h>
1da177e4 34#include <linux/dma-mapping.h>
c7a3bd17 35#include <linux/irq.h>
6549e6c9 36#include <linux/clk.h>
040fa1b9
DES
37#include <linux/seq_file.h>
38#include <linux/debugfs.h>
284d115e 39#include <linux/io.h>
268bb0ce 40#include <linux/prefetch.h>
1da177e4
LT
41
42#include <asm/byteorder.h>
43#include <asm/dma.h>
9068a4c6 44#include <asm/gpio.h>
1da177e4
LT
45#include <asm/mach-types.h>
46#include <asm/unaligned.h>
1da177e4 47
5f848137 48#include <linux/usb/ch9.h>
9454a57a 49#include <linux/usb/gadget.h>
ab26d20f 50#include <linux/usb/otg.h>
1da177e4 51
284d115e
RK
52/*
53 * This driver is PXA25x only. Grab the right register definitions.
54 */
55#ifdef CONFIG_ARCH_PXA
a09e64fb 56#include <mach/pxa25x-udc.h>
284d115e
RK
57#endif
58
0dc726bb
EM
59#ifdef CONFIG_ARCH_LUBBOCK
60#include <mach/lubbock.h>
61#endif
62
1da177e4 63/*
91987693 64 * This driver handles the USB Device Controller (UDC) in Intel's PXA 25x
1da177e4
LT
65 * series processors. The UDC for the IXP 4xx series is very similar.
66 * There are fifteen endpoints, in addition to ep0.
67 *
68 * Such controller drivers work with a gadget driver. The gadget driver
69 * returns descriptors, implements configuration and data protocols used
70 * by the host to interact with this device, and allocates endpoints to
71 * the different protocol interfaces. The controller driver virtualizes
72 * usb hardware so that the gadget drivers will be more portable.
34ebcd28 73 *
1da177e4
LT
74 * This UDC hardware wants to implement a bit too much USB protocol, so
75 * it constrains the sorts of USB configuration change events that work.
76 * The errata for these chips are misleading; some "fixed" bugs from
77 * pxa250 a0/a1 b0/b1/b2 sure act like they're still there.
ad8c623f
DB
78 *
79 * Note that the UDC hardware supports DMA (except on IXP) but that's
80 * not used here. IN-DMA (to host) is simple enough, when the data is
81 * suitably aligned (16 bytes) ... the network stack doesn't do that,
82 * other software can. OUT-DMA is buggy in most chip versions, as well
83 * as poorly designed (data toggle not automatic). So this driver won't
84 * bother using DMA. (Mostly-working IN-DMA support was available in
85 * kernels before 2.6.23, but was never enabled or well tested.)
1da177e4
LT
86 */
87
ad8c623f 88#define DRIVER_VERSION "30-June-2007"
91987693 89#define DRIVER_DESC "PXA 25x USB Device Controller driver"
1da177e4
LT
90
91
7a857620 92static const char driver_name [] = "pxa25x_udc";
1da177e4
LT
93
94static const char ep0name [] = "ep0";
95
96
1da177e4 97#ifdef CONFIG_ARCH_IXP4XX
1da177e4
LT
98
99/* cpu-specific register addresses are compiled in to this code */
100#ifdef CONFIG_ARCH_PXA
101#error "Can't configure both IXP and PXA"
102#endif
103
64cc2dd9
DES
104/* IXP doesn't yet support <linux/clk.h> */
105#define clk_get(dev,name) NULL
106#define clk_enable(clk) do { } while (0)
107#define clk_disable(clk) do { } while (0)
108#define clk_put(clk) do { } while (0)
109
1da177e4
LT
110#endif
111
7a857620 112#include "pxa25x_udc.h"
1da177e4
LT
113
114
7a857620 115#ifdef CONFIG_USB_PXA25X_SMALL
1da177e4
LT
116#define SIZE_STR " (small)"
117#else
118#define SIZE_STR ""
119#endif
120
1da177e4 121/* ---------------------------------------------------------------------------
34ebcd28 122 * endpoint related parts of the api to the usb controller hardware,
1da177e4
LT
123 * used by gadget driver; and the inner talker-to-hardware core.
124 * ---------------------------------------------------------------------------
125 */
126
7a857620
PZ
127static void pxa25x_ep_fifo_flush (struct usb_ep *ep);
128static void nuke (struct pxa25x_ep *, int status);
1da177e4 129
b2bbb20b
DB
130/* one GPIO should control a D+ pullup, so host sees this device (or not) */
131static void pullup_off(void)
132{
133 struct pxa2xx_udc_mach_info *mach = the_controller->mach;
8fb105f5 134 int off_level = mach->gpio_pullup_inverted;
b2bbb20b 135
56a075dc 136 if (gpio_is_valid(mach->gpio_pullup))
8fb105f5 137 gpio_set_value(mach->gpio_pullup, off_level);
b2bbb20b
DB
138 else if (mach->udc_command)
139 mach->udc_command(PXA2XX_UDC_CMD_DISCONNECT);
140}
141
142static void pullup_on(void)
143{
144 struct pxa2xx_udc_mach_info *mach = the_controller->mach;
8fb105f5 145 int on_level = !mach->gpio_pullup_inverted;
b2bbb20b 146
56a075dc 147 if (gpio_is_valid(mach->gpio_pullup))
8fb105f5 148 gpio_set_value(mach->gpio_pullup, on_level);
b2bbb20b
DB
149 else if (mach->udc_command)
150 mach->udc_command(PXA2XX_UDC_CMD_CONNECT);
151}
152
1da177e4
LT
153static void pio_irq_enable(int bEndpointAddress)
154{
155 bEndpointAddress &= 0xf;
156 if (bEndpointAddress < 8)
157 UICR0 &= ~(1 << bEndpointAddress);
158 else {
159 bEndpointAddress -= 8;
160 UICR1 &= ~(1 << bEndpointAddress);
161 }
162}
163
164static void pio_irq_disable(int bEndpointAddress)
165{
166 bEndpointAddress &= 0xf;
167 if (bEndpointAddress < 8)
168 UICR0 |= 1 << bEndpointAddress;
169 else {
170 bEndpointAddress -= 8;
171 UICR1 |= 1 << bEndpointAddress;
172 }
173}
174
175/* The UDCCR reg contains mask and interrupt status bits,
176 * so using '|=' isn't safe as it may ack an interrupt.
177 */
178#define UDCCR_MASK_BITS (UDCCR_REM | UDCCR_SRM | UDCCR_UDE)
179
180static inline void udc_set_mask_UDCCR(int mask)
181{
182 UDCCR = (UDCCR & UDCCR_MASK_BITS) | (mask & UDCCR_MASK_BITS);
183}
184
185static inline void udc_clear_mask_UDCCR(int mask)
186{
187 UDCCR = (UDCCR & UDCCR_MASK_BITS) & ~(mask & UDCCR_MASK_BITS);
188}
189
190static inline void udc_ack_int_UDCCR(int mask)
191{
192 /* udccr contains the bits we dont want to change */
193 __u32 udccr = UDCCR & UDCCR_MASK_BITS;
194
195 UDCCR = udccr | (mask & ~UDCCR_MASK_BITS);
196}
197
198/*
199 * endpoint enable/disable
200 *
7a857620 201 * we need to verify the descriptors used to enable endpoints. since pxa25x
1da177e4
LT
202 * endpoint configurations are fixed, and are pretty much always enabled,
203 * there's not a lot to manage here.
204 *
7a857620 205 * because pxa25x can't selectively initialize bulk (or interrupt) endpoints,
1da177e4
LT
206 * (resetting endpoint halt and toggle), SET_INTERFACE is unusable except
207 * for a single interface (with only the default altsetting) and for gadget
208 * drivers that don't halt endpoints (not reset by set_interface). that also
209 * means that if you use ISO, you must violate the USB spec rule that all
210 * iso endpoints must be in non-default altsettings.
211 */
7a857620 212static int pxa25x_ep_enable (struct usb_ep *_ep,
1da177e4
LT
213 const struct usb_endpoint_descriptor *desc)
214{
7a857620
PZ
215 struct pxa25x_ep *ep;
216 struct pxa25x_udc *dev;
1da177e4 217
7a857620 218 ep = container_of (_ep, struct pxa25x_ep, ep);
3ba0b31a 219 if (!_ep || !desc || _ep->name == ep0name
1da177e4
LT
220 || desc->bDescriptorType != USB_DT_ENDPOINT
221 || ep->bEndpointAddress != desc->bEndpointAddress
29cc8897 222 || ep->fifo_size < usb_endpoint_maxp (desc)) {
441b62c1 223 DMSG("%s, bad ep or descriptor\n", __func__);
1da177e4
LT
224 return -EINVAL;
225 }
226
227 /* xfer types must match, except that interrupt ~= bulk */
228 if (ep->bmAttributes != desc->bmAttributes
229 && ep->bmAttributes != USB_ENDPOINT_XFER_BULK
230 && desc->bmAttributes != USB_ENDPOINT_XFER_INT) {
441b62c1 231 DMSG("%s, %s type mismatch\n", __func__, _ep->name);
1da177e4
LT
232 return -EINVAL;
233 }
234
235 /* hardware _could_ do smaller, but driver doesn't */
236 if ((desc->bmAttributes == USB_ENDPOINT_XFER_BULK
29cc8897 237 && usb_endpoint_maxp (desc)
1da177e4
LT
238 != BULK_FIFO_SIZE)
239 || !desc->wMaxPacketSize) {
441b62c1 240 DMSG("%s, bad %s maxpacket\n", __func__, _ep->name);
1da177e4
LT
241 return -ERANGE;
242 }
243
244 dev = ep->dev;
245 if (!dev->driver || dev->gadget.speed == USB_SPEED_UNKNOWN) {
441b62c1 246 DMSG("%s, bogus device state\n", __func__);
1da177e4
LT
247 return -ESHUTDOWN;
248 }
249
c18800d8 250 ep->ep.desc = desc;
1da177e4 251 ep->stopped = 0;
ad8c623f 252 ep->pio_irqs = 0;
29cc8897 253 ep->ep.maxpacket = usb_endpoint_maxp (desc);
1da177e4
LT
254
255 /* flush fifo (mostly for OUT buffers) */
7a857620 256 pxa25x_ep_fifo_flush (_ep);
1da177e4
LT
257
258 /* ... reset halt state too, if we could ... */
259
1da177e4
LT
260 DBG(DBG_VERBOSE, "enabled %s\n", _ep->name);
261 return 0;
262}
263
7a857620 264static int pxa25x_ep_disable (struct usb_ep *_ep)
1da177e4 265{
7a857620 266 struct pxa25x_ep *ep;
91987693 267 unsigned long flags;
1da177e4 268
7a857620 269 ep = container_of (_ep, struct pxa25x_ep, ep);
c18800d8 270 if (!_ep || !ep->ep.desc) {
441b62c1 271 DMSG("%s, %s not enabled\n", __func__,
1da177e4
LT
272 _ep ? ep->ep.name : NULL);
273 return -EINVAL;
274 }
91987693
DB
275 local_irq_save(flags);
276
1da177e4
LT
277 nuke (ep, -ESHUTDOWN);
278
1da177e4 279 /* flush fifo (mostly for IN buffers) */
7a857620 280 pxa25x_ep_fifo_flush (_ep);
1da177e4 281
f9c56cdd 282 ep->ep.desc = NULL;
1da177e4
LT
283 ep->stopped = 1;
284
91987693 285 local_irq_restore(flags);
1da177e4
LT
286 DBG(DBG_VERBOSE, "%s disabled\n", _ep->name);
287 return 0;
288}
289
290/*-------------------------------------------------------------------------*/
291
7a857620 292/* for the pxa25x, these can just wrap kmalloc/kfree. gadget drivers
1da177e4
LT
293 * must still pass correctly initialized endpoints, since other controller
294 * drivers may care about how it's currently set up (dma issues etc).
295 */
296
297/*
7a857620 298 * pxa25x_ep_alloc_request - allocate a request data structure
1da177e4
LT
299 */
300static struct usb_request *
7a857620 301pxa25x_ep_alloc_request (struct usb_ep *_ep, gfp_t gfp_flags)
1da177e4 302{
7a857620 303 struct pxa25x_request *req;
1da177e4 304
7039f422 305 req = kzalloc(sizeof(*req), gfp_flags);
1da177e4
LT
306 if (!req)
307 return NULL;
308
1da177e4
LT
309 INIT_LIST_HEAD (&req->queue);
310 return &req->req;
311}
312
313
314/*
7a857620 315 * pxa25x_ep_free_request - deallocate a request data structure
1da177e4
LT
316 */
317static void
7a857620 318pxa25x_ep_free_request (struct usb_ep *_ep, struct usb_request *_req)
1da177e4 319{
7a857620 320 struct pxa25x_request *req;
1da177e4 321
7a857620 322 req = container_of (_req, struct pxa25x_request, req);
b6c63937 323 WARN_ON(!list_empty (&req->queue));
1da177e4
LT
324 kfree(req);
325}
326
1da177e4
LT
327/*-------------------------------------------------------------------------*/
328
329/*
330 * done - retire a request; caller blocked irqs
331 */
7a857620 332static void done(struct pxa25x_ep *ep, struct pxa25x_request *req, int status)
1da177e4
LT
333{
334 unsigned stopped = ep->stopped;
335
336 list_del_init(&req->queue);
337
338 if (likely (req->req.status == -EINPROGRESS))
339 req->req.status = status;
340 else
341 status = req->req.status;
342
343 if (status && status != -ESHUTDOWN)
344 DBG(DBG_VERBOSE, "complete %s req %p stat %d len %u/%u\n",
345 ep->ep.name, &req->req, status,
346 req->req.actual, req->req.length);
347
348 /* don't modify queue heads during completion callback */
349 ep->stopped = 1;
350 req->req.complete(&ep->ep, &req->req);
351 ep->stopped = stopped;
352}
353
354
7a857620 355static inline void ep0_idle (struct pxa25x_udc *dev)
1da177e4
LT
356{
357 dev->ep0state = EP0_IDLE;
358}
359
360static int
7a857620 361write_packet(volatile u32 *uddr, struct pxa25x_request *req, unsigned max)
1da177e4
LT
362{
363 u8 *buf;
364 unsigned length, count;
365
366 buf = req->req.buf + req->req.actual;
367 prefetch(buf);
368
369 /* how big will this packet be? */
370 length = min(req->req.length - req->req.actual, max);
371 req->req.actual += length;
372
373 count = length;
374 while (likely(count--))
375 *uddr = *buf++;
376
377 return length;
378}
379
380/*
381 * write to an IN endpoint fifo, as many packets as possible.
382 * irqs will use this to write the rest later.
383 * caller guarantees at least one packet buffer is ready (or a zlp).
384 */
385static int
7a857620 386write_fifo (struct pxa25x_ep *ep, struct pxa25x_request *req)
1da177e4
LT
387{
388 unsigned max;
389
c18800d8 390 max = usb_endpoint_maxp(ep->ep.desc);
1da177e4
LT
391 do {
392 unsigned count;
393 int is_last, is_short;
394
395 count = write_packet(ep->reg_uddr, req, max);
396
397 /* last packet is usually short (or a zlp) */
398 if (unlikely (count != max))
399 is_last = is_short = 1;
400 else {
401 if (likely(req->req.length != req->req.actual)
402 || req->req.zero)
403 is_last = 0;
404 else
405 is_last = 1;
406 /* interrupt/iso maxpacket may not fill the fifo */
407 is_short = unlikely (max < ep->fifo_size);
408 }
409
410 DBG(DBG_VERY_NOISY, "wrote %s %d bytes%s%s %d left %p\n",
411 ep->ep.name, count,
412 is_last ? "/L" : "", is_short ? "/S" : "",
413 req->req.length - req->req.actual, req);
414
415 /* let loose that packet. maybe try writing another one,
416 * double buffering might work. TSP, TPC, and TFS
417 * bit values are the same for all normal IN endpoints.
418 */
419 *ep->reg_udccs = UDCCS_BI_TPC;
420 if (is_short)
421 *ep->reg_udccs = UDCCS_BI_TSP;
422
423 /* requests complete when all IN data is in the FIFO */
424 if (is_last) {
425 done (ep, req, 0);
ad8c623f 426 if (list_empty(&ep->queue))
1da177e4 427 pio_irq_disable (ep->bEndpointAddress);
1da177e4
LT
428 return 1;
429 }
430
431 // TODO experiment: how robust can fifo mode tweaking be?
432 // double buffering is off in the default fifo mode, which
433 // prevents TFS from being set here.
434
435 } while (*ep->reg_udccs & UDCCS_BI_TFS);
436 return 0;
437}
438
439/* caller asserts req->pending (ep0 irq status nyet cleared); starts
440 * ep0 data stage. these chips want very simple state transitions.
441 */
442static inline
7a857620 443void ep0start(struct pxa25x_udc *dev, u32 flags, const char *tag)
1da177e4
LT
444{
445 UDCCS0 = flags|UDCCS0_SA|UDCCS0_OPR;
446 USIR0 = USIR0_IR0;
447 dev->req_pending = 0;
448 DBG(DBG_VERY_NOISY, "%s %s, %02x/%02x\n",
441b62c1 449 __func__, tag, UDCCS0, flags);
1da177e4
LT
450}
451
452static int
7a857620 453write_ep0_fifo (struct pxa25x_ep *ep, struct pxa25x_request *req)
1da177e4
LT
454{
455 unsigned count;
456 int is_short;
457
458 count = write_packet(&UDDR0, req, EP0_FIFO_SIZE);
459 ep->dev->stats.write.bytes += count;
460
461 /* last packet "must be" short (or a zlp) */
462 is_short = (count != EP0_FIFO_SIZE);
463
464 DBG(DBG_VERY_NOISY, "ep0in %d bytes %d left %p\n", count,
465 req->req.length - req->req.actual, req);
466
467 if (unlikely (is_short)) {
468 if (ep->dev->req_pending)
469 ep0start(ep->dev, UDCCS0_IPR, "short IN");
470 else
471 UDCCS0 = UDCCS0_IPR;
472
473 count = req->req.length;
474 done (ep, req, 0);
475 ep0_idle(ep->dev);
043ea18b 476#ifndef CONFIG_ARCH_IXP4XX
1da177e4
LT
477#if 1
478 /* This seems to get rid of lost status irqs in some cases:
479 * host responds quickly, or next request involves config
480 * change automagic, or should have been hidden, or ...
481 *
482 * FIXME get rid of all udelays possible...
483 */
484 if (count >= EP0_FIFO_SIZE) {
485 count = 100;
486 do {
487 if ((UDCCS0 & UDCCS0_OPR) != 0) {
488 /* clear OPR, generate ack */
489 UDCCS0 = UDCCS0_OPR;
490 break;
491 }
492 count--;
493 udelay(1);
494 } while (count);
495 }
043ea18b 496#endif
1da177e4
LT
497#endif
498 } else if (ep->dev->req_pending)
499 ep0start(ep->dev, 0, "IN");
500 return is_short;
501}
502
503
504/*
505 * read_fifo - unload packet(s) from the fifo we use for usb OUT
506 * transfers and put them into the request. caller should have made
507 * sure there's at least one packet ready.
508 *
509 * returns true if the request completed because of short packet or the
510 * request buffer having filled (and maybe overran till end-of-packet).
511 */
512static int
7a857620 513read_fifo (struct pxa25x_ep *ep, struct pxa25x_request *req)
1da177e4
LT
514{
515 for (;;) {
516 u32 udccs;
517 u8 *buf;
518 unsigned bufferspace, count, is_short;
519
520 /* make sure there's a packet in the FIFO.
521 * UDCCS_{BO,IO}_RPC are all the same bit value.
522 * UDCCS_{BO,IO}_RNE are all the same bit value.
523 */
524 udccs = *ep->reg_udccs;
525 if (unlikely ((udccs & UDCCS_BO_RPC) == 0))
526 break;
527 buf = req->req.buf + req->req.actual;
528 prefetchw(buf);
529 bufferspace = req->req.length - req->req.actual;
530
531 /* read all bytes from this packet */
532 if (likely (udccs & UDCCS_BO_RNE)) {
533 count = 1 + (0x0ff & *ep->reg_ubcr);
534 req->req.actual += min (count, bufferspace);
535 } else /* zlp */
536 count = 0;
537 is_short = (count < ep->ep.maxpacket);
538 DBG(DBG_VERY_NOISY, "read %s %02x, %d bytes%s req %p %d/%d\n",
539 ep->ep.name, udccs, count,
540 is_short ? "/S" : "",
541 req, req->req.actual, req->req.length);
542 while (likely (count-- != 0)) {
543 u8 byte = (u8) *ep->reg_uddr;
544
545 if (unlikely (bufferspace == 0)) {
546 /* this happens when the driver's buffer
547 * is smaller than what the host sent.
548 * discard the extra data.
549 */
550 if (req->req.status != -EOVERFLOW)
551 DMSG("%s overflow %d\n",
552 ep->ep.name, count);
553 req->req.status = -EOVERFLOW;
554 } else {
555 *buf++ = byte;
556 bufferspace--;
557 }
558 }
559 *ep->reg_udccs = UDCCS_BO_RPC;
560 /* RPC/RSP/RNE could now reflect the other packet buffer */
561
562 /* iso is one request per packet */
563 if (ep->bmAttributes == USB_ENDPOINT_XFER_ISOC) {
564 if (udccs & UDCCS_IO_ROF)
565 req->req.status = -EHOSTUNREACH;
566 /* more like "is_done" */
567 is_short = 1;
568 }
569
570 /* completion */
571 if (is_short || req->req.actual == req->req.length) {
572 done (ep, req, 0);
573 if (list_empty(&ep->queue))
574 pio_irq_disable (ep->bEndpointAddress);
575 return 1;
576 }
577
578 /* finished that packet. the next one may be waiting... */
579 }
580 return 0;
581}
582
583/*
584 * special ep0 version of the above. no UBCR0 or double buffering; status
585 * handshaking is magic. most device protocols don't need control-OUT.
586 * CDC vendor commands (and RNDIS), mass storage CB/CBI, and some other
587 * protocols do use them.
588 */
589static int
7a857620 590read_ep0_fifo (struct pxa25x_ep *ep, struct pxa25x_request *req)
1da177e4
LT
591{
592 u8 *buf, byte;
593 unsigned bufferspace;
594
595 buf = req->req.buf + req->req.actual;
596 bufferspace = req->req.length - req->req.actual;
597
598 while (UDCCS0 & UDCCS0_RNE) {
599 byte = (u8) UDDR0;
600
601 if (unlikely (bufferspace == 0)) {
602 /* this happens when the driver's buffer
603 * is smaller than what the host sent.
604 * discard the extra data.
605 */
606 if (req->req.status != -EOVERFLOW)
607 DMSG("%s overflow\n", ep->ep.name);
608 req->req.status = -EOVERFLOW;
609 } else {
610 *buf++ = byte;
611 req->req.actual++;
612 bufferspace--;
613 }
614 }
615
616 UDCCS0 = UDCCS0_OPR | UDCCS0_IPR;
617
618 /* completion */
619 if (req->req.actual >= req->req.length)
620 return 1;
621
622 /* finished that packet. the next one may be waiting... */
623 return 0;
624}
625
1da177e4
LT
626/*-------------------------------------------------------------------------*/
627
628static int
7a857620 629pxa25x_ep_queue(struct usb_ep *_ep, struct usb_request *_req, gfp_t gfp_flags)
1da177e4 630{
7a857620
PZ
631 struct pxa25x_request *req;
632 struct pxa25x_ep *ep;
633 struct pxa25x_udc *dev;
1da177e4
LT
634 unsigned long flags;
635
7a857620 636 req = container_of(_req, struct pxa25x_request, req);
1da177e4
LT
637 if (unlikely (!_req || !_req->complete || !_req->buf
638 || !list_empty(&req->queue))) {
441b62c1 639 DMSG("%s, bad params\n", __func__);
1da177e4
LT
640 return -EINVAL;
641 }
642
7a857620 643 ep = container_of(_ep, struct pxa25x_ep, ep);
c18800d8 644 if (unlikely(!_ep || (!ep->ep.desc && ep->ep.name != ep0name))) {
441b62c1 645 DMSG("%s, bad ep\n", __func__);
1da177e4
LT
646 return -EINVAL;
647 }
648
649 dev = ep->dev;
650 if (unlikely (!dev->driver
651 || dev->gadget.speed == USB_SPEED_UNKNOWN)) {
441b62c1 652 DMSG("%s, bogus device state\n", __func__);
1da177e4
LT
653 return -ESHUTDOWN;
654 }
655
656 /* iso is always one packet per request, that's the only way
657 * we can report per-packet status. that also helps with dma.
658 */
659 if (unlikely (ep->bmAttributes == USB_ENDPOINT_XFER_ISOC
c18800d8 660 && req->req.length > usb_endpoint_maxp(ep->ep.desc)))
1da177e4
LT
661 return -EMSGSIZE;
662
1da177e4 663 DBG(DBG_NOISY, "%s queue req %p, len %d buf %p\n",
ad8c623f 664 _ep->name, _req, _req->length, _req->buf);
1da177e4
LT
665
666 local_irq_save(flags);
667
668 _req->status = -EINPROGRESS;
669 _req->actual = 0;
670
671 /* kickstart this i/o queue? */
672 if (list_empty(&ep->queue) && !ep->stopped) {
c18800d8 673 if (ep->ep.desc == NULL/* ep0 */) {
1da177e4
LT
674 unsigned length = _req->length;
675
676 switch (dev->ep0state) {
677 case EP0_IN_DATA_PHASE:
678 dev->stats.write.ops++;
679 if (write_ep0_fifo(ep, req))
680 req = NULL;
681 break;
682
683 case EP0_OUT_DATA_PHASE:
684 dev->stats.read.ops++;
685 /* messy ... */
686 if (dev->req_config) {
687 DBG(DBG_VERBOSE, "ep0 config ack%s\n",
688 dev->has_cfr ? "" : " raced");
689 if (dev->has_cfr)
690 UDCCFR = UDCCFR_AREN|UDCCFR_ACM
691 |UDCCFR_MB1;
692 done(ep, req, 0);
693 dev->ep0state = EP0_END_XFER;
694 local_irq_restore (flags);
695 return 0;
696 }
697 if (dev->req_pending)
698 ep0start(dev, UDCCS0_IPR, "OUT");
699 if (length == 0 || ((UDCCS0 & UDCCS0_RNE) != 0
700 && read_ep0_fifo(ep, req))) {
701 ep0_idle(dev);
702 done(ep, req, 0);
703 req = NULL;
704 }
705 break;
706
707 default:
708 DMSG("ep0 i/o, odd state %d\n", dev->ep0state);
709 local_irq_restore (flags);
710 return -EL2HLT;
711 }
1da177e4 712 /* can the FIFO can satisfy the request immediately? */
91987693
DB
713 } else if ((ep->bEndpointAddress & USB_DIR_IN) != 0) {
714 if ((*ep->reg_udccs & UDCCS_BI_TFS) != 0
715 && write_fifo(ep, req))
716 req = NULL;
1da177e4
LT
717 } else if ((*ep->reg_udccs & UDCCS_BO_RFS) != 0
718 && read_fifo(ep, req)) {
719 req = NULL;
720 }
721
c18800d8 722 if (likely(req && ep->ep.desc))
1da177e4
LT
723 pio_irq_enable(ep->bEndpointAddress);
724 }
725
726 /* pio or dma irq handler advances the queue. */
040fa1b9 727 if (likely(req != NULL))
1da177e4
LT
728 list_add_tail(&req->queue, &ep->queue);
729 local_irq_restore(flags);
730
731 return 0;
732}
733
734
735/*
34ebcd28 736 * nuke - dequeue ALL requests
1da177e4 737 */
7a857620 738static void nuke(struct pxa25x_ep *ep, int status)
1da177e4 739{
7a857620 740 struct pxa25x_request *req;
1da177e4
LT
741
742 /* called with irqs blocked */
1da177e4
LT
743 while (!list_empty(&ep->queue)) {
744 req = list_entry(ep->queue.next,
7a857620 745 struct pxa25x_request,
1da177e4
LT
746 queue);
747 done(ep, req, status);
748 }
c18800d8 749 if (ep->ep.desc)
1da177e4
LT
750 pio_irq_disable (ep->bEndpointAddress);
751}
752
753
754/* dequeue JUST ONE request */
7a857620 755static int pxa25x_ep_dequeue(struct usb_ep *_ep, struct usb_request *_req)
1da177e4 756{
7a857620
PZ
757 struct pxa25x_ep *ep;
758 struct pxa25x_request *req;
1da177e4
LT
759 unsigned long flags;
760
7a857620 761 ep = container_of(_ep, struct pxa25x_ep, ep);
1da177e4
LT
762 if (!_ep || ep->ep.name == ep0name)
763 return -EINVAL;
764
765 local_irq_save(flags);
766
767 /* make sure it's actually queued on this endpoint */
768 list_for_each_entry (req, &ep->queue, queue) {
769 if (&req->req == _req)
770 break;
771 }
772 if (&req->req != _req) {
773 local_irq_restore(flags);
774 return -EINVAL;
775 }
776
ad8c623f 777 done(ep, req, -ECONNRESET);
1da177e4
LT
778
779 local_irq_restore(flags);
780 return 0;
781}
782
783/*-------------------------------------------------------------------------*/
784
7a857620 785static int pxa25x_ep_set_halt(struct usb_ep *_ep, int value)
1da177e4 786{
7a857620 787 struct pxa25x_ep *ep;
1da177e4
LT
788 unsigned long flags;
789
7a857620 790 ep = container_of(_ep, struct pxa25x_ep, ep);
1da177e4 791 if (unlikely (!_ep
c18800d8 792 || (!ep->ep.desc && ep->ep.name != ep0name))
1da177e4 793 || ep->bmAttributes == USB_ENDPOINT_XFER_ISOC) {
441b62c1 794 DMSG("%s, bad ep\n", __func__);
1da177e4
LT
795 return -EINVAL;
796 }
797 if (value == 0) {
798 /* this path (reset toggle+halt) is needed to implement
799 * SET_INTERFACE on normal hardware. but it can't be
800 * done from software on the PXA UDC, and the hardware
801 * forgets to do it as part of SET_INTERFACE automagic.
802 */
803 DMSG("only host can clear %s halt\n", _ep->name);
804 return -EROFS;
805 }
806
807 local_irq_save(flags);
808
809 if ((ep->bEndpointAddress & USB_DIR_IN) != 0
810 && ((*ep->reg_udccs & UDCCS_BI_TFS) == 0
811 || !list_empty(&ep->queue))) {
812 local_irq_restore(flags);
813 return -EAGAIN;
814 }
815
816 /* FST bit is the same for control, bulk in, bulk out, interrupt in */
817 *ep->reg_udccs = UDCCS_BI_FST|UDCCS_BI_FTF;
818
819 /* ep0 needs special care */
c18800d8 820 if (!ep->ep.desc) {
1da177e4
LT
821 start_watchdog(ep->dev);
822 ep->dev->req_pending = 0;
823 ep->dev->ep0state = EP0_STALL;
824
34ebcd28
DB
825 /* and bulk/intr endpoints like dropping stalls too */
826 } else {
827 unsigned i;
828 for (i = 0; i < 1000; i += 20) {
829 if (*ep->reg_udccs & UDCCS_BI_SST)
830 break;
831 udelay(20);
832 }
833 }
834 local_irq_restore(flags);
1da177e4
LT
835
836 DBG(DBG_VERBOSE, "%s halt\n", _ep->name);
837 return 0;
838}
839
7a857620 840static int pxa25x_ep_fifo_status(struct usb_ep *_ep)
1da177e4 841{
7a857620 842 struct pxa25x_ep *ep;
1da177e4 843
7a857620 844 ep = container_of(_ep, struct pxa25x_ep, ep);
1da177e4 845 if (!_ep) {
441b62c1 846 DMSG("%s, bad ep\n", __func__);
1da177e4
LT
847 return -ENODEV;
848 }
849 /* pxa can't report unclaimed bytes from IN fifos */
850 if ((ep->bEndpointAddress & USB_DIR_IN) != 0)
851 return -EOPNOTSUPP;
852 if (ep->dev->gadget.speed == USB_SPEED_UNKNOWN
853 || (*ep->reg_udccs & UDCCS_BO_RFS) == 0)
854 return 0;
855 else
856 return (*ep->reg_ubcr & 0xfff) + 1;
857}
858
7a857620 859static void pxa25x_ep_fifo_flush(struct usb_ep *_ep)
1da177e4 860{
7a857620 861 struct pxa25x_ep *ep;
1da177e4 862
7a857620 863 ep = container_of(_ep, struct pxa25x_ep, ep);
1da177e4 864 if (!_ep || ep->ep.name == ep0name || !list_empty(&ep->queue)) {
441b62c1 865 DMSG("%s, bad ep\n", __func__);
1da177e4
LT
866 return;
867 }
868
869 /* toggle and halt bits stay unchanged */
870
871 /* for OUT, just read and discard the FIFO contents. */
872 if ((ep->bEndpointAddress & USB_DIR_IN) == 0) {
873 while (((*ep->reg_udccs) & UDCCS_BO_RNE) != 0)
874 (void) *ep->reg_uddr;
875 return;
876 }
877
878 /* most IN status is the same, but ISO can't stall */
879 *ep->reg_udccs = UDCCS_BI_TPC|UDCCS_BI_FTF|UDCCS_BI_TUR
22eb36f4
RK
880 | (ep->bmAttributes == USB_ENDPOINT_XFER_ISOC
881 ? 0 : UDCCS_BI_SST);
1da177e4
LT
882}
883
884
7a857620
PZ
885static struct usb_ep_ops pxa25x_ep_ops = {
886 .enable = pxa25x_ep_enable,
887 .disable = pxa25x_ep_disable,
1da177e4 888
7a857620
PZ
889 .alloc_request = pxa25x_ep_alloc_request,
890 .free_request = pxa25x_ep_free_request,
1da177e4 891
7a857620
PZ
892 .queue = pxa25x_ep_queue,
893 .dequeue = pxa25x_ep_dequeue,
1da177e4 894
7a857620
PZ
895 .set_halt = pxa25x_ep_set_halt,
896 .fifo_status = pxa25x_ep_fifo_status,
897 .fifo_flush = pxa25x_ep_fifo_flush,
1da177e4
LT
898};
899
900
901/* ---------------------------------------------------------------------------
34ebcd28 902 * device-scoped parts of the api to the usb controller hardware
1da177e4
LT
903 * ---------------------------------------------------------------------------
904 */
905
7a857620 906static int pxa25x_udc_get_frame(struct usb_gadget *_gadget)
1da177e4
LT
907{
908 return ((UFNRH & 0x07) << 8) | (UFNRL & 0xff);
909}
910
7a857620 911static int pxa25x_udc_wakeup(struct usb_gadget *_gadget)
1da177e4
LT
912{
913 /* host may not have enabled remote wakeup */
914 if ((UDCCS0 & UDCCS0_DRWF) == 0)
915 return -EHOSTUNREACH;
916 udc_set_mask_UDCCR(UDCCR_RSM);
917 return 0;
918}
919
7a857620
PZ
920static void stop_activity(struct pxa25x_udc *, struct usb_gadget_driver *);
921static void udc_enable (struct pxa25x_udc *);
922static void udc_disable(struct pxa25x_udc *);
1da177e4
LT
923
924/* We disable the UDC -- and its 48 MHz clock -- whenever it's not
34ebcd28 925 * in active use.
1da177e4 926 */
7a857620 927static int pullup(struct pxa25x_udc *udc)
1da177e4 928{
64cc2dd9 929 int is_active = udc->vbus && udc->pullup && !udc->suspended;
1da177e4 930 DMSG("%s\n", is_active ? "active" : "inactive");
64cc2dd9
DES
931 if (is_active) {
932 if (!udc->active) {
933 udc->active = 1;
934 /* Enable clock for USB device */
935 clk_enable(udc->clk);
936 udc_enable(udc);
1da177e4 937 }
64cc2dd9
DES
938 } else {
939 if (udc->active) {
940 if (udc->gadget.speed != USB_SPEED_UNKNOWN) {
941 DMSG("disconnect %s\n", udc->driver
942 ? udc->driver->driver.name
943 : "(no driver)");
944 stop_activity(udc, udc->driver);
945 }
946 udc_disable(udc);
947 /* Disable clock for USB device */
948 clk_disable(udc->clk);
949 udc->active = 0;
950 }
951
1da177e4
LT
952 }
953 return 0;
954}
955
956/* VBUS reporting logically comes from a transceiver */
7a857620 957static int pxa25x_udc_vbus_session(struct usb_gadget *_gadget, int is_active)
1da177e4 958{
7a857620 959 struct pxa25x_udc *udc;
1da177e4 960
7a857620 961 udc = container_of(_gadget, struct pxa25x_udc, gadget);
47fd6f7c 962 udc->vbus = is_active;
1da177e4 963 DMSG("vbus %s\n", is_active ? "supplied" : "inactive");
64cc2dd9 964 pullup(udc);
1da177e4
LT
965 return 0;
966}
967
968/* drivers may have software control over D+ pullup */
7a857620 969static int pxa25x_udc_pullup(struct usb_gadget *_gadget, int is_active)
1da177e4 970{
7a857620 971 struct pxa25x_udc *udc;
1da177e4 972
7a857620 973 udc = container_of(_gadget, struct pxa25x_udc, gadget);
1da177e4
LT
974
975 /* not all boards support pullup control */
56a075dc 976 if (!gpio_is_valid(udc->mach->gpio_pullup) && !udc->mach->udc_command)
1da177e4
LT
977 return -EOPNOTSUPP;
978
64cc2dd9
DES
979 udc->pullup = (is_active != 0);
980 pullup(udc);
1da177e4
LT
981 return 0;
982}
983
ab26d20f
PZ
984/* boards may consume current from VBUS, up to 100-500mA based on config.
985 * the 500uA suspend ceiling means that exclusively vbus-powered PXA designs
986 * violate USB specs.
987 */
988static int pxa25x_udc_vbus_draw(struct usb_gadget *_gadget, unsigned mA)
989{
990 struct pxa25x_udc *udc;
991
992 udc = container_of(_gadget, struct pxa25x_udc, gadget);
993
ded017ee 994 if (!IS_ERR_OR_NULL(udc->transceiver))
b96d3b08 995 return usb_phy_set_power(udc->transceiver, mA);
ab26d20f
PZ
996 return -EOPNOTSUPP;
997}
998
6166c246
FB
999static int pxa25x_udc_start(struct usb_gadget *g,
1000 struct usb_gadget_driver *driver);
1001static int pxa25x_udc_stop(struct usb_gadget *g,
1002 struct usb_gadget_driver *driver);
0f91349b 1003
7a857620
PZ
1004static const struct usb_gadget_ops pxa25x_udc_ops = {
1005 .get_frame = pxa25x_udc_get_frame,
1006 .wakeup = pxa25x_udc_wakeup,
1007 .vbus_session = pxa25x_udc_vbus_session,
1008 .pullup = pxa25x_udc_pullup,
ab26d20f 1009 .vbus_draw = pxa25x_udc_vbus_draw,
6166c246
FB
1010 .udc_start = pxa25x_udc_start,
1011 .udc_stop = pxa25x_udc_stop,
1da177e4
LT
1012};
1013
1014/*-------------------------------------------------------------------------*/
1015
040fa1b9 1016#ifdef CONFIG_USB_GADGET_DEBUG_FS
1da177e4
LT
1017
1018static int
64cc2dd9 1019udc_seq_show(struct seq_file *m, void *_d)
1da177e4 1020{
7a857620 1021 struct pxa25x_udc *dev = m->private;
1da177e4 1022 unsigned long flags;
040fa1b9 1023 int i;
1da177e4
LT
1024 u32 tmp;
1025
1da177e4
LT
1026 local_irq_save(flags);
1027
1028 /* basic device status */
040fa1b9 1029 seq_printf(m, DRIVER_DESC "\n"
1da177e4 1030 "%s version: %s\nGadget driver: %s\nHost %s\n\n",
ad8c623f 1031 driver_name, DRIVER_VERSION SIZE_STR "(pio)",
1da177e4 1032 dev->driver ? dev->driver->driver.name : "(none)",
a8ecc860 1033 dev->gadget.speed == USB_SPEED_FULL ? "full speed" : "disconnected");
1da177e4
LT
1034
1035 /* registers for device and ep0 */
040fa1b9 1036 seq_printf(m,
1da177e4
LT
1037 "uicr %02X.%02X, usir %02X.%02x, ufnr %02X.%02X\n",
1038 UICR1, UICR0, USIR1, USIR0, UFNRH, UFNRL);
1da177e4
LT
1039
1040 tmp = UDCCR;
040fa1b9 1041 seq_printf(m,
1da177e4
LT
1042 "udccr %02X =%s%s%s%s%s%s%s%s\n", tmp,
1043 (tmp & UDCCR_REM) ? " rem" : "",
1044 (tmp & UDCCR_RSTIR) ? " rstir" : "",
1045 (tmp & UDCCR_SRM) ? " srm" : "",
1046 (tmp & UDCCR_SUSIR) ? " susir" : "",
1047 (tmp & UDCCR_RESIR) ? " resir" : "",
1048 (tmp & UDCCR_RSM) ? " rsm" : "",
1049 (tmp & UDCCR_UDA) ? " uda" : "",
1050 (tmp & UDCCR_UDE) ? " ude" : "");
1da177e4
LT
1051
1052 tmp = UDCCS0;
040fa1b9 1053 seq_printf(m,
1da177e4
LT
1054 "udccs0 %02X =%s%s%s%s%s%s%s%s\n", tmp,
1055 (tmp & UDCCS0_SA) ? " sa" : "",
1056 (tmp & UDCCS0_RNE) ? " rne" : "",
1057 (tmp & UDCCS0_FST) ? " fst" : "",
1058 (tmp & UDCCS0_SST) ? " sst" : "",
1059 (tmp & UDCCS0_DRWF) ? " dwrf" : "",
1060 (tmp & UDCCS0_FTF) ? " ftf" : "",
1061 (tmp & UDCCS0_IPR) ? " ipr" : "",
1062 (tmp & UDCCS0_OPR) ? " opr" : "");
1da177e4
LT
1063
1064 if (dev->has_cfr) {
1065 tmp = UDCCFR;
040fa1b9 1066 seq_printf(m,
1da177e4
LT
1067 "udccfr %02X =%s%s\n", tmp,
1068 (tmp & UDCCFR_AREN) ? " aren" : "",
1069 (tmp & UDCCFR_ACM) ? " acm" : "");
1da177e4
LT
1070 }
1071
a8ecc860 1072 if (dev->gadget.speed != USB_SPEED_FULL || !dev->driver)
1da177e4
LT
1073 goto done;
1074
040fa1b9 1075 seq_printf(m, "ep0 IN %lu/%lu, OUT %lu/%lu\nirqs %lu\n\n",
1da177e4
LT
1076 dev->stats.write.bytes, dev->stats.write.ops,
1077 dev->stats.read.bytes, dev->stats.read.ops,
1078 dev->stats.irqs);
1da177e4
LT
1079
1080 /* dump endpoint queues */
1081 for (i = 0; i < PXA_UDC_NUM_ENDPOINTS; i++) {
7a857620
PZ
1082 struct pxa25x_ep *ep = &dev->ep [i];
1083 struct pxa25x_request *req;
1da177e4
LT
1084
1085 if (i != 0) {
040fa1b9 1086 const struct usb_endpoint_descriptor *desc;
1da177e4 1087
c18800d8 1088 desc = ep->ep.desc;
040fa1b9 1089 if (!desc)
1da177e4
LT
1090 continue;
1091 tmp = *dev->ep [i].reg_udccs;
040fa1b9 1092 seq_printf(m,
ad8c623f 1093 "%s max %d %s udccs %02x irqs %lu\n",
29cc8897 1094 ep->ep.name, usb_endpoint_maxp(desc),
ad8c623f 1095 "pio", tmp, ep->pio_irqs);
1da177e4
LT
1096 /* TODO translate all five groups of udccs bits! */
1097
1098 } else /* ep0 should only have one transfer queued */
040fa1b9 1099 seq_printf(m, "ep0 max 16 pio irqs %lu\n",
1da177e4 1100 ep->pio_irqs);
1da177e4
LT
1101
1102 if (list_empty(&ep->queue)) {
040fa1b9 1103 seq_printf(m, "\t(nothing queued)\n");
1da177e4
LT
1104 continue;
1105 }
1106 list_for_each_entry(req, &ep->queue, queue) {
040fa1b9 1107 seq_printf(m,
1da177e4
LT
1108 "\treq %p len %d/%d buf %p\n",
1109 &req->req, req->req.actual,
1110 req->req.length, req->req.buf);
1da177e4
LT
1111 }
1112 }
1113
1114done:
1115 local_irq_restore(flags);
040fa1b9 1116 return 0;
1da177e4
LT
1117}
1118
040fa1b9
DES
1119static int
1120udc_debugfs_open(struct inode *inode, struct file *file)
1121{
1122 return single_open(file, udc_seq_show, inode->i_private);
1123}
1124
1125static const struct file_operations debug_fops = {
1126 .open = udc_debugfs_open,
1127 .read = seq_read,
1128 .llseek = seq_lseek,
1129 .release = single_release,
1130 .owner = THIS_MODULE,
1131};
1132
1133#define create_debug_files(dev) \
1134 do { \
1135 dev->debugfs_udc = debugfs_create_file(dev->gadget.name, \
1136 S_IRUGO, NULL, dev, &debug_fops); \
1137 } while (0)
1138#define remove_debug_files(dev) \
1139 do { \
1140 if (dev->debugfs_udc) \
1141 debugfs_remove(dev->debugfs_udc); \
1142 } while (0)
1da177e4
LT
1143
1144#else /* !CONFIG_USB_GADGET_DEBUG_FILES */
1145
040fa1b9
DES
1146#define create_debug_files(dev) do {} while (0)
1147#define remove_debug_files(dev) do {} while (0)
1da177e4
LT
1148
1149#endif /* CONFIG_USB_GADGET_DEBUG_FILES */
1150
1da177e4
LT
1151/*-------------------------------------------------------------------------*/
1152
1153/*
34ebcd28 1154 * udc_disable - disable USB device controller
1da177e4 1155 */
7a857620 1156static void udc_disable(struct pxa25x_udc *dev)
1da177e4
LT
1157{
1158 /* block all irqs */
1159 udc_set_mask_UDCCR(UDCCR_SRM|UDCCR_REM);
1160 UICR0 = UICR1 = 0xff;
1161 UFNRH = UFNRH_SIM;
1162
1163 /* if hardware supports it, disconnect from usb */
91987693 1164 pullup_off();
1da177e4
LT
1165
1166 udc_clear_mask_UDCCR(UDCCR_UDE);
1167
1da177e4
LT
1168 ep0_idle (dev);
1169 dev->gadget.speed = USB_SPEED_UNKNOWN;
1da177e4
LT
1170}
1171
1172
1173/*
34ebcd28 1174 * udc_reinit - initialize software state
1da177e4 1175 */
7a857620 1176static void udc_reinit(struct pxa25x_udc *dev)
1da177e4
LT
1177{
1178 u32 i;
1179
1180 /* device/ep0 records init */
1181 INIT_LIST_HEAD (&dev->gadget.ep_list);
1182 INIT_LIST_HEAD (&dev->gadget.ep0->ep_list);
1183 dev->ep0state = EP0_IDLE;
1184
1185 /* basic endpoint records init */
1186 for (i = 0; i < PXA_UDC_NUM_ENDPOINTS; i++) {
7a857620 1187 struct pxa25x_ep *ep = &dev->ep[i];
1da177e4
LT
1188
1189 if (i != 0)
1190 list_add_tail (&ep->ep.ep_list, &dev->gadget.ep_list);
1191
f9c56cdd 1192 ep->ep.desc = NULL;
1da177e4
LT
1193 ep->stopped = 0;
1194 INIT_LIST_HEAD (&ep->queue);
ad8c623f 1195 ep->pio_irqs = 0;
1da177e4
LT
1196 }
1197
1198 /* the rest was statically initialized, and is read-only */
1199}
1200
1201/* until it's enabled, this UDC should be completely invisible
1202 * to any USB host.
1203 */
7a857620 1204static void udc_enable (struct pxa25x_udc *dev)
1da177e4
LT
1205{
1206 udc_clear_mask_UDCCR(UDCCR_UDE);
1207
1da177e4
LT
1208 /* try to clear these bits before we enable the udc */
1209 udc_ack_int_UDCCR(UDCCR_SUSIR|/*UDCCR_RSTIR|*/UDCCR_RESIR);
1210
1211 ep0_idle(dev);
1212 dev->gadget.speed = USB_SPEED_UNKNOWN;
1213 dev->stats.irqs = 0;
1214
1215 /*
1216 * sequence taken from chapter 12.5.10, PXA250 AppProcDevManual:
1217 * - enable UDC
1218 * - if RESET is already in progress, ack interrupt
1219 * - unmask reset interrupt
1220 */
1221 udc_set_mask_UDCCR(UDCCR_UDE);
1222 if (!(UDCCR & UDCCR_UDA))
1223 udc_ack_int_UDCCR(UDCCR_RSTIR);
1224
1225 if (dev->has_cfr /* UDC_RES2 is defined */) {
1226 /* pxa255 (a0+) can avoid a set_config race that could
1227 * prevent gadget drivers from configuring correctly
1228 */
1229 UDCCFR = UDCCFR_ACM | UDCCFR_MB1;
1230 } else {
1231 /* "USB test mode" for pxa250 errata 40-42 (stepping a0, a1)
1232 * which could result in missing packets and interrupts.
1233 * supposedly one bit per endpoint, controlling whether it
1234 * double buffers or not; ACM/AREN bits fit into the holes.
1235 * zero bits (like USIR0_IRx) disable double buffering.
1236 */
1237 UDC_RES1 = 0x00;
1238 UDC_RES2 = 0x00;
1239 }
1240
1da177e4
LT
1241 /* enable suspend/resume and reset irqs */
1242 udc_clear_mask_UDCCR(UDCCR_SRM | UDCCR_REM);
1243
1244 /* enable ep0 irqs */
1245 UICR0 &= ~UICR0_IM0;
1246
1247 /* if hardware supports it, pullup D+ and wait for reset */
91987693 1248 pullup_on();
1da177e4
LT
1249}
1250
1251
1252/* when a driver is successfully registered, it will receive
1253 * control requests including set_configuration(), which enables
1254 * non-control requests. then usb traffic follows until a
1255 * disconnect is reported. then a host may connect again, or
1256 * the driver might get unbound.
1257 */
6166c246
FB
1258static int pxa25x_udc_start(struct usb_gadget *g,
1259 struct usb_gadget_driver *driver)
1da177e4 1260{
6166c246 1261 struct pxa25x_udc *dev = to_pxa25x(g);
1da177e4
LT
1262 int retval;
1263
1da177e4
LT
1264 /* first hook up the driver ... */
1265 dev->driver = driver;
1266 dev->gadget.dev.driver = &driver->driver;
1267 dev->pullup = 1;
1268
1da177e4
LT
1269 /* ... then enable host detection and ep0; and we're ready
1270 * for set_configuration as well as eventual disconnect.
1271 */
ab26d20f 1272 /* connect to bus through transceiver */
ded017ee 1273 if (!IS_ERR_OR_NULL(dev->transceiver)) {
6e13c650
HK
1274 retval = otg_set_peripheral(dev->transceiver->otg,
1275 &dev->gadget);
6166c246 1276 if (retval)
ab26d20f 1277 goto bind_fail;
ab26d20f
PZ
1278 }
1279
64cc2dd9 1280 pullup(dev);
1da177e4
LT
1281 dump_state(dev);
1282 return 0;
ab26d20f
PZ
1283bind_fail:
1284 return retval;
1da177e4 1285}
1da177e4
LT
1286
1287static void
7a857620 1288stop_activity(struct pxa25x_udc *dev, struct usb_gadget_driver *driver)
1da177e4
LT
1289{
1290 int i;
1291
1292 /* don't disconnect drivers more than once */
1293 if (dev->gadget.speed == USB_SPEED_UNKNOWN)
1294 driver = NULL;
1295 dev->gadget.speed = USB_SPEED_UNKNOWN;
1296
1297 /* prevent new request submissions, kill any outstanding requests */
1298 for (i = 0; i < PXA_UDC_NUM_ENDPOINTS; i++) {
7a857620 1299 struct pxa25x_ep *ep = &dev->ep[i];
1da177e4
LT
1300
1301 ep->stopped = 1;
1302 nuke(ep, -ESHUTDOWN);
1303 }
1304 del_timer_sync(&dev->timer);
1305
66e4afc7
FB
1306 /* report disconnect; the driver is already quiesced */
1307 if (driver)
1308 driver->disconnect(&dev->gadget);
1309
1da177e4
LT
1310 /* re-init driver-visible data structures */
1311 udc_reinit(dev);
1312}
1313
6166c246
FB
1314static int pxa25x_udc_stop(struct usb_gadget*g,
1315 struct usb_gadget_driver *driver)
1da177e4 1316{
6166c246 1317 struct pxa25x_udc *dev = to_pxa25x(g);
1da177e4
LT
1318
1319 local_irq_disable();
64cc2dd9
DES
1320 dev->pullup = 0;
1321 pullup(dev);
1da177e4
LT
1322 stop_activity(dev, driver);
1323 local_irq_enable();
1324
ded017ee 1325 if (!IS_ERR_OR_NULL(dev->transceiver))
6e13c650 1326 (void) otg_set_peripheral(dev->transceiver->otg, NULL);
ab26d20f 1327
eb0be47d 1328 dev->gadget.dev.driver = NULL;
1da177e4
LT
1329 dev->driver = NULL;
1330
1da177e4 1331 dump_state(dev);
6166c246 1332
1da177e4
LT
1333 return 0;
1334}
1da177e4
LT
1335
1336/*-------------------------------------------------------------------------*/
1337
1338#ifdef CONFIG_ARCH_LUBBOCK
1339
1340/* Lubbock has separate connect and disconnect irqs. More typical designs
1341 * use one GPIO as the VBUS IRQ, and another to control the D+ pullup.
1342 */
1343
1344static irqreturn_t
7d12e780 1345lubbock_vbus_irq(int irq, void *_dev)
1da177e4 1346{
7a857620 1347 struct pxa25x_udc *dev = _dev;
1da177e4
LT
1348 int vbus;
1349
1350 dev->stats.irqs++;
1da177e4
LT
1351 switch (irq) {
1352 case LUBBOCK_USB_IRQ:
1da177e4
LT
1353 vbus = 1;
1354 disable_irq(LUBBOCK_USB_IRQ);
1355 enable_irq(LUBBOCK_USB_DISC_IRQ);
1356 break;
1357 case LUBBOCK_USB_DISC_IRQ:
1da177e4
LT
1358 vbus = 0;
1359 disable_irq(LUBBOCK_USB_DISC_IRQ);
1360 enable_irq(LUBBOCK_USB_IRQ);
1361 break;
1362 default:
1363 return IRQ_NONE;
1364 }
1365
7a857620 1366 pxa25x_udc_vbus_session(&dev->gadget, vbus);
1da177e4
LT
1367 return IRQ_HANDLED;
1368}
1369
1370#endif
1371
1372
1373/*-------------------------------------------------------------------------*/
1374
7a857620 1375static inline void clear_ep_state (struct pxa25x_udc *dev)
1da177e4
LT
1376{
1377 unsigned i;
1378
1379 /* hardware SET_{CONFIGURATION,INTERFACE} automagic resets endpoint
1380 * fifos, and pending transactions mustn't be continued in any case.
1381 */
1382 for (i = 1; i < PXA_UDC_NUM_ENDPOINTS; i++)
1383 nuke(&dev->ep[i], -ECONNABORTED);
1384}
1385
1386static void udc_watchdog(unsigned long _dev)
1387{
7a857620 1388 struct pxa25x_udc *dev = (void *)_dev;
1da177e4
LT
1389
1390 local_irq_disable();
1391 if (dev->ep0state == EP0_STALL
1392 && (UDCCS0 & UDCCS0_FST) == 0
1393 && (UDCCS0 & UDCCS0_SST) == 0) {
1394 UDCCS0 = UDCCS0_FST|UDCCS0_FTF;
1395 DBG(DBG_VERBOSE, "ep0 re-stall\n");
1396 start_watchdog(dev);
1397 }
1398 local_irq_enable();
1399}
1400
7a857620 1401static void handle_ep0 (struct pxa25x_udc *dev)
1da177e4
LT
1402{
1403 u32 udccs0 = UDCCS0;
7a857620
PZ
1404 struct pxa25x_ep *ep = &dev->ep [0];
1405 struct pxa25x_request *req;
1da177e4
LT
1406 union {
1407 struct usb_ctrlrequest r;
1408 u8 raw [8];
1409 u32 word [2];
1410 } u;
1411
1412 if (list_empty(&ep->queue))
1413 req = NULL;
1414 else
7a857620 1415 req = list_entry(ep->queue.next, struct pxa25x_request, queue);
1da177e4
LT
1416
1417 /* clear stall status */
1418 if (udccs0 & UDCCS0_SST) {
1419 nuke(ep, -EPIPE);
1420 UDCCS0 = UDCCS0_SST;
1421 del_timer(&dev->timer);
1422 ep0_idle(dev);
1423 }
1424
1425 /* previous request unfinished? non-error iff back-to-back ... */
1426 if ((udccs0 & UDCCS0_SA) != 0 && dev->ep0state != EP0_IDLE) {
1427 nuke(ep, 0);
1428 del_timer(&dev->timer);
1429 ep0_idle(dev);
1430 }
1431
1432 switch (dev->ep0state) {
1433 case EP0_IDLE:
1434 /* late-breaking status? */
1435 udccs0 = UDCCS0;
1436
1437 /* start control request? */
1438 if (likely((udccs0 & (UDCCS0_OPR|UDCCS0_SA|UDCCS0_RNE))
1439 == (UDCCS0_OPR|UDCCS0_SA|UDCCS0_RNE))) {
1440 int i;
1441
1442 nuke (ep, -EPROTO);
1443
1444 /* read SETUP packet */
1445 for (i = 0; i < 8; i++) {
1446 if (unlikely(!(UDCCS0 & UDCCS0_RNE))) {
1447bad_setup:
1448 DMSG("SETUP %d!\n", i);
1449 goto stall;
1450 }
1451 u.raw [i] = (u8) UDDR0;
1452 }
1453 if (unlikely((UDCCS0 & UDCCS0_RNE) != 0))
1454 goto bad_setup;
1455
1456got_setup:
1457 DBG(DBG_VERBOSE, "SETUP %02x.%02x v%04x i%04x l%04x\n",
1458 u.r.bRequestType, u.r.bRequest,
1459 le16_to_cpu(u.r.wValue),
1460 le16_to_cpu(u.r.wIndex),
1461 le16_to_cpu(u.r.wLength));
1462
1463 /* cope with automagic for some standard requests. */
1464 dev->req_std = (u.r.bRequestType & USB_TYPE_MASK)
1465 == USB_TYPE_STANDARD;
1466 dev->req_config = 0;
1467 dev->req_pending = 1;
1468 switch (u.r.bRequest) {
1469 /* hardware restricts gadget drivers here! */
1470 case USB_REQ_SET_CONFIGURATION:
1471 if (u.r.bRequestType == USB_RECIP_DEVICE) {
1472 /* reflect hardware's automagic
1473 * up to the gadget driver.
1474 */
1475config_change:
1476 dev->req_config = 1;
1477 clear_ep_state(dev);
1478 /* if !has_cfr, there's no synch
1479 * else use AREN (later) not SA|OPR
1480 * USIR0_IR0 acts edge sensitive
1481 */
1482 }
1483 break;
1484 /* ... and here, even more ... */
1485 case USB_REQ_SET_INTERFACE:
1486 if (u.r.bRequestType == USB_RECIP_INTERFACE) {
1487 /* udc hardware is broken by design:
1488 * - altsetting may only be zero;
1489 * - hw resets all interfaces' eps;
1490 * - ep reset doesn't include halt(?).
1491 */
1492 DMSG("broken set_interface (%d/%d)\n",
1493 le16_to_cpu(u.r.wIndex),
1494 le16_to_cpu(u.r.wValue));
1495 goto config_change;
1496 }
1497 break;
1498 /* hardware was supposed to hide this */
1499 case USB_REQ_SET_ADDRESS:
1500 if (u.r.bRequestType == USB_RECIP_DEVICE) {
1501 ep0start(dev, 0, "address");
1502 return;
1503 }
1504 break;
1505 }
1506
1507 if (u.r.bRequestType & USB_DIR_IN)
1508 dev->ep0state = EP0_IN_DATA_PHASE;
1509 else
1510 dev->ep0state = EP0_OUT_DATA_PHASE;
1511
1512 i = dev->driver->setup(&dev->gadget, &u.r);
1513 if (i < 0) {
1514 /* hardware automagic preventing STALL... */
1515 if (dev->req_config) {
1516 /* hardware sometimes neglects to tell
1517 * tell us about config change events,
1518 * so later ones may fail...
1519 */
b6c63937 1520 WARNING("config change %02x fail %d?\n",
1da177e4
LT
1521 u.r.bRequest, i);
1522 return;
1523 /* TODO experiment: if has_cfr,
1524 * hardware didn't ACK; maybe we
1525 * could actually STALL!
1526 */
1527 }
1528 DBG(DBG_VERBOSE, "protocol STALL, "
1529 "%02x err %d\n", UDCCS0, i);
1530stall:
1531 /* the watchdog timer helps deal with cases
1532 * where udc seems to clear FST wrongly, and
1533 * then NAKs instead of STALLing.
1534 */
1535 ep0start(dev, UDCCS0_FST|UDCCS0_FTF, "stall");
1536 start_watchdog(dev);
1537 dev->ep0state = EP0_STALL;
1538
1539 /* deferred i/o == no response yet */
1540 } else if (dev->req_pending) {
1541 if (likely(dev->ep0state == EP0_IN_DATA_PHASE
1542 || dev->req_std || u.r.wLength))
1543 ep0start(dev, 0, "defer");
1544 else
1545 ep0start(dev, UDCCS0_IPR, "defer/IPR");
1546 }
1547
1548 /* expect at least one data or status stage irq */
1549 return;
1550
1551 } else if (likely((udccs0 & (UDCCS0_OPR|UDCCS0_SA))
1552 == (UDCCS0_OPR|UDCCS0_SA))) {
1553 unsigned i;
1554
1555 /* pxa210/250 erratum 131 for B0/B1 says RNE lies.
1556 * still observed on a pxa255 a0.
1557 */
1558 DBG(DBG_VERBOSE, "e131\n");
1559 nuke(ep, -EPROTO);
1560
1561 /* read SETUP data, but don't trust it too much */
1562 for (i = 0; i < 8; i++)
1563 u.raw [i] = (u8) UDDR0;
1564 if ((u.r.bRequestType & USB_RECIP_MASK)
1565 > USB_RECIP_OTHER)
1566 goto stall;
1567 if (u.word [0] == 0 && u.word [1] == 0)
1568 goto stall;
1569 goto got_setup;
1570 } else {
1571 /* some random early IRQ:
1572 * - we acked FST
1573 * - IPR cleared
1574 * - OPR got set, without SA (likely status stage)
1575 */
1576 UDCCS0 = udccs0 & (UDCCS0_SA|UDCCS0_OPR);
1577 }
1578 break;
1579 case EP0_IN_DATA_PHASE: /* GET_DESCRIPTOR etc */
1580 if (udccs0 & UDCCS0_OPR) {
1581 UDCCS0 = UDCCS0_OPR|UDCCS0_FTF;
1582 DBG(DBG_VERBOSE, "ep0in premature status\n");
1583 if (req)
1584 done(ep, req, 0);
1585 ep0_idle(dev);
1586 } else /* irq was IPR clearing */ {
1587 if (req) {
1588 /* this IN packet might finish the request */
1589 (void) write_ep0_fifo(ep, req);
1590 } /* else IN token before response was written */
1591 }
1592 break;
1593 case EP0_OUT_DATA_PHASE: /* SET_DESCRIPTOR etc */
1594 if (udccs0 & UDCCS0_OPR) {
1595 if (req) {
1596 /* this OUT packet might finish the request */
1597 if (read_ep0_fifo(ep, req))
1598 done(ep, req, 0);
1599 /* else more OUT packets expected */
1600 } /* else OUT token before read was issued */
1601 } else /* irq was IPR clearing */ {
1602 DBG(DBG_VERBOSE, "ep0out premature status\n");
1603 if (req)
1604 done(ep, req, 0);
1605 ep0_idle(dev);
1606 }
1607 break;
1608 case EP0_END_XFER:
1609 if (req)
1610 done(ep, req, 0);
1611 /* ack control-IN status (maybe in-zlp was skipped)
1612 * also appears after some config change events.
1613 */
1614 if (udccs0 & UDCCS0_OPR)
1615 UDCCS0 = UDCCS0_OPR;
1616 ep0_idle(dev);
1617 break;
1618 case EP0_STALL:
1619 UDCCS0 = UDCCS0_FST;
1620 break;
1621 }
1622 USIR0 = USIR0_IR0;
1623}
1624
7a857620 1625static void handle_ep(struct pxa25x_ep *ep)
1da177e4 1626{
7a857620 1627 struct pxa25x_request *req;
1da177e4
LT
1628 int is_in = ep->bEndpointAddress & USB_DIR_IN;
1629 int completed;
1630 u32 udccs, tmp;
1631
1632 do {
1633 completed = 0;
1634 if (likely (!list_empty(&ep->queue)))
1635 req = list_entry(ep->queue.next,
7a857620 1636 struct pxa25x_request, queue);
1da177e4
LT
1637 else
1638 req = NULL;
1639
1640 // TODO check FST handling
1641
1642 udccs = *ep->reg_udccs;
1643 if (unlikely(is_in)) { /* irq from TPC, SST, or (ISO) TUR */
1644 tmp = UDCCS_BI_TUR;
1645 if (likely(ep->bmAttributes == USB_ENDPOINT_XFER_BULK))
1646 tmp |= UDCCS_BI_SST;
1647 tmp &= udccs;
1648 if (likely (tmp))
1649 *ep->reg_udccs = tmp;
1650 if (req && likely ((udccs & UDCCS_BI_TFS) != 0))
1651 completed = write_fifo(ep, req);
1652
1653 } else { /* irq from RPC (or for ISO, ROF) */
1654 if (likely(ep->bmAttributes == USB_ENDPOINT_XFER_BULK))
1655 tmp = UDCCS_BO_SST | UDCCS_BO_DME;
1656 else
1657 tmp = UDCCS_IO_ROF | UDCCS_IO_DME;
1658 tmp &= udccs;
1659 if (likely(tmp))
1660 *ep->reg_udccs = tmp;
1661
1662 /* fifos can hold packets, ready for reading... */
1663 if (likely(req)) {
1da177e4
LT
1664 completed = read_fifo(ep, req);
1665 } else
1666 pio_irq_disable (ep->bEndpointAddress);
1667 }
1668 ep->pio_irqs++;
1669 } while (completed);
1670}
1671
1672/*
7a857620 1673 * pxa25x_udc_irq - interrupt handler
1da177e4
LT
1674 *
1675 * avoid delays in ep0 processing. the control handshaking isn't always
1676 * under software control (pxa250c0 and the pxa255 are better), and delays
1677 * could cause usb protocol errors.
1678 */
1679static irqreturn_t
7a857620 1680pxa25x_udc_irq(int irq, void *_dev)
1da177e4 1681{
7a857620 1682 struct pxa25x_udc *dev = _dev;
1da177e4
LT
1683 int handled;
1684
1685 dev->stats.irqs++;
1da177e4
LT
1686 do {
1687 u32 udccr = UDCCR;
1688
1689 handled = 0;
1690
1691 /* SUSpend Interrupt Request */
1692 if (unlikely(udccr & UDCCR_SUSIR)) {
1693 udc_ack_int_UDCCR(UDCCR_SUSIR);
1694 handled = 1;
a8ecc860 1695 DBG(DBG_VERBOSE, "USB suspend\n");
1da177e4 1696
a8ecc860 1697 if (dev->gadget.speed != USB_SPEED_UNKNOWN
1da177e4
LT
1698 && dev->driver
1699 && dev->driver->suspend)
1700 dev->driver->suspend(&dev->gadget);
1701 ep0_idle (dev);
1702 }
1703
1704 /* RESume Interrupt Request */
1705 if (unlikely(udccr & UDCCR_RESIR)) {
1706 udc_ack_int_UDCCR(UDCCR_RESIR);
1707 handled = 1;
1708 DBG(DBG_VERBOSE, "USB resume\n");
1709
1710 if (dev->gadget.speed != USB_SPEED_UNKNOWN
1711 && dev->driver
a8ecc860 1712 && dev->driver->resume)
1da177e4
LT
1713 dev->driver->resume(&dev->gadget);
1714 }
1715
1716 /* ReSeT Interrupt Request - USB reset */
1717 if (unlikely(udccr & UDCCR_RSTIR)) {
1718 udc_ack_int_UDCCR(UDCCR_RSTIR);
1719 handled = 1;
1720
1721 if ((UDCCR & UDCCR_UDA) == 0) {
1722 DBG(DBG_VERBOSE, "USB reset start\n");
1723
1724 /* reset driver and endpoints,
1725 * in case that's not yet done
1726 */
1727 stop_activity (dev, dev->driver);
1728
1729 } else {
1730 DBG(DBG_VERBOSE, "USB reset end\n");
1731 dev->gadget.speed = USB_SPEED_FULL;
1da177e4
LT
1732 memset(&dev->stats, 0, sizeof dev->stats);
1733 /* driver and endpoints are still reset */
1734 }
1735
1736 } else {
1737 u32 usir0 = USIR0 & ~UICR0;
1738 u32 usir1 = USIR1 & ~UICR1;
1739 int i;
1740
1741 if (unlikely (!usir0 && !usir1))
1742 continue;
1743
1744 DBG(DBG_VERY_NOISY, "irq %02x.%02x\n", usir1, usir0);
1745
1746 /* control traffic */
1747 if (usir0 & USIR0_IR0) {
1748 dev->ep[0].pio_irqs++;
1749 handle_ep0(dev);
1750 handled = 1;
1751 }
1752
1753 /* endpoint data transfers */
1754 for (i = 0; i < 8; i++) {
1755 u32 tmp = 1 << i;
1756
1757 if (i && (usir0 & tmp)) {
1758 handle_ep(&dev->ep[i]);
1759 USIR0 |= tmp;
1760 handled = 1;
1761 }
6d84599b 1762#ifndef CONFIG_USB_PXA25X_SMALL
1da177e4
LT
1763 if (usir1 & tmp) {
1764 handle_ep(&dev->ep[i+8]);
1765 USIR1 |= tmp;
1766 handled = 1;
1767 }
6d84599b 1768#endif
1da177e4
LT
1769 }
1770 }
1771
1772 /* we could also ask for 1 msec SOF (SIR) interrupts */
1773
1774 } while (handled);
1775 return IRQ_HANDLED;
1776}
1777
1778/*-------------------------------------------------------------------------*/
1779
1780static void nop_release (struct device *dev)
1781{
7071a3ce 1782 DMSG("%s %s\n", __func__, dev_name(dev));
1da177e4
LT
1783}
1784
1785/* this uses load-time allocation and initialization (instead of
1786 * doing it at run-time) to save code, eliminate fault paths, and
1787 * be more obviously correct.
1788 */
7a857620 1789static struct pxa25x_udc memory = {
1da177e4 1790 .gadget = {
7a857620 1791 .ops = &pxa25x_udc_ops,
1da177e4
LT
1792 .ep0 = &memory.ep[0].ep,
1793 .name = driver_name,
1794 .dev = {
c682b170 1795 .init_name = "gadget",
1da177e4
LT
1796 .release = nop_release,
1797 },
1798 },
1799
1800 /* control endpoint */
1801 .ep[0] = {
1802 .ep = {
1803 .name = ep0name,
7a857620 1804 .ops = &pxa25x_ep_ops,
1da177e4
LT
1805 .maxpacket = EP0_FIFO_SIZE,
1806 },
1807 .dev = &memory,
1808 .reg_udccs = &UDCCS0,
1809 .reg_uddr = &UDDR0,
1810 },
1811
1812 /* first group of endpoints */
1813 .ep[1] = {
1814 .ep = {
1815 .name = "ep1in-bulk",
7a857620 1816 .ops = &pxa25x_ep_ops,
1da177e4
LT
1817 .maxpacket = BULK_FIFO_SIZE,
1818 },
1819 .dev = &memory,
1820 .fifo_size = BULK_FIFO_SIZE,
1821 .bEndpointAddress = USB_DIR_IN | 1,
1822 .bmAttributes = USB_ENDPOINT_XFER_BULK,
1823 .reg_udccs = &UDCCS1,
1824 .reg_uddr = &UDDR1,
1da177e4
LT
1825 },
1826 .ep[2] = {
1827 .ep = {
1828 .name = "ep2out-bulk",
7a857620 1829 .ops = &pxa25x_ep_ops,
1da177e4
LT
1830 .maxpacket = BULK_FIFO_SIZE,
1831 },
1832 .dev = &memory,
1833 .fifo_size = BULK_FIFO_SIZE,
1834 .bEndpointAddress = 2,
1835 .bmAttributes = USB_ENDPOINT_XFER_BULK,
1836 .reg_udccs = &UDCCS2,
1837 .reg_ubcr = &UBCR2,
1838 .reg_uddr = &UDDR2,
1da177e4 1839 },
7a857620 1840#ifndef CONFIG_USB_PXA25X_SMALL
1da177e4
LT
1841 .ep[3] = {
1842 .ep = {
1843 .name = "ep3in-iso",
7a857620 1844 .ops = &pxa25x_ep_ops,
1da177e4
LT
1845 .maxpacket = ISO_FIFO_SIZE,
1846 },
1847 .dev = &memory,
1848 .fifo_size = ISO_FIFO_SIZE,
1849 .bEndpointAddress = USB_DIR_IN | 3,
1850 .bmAttributes = USB_ENDPOINT_XFER_ISOC,
1851 .reg_udccs = &UDCCS3,
1852 .reg_uddr = &UDDR3,
1da177e4
LT
1853 },
1854 .ep[4] = {
1855 .ep = {
1856 .name = "ep4out-iso",
7a857620 1857 .ops = &pxa25x_ep_ops,
1da177e4
LT
1858 .maxpacket = ISO_FIFO_SIZE,
1859 },
1860 .dev = &memory,
1861 .fifo_size = ISO_FIFO_SIZE,
1862 .bEndpointAddress = 4,
1863 .bmAttributes = USB_ENDPOINT_XFER_ISOC,
1864 .reg_udccs = &UDCCS4,
1865 .reg_ubcr = &UBCR4,
1866 .reg_uddr = &UDDR4,
1da177e4
LT
1867 },
1868 .ep[5] = {
1869 .ep = {
1870 .name = "ep5in-int",
7a857620 1871 .ops = &pxa25x_ep_ops,
1da177e4
LT
1872 .maxpacket = INT_FIFO_SIZE,
1873 },
1874 .dev = &memory,
1875 .fifo_size = INT_FIFO_SIZE,
1876 .bEndpointAddress = USB_DIR_IN | 5,
1877 .bmAttributes = USB_ENDPOINT_XFER_INT,
1878 .reg_udccs = &UDCCS5,
1879 .reg_uddr = &UDDR5,
1880 },
1881
1882 /* second group of endpoints */
1883 .ep[6] = {
1884 .ep = {
1885 .name = "ep6in-bulk",
7a857620 1886 .ops = &pxa25x_ep_ops,
1da177e4
LT
1887 .maxpacket = BULK_FIFO_SIZE,
1888 },
1889 .dev = &memory,
1890 .fifo_size = BULK_FIFO_SIZE,
1891 .bEndpointAddress = USB_DIR_IN | 6,
1892 .bmAttributes = USB_ENDPOINT_XFER_BULK,
1893 .reg_udccs = &UDCCS6,
1894 .reg_uddr = &UDDR6,
1da177e4
LT
1895 },
1896 .ep[7] = {
1897 .ep = {
1898 .name = "ep7out-bulk",
7a857620 1899 .ops = &pxa25x_ep_ops,
1da177e4
LT
1900 .maxpacket = BULK_FIFO_SIZE,
1901 },
1902 .dev = &memory,
1903 .fifo_size = BULK_FIFO_SIZE,
1904 .bEndpointAddress = 7,
1905 .bmAttributes = USB_ENDPOINT_XFER_BULK,
1906 .reg_udccs = &UDCCS7,
1907 .reg_ubcr = &UBCR7,
1908 .reg_uddr = &UDDR7,
1da177e4
LT
1909 },
1910 .ep[8] = {
1911 .ep = {
1912 .name = "ep8in-iso",
7a857620 1913 .ops = &pxa25x_ep_ops,
1da177e4
LT
1914 .maxpacket = ISO_FIFO_SIZE,
1915 },
1916 .dev = &memory,
1917 .fifo_size = ISO_FIFO_SIZE,
1918 .bEndpointAddress = USB_DIR_IN | 8,
1919 .bmAttributes = USB_ENDPOINT_XFER_ISOC,
1920 .reg_udccs = &UDCCS8,
1921 .reg_uddr = &UDDR8,
1da177e4
LT
1922 },
1923 .ep[9] = {
1924 .ep = {
1925 .name = "ep9out-iso",
7a857620 1926 .ops = &pxa25x_ep_ops,
1da177e4
LT
1927 .maxpacket = ISO_FIFO_SIZE,
1928 },
1929 .dev = &memory,
1930 .fifo_size = ISO_FIFO_SIZE,
1931 .bEndpointAddress = 9,
1932 .bmAttributes = USB_ENDPOINT_XFER_ISOC,
1933 .reg_udccs = &UDCCS9,
1934 .reg_ubcr = &UBCR9,
1935 .reg_uddr = &UDDR9,
1da177e4
LT
1936 },
1937 .ep[10] = {
1938 .ep = {
1939 .name = "ep10in-int",
7a857620 1940 .ops = &pxa25x_ep_ops,
1da177e4
LT
1941 .maxpacket = INT_FIFO_SIZE,
1942 },
1943 .dev = &memory,
1944 .fifo_size = INT_FIFO_SIZE,
1945 .bEndpointAddress = USB_DIR_IN | 10,
1946 .bmAttributes = USB_ENDPOINT_XFER_INT,
1947 .reg_udccs = &UDCCS10,
1948 .reg_uddr = &UDDR10,
1949 },
1950
1951 /* third group of endpoints */
1952 .ep[11] = {
1953 .ep = {
1954 .name = "ep11in-bulk",
7a857620 1955 .ops = &pxa25x_ep_ops,
1da177e4
LT
1956 .maxpacket = BULK_FIFO_SIZE,
1957 },
1958 .dev = &memory,
1959 .fifo_size = BULK_FIFO_SIZE,
1960 .bEndpointAddress = USB_DIR_IN | 11,
1961 .bmAttributes = USB_ENDPOINT_XFER_BULK,
1962 .reg_udccs = &UDCCS11,
1963 .reg_uddr = &UDDR11,
1da177e4
LT
1964 },
1965 .ep[12] = {
1966 .ep = {
1967 .name = "ep12out-bulk",
7a857620 1968 .ops = &pxa25x_ep_ops,
1da177e4
LT
1969 .maxpacket = BULK_FIFO_SIZE,
1970 },
1971 .dev = &memory,
1972 .fifo_size = BULK_FIFO_SIZE,
1973 .bEndpointAddress = 12,
1974 .bmAttributes = USB_ENDPOINT_XFER_BULK,
1975 .reg_udccs = &UDCCS12,
1976 .reg_ubcr = &UBCR12,
1977 .reg_uddr = &UDDR12,
1da177e4
LT
1978 },
1979 .ep[13] = {
1980 .ep = {
1981 .name = "ep13in-iso",
7a857620 1982 .ops = &pxa25x_ep_ops,
1da177e4
LT
1983 .maxpacket = ISO_FIFO_SIZE,
1984 },
1985 .dev = &memory,
1986 .fifo_size = ISO_FIFO_SIZE,
1987 .bEndpointAddress = USB_DIR_IN | 13,
1988 .bmAttributes = USB_ENDPOINT_XFER_ISOC,
1989 .reg_udccs = &UDCCS13,
1990 .reg_uddr = &UDDR13,
1da177e4
LT
1991 },
1992 .ep[14] = {
1993 .ep = {
1994 .name = "ep14out-iso",
7a857620 1995 .ops = &pxa25x_ep_ops,
1da177e4
LT
1996 .maxpacket = ISO_FIFO_SIZE,
1997 },
1998 .dev = &memory,
1999 .fifo_size = ISO_FIFO_SIZE,
2000 .bEndpointAddress = 14,
2001 .bmAttributes = USB_ENDPOINT_XFER_ISOC,
2002 .reg_udccs = &UDCCS14,
2003 .reg_ubcr = &UBCR14,
2004 .reg_uddr = &UDDR14,
1da177e4
LT
2005 },
2006 .ep[15] = {
2007 .ep = {
2008 .name = "ep15in-int",
7a857620 2009 .ops = &pxa25x_ep_ops,
1da177e4
LT
2010 .maxpacket = INT_FIFO_SIZE,
2011 },
2012 .dev = &memory,
2013 .fifo_size = INT_FIFO_SIZE,
2014 .bEndpointAddress = USB_DIR_IN | 15,
2015 .bmAttributes = USB_ENDPOINT_XFER_INT,
2016 .reg_udccs = &UDCCS15,
2017 .reg_uddr = &UDDR15,
2018 },
7a857620 2019#endif /* !CONFIG_USB_PXA25X_SMALL */
1da177e4
LT
2020};
2021
2022#define CP15R0_VENDOR_MASK 0xffffe000
2023
2024#if defined(CONFIG_ARCH_PXA)
2025#define CP15R0_XSCALE_VALUE 0x69052000 /* intel/arm/xscale */
2026
2027#elif defined(CONFIG_ARCH_IXP4XX)
2028#define CP15R0_XSCALE_VALUE 0x69054000 /* intel/arm/ixp4xx */
2029
2030#endif
2031
2032#define CP15R0_PROD_MASK 0x000003f0
2033#define PXA25x 0x00000100 /* and PXA26x */
2034#define PXA210 0x00000120
2035
2036#define CP15R0_REV_MASK 0x0000000f
2037
2038#define CP15R0_PRODREV_MASK (CP15R0_PROD_MASK | CP15R0_REV_MASK)
2039
2040#define PXA255_A0 0x00000106 /* or PXA260_B1 */
2041#define PXA250_C0 0x00000105 /* or PXA26x_B0 */
2042#define PXA250_B2 0x00000104
2043#define PXA250_B1 0x00000103 /* or PXA260_A0 */
2044#define PXA250_B0 0x00000102
2045#define PXA250_A1 0x00000101
2046#define PXA250_A0 0x00000100
2047
2048#define PXA210_C0 0x00000125
2049#define PXA210_B2 0x00000124
2050#define PXA210_B1 0x00000123
2051#define PXA210_B0 0x00000122
2052#define IXP425_A0 0x000001c1
827982c5 2053#define IXP425_B0 0x000001f1
043ea18b 2054#define IXP465_AD 0x00000200
1da177e4
LT
2055
2056/*
34ebcd28 2057 * probe - binds to the platform device
1da177e4 2058 */
7a857620 2059static int __init pxa25x_udc_probe(struct platform_device *pdev)
1da177e4 2060{
7a857620 2061 struct pxa25x_udc *dev = &memory;
a8ecc860 2062 int retval, irq;
1da177e4
LT
2063 u32 chiprev;
2064
52f7a82b
FP
2065 pr_info("%s: version %s\n", driver_name, DRIVER_VERSION);
2066
1da177e4
LT
2067 /* insist on Intel/ARM/XScale */
2068 asm("mrc%? p15, 0, %0, c0, c0" : "=r" (chiprev));
2069 if ((chiprev & CP15R0_VENDOR_MASK) != CP15R0_XSCALE_VALUE) {
00274921 2070 pr_err("%s: not XScale!\n", driver_name);
1da177e4
LT
2071 return -ENODEV;
2072 }
2073
2074 /* trigger chiprev-specific logic */
2075 switch (chiprev & CP15R0_PRODREV_MASK) {
2076#if defined(CONFIG_ARCH_PXA)
2077 case PXA255_A0:
2078 dev->has_cfr = 1;
2079 break;
2080 case PXA250_A0:
2081 case PXA250_A1:
2082 /* A0/A1 "not released"; ep 13, 15 unusable */
2083 /* fall through */
2084 case PXA250_B2: case PXA210_B2:
2085 case PXA250_B1: case PXA210_B1:
2086 case PXA250_B0: case PXA210_B0:
ad8c623f 2087 /* OUT-DMA is broken ... */
1da177e4
LT
2088 /* fall through */
2089 case PXA250_C0: case PXA210_C0:
2090 break;
2091#elif defined(CONFIG_ARCH_IXP4XX)
2092 case IXP425_A0:
827982c5 2093 case IXP425_B0:
043ea18b
MS
2094 case IXP465_AD:
2095 dev->has_cfr = 1;
1da177e4
LT
2096 break;
2097#endif
2098 default:
00274921 2099 pr_err("%s: unrecognized processor: %08x\n",
1da177e4
LT
2100 driver_name, chiprev);
2101 /* iop3xx, ixp4xx, ... */
2102 return -ENODEV;
2103 }
2104
34ebcd28
DB
2105 irq = platform_get_irq(pdev, 0);
2106 if (irq < 0)
2107 return -ENODEV;
2108
e0d8b13a 2109 dev->clk = clk_get(&pdev->dev, NULL);
6549e6c9
RK
2110 if (IS_ERR(dev->clk)) {
2111 retval = PTR_ERR(dev->clk);
2112 goto err_clk;
2113 }
6549e6c9 2114
ad8c623f 2115 pr_debug("%s: IRQ %d%s%s\n", driver_name, irq,
1da177e4 2116 dev->has_cfr ? "" : " (!cfr)",
ad8c623f 2117 SIZE_STR "(pio)"
1da177e4
LT
2118 );
2119
1da177e4 2120 /* other non-static parts of init */
3ae5eaec
RK
2121 dev->dev = &pdev->dev;
2122 dev->mach = pdev->dev.platform_data;
9068a4c6 2123
662dca54 2124 dev->transceiver = usb_get_phy(USB_PHY_TYPE_USB2);
ab26d20f 2125
56a075dc 2126 if (gpio_is_valid(dev->mach->gpio_pullup)) {
9068a4c6 2127 if ((retval = gpio_request(dev->mach->gpio_pullup,
7a857620 2128 "pca25x_udc GPIO PULLUP"))) {
9068a4c6
MS
2129 dev_dbg(&pdev->dev,
2130 "can't get pullup gpio %d, err: %d\n",
2131 dev->mach->gpio_pullup, retval);
6549e6c9 2132 goto err_gpio_pullup;
9068a4c6
MS
2133 }
2134 gpio_direction_output(dev->mach->gpio_pullup, 0);
2135 }
1da177e4
LT
2136
2137 init_timer(&dev->timer);
2138 dev->timer.function = udc_watchdog;
2139 dev->timer.data = (unsigned long) dev;
2140
2141 device_initialize(&dev->gadget.dev);
3ae5eaec
RK
2142 dev->gadget.dev.parent = &pdev->dev;
2143 dev->gadget.dev.dma_mask = pdev->dev.dma_mask;
1da177e4 2144
9992a997
FB
2145 retval = device_add(&dev->gadget.dev);
2146 if (retval) {
2147 dev->driver = NULL;
2148 dev->gadget.dev.driver = NULL;
2149 goto err_device_add;
2150 }
2151
1da177e4 2152 the_controller = dev;
3ae5eaec 2153 platform_set_drvdata(pdev, dev);
1da177e4
LT
2154
2155 udc_disable(dev);
2156 udc_reinit(dev);
2157
a8ecc860 2158 dev->vbus = 0;
1da177e4
LT
2159
2160 /* irq setup after old hardware state is cleaned up */
7a857620 2161 retval = request_irq(irq, pxa25x_udc_irq,
b5dd18d8 2162 0, driver_name, dev);
1da177e4 2163 if (retval != 0) {
00274921 2164 pr_err("%s: can't get irq %d, err %d\n",
34ebcd28 2165 driver_name, irq, retval);
6549e6c9 2166 goto err_irq1;
1da177e4
LT
2167 }
2168 dev->got_irq = 1;
2169
2170#ifdef CONFIG_ARCH_LUBBOCK
2171 if (machine_is_lubbock()) {
8de1ee8f
TT
2172 retval = request_irq(LUBBOCK_USB_DISC_IRQ, lubbock_vbus_irq,
2173 0, driver_name, dev);
1da177e4 2174 if (retval != 0) {
00274921 2175 pr_err("%s: can't get irq %i, err %d\n",
1da177e4 2176 driver_name, LUBBOCK_USB_DISC_IRQ, retval);
6549e6c9 2177 goto err_irq_lub;
1da177e4 2178 }
8de1ee8f
TT
2179 retval = request_irq(LUBBOCK_USB_IRQ, lubbock_vbus_irq,
2180 0, driver_name, dev);
1da177e4 2181 if (retval != 0) {
00274921 2182 pr_err("%s: can't get irq %i, err %d\n",
1da177e4 2183 driver_name, LUBBOCK_USB_IRQ, retval);
1da177e4
LT
2184 goto lubbock_fail0;
2185 }
b2bbb20b 2186 } else
1da177e4 2187#endif
040fa1b9 2188 create_debug_files(dev);
1da177e4 2189
0f91349b
SAS
2190 retval = usb_add_gadget_udc(&pdev->dev, &dev->gadget);
2191 if (!retval)
2192 return retval;
6549e6c9 2193
0f91349b 2194 remove_debug_files(dev);
6549e6c9 2195#ifdef CONFIG_ARCH_LUBBOCK
a6207b17 2196lubbock_fail0:
6549e6c9
RK
2197 free_irq(LUBBOCK_USB_DISC_IRQ, dev);
2198 err_irq_lub:
6549e6c9 2199 free_irq(irq, dev);
a6207b17 2200#endif
6549e6c9 2201 err_irq1:
9992a997
FB
2202 device_unregister(&dev->gadget.dev);
2203 err_device_add:
56a075dc 2204 if (gpio_is_valid(dev->mach->gpio_pullup))
6549e6c9
RK
2205 gpio_free(dev->mach->gpio_pullup);
2206 err_gpio_pullup:
ded017ee 2207 if (!IS_ERR_OR_NULL(dev->transceiver)) {
721002ec 2208 usb_put_phy(dev->transceiver);
ab26d20f
PZ
2209 dev->transceiver = NULL;
2210 }
6549e6c9
RK
2211 clk_put(dev->clk);
2212 err_clk:
6549e6c9 2213 return retval;
1da177e4 2214}
91987693 2215
7a857620 2216static void pxa25x_udc_shutdown(struct platform_device *_dev)
91987693
DB
2217{
2218 pullup_off();
2219}
2220
7a857620 2221static int __exit pxa25x_udc_remove(struct platform_device *pdev)
1da177e4 2222{
7a857620 2223 struct pxa25x_udc *dev = platform_get_drvdata(pdev);
1da177e4 2224
6bea476c
DB
2225 if (dev->driver)
2226 return -EBUSY;
2227
9992a997
FB
2228 usb_del_gadget_udc(&dev->gadget);
2229 device_unregister(&dev->gadget.dev);
64cc2dd9
DES
2230 dev->pullup = 0;
2231 pullup(dev);
2232
040fa1b9 2233 remove_debug_files(dev);
1da177e4
LT
2234
2235 if (dev->got_irq) {
34ebcd28 2236 free_irq(platform_get_irq(pdev, 0), dev);
1da177e4
LT
2237 dev->got_irq = 0;
2238 }
44df45a0 2239#ifdef CONFIG_ARCH_LUBBOCK
1da177e4
LT
2240 if (machine_is_lubbock()) {
2241 free_irq(LUBBOCK_USB_DISC_IRQ, dev);
2242 free_irq(LUBBOCK_USB_IRQ, dev);
2243 }
44df45a0 2244#endif
56a075dc 2245 if (gpio_is_valid(dev->mach->gpio_pullup))
9068a4c6
MS
2246 gpio_free(dev->mach->gpio_pullup);
2247
6549e6c9 2248 clk_put(dev->clk);
6549e6c9 2249
ded017ee 2250 if (!IS_ERR_OR_NULL(dev->transceiver)) {
721002ec 2251 usb_put_phy(dev->transceiver);
ab26d20f
PZ
2252 dev->transceiver = NULL;
2253 }
2254
3ae5eaec 2255 platform_set_drvdata(pdev, NULL);
1da177e4
LT
2256 the_controller = NULL;
2257 return 0;
2258}
2259
2260/*-------------------------------------------------------------------------*/
2261
2262#ifdef CONFIG_PM
2263
2264/* USB suspend (controlled by the host) and system suspend (controlled
2265 * by the PXA) don't necessarily work well together. If USB is active,
2266 * the 48 MHz clock is required; so the system can't enter 33 MHz idle
2267 * mode, or any deeper PM saving state.
2268 *
2269 * For now, we punt and forcibly disconnect from the USB host when PXA
2270 * enters any suspend state. While we're disconnected, we always disable
34ebcd28 2271 * the 48MHz USB clock ... allowing PXA sleep and/or 33 MHz idle states.
1da177e4
LT
2272 * Boards without software pullup control shouldn't use those states.
2273 * VBUS IRQs should probably be ignored so that the PXA device just acts
2274 * "dead" to USB hosts until system resume.
2275 */
7a857620 2276static int pxa25x_udc_suspend(struct platform_device *dev, pm_message_t state)
1da177e4 2277{
7a857620 2278 struct pxa25x_udc *udc = platform_get_drvdata(dev);
64cc2dd9 2279 unsigned long flags;
1da177e4 2280
56a075dc 2281 if (!gpio_is_valid(udc->mach->gpio_pullup) && !udc->mach->udc_command)
b6c63937 2282 WARNING("USB host won't detect disconnect!\n");
64cc2dd9
DES
2283 udc->suspended = 1;
2284
2285 local_irq_save(flags);
2286 pullup(udc);
2287 local_irq_restore(flags);
9480e307 2288
1da177e4
LT
2289 return 0;
2290}
2291
7a857620 2292static int pxa25x_udc_resume(struct platform_device *dev)
1da177e4 2293{
7a857620 2294 struct pxa25x_udc *udc = platform_get_drvdata(dev);
64cc2dd9 2295 unsigned long flags;
1da177e4 2296
64cc2dd9
DES
2297 udc->suspended = 0;
2298 local_irq_save(flags);
2299 pullup(udc);
2300 local_irq_restore(flags);
9480e307 2301
1da177e4
LT
2302 return 0;
2303}
2304
2305#else
7a857620
PZ
2306#define pxa25x_udc_suspend NULL
2307#define pxa25x_udc_resume NULL
1da177e4
LT
2308#endif
2309
2310/*-------------------------------------------------------------------------*/
2311
3ae5eaec 2312static struct platform_driver udc_driver = {
7a857620
PZ
2313 .shutdown = pxa25x_udc_shutdown,
2314 .remove = __exit_p(pxa25x_udc_remove),
2315 .suspend = pxa25x_udc_suspend,
2316 .resume = pxa25x_udc_resume,
3ae5eaec
RK
2317 .driver = {
2318 .owner = THIS_MODULE,
7a857620 2319 .name = "pxa25x-udc",
3ae5eaec 2320 },
1da177e4
LT
2321};
2322
52f7a82b 2323module_platform_driver_probe(udc_driver, pxa25x_udc_probe);
1da177e4
LT
2324
2325MODULE_DESCRIPTION(DRIVER_DESC);
2326MODULE_AUTHOR("Frank Becker, Robert Schwebel, David Brownell");
2327MODULE_LICENSE("GPL");
7a857620 2328MODULE_ALIAS("platform:pxa25x-udc");