[S390] Remove error checking from copy_oldmem_page()
[linux/fpc-iii.git] / drivers / usb / gadget / at91_udc.c
blob8efe0fa9228dc737f1623fd18cf8e4411208f67b
1 /*
2 * at91_udc -- driver for at91-series USB peripheral controller
4 * Copyright (C) 2004 by Thomas Rathbone
5 * Copyright (C) 2005 by HP Labs
6 * Copyright (C) 2005 by David Brownell
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
14 #undef VERBOSE_DEBUG
15 #undef PACKET_TRACE
17 #include <linux/kernel.h>
18 #include <linux/module.h>
19 #include <linux/platform_device.h>
20 #include <linux/delay.h>
21 #include <linux/ioport.h>
22 #include <linux/slab.h>
23 #include <linux/errno.h>
24 #include <linux/init.h>
25 #include <linux/list.h>
26 #include <linux/interrupt.h>
27 #include <linux/proc_fs.h>
28 #include <linux/prefetch.h>
29 #include <linux/clk.h>
30 #include <linux/usb/ch9.h>
31 #include <linux/usb/gadget.h>
32 #include <linux/prefetch.h>
34 #include <asm/byteorder.h>
35 #include <mach/hardware.h>
36 #include <asm/io.h>
37 #include <asm/irq.h>
38 #include <asm/system.h>
39 #include <asm/gpio.h>
41 #include <mach/board.h>
42 #include <mach/cpu.h>
43 #include <mach/at91sam9261_matrix.h>
45 #include "at91_udc.h"
49 * This controller is simple and PIO-only. It's used in many AT91-series
50 * full speed USB controllers, including the at91rm9200 (arm920T, with MMU),
51 * at91sam926x (arm926ejs, with MMU), and several no-mmu versions.
53 * This driver expects the board has been wired with two GPIOs suppporting
54 * a VBUS sensing IRQ, and a D+ pullup. (They may be omitted, but the
55 * testing hasn't covered such cases.)
57 * The pullup is most important (so it's integrated on sam926x parts). It
58 * provides software control over whether the host enumerates the device.
60 * The VBUS sensing helps during enumeration, and allows both USB clocks
61 * (and the transceiver) to stay gated off until they're necessary, saving
62 * power. During USB suspend, the 48 MHz clock is gated off in hardware;
63 * it may also be gated off by software during some Linux sleep states.
66 #define DRIVER_VERSION "3 May 2006"
68 static const char driver_name [] = "at91_udc";
69 static const char ep0name[] = "ep0";
71 #define VBUS_POLL_TIMEOUT msecs_to_jiffies(1000)
73 #define at91_udp_read(udc, reg) \
74 __raw_readl((udc)->udp_baseaddr + (reg))
75 #define at91_udp_write(udc, reg, val) \
76 __raw_writel((val), (udc)->udp_baseaddr + (reg))
78 /*-------------------------------------------------------------------------*/
80 #ifdef CONFIG_USB_GADGET_DEBUG_FILES
82 #include <linux/seq_file.h>
84 static const char debug_filename[] = "driver/udc";
86 #define FOURBITS "%s%s%s%s"
87 #define EIGHTBITS FOURBITS FOURBITS
89 static void proc_ep_show(struct seq_file *s, struct at91_ep *ep)
91 static char *types[] = {
92 "control", "out-iso", "out-bulk", "out-int",
93 "BOGUS", "in-iso", "in-bulk", "in-int"};
95 u32 csr;
96 struct at91_request *req;
97 unsigned long flags;
98 struct at91_udc *udc = ep->udc;
100 spin_lock_irqsave(&udc->lock, flags);
102 csr = __raw_readl(ep->creg);
104 /* NOTE: not collecting per-endpoint irq statistics... */
106 seq_printf(s, "\n");
107 seq_printf(s, "%s, maxpacket %d %s%s %s%s\n",
108 ep->ep.name, ep->ep.maxpacket,
109 ep->is_in ? "in" : "out",
110 ep->is_iso ? " iso" : "",
111 ep->is_pingpong
112 ? (ep->fifo_bank ? "pong" : "ping")
113 : "",
114 ep->stopped ? " stopped" : "");
115 seq_printf(s, "csr %08x rxbytes=%d %s %s %s" EIGHTBITS "\n",
116 csr,
117 (csr & 0x07ff0000) >> 16,
118 (csr & (1 << 15)) ? "enabled" : "disabled",
119 (csr & (1 << 11)) ? "DATA1" : "DATA0",
120 types[(csr & 0x700) >> 8],
122 /* iff type is control then print current direction */
123 (!(csr & 0x700))
124 ? ((csr & (1 << 7)) ? " IN" : " OUT")
125 : "",
126 (csr & (1 << 6)) ? " rxdatabk1" : "",
127 (csr & (1 << 5)) ? " forcestall" : "",
128 (csr & (1 << 4)) ? " txpktrdy" : "",
130 (csr & (1 << 3)) ? " stallsent" : "",
131 (csr & (1 << 2)) ? " rxsetup" : "",
132 (csr & (1 << 1)) ? " rxdatabk0" : "",
133 (csr & (1 << 0)) ? " txcomp" : "");
134 if (list_empty (&ep->queue))
135 seq_printf(s, "\t(queue empty)\n");
137 else list_for_each_entry (req, &ep->queue, queue) {
138 unsigned length = req->req.actual;
140 seq_printf(s, "\treq %p len %d/%d buf %p\n",
141 &req->req, length,
142 req->req.length, req->req.buf);
144 spin_unlock_irqrestore(&udc->lock, flags);
147 static void proc_irq_show(struct seq_file *s, const char *label, u32 mask)
149 int i;
151 seq_printf(s, "%s %04x:%s%s" FOURBITS, label, mask,
152 (mask & (1 << 13)) ? " wakeup" : "",
153 (mask & (1 << 12)) ? " endbusres" : "",
155 (mask & (1 << 11)) ? " sofint" : "",
156 (mask & (1 << 10)) ? " extrsm" : "",
157 (mask & (1 << 9)) ? " rxrsm" : "",
158 (mask & (1 << 8)) ? " rxsusp" : "");
159 for (i = 0; i < 8; i++) {
160 if (mask & (1 << i))
161 seq_printf(s, " ep%d", i);
163 seq_printf(s, "\n");
166 static int proc_udc_show(struct seq_file *s, void *unused)
168 struct at91_udc *udc = s->private;
169 struct at91_ep *ep;
170 u32 tmp;
172 seq_printf(s, "%s: version %s\n", driver_name, DRIVER_VERSION);
174 seq_printf(s, "vbus %s, pullup %s, %s powered%s, gadget %s\n\n",
175 udc->vbus ? "present" : "off",
176 udc->enabled
177 ? (udc->vbus ? "active" : "enabled")
178 : "disabled",
179 udc->selfpowered ? "self" : "VBUS",
180 udc->suspended ? ", suspended" : "",
181 udc->driver ? udc->driver->driver.name : "(none)");
183 /* don't access registers when interface isn't clocked */
184 if (!udc->clocked) {
185 seq_printf(s, "(not clocked)\n");
186 return 0;
189 tmp = at91_udp_read(udc, AT91_UDP_FRM_NUM);
190 seq_printf(s, "frame %05x:%s%s frame=%d\n", tmp,
191 (tmp & AT91_UDP_FRM_OK) ? " ok" : "",
192 (tmp & AT91_UDP_FRM_ERR) ? " err" : "",
193 (tmp & AT91_UDP_NUM));
195 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT);
196 seq_printf(s, "glbstate %02x:%s" FOURBITS "\n", tmp,
197 (tmp & AT91_UDP_RMWUPE) ? " rmwupe" : "",
198 (tmp & AT91_UDP_RSMINPR) ? " rsminpr" : "",
199 (tmp & AT91_UDP_ESR) ? " esr" : "",
200 (tmp & AT91_UDP_CONFG) ? " confg" : "",
201 (tmp & AT91_UDP_FADDEN) ? " fadden" : "");
203 tmp = at91_udp_read(udc, AT91_UDP_FADDR);
204 seq_printf(s, "faddr %03x:%s fadd=%d\n", tmp,
205 (tmp & AT91_UDP_FEN) ? " fen" : "",
206 (tmp & AT91_UDP_FADD));
208 proc_irq_show(s, "imr ", at91_udp_read(udc, AT91_UDP_IMR));
209 proc_irq_show(s, "isr ", at91_udp_read(udc, AT91_UDP_ISR));
211 if (udc->enabled && udc->vbus) {
212 proc_ep_show(s, &udc->ep[0]);
213 list_for_each_entry (ep, &udc->gadget.ep_list, ep.ep_list) {
214 if (ep->desc)
215 proc_ep_show(s, ep);
218 return 0;
221 static int proc_udc_open(struct inode *inode, struct file *file)
223 return single_open(file, proc_udc_show, PDE(inode)->data);
226 static const struct file_operations proc_ops = {
227 .owner = THIS_MODULE,
228 .open = proc_udc_open,
229 .read = seq_read,
230 .llseek = seq_lseek,
231 .release = single_release,
234 static void create_debug_file(struct at91_udc *udc)
236 udc->pde = proc_create_data(debug_filename, 0, NULL, &proc_ops, udc);
239 static void remove_debug_file(struct at91_udc *udc)
241 if (udc->pde)
242 remove_proc_entry(debug_filename, NULL);
245 #else
247 static inline void create_debug_file(struct at91_udc *udc) {}
248 static inline void remove_debug_file(struct at91_udc *udc) {}
250 #endif
253 /*-------------------------------------------------------------------------*/
255 static void done(struct at91_ep *ep, struct at91_request *req, int status)
257 unsigned stopped = ep->stopped;
258 struct at91_udc *udc = ep->udc;
260 list_del_init(&req->queue);
261 if (req->req.status == -EINPROGRESS)
262 req->req.status = status;
263 else
264 status = req->req.status;
265 if (status && status != -ESHUTDOWN)
266 VDBG("%s done %p, status %d\n", ep->ep.name, req, status);
268 ep->stopped = 1;
269 spin_unlock(&udc->lock);
270 req->req.complete(&ep->ep, &req->req);
271 spin_lock(&udc->lock);
272 ep->stopped = stopped;
274 /* ep0 is always ready; other endpoints need a non-empty queue */
275 if (list_empty(&ep->queue) && ep->int_mask != (1 << 0))
276 at91_udp_write(udc, AT91_UDP_IDR, ep->int_mask);
279 /*-------------------------------------------------------------------------*/
281 /* bits indicating OUT fifo has data ready */
282 #define RX_DATA_READY (AT91_UDP_RX_DATA_BK0 | AT91_UDP_RX_DATA_BK1)
285 * Endpoint FIFO CSR bits have a mix of bits, making it unsafe to just write
286 * back most of the value you just read (because of side effects, including
287 * bits that may change after reading and before writing).
289 * Except when changing a specific bit, always write values which:
290 * - clear SET_FX bits (setting them could change something)
291 * - set CLR_FX bits (clearing them could change something)
293 * There are also state bits like FORCESTALL, EPEDS, DIR, and EPTYPE
294 * that shouldn't normally be changed.
296 * NOTE at91sam9260 docs mention synch between UDPCK and MCK clock domains,
297 * implying a need to wait for one write to complete (test relevant bits)
298 * before starting the next write. This shouldn't be an issue given how
299 * infrequently we write, except maybe for write-then-read idioms.
301 #define SET_FX (AT91_UDP_TXPKTRDY)
302 #define CLR_FX (RX_DATA_READY | AT91_UDP_RXSETUP \
303 | AT91_UDP_STALLSENT | AT91_UDP_TXCOMP)
305 /* pull OUT packet data from the endpoint's fifo */
306 static int read_fifo (struct at91_ep *ep, struct at91_request *req)
308 u32 __iomem *creg = ep->creg;
309 u8 __iomem *dreg = ep->creg + (AT91_UDP_FDR(0) - AT91_UDP_CSR(0));
310 u32 csr;
311 u8 *buf;
312 unsigned int count, bufferspace, is_done;
314 buf = req->req.buf + req->req.actual;
315 bufferspace = req->req.length - req->req.actual;
318 * there might be nothing to read if ep_queue() calls us,
319 * or if we already emptied both pingpong buffers
321 rescan:
322 csr = __raw_readl(creg);
323 if ((csr & RX_DATA_READY) == 0)
324 return 0;
326 count = (csr & AT91_UDP_RXBYTECNT) >> 16;
327 if (count > ep->ep.maxpacket)
328 count = ep->ep.maxpacket;
329 if (count > bufferspace) {
330 DBG("%s buffer overflow\n", ep->ep.name);
331 req->req.status = -EOVERFLOW;
332 count = bufferspace;
334 __raw_readsb(dreg, buf, count);
336 /* release and swap pingpong mem bank */
337 csr |= CLR_FX;
338 if (ep->is_pingpong) {
339 if (ep->fifo_bank == 0) {
340 csr &= ~(SET_FX | AT91_UDP_RX_DATA_BK0);
341 ep->fifo_bank = 1;
342 } else {
343 csr &= ~(SET_FX | AT91_UDP_RX_DATA_BK1);
344 ep->fifo_bank = 0;
346 } else
347 csr &= ~(SET_FX | AT91_UDP_RX_DATA_BK0);
348 __raw_writel(csr, creg);
350 req->req.actual += count;
351 is_done = (count < ep->ep.maxpacket);
352 if (count == bufferspace)
353 is_done = 1;
355 PACKET("%s %p out/%d%s\n", ep->ep.name, &req->req, count,
356 is_done ? " (done)" : "");
359 * avoid extra trips through IRQ logic for packets already in
360 * the fifo ... maybe preventing an extra (expensive) OUT-NAK
362 if (is_done)
363 done(ep, req, 0);
364 else if (ep->is_pingpong) {
366 * One dummy read to delay the code because of a HW glitch:
367 * CSR returns bad RXCOUNT when read too soon after updating
368 * RX_DATA_BK flags.
370 csr = __raw_readl(creg);
372 bufferspace -= count;
373 buf += count;
374 goto rescan;
377 return is_done;
380 /* load fifo for an IN packet */
381 static int write_fifo(struct at91_ep *ep, struct at91_request *req)
383 u32 __iomem *creg = ep->creg;
384 u32 csr = __raw_readl(creg);
385 u8 __iomem *dreg = ep->creg + (AT91_UDP_FDR(0) - AT91_UDP_CSR(0));
386 unsigned total, count, is_last;
387 u8 *buf;
390 * TODO: allow for writing two packets to the fifo ... that'll
391 * reduce the amount of IN-NAKing, but probably won't affect
392 * throughput much. (Unlike preventing OUT-NAKing!)
396 * If ep_queue() calls us, the queue is empty and possibly in
397 * odd states like TXCOMP not yet cleared (we do it, saving at
398 * least one IRQ) or the fifo not yet being free. Those aren't
399 * issues normally (IRQ handler fast path).
401 if (unlikely(csr & (AT91_UDP_TXCOMP | AT91_UDP_TXPKTRDY))) {
402 if (csr & AT91_UDP_TXCOMP) {
403 csr |= CLR_FX;
404 csr &= ~(SET_FX | AT91_UDP_TXCOMP);
405 __raw_writel(csr, creg);
406 csr = __raw_readl(creg);
408 if (csr & AT91_UDP_TXPKTRDY)
409 return 0;
412 buf = req->req.buf + req->req.actual;
413 prefetch(buf);
414 total = req->req.length - req->req.actual;
415 if (ep->ep.maxpacket < total) {
416 count = ep->ep.maxpacket;
417 is_last = 0;
418 } else {
419 count = total;
420 is_last = (count < ep->ep.maxpacket) || !req->req.zero;
424 * Write the packet, maybe it's a ZLP.
426 * NOTE: incrementing req->actual before we receive the ACK means
427 * gadget driver IN bytecounts can be wrong in fault cases. That's
428 * fixable with PIO drivers like this one (save "count" here, and
429 * do the increment later on TX irq), but not for most DMA hardware.
431 * So all gadget drivers must accept that potential error. Some
432 * hardware supports precise fifo status reporting, letting them
433 * recover when the actual bytecount matters (e.g. for USB Test
434 * and Measurement Class devices).
436 __raw_writesb(dreg, buf, count);
437 csr &= ~SET_FX;
438 csr |= CLR_FX | AT91_UDP_TXPKTRDY;
439 __raw_writel(csr, creg);
440 req->req.actual += count;
442 PACKET("%s %p in/%d%s\n", ep->ep.name, &req->req, count,
443 is_last ? " (done)" : "");
444 if (is_last)
445 done(ep, req, 0);
446 return is_last;
449 static void nuke(struct at91_ep *ep, int status)
451 struct at91_request *req;
453 /* terminate any request in the queue */
454 ep->stopped = 1;
455 if (list_empty(&ep->queue))
456 return;
458 VDBG("%s %s\n", __func__, ep->ep.name);
459 while (!list_empty(&ep->queue)) {
460 req = list_entry(ep->queue.next, struct at91_request, queue);
461 done(ep, req, status);
465 /*-------------------------------------------------------------------------*/
467 static int at91_ep_enable(struct usb_ep *_ep,
468 const struct usb_endpoint_descriptor *desc)
470 struct at91_ep *ep = container_of(_ep, struct at91_ep, ep);
471 struct at91_udc *udc = ep->udc;
472 u16 maxpacket;
473 u32 tmp;
474 unsigned long flags;
476 if (!_ep || !ep
477 || !desc || ep->desc
478 || _ep->name == ep0name
479 || desc->bDescriptorType != USB_DT_ENDPOINT
480 || (maxpacket = usb_endpoint_maxp(desc)) == 0
481 || maxpacket > ep->maxpacket) {
482 DBG("bad ep or descriptor\n");
483 return -EINVAL;
486 if (!udc->driver || udc->gadget.speed == USB_SPEED_UNKNOWN) {
487 DBG("bogus device state\n");
488 return -ESHUTDOWN;
491 tmp = usb_endpoint_type(desc);
492 switch (tmp) {
493 case USB_ENDPOINT_XFER_CONTROL:
494 DBG("only one control endpoint\n");
495 return -EINVAL;
496 case USB_ENDPOINT_XFER_INT:
497 if (maxpacket > 64)
498 goto bogus_max;
499 break;
500 case USB_ENDPOINT_XFER_BULK:
501 switch (maxpacket) {
502 case 8:
503 case 16:
504 case 32:
505 case 64:
506 goto ok;
508 bogus_max:
509 DBG("bogus maxpacket %d\n", maxpacket);
510 return -EINVAL;
511 case USB_ENDPOINT_XFER_ISOC:
512 if (!ep->is_pingpong) {
513 DBG("iso requires double buffering\n");
514 return -EINVAL;
516 break;
520 spin_lock_irqsave(&udc->lock, flags);
522 /* initialize endpoint to match this descriptor */
523 ep->is_in = usb_endpoint_dir_in(desc);
524 ep->is_iso = (tmp == USB_ENDPOINT_XFER_ISOC);
525 ep->stopped = 0;
526 if (ep->is_in)
527 tmp |= 0x04;
528 tmp <<= 8;
529 tmp |= AT91_UDP_EPEDS;
530 __raw_writel(tmp, ep->creg);
532 ep->desc = desc;
533 ep->ep.maxpacket = maxpacket;
536 * reset/init endpoint fifo. NOTE: leaves fifo_bank alone,
537 * since endpoint resets don't reset hw pingpong state.
539 at91_udp_write(udc, AT91_UDP_RST_EP, ep->int_mask);
540 at91_udp_write(udc, AT91_UDP_RST_EP, 0);
542 spin_unlock_irqrestore(&udc->lock, flags);
543 return 0;
546 static int at91_ep_disable (struct usb_ep * _ep)
548 struct at91_ep *ep = container_of(_ep, struct at91_ep, ep);
549 struct at91_udc *udc = ep->udc;
550 unsigned long flags;
552 if (ep == &ep->udc->ep[0])
553 return -EINVAL;
555 spin_lock_irqsave(&udc->lock, flags);
557 nuke(ep, -ESHUTDOWN);
559 /* restore the endpoint's pristine config */
560 ep->desc = NULL;
561 ep->ep.maxpacket = ep->maxpacket;
563 /* reset fifos and endpoint */
564 if (ep->udc->clocked) {
565 at91_udp_write(udc, AT91_UDP_RST_EP, ep->int_mask);
566 at91_udp_write(udc, AT91_UDP_RST_EP, 0);
567 __raw_writel(0, ep->creg);
570 spin_unlock_irqrestore(&udc->lock, flags);
571 return 0;
575 * this is a PIO-only driver, so there's nothing
576 * interesting for request or buffer allocation.
579 static struct usb_request *
580 at91_ep_alloc_request(struct usb_ep *_ep, gfp_t gfp_flags)
582 struct at91_request *req;
584 req = kzalloc(sizeof (struct at91_request), gfp_flags);
585 if (!req)
586 return NULL;
588 INIT_LIST_HEAD(&req->queue);
589 return &req->req;
592 static void at91_ep_free_request(struct usb_ep *_ep, struct usb_request *_req)
594 struct at91_request *req;
596 req = container_of(_req, struct at91_request, req);
597 BUG_ON(!list_empty(&req->queue));
598 kfree(req);
601 static int at91_ep_queue(struct usb_ep *_ep,
602 struct usb_request *_req, gfp_t gfp_flags)
604 struct at91_request *req;
605 struct at91_ep *ep;
606 struct at91_udc *udc;
607 int status;
608 unsigned long flags;
610 req = container_of(_req, struct at91_request, req);
611 ep = container_of(_ep, struct at91_ep, ep);
613 if (!_req || !_req->complete
614 || !_req->buf || !list_empty(&req->queue)) {
615 DBG("invalid request\n");
616 return -EINVAL;
619 if (!_ep || (!ep->desc && ep->ep.name != ep0name)) {
620 DBG("invalid ep\n");
621 return -EINVAL;
624 udc = ep->udc;
626 if (!udc || !udc->driver || udc->gadget.speed == USB_SPEED_UNKNOWN) {
627 DBG("invalid device\n");
628 return -EINVAL;
631 _req->status = -EINPROGRESS;
632 _req->actual = 0;
634 spin_lock_irqsave(&udc->lock, flags);
636 /* try to kickstart any empty and idle queue */
637 if (list_empty(&ep->queue) && !ep->stopped) {
638 int is_ep0;
641 * If this control request has a non-empty DATA stage, this
642 * will start that stage. It works just like a non-control
643 * request (until the status stage starts, maybe early).
645 * If the data stage is empty, then this starts a successful
646 * IN/STATUS stage. (Unsuccessful ones use set_halt.)
648 is_ep0 = (ep->ep.name == ep0name);
649 if (is_ep0) {
650 u32 tmp;
652 if (!udc->req_pending) {
653 status = -EINVAL;
654 goto done;
658 * defer changing CONFG until after the gadget driver
659 * reconfigures the endpoints.
661 if (udc->wait_for_config_ack) {
662 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT);
663 tmp ^= AT91_UDP_CONFG;
664 VDBG("toggle config\n");
665 at91_udp_write(udc, AT91_UDP_GLB_STAT, tmp);
667 if (req->req.length == 0) {
668 ep0_in_status:
669 PACKET("ep0 in/status\n");
670 status = 0;
671 tmp = __raw_readl(ep->creg);
672 tmp &= ~SET_FX;
673 tmp |= CLR_FX | AT91_UDP_TXPKTRDY;
674 __raw_writel(tmp, ep->creg);
675 udc->req_pending = 0;
676 goto done;
680 if (ep->is_in)
681 status = write_fifo(ep, req);
682 else {
683 status = read_fifo(ep, req);
685 /* IN/STATUS stage is otherwise triggered by irq */
686 if (status && is_ep0)
687 goto ep0_in_status;
689 } else
690 status = 0;
692 if (req && !status) {
693 list_add_tail (&req->queue, &ep->queue);
694 at91_udp_write(udc, AT91_UDP_IER, ep->int_mask);
696 done:
697 spin_unlock_irqrestore(&udc->lock, flags);
698 return (status < 0) ? status : 0;
701 static int at91_ep_dequeue(struct usb_ep *_ep, struct usb_request *_req)
703 struct at91_ep *ep;
704 struct at91_request *req;
705 unsigned long flags;
706 struct at91_udc *udc;
708 ep = container_of(_ep, struct at91_ep, ep);
709 if (!_ep || ep->ep.name == ep0name)
710 return -EINVAL;
712 udc = ep->udc;
714 spin_lock_irqsave(&udc->lock, flags);
716 /* make sure it's actually queued on this endpoint */
717 list_for_each_entry (req, &ep->queue, queue) {
718 if (&req->req == _req)
719 break;
721 if (&req->req != _req) {
722 spin_unlock_irqrestore(&udc->lock, flags);
723 return -EINVAL;
726 done(ep, req, -ECONNRESET);
727 spin_unlock_irqrestore(&udc->lock, flags);
728 return 0;
731 static int at91_ep_set_halt(struct usb_ep *_ep, int value)
733 struct at91_ep *ep = container_of(_ep, struct at91_ep, ep);
734 struct at91_udc *udc = ep->udc;
735 u32 __iomem *creg;
736 u32 csr;
737 unsigned long flags;
738 int status = 0;
740 if (!_ep || ep->is_iso || !ep->udc->clocked)
741 return -EINVAL;
743 creg = ep->creg;
744 spin_lock_irqsave(&udc->lock, flags);
746 csr = __raw_readl(creg);
749 * fail with still-busy IN endpoints, ensuring correct sequencing
750 * of data tx then stall. note that the fifo rx bytecount isn't
751 * completely accurate as a tx bytecount.
753 if (ep->is_in && (!list_empty(&ep->queue) || (csr >> 16) != 0))
754 status = -EAGAIN;
755 else {
756 csr |= CLR_FX;
757 csr &= ~SET_FX;
758 if (value) {
759 csr |= AT91_UDP_FORCESTALL;
760 VDBG("halt %s\n", ep->ep.name);
761 } else {
762 at91_udp_write(udc, AT91_UDP_RST_EP, ep->int_mask);
763 at91_udp_write(udc, AT91_UDP_RST_EP, 0);
764 csr &= ~AT91_UDP_FORCESTALL;
766 __raw_writel(csr, creg);
769 spin_unlock_irqrestore(&udc->lock, flags);
770 return status;
773 static const struct usb_ep_ops at91_ep_ops = {
774 .enable = at91_ep_enable,
775 .disable = at91_ep_disable,
776 .alloc_request = at91_ep_alloc_request,
777 .free_request = at91_ep_free_request,
778 .queue = at91_ep_queue,
779 .dequeue = at91_ep_dequeue,
780 .set_halt = at91_ep_set_halt,
781 /* there's only imprecise fifo status reporting */
784 /*-------------------------------------------------------------------------*/
786 static int at91_get_frame(struct usb_gadget *gadget)
788 struct at91_udc *udc = to_udc(gadget);
790 if (!to_udc(gadget)->clocked)
791 return -EINVAL;
792 return at91_udp_read(udc, AT91_UDP_FRM_NUM) & AT91_UDP_NUM;
795 static int at91_wakeup(struct usb_gadget *gadget)
797 struct at91_udc *udc = to_udc(gadget);
798 u32 glbstate;
799 int status = -EINVAL;
800 unsigned long flags;
802 DBG("%s\n", __func__ );
803 spin_lock_irqsave(&udc->lock, flags);
805 if (!udc->clocked || !udc->suspended)
806 goto done;
808 /* NOTE: some "early versions" handle ESR differently ... */
810 glbstate = at91_udp_read(udc, AT91_UDP_GLB_STAT);
811 if (!(glbstate & AT91_UDP_ESR))
812 goto done;
813 glbstate |= AT91_UDP_ESR;
814 at91_udp_write(udc, AT91_UDP_GLB_STAT, glbstate);
816 done:
817 spin_unlock_irqrestore(&udc->lock, flags);
818 return status;
821 /* reinit == restore initial software state */
822 static void udc_reinit(struct at91_udc *udc)
824 u32 i;
826 INIT_LIST_HEAD(&udc->gadget.ep_list);
827 INIT_LIST_HEAD(&udc->gadget.ep0->ep_list);
829 for (i = 0; i < NUM_ENDPOINTS; i++) {
830 struct at91_ep *ep = &udc->ep[i];
832 if (i != 0)
833 list_add_tail(&ep->ep.ep_list, &udc->gadget.ep_list);
834 ep->desc = NULL;
835 ep->stopped = 0;
836 ep->fifo_bank = 0;
837 ep->ep.maxpacket = ep->maxpacket;
838 ep->creg = (void __iomem *) udc->udp_baseaddr + AT91_UDP_CSR(i);
839 /* initialize one queue per endpoint */
840 INIT_LIST_HEAD(&ep->queue);
844 static void stop_activity(struct at91_udc *udc)
846 struct usb_gadget_driver *driver = udc->driver;
847 int i;
849 if (udc->gadget.speed == USB_SPEED_UNKNOWN)
850 driver = NULL;
851 udc->gadget.speed = USB_SPEED_UNKNOWN;
852 udc->suspended = 0;
854 for (i = 0; i < NUM_ENDPOINTS; i++) {
855 struct at91_ep *ep = &udc->ep[i];
856 ep->stopped = 1;
857 nuke(ep, -ESHUTDOWN);
859 if (driver) {
860 spin_unlock(&udc->lock);
861 driver->disconnect(&udc->gadget);
862 spin_lock(&udc->lock);
865 udc_reinit(udc);
868 static void clk_on(struct at91_udc *udc)
870 if (udc->clocked)
871 return;
872 udc->clocked = 1;
873 clk_enable(udc->iclk);
874 clk_enable(udc->fclk);
877 static void clk_off(struct at91_udc *udc)
879 if (!udc->clocked)
880 return;
881 udc->clocked = 0;
882 udc->gadget.speed = USB_SPEED_UNKNOWN;
883 clk_disable(udc->fclk);
884 clk_disable(udc->iclk);
888 * activate/deactivate link with host; minimize power usage for
889 * inactive links by cutting clocks and transceiver power.
891 static void pullup(struct at91_udc *udc, int is_on)
893 int active = !udc->board.pullup_active_low;
895 if (!udc->enabled || !udc->vbus)
896 is_on = 0;
897 DBG("%sactive\n", is_on ? "" : "in");
899 if (is_on) {
900 clk_on(udc);
901 at91_udp_write(udc, AT91_UDP_ICR, AT91_UDP_RXRSM);
902 at91_udp_write(udc, AT91_UDP_TXVC, 0);
903 if (cpu_is_at91rm9200())
904 gpio_set_value(udc->board.pullup_pin, active);
905 else if (cpu_is_at91sam9260() || cpu_is_at91sam9263() || cpu_is_at91sam9g20()) {
906 u32 txvc = at91_udp_read(udc, AT91_UDP_TXVC);
908 txvc |= AT91_UDP_TXVC_PUON;
909 at91_udp_write(udc, AT91_UDP_TXVC, txvc);
910 } else if (cpu_is_at91sam9261() || cpu_is_at91sam9g10()) {
911 u32 usbpucr;
913 usbpucr = at91_sys_read(AT91_MATRIX_USBPUCR);
914 usbpucr |= AT91_MATRIX_USBPUCR_PUON;
915 at91_sys_write(AT91_MATRIX_USBPUCR, usbpucr);
917 } else {
918 stop_activity(udc);
919 at91_udp_write(udc, AT91_UDP_IDR, AT91_UDP_RXRSM);
920 at91_udp_write(udc, AT91_UDP_TXVC, AT91_UDP_TXVC_TXVDIS);
921 if (cpu_is_at91rm9200())
922 gpio_set_value(udc->board.pullup_pin, !active);
923 else if (cpu_is_at91sam9260() || cpu_is_at91sam9263() || cpu_is_at91sam9g20()) {
924 u32 txvc = at91_udp_read(udc, AT91_UDP_TXVC);
926 txvc &= ~AT91_UDP_TXVC_PUON;
927 at91_udp_write(udc, AT91_UDP_TXVC, txvc);
928 } else if (cpu_is_at91sam9261() || cpu_is_at91sam9g10()) {
929 u32 usbpucr;
931 usbpucr = at91_sys_read(AT91_MATRIX_USBPUCR);
932 usbpucr &= ~AT91_MATRIX_USBPUCR_PUON;
933 at91_sys_write(AT91_MATRIX_USBPUCR, usbpucr);
935 clk_off(udc);
939 /* vbus is here! turn everything on that's ready */
940 static int at91_vbus_session(struct usb_gadget *gadget, int is_active)
942 struct at91_udc *udc = to_udc(gadget);
943 unsigned long flags;
945 /* VDBG("vbus %s\n", is_active ? "on" : "off"); */
946 spin_lock_irqsave(&udc->lock, flags);
947 udc->vbus = (is_active != 0);
948 if (udc->driver)
949 pullup(udc, is_active);
950 else
951 pullup(udc, 0);
952 spin_unlock_irqrestore(&udc->lock, flags);
953 return 0;
956 static int at91_pullup(struct usb_gadget *gadget, int is_on)
958 struct at91_udc *udc = to_udc(gadget);
959 unsigned long flags;
961 spin_lock_irqsave(&udc->lock, flags);
962 udc->enabled = is_on = !!is_on;
963 pullup(udc, is_on);
964 spin_unlock_irqrestore(&udc->lock, flags);
965 return 0;
968 static int at91_set_selfpowered(struct usb_gadget *gadget, int is_on)
970 struct at91_udc *udc = to_udc(gadget);
971 unsigned long flags;
973 spin_lock_irqsave(&udc->lock, flags);
974 udc->selfpowered = (is_on != 0);
975 spin_unlock_irqrestore(&udc->lock, flags);
976 return 0;
979 static int at91_start(struct usb_gadget_driver *driver,
980 int (*bind)(struct usb_gadget *));
981 static int at91_stop(struct usb_gadget_driver *driver);
983 static const struct usb_gadget_ops at91_udc_ops = {
984 .get_frame = at91_get_frame,
985 .wakeup = at91_wakeup,
986 .set_selfpowered = at91_set_selfpowered,
987 .vbus_session = at91_vbus_session,
988 .pullup = at91_pullup,
989 .start = at91_start,
990 .stop = at91_stop,
993 * VBUS-powered devices may also also want to support bigger
994 * power budgets after an appropriate SET_CONFIGURATION.
996 /* .vbus_power = at91_vbus_power, */
999 /*-------------------------------------------------------------------------*/
1001 static int handle_ep(struct at91_ep *ep)
1003 struct at91_request *req;
1004 u32 __iomem *creg = ep->creg;
1005 u32 csr = __raw_readl(creg);
1007 if (!list_empty(&ep->queue))
1008 req = list_entry(ep->queue.next,
1009 struct at91_request, queue);
1010 else
1011 req = NULL;
1013 if (ep->is_in) {
1014 if (csr & (AT91_UDP_STALLSENT | AT91_UDP_TXCOMP)) {
1015 csr |= CLR_FX;
1016 csr &= ~(SET_FX | AT91_UDP_STALLSENT | AT91_UDP_TXCOMP);
1017 __raw_writel(csr, creg);
1019 if (req)
1020 return write_fifo(ep, req);
1022 } else {
1023 if (csr & AT91_UDP_STALLSENT) {
1024 /* STALLSENT bit == ISOERR */
1025 if (ep->is_iso && req)
1026 req->req.status = -EILSEQ;
1027 csr |= CLR_FX;
1028 csr &= ~(SET_FX | AT91_UDP_STALLSENT);
1029 __raw_writel(csr, creg);
1030 csr = __raw_readl(creg);
1032 if (req && (csr & RX_DATA_READY))
1033 return read_fifo(ep, req);
1035 return 0;
1038 union setup {
1039 u8 raw[8];
1040 struct usb_ctrlrequest r;
1043 static void handle_setup(struct at91_udc *udc, struct at91_ep *ep, u32 csr)
1045 u32 __iomem *creg = ep->creg;
1046 u8 __iomem *dreg = ep->creg + (AT91_UDP_FDR(0) - AT91_UDP_CSR(0));
1047 unsigned rxcount, i = 0;
1048 u32 tmp;
1049 union setup pkt;
1050 int status = 0;
1052 /* read and ack SETUP; hard-fail for bogus packets */
1053 rxcount = (csr & AT91_UDP_RXBYTECNT) >> 16;
1054 if (likely(rxcount == 8)) {
1055 while (rxcount--)
1056 pkt.raw[i++] = __raw_readb(dreg);
1057 if (pkt.r.bRequestType & USB_DIR_IN) {
1058 csr |= AT91_UDP_DIR;
1059 ep->is_in = 1;
1060 } else {
1061 csr &= ~AT91_UDP_DIR;
1062 ep->is_in = 0;
1064 } else {
1065 /* REVISIT this happens sometimes under load; why?? */
1066 ERR("SETUP len %d, csr %08x\n", rxcount, csr);
1067 status = -EINVAL;
1069 csr |= CLR_FX;
1070 csr &= ~(SET_FX | AT91_UDP_RXSETUP);
1071 __raw_writel(csr, creg);
1072 udc->wait_for_addr_ack = 0;
1073 udc->wait_for_config_ack = 0;
1074 ep->stopped = 0;
1075 if (unlikely(status != 0))
1076 goto stall;
1078 #define w_index le16_to_cpu(pkt.r.wIndex)
1079 #define w_value le16_to_cpu(pkt.r.wValue)
1080 #define w_length le16_to_cpu(pkt.r.wLength)
1082 VDBG("SETUP %02x.%02x v%04x i%04x l%04x\n",
1083 pkt.r.bRequestType, pkt.r.bRequest,
1084 w_value, w_index, w_length);
1087 * A few standard requests get handled here, ones that touch
1088 * hardware ... notably for device and endpoint features.
1090 udc->req_pending = 1;
1091 csr = __raw_readl(creg);
1092 csr |= CLR_FX;
1093 csr &= ~SET_FX;
1094 switch ((pkt.r.bRequestType << 8) | pkt.r.bRequest) {
1096 case ((USB_TYPE_STANDARD|USB_RECIP_DEVICE) << 8)
1097 | USB_REQ_SET_ADDRESS:
1098 __raw_writel(csr | AT91_UDP_TXPKTRDY, creg);
1099 udc->addr = w_value;
1100 udc->wait_for_addr_ack = 1;
1101 udc->req_pending = 0;
1102 /* FADDR is set later, when we ack host STATUS */
1103 return;
1105 case ((USB_TYPE_STANDARD|USB_RECIP_DEVICE) << 8)
1106 | USB_REQ_SET_CONFIGURATION:
1107 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT) & AT91_UDP_CONFG;
1108 if (pkt.r.wValue)
1109 udc->wait_for_config_ack = (tmp == 0);
1110 else
1111 udc->wait_for_config_ack = (tmp != 0);
1112 if (udc->wait_for_config_ack)
1113 VDBG("wait for config\n");
1114 /* CONFG is toggled later, if gadget driver succeeds */
1115 break;
1118 * Hosts may set or clear remote wakeup status, and
1119 * devices may report they're VBUS powered.
1121 case ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE) << 8)
1122 | USB_REQ_GET_STATUS:
1123 tmp = (udc->selfpowered << USB_DEVICE_SELF_POWERED);
1124 if (at91_udp_read(udc, AT91_UDP_GLB_STAT) & AT91_UDP_ESR)
1125 tmp |= (1 << USB_DEVICE_REMOTE_WAKEUP);
1126 PACKET("get device status\n");
1127 __raw_writeb(tmp, dreg);
1128 __raw_writeb(0, dreg);
1129 goto write_in;
1130 /* then STATUS starts later, automatically */
1131 case ((USB_TYPE_STANDARD|USB_RECIP_DEVICE) << 8)
1132 | USB_REQ_SET_FEATURE:
1133 if (w_value != USB_DEVICE_REMOTE_WAKEUP)
1134 goto stall;
1135 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT);
1136 tmp |= AT91_UDP_ESR;
1137 at91_udp_write(udc, AT91_UDP_GLB_STAT, tmp);
1138 goto succeed;
1139 case ((USB_TYPE_STANDARD|USB_RECIP_DEVICE) << 8)
1140 | USB_REQ_CLEAR_FEATURE:
1141 if (w_value != USB_DEVICE_REMOTE_WAKEUP)
1142 goto stall;
1143 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT);
1144 tmp &= ~AT91_UDP_ESR;
1145 at91_udp_write(udc, AT91_UDP_GLB_STAT, tmp);
1146 goto succeed;
1149 * Interfaces have no feature settings; this is pretty useless.
1150 * we won't even insist the interface exists...
1152 case ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE) << 8)
1153 | USB_REQ_GET_STATUS:
1154 PACKET("get interface status\n");
1155 __raw_writeb(0, dreg);
1156 __raw_writeb(0, dreg);
1157 goto write_in;
1158 /* then STATUS starts later, automatically */
1159 case ((USB_TYPE_STANDARD|USB_RECIP_INTERFACE) << 8)
1160 | USB_REQ_SET_FEATURE:
1161 case ((USB_TYPE_STANDARD|USB_RECIP_INTERFACE) << 8)
1162 | USB_REQ_CLEAR_FEATURE:
1163 goto stall;
1166 * Hosts may clear bulk/intr endpoint halt after the gadget
1167 * driver sets it (not widely used); or set it (for testing)
1169 case ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT) << 8)
1170 | USB_REQ_GET_STATUS:
1171 tmp = w_index & USB_ENDPOINT_NUMBER_MASK;
1172 ep = &udc->ep[tmp];
1173 if (tmp >= NUM_ENDPOINTS || (tmp && !ep->desc))
1174 goto stall;
1176 if (tmp) {
1177 if ((w_index & USB_DIR_IN)) {
1178 if (!ep->is_in)
1179 goto stall;
1180 } else if (ep->is_in)
1181 goto stall;
1183 PACKET("get %s status\n", ep->ep.name);
1184 if (__raw_readl(ep->creg) & AT91_UDP_FORCESTALL)
1185 tmp = (1 << USB_ENDPOINT_HALT);
1186 else
1187 tmp = 0;
1188 __raw_writeb(tmp, dreg);
1189 __raw_writeb(0, dreg);
1190 goto write_in;
1191 /* then STATUS starts later, automatically */
1192 case ((USB_TYPE_STANDARD|USB_RECIP_ENDPOINT) << 8)
1193 | USB_REQ_SET_FEATURE:
1194 tmp = w_index & USB_ENDPOINT_NUMBER_MASK;
1195 ep = &udc->ep[tmp];
1196 if (w_value != USB_ENDPOINT_HALT || tmp >= NUM_ENDPOINTS)
1197 goto stall;
1198 if (!ep->desc || ep->is_iso)
1199 goto stall;
1200 if ((w_index & USB_DIR_IN)) {
1201 if (!ep->is_in)
1202 goto stall;
1203 } else if (ep->is_in)
1204 goto stall;
1206 tmp = __raw_readl(ep->creg);
1207 tmp &= ~SET_FX;
1208 tmp |= CLR_FX | AT91_UDP_FORCESTALL;
1209 __raw_writel(tmp, ep->creg);
1210 goto succeed;
1211 case ((USB_TYPE_STANDARD|USB_RECIP_ENDPOINT) << 8)
1212 | USB_REQ_CLEAR_FEATURE:
1213 tmp = w_index & USB_ENDPOINT_NUMBER_MASK;
1214 ep = &udc->ep[tmp];
1215 if (w_value != USB_ENDPOINT_HALT || tmp >= NUM_ENDPOINTS)
1216 goto stall;
1217 if (tmp == 0)
1218 goto succeed;
1219 if (!ep->desc || ep->is_iso)
1220 goto stall;
1221 if ((w_index & USB_DIR_IN)) {
1222 if (!ep->is_in)
1223 goto stall;
1224 } else if (ep->is_in)
1225 goto stall;
1227 at91_udp_write(udc, AT91_UDP_RST_EP, ep->int_mask);
1228 at91_udp_write(udc, AT91_UDP_RST_EP, 0);
1229 tmp = __raw_readl(ep->creg);
1230 tmp |= CLR_FX;
1231 tmp &= ~(SET_FX | AT91_UDP_FORCESTALL);
1232 __raw_writel(tmp, ep->creg);
1233 if (!list_empty(&ep->queue))
1234 handle_ep(ep);
1235 goto succeed;
1238 #undef w_value
1239 #undef w_index
1240 #undef w_length
1242 /* pass request up to the gadget driver */
1243 if (udc->driver) {
1244 spin_unlock(&udc->lock);
1245 status = udc->driver->setup(&udc->gadget, &pkt.r);
1246 spin_lock(&udc->lock);
1248 else
1249 status = -ENODEV;
1250 if (status < 0) {
1251 stall:
1252 VDBG("req %02x.%02x protocol STALL; stat %d\n",
1253 pkt.r.bRequestType, pkt.r.bRequest, status);
1254 csr |= AT91_UDP_FORCESTALL;
1255 __raw_writel(csr, creg);
1256 udc->req_pending = 0;
1258 return;
1260 succeed:
1261 /* immediate successful (IN) STATUS after zero length DATA */
1262 PACKET("ep0 in/status\n");
1263 write_in:
1264 csr |= AT91_UDP_TXPKTRDY;
1265 __raw_writel(csr, creg);
1266 udc->req_pending = 0;
1269 static void handle_ep0(struct at91_udc *udc)
1271 struct at91_ep *ep0 = &udc->ep[0];
1272 u32 __iomem *creg = ep0->creg;
1273 u32 csr = __raw_readl(creg);
1274 struct at91_request *req;
1276 if (unlikely(csr & AT91_UDP_STALLSENT)) {
1277 nuke(ep0, -EPROTO);
1278 udc->req_pending = 0;
1279 csr |= CLR_FX;
1280 csr &= ~(SET_FX | AT91_UDP_STALLSENT | AT91_UDP_FORCESTALL);
1281 __raw_writel(csr, creg);
1282 VDBG("ep0 stalled\n");
1283 csr = __raw_readl(creg);
1285 if (csr & AT91_UDP_RXSETUP) {
1286 nuke(ep0, 0);
1287 udc->req_pending = 0;
1288 handle_setup(udc, ep0, csr);
1289 return;
1292 if (list_empty(&ep0->queue))
1293 req = NULL;
1294 else
1295 req = list_entry(ep0->queue.next, struct at91_request, queue);
1297 /* host ACKed an IN packet that we sent */
1298 if (csr & AT91_UDP_TXCOMP) {
1299 csr |= CLR_FX;
1300 csr &= ~(SET_FX | AT91_UDP_TXCOMP);
1302 /* write more IN DATA? */
1303 if (req && ep0->is_in) {
1304 if (handle_ep(ep0))
1305 udc->req_pending = 0;
1308 * Ack after:
1309 * - last IN DATA packet (including GET_STATUS)
1310 * - IN/STATUS for OUT DATA
1311 * - IN/STATUS for any zero-length DATA stage
1312 * except for the IN DATA case, the host should send
1313 * an OUT status later, which we'll ack.
1315 } else {
1316 udc->req_pending = 0;
1317 __raw_writel(csr, creg);
1320 * SET_ADDRESS takes effect only after the STATUS
1321 * (to the original address) gets acked.
1323 if (udc->wait_for_addr_ack) {
1324 u32 tmp;
1326 at91_udp_write(udc, AT91_UDP_FADDR,
1327 AT91_UDP_FEN | udc->addr);
1328 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT);
1329 tmp &= ~AT91_UDP_FADDEN;
1330 if (udc->addr)
1331 tmp |= AT91_UDP_FADDEN;
1332 at91_udp_write(udc, AT91_UDP_GLB_STAT, tmp);
1334 udc->wait_for_addr_ack = 0;
1335 VDBG("address %d\n", udc->addr);
1340 /* OUT packet arrived ... */
1341 else if (csr & AT91_UDP_RX_DATA_BK0) {
1342 csr |= CLR_FX;
1343 csr &= ~(SET_FX | AT91_UDP_RX_DATA_BK0);
1345 /* OUT DATA stage */
1346 if (!ep0->is_in) {
1347 if (req) {
1348 if (handle_ep(ep0)) {
1349 /* send IN/STATUS */
1350 PACKET("ep0 in/status\n");
1351 csr = __raw_readl(creg);
1352 csr &= ~SET_FX;
1353 csr |= CLR_FX | AT91_UDP_TXPKTRDY;
1354 __raw_writel(csr, creg);
1355 udc->req_pending = 0;
1357 } else if (udc->req_pending) {
1359 * AT91 hardware has a hard time with this
1360 * "deferred response" mode for control-OUT
1361 * transfers. (For control-IN it's fine.)
1363 * The normal solution leaves OUT data in the
1364 * fifo until the gadget driver is ready.
1365 * We couldn't do that here without disabling
1366 * the IRQ that tells about SETUP packets,
1367 * e.g. when the host gets impatient...
1369 * Working around it by copying into a buffer
1370 * would almost be a non-deferred response,
1371 * except that it wouldn't permit reliable
1372 * stalling of the request. Instead, demand
1373 * that gadget drivers not use this mode.
1375 DBG("no control-OUT deferred responses!\n");
1376 __raw_writel(csr | AT91_UDP_FORCESTALL, creg);
1377 udc->req_pending = 0;
1380 /* STATUS stage for control-IN; ack. */
1381 } else {
1382 PACKET("ep0 out/status ACK\n");
1383 __raw_writel(csr, creg);
1385 /* "early" status stage */
1386 if (req)
1387 done(ep0, req, 0);
1392 static irqreturn_t at91_udc_irq (int irq, void *_udc)
1394 struct at91_udc *udc = _udc;
1395 u32 rescans = 5;
1396 int disable_clock = 0;
1397 unsigned long flags;
1399 spin_lock_irqsave(&udc->lock, flags);
1401 if (!udc->clocked) {
1402 clk_on(udc);
1403 disable_clock = 1;
1406 while (rescans--) {
1407 u32 status;
1409 status = at91_udp_read(udc, AT91_UDP_ISR)
1410 & at91_udp_read(udc, AT91_UDP_IMR);
1411 if (!status)
1412 break;
1414 /* USB reset irq: not maskable */
1415 if (status & AT91_UDP_ENDBUSRES) {
1416 at91_udp_write(udc, AT91_UDP_IDR, ~MINIMUS_INTERRUPTUS);
1417 at91_udp_write(udc, AT91_UDP_IER, MINIMUS_INTERRUPTUS);
1418 /* Atmel code clears this irq twice */
1419 at91_udp_write(udc, AT91_UDP_ICR, AT91_UDP_ENDBUSRES);
1420 at91_udp_write(udc, AT91_UDP_ICR, AT91_UDP_ENDBUSRES);
1421 VDBG("end bus reset\n");
1422 udc->addr = 0;
1423 stop_activity(udc);
1425 /* enable ep0 */
1426 at91_udp_write(udc, AT91_UDP_CSR(0),
1427 AT91_UDP_EPEDS | AT91_UDP_EPTYPE_CTRL);
1428 udc->gadget.speed = USB_SPEED_FULL;
1429 udc->suspended = 0;
1430 at91_udp_write(udc, AT91_UDP_IER, AT91_UDP_EP(0));
1433 * NOTE: this driver keeps clocks off unless the
1434 * USB host is present. That saves power, but for
1435 * boards that don't support VBUS detection, both
1436 * clocks need to be active most of the time.
1439 /* host initiated suspend (3+ms bus idle) */
1440 } else if (status & AT91_UDP_RXSUSP) {
1441 at91_udp_write(udc, AT91_UDP_IDR, AT91_UDP_RXSUSP);
1442 at91_udp_write(udc, AT91_UDP_IER, AT91_UDP_RXRSM);
1443 at91_udp_write(udc, AT91_UDP_ICR, AT91_UDP_RXSUSP);
1444 /* VDBG("bus suspend\n"); */
1445 if (udc->suspended)
1446 continue;
1447 udc->suspended = 1;
1450 * NOTE: when suspending a VBUS-powered device, the
1451 * gadget driver should switch into slow clock mode
1452 * and then into standby to avoid drawing more than
1453 * 500uA power (2500uA for some high-power configs).
1455 if (udc->driver && udc->driver->suspend) {
1456 spin_unlock(&udc->lock);
1457 udc->driver->suspend(&udc->gadget);
1458 spin_lock(&udc->lock);
1461 /* host initiated resume */
1462 } else if (status & AT91_UDP_RXRSM) {
1463 at91_udp_write(udc, AT91_UDP_IDR, AT91_UDP_RXRSM);
1464 at91_udp_write(udc, AT91_UDP_IER, AT91_UDP_RXSUSP);
1465 at91_udp_write(udc, AT91_UDP_ICR, AT91_UDP_RXRSM);
1466 /* VDBG("bus resume\n"); */
1467 if (!udc->suspended)
1468 continue;
1469 udc->suspended = 0;
1472 * NOTE: for a VBUS-powered device, the gadget driver
1473 * would normally want to switch out of slow clock
1474 * mode into normal mode.
1476 if (udc->driver && udc->driver->resume) {
1477 spin_unlock(&udc->lock);
1478 udc->driver->resume(&udc->gadget);
1479 spin_lock(&udc->lock);
1482 /* endpoint IRQs are cleared by handling them */
1483 } else {
1484 int i;
1485 unsigned mask = 1;
1486 struct at91_ep *ep = &udc->ep[1];
1488 if (status & mask)
1489 handle_ep0(udc);
1490 for (i = 1; i < NUM_ENDPOINTS; i++) {
1491 mask <<= 1;
1492 if (status & mask)
1493 handle_ep(ep);
1494 ep++;
1499 if (disable_clock)
1500 clk_off(udc);
1502 spin_unlock_irqrestore(&udc->lock, flags);
1504 return IRQ_HANDLED;
1507 /*-------------------------------------------------------------------------*/
1509 static void nop_release(struct device *dev)
1511 /* nothing to free */
1514 static struct at91_udc controller = {
1515 .gadget = {
1516 .ops = &at91_udc_ops,
1517 .ep0 = &controller.ep[0].ep,
1518 .name = driver_name,
1519 .dev = {
1520 .init_name = "gadget",
1521 .release = nop_release,
1524 .ep[0] = {
1525 .ep = {
1526 .name = ep0name,
1527 .ops = &at91_ep_ops,
1529 .udc = &controller,
1530 .maxpacket = 8,
1531 .int_mask = 1 << 0,
1533 .ep[1] = {
1534 .ep = {
1535 .name = "ep1",
1536 .ops = &at91_ep_ops,
1538 .udc = &controller,
1539 .is_pingpong = 1,
1540 .maxpacket = 64,
1541 .int_mask = 1 << 1,
1543 .ep[2] = {
1544 .ep = {
1545 .name = "ep2",
1546 .ops = &at91_ep_ops,
1548 .udc = &controller,
1549 .is_pingpong = 1,
1550 .maxpacket = 64,
1551 .int_mask = 1 << 2,
1553 .ep[3] = {
1554 .ep = {
1555 /* could actually do bulk too */
1556 .name = "ep3-int",
1557 .ops = &at91_ep_ops,
1559 .udc = &controller,
1560 .maxpacket = 8,
1561 .int_mask = 1 << 3,
1563 .ep[4] = {
1564 .ep = {
1565 .name = "ep4",
1566 .ops = &at91_ep_ops,
1568 .udc = &controller,
1569 .is_pingpong = 1,
1570 .maxpacket = 256,
1571 .int_mask = 1 << 4,
1573 .ep[5] = {
1574 .ep = {
1575 .name = "ep5",
1576 .ops = &at91_ep_ops,
1578 .udc = &controller,
1579 .is_pingpong = 1,
1580 .maxpacket = 256,
1581 .int_mask = 1 << 5,
1583 /* ep6 and ep7 are also reserved (custom silicon might use them) */
1586 static void at91_vbus_update(struct at91_udc *udc, unsigned value)
1588 value ^= udc->board.vbus_active_low;
1589 if (value != udc->vbus)
1590 at91_vbus_session(&udc->gadget, value);
1593 static irqreturn_t at91_vbus_irq(int irq, void *_udc)
1595 struct at91_udc *udc = _udc;
1597 /* vbus needs at least brief debouncing */
1598 udelay(10);
1599 at91_vbus_update(udc, gpio_get_value(udc->board.vbus_pin));
1601 return IRQ_HANDLED;
1604 static void at91_vbus_timer_work(struct work_struct *work)
1606 struct at91_udc *udc = container_of(work, struct at91_udc,
1607 vbus_timer_work);
1609 at91_vbus_update(udc, gpio_get_value_cansleep(udc->board.vbus_pin));
1611 if (!timer_pending(&udc->vbus_timer))
1612 mod_timer(&udc->vbus_timer, jiffies + VBUS_POLL_TIMEOUT);
1615 static void at91_vbus_timer(unsigned long data)
1617 struct at91_udc *udc = (struct at91_udc *)data;
1620 * If we are polling vbus it is likely that the gpio is on an
1621 * bus such as i2c or spi which may sleep, so schedule some work
1622 * to read the vbus gpio
1624 if (!work_pending(&udc->vbus_timer_work))
1625 schedule_work(&udc->vbus_timer_work);
1628 static int at91_start(struct usb_gadget_driver *driver,
1629 int (*bind)(struct usb_gadget *))
1631 struct at91_udc *udc = &controller;
1632 int retval;
1633 unsigned long flags;
1635 if (!driver
1636 || driver->speed < USB_SPEED_FULL
1637 || !bind
1638 || !driver->setup) {
1639 DBG("bad parameter.\n");
1640 return -EINVAL;
1643 if (udc->driver) {
1644 DBG("UDC already has a gadget driver\n");
1645 return -EBUSY;
1648 udc->driver = driver;
1649 udc->gadget.dev.driver = &driver->driver;
1650 dev_set_drvdata(&udc->gadget.dev, &driver->driver);
1651 udc->enabled = 1;
1652 udc->selfpowered = 1;
1654 retval = bind(&udc->gadget);
1655 if (retval) {
1656 DBG("bind() returned %d\n", retval);
1657 udc->driver = NULL;
1658 udc->gadget.dev.driver = NULL;
1659 dev_set_drvdata(&udc->gadget.dev, NULL);
1660 udc->enabled = 0;
1661 udc->selfpowered = 0;
1662 return retval;
1665 spin_lock_irqsave(&udc->lock, flags);
1666 pullup(udc, 1);
1667 spin_unlock_irqrestore(&udc->lock, flags);
1669 DBG("bound to %s\n", driver->driver.name);
1670 return 0;
1673 static int at91_stop(struct usb_gadget_driver *driver)
1675 struct at91_udc *udc = &controller;
1676 unsigned long flags;
1678 if (!driver || driver != udc->driver || !driver->unbind)
1679 return -EINVAL;
1681 spin_lock_irqsave(&udc->lock, flags);
1682 udc->enabled = 0;
1683 at91_udp_write(udc, AT91_UDP_IDR, ~0);
1684 pullup(udc, 0);
1685 spin_unlock_irqrestore(&udc->lock, flags);
1687 driver->unbind(&udc->gadget);
1688 udc->gadget.dev.driver = NULL;
1689 dev_set_drvdata(&udc->gadget.dev, NULL);
1690 udc->driver = NULL;
1692 DBG("unbound from %s\n", driver->driver.name);
1693 return 0;
1696 /*-------------------------------------------------------------------------*/
1698 static void at91udc_shutdown(struct platform_device *dev)
1700 struct at91_udc *udc = platform_get_drvdata(dev);
1701 unsigned long flags;
1703 /* force disconnect on reboot */
1704 spin_lock_irqsave(&udc->lock, flags);
1705 pullup(platform_get_drvdata(dev), 0);
1706 spin_unlock_irqrestore(&udc->lock, flags);
1709 static int __init at91udc_probe(struct platform_device *pdev)
1711 struct device *dev = &pdev->dev;
1712 struct at91_udc *udc;
1713 int retval;
1714 struct resource *res;
1716 if (!dev->platform_data) {
1717 /* small (so we copy it) but critical! */
1718 DBG("missing platform_data\n");
1719 return -ENODEV;
1722 if (pdev->num_resources != 2) {
1723 DBG("invalid num_resources\n");
1724 return -ENODEV;
1726 if ((pdev->resource[0].flags != IORESOURCE_MEM)
1727 || (pdev->resource[1].flags != IORESOURCE_IRQ)) {
1728 DBG("invalid resource type\n");
1729 return -ENODEV;
1732 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1733 if (!res)
1734 return -ENXIO;
1736 if (!request_mem_region(res->start, resource_size(res), driver_name)) {
1737 DBG("someone's using UDC memory\n");
1738 return -EBUSY;
1741 /* init software state */
1742 udc = &controller;
1743 udc->gadget.dev.parent = dev;
1744 udc->board = *(struct at91_udc_data *) dev->platform_data;
1745 udc->pdev = pdev;
1746 udc->enabled = 0;
1747 spin_lock_init(&udc->lock);
1749 /* rm9200 needs manual D+ pullup; off by default */
1750 if (cpu_is_at91rm9200()) {
1751 if (udc->board.pullup_pin <= 0) {
1752 DBG("no D+ pullup?\n");
1753 retval = -ENODEV;
1754 goto fail0;
1756 retval = gpio_request(udc->board.pullup_pin, "udc_pullup");
1757 if (retval) {
1758 DBG("D+ pullup is busy\n");
1759 goto fail0;
1761 gpio_direction_output(udc->board.pullup_pin,
1762 udc->board.pullup_active_low);
1765 /* newer chips have more FIFO memory than rm9200 */
1766 if (cpu_is_at91sam9260() || cpu_is_at91sam9g20()) {
1767 udc->ep[0].maxpacket = 64;
1768 udc->ep[3].maxpacket = 64;
1769 udc->ep[4].maxpacket = 512;
1770 udc->ep[5].maxpacket = 512;
1771 } else if (cpu_is_at91sam9261() || cpu_is_at91sam9g10()) {
1772 udc->ep[3].maxpacket = 64;
1773 } else if (cpu_is_at91sam9263()) {
1774 udc->ep[0].maxpacket = 64;
1775 udc->ep[3].maxpacket = 64;
1778 udc->udp_baseaddr = ioremap(res->start, resource_size(res));
1779 if (!udc->udp_baseaddr) {
1780 retval = -ENOMEM;
1781 goto fail0a;
1784 udc_reinit(udc);
1786 /* get interface and function clocks */
1787 udc->iclk = clk_get(dev, "udc_clk");
1788 udc->fclk = clk_get(dev, "udpck");
1789 if (IS_ERR(udc->iclk) || IS_ERR(udc->fclk)) {
1790 DBG("clocks missing\n");
1791 retval = -ENODEV;
1792 /* NOTE: we "know" here that refcounts on these are NOPs */
1793 goto fail0b;
1796 retval = device_register(&udc->gadget.dev);
1797 if (retval < 0) {
1798 put_device(&udc->gadget.dev);
1799 goto fail0b;
1802 /* don't do anything until we have both gadget driver and VBUS */
1803 clk_enable(udc->iclk);
1804 at91_udp_write(udc, AT91_UDP_TXVC, AT91_UDP_TXVC_TXVDIS);
1805 at91_udp_write(udc, AT91_UDP_IDR, 0xffffffff);
1806 /* Clear all pending interrupts - UDP may be used by bootloader. */
1807 at91_udp_write(udc, AT91_UDP_ICR, 0xffffffff);
1808 clk_disable(udc->iclk);
1810 /* request UDC and maybe VBUS irqs */
1811 udc->udp_irq = platform_get_irq(pdev, 0);
1812 retval = request_irq(udc->udp_irq, at91_udc_irq,
1813 0, driver_name, udc);
1814 if (retval < 0) {
1815 DBG("request irq %d failed\n", udc->udp_irq);
1816 goto fail1;
1818 if (udc->board.vbus_pin > 0) {
1819 retval = gpio_request(udc->board.vbus_pin, "udc_vbus");
1820 if (retval < 0) {
1821 DBG("request vbus pin failed\n");
1822 goto fail2;
1824 gpio_direction_input(udc->board.vbus_pin);
1827 * Get the initial state of VBUS - we cannot expect
1828 * a pending interrupt.
1830 udc->vbus = gpio_get_value_cansleep(udc->board.vbus_pin) ^
1831 udc->board.vbus_active_low;
1833 if (udc->board.vbus_polled) {
1834 INIT_WORK(&udc->vbus_timer_work, at91_vbus_timer_work);
1835 setup_timer(&udc->vbus_timer, at91_vbus_timer,
1836 (unsigned long)udc);
1837 mod_timer(&udc->vbus_timer,
1838 jiffies + VBUS_POLL_TIMEOUT);
1839 } else {
1840 if (request_irq(udc->board.vbus_pin, at91_vbus_irq,
1841 0, driver_name, udc)) {
1842 DBG("request vbus irq %d failed\n",
1843 udc->board.vbus_pin);
1844 retval = -EBUSY;
1845 goto fail3;
1848 } else {
1849 DBG("no VBUS detection, assuming always-on\n");
1850 udc->vbus = 1;
1852 retval = usb_add_gadget_udc(dev, &udc->gadget);
1853 if (retval)
1854 goto fail4;
1855 dev_set_drvdata(dev, udc);
1856 device_init_wakeup(dev, 1);
1857 create_debug_file(udc);
1859 INFO("%s version %s\n", driver_name, DRIVER_VERSION);
1860 return 0;
1861 fail4:
1862 if (udc->board.vbus_pin > 0 && !udc->board.vbus_polled)
1863 free_irq(udc->board.vbus_pin, udc);
1864 fail3:
1865 if (udc->board.vbus_pin > 0)
1866 gpio_free(udc->board.vbus_pin);
1867 fail2:
1868 free_irq(udc->udp_irq, udc);
1869 fail1:
1870 device_unregister(&udc->gadget.dev);
1871 fail0b:
1872 iounmap(udc->udp_baseaddr);
1873 fail0a:
1874 if (cpu_is_at91rm9200())
1875 gpio_free(udc->board.pullup_pin);
1876 fail0:
1877 release_mem_region(res->start, resource_size(res));
1878 DBG("%s probe failed, %d\n", driver_name, retval);
1879 return retval;
1882 static int __exit at91udc_remove(struct platform_device *pdev)
1884 struct at91_udc *udc = platform_get_drvdata(pdev);
1885 struct resource *res;
1886 unsigned long flags;
1888 DBG("remove\n");
1890 usb_del_gadget_udc(&udc->gadget);
1891 if (udc->driver)
1892 return -EBUSY;
1894 spin_lock_irqsave(&udc->lock, flags);
1895 pullup(udc, 0);
1896 spin_unlock_irqrestore(&udc->lock, flags);
1898 device_init_wakeup(&pdev->dev, 0);
1899 remove_debug_file(udc);
1900 if (udc->board.vbus_pin > 0) {
1901 free_irq(udc->board.vbus_pin, udc);
1902 gpio_free(udc->board.vbus_pin);
1904 free_irq(udc->udp_irq, udc);
1905 device_unregister(&udc->gadget.dev);
1907 iounmap(udc->udp_baseaddr);
1909 if (cpu_is_at91rm9200())
1910 gpio_free(udc->board.pullup_pin);
1912 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1913 release_mem_region(res->start, resource_size(res));
1915 clk_put(udc->iclk);
1916 clk_put(udc->fclk);
1918 return 0;
1921 #ifdef CONFIG_PM
1922 static int at91udc_suspend(struct platform_device *pdev, pm_message_t mesg)
1924 struct at91_udc *udc = platform_get_drvdata(pdev);
1925 int wake = udc->driver && device_may_wakeup(&pdev->dev);
1926 unsigned long flags;
1928 /* Unless we can act normally to the host (letting it wake us up
1929 * whenever it has work for us) force disconnect. Wakeup requires
1930 * PLLB for USB events (signaling for reset, wakeup, or incoming
1931 * tokens) and VBUS irqs (on systems which support them).
1933 if ((!udc->suspended && udc->addr)
1934 || !wake
1935 || at91_suspend_entering_slow_clock()) {
1936 spin_lock_irqsave(&udc->lock, flags);
1937 pullup(udc, 0);
1938 wake = 0;
1939 spin_unlock_irqrestore(&udc->lock, flags);
1940 } else
1941 enable_irq_wake(udc->udp_irq);
1943 udc->active_suspend = wake;
1944 if (udc->board.vbus_pin > 0 && !udc->board.vbus_polled && wake)
1945 enable_irq_wake(udc->board.vbus_pin);
1946 return 0;
1949 static int at91udc_resume(struct platform_device *pdev)
1951 struct at91_udc *udc = platform_get_drvdata(pdev);
1952 unsigned long flags;
1954 if (udc->board.vbus_pin > 0 && !udc->board.vbus_polled &&
1955 udc->active_suspend)
1956 disable_irq_wake(udc->board.vbus_pin);
1958 /* maybe reconnect to host; if so, clocks on */
1959 if (udc->active_suspend)
1960 disable_irq_wake(udc->udp_irq);
1961 else {
1962 spin_lock_irqsave(&udc->lock, flags);
1963 pullup(udc, 1);
1964 spin_unlock_irqrestore(&udc->lock, flags);
1966 return 0;
1968 #else
1969 #define at91udc_suspend NULL
1970 #define at91udc_resume NULL
1971 #endif
1973 static struct platform_driver at91_udc_driver = {
1974 .remove = __exit_p(at91udc_remove),
1975 .shutdown = at91udc_shutdown,
1976 .suspend = at91udc_suspend,
1977 .resume = at91udc_resume,
1978 .driver = {
1979 .name = (char *) driver_name,
1980 .owner = THIS_MODULE,
1984 static int __init udc_init_module(void)
1986 return platform_driver_probe(&at91_udc_driver, at91udc_probe);
1988 module_init(udc_init_module);
1990 static void __exit udc_exit_module(void)
1992 platform_driver_unregister(&at91_udc_driver);
1994 module_exit(udc_exit_module);
1996 MODULE_DESCRIPTION("AT91 udc driver");
1997 MODULE_AUTHOR("Thomas Rathbone, David Brownell");
1998 MODULE_LICENSE("GPL");
1999 MODULE_ALIAS("platform:at91_udc");