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.
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 <linux/of_gpio.h>
36 #include <asm/byteorder.h>
37 #include <mach/hardware.h>
40 #include <asm/system.h>
43 #include <mach/board.h>
45 #include <mach/at91sam9261_matrix.h>
46 #include <mach/at91_matrix.h>
52 * This controller is simple and PIO-only. It's used in many AT91-series
53 * full speed USB controllers, including the at91rm9200 (arm920T, with MMU),
54 * at91sam926x (arm926ejs, with MMU), and several no-mmu versions.
56 * This driver expects the board has been wired with two GPIOs suppporting
57 * a VBUS sensing IRQ, and a D+ pullup. (They may be omitted, but the
58 * testing hasn't covered such cases.)
60 * The pullup is most important (so it's integrated on sam926x parts). It
61 * provides software control over whether the host enumerates the device.
63 * The VBUS sensing helps during enumeration, and allows both USB clocks
64 * (and the transceiver) to stay gated off until they're necessary, saving
65 * power. During USB suspend, the 48 MHz clock is gated off in hardware;
66 * it may also be gated off by software during some Linux sleep states.
69 #define DRIVER_VERSION "3 May 2006"
71 static const char driver_name [] = "at91_udc";
72 static const char ep0name[] = "ep0";
74 #define VBUS_POLL_TIMEOUT msecs_to_jiffies(1000)
76 #define at91_udp_read(udc, reg) \
77 __raw_readl((udc)->udp_baseaddr + (reg))
78 #define at91_udp_write(udc, reg, val) \
79 __raw_writel((val), (udc)->udp_baseaddr + (reg))
81 /*-------------------------------------------------------------------------*/
83 #ifdef CONFIG_USB_GADGET_DEBUG_FILES
85 #include <linux/seq_file.h>
87 static const char debug_filename[] = "driver/udc";
89 #define FOURBITS "%s%s%s%s"
90 #define EIGHTBITS FOURBITS FOURBITS
92 static void proc_ep_show(struct seq_file *s, struct at91_ep *ep)
94 static char *types[] = {
95 "control", "out-iso", "out-bulk", "out-int",
96 "BOGUS", "in-iso", "in-bulk", "in-int"};
99 struct at91_request *req;
101 struct at91_udc *udc = ep->udc;
103 spin_lock_irqsave(&udc->lock, flags);
105 csr = __raw_readl(ep->creg);
107 /* NOTE: not collecting per-endpoint irq statistics... */
110 seq_printf(s, "%s, maxpacket %d %s%s %s%s\n",
111 ep->ep.name, ep->ep.maxpacket,
112 ep->is_in ? "in" : "out",
113 ep->is_iso ? " iso" : "",
115 ? (ep->fifo_bank ? "pong" : "ping")
117 ep->stopped ? " stopped" : "");
118 seq_printf(s, "csr %08x rxbytes=%d %s %s %s" EIGHTBITS "\n",
120 (csr & 0x07ff0000) >> 16,
121 (csr & (1 << 15)) ? "enabled" : "disabled",
122 (csr & (1 << 11)) ? "DATA1" : "DATA0",
123 types[(csr & 0x700) >> 8],
125 /* iff type is control then print current direction */
127 ? ((csr & (1 << 7)) ? " IN" : " OUT")
129 (csr & (1 << 6)) ? " rxdatabk1" : "",
130 (csr & (1 << 5)) ? " forcestall" : "",
131 (csr & (1 << 4)) ? " txpktrdy" : "",
133 (csr & (1 << 3)) ? " stallsent" : "",
134 (csr & (1 << 2)) ? " rxsetup" : "",
135 (csr & (1 << 1)) ? " rxdatabk0" : "",
136 (csr & (1 << 0)) ? " txcomp" : "");
137 if (list_empty (&ep->queue))
138 seq_printf(s, "\t(queue empty)\n");
140 else list_for_each_entry (req, &ep->queue, queue) {
141 unsigned length = req->req.actual;
143 seq_printf(s, "\treq %p len %d/%d buf %p\n",
145 req->req.length, req->req.buf);
147 spin_unlock_irqrestore(&udc->lock, flags);
150 static void proc_irq_show(struct seq_file *s, const char *label, u32 mask)
154 seq_printf(s, "%s %04x:%s%s" FOURBITS, label, mask,
155 (mask & (1 << 13)) ? " wakeup" : "",
156 (mask & (1 << 12)) ? " endbusres" : "",
158 (mask & (1 << 11)) ? " sofint" : "",
159 (mask & (1 << 10)) ? " extrsm" : "",
160 (mask & (1 << 9)) ? " rxrsm" : "",
161 (mask & (1 << 8)) ? " rxsusp" : "");
162 for (i = 0; i < 8; i++) {
164 seq_printf(s, " ep%d", i);
169 static int proc_udc_show(struct seq_file *s, void *unused)
171 struct at91_udc *udc = s->private;
175 seq_printf(s, "%s: version %s\n", driver_name, DRIVER_VERSION);
177 seq_printf(s, "vbus %s, pullup %s, %s powered%s, gadget %s\n\n",
178 udc->vbus ? "present" : "off",
180 ? (udc->vbus ? "active" : "enabled")
182 udc->selfpowered ? "self" : "VBUS",
183 udc->suspended ? ", suspended" : "",
184 udc->driver ? udc->driver->driver.name : "(none)");
186 /* don't access registers when interface isn't clocked */
188 seq_printf(s, "(not clocked)\n");
192 tmp = at91_udp_read(udc, AT91_UDP_FRM_NUM);
193 seq_printf(s, "frame %05x:%s%s frame=%d\n", tmp,
194 (tmp & AT91_UDP_FRM_OK) ? " ok" : "",
195 (tmp & AT91_UDP_FRM_ERR) ? " err" : "",
196 (tmp & AT91_UDP_NUM));
198 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT);
199 seq_printf(s, "glbstate %02x:%s" FOURBITS "\n", tmp,
200 (tmp & AT91_UDP_RMWUPE) ? " rmwupe" : "",
201 (tmp & AT91_UDP_RSMINPR) ? " rsminpr" : "",
202 (tmp & AT91_UDP_ESR) ? " esr" : "",
203 (tmp & AT91_UDP_CONFG) ? " confg" : "",
204 (tmp & AT91_UDP_FADDEN) ? " fadden" : "");
206 tmp = at91_udp_read(udc, AT91_UDP_FADDR);
207 seq_printf(s, "faddr %03x:%s fadd=%d\n", tmp,
208 (tmp & AT91_UDP_FEN) ? " fen" : "",
209 (tmp & AT91_UDP_FADD));
211 proc_irq_show(s, "imr ", at91_udp_read(udc, AT91_UDP_IMR));
212 proc_irq_show(s, "isr ", at91_udp_read(udc, AT91_UDP_ISR));
214 if (udc->enabled && udc->vbus) {
215 proc_ep_show(s, &udc->ep[0]);
216 list_for_each_entry (ep, &udc->gadget.ep_list, ep.ep_list) {
224 static int proc_udc_open(struct inode *inode, struct file *file)
226 return single_open(file, proc_udc_show, PDE(inode)->data);
229 static const struct file_operations proc_ops = {
230 .owner = THIS_MODULE,
231 .open = proc_udc_open,
234 .release = single_release,
237 static void create_debug_file(struct at91_udc *udc)
239 udc->pde = proc_create_data(debug_filename, 0, NULL, &proc_ops, udc);
242 static void remove_debug_file(struct at91_udc *udc)
245 remove_proc_entry(debug_filename, NULL);
250 static inline void create_debug_file(struct at91_udc *udc) {}
251 static inline void remove_debug_file(struct at91_udc *udc) {}
256 /*-------------------------------------------------------------------------*/
258 static void done(struct at91_ep *ep, struct at91_request *req, int status)
260 unsigned stopped = ep->stopped;
261 struct at91_udc *udc = ep->udc;
263 list_del_init(&req->queue);
264 if (req->req.status == -EINPROGRESS)
265 req->req.status = status;
267 status = req->req.status;
268 if (status && status != -ESHUTDOWN)
269 VDBG("%s done %p, status %d\n", ep->ep.name, req, status);
272 spin_unlock(&udc->lock);
273 req->req.complete(&ep->ep, &req->req);
274 spin_lock(&udc->lock);
275 ep->stopped = stopped;
277 /* ep0 is always ready; other endpoints need a non-empty queue */
278 if (list_empty(&ep->queue) && ep->int_mask != (1 << 0))
279 at91_udp_write(udc, AT91_UDP_IDR, ep->int_mask);
282 /*-------------------------------------------------------------------------*/
284 /* bits indicating OUT fifo has data ready */
285 #define RX_DATA_READY (AT91_UDP_RX_DATA_BK0 | AT91_UDP_RX_DATA_BK1)
288 * Endpoint FIFO CSR bits have a mix of bits, making it unsafe to just write
289 * back most of the value you just read (because of side effects, including
290 * bits that may change after reading and before writing).
292 * Except when changing a specific bit, always write values which:
293 * - clear SET_FX bits (setting them could change something)
294 * - set CLR_FX bits (clearing them could change something)
296 * There are also state bits like FORCESTALL, EPEDS, DIR, and EPTYPE
297 * that shouldn't normally be changed.
299 * NOTE at91sam9260 docs mention synch between UDPCK and MCK clock domains,
300 * implying a need to wait for one write to complete (test relevant bits)
301 * before starting the next write. This shouldn't be an issue given how
302 * infrequently we write, except maybe for write-then-read idioms.
304 #define SET_FX (AT91_UDP_TXPKTRDY)
305 #define CLR_FX (RX_DATA_READY | AT91_UDP_RXSETUP \
306 | AT91_UDP_STALLSENT | AT91_UDP_TXCOMP)
308 /* pull OUT packet data from the endpoint's fifo */
309 static int read_fifo (struct at91_ep *ep, struct at91_request *req)
311 u32 __iomem *creg = ep->creg;
312 u8 __iomem *dreg = ep->creg + (AT91_UDP_FDR(0) - AT91_UDP_CSR(0));
315 unsigned int count, bufferspace, is_done;
317 buf = req->req.buf + req->req.actual;
318 bufferspace = req->req.length - req->req.actual;
321 * there might be nothing to read if ep_queue() calls us,
322 * or if we already emptied both pingpong buffers
325 csr = __raw_readl(creg);
326 if ((csr & RX_DATA_READY) == 0)
329 count = (csr & AT91_UDP_RXBYTECNT) >> 16;
330 if (count > ep->ep.maxpacket)
331 count = ep->ep.maxpacket;
332 if (count > bufferspace) {
333 DBG("%s buffer overflow\n", ep->ep.name);
334 req->req.status = -EOVERFLOW;
337 __raw_readsb(dreg, buf, count);
339 /* release and swap pingpong mem bank */
341 if (ep->is_pingpong) {
342 if (ep->fifo_bank == 0) {
343 csr &= ~(SET_FX | AT91_UDP_RX_DATA_BK0);
346 csr &= ~(SET_FX | AT91_UDP_RX_DATA_BK1);
350 csr &= ~(SET_FX | AT91_UDP_RX_DATA_BK0);
351 __raw_writel(csr, creg);
353 req->req.actual += count;
354 is_done = (count < ep->ep.maxpacket);
355 if (count == bufferspace)
358 PACKET("%s %p out/%d%s\n", ep->ep.name, &req->req, count,
359 is_done ? " (done)" : "");
362 * avoid extra trips through IRQ logic for packets already in
363 * the fifo ... maybe preventing an extra (expensive) OUT-NAK
367 else if (ep->is_pingpong) {
369 * One dummy read to delay the code because of a HW glitch:
370 * CSR returns bad RXCOUNT when read too soon after updating
373 csr = __raw_readl(creg);
375 bufferspace -= count;
383 /* load fifo for an IN packet */
384 static int write_fifo(struct at91_ep *ep, struct at91_request *req)
386 u32 __iomem *creg = ep->creg;
387 u32 csr = __raw_readl(creg);
388 u8 __iomem *dreg = ep->creg + (AT91_UDP_FDR(0) - AT91_UDP_CSR(0));
389 unsigned total, count, is_last;
393 * TODO: allow for writing two packets to the fifo ... that'll
394 * reduce the amount of IN-NAKing, but probably won't affect
395 * throughput much. (Unlike preventing OUT-NAKing!)
399 * If ep_queue() calls us, the queue is empty and possibly in
400 * odd states like TXCOMP not yet cleared (we do it, saving at
401 * least one IRQ) or the fifo not yet being free. Those aren't
402 * issues normally (IRQ handler fast path).
404 if (unlikely(csr & (AT91_UDP_TXCOMP | AT91_UDP_TXPKTRDY))) {
405 if (csr & AT91_UDP_TXCOMP) {
407 csr &= ~(SET_FX | AT91_UDP_TXCOMP);
408 __raw_writel(csr, creg);
409 csr = __raw_readl(creg);
411 if (csr & AT91_UDP_TXPKTRDY)
415 buf = req->req.buf + req->req.actual;
417 total = req->req.length - req->req.actual;
418 if (ep->ep.maxpacket < total) {
419 count = ep->ep.maxpacket;
423 is_last = (count < ep->ep.maxpacket) || !req->req.zero;
427 * Write the packet, maybe it's a ZLP.
429 * NOTE: incrementing req->actual before we receive the ACK means
430 * gadget driver IN bytecounts can be wrong in fault cases. That's
431 * fixable with PIO drivers like this one (save "count" here, and
432 * do the increment later on TX irq), but not for most DMA hardware.
434 * So all gadget drivers must accept that potential error. Some
435 * hardware supports precise fifo status reporting, letting them
436 * recover when the actual bytecount matters (e.g. for USB Test
437 * and Measurement Class devices).
439 __raw_writesb(dreg, buf, count);
441 csr |= CLR_FX | AT91_UDP_TXPKTRDY;
442 __raw_writel(csr, creg);
443 req->req.actual += count;
445 PACKET("%s %p in/%d%s\n", ep->ep.name, &req->req, count,
446 is_last ? " (done)" : "");
452 static void nuke(struct at91_ep *ep, int status)
454 struct at91_request *req;
456 /* terminate any request in the queue */
458 if (list_empty(&ep->queue))
461 VDBG("%s %s\n", __func__, ep->ep.name);
462 while (!list_empty(&ep->queue)) {
463 req = list_entry(ep->queue.next, struct at91_request, queue);
464 done(ep, req, status);
468 /*-------------------------------------------------------------------------*/
470 static int at91_ep_enable(struct usb_ep *_ep,
471 const struct usb_endpoint_descriptor *desc)
473 struct at91_ep *ep = container_of(_ep, struct at91_ep, ep);
474 struct at91_udc *udc = ep->udc;
481 || _ep->name == ep0name
482 || desc->bDescriptorType != USB_DT_ENDPOINT
483 || (maxpacket = usb_endpoint_maxp(desc)) == 0
484 || maxpacket > ep->maxpacket) {
485 DBG("bad ep or descriptor\n");
489 if (!udc->driver || udc->gadget.speed == USB_SPEED_UNKNOWN) {
490 DBG("bogus device state\n");
494 tmp = usb_endpoint_type(desc);
496 case USB_ENDPOINT_XFER_CONTROL:
497 DBG("only one control endpoint\n");
499 case USB_ENDPOINT_XFER_INT:
503 case USB_ENDPOINT_XFER_BULK:
512 DBG("bogus maxpacket %d\n", maxpacket);
514 case USB_ENDPOINT_XFER_ISOC:
515 if (!ep->is_pingpong) {
516 DBG("iso requires double buffering\n");
523 spin_lock_irqsave(&udc->lock, flags);
525 /* initialize endpoint to match this descriptor */
526 ep->is_in = usb_endpoint_dir_in(desc);
527 ep->is_iso = (tmp == USB_ENDPOINT_XFER_ISOC);
532 tmp |= AT91_UDP_EPEDS;
533 __raw_writel(tmp, ep->creg);
536 ep->ep.maxpacket = maxpacket;
539 * reset/init endpoint fifo. NOTE: leaves fifo_bank alone,
540 * since endpoint resets don't reset hw pingpong state.
542 at91_udp_write(udc, AT91_UDP_RST_EP, ep->int_mask);
543 at91_udp_write(udc, AT91_UDP_RST_EP, 0);
545 spin_unlock_irqrestore(&udc->lock, flags);
549 static int at91_ep_disable (struct usb_ep * _ep)
551 struct at91_ep *ep = container_of(_ep, struct at91_ep, ep);
552 struct at91_udc *udc = ep->udc;
555 if (ep == &ep->udc->ep[0])
558 spin_lock_irqsave(&udc->lock, flags);
560 nuke(ep, -ESHUTDOWN);
562 /* restore the endpoint's pristine config */
564 ep->ep.maxpacket = ep->maxpacket;
566 /* reset fifos and endpoint */
567 if (ep->udc->clocked) {
568 at91_udp_write(udc, AT91_UDP_RST_EP, ep->int_mask);
569 at91_udp_write(udc, AT91_UDP_RST_EP, 0);
570 __raw_writel(0, ep->creg);
573 spin_unlock_irqrestore(&udc->lock, flags);
578 * this is a PIO-only driver, so there's nothing
579 * interesting for request or buffer allocation.
582 static struct usb_request *
583 at91_ep_alloc_request(struct usb_ep *_ep, gfp_t gfp_flags)
585 struct at91_request *req;
587 req = kzalloc(sizeof (struct at91_request), gfp_flags);
591 INIT_LIST_HEAD(&req->queue);
595 static void at91_ep_free_request(struct usb_ep *_ep, struct usb_request *_req)
597 struct at91_request *req;
599 req = container_of(_req, struct at91_request, req);
600 BUG_ON(!list_empty(&req->queue));
604 static int at91_ep_queue(struct usb_ep *_ep,
605 struct usb_request *_req, gfp_t gfp_flags)
607 struct at91_request *req;
609 struct at91_udc *udc;
613 req = container_of(_req, struct at91_request, req);
614 ep = container_of(_ep, struct at91_ep, ep);
616 if (!_req || !_req->complete
617 || !_req->buf || !list_empty(&req->queue)) {
618 DBG("invalid request\n");
622 if (!_ep || (!ep->desc && ep->ep.name != ep0name)) {
629 if (!udc || !udc->driver || udc->gadget.speed == USB_SPEED_UNKNOWN) {
630 DBG("invalid device\n");
634 _req->status = -EINPROGRESS;
637 spin_lock_irqsave(&udc->lock, flags);
639 /* try to kickstart any empty and idle queue */
640 if (list_empty(&ep->queue) && !ep->stopped) {
644 * If this control request has a non-empty DATA stage, this
645 * will start that stage. It works just like a non-control
646 * request (until the status stage starts, maybe early).
648 * If the data stage is empty, then this starts a successful
649 * IN/STATUS stage. (Unsuccessful ones use set_halt.)
651 is_ep0 = (ep->ep.name == ep0name);
655 if (!udc->req_pending) {
661 * defer changing CONFG until after the gadget driver
662 * reconfigures the endpoints.
664 if (udc->wait_for_config_ack) {
665 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT);
666 tmp ^= AT91_UDP_CONFG;
667 VDBG("toggle config\n");
668 at91_udp_write(udc, AT91_UDP_GLB_STAT, tmp);
670 if (req->req.length == 0) {
672 PACKET("ep0 in/status\n");
674 tmp = __raw_readl(ep->creg);
676 tmp |= CLR_FX | AT91_UDP_TXPKTRDY;
677 __raw_writel(tmp, ep->creg);
678 udc->req_pending = 0;
684 status = write_fifo(ep, req);
686 status = read_fifo(ep, req);
688 /* IN/STATUS stage is otherwise triggered by irq */
689 if (status && is_ep0)
695 if (req && !status) {
696 list_add_tail (&req->queue, &ep->queue);
697 at91_udp_write(udc, AT91_UDP_IER, ep->int_mask);
700 spin_unlock_irqrestore(&udc->lock, flags);
701 return (status < 0) ? status : 0;
704 static int at91_ep_dequeue(struct usb_ep *_ep, struct usb_request *_req)
707 struct at91_request *req;
709 struct at91_udc *udc;
711 ep = container_of(_ep, struct at91_ep, ep);
712 if (!_ep || ep->ep.name == ep0name)
717 spin_lock_irqsave(&udc->lock, flags);
719 /* make sure it's actually queued on this endpoint */
720 list_for_each_entry (req, &ep->queue, queue) {
721 if (&req->req == _req)
724 if (&req->req != _req) {
725 spin_unlock_irqrestore(&udc->lock, flags);
729 done(ep, req, -ECONNRESET);
730 spin_unlock_irqrestore(&udc->lock, flags);
734 static int at91_ep_set_halt(struct usb_ep *_ep, int value)
736 struct at91_ep *ep = container_of(_ep, struct at91_ep, ep);
737 struct at91_udc *udc = ep->udc;
743 if (!_ep || ep->is_iso || !ep->udc->clocked)
747 spin_lock_irqsave(&udc->lock, flags);
749 csr = __raw_readl(creg);
752 * fail with still-busy IN endpoints, ensuring correct sequencing
753 * of data tx then stall. note that the fifo rx bytecount isn't
754 * completely accurate as a tx bytecount.
756 if (ep->is_in && (!list_empty(&ep->queue) || (csr >> 16) != 0))
762 csr |= AT91_UDP_FORCESTALL;
763 VDBG("halt %s\n", ep->ep.name);
765 at91_udp_write(udc, AT91_UDP_RST_EP, ep->int_mask);
766 at91_udp_write(udc, AT91_UDP_RST_EP, 0);
767 csr &= ~AT91_UDP_FORCESTALL;
769 __raw_writel(csr, creg);
772 spin_unlock_irqrestore(&udc->lock, flags);
776 static const struct usb_ep_ops at91_ep_ops = {
777 .enable = at91_ep_enable,
778 .disable = at91_ep_disable,
779 .alloc_request = at91_ep_alloc_request,
780 .free_request = at91_ep_free_request,
781 .queue = at91_ep_queue,
782 .dequeue = at91_ep_dequeue,
783 .set_halt = at91_ep_set_halt,
784 /* there's only imprecise fifo status reporting */
787 /*-------------------------------------------------------------------------*/
789 static int at91_get_frame(struct usb_gadget *gadget)
791 struct at91_udc *udc = to_udc(gadget);
793 if (!to_udc(gadget)->clocked)
795 return at91_udp_read(udc, AT91_UDP_FRM_NUM) & AT91_UDP_NUM;
798 static int at91_wakeup(struct usb_gadget *gadget)
800 struct at91_udc *udc = to_udc(gadget);
802 int status = -EINVAL;
805 DBG("%s\n", __func__ );
806 spin_lock_irqsave(&udc->lock, flags);
808 if (!udc->clocked || !udc->suspended)
811 /* NOTE: some "early versions" handle ESR differently ... */
813 glbstate = at91_udp_read(udc, AT91_UDP_GLB_STAT);
814 if (!(glbstate & AT91_UDP_ESR))
816 glbstate |= AT91_UDP_ESR;
817 at91_udp_write(udc, AT91_UDP_GLB_STAT, glbstate);
820 spin_unlock_irqrestore(&udc->lock, flags);
824 /* reinit == restore initial software state */
825 static void udc_reinit(struct at91_udc *udc)
829 INIT_LIST_HEAD(&udc->gadget.ep_list);
830 INIT_LIST_HEAD(&udc->gadget.ep0->ep_list);
832 for (i = 0; i < NUM_ENDPOINTS; i++) {
833 struct at91_ep *ep = &udc->ep[i];
836 list_add_tail(&ep->ep.ep_list, &udc->gadget.ep_list);
840 ep->ep.maxpacket = ep->maxpacket;
841 ep->creg = (void __iomem *) udc->udp_baseaddr + AT91_UDP_CSR(i);
842 /* initialize one queue per endpoint */
843 INIT_LIST_HEAD(&ep->queue);
847 static void stop_activity(struct at91_udc *udc)
849 struct usb_gadget_driver *driver = udc->driver;
852 if (udc->gadget.speed == USB_SPEED_UNKNOWN)
854 udc->gadget.speed = USB_SPEED_UNKNOWN;
857 for (i = 0; i < NUM_ENDPOINTS; i++) {
858 struct at91_ep *ep = &udc->ep[i];
860 nuke(ep, -ESHUTDOWN);
863 spin_unlock(&udc->lock);
864 driver->disconnect(&udc->gadget);
865 spin_lock(&udc->lock);
871 static void clk_on(struct at91_udc *udc)
876 clk_enable(udc->iclk);
877 clk_enable(udc->fclk);
880 static void clk_off(struct at91_udc *udc)
885 udc->gadget.speed = USB_SPEED_UNKNOWN;
886 clk_disable(udc->fclk);
887 clk_disable(udc->iclk);
891 * activate/deactivate link with host; minimize power usage for
892 * inactive links by cutting clocks and transceiver power.
894 static void pullup(struct at91_udc *udc, int is_on)
896 int active = !udc->board.pullup_active_low;
898 if (!udc->enabled || !udc->vbus)
900 DBG("%sactive\n", is_on ? "" : "in");
904 at91_udp_write(udc, AT91_UDP_ICR, AT91_UDP_RXRSM);
905 at91_udp_write(udc, AT91_UDP_TXVC, 0);
906 if (cpu_is_at91rm9200())
907 gpio_set_value(udc->board.pullup_pin, active);
908 else if (cpu_is_at91sam9260() || cpu_is_at91sam9263() || cpu_is_at91sam9g20()) {
909 u32 txvc = at91_udp_read(udc, AT91_UDP_TXVC);
911 txvc |= AT91_UDP_TXVC_PUON;
912 at91_udp_write(udc, AT91_UDP_TXVC, txvc);
913 } else if (cpu_is_at91sam9261() || cpu_is_at91sam9g10()) {
916 usbpucr = at91_matrix_read(AT91_MATRIX_USBPUCR);
917 usbpucr |= AT91_MATRIX_USBPUCR_PUON;
918 at91_matrix_write(AT91_MATRIX_USBPUCR, usbpucr);
922 at91_udp_write(udc, AT91_UDP_IDR, AT91_UDP_RXRSM);
923 at91_udp_write(udc, AT91_UDP_TXVC, AT91_UDP_TXVC_TXVDIS);
924 if (cpu_is_at91rm9200())
925 gpio_set_value(udc->board.pullup_pin, !active);
926 else if (cpu_is_at91sam9260() || cpu_is_at91sam9263() || cpu_is_at91sam9g20()) {
927 u32 txvc = at91_udp_read(udc, AT91_UDP_TXVC);
929 txvc &= ~AT91_UDP_TXVC_PUON;
930 at91_udp_write(udc, AT91_UDP_TXVC, txvc);
931 } else if (cpu_is_at91sam9261() || cpu_is_at91sam9g10()) {
934 usbpucr = at91_matrix_read(AT91_MATRIX_USBPUCR);
935 usbpucr &= ~AT91_MATRIX_USBPUCR_PUON;
936 at91_matrix_write(AT91_MATRIX_USBPUCR, usbpucr);
942 /* vbus is here! turn everything on that's ready */
943 static int at91_vbus_session(struct usb_gadget *gadget, int is_active)
945 struct at91_udc *udc = to_udc(gadget);
948 /* VDBG("vbus %s\n", is_active ? "on" : "off"); */
949 spin_lock_irqsave(&udc->lock, flags);
950 udc->vbus = (is_active != 0);
952 pullup(udc, is_active);
955 spin_unlock_irqrestore(&udc->lock, flags);
959 static int at91_pullup(struct usb_gadget *gadget, int is_on)
961 struct at91_udc *udc = to_udc(gadget);
964 spin_lock_irqsave(&udc->lock, flags);
965 udc->enabled = is_on = !!is_on;
967 spin_unlock_irqrestore(&udc->lock, flags);
971 static int at91_set_selfpowered(struct usb_gadget *gadget, int is_on)
973 struct at91_udc *udc = to_udc(gadget);
976 spin_lock_irqsave(&udc->lock, flags);
977 udc->selfpowered = (is_on != 0);
978 spin_unlock_irqrestore(&udc->lock, flags);
982 static int at91_start(struct usb_gadget_driver *driver,
983 int (*bind)(struct usb_gadget *));
984 static int at91_stop(struct usb_gadget_driver *driver);
986 static const struct usb_gadget_ops at91_udc_ops = {
987 .get_frame = at91_get_frame,
988 .wakeup = at91_wakeup,
989 .set_selfpowered = at91_set_selfpowered,
990 .vbus_session = at91_vbus_session,
991 .pullup = at91_pullup,
996 * VBUS-powered devices may also also want to support bigger
997 * power budgets after an appropriate SET_CONFIGURATION.
999 /* .vbus_power = at91_vbus_power, */
1002 /*-------------------------------------------------------------------------*/
1004 static int handle_ep(struct at91_ep *ep)
1006 struct at91_request *req;
1007 u32 __iomem *creg = ep->creg;
1008 u32 csr = __raw_readl(creg);
1010 if (!list_empty(&ep->queue))
1011 req = list_entry(ep->queue.next,
1012 struct at91_request, queue);
1017 if (csr & (AT91_UDP_STALLSENT | AT91_UDP_TXCOMP)) {
1019 csr &= ~(SET_FX | AT91_UDP_STALLSENT | AT91_UDP_TXCOMP);
1020 __raw_writel(csr, creg);
1023 return write_fifo(ep, req);
1026 if (csr & AT91_UDP_STALLSENT) {
1027 /* STALLSENT bit == ISOERR */
1028 if (ep->is_iso && req)
1029 req->req.status = -EILSEQ;
1031 csr &= ~(SET_FX | AT91_UDP_STALLSENT);
1032 __raw_writel(csr, creg);
1033 csr = __raw_readl(creg);
1035 if (req && (csr & RX_DATA_READY))
1036 return read_fifo(ep, req);
1043 struct usb_ctrlrequest r;
1046 static void handle_setup(struct at91_udc *udc, struct at91_ep *ep, u32 csr)
1048 u32 __iomem *creg = ep->creg;
1049 u8 __iomem *dreg = ep->creg + (AT91_UDP_FDR(0) - AT91_UDP_CSR(0));
1050 unsigned rxcount, i = 0;
1055 /* read and ack SETUP; hard-fail for bogus packets */
1056 rxcount = (csr & AT91_UDP_RXBYTECNT) >> 16;
1057 if (likely(rxcount == 8)) {
1059 pkt.raw[i++] = __raw_readb(dreg);
1060 if (pkt.r.bRequestType & USB_DIR_IN) {
1061 csr |= AT91_UDP_DIR;
1064 csr &= ~AT91_UDP_DIR;
1068 /* REVISIT this happens sometimes under load; why?? */
1069 ERR("SETUP len %d, csr %08x\n", rxcount, csr);
1073 csr &= ~(SET_FX | AT91_UDP_RXSETUP);
1074 __raw_writel(csr, creg);
1075 udc->wait_for_addr_ack = 0;
1076 udc->wait_for_config_ack = 0;
1078 if (unlikely(status != 0))
1081 #define w_index le16_to_cpu(pkt.r.wIndex)
1082 #define w_value le16_to_cpu(pkt.r.wValue)
1083 #define w_length le16_to_cpu(pkt.r.wLength)
1085 VDBG("SETUP %02x.%02x v%04x i%04x l%04x\n",
1086 pkt.r.bRequestType, pkt.r.bRequest,
1087 w_value, w_index, w_length);
1090 * A few standard requests get handled here, ones that touch
1091 * hardware ... notably for device and endpoint features.
1093 udc->req_pending = 1;
1094 csr = __raw_readl(creg);
1097 switch ((pkt.r.bRequestType << 8) | pkt.r.bRequest) {
1099 case ((USB_TYPE_STANDARD|USB_RECIP_DEVICE) << 8)
1100 | USB_REQ_SET_ADDRESS:
1101 __raw_writel(csr | AT91_UDP_TXPKTRDY, creg);
1102 udc->addr = w_value;
1103 udc->wait_for_addr_ack = 1;
1104 udc->req_pending = 0;
1105 /* FADDR is set later, when we ack host STATUS */
1108 case ((USB_TYPE_STANDARD|USB_RECIP_DEVICE) << 8)
1109 | USB_REQ_SET_CONFIGURATION:
1110 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT) & AT91_UDP_CONFG;
1112 udc->wait_for_config_ack = (tmp == 0);
1114 udc->wait_for_config_ack = (tmp != 0);
1115 if (udc->wait_for_config_ack)
1116 VDBG("wait for config\n");
1117 /* CONFG is toggled later, if gadget driver succeeds */
1121 * Hosts may set or clear remote wakeup status, and
1122 * devices may report they're VBUS powered.
1124 case ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE) << 8)
1125 | USB_REQ_GET_STATUS:
1126 tmp = (udc->selfpowered << USB_DEVICE_SELF_POWERED);
1127 if (at91_udp_read(udc, AT91_UDP_GLB_STAT) & AT91_UDP_ESR)
1128 tmp |= (1 << USB_DEVICE_REMOTE_WAKEUP);
1129 PACKET("get device status\n");
1130 __raw_writeb(tmp, dreg);
1131 __raw_writeb(0, dreg);
1133 /* then STATUS starts later, automatically */
1134 case ((USB_TYPE_STANDARD|USB_RECIP_DEVICE) << 8)
1135 | USB_REQ_SET_FEATURE:
1136 if (w_value != USB_DEVICE_REMOTE_WAKEUP)
1138 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT);
1139 tmp |= AT91_UDP_ESR;
1140 at91_udp_write(udc, AT91_UDP_GLB_STAT, tmp);
1142 case ((USB_TYPE_STANDARD|USB_RECIP_DEVICE) << 8)
1143 | USB_REQ_CLEAR_FEATURE:
1144 if (w_value != USB_DEVICE_REMOTE_WAKEUP)
1146 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT);
1147 tmp &= ~AT91_UDP_ESR;
1148 at91_udp_write(udc, AT91_UDP_GLB_STAT, tmp);
1152 * Interfaces have no feature settings; this is pretty useless.
1153 * we won't even insist the interface exists...
1155 case ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE) << 8)
1156 | USB_REQ_GET_STATUS:
1157 PACKET("get interface status\n");
1158 __raw_writeb(0, dreg);
1159 __raw_writeb(0, dreg);
1161 /* then STATUS starts later, automatically */
1162 case ((USB_TYPE_STANDARD|USB_RECIP_INTERFACE) << 8)
1163 | USB_REQ_SET_FEATURE:
1164 case ((USB_TYPE_STANDARD|USB_RECIP_INTERFACE) << 8)
1165 | USB_REQ_CLEAR_FEATURE:
1169 * Hosts may clear bulk/intr endpoint halt after the gadget
1170 * driver sets it (not widely used); or set it (for testing)
1172 case ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT) << 8)
1173 | USB_REQ_GET_STATUS:
1174 tmp = w_index & USB_ENDPOINT_NUMBER_MASK;
1176 if (tmp >= NUM_ENDPOINTS || (tmp && !ep->desc))
1180 if ((w_index & USB_DIR_IN)) {
1183 } else if (ep->is_in)
1186 PACKET("get %s status\n", ep->ep.name);
1187 if (__raw_readl(ep->creg) & AT91_UDP_FORCESTALL)
1188 tmp = (1 << USB_ENDPOINT_HALT);
1191 __raw_writeb(tmp, dreg);
1192 __raw_writeb(0, dreg);
1194 /* then STATUS starts later, automatically */
1195 case ((USB_TYPE_STANDARD|USB_RECIP_ENDPOINT) << 8)
1196 | USB_REQ_SET_FEATURE:
1197 tmp = w_index & USB_ENDPOINT_NUMBER_MASK;
1199 if (w_value != USB_ENDPOINT_HALT || tmp >= NUM_ENDPOINTS)
1201 if (!ep->desc || ep->is_iso)
1203 if ((w_index & USB_DIR_IN)) {
1206 } else if (ep->is_in)
1209 tmp = __raw_readl(ep->creg);
1211 tmp |= CLR_FX | AT91_UDP_FORCESTALL;
1212 __raw_writel(tmp, ep->creg);
1214 case ((USB_TYPE_STANDARD|USB_RECIP_ENDPOINT) << 8)
1215 | USB_REQ_CLEAR_FEATURE:
1216 tmp = w_index & USB_ENDPOINT_NUMBER_MASK;
1218 if (w_value != USB_ENDPOINT_HALT || tmp >= NUM_ENDPOINTS)
1222 if (!ep->desc || ep->is_iso)
1224 if ((w_index & USB_DIR_IN)) {
1227 } else if (ep->is_in)
1230 at91_udp_write(udc, AT91_UDP_RST_EP, ep->int_mask);
1231 at91_udp_write(udc, AT91_UDP_RST_EP, 0);
1232 tmp = __raw_readl(ep->creg);
1234 tmp &= ~(SET_FX | AT91_UDP_FORCESTALL);
1235 __raw_writel(tmp, ep->creg);
1236 if (!list_empty(&ep->queue))
1245 /* pass request up to the gadget driver */
1247 spin_unlock(&udc->lock);
1248 status = udc->driver->setup(&udc->gadget, &pkt.r);
1249 spin_lock(&udc->lock);
1255 VDBG("req %02x.%02x protocol STALL; stat %d\n",
1256 pkt.r.bRequestType, pkt.r.bRequest, status);
1257 csr |= AT91_UDP_FORCESTALL;
1258 __raw_writel(csr, creg);
1259 udc->req_pending = 0;
1264 /* immediate successful (IN) STATUS after zero length DATA */
1265 PACKET("ep0 in/status\n");
1267 csr |= AT91_UDP_TXPKTRDY;
1268 __raw_writel(csr, creg);
1269 udc->req_pending = 0;
1272 static void handle_ep0(struct at91_udc *udc)
1274 struct at91_ep *ep0 = &udc->ep[0];
1275 u32 __iomem *creg = ep0->creg;
1276 u32 csr = __raw_readl(creg);
1277 struct at91_request *req;
1279 if (unlikely(csr & AT91_UDP_STALLSENT)) {
1281 udc->req_pending = 0;
1283 csr &= ~(SET_FX | AT91_UDP_STALLSENT | AT91_UDP_FORCESTALL);
1284 __raw_writel(csr, creg);
1285 VDBG("ep0 stalled\n");
1286 csr = __raw_readl(creg);
1288 if (csr & AT91_UDP_RXSETUP) {
1290 udc->req_pending = 0;
1291 handle_setup(udc, ep0, csr);
1295 if (list_empty(&ep0->queue))
1298 req = list_entry(ep0->queue.next, struct at91_request, queue);
1300 /* host ACKed an IN packet that we sent */
1301 if (csr & AT91_UDP_TXCOMP) {
1303 csr &= ~(SET_FX | AT91_UDP_TXCOMP);
1305 /* write more IN DATA? */
1306 if (req && ep0->is_in) {
1308 udc->req_pending = 0;
1312 * - last IN DATA packet (including GET_STATUS)
1313 * - IN/STATUS for OUT DATA
1314 * - IN/STATUS for any zero-length DATA stage
1315 * except for the IN DATA case, the host should send
1316 * an OUT status later, which we'll ack.
1319 udc->req_pending = 0;
1320 __raw_writel(csr, creg);
1323 * SET_ADDRESS takes effect only after the STATUS
1324 * (to the original address) gets acked.
1326 if (udc->wait_for_addr_ack) {
1329 at91_udp_write(udc, AT91_UDP_FADDR,
1330 AT91_UDP_FEN | udc->addr);
1331 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT);
1332 tmp &= ~AT91_UDP_FADDEN;
1334 tmp |= AT91_UDP_FADDEN;
1335 at91_udp_write(udc, AT91_UDP_GLB_STAT, tmp);
1337 udc->wait_for_addr_ack = 0;
1338 VDBG("address %d\n", udc->addr);
1343 /* OUT packet arrived ... */
1344 else if (csr & AT91_UDP_RX_DATA_BK0) {
1346 csr &= ~(SET_FX | AT91_UDP_RX_DATA_BK0);
1348 /* OUT DATA stage */
1351 if (handle_ep(ep0)) {
1352 /* send IN/STATUS */
1353 PACKET("ep0 in/status\n");
1354 csr = __raw_readl(creg);
1356 csr |= CLR_FX | AT91_UDP_TXPKTRDY;
1357 __raw_writel(csr, creg);
1358 udc->req_pending = 0;
1360 } else if (udc->req_pending) {
1362 * AT91 hardware has a hard time with this
1363 * "deferred response" mode for control-OUT
1364 * transfers. (For control-IN it's fine.)
1366 * The normal solution leaves OUT data in the
1367 * fifo until the gadget driver is ready.
1368 * We couldn't do that here without disabling
1369 * the IRQ that tells about SETUP packets,
1370 * e.g. when the host gets impatient...
1372 * Working around it by copying into a buffer
1373 * would almost be a non-deferred response,
1374 * except that it wouldn't permit reliable
1375 * stalling of the request. Instead, demand
1376 * that gadget drivers not use this mode.
1378 DBG("no control-OUT deferred responses!\n");
1379 __raw_writel(csr | AT91_UDP_FORCESTALL, creg);
1380 udc->req_pending = 0;
1383 /* STATUS stage for control-IN; ack. */
1385 PACKET("ep0 out/status ACK\n");
1386 __raw_writel(csr, creg);
1388 /* "early" status stage */
1395 static irqreturn_t at91_udc_irq (int irq, void *_udc)
1397 struct at91_udc *udc = _udc;
1399 int disable_clock = 0;
1400 unsigned long flags;
1402 spin_lock_irqsave(&udc->lock, flags);
1404 if (!udc->clocked) {
1412 status = at91_udp_read(udc, AT91_UDP_ISR)
1413 & at91_udp_read(udc, AT91_UDP_IMR);
1417 /* USB reset irq: not maskable */
1418 if (status & AT91_UDP_ENDBUSRES) {
1419 at91_udp_write(udc, AT91_UDP_IDR, ~MINIMUS_INTERRUPTUS);
1420 at91_udp_write(udc, AT91_UDP_IER, MINIMUS_INTERRUPTUS);
1421 /* Atmel code clears this irq twice */
1422 at91_udp_write(udc, AT91_UDP_ICR, AT91_UDP_ENDBUSRES);
1423 at91_udp_write(udc, AT91_UDP_ICR, AT91_UDP_ENDBUSRES);
1424 VDBG("end bus reset\n");
1429 at91_udp_write(udc, AT91_UDP_CSR(0),
1430 AT91_UDP_EPEDS | AT91_UDP_EPTYPE_CTRL);
1431 udc->gadget.speed = USB_SPEED_FULL;
1433 at91_udp_write(udc, AT91_UDP_IER, AT91_UDP_EP(0));
1436 * NOTE: this driver keeps clocks off unless the
1437 * USB host is present. That saves power, but for
1438 * boards that don't support VBUS detection, both
1439 * clocks need to be active most of the time.
1442 /* host initiated suspend (3+ms bus idle) */
1443 } else if (status & AT91_UDP_RXSUSP) {
1444 at91_udp_write(udc, AT91_UDP_IDR, AT91_UDP_RXSUSP);
1445 at91_udp_write(udc, AT91_UDP_IER, AT91_UDP_RXRSM);
1446 at91_udp_write(udc, AT91_UDP_ICR, AT91_UDP_RXSUSP);
1447 /* VDBG("bus suspend\n"); */
1453 * NOTE: when suspending a VBUS-powered device, the
1454 * gadget driver should switch into slow clock mode
1455 * and then into standby to avoid drawing more than
1456 * 500uA power (2500uA for some high-power configs).
1458 if (udc->driver && udc->driver->suspend) {
1459 spin_unlock(&udc->lock);
1460 udc->driver->suspend(&udc->gadget);
1461 spin_lock(&udc->lock);
1464 /* host initiated resume */
1465 } else if (status & AT91_UDP_RXRSM) {
1466 at91_udp_write(udc, AT91_UDP_IDR, AT91_UDP_RXRSM);
1467 at91_udp_write(udc, AT91_UDP_IER, AT91_UDP_RXSUSP);
1468 at91_udp_write(udc, AT91_UDP_ICR, AT91_UDP_RXRSM);
1469 /* VDBG("bus resume\n"); */
1470 if (!udc->suspended)
1475 * NOTE: for a VBUS-powered device, the gadget driver
1476 * would normally want to switch out of slow clock
1477 * mode into normal mode.
1479 if (udc->driver && udc->driver->resume) {
1480 spin_unlock(&udc->lock);
1481 udc->driver->resume(&udc->gadget);
1482 spin_lock(&udc->lock);
1485 /* endpoint IRQs are cleared by handling them */
1489 struct at91_ep *ep = &udc->ep[1];
1493 for (i = 1; i < NUM_ENDPOINTS; i++) {
1505 spin_unlock_irqrestore(&udc->lock, flags);
1510 /*-------------------------------------------------------------------------*/
1512 static void nop_release(struct device *dev)
1514 /* nothing to free */
1517 static struct at91_udc controller = {
1519 .ops = &at91_udc_ops,
1520 .ep0 = &controller.ep[0].ep,
1521 .name = driver_name,
1523 .init_name = "gadget",
1524 .release = nop_release,
1530 .ops = &at91_ep_ops,
1539 .ops = &at91_ep_ops,
1549 .ops = &at91_ep_ops,
1558 /* could actually do bulk too */
1560 .ops = &at91_ep_ops,
1569 .ops = &at91_ep_ops,
1579 .ops = &at91_ep_ops,
1586 /* ep6 and ep7 are also reserved (custom silicon might use them) */
1589 static void at91_vbus_update(struct at91_udc *udc, unsigned value)
1591 value ^= udc->board.vbus_active_low;
1592 if (value != udc->vbus)
1593 at91_vbus_session(&udc->gadget, value);
1596 static irqreturn_t at91_vbus_irq(int irq, void *_udc)
1598 struct at91_udc *udc = _udc;
1600 /* vbus needs at least brief debouncing */
1602 at91_vbus_update(udc, gpio_get_value(udc->board.vbus_pin));
1607 static void at91_vbus_timer_work(struct work_struct *work)
1609 struct at91_udc *udc = container_of(work, struct at91_udc,
1612 at91_vbus_update(udc, gpio_get_value_cansleep(udc->board.vbus_pin));
1614 if (!timer_pending(&udc->vbus_timer))
1615 mod_timer(&udc->vbus_timer, jiffies + VBUS_POLL_TIMEOUT);
1618 static void at91_vbus_timer(unsigned long data)
1620 struct at91_udc *udc = (struct at91_udc *)data;
1623 * If we are polling vbus it is likely that the gpio is on an
1624 * bus such as i2c or spi which may sleep, so schedule some work
1625 * to read the vbus gpio
1627 if (!work_pending(&udc->vbus_timer_work))
1628 schedule_work(&udc->vbus_timer_work);
1631 static int at91_start(struct usb_gadget_driver *driver,
1632 int (*bind)(struct usb_gadget *))
1634 struct at91_udc *udc = &controller;
1636 unsigned long flags;
1639 || driver->max_speed < USB_SPEED_FULL
1641 || !driver->setup) {
1642 DBG("bad parameter.\n");
1647 DBG("UDC already has a gadget driver\n");
1651 udc->driver = driver;
1652 udc->gadget.dev.driver = &driver->driver;
1653 dev_set_drvdata(&udc->gadget.dev, &driver->driver);
1655 udc->selfpowered = 1;
1657 retval = bind(&udc->gadget);
1659 DBG("bind() returned %d\n", retval);
1661 udc->gadget.dev.driver = NULL;
1662 dev_set_drvdata(&udc->gadget.dev, NULL);
1664 udc->selfpowered = 0;
1668 spin_lock_irqsave(&udc->lock, flags);
1670 spin_unlock_irqrestore(&udc->lock, flags);
1672 DBG("bound to %s\n", driver->driver.name);
1676 static int at91_stop(struct usb_gadget_driver *driver)
1678 struct at91_udc *udc = &controller;
1679 unsigned long flags;
1681 if (!driver || driver != udc->driver || !driver->unbind)
1684 spin_lock_irqsave(&udc->lock, flags);
1686 at91_udp_write(udc, AT91_UDP_IDR, ~0);
1688 spin_unlock_irqrestore(&udc->lock, flags);
1690 driver->unbind(&udc->gadget);
1691 udc->gadget.dev.driver = NULL;
1692 dev_set_drvdata(&udc->gadget.dev, NULL);
1695 DBG("unbound from %s\n", driver->driver.name);
1699 /*-------------------------------------------------------------------------*/
1701 static void at91udc_shutdown(struct platform_device *dev)
1703 struct at91_udc *udc = platform_get_drvdata(dev);
1704 unsigned long flags;
1706 /* force disconnect on reboot */
1707 spin_lock_irqsave(&udc->lock, flags);
1708 pullup(platform_get_drvdata(dev), 0);
1709 spin_unlock_irqrestore(&udc->lock, flags);
1712 static void __devinit at91udc_of_init(struct at91_udc *udc,
1713 struct device_node *np)
1715 struct at91_udc_data *board = &udc->board;
1717 enum of_gpio_flags flags;
1719 if (of_property_read_u32(np, "atmel,vbus-polled", &val) == 0)
1720 board->vbus_polled = 1;
1722 board->vbus_pin = of_get_named_gpio_flags(np, "atmel,vbus-gpio", 0,
1724 board->vbus_active_low = (flags & OF_GPIO_ACTIVE_LOW) ? 1 : 0;
1726 board->pullup_pin = of_get_named_gpio_flags(np, "atmel,pullup-gpio", 0,
1729 board->pullup_active_low = (flags & OF_GPIO_ACTIVE_LOW) ? 1 : 0;
1732 static int __devinit at91udc_probe(struct platform_device *pdev)
1734 struct device *dev = &pdev->dev;
1735 struct at91_udc *udc;
1737 struct resource *res;
1739 if (!dev->platform_data) {
1740 /* small (so we copy it) but critical! */
1741 DBG("missing platform_data\n");
1745 if (pdev->num_resources != 2) {
1746 DBG("invalid num_resources\n");
1749 if ((pdev->resource[0].flags != IORESOURCE_MEM)
1750 || (pdev->resource[1].flags != IORESOURCE_IRQ)) {
1751 DBG("invalid resource type\n");
1755 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1759 if (!request_mem_region(res->start, resource_size(res), driver_name)) {
1760 DBG("someone's using UDC memory\n");
1764 /* init software state */
1766 udc->gadget.dev.parent = dev;
1767 if (pdev->dev.of_node)
1768 at91udc_of_init(udc, pdev->dev.of_node);
1770 memcpy(&udc->board, dev->platform_data,
1771 sizeof(struct at91_udc_data));
1774 spin_lock_init(&udc->lock);
1776 /* rm9200 needs manual D+ pullup; off by default */
1777 if (cpu_is_at91rm9200()) {
1778 if (gpio_is_valid(udc->board.pullup_pin)) {
1779 DBG("no D+ pullup?\n");
1783 retval = gpio_request(udc->board.pullup_pin, "udc_pullup");
1785 DBG("D+ pullup is busy\n");
1788 gpio_direction_output(udc->board.pullup_pin,
1789 udc->board.pullup_active_low);
1792 /* newer chips have more FIFO memory than rm9200 */
1793 if (cpu_is_at91sam9260() || cpu_is_at91sam9g20()) {
1794 udc->ep[0].maxpacket = 64;
1795 udc->ep[3].maxpacket = 64;
1796 udc->ep[4].maxpacket = 512;
1797 udc->ep[5].maxpacket = 512;
1798 } else if (cpu_is_at91sam9261() || cpu_is_at91sam9g10()) {
1799 udc->ep[3].maxpacket = 64;
1800 } else if (cpu_is_at91sam9263()) {
1801 udc->ep[0].maxpacket = 64;
1802 udc->ep[3].maxpacket = 64;
1805 udc->udp_baseaddr = ioremap(res->start, resource_size(res));
1806 if (!udc->udp_baseaddr) {
1813 /* get interface and function clocks */
1814 udc->iclk = clk_get(dev, "udc_clk");
1815 udc->fclk = clk_get(dev, "udpck");
1816 if (IS_ERR(udc->iclk) || IS_ERR(udc->fclk)) {
1817 DBG("clocks missing\n");
1819 /* NOTE: we "know" here that refcounts on these are NOPs */
1823 retval = device_register(&udc->gadget.dev);
1825 put_device(&udc->gadget.dev);
1829 /* don't do anything until we have both gadget driver and VBUS */
1830 clk_enable(udc->iclk);
1831 at91_udp_write(udc, AT91_UDP_TXVC, AT91_UDP_TXVC_TXVDIS);
1832 at91_udp_write(udc, AT91_UDP_IDR, 0xffffffff);
1833 /* Clear all pending interrupts - UDP may be used by bootloader. */
1834 at91_udp_write(udc, AT91_UDP_ICR, 0xffffffff);
1835 clk_disable(udc->iclk);
1837 /* request UDC and maybe VBUS irqs */
1838 udc->udp_irq = platform_get_irq(pdev, 0);
1839 retval = request_irq(udc->udp_irq, at91_udc_irq,
1840 0, driver_name, udc);
1842 DBG("request irq %d failed\n", udc->udp_irq);
1845 if (gpio_is_valid(udc->board.vbus_pin)) {
1846 retval = gpio_request(udc->board.vbus_pin, "udc_vbus");
1848 DBG("request vbus pin failed\n");
1851 gpio_direction_input(udc->board.vbus_pin);
1854 * Get the initial state of VBUS - we cannot expect
1855 * a pending interrupt.
1857 udc->vbus = gpio_get_value_cansleep(udc->board.vbus_pin) ^
1858 udc->board.vbus_active_low;
1860 if (udc->board.vbus_polled) {
1861 INIT_WORK(&udc->vbus_timer_work, at91_vbus_timer_work);
1862 setup_timer(&udc->vbus_timer, at91_vbus_timer,
1863 (unsigned long)udc);
1864 mod_timer(&udc->vbus_timer,
1865 jiffies + VBUS_POLL_TIMEOUT);
1867 if (request_irq(udc->board.vbus_pin, at91_vbus_irq,
1868 0, driver_name, udc)) {
1869 DBG("request vbus irq %d failed\n",
1870 udc->board.vbus_pin);
1876 DBG("no VBUS detection, assuming always-on\n");
1879 retval = usb_add_gadget_udc(dev, &udc->gadget);
1882 dev_set_drvdata(dev, udc);
1883 device_init_wakeup(dev, 1);
1884 create_debug_file(udc);
1886 INFO("%s version %s\n", driver_name, DRIVER_VERSION);
1889 if (gpio_is_valid(udc->board.vbus_pin) && !udc->board.vbus_polled)
1890 free_irq(udc->board.vbus_pin, udc);
1892 if (gpio_is_valid(udc->board.vbus_pin))
1893 gpio_free(udc->board.vbus_pin);
1895 free_irq(udc->udp_irq, udc);
1897 device_unregister(&udc->gadget.dev);
1899 iounmap(udc->udp_baseaddr);
1901 if (cpu_is_at91rm9200())
1902 gpio_free(udc->board.pullup_pin);
1904 release_mem_region(res->start, resource_size(res));
1905 DBG("%s probe failed, %d\n", driver_name, retval);
1909 static int __exit at91udc_remove(struct platform_device *pdev)
1911 struct at91_udc *udc = platform_get_drvdata(pdev);
1912 struct resource *res;
1913 unsigned long flags;
1917 usb_del_gadget_udc(&udc->gadget);
1921 spin_lock_irqsave(&udc->lock, flags);
1923 spin_unlock_irqrestore(&udc->lock, flags);
1925 device_init_wakeup(&pdev->dev, 0);
1926 remove_debug_file(udc);
1927 if (gpio_is_valid(udc->board.vbus_pin)) {
1928 free_irq(udc->board.vbus_pin, udc);
1929 gpio_free(udc->board.vbus_pin);
1931 free_irq(udc->udp_irq, udc);
1932 device_unregister(&udc->gadget.dev);
1934 iounmap(udc->udp_baseaddr);
1936 if (cpu_is_at91rm9200())
1937 gpio_free(udc->board.pullup_pin);
1939 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1940 release_mem_region(res->start, resource_size(res));
1949 static int at91udc_suspend(struct platform_device *pdev, pm_message_t mesg)
1951 struct at91_udc *udc = platform_get_drvdata(pdev);
1952 int wake = udc->driver && device_may_wakeup(&pdev->dev);
1953 unsigned long flags;
1955 /* Unless we can act normally to the host (letting it wake us up
1956 * whenever it has work for us) force disconnect. Wakeup requires
1957 * PLLB for USB events (signaling for reset, wakeup, or incoming
1958 * tokens) and VBUS irqs (on systems which support them).
1960 if ((!udc->suspended && udc->addr)
1962 || at91_suspend_entering_slow_clock()) {
1963 spin_lock_irqsave(&udc->lock, flags);
1966 spin_unlock_irqrestore(&udc->lock, flags);
1968 enable_irq_wake(udc->udp_irq);
1970 udc->active_suspend = wake;
1971 if (gpio_is_valid(udc->board.vbus_pin) && !udc->board.vbus_polled && wake)
1972 enable_irq_wake(udc->board.vbus_pin);
1976 static int at91udc_resume(struct platform_device *pdev)
1978 struct at91_udc *udc = platform_get_drvdata(pdev);
1979 unsigned long flags;
1981 if (gpio_is_valid(udc->board.vbus_pin) && !udc->board.vbus_polled &&
1982 udc->active_suspend)
1983 disable_irq_wake(udc->board.vbus_pin);
1985 /* maybe reconnect to host; if so, clocks on */
1986 if (udc->active_suspend)
1987 disable_irq_wake(udc->udp_irq);
1989 spin_lock_irqsave(&udc->lock, flags);
1991 spin_unlock_irqrestore(&udc->lock, flags);
1996 #define at91udc_suspend NULL
1997 #define at91udc_resume NULL
2000 #if defined(CONFIG_OF)
2001 static const struct of_device_id at91_udc_dt_ids[] = {
2002 { .compatible = "atmel,at91rm9200-udc" },
2006 MODULE_DEVICE_TABLE(of, at91_udc_dt_ids);
2009 static struct platform_driver at91_udc_driver = {
2010 .remove = __exit_p(at91udc_remove),
2011 .shutdown = at91udc_shutdown,
2012 .suspend = at91udc_suspend,
2013 .resume = at91udc_resume,
2015 .name = (char *) driver_name,
2016 .owner = THIS_MODULE,
2017 .of_match_table = of_match_ptr(at91_udc_dt_ids),
2021 static int __init udc_init_module(void)
2023 return platform_driver_probe(&at91_udc_driver, at91udc_probe);
2025 module_init(udc_init_module);
2027 static void __exit udc_exit_module(void)
2029 platform_driver_unregister(&at91_udc_driver);
2031 module_exit(udc_exit_module);
2033 MODULE_DESCRIPTION("AT91 udc driver");
2034 MODULE_AUTHOR("Thomas Rathbone, David Brownell");
2035 MODULE_LICENSE("GPL");
2036 MODULE_ALIAS("platform:at91_udc");