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>
33 #include <linux/of_gpio.h>
35 #include <asm/byteorder.h>
36 #include <mach/hardware.h>
41 #include <mach/board.h>
43 #include <mach/at91sam9261_matrix.h>
44 #include <mach/at91_matrix.h>
50 * This controller is simple and PIO-only. It's used in many AT91-series
51 * full speed USB controllers, including the at91rm9200 (arm920T, with MMU),
52 * at91sam926x (arm926ejs, with MMU), and several no-mmu versions.
54 * This driver expects the board has been wired with two GPIOs suppporting
55 * a VBUS sensing IRQ, and a D+ pullup. (They may be omitted, but the
56 * testing hasn't covered such cases.)
58 * The pullup is most important (so it's integrated on sam926x parts). It
59 * provides software control over whether the host enumerates the device.
61 * The VBUS sensing helps during enumeration, and allows both USB clocks
62 * (and the transceiver) to stay gated off until they're necessary, saving
63 * power. During USB suspend, the 48 MHz clock is gated off in hardware;
64 * it may also be gated off by software during some Linux sleep states.
67 #define DRIVER_VERSION "3 May 2006"
69 static const char driver_name [] = "at91_udc";
70 static const char ep0name[] = "ep0";
72 #define VBUS_POLL_TIMEOUT msecs_to_jiffies(1000)
74 #define at91_udp_read(udc, reg) \
75 __raw_readl((udc)->udp_baseaddr + (reg))
76 #define at91_udp_write(udc, reg, val) \
77 __raw_writel((val), (udc)->udp_baseaddr + (reg))
79 /*-------------------------------------------------------------------------*/
81 #ifdef CONFIG_USB_GADGET_DEBUG_FILES
83 #include <linux/seq_file.h>
85 static const char debug_filename[] = "driver/udc";
87 #define FOURBITS "%s%s%s%s"
88 #define EIGHTBITS FOURBITS FOURBITS
90 static void proc_ep_show(struct seq_file *s, struct at91_ep *ep)
92 static char *types[] = {
93 "control", "out-iso", "out-bulk", "out-int",
94 "BOGUS", "in-iso", "in-bulk", "in-int"};
97 struct at91_request *req;
99 struct at91_udc *udc = ep->udc;
101 spin_lock_irqsave(&udc->lock, flags);
103 csr = __raw_readl(ep->creg);
105 /* NOTE: not collecting per-endpoint irq statistics... */
108 seq_printf(s, "%s, maxpacket %d %s%s %s%s\n",
109 ep->ep.name, ep->ep.maxpacket,
110 ep->is_in ? "in" : "out",
111 ep->is_iso ? " iso" : "",
113 ? (ep->fifo_bank ? "pong" : "ping")
115 ep->stopped ? " stopped" : "");
116 seq_printf(s, "csr %08x rxbytes=%d %s %s %s" EIGHTBITS "\n",
118 (csr & 0x07ff0000) >> 16,
119 (csr & (1 << 15)) ? "enabled" : "disabled",
120 (csr & (1 << 11)) ? "DATA1" : "DATA0",
121 types[(csr & 0x700) >> 8],
123 /* iff type is control then print current direction */
125 ? ((csr & (1 << 7)) ? " IN" : " OUT")
127 (csr & (1 << 6)) ? " rxdatabk1" : "",
128 (csr & (1 << 5)) ? " forcestall" : "",
129 (csr & (1 << 4)) ? " txpktrdy" : "",
131 (csr & (1 << 3)) ? " stallsent" : "",
132 (csr & (1 << 2)) ? " rxsetup" : "",
133 (csr & (1 << 1)) ? " rxdatabk0" : "",
134 (csr & (1 << 0)) ? " txcomp" : "");
135 if (list_empty (&ep->queue))
136 seq_printf(s, "\t(queue empty)\n");
138 else list_for_each_entry (req, &ep->queue, queue) {
139 unsigned length = req->req.actual;
141 seq_printf(s, "\treq %p len %d/%d buf %p\n",
143 req->req.length, req->req.buf);
145 spin_unlock_irqrestore(&udc->lock, flags);
148 static void proc_irq_show(struct seq_file *s, const char *label, u32 mask)
152 seq_printf(s, "%s %04x:%s%s" FOURBITS, label, mask,
153 (mask & (1 << 13)) ? " wakeup" : "",
154 (mask & (1 << 12)) ? " endbusres" : "",
156 (mask & (1 << 11)) ? " sofint" : "",
157 (mask & (1 << 10)) ? " extrsm" : "",
158 (mask & (1 << 9)) ? " rxrsm" : "",
159 (mask & (1 << 8)) ? " rxsusp" : "");
160 for (i = 0; i < 8; i++) {
162 seq_printf(s, " ep%d", i);
167 static int proc_udc_show(struct seq_file *s, void *unused)
169 struct at91_udc *udc = s->private;
173 seq_printf(s, "%s: version %s\n", driver_name, DRIVER_VERSION);
175 seq_printf(s, "vbus %s, pullup %s, %s powered%s, gadget %s\n\n",
176 udc->vbus ? "present" : "off",
178 ? (udc->vbus ? "active" : "enabled")
180 udc->selfpowered ? "self" : "VBUS",
181 udc->suspended ? ", suspended" : "",
182 udc->driver ? udc->driver->driver.name : "(none)");
184 /* don't access registers when interface isn't clocked */
186 seq_printf(s, "(not clocked)\n");
190 tmp = at91_udp_read(udc, AT91_UDP_FRM_NUM);
191 seq_printf(s, "frame %05x:%s%s frame=%d\n", tmp,
192 (tmp & AT91_UDP_FRM_OK) ? " ok" : "",
193 (tmp & AT91_UDP_FRM_ERR) ? " err" : "",
194 (tmp & AT91_UDP_NUM));
196 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT);
197 seq_printf(s, "glbstate %02x:%s" FOURBITS "\n", tmp,
198 (tmp & AT91_UDP_RMWUPE) ? " rmwupe" : "",
199 (tmp & AT91_UDP_RSMINPR) ? " rsminpr" : "",
200 (tmp & AT91_UDP_ESR) ? " esr" : "",
201 (tmp & AT91_UDP_CONFG) ? " confg" : "",
202 (tmp & AT91_UDP_FADDEN) ? " fadden" : "");
204 tmp = at91_udp_read(udc, AT91_UDP_FADDR);
205 seq_printf(s, "faddr %03x:%s fadd=%d\n", tmp,
206 (tmp & AT91_UDP_FEN) ? " fen" : "",
207 (tmp & AT91_UDP_FADD));
209 proc_irq_show(s, "imr ", at91_udp_read(udc, AT91_UDP_IMR));
210 proc_irq_show(s, "isr ", at91_udp_read(udc, AT91_UDP_ISR));
212 if (udc->enabled && udc->vbus) {
213 proc_ep_show(s, &udc->ep[0]);
214 list_for_each_entry (ep, &udc->gadget.ep_list, ep.ep_list) {
222 static int proc_udc_open(struct inode *inode, struct file *file)
224 return single_open(file, proc_udc_show, PDE(inode)->data);
227 static const struct file_operations proc_ops = {
228 .owner = THIS_MODULE,
229 .open = proc_udc_open,
232 .release = single_release,
235 static void create_debug_file(struct at91_udc *udc)
237 udc->pde = proc_create_data(debug_filename, 0, NULL, &proc_ops, udc);
240 static void remove_debug_file(struct at91_udc *udc)
243 remove_proc_entry(debug_filename, NULL);
248 static inline void create_debug_file(struct at91_udc *udc) {}
249 static inline void remove_debug_file(struct at91_udc *udc) {}
254 /*-------------------------------------------------------------------------*/
256 static void done(struct at91_ep *ep, struct at91_request *req, int status)
258 unsigned stopped = ep->stopped;
259 struct at91_udc *udc = ep->udc;
261 list_del_init(&req->queue);
262 if (req->req.status == -EINPROGRESS)
263 req->req.status = status;
265 status = req->req.status;
266 if (status && status != -ESHUTDOWN)
267 VDBG("%s done %p, status %d\n", ep->ep.name, req, status);
270 spin_unlock(&udc->lock);
271 req->req.complete(&ep->ep, &req->req);
272 spin_lock(&udc->lock);
273 ep->stopped = stopped;
275 /* ep0 is always ready; other endpoints need a non-empty queue */
276 if (list_empty(&ep->queue) && ep->int_mask != (1 << 0))
277 at91_udp_write(udc, AT91_UDP_IDR, ep->int_mask);
280 /*-------------------------------------------------------------------------*/
282 /* bits indicating OUT fifo has data ready */
283 #define RX_DATA_READY (AT91_UDP_RX_DATA_BK0 | AT91_UDP_RX_DATA_BK1)
286 * Endpoint FIFO CSR bits have a mix of bits, making it unsafe to just write
287 * back most of the value you just read (because of side effects, including
288 * bits that may change after reading and before writing).
290 * Except when changing a specific bit, always write values which:
291 * - clear SET_FX bits (setting them could change something)
292 * - set CLR_FX bits (clearing them could change something)
294 * There are also state bits like FORCESTALL, EPEDS, DIR, and EPTYPE
295 * that shouldn't normally be changed.
297 * NOTE at91sam9260 docs mention synch between UDPCK and MCK clock domains,
298 * implying a need to wait for one write to complete (test relevant bits)
299 * before starting the next write. This shouldn't be an issue given how
300 * infrequently we write, except maybe for write-then-read idioms.
302 #define SET_FX (AT91_UDP_TXPKTRDY)
303 #define CLR_FX (RX_DATA_READY | AT91_UDP_RXSETUP \
304 | AT91_UDP_STALLSENT | AT91_UDP_TXCOMP)
306 /* pull OUT packet data from the endpoint's fifo */
307 static int read_fifo (struct at91_ep *ep, struct at91_request *req)
309 u32 __iomem *creg = ep->creg;
310 u8 __iomem *dreg = ep->creg + (AT91_UDP_FDR(0) - AT91_UDP_CSR(0));
313 unsigned int count, bufferspace, is_done;
315 buf = req->req.buf + req->req.actual;
316 bufferspace = req->req.length - req->req.actual;
319 * there might be nothing to read if ep_queue() calls us,
320 * or if we already emptied both pingpong buffers
323 csr = __raw_readl(creg);
324 if ((csr & RX_DATA_READY) == 0)
327 count = (csr & AT91_UDP_RXBYTECNT) >> 16;
328 if (count > ep->ep.maxpacket)
329 count = ep->ep.maxpacket;
330 if (count > bufferspace) {
331 DBG("%s buffer overflow\n", ep->ep.name);
332 req->req.status = -EOVERFLOW;
335 __raw_readsb(dreg, buf, count);
337 /* release and swap pingpong mem bank */
339 if (ep->is_pingpong) {
340 if (ep->fifo_bank == 0) {
341 csr &= ~(SET_FX | AT91_UDP_RX_DATA_BK0);
344 csr &= ~(SET_FX | AT91_UDP_RX_DATA_BK1);
348 csr &= ~(SET_FX | AT91_UDP_RX_DATA_BK0);
349 __raw_writel(csr, creg);
351 req->req.actual += count;
352 is_done = (count < ep->ep.maxpacket);
353 if (count == bufferspace)
356 PACKET("%s %p out/%d%s\n", ep->ep.name, &req->req, count,
357 is_done ? " (done)" : "");
360 * avoid extra trips through IRQ logic for packets already in
361 * the fifo ... maybe preventing an extra (expensive) OUT-NAK
365 else if (ep->is_pingpong) {
367 * One dummy read to delay the code because of a HW glitch:
368 * CSR returns bad RXCOUNT when read too soon after updating
371 csr = __raw_readl(creg);
373 bufferspace -= count;
381 /* load fifo for an IN packet */
382 static int write_fifo(struct at91_ep *ep, struct at91_request *req)
384 u32 __iomem *creg = ep->creg;
385 u32 csr = __raw_readl(creg);
386 u8 __iomem *dreg = ep->creg + (AT91_UDP_FDR(0) - AT91_UDP_CSR(0));
387 unsigned total, count, is_last;
391 * TODO: allow for writing two packets to the fifo ... that'll
392 * reduce the amount of IN-NAKing, but probably won't affect
393 * throughput much. (Unlike preventing OUT-NAKing!)
397 * If ep_queue() calls us, the queue is empty and possibly in
398 * odd states like TXCOMP not yet cleared (we do it, saving at
399 * least one IRQ) or the fifo not yet being free. Those aren't
400 * issues normally (IRQ handler fast path).
402 if (unlikely(csr & (AT91_UDP_TXCOMP | AT91_UDP_TXPKTRDY))) {
403 if (csr & AT91_UDP_TXCOMP) {
405 csr &= ~(SET_FX | AT91_UDP_TXCOMP);
406 __raw_writel(csr, creg);
407 csr = __raw_readl(creg);
409 if (csr & AT91_UDP_TXPKTRDY)
413 buf = req->req.buf + req->req.actual;
415 total = req->req.length - req->req.actual;
416 if (ep->ep.maxpacket < total) {
417 count = ep->ep.maxpacket;
421 is_last = (count < ep->ep.maxpacket) || !req->req.zero;
425 * Write the packet, maybe it's a ZLP.
427 * NOTE: incrementing req->actual before we receive the ACK means
428 * gadget driver IN bytecounts can be wrong in fault cases. That's
429 * fixable with PIO drivers like this one (save "count" here, and
430 * do the increment later on TX irq), but not for most DMA hardware.
432 * So all gadget drivers must accept that potential error. Some
433 * hardware supports precise fifo status reporting, letting them
434 * recover when the actual bytecount matters (e.g. for USB Test
435 * and Measurement Class devices).
437 __raw_writesb(dreg, buf, count);
439 csr |= CLR_FX | AT91_UDP_TXPKTRDY;
440 __raw_writel(csr, creg);
441 req->req.actual += count;
443 PACKET("%s %p in/%d%s\n", ep->ep.name, &req->req, count,
444 is_last ? " (done)" : "");
450 static void nuke(struct at91_ep *ep, int status)
452 struct at91_request *req;
454 /* terminate any request in the queue */
456 if (list_empty(&ep->queue))
459 VDBG("%s %s\n", __func__, ep->ep.name);
460 while (!list_empty(&ep->queue)) {
461 req = list_entry(ep->queue.next, struct at91_request, queue);
462 done(ep, req, status);
466 /*-------------------------------------------------------------------------*/
468 static int at91_ep_enable(struct usb_ep *_ep,
469 const struct usb_endpoint_descriptor *desc)
471 struct at91_ep *ep = container_of(_ep, struct at91_ep, ep);
472 struct at91_udc *udc = ep->udc;
478 || !desc || ep->ep.desc
479 || _ep->name == ep0name
480 || desc->bDescriptorType != USB_DT_ENDPOINT
481 || (maxpacket = usb_endpoint_maxp(desc)) == 0
482 || maxpacket > ep->maxpacket) {
483 DBG("bad ep or descriptor\n");
487 if (!udc->driver || udc->gadget.speed == USB_SPEED_UNKNOWN) {
488 DBG("bogus device state\n");
492 tmp = usb_endpoint_type(desc);
494 case USB_ENDPOINT_XFER_CONTROL:
495 DBG("only one control endpoint\n");
497 case USB_ENDPOINT_XFER_INT:
501 case USB_ENDPOINT_XFER_BULK:
510 DBG("bogus maxpacket %d\n", maxpacket);
512 case USB_ENDPOINT_XFER_ISOC:
513 if (!ep->is_pingpong) {
514 DBG("iso requires double buffering\n");
521 spin_lock_irqsave(&udc->lock, flags);
523 /* initialize endpoint to match this descriptor */
524 ep->is_in = usb_endpoint_dir_in(desc);
525 ep->is_iso = (tmp == USB_ENDPOINT_XFER_ISOC);
530 tmp |= AT91_UDP_EPEDS;
531 __raw_writel(tmp, ep->creg);
534 ep->ep.maxpacket = maxpacket;
537 * reset/init endpoint fifo. NOTE: leaves fifo_bank alone,
538 * since endpoint resets don't reset hw pingpong state.
540 at91_udp_write(udc, AT91_UDP_RST_EP, ep->int_mask);
541 at91_udp_write(udc, AT91_UDP_RST_EP, 0);
543 spin_unlock_irqrestore(&udc->lock, flags);
547 static int at91_ep_disable (struct usb_ep * _ep)
549 struct at91_ep *ep = container_of(_ep, struct at91_ep, ep);
550 struct at91_udc *udc = ep->udc;
553 if (ep == &ep->udc->ep[0])
556 spin_lock_irqsave(&udc->lock, flags);
558 nuke(ep, -ESHUTDOWN);
560 /* restore the endpoint's pristine config */
562 ep->ep.maxpacket = ep->maxpacket;
564 /* reset fifos and endpoint */
565 if (ep->udc->clocked) {
566 at91_udp_write(udc, AT91_UDP_RST_EP, ep->int_mask);
567 at91_udp_write(udc, AT91_UDP_RST_EP, 0);
568 __raw_writel(0, ep->creg);
571 spin_unlock_irqrestore(&udc->lock, flags);
576 * this is a PIO-only driver, so there's nothing
577 * interesting for request or buffer allocation.
580 static struct usb_request *
581 at91_ep_alloc_request(struct usb_ep *_ep, gfp_t gfp_flags)
583 struct at91_request *req;
585 req = kzalloc(sizeof (struct at91_request), gfp_flags);
589 INIT_LIST_HEAD(&req->queue);
593 static void at91_ep_free_request(struct usb_ep *_ep, struct usb_request *_req)
595 struct at91_request *req;
597 req = container_of(_req, struct at91_request, req);
598 BUG_ON(!list_empty(&req->queue));
602 static int at91_ep_queue(struct usb_ep *_ep,
603 struct usb_request *_req, gfp_t gfp_flags)
605 struct at91_request *req;
607 struct at91_udc *udc;
611 req = container_of(_req, struct at91_request, req);
612 ep = container_of(_ep, struct at91_ep, ep);
614 if (!_req || !_req->complete
615 || !_req->buf || !list_empty(&req->queue)) {
616 DBG("invalid request\n");
620 if (!_ep || (!ep->ep.desc && ep->ep.name != ep0name)) {
627 if (!udc || !udc->driver || udc->gadget.speed == USB_SPEED_UNKNOWN) {
628 DBG("invalid device\n");
632 _req->status = -EINPROGRESS;
635 spin_lock_irqsave(&udc->lock, flags);
637 /* try to kickstart any empty and idle queue */
638 if (list_empty(&ep->queue) && !ep->stopped) {
642 * If this control request has a non-empty DATA stage, this
643 * will start that stage. It works just like a non-control
644 * request (until the status stage starts, maybe early).
646 * If the data stage is empty, then this starts a successful
647 * IN/STATUS stage. (Unsuccessful ones use set_halt.)
649 is_ep0 = (ep->ep.name == ep0name);
653 if (!udc->req_pending) {
659 * defer changing CONFG until after the gadget driver
660 * reconfigures the endpoints.
662 if (udc->wait_for_config_ack) {
663 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT);
664 tmp ^= AT91_UDP_CONFG;
665 VDBG("toggle config\n");
666 at91_udp_write(udc, AT91_UDP_GLB_STAT, tmp);
668 if (req->req.length == 0) {
670 PACKET("ep0 in/status\n");
672 tmp = __raw_readl(ep->creg);
674 tmp |= CLR_FX | AT91_UDP_TXPKTRDY;
675 __raw_writel(tmp, ep->creg);
676 udc->req_pending = 0;
682 status = write_fifo(ep, req);
684 status = read_fifo(ep, req);
686 /* IN/STATUS stage is otherwise triggered by irq */
687 if (status && is_ep0)
693 if (req && !status) {
694 list_add_tail (&req->queue, &ep->queue);
695 at91_udp_write(udc, AT91_UDP_IER, ep->int_mask);
698 spin_unlock_irqrestore(&udc->lock, flags);
699 return (status < 0) ? status : 0;
702 static int at91_ep_dequeue(struct usb_ep *_ep, struct usb_request *_req)
705 struct at91_request *req;
707 struct at91_udc *udc;
709 ep = container_of(_ep, struct at91_ep, ep);
710 if (!_ep || ep->ep.name == ep0name)
715 spin_lock_irqsave(&udc->lock, flags);
717 /* make sure it's actually queued on this endpoint */
718 list_for_each_entry (req, &ep->queue, queue) {
719 if (&req->req == _req)
722 if (&req->req != _req) {
723 spin_unlock_irqrestore(&udc->lock, flags);
727 done(ep, req, -ECONNRESET);
728 spin_unlock_irqrestore(&udc->lock, flags);
732 static int at91_ep_set_halt(struct usb_ep *_ep, int value)
734 struct at91_ep *ep = container_of(_ep, struct at91_ep, ep);
735 struct at91_udc *udc = ep->udc;
741 if (!_ep || ep->is_iso || !ep->udc->clocked)
745 spin_lock_irqsave(&udc->lock, flags);
747 csr = __raw_readl(creg);
750 * fail with still-busy IN endpoints, ensuring correct sequencing
751 * of data tx then stall. note that the fifo rx bytecount isn't
752 * completely accurate as a tx bytecount.
754 if (ep->is_in && (!list_empty(&ep->queue) || (csr >> 16) != 0))
760 csr |= AT91_UDP_FORCESTALL;
761 VDBG("halt %s\n", ep->ep.name);
763 at91_udp_write(udc, AT91_UDP_RST_EP, ep->int_mask);
764 at91_udp_write(udc, AT91_UDP_RST_EP, 0);
765 csr &= ~AT91_UDP_FORCESTALL;
767 __raw_writel(csr, creg);
770 spin_unlock_irqrestore(&udc->lock, flags);
774 static const struct usb_ep_ops at91_ep_ops = {
775 .enable = at91_ep_enable,
776 .disable = at91_ep_disable,
777 .alloc_request = at91_ep_alloc_request,
778 .free_request = at91_ep_free_request,
779 .queue = at91_ep_queue,
780 .dequeue = at91_ep_dequeue,
781 .set_halt = at91_ep_set_halt,
782 /* there's only imprecise fifo status reporting */
785 /*-------------------------------------------------------------------------*/
787 static int at91_get_frame(struct usb_gadget *gadget)
789 struct at91_udc *udc = to_udc(gadget);
791 if (!to_udc(gadget)->clocked)
793 return at91_udp_read(udc, AT91_UDP_FRM_NUM) & AT91_UDP_NUM;
796 static int at91_wakeup(struct usb_gadget *gadget)
798 struct at91_udc *udc = to_udc(gadget);
800 int status = -EINVAL;
803 DBG("%s\n", __func__ );
804 spin_lock_irqsave(&udc->lock, flags);
806 if (!udc->clocked || !udc->suspended)
809 /* NOTE: some "early versions" handle ESR differently ... */
811 glbstate = at91_udp_read(udc, AT91_UDP_GLB_STAT);
812 if (!(glbstate & AT91_UDP_ESR))
814 glbstate |= AT91_UDP_ESR;
815 at91_udp_write(udc, AT91_UDP_GLB_STAT, glbstate);
818 spin_unlock_irqrestore(&udc->lock, flags);
822 /* reinit == restore initial software state */
823 static void udc_reinit(struct at91_udc *udc)
827 INIT_LIST_HEAD(&udc->gadget.ep_list);
828 INIT_LIST_HEAD(&udc->gadget.ep0->ep_list);
830 for (i = 0; i < NUM_ENDPOINTS; i++) {
831 struct at91_ep *ep = &udc->ep[i];
834 list_add_tail(&ep->ep.ep_list, &udc->gadget.ep_list);
838 ep->ep.maxpacket = ep->maxpacket;
839 ep->creg = (void __iomem *) udc->udp_baseaddr + AT91_UDP_CSR(i);
840 /* initialize one queue per endpoint */
841 INIT_LIST_HEAD(&ep->queue);
845 static void stop_activity(struct at91_udc *udc)
847 struct usb_gadget_driver *driver = udc->driver;
850 if (udc->gadget.speed == USB_SPEED_UNKNOWN)
852 udc->gadget.speed = USB_SPEED_UNKNOWN;
855 for (i = 0; i < NUM_ENDPOINTS; i++) {
856 struct at91_ep *ep = &udc->ep[i];
858 nuke(ep, -ESHUTDOWN);
861 spin_unlock(&udc->lock);
862 driver->disconnect(&udc->gadget);
863 spin_lock(&udc->lock);
869 static void clk_on(struct at91_udc *udc)
874 clk_enable(udc->iclk);
875 clk_enable(udc->fclk);
878 static void clk_off(struct at91_udc *udc)
883 udc->gadget.speed = USB_SPEED_UNKNOWN;
884 clk_disable(udc->fclk);
885 clk_disable(udc->iclk);
889 * activate/deactivate link with host; minimize power usage for
890 * inactive links by cutting clocks and transceiver power.
892 static void pullup(struct at91_udc *udc, int is_on)
894 int active = !udc->board.pullup_active_low;
896 if (!udc->enabled || !udc->vbus)
898 DBG("%sactive\n", is_on ? "" : "in");
902 at91_udp_write(udc, AT91_UDP_ICR, AT91_UDP_RXRSM);
903 at91_udp_write(udc, AT91_UDP_TXVC, 0);
904 if (cpu_is_at91rm9200())
905 gpio_set_value(udc->board.pullup_pin, active);
906 else if (cpu_is_at91sam9260() || cpu_is_at91sam9263() || cpu_is_at91sam9g20()) {
907 u32 txvc = at91_udp_read(udc, AT91_UDP_TXVC);
909 txvc |= AT91_UDP_TXVC_PUON;
910 at91_udp_write(udc, AT91_UDP_TXVC, txvc);
911 } else if (cpu_is_at91sam9261() || cpu_is_at91sam9g10()) {
914 usbpucr = at91_matrix_read(AT91_MATRIX_USBPUCR);
915 usbpucr |= AT91_MATRIX_USBPUCR_PUON;
916 at91_matrix_write(AT91_MATRIX_USBPUCR, usbpucr);
920 at91_udp_write(udc, AT91_UDP_IDR, AT91_UDP_RXRSM);
921 at91_udp_write(udc, AT91_UDP_TXVC, AT91_UDP_TXVC_TXVDIS);
922 if (cpu_is_at91rm9200())
923 gpio_set_value(udc->board.pullup_pin, !active);
924 else if (cpu_is_at91sam9260() || cpu_is_at91sam9263() || cpu_is_at91sam9g20()) {
925 u32 txvc = at91_udp_read(udc, AT91_UDP_TXVC);
927 txvc &= ~AT91_UDP_TXVC_PUON;
928 at91_udp_write(udc, AT91_UDP_TXVC, txvc);
929 } else if (cpu_is_at91sam9261() || cpu_is_at91sam9g10()) {
932 usbpucr = at91_matrix_read(AT91_MATRIX_USBPUCR);
933 usbpucr &= ~AT91_MATRIX_USBPUCR_PUON;
934 at91_matrix_write(AT91_MATRIX_USBPUCR, usbpucr);
940 /* vbus is here! turn everything on that's ready */
941 static int at91_vbus_session(struct usb_gadget *gadget, int is_active)
943 struct at91_udc *udc = to_udc(gadget);
946 /* VDBG("vbus %s\n", is_active ? "on" : "off"); */
947 spin_lock_irqsave(&udc->lock, flags);
948 udc->vbus = (is_active != 0);
950 pullup(udc, is_active);
953 spin_unlock_irqrestore(&udc->lock, flags);
957 static int at91_pullup(struct usb_gadget *gadget, int is_on)
959 struct at91_udc *udc = to_udc(gadget);
962 spin_lock_irqsave(&udc->lock, flags);
963 udc->enabled = is_on = !!is_on;
965 spin_unlock_irqrestore(&udc->lock, flags);
969 static int at91_set_selfpowered(struct usb_gadget *gadget, int is_on)
971 struct at91_udc *udc = to_udc(gadget);
974 spin_lock_irqsave(&udc->lock, flags);
975 udc->selfpowered = (is_on != 0);
976 spin_unlock_irqrestore(&udc->lock, flags);
980 static int at91_start(struct usb_gadget *gadget,
981 struct usb_gadget_driver *driver);
982 static int at91_stop(struct usb_gadget *gadget,
983 struct usb_gadget_driver *driver);
984 static const struct usb_gadget_ops at91_udc_ops = {
985 .get_frame = at91_get_frame,
986 .wakeup = at91_wakeup,
987 .set_selfpowered = at91_set_selfpowered,
988 .vbus_session = at91_vbus_session,
989 .pullup = at91_pullup,
990 .udc_start = at91_start,
991 .udc_stop = at91_stop,
994 * VBUS-powered devices may also also want to support bigger
995 * power budgets after an appropriate SET_CONFIGURATION.
997 /* .vbus_power = at91_vbus_power, */
1000 /*-------------------------------------------------------------------------*/
1002 static int handle_ep(struct at91_ep *ep)
1004 struct at91_request *req;
1005 u32 __iomem *creg = ep->creg;
1006 u32 csr = __raw_readl(creg);
1008 if (!list_empty(&ep->queue))
1009 req = list_entry(ep->queue.next,
1010 struct at91_request, queue);
1015 if (csr & (AT91_UDP_STALLSENT | AT91_UDP_TXCOMP)) {
1017 csr &= ~(SET_FX | AT91_UDP_STALLSENT | AT91_UDP_TXCOMP);
1018 __raw_writel(csr, creg);
1021 return write_fifo(ep, req);
1024 if (csr & AT91_UDP_STALLSENT) {
1025 /* STALLSENT bit == ISOERR */
1026 if (ep->is_iso && req)
1027 req->req.status = -EILSEQ;
1029 csr &= ~(SET_FX | AT91_UDP_STALLSENT);
1030 __raw_writel(csr, creg);
1031 csr = __raw_readl(creg);
1033 if (req && (csr & RX_DATA_READY))
1034 return read_fifo(ep, req);
1041 struct usb_ctrlrequest r;
1044 static void handle_setup(struct at91_udc *udc, struct at91_ep *ep, u32 csr)
1046 u32 __iomem *creg = ep->creg;
1047 u8 __iomem *dreg = ep->creg + (AT91_UDP_FDR(0) - AT91_UDP_CSR(0));
1048 unsigned rxcount, i = 0;
1053 /* read and ack SETUP; hard-fail for bogus packets */
1054 rxcount = (csr & AT91_UDP_RXBYTECNT) >> 16;
1055 if (likely(rxcount == 8)) {
1057 pkt.raw[i++] = __raw_readb(dreg);
1058 if (pkt.r.bRequestType & USB_DIR_IN) {
1059 csr |= AT91_UDP_DIR;
1062 csr &= ~AT91_UDP_DIR;
1066 /* REVISIT this happens sometimes under load; why?? */
1067 ERR("SETUP len %d, csr %08x\n", rxcount, csr);
1071 csr &= ~(SET_FX | AT91_UDP_RXSETUP);
1072 __raw_writel(csr, creg);
1073 udc->wait_for_addr_ack = 0;
1074 udc->wait_for_config_ack = 0;
1076 if (unlikely(status != 0))
1079 #define w_index le16_to_cpu(pkt.r.wIndex)
1080 #define w_value le16_to_cpu(pkt.r.wValue)
1081 #define w_length le16_to_cpu(pkt.r.wLength)
1083 VDBG("SETUP %02x.%02x v%04x i%04x l%04x\n",
1084 pkt.r.bRequestType, pkt.r.bRequest,
1085 w_value, w_index, w_length);
1088 * A few standard requests get handled here, ones that touch
1089 * hardware ... notably for device and endpoint features.
1091 udc->req_pending = 1;
1092 csr = __raw_readl(creg);
1095 switch ((pkt.r.bRequestType << 8) | pkt.r.bRequest) {
1097 case ((USB_TYPE_STANDARD|USB_RECIP_DEVICE) << 8)
1098 | USB_REQ_SET_ADDRESS:
1099 __raw_writel(csr | AT91_UDP_TXPKTRDY, creg);
1100 udc->addr = w_value;
1101 udc->wait_for_addr_ack = 1;
1102 udc->req_pending = 0;
1103 /* FADDR is set later, when we ack host STATUS */
1106 case ((USB_TYPE_STANDARD|USB_RECIP_DEVICE) << 8)
1107 | USB_REQ_SET_CONFIGURATION:
1108 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT) & AT91_UDP_CONFG;
1110 udc->wait_for_config_ack = (tmp == 0);
1112 udc->wait_for_config_ack = (tmp != 0);
1113 if (udc->wait_for_config_ack)
1114 VDBG("wait for config\n");
1115 /* CONFG is toggled later, if gadget driver succeeds */
1119 * Hosts may set or clear remote wakeup status, and
1120 * devices may report they're VBUS powered.
1122 case ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE) << 8)
1123 | USB_REQ_GET_STATUS:
1124 tmp = (udc->selfpowered << USB_DEVICE_SELF_POWERED);
1125 if (at91_udp_read(udc, AT91_UDP_GLB_STAT) & AT91_UDP_ESR)
1126 tmp |= (1 << USB_DEVICE_REMOTE_WAKEUP);
1127 PACKET("get device status\n");
1128 __raw_writeb(tmp, dreg);
1129 __raw_writeb(0, dreg);
1131 /* then STATUS starts later, automatically */
1132 case ((USB_TYPE_STANDARD|USB_RECIP_DEVICE) << 8)
1133 | USB_REQ_SET_FEATURE:
1134 if (w_value != USB_DEVICE_REMOTE_WAKEUP)
1136 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT);
1137 tmp |= AT91_UDP_ESR;
1138 at91_udp_write(udc, AT91_UDP_GLB_STAT, tmp);
1140 case ((USB_TYPE_STANDARD|USB_RECIP_DEVICE) << 8)
1141 | USB_REQ_CLEAR_FEATURE:
1142 if (w_value != USB_DEVICE_REMOTE_WAKEUP)
1144 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT);
1145 tmp &= ~AT91_UDP_ESR;
1146 at91_udp_write(udc, AT91_UDP_GLB_STAT, tmp);
1150 * Interfaces have no feature settings; this is pretty useless.
1151 * we won't even insist the interface exists...
1153 case ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE) << 8)
1154 | USB_REQ_GET_STATUS:
1155 PACKET("get interface status\n");
1156 __raw_writeb(0, dreg);
1157 __raw_writeb(0, dreg);
1159 /* then STATUS starts later, automatically */
1160 case ((USB_TYPE_STANDARD|USB_RECIP_INTERFACE) << 8)
1161 | USB_REQ_SET_FEATURE:
1162 case ((USB_TYPE_STANDARD|USB_RECIP_INTERFACE) << 8)
1163 | USB_REQ_CLEAR_FEATURE:
1167 * Hosts may clear bulk/intr endpoint halt after the gadget
1168 * driver sets it (not widely used); or set it (for testing)
1170 case ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT) << 8)
1171 | USB_REQ_GET_STATUS:
1172 tmp = w_index & USB_ENDPOINT_NUMBER_MASK;
1174 if (tmp >= NUM_ENDPOINTS || (tmp && !ep->ep.desc))
1178 if ((w_index & USB_DIR_IN)) {
1181 } else if (ep->is_in)
1184 PACKET("get %s status\n", ep->ep.name);
1185 if (__raw_readl(ep->creg) & AT91_UDP_FORCESTALL)
1186 tmp = (1 << USB_ENDPOINT_HALT);
1189 __raw_writeb(tmp, dreg);
1190 __raw_writeb(0, dreg);
1192 /* then STATUS starts later, automatically */
1193 case ((USB_TYPE_STANDARD|USB_RECIP_ENDPOINT) << 8)
1194 | USB_REQ_SET_FEATURE:
1195 tmp = w_index & USB_ENDPOINT_NUMBER_MASK;
1197 if (w_value != USB_ENDPOINT_HALT || tmp >= NUM_ENDPOINTS)
1199 if (!ep->ep.desc || ep->is_iso)
1201 if ((w_index & USB_DIR_IN)) {
1204 } else if (ep->is_in)
1207 tmp = __raw_readl(ep->creg);
1209 tmp |= CLR_FX | AT91_UDP_FORCESTALL;
1210 __raw_writel(tmp, ep->creg);
1212 case ((USB_TYPE_STANDARD|USB_RECIP_ENDPOINT) << 8)
1213 | USB_REQ_CLEAR_FEATURE:
1214 tmp = w_index & USB_ENDPOINT_NUMBER_MASK;
1216 if (w_value != USB_ENDPOINT_HALT || tmp >= NUM_ENDPOINTS)
1220 if (!ep->ep.desc || ep->is_iso)
1222 if ((w_index & USB_DIR_IN)) {
1225 } else if (ep->is_in)
1228 at91_udp_write(udc, AT91_UDP_RST_EP, ep->int_mask);
1229 at91_udp_write(udc, AT91_UDP_RST_EP, 0);
1230 tmp = __raw_readl(ep->creg);
1232 tmp &= ~(SET_FX | AT91_UDP_FORCESTALL);
1233 __raw_writel(tmp, ep->creg);
1234 if (!list_empty(&ep->queue))
1243 /* pass request up to the gadget driver */
1245 spin_unlock(&udc->lock);
1246 status = udc->driver->setup(&udc->gadget, &pkt.r);
1247 spin_lock(&udc->lock);
1253 VDBG("req %02x.%02x protocol STALL; stat %d\n",
1254 pkt.r.bRequestType, pkt.r.bRequest, status);
1255 csr |= AT91_UDP_FORCESTALL;
1256 __raw_writel(csr, creg);
1257 udc->req_pending = 0;
1262 /* immediate successful (IN) STATUS after zero length DATA */
1263 PACKET("ep0 in/status\n");
1265 csr |= AT91_UDP_TXPKTRDY;
1266 __raw_writel(csr, creg);
1267 udc->req_pending = 0;
1270 static void handle_ep0(struct at91_udc *udc)
1272 struct at91_ep *ep0 = &udc->ep[0];
1273 u32 __iomem *creg = ep0->creg;
1274 u32 csr = __raw_readl(creg);
1275 struct at91_request *req;
1277 if (unlikely(csr & AT91_UDP_STALLSENT)) {
1279 udc->req_pending = 0;
1281 csr &= ~(SET_FX | AT91_UDP_STALLSENT | AT91_UDP_FORCESTALL);
1282 __raw_writel(csr, creg);
1283 VDBG("ep0 stalled\n");
1284 csr = __raw_readl(creg);
1286 if (csr & AT91_UDP_RXSETUP) {
1288 udc->req_pending = 0;
1289 handle_setup(udc, ep0, csr);
1293 if (list_empty(&ep0->queue))
1296 req = list_entry(ep0->queue.next, struct at91_request, queue);
1298 /* host ACKed an IN packet that we sent */
1299 if (csr & AT91_UDP_TXCOMP) {
1301 csr &= ~(SET_FX | AT91_UDP_TXCOMP);
1303 /* write more IN DATA? */
1304 if (req && ep0->is_in) {
1306 udc->req_pending = 0;
1310 * - last IN DATA packet (including GET_STATUS)
1311 * - IN/STATUS for OUT DATA
1312 * - IN/STATUS for any zero-length DATA stage
1313 * except for the IN DATA case, the host should send
1314 * an OUT status later, which we'll ack.
1317 udc->req_pending = 0;
1318 __raw_writel(csr, creg);
1321 * SET_ADDRESS takes effect only after the STATUS
1322 * (to the original address) gets acked.
1324 if (udc->wait_for_addr_ack) {
1327 at91_udp_write(udc, AT91_UDP_FADDR,
1328 AT91_UDP_FEN | udc->addr);
1329 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT);
1330 tmp &= ~AT91_UDP_FADDEN;
1332 tmp |= AT91_UDP_FADDEN;
1333 at91_udp_write(udc, AT91_UDP_GLB_STAT, tmp);
1335 udc->wait_for_addr_ack = 0;
1336 VDBG("address %d\n", udc->addr);
1341 /* OUT packet arrived ... */
1342 else if (csr & AT91_UDP_RX_DATA_BK0) {
1344 csr &= ~(SET_FX | AT91_UDP_RX_DATA_BK0);
1346 /* OUT DATA stage */
1349 if (handle_ep(ep0)) {
1350 /* send IN/STATUS */
1351 PACKET("ep0 in/status\n");
1352 csr = __raw_readl(creg);
1354 csr |= CLR_FX | AT91_UDP_TXPKTRDY;
1355 __raw_writel(csr, creg);
1356 udc->req_pending = 0;
1358 } else if (udc->req_pending) {
1360 * AT91 hardware has a hard time with this
1361 * "deferred response" mode for control-OUT
1362 * transfers. (For control-IN it's fine.)
1364 * The normal solution leaves OUT data in the
1365 * fifo until the gadget driver is ready.
1366 * We couldn't do that here without disabling
1367 * the IRQ that tells about SETUP packets,
1368 * e.g. when the host gets impatient...
1370 * Working around it by copying into a buffer
1371 * would almost be a non-deferred response,
1372 * except that it wouldn't permit reliable
1373 * stalling of the request. Instead, demand
1374 * that gadget drivers not use this mode.
1376 DBG("no control-OUT deferred responses!\n");
1377 __raw_writel(csr | AT91_UDP_FORCESTALL, creg);
1378 udc->req_pending = 0;
1381 /* STATUS stage for control-IN; ack. */
1383 PACKET("ep0 out/status ACK\n");
1384 __raw_writel(csr, creg);
1386 /* "early" status stage */
1393 static irqreturn_t at91_udc_irq (int irq, void *_udc)
1395 struct at91_udc *udc = _udc;
1397 int disable_clock = 0;
1398 unsigned long flags;
1400 spin_lock_irqsave(&udc->lock, flags);
1402 if (!udc->clocked) {
1410 status = at91_udp_read(udc, AT91_UDP_ISR)
1411 & at91_udp_read(udc, AT91_UDP_IMR);
1415 /* USB reset irq: not maskable */
1416 if (status & AT91_UDP_ENDBUSRES) {
1417 at91_udp_write(udc, AT91_UDP_IDR, ~MINIMUS_INTERRUPTUS);
1418 at91_udp_write(udc, AT91_UDP_IER, MINIMUS_INTERRUPTUS);
1419 /* Atmel code clears this irq twice */
1420 at91_udp_write(udc, AT91_UDP_ICR, AT91_UDP_ENDBUSRES);
1421 at91_udp_write(udc, AT91_UDP_ICR, AT91_UDP_ENDBUSRES);
1422 VDBG("end bus reset\n");
1427 at91_udp_write(udc, AT91_UDP_CSR(0),
1428 AT91_UDP_EPEDS | AT91_UDP_EPTYPE_CTRL);
1429 udc->gadget.speed = USB_SPEED_FULL;
1431 at91_udp_write(udc, AT91_UDP_IER, AT91_UDP_EP(0));
1434 * NOTE: this driver keeps clocks off unless the
1435 * USB host is present. That saves power, but for
1436 * boards that don't support VBUS detection, both
1437 * clocks need to be active most of the time.
1440 /* host initiated suspend (3+ms bus idle) */
1441 } else if (status & AT91_UDP_RXSUSP) {
1442 at91_udp_write(udc, AT91_UDP_IDR, AT91_UDP_RXSUSP);
1443 at91_udp_write(udc, AT91_UDP_IER, AT91_UDP_RXRSM);
1444 at91_udp_write(udc, AT91_UDP_ICR, AT91_UDP_RXSUSP);
1445 /* VDBG("bus suspend\n"); */
1451 * NOTE: when suspending a VBUS-powered device, the
1452 * gadget driver should switch into slow clock mode
1453 * and then into standby to avoid drawing more than
1454 * 500uA power (2500uA for some high-power configs).
1456 if (udc->driver && udc->driver->suspend) {
1457 spin_unlock(&udc->lock);
1458 udc->driver->suspend(&udc->gadget);
1459 spin_lock(&udc->lock);
1462 /* host initiated resume */
1463 } else if (status & AT91_UDP_RXRSM) {
1464 at91_udp_write(udc, AT91_UDP_IDR, AT91_UDP_RXRSM);
1465 at91_udp_write(udc, AT91_UDP_IER, AT91_UDP_RXSUSP);
1466 at91_udp_write(udc, AT91_UDP_ICR, AT91_UDP_RXRSM);
1467 /* VDBG("bus resume\n"); */
1468 if (!udc->suspended)
1473 * NOTE: for a VBUS-powered device, the gadget driver
1474 * would normally want to switch out of slow clock
1475 * mode into normal mode.
1477 if (udc->driver && udc->driver->resume) {
1478 spin_unlock(&udc->lock);
1479 udc->driver->resume(&udc->gadget);
1480 spin_lock(&udc->lock);
1483 /* endpoint IRQs are cleared by handling them */
1487 struct at91_ep *ep = &udc->ep[1];
1491 for (i = 1; i < NUM_ENDPOINTS; i++) {
1503 spin_unlock_irqrestore(&udc->lock, flags);
1508 /*-------------------------------------------------------------------------*/
1510 static void nop_release(struct device *dev)
1512 /* nothing to free */
1515 static struct at91_udc controller = {
1517 .ops = &at91_udc_ops,
1518 .ep0 = &controller.ep[0].ep,
1519 .name = driver_name,
1521 .init_name = "gadget",
1522 .release = nop_release,
1528 .ops = &at91_ep_ops,
1537 .ops = &at91_ep_ops,
1547 .ops = &at91_ep_ops,
1556 /* could actually do bulk too */
1558 .ops = &at91_ep_ops,
1567 .ops = &at91_ep_ops,
1577 .ops = &at91_ep_ops,
1584 /* ep6 and ep7 are also reserved (custom silicon might use them) */
1587 static void at91_vbus_update(struct at91_udc *udc, unsigned value)
1589 value ^= udc->board.vbus_active_low;
1590 if (value != udc->vbus)
1591 at91_vbus_session(&udc->gadget, value);
1594 static irqreturn_t at91_vbus_irq(int irq, void *_udc)
1596 struct at91_udc *udc = _udc;
1598 /* vbus needs at least brief debouncing */
1600 at91_vbus_update(udc, gpio_get_value(udc->board.vbus_pin));
1605 static void at91_vbus_timer_work(struct work_struct *work)
1607 struct at91_udc *udc = container_of(work, struct at91_udc,
1610 at91_vbus_update(udc, gpio_get_value_cansleep(udc->board.vbus_pin));
1612 if (!timer_pending(&udc->vbus_timer))
1613 mod_timer(&udc->vbus_timer, jiffies + VBUS_POLL_TIMEOUT);
1616 static void at91_vbus_timer(unsigned long data)
1618 struct at91_udc *udc = (struct at91_udc *)data;
1621 * If we are polling vbus it is likely that the gpio is on an
1622 * bus such as i2c or spi which may sleep, so schedule some work
1623 * to read the vbus gpio
1625 if (!work_pending(&udc->vbus_timer_work))
1626 schedule_work(&udc->vbus_timer_work);
1629 static int at91_start(struct usb_gadget *gadget,
1630 struct usb_gadget_driver *driver)
1632 struct at91_udc *udc;
1634 udc = container_of(gadget, struct at91_udc, gadget);
1635 udc->driver = driver;
1636 udc->gadget.dev.driver = &driver->driver;
1637 dev_set_drvdata(&udc->gadget.dev, &driver->driver);
1639 udc->selfpowered = 1;
1641 DBG("bound to %s\n", driver->driver.name);
1645 static int at91_stop(struct usb_gadget *gadget,
1646 struct usb_gadget_driver *driver)
1648 struct at91_udc *udc;
1649 unsigned long flags;
1651 udc = container_of(gadget, struct at91_udc, gadget);
1652 spin_lock_irqsave(&udc->lock, flags);
1654 at91_udp_write(udc, AT91_UDP_IDR, ~0);
1655 spin_unlock_irqrestore(&udc->lock, flags);
1657 udc->gadget.dev.driver = NULL;
1658 dev_set_drvdata(&udc->gadget.dev, NULL);
1661 DBG("unbound from %s\n", driver->driver.name);
1665 /*-------------------------------------------------------------------------*/
1667 static void at91udc_shutdown(struct platform_device *dev)
1669 struct at91_udc *udc = platform_get_drvdata(dev);
1670 unsigned long flags;
1672 /* force disconnect on reboot */
1673 spin_lock_irqsave(&udc->lock, flags);
1674 pullup(platform_get_drvdata(dev), 0);
1675 spin_unlock_irqrestore(&udc->lock, flags);
1678 static void __devinit at91udc_of_init(struct at91_udc *udc,
1679 struct device_node *np)
1681 struct at91_udc_data *board = &udc->board;
1683 enum of_gpio_flags flags;
1685 if (of_property_read_u32(np, "atmel,vbus-polled", &val) == 0)
1686 board->vbus_polled = 1;
1688 board->vbus_pin = of_get_named_gpio_flags(np, "atmel,vbus-gpio", 0,
1690 board->vbus_active_low = (flags & OF_GPIO_ACTIVE_LOW) ? 1 : 0;
1692 board->pullup_pin = of_get_named_gpio_flags(np, "atmel,pullup-gpio", 0,
1695 board->pullup_active_low = (flags & OF_GPIO_ACTIVE_LOW) ? 1 : 0;
1698 static int __devinit at91udc_probe(struct platform_device *pdev)
1700 struct device *dev = &pdev->dev;
1701 struct at91_udc *udc;
1703 struct resource *res;
1705 if (!dev->platform_data) {
1706 /* small (so we copy it) but critical! */
1707 DBG("missing platform_data\n");
1711 if (pdev->num_resources != 2) {
1712 DBG("invalid num_resources\n");
1715 if ((pdev->resource[0].flags != IORESOURCE_MEM)
1716 || (pdev->resource[1].flags != IORESOURCE_IRQ)) {
1717 DBG("invalid resource type\n");
1721 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1725 if (!request_mem_region(res->start, resource_size(res), driver_name)) {
1726 DBG("someone's using UDC memory\n");
1730 /* init software state */
1732 udc->gadget.dev.parent = dev;
1733 if (pdev->dev.of_node)
1734 at91udc_of_init(udc, pdev->dev.of_node);
1736 memcpy(&udc->board, dev->platform_data,
1737 sizeof(struct at91_udc_data));
1740 spin_lock_init(&udc->lock);
1742 /* rm9200 needs manual D+ pullup; off by default */
1743 if (cpu_is_at91rm9200()) {
1744 if (gpio_is_valid(udc->board.pullup_pin)) {
1745 DBG("no D+ pullup?\n");
1749 retval = gpio_request(udc->board.pullup_pin, "udc_pullup");
1751 DBG("D+ pullup is busy\n");
1754 gpio_direction_output(udc->board.pullup_pin,
1755 udc->board.pullup_active_low);
1758 /* newer chips have more FIFO memory than rm9200 */
1759 if (cpu_is_at91sam9260() || cpu_is_at91sam9g20()) {
1760 udc->ep[0].maxpacket = 64;
1761 udc->ep[3].maxpacket = 64;
1762 udc->ep[4].maxpacket = 512;
1763 udc->ep[5].maxpacket = 512;
1764 } else if (cpu_is_at91sam9261() || cpu_is_at91sam9g10()) {
1765 udc->ep[3].maxpacket = 64;
1766 } else if (cpu_is_at91sam9263()) {
1767 udc->ep[0].maxpacket = 64;
1768 udc->ep[3].maxpacket = 64;
1771 udc->udp_baseaddr = ioremap(res->start, resource_size(res));
1772 if (!udc->udp_baseaddr) {
1779 /* get interface and function clocks */
1780 udc->iclk = clk_get(dev, "udc_clk");
1781 udc->fclk = clk_get(dev, "udpck");
1782 if (IS_ERR(udc->iclk) || IS_ERR(udc->fclk)) {
1783 DBG("clocks missing\n");
1785 /* NOTE: we "know" here that refcounts on these are NOPs */
1789 retval = device_register(&udc->gadget.dev);
1791 put_device(&udc->gadget.dev);
1795 /* don't do anything until we have both gadget driver and VBUS */
1796 clk_enable(udc->iclk);
1797 at91_udp_write(udc, AT91_UDP_TXVC, AT91_UDP_TXVC_TXVDIS);
1798 at91_udp_write(udc, AT91_UDP_IDR, 0xffffffff);
1799 /* Clear all pending interrupts - UDP may be used by bootloader. */
1800 at91_udp_write(udc, AT91_UDP_ICR, 0xffffffff);
1801 clk_disable(udc->iclk);
1803 /* request UDC and maybe VBUS irqs */
1804 udc->udp_irq = platform_get_irq(pdev, 0);
1805 retval = request_irq(udc->udp_irq, at91_udc_irq,
1806 0, driver_name, udc);
1808 DBG("request irq %d failed\n", udc->udp_irq);
1811 if (gpio_is_valid(udc->board.vbus_pin)) {
1812 retval = gpio_request(udc->board.vbus_pin, "udc_vbus");
1814 DBG("request vbus pin failed\n");
1817 gpio_direction_input(udc->board.vbus_pin);
1820 * Get the initial state of VBUS - we cannot expect
1821 * a pending interrupt.
1823 udc->vbus = gpio_get_value_cansleep(udc->board.vbus_pin) ^
1824 udc->board.vbus_active_low;
1826 if (udc->board.vbus_polled) {
1827 INIT_WORK(&udc->vbus_timer_work, at91_vbus_timer_work);
1828 setup_timer(&udc->vbus_timer, at91_vbus_timer,
1829 (unsigned long)udc);
1830 mod_timer(&udc->vbus_timer,
1831 jiffies + VBUS_POLL_TIMEOUT);
1833 if (request_irq(gpio_to_irq(udc->board.vbus_pin),
1834 at91_vbus_irq, 0, driver_name, udc)) {
1835 DBG("request vbus irq %d failed\n",
1836 udc->board.vbus_pin);
1842 DBG("no VBUS detection, assuming always-on\n");
1845 retval = usb_add_gadget_udc(dev, &udc->gadget);
1848 dev_set_drvdata(dev, udc);
1849 device_init_wakeup(dev, 1);
1850 create_debug_file(udc);
1852 INFO("%s version %s\n", driver_name, DRIVER_VERSION);
1855 if (gpio_is_valid(udc->board.vbus_pin) && !udc->board.vbus_polled)
1856 free_irq(gpio_to_irq(udc->board.vbus_pin), udc);
1858 if (gpio_is_valid(udc->board.vbus_pin))
1859 gpio_free(udc->board.vbus_pin);
1861 free_irq(udc->udp_irq, udc);
1863 device_unregister(&udc->gadget.dev);
1865 iounmap(udc->udp_baseaddr);
1867 if (cpu_is_at91rm9200())
1868 gpio_free(udc->board.pullup_pin);
1870 release_mem_region(res->start, resource_size(res));
1871 DBG("%s probe failed, %d\n", driver_name, retval);
1875 static int __exit at91udc_remove(struct platform_device *pdev)
1877 struct at91_udc *udc = platform_get_drvdata(pdev);
1878 struct resource *res;
1879 unsigned long flags;
1883 usb_del_gadget_udc(&udc->gadget);
1887 spin_lock_irqsave(&udc->lock, flags);
1889 spin_unlock_irqrestore(&udc->lock, flags);
1891 device_init_wakeup(&pdev->dev, 0);
1892 remove_debug_file(udc);
1893 if (gpio_is_valid(udc->board.vbus_pin)) {
1894 free_irq(gpio_to_irq(udc->board.vbus_pin), udc);
1895 gpio_free(udc->board.vbus_pin);
1897 free_irq(udc->udp_irq, udc);
1898 device_unregister(&udc->gadget.dev);
1900 iounmap(udc->udp_baseaddr);
1902 if (cpu_is_at91rm9200())
1903 gpio_free(udc->board.pullup_pin);
1905 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1906 release_mem_region(res->start, resource_size(res));
1915 static int at91udc_suspend(struct platform_device *pdev, pm_message_t mesg)
1917 struct at91_udc *udc = platform_get_drvdata(pdev);
1918 int wake = udc->driver && device_may_wakeup(&pdev->dev);
1919 unsigned long flags;
1921 /* Unless we can act normally to the host (letting it wake us up
1922 * whenever it has work for us) force disconnect. Wakeup requires
1923 * PLLB for USB events (signaling for reset, wakeup, or incoming
1924 * tokens) and VBUS irqs (on systems which support them).
1926 if ((!udc->suspended && udc->addr)
1928 || at91_suspend_entering_slow_clock()) {
1929 spin_lock_irqsave(&udc->lock, flags);
1932 spin_unlock_irqrestore(&udc->lock, flags);
1934 enable_irq_wake(udc->udp_irq);
1936 udc->active_suspend = wake;
1937 if (gpio_is_valid(udc->board.vbus_pin) && !udc->board.vbus_polled && wake)
1938 enable_irq_wake(udc->board.vbus_pin);
1942 static int at91udc_resume(struct platform_device *pdev)
1944 struct at91_udc *udc = platform_get_drvdata(pdev);
1945 unsigned long flags;
1947 if (gpio_is_valid(udc->board.vbus_pin) && !udc->board.vbus_polled &&
1948 udc->active_suspend)
1949 disable_irq_wake(udc->board.vbus_pin);
1951 /* maybe reconnect to host; if so, clocks on */
1952 if (udc->active_suspend)
1953 disable_irq_wake(udc->udp_irq);
1955 spin_lock_irqsave(&udc->lock, flags);
1957 spin_unlock_irqrestore(&udc->lock, flags);
1962 #define at91udc_suspend NULL
1963 #define at91udc_resume NULL
1966 #if defined(CONFIG_OF)
1967 static const struct of_device_id at91_udc_dt_ids[] = {
1968 { .compatible = "atmel,at91rm9200-udc" },
1972 MODULE_DEVICE_TABLE(of, at91_udc_dt_ids);
1975 static struct platform_driver at91_udc_driver = {
1976 .remove = __exit_p(at91udc_remove),
1977 .shutdown = at91udc_shutdown,
1978 .suspend = at91udc_suspend,
1979 .resume = at91udc_resume,
1981 .name = (char *) driver_name,
1982 .owner = THIS_MODULE,
1983 .of_match_table = of_match_ptr(at91_udc_dt_ids),
1987 static int __init udc_init_module(void)
1989 return platform_driver_probe(&at91_udc_driver, at91udc_probe);
1991 module_init(udc_init_module);
1993 static void __exit udc_exit_module(void)
1995 platform_driver_unregister(&at91_udc_driver);
1997 module_exit(udc_exit_module);
1999 MODULE_DESCRIPTION("AT91 udc driver");
2000 MODULE_AUTHOR("Thomas Rathbone, David Brownell");
2001 MODULE_LICENSE("GPL");
2002 MODULE_ALIAS("platform:at91_udc");