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