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>
34 #include <linux/platform_data/atmel.h>
36 #include <asm/byteorder.h>
37 #include <mach/hardware.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 supporting
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_DATA(inode));
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;
478 || !desc || _ep->name == ep0name
479 || desc->bDescriptorType != USB_DT_ENDPOINT
480 || (maxpacket = usb_endpoint_maxp(desc)) == 0
481 || maxpacket > ep->maxpacket) {
482 DBG("bad ep or descriptor\n");
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);
533 ep->ep.maxpacket = maxpacket;
536 * reset/init endpoint fifo. NOTE: leaves fifo_bank alone,
537 * since endpoint resets don't reset hw pingpong state.
539 at91_udp_write(udc, AT91_UDP_RST_EP, ep->int_mask);
540 at91_udp_write(udc, AT91_UDP_RST_EP, 0);
542 spin_unlock_irqrestore(&udc->lock, flags);
546 static int at91_ep_disable (struct usb_ep * _ep)
548 struct at91_ep *ep = container_of(_ep, struct at91_ep, ep);
549 struct at91_udc *udc = ep->udc;
552 if (ep == &ep->udc->ep[0])
555 spin_lock_irqsave(&udc->lock, flags);
557 nuke(ep, -ESHUTDOWN);
559 /* restore the endpoint's pristine config */
561 ep->ep.maxpacket = ep->maxpacket;
563 /* reset fifos and endpoint */
564 if (ep->udc->clocked) {
565 at91_udp_write(udc, AT91_UDP_RST_EP, ep->int_mask);
566 at91_udp_write(udc, AT91_UDP_RST_EP, 0);
567 __raw_writel(0, ep->creg);
570 spin_unlock_irqrestore(&udc->lock, flags);
575 * this is a PIO-only driver, so there's nothing
576 * interesting for request or buffer allocation.
579 static struct usb_request *
580 at91_ep_alloc_request(struct usb_ep *_ep, gfp_t gfp_flags)
582 struct at91_request *req;
584 req = kzalloc(sizeof (struct at91_request), gfp_flags);
588 INIT_LIST_HEAD(&req->queue);
592 static void at91_ep_free_request(struct usb_ep *_ep, struct usb_request *_req)
594 struct at91_request *req;
596 req = container_of(_req, struct at91_request, req);
597 BUG_ON(!list_empty(&req->queue));
601 static int at91_ep_queue(struct usb_ep *_ep,
602 struct usb_request *_req, gfp_t gfp_flags)
604 struct at91_request *req;
606 struct at91_udc *udc;
610 req = container_of(_req, struct at91_request, req);
611 ep = container_of(_ep, struct at91_ep, ep);
613 if (!_req || !_req->complete
614 || !_req->buf || !list_empty(&req->queue)) {
615 DBG("invalid request\n");
619 if (!_ep || (!ep->ep.desc && ep->ep.name != ep0name)) {
626 if (!udc || !udc->driver || udc->gadget.speed == USB_SPEED_UNKNOWN) {
627 DBG("invalid device\n");
631 _req->status = -EINPROGRESS;
634 spin_lock_irqsave(&udc->lock, flags);
636 /* try to kickstart any empty and idle queue */
637 if (list_empty(&ep->queue) && !ep->stopped) {
641 * If this control request has a non-empty DATA stage, this
642 * will start that stage. It works just like a non-control
643 * request (until the status stage starts, maybe early).
645 * If the data stage is empty, then this starts a successful
646 * IN/STATUS stage. (Unsuccessful ones use set_halt.)
648 is_ep0 = (ep->ep.name == ep0name);
652 if (!udc->req_pending) {
658 * defer changing CONFG until after the gadget driver
659 * reconfigures the endpoints.
661 if (udc->wait_for_config_ack) {
662 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT);
663 tmp ^= AT91_UDP_CONFG;
664 VDBG("toggle config\n");
665 at91_udp_write(udc, AT91_UDP_GLB_STAT, tmp);
667 if (req->req.length == 0) {
669 PACKET("ep0 in/status\n");
671 tmp = __raw_readl(ep->creg);
673 tmp |= CLR_FX | AT91_UDP_TXPKTRDY;
674 __raw_writel(tmp, ep->creg);
675 udc->req_pending = 0;
681 status = write_fifo(ep, req);
683 status = read_fifo(ep, req);
685 /* IN/STATUS stage is otherwise triggered by irq */
686 if (status && is_ep0)
692 if (req && !status) {
693 list_add_tail (&req->queue, &ep->queue);
694 at91_udp_write(udc, AT91_UDP_IER, ep->int_mask);
697 spin_unlock_irqrestore(&udc->lock, flags);
698 return (status < 0) ? status : 0;
701 static int at91_ep_dequeue(struct usb_ep *_ep, struct usb_request *_req)
704 struct at91_request *req;
706 struct at91_udc *udc;
708 ep = container_of(_ep, struct at91_ep, ep);
709 if (!_ep || ep->ep.name == ep0name)
714 spin_lock_irqsave(&udc->lock, flags);
716 /* make sure it's actually queued on this endpoint */
717 list_for_each_entry (req, &ep->queue, queue) {
718 if (&req->req == _req)
721 if (&req->req != _req) {
722 spin_unlock_irqrestore(&udc->lock, flags);
726 done(ep, req, -ECONNRESET);
727 spin_unlock_irqrestore(&udc->lock, flags);
731 static int at91_ep_set_halt(struct usb_ep *_ep, int value)
733 struct at91_ep *ep = container_of(_ep, struct at91_ep, ep);
734 struct at91_udc *udc = ep->udc;
740 if (!_ep || ep->is_iso || !ep->udc->clocked)
744 spin_lock_irqsave(&udc->lock, flags);
746 csr = __raw_readl(creg);
749 * fail with still-busy IN endpoints, ensuring correct sequencing
750 * of data tx then stall. note that the fifo rx bytecount isn't
751 * completely accurate as a tx bytecount.
753 if (ep->is_in && (!list_empty(&ep->queue) || (csr >> 16) != 0))
759 csr |= AT91_UDP_FORCESTALL;
760 VDBG("halt %s\n", ep->ep.name);
762 at91_udp_write(udc, AT91_UDP_RST_EP, ep->int_mask);
763 at91_udp_write(udc, AT91_UDP_RST_EP, 0);
764 csr &= ~AT91_UDP_FORCESTALL;
766 __raw_writel(csr, creg);
769 spin_unlock_irqrestore(&udc->lock, flags);
773 static const struct usb_ep_ops at91_ep_ops = {
774 .enable = at91_ep_enable,
775 .disable = at91_ep_disable,
776 .alloc_request = at91_ep_alloc_request,
777 .free_request = at91_ep_free_request,
778 .queue = at91_ep_queue,
779 .dequeue = at91_ep_dequeue,
780 .set_halt = at91_ep_set_halt,
781 /* there's only imprecise fifo status reporting */
784 /*-------------------------------------------------------------------------*/
786 static int at91_get_frame(struct usb_gadget *gadget)
788 struct at91_udc *udc = to_udc(gadget);
790 if (!to_udc(gadget)->clocked)
792 return at91_udp_read(udc, AT91_UDP_FRM_NUM) & AT91_UDP_NUM;
795 static int at91_wakeup(struct usb_gadget *gadget)
797 struct at91_udc *udc = to_udc(gadget);
799 int status = -EINVAL;
802 DBG("%s\n", __func__ );
803 spin_lock_irqsave(&udc->lock, flags);
805 if (!udc->clocked || !udc->suspended)
808 /* NOTE: some "early versions" handle ESR differently ... */
810 glbstate = at91_udp_read(udc, AT91_UDP_GLB_STAT);
811 if (!(glbstate & AT91_UDP_ESR))
813 glbstate |= AT91_UDP_ESR;
814 at91_udp_write(udc, AT91_UDP_GLB_STAT, glbstate);
817 spin_unlock_irqrestore(&udc->lock, flags);
821 /* reinit == restore initial software state */
822 static void udc_reinit(struct at91_udc *udc)
826 INIT_LIST_HEAD(&udc->gadget.ep_list);
827 INIT_LIST_HEAD(&udc->gadget.ep0->ep_list);
829 for (i = 0; i < NUM_ENDPOINTS; i++) {
830 struct at91_ep *ep = &udc->ep[i];
833 list_add_tail(&ep->ep.ep_list, &udc->gadget.ep_list);
837 ep->ep.maxpacket = ep->maxpacket;
838 ep->creg = (void __iomem *) udc->udp_baseaddr + AT91_UDP_CSR(i);
839 /* initialize one queue per endpoint */
840 INIT_LIST_HEAD(&ep->queue);
844 static void stop_activity(struct at91_udc *udc)
846 struct usb_gadget_driver *driver = udc->driver;
849 if (udc->gadget.speed == USB_SPEED_UNKNOWN)
851 udc->gadget.speed = USB_SPEED_UNKNOWN;
854 for (i = 0; i < NUM_ENDPOINTS; i++) {
855 struct at91_ep *ep = &udc->ep[i];
857 nuke(ep, -ESHUTDOWN);
860 spin_unlock(&udc->lock);
861 driver->disconnect(&udc->gadget);
862 spin_lock(&udc->lock);
868 static void clk_on(struct at91_udc *udc)
874 if (IS_ENABLED(CONFIG_COMMON_CLK)) {
875 clk_set_rate(udc->uclk, 48000000);
876 clk_prepare_enable(udc->uclk);
878 clk_prepare_enable(udc->iclk);
879 clk_prepare_enable(udc->fclk);
882 static void clk_off(struct at91_udc *udc)
887 udc->gadget.speed = USB_SPEED_UNKNOWN;
888 clk_disable_unprepare(udc->fclk);
889 clk_disable_unprepare(udc->iclk);
890 if (IS_ENABLED(CONFIG_COMMON_CLK))
891 clk_disable_unprepare(udc->uclk);
895 * activate/deactivate link with host; minimize power usage for
896 * inactive links by cutting clocks and transceiver power.
898 static void pullup(struct at91_udc *udc, int is_on)
900 int active = !udc->board.pullup_active_low;
902 if (!udc->enabled || !udc->vbus)
904 DBG("%sactive\n", is_on ? "" : "in");
908 at91_udp_write(udc, AT91_UDP_ICR, AT91_UDP_RXRSM);
909 at91_udp_write(udc, AT91_UDP_TXVC, 0);
910 if (cpu_is_at91rm9200())
911 gpio_set_value(udc->board.pullup_pin, active);
912 else if (cpu_is_at91sam9260() || cpu_is_at91sam9263() || cpu_is_at91sam9g20()) {
913 u32 txvc = at91_udp_read(udc, AT91_UDP_TXVC);
915 txvc |= AT91_UDP_TXVC_PUON;
916 at91_udp_write(udc, AT91_UDP_TXVC, txvc);
917 } else if (cpu_is_at91sam9261() || cpu_is_at91sam9g10()) {
920 usbpucr = at91_matrix_read(AT91_MATRIX_USBPUCR);
921 usbpucr |= AT91_MATRIX_USBPUCR_PUON;
922 at91_matrix_write(AT91_MATRIX_USBPUCR, usbpucr);
926 at91_udp_write(udc, AT91_UDP_IDR, AT91_UDP_RXRSM);
927 at91_udp_write(udc, AT91_UDP_TXVC, AT91_UDP_TXVC_TXVDIS);
928 if (cpu_is_at91rm9200())
929 gpio_set_value(udc->board.pullup_pin, !active);
930 else if (cpu_is_at91sam9260() || cpu_is_at91sam9263() || cpu_is_at91sam9g20()) {
931 u32 txvc = at91_udp_read(udc, AT91_UDP_TXVC);
933 txvc &= ~AT91_UDP_TXVC_PUON;
934 at91_udp_write(udc, AT91_UDP_TXVC, txvc);
935 } else if (cpu_is_at91sam9261() || cpu_is_at91sam9g10()) {
938 usbpucr = at91_matrix_read(AT91_MATRIX_USBPUCR);
939 usbpucr &= ~AT91_MATRIX_USBPUCR_PUON;
940 at91_matrix_write(AT91_MATRIX_USBPUCR, usbpucr);
946 /* vbus is here! turn everything on that's ready */
947 static int at91_vbus_session(struct usb_gadget *gadget, int is_active)
949 struct at91_udc *udc = to_udc(gadget);
952 /* VDBG("vbus %s\n", is_active ? "on" : "off"); */
953 spin_lock_irqsave(&udc->lock, flags);
954 udc->vbus = (is_active != 0);
956 pullup(udc, is_active);
959 spin_unlock_irqrestore(&udc->lock, flags);
963 static int at91_pullup(struct usb_gadget *gadget, int is_on)
965 struct at91_udc *udc = to_udc(gadget);
968 spin_lock_irqsave(&udc->lock, flags);
969 udc->enabled = is_on = !!is_on;
971 spin_unlock_irqrestore(&udc->lock, flags);
975 static int at91_set_selfpowered(struct usb_gadget *gadget, int is_on)
977 struct at91_udc *udc = to_udc(gadget);
980 spin_lock_irqsave(&udc->lock, flags);
981 udc->selfpowered = (is_on != 0);
982 spin_unlock_irqrestore(&udc->lock, flags);
986 static int at91_start(struct usb_gadget *gadget,
987 struct usb_gadget_driver *driver);
988 static int at91_stop(struct usb_gadget *gadget,
989 struct usb_gadget_driver *driver);
990 static const struct usb_gadget_ops at91_udc_ops = {
991 .get_frame = at91_get_frame,
992 .wakeup = at91_wakeup,
993 .set_selfpowered = at91_set_selfpowered,
994 .vbus_session = at91_vbus_session,
995 .pullup = at91_pullup,
996 .udc_start = at91_start,
997 .udc_stop = at91_stop,
1000 * VBUS-powered devices may also also want to support bigger
1001 * power budgets after an appropriate SET_CONFIGURATION.
1003 /* .vbus_power = at91_vbus_power, */
1006 /*-------------------------------------------------------------------------*/
1008 static int handle_ep(struct at91_ep *ep)
1010 struct at91_request *req;
1011 u32 __iomem *creg = ep->creg;
1012 u32 csr = __raw_readl(creg);
1014 if (!list_empty(&ep->queue))
1015 req = list_entry(ep->queue.next,
1016 struct at91_request, queue);
1021 if (csr & (AT91_UDP_STALLSENT | AT91_UDP_TXCOMP)) {
1023 csr &= ~(SET_FX | AT91_UDP_STALLSENT | AT91_UDP_TXCOMP);
1024 __raw_writel(csr, creg);
1027 return write_fifo(ep, req);
1030 if (csr & AT91_UDP_STALLSENT) {
1031 /* STALLSENT bit == ISOERR */
1032 if (ep->is_iso && req)
1033 req->req.status = -EILSEQ;
1035 csr &= ~(SET_FX | AT91_UDP_STALLSENT);
1036 __raw_writel(csr, creg);
1037 csr = __raw_readl(creg);
1039 if (req && (csr & RX_DATA_READY))
1040 return read_fifo(ep, req);
1047 struct usb_ctrlrequest r;
1050 static void handle_setup(struct at91_udc *udc, struct at91_ep *ep, u32 csr)
1052 u32 __iomem *creg = ep->creg;
1053 u8 __iomem *dreg = ep->creg + (AT91_UDP_FDR(0) - AT91_UDP_CSR(0));
1054 unsigned rxcount, i = 0;
1059 /* read and ack SETUP; hard-fail for bogus packets */
1060 rxcount = (csr & AT91_UDP_RXBYTECNT) >> 16;
1061 if (likely(rxcount == 8)) {
1063 pkt.raw[i++] = __raw_readb(dreg);
1064 if (pkt.r.bRequestType & USB_DIR_IN) {
1065 csr |= AT91_UDP_DIR;
1068 csr &= ~AT91_UDP_DIR;
1072 /* REVISIT this happens sometimes under load; why?? */
1073 ERR("SETUP len %d, csr %08x\n", rxcount, csr);
1077 csr &= ~(SET_FX | AT91_UDP_RXSETUP);
1078 __raw_writel(csr, creg);
1079 udc->wait_for_addr_ack = 0;
1080 udc->wait_for_config_ack = 0;
1082 if (unlikely(status != 0))
1085 #define w_index le16_to_cpu(pkt.r.wIndex)
1086 #define w_value le16_to_cpu(pkt.r.wValue)
1087 #define w_length le16_to_cpu(pkt.r.wLength)
1089 VDBG("SETUP %02x.%02x v%04x i%04x l%04x\n",
1090 pkt.r.bRequestType, pkt.r.bRequest,
1091 w_value, w_index, w_length);
1094 * A few standard requests get handled here, ones that touch
1095 * hardware ... notably for device and endpoint features.
1097 udc->req_pending = 1;
1098 csr = __raw_readl(creg);
1101 switch ((pkt.r.bRequestType << 8) | pkt.r.bRequest) {
1103 case ((USB_TYPE_STANDARD|USB_RECIP_DEVICE) << 8)
1104 | USB_REQ_SET_ADDRESS:
1105 __raw_writel(csr | AT91_UDP_TXPKTRDY, creg);
1106 udc->addr = w_value;
1107 udc->wait_for_addr_ack = 1;
1108 udc->req_pending = 0;
1109 /* FADDR is set later, when we ack host STATUS */
1112 case ((USB_TYPE_STANDARD|USB_RECIP_DEVICE) << 8)
1113 | USB_REQ_SET_CONFIGURATION:
1114 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT) & AT91_UDP_CONFG;
1116 udc->wait_for_config_ack = (tmp == 0);
1118 udc->wait_for_config_ack = (tmp != 0);
1119 if (udc->wait_for_config_ack)
1120 VDBG("wait for config\n");
1121 /* CONFG is toggled later, if gadget driver succeeds */
1125 * Hosts may set or clear remote wakeup status, and
1126 * devices may report they're VBUS powered.
1128 case ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE) << 8)
1129 | USB_REQ_GET_STATUS:
1130 tmp = (udc->selfpowered << USB_DEVICE_SELF_POWERED);
1131 if (at91_udp_read(udc, AT91_UDP_GLB_STAT) & AT91_UDP_ESR)
1132 tmp |= (1 << USB_DEVICE_REMOTE_WAKEUP);
1133 PACKET("get device status\n");
1134 __raw_writeb(tmp, dreg);
1135 __raw_writeb(0, dreg);
1137 /* then STATUS starts later, automatically */
1138 case ((USB_TYPE_STANDARD|USB_RECIP_DEVICE) << 8)
1139 | USB_REQ_SET_FEATURE:
1140 if (w_value != USB_DEVICE_REMOTE_WAKEUP)
1142 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT);
1143 tmp |= AT91_UDP_ESR;
1144 at91_udp_write(udc, AT91_UDP_GLB_STAT, tmp);
1146 case ((USB_TYPE_STANDARD|USB_RECIP_DEVICE) << 8)
1147 | USB_REQ_CLEAR_FEATURE:
1148 if (w_value != USB_DEVICE_REMOTE_WAKEUP)
1150 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT);
1151 tmp &= ~AT91_UDP_ESR;
1152 at91_udp_write(udc, AT91_UDP_GLB_STAT, tmp);
1156 * Interfaces have no feature settings; this is pretty useless.
1157 * we won't even insist the interface exists...
1159 case ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE) << 8)
1160 | USB_REQ_GET_STATUS:
1161 PACKET("get interface status\n");
1162 __raw_writeb(0, dreg);
1163 __raw_writeb(0, dreg);
1165 /* then STATUS starts later, automatically */
1166 case ((USB_TYPE_STANDARD|USB_RECIP_INTERFACE) << 8)
1167 | USB_REQ_SET_FEATURE:
1168 case ((USB_TYPE_STANDARD|USB_RECIP_INTERFACE) << 8)
1169 | USB_REQ_CLEAR_FEATURE:
1173 * Hosts may clear bulk/intr endpoint halt after the gadget
1174 * driver sets it (not widely used); or set it (for testing)
1176 case ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT) << 8)
1177 | USB_REQ_GET_STATUS:
1178 tmp = w_index & USB_ENDPOINT_NUMBER_MASK;
1180 if (tmp >= NUM_ENDPOINTS || (tmp && !ep->ep.desc))
1184 if ((w_index & USB_DIR_IN)) {
1187 } else if (ep->is_in)
1190 PACKET("get %s status\n", ep->ep.name);
1191 if (__raw_readl(ep->creg) & AT91_UDP_FORCESTALL)
1192 tmp = (1 << USB_ENDPOINT_HALT);
1195 __raw_writeb(tmp, dreg);
1196 __raw_writeb(0, dreg);
1198 /* then STATUS starts later, automatically */
1199 case ((USB_TYPE_STANDARD|USB_RECIP_ENDPOINT) << 8)
1200 | USB_REQ_SET_FEATURE:
1201 tmp = w_index & USB_ENDPOINT_NUMBER_MASK;
1203 if (w_value != USB_ENDPOINT_HALT || tmp >= NUM_ENDPOINTS)
1205 if (!ep->ep.desc || ep->is_iso)
1207 if ((w_index & USB_DIR_IN)) {
1210 } else if (ep->is_in)
1213 tmp = __raw_readl(ep->creg);
1215 tmp |= CLR_FX | AT91_UDP_FORCESTALL;
1216 __raw_writel(tmp, ep->creg);
1218 case ((USB_TYPE_STANDARD|USB_RECIP_ENDPOINT) << 8)
1219 | USB_REQ_CLEAR_FEATURE:
1220 tmp = w_index & USB_ENDPOINT_NUMBER_MASK;
1222 if (w_value != USB_ENDPOINT_HALT || tmp >= NUM_ENDPOINTS)
1226 if (!ep->ep.desc || ep->is_iso)
1228 if ((w_index & USB_DIR_IN)) {
1231 } else if (ep->is_in)
1234 at91_udp_write(udc, AT91_UDP_RST_EP, ep->int_mask);
1235 at91_udp_write(udc, AT91_UDP_RST_EP, 0);
1236 tmp = __raw_readl(ep->creg);
1238 tmp &= ~(SET_FX | AT91_UDP_FORCESTALL);
1239 __raw_writel(tmp, ep->creg);
1240 if (!list_empty(&ep->queue))
1249 /* pass request up to the gadget driver */
1251 spin_unlock(&udc->lock);
1252 status = udc->driver->setup(&udc->gadget, &pkt.r);
1253 spin_lock(&udc->lock);
1259 VDBG("req %02x.%02x protocol STALL; stat %d\n",
1260 pkt.r.bRequestType, pkt.r.bRequest, status);
1261 csr |= AT91_UDP_FORCESTALL;
1262 __raw_writel(csr, creg);
1263 udc->req_pending = 0;
1268 /* immediate successful (IN) STATUS after zero length DATA */
1269 PACKET("ep0 in/status\n");
1271 csr |= AT91_UDP_TXPKTRDY;
1272 __raw_writel(csr, creg);
1273 udc->req_pending = 0;
1276 static void handle_ep0(struct at91_udc *udc)
1278 struct at91_ep *ep0 = &udc->ep[0];
1279 u32 __iomem *creg = ep0->creg;
1280 u32 csr = __raw_readl(creg);
1281 struct at91_request *req;
1283 if (unlikely(csr & AT91_UDP_STALLSENT)) {
1285 udc->req_pending = 0;
1287 csr &= ~(SET_FX | AT91_UDP_STALLSENT | AT91_UDP_FORCESTALL);
1288 __raw_writel(csr, creg);
1289 VDBG("ep0 stalled\n");
1290 csr = __raw_readl(creg);
1292 if (csr & AT91_UDP_RXSETUP) {
1294 udc->req_pending = 0;
1295 handle_setup(udc, ep0, csr);
1299 if (list_empty(&ep0->queue))
1302 req = list_entry(ep0->queue.next, struct at91_request, queue);
1304 /* host ACKed an IN packet that we sent */
1305 if (csr & AT91_UDP_TXCOMP) {
1307 csr &= ~(SET_FX | AT91_UDP_TXCOMP);
1309 /* write more IN DATA? */
1310 if (req && ep0->is_in) {
1312 udc->req_pending = 0;
1316 * - last IN DATA packet (including GET_STATUS)
1317 * - IN/STATUS for OUT DATA
1318 * - IN/STATUS for any zero-length DATA stage
1319 * except for the IN DATA case, the host should send
1320 * an OUT status later, which we'll ack.
1323 udc->req_pending = 0;
1324 __raw_writel(csr, creg);
1327 * SET_ADDRESS takes effect only after the STATUS
1328 * (to the original address) gets acked.
1330 if (udc->wait_for_addr_ack) {
1333 at91_udp_write(udc, AT91_UDP_FADDR,
1334 AT91_UDP_FEN | udc->addr);
1335 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT);
1336 tmp &= ~AT91_UDP_FADDEN;
1338 tmp |= AT91_UDP_FADDEN;
1339 at91_udp_write(udc, AT91_UDP_GLB_STAT, tmp);
1341 udc->wait_for_addr_ack = 0;
1342 VDBG("address %d\n", udc->addr);
1347 /* OUT packet arrived ... */
1348 else if (csr & AT91_UDP_RX_DATA_BK0) {
1350 csr &= ~(SET_FX | AT91_UDP_RX_DATA_BK0);
1352 /* OUT DATA stage */
1355 if (handle_ep(ep0)) {
1356 /* send IN/STATUS */
1357 PACKET("ep0 in/status\n");
1358 csr = __raw_readl(creg);
1360 csr |= CLR_FX | AT91_UDP_TXPKTRDY;
1361 __raw_writel(csr, creg);
1362 udc->req_pending = 0;
1364 } else if (udc->req_pending) {
1366 * AT91 hardware has a hard time with this
1367 * "deferred response" mode for control-OUT
1368 * transfers. (For control-IN it's fine.)
1370 * The normal solution leaves OUT data in the
1371 * fifo until the gadget driver is ready.
1372 * We couldn't do that here without disabling
1373 * the IRQ that tells about SETUP packets,
1374 * e.g. when the host gets impatient...
1376 * Working around it by copying into a buffer
1377 * would almost be a non-deferred response,
1378 * except that it wouldn't permit reliable
1379 * stalling of the request. Instead, demand
1380 * that gadget drivers not use this mode.
1382 DBG("no control-OUT deferred responses!\n");
1383 __raw_writel(csr | AT91_UDP_FORCESTALL, creg);
1384 udc->req_pending = 0;
1387 /* STATUS stage for control-IN; ack. */
1389 PACKET("ep0 out/status ACK\n");
1390 __raw_writel(csr, creg);
1392 /* "early" status stage */
1399 static irqreturn_t at91_udc_irq (int irq, void *_udc)
1401 struct at91_udc *udc = _udc;
1403 int disable_clock = 0;
1404 unsigned long flags;
1406 spin_lock_irqsave(&udc->lock, flags);
1408 if (!udc->clocked) {
1416 status = at91_udp_read(udc, AT91_UDP_ISR)
1417 & at91_udp_read(udc, AT91_UDP_IMR);
1421 /* USB reset irq: not maskable */
1422 if (status & AT91_UDP_ENDBUSRES) {
1423 at91_udp_write(udc, AT91_UDP_IDR, ~MINIMUS_INTERRUPTUS);
1424 at91_udp_write(udc, AT91_UDP_IER, MINIMUS_INTERRUPTUS);
1425 /* Atmel code clears this irq twice */
1426 at91_udp_write(udc, AT91_UDP_ICR, AT91_UDP_ENDBUSRES);
1427 at91_udp_write(udc, AT91_UDP_ICR, AT91_UDP_ENDBUSRES);
1428 VDBG("end bus reset\n");
1433 at91_udp_write(udc, AT91_UDP_CSR(0),
1434 AT91_UDP_EPEDS | AT91_UDP_EPTYPE_CTRL);
1435 udc->gadget.speed = USB_SPEED_FULL;
1437 at91_udp_write(udc, AT91_UDP_IER, AT91_UDP_EP(0));
1440 * NOTE: this driver keeps clocks off unless the
1441 * USB host is present. That saves power, but for
1442 * boards that don't support VBUS detection, both
1443 * clocks need to be active most of the time.
1446 /* host initiated suspend (3+ms bus idle) */
1447 } else if (status & AT91_UDP_RXSUSP) {
1448 at91_udp_write(udc, AT91_UDP_IDR, AT91_UDP_RXSUSP);
1449 at91_udp_write(udc, AT91_UDP_IER, AT91_UDP_RXRSM);
1450 at91_udp_write(udc, AT91_UDP_ICR, AT91_UDP_RXSUSP);
1451 /* VDBG("bus suspend\n"); */
1457 * NOTE: when suspending a VBUS-powered device, the
1458 * gadget driver should switch into slow clock mode
1459 * and then into standby to avoid drawing more than
1460 * 500uA power (2500uA for some high-power configs).
1462 if (udc->driver && udc->driver->suspend) {
1463 spin_unlock(&udc->lock);
1464 udc->driver->suspend(&udc->gadget);
1465 spin_lock(&udc->lock);
1468 /* host initiated resume */
1469 } else if (status & AT91_UDP_RXRSM) {
1470 at91_udp_write(udc, AT91_UDP_IDR, AT91_UDP_RXRSM);
1471 at91_udp_write(udc, AT91_UDP_IER, AT91_UDP_RXSUSP);
1472 at91_udp_write(udc, AT91_UDP_ICR, AT91_UDP_RXRSM);
1473 /* VDBG("bus resume\n"); */
1474 if (!udc->suspended)
1479 * NOTE: for a VBUS-powered device, the gadget driver
1480 * would normally want to switch out of slow clock
1481 * mode into normal mode.
1483 if (udc->driver && udc->driver->resume) {
1484 spin_unlock(&udc->lock);
1485 udc->driver->resume(&udc->gadget);
1486 spin_lock(&udc->lock);
1489 /* endpoint IRQs are cleared by handling them */
1493 struct at91_ep *ep = &udc->ep[1];
1497 for (i = 1; i < NUM_ENDPOINTS; i++) {
1509 spin_unlock_irqrestore(&udc->lock, flags);
1514 /*-------------------------------------------------------------------------*/
1516 static void nop_release(struct device *dev)
1518 /* nothing to free */
1521 static struct at91_udc controller = {
1523 .ops = &at91_udc_ops,
1524 .ep0 = &controller.ep[0].ep,
1525 .name = driver_name,
1527 .init_name = "gadget",
1528 .release = nop_release,
1534 .ops = &at91_ep_ops,
1543 .ops = &at91_ep_ops,
1553 .ops = &at91_ep_ops,
1562 /* could actually do bulk too */
1564 .ops = &at91_ep_ops,
1573 .ops = &at91_ep_ops,
1583 .ops = &at91_ep_ops,
1590 /* ep6 and ep7 are also reserved (custom silicon might use them) */
1593 static void at91_vbus_update(struct at91_udc *udc, unsigned value)
1595 value ^= udc->board.vbus_active_low;
1596 if (value != udc->vbus)
1597 at91_vbus_session(&udc->gadget, value);
1600 static irqreturn_t at91_vbus_irq(int irq, void *_udc)
1602 struct at91_udc *udc = _udc;
1604 /* vbus needs at least brief debouncing */
1606 at91_vbus_update(udc, gpio_get_value(udc->board.vbus_pin));
1611 static void at91_vbus_timer_work(struct work_struct *work)
1613 struct at91_udc *udc = container_of(work, struct at91_udc,
1616 at91_vbus_update(udc, gpio_get_value_cansleep(udc->board.vbus_pin));
1618 if (!timer_pending(&udc->vbus_timer))
1619 mod_timer(&udc->vbus_timer, jiffies + VBUS_POLL_TIMEOUT);
1622 static void at91_vbus_timer(unsigned long data)
1624 struct at91_udc *udc = (struct at91_udc *)data;
1627 * If we are polling vbus it is likely that the gpio is on an
1628 * bus such as i2c or spi which may sleep, so schedule some work
1629 * to read the vbus gpio
1631 schedule_work(&udc->vbus_timer_work);
1634 static int at91_start(struct usb_gadget *gadget,
1635 struct usb_gadget_driver *driver)
1637 struct at91_udc *udc;
1639 udc = container_of(gadget, struct at91_udc, gadget);
1640 udc->driver = driver;
1641 udc->gadget.dev.of_node = udc->pdev->dev.of_node;
1643 udc->selfpowered = 1;
1645 DBG("bound to %s\n", driver->driver.name);
1649 static int at91_stop(struct usb_gadget *gadget,
1650 struct usb_gadget_driver *driver)
1652 struct at91_udc *udc;
1653 unsigned long flags;
1655 udc = container_of(gadget, struct at91_udc, gadget);
1656 spin_lock_irqsave(&udc->lock, flags);
1658 at91_udp_write(udc, AT91_UDP_IDR, ~0);
1659 spin_unlock_irqrestore(&udc->lock, flags);
1663 DBG("unbound from %s\n", driver->driver.name);
1667 /*-------------------------------------------------------------------------*/
1669 static void at91udc_shutdown(struct platform_device *dev)
1671 struct at91_udc *udc = platform_get_drvdata(dev);
1672 unsigned long flags;
1674 /* force disconnect on reboot */
1675 spin_lock_irqsave(&udc->lock, flags);
1676 pullup(platform_get_drvdata(dev), 0);
1677 spin_unlock_irqrestore(&udc->lock, flags);
1680 static void at91udc_of_init(struct at91_udc *udc,
1681 struct device_node *np)
1683 struct at91_udc_data *board = &udc->board;
1685 enum of_gpio_flags flags;
1687 if (of_property_read_u32(np, "atmel,vbus-polled", &val) == 0)
1688 board->vbus_polled = 1;
1690 board->vbus_pin = of_get_named_gpio_flags(np, "atmel,vbus-gpio", 0,
1692 board->vbus_active_low = (flags & OF_GPIO_ACTIVE_LOW) ? 1 : 0;
1694 board->pullup_pin = of_get_named_gpio_flags(np, "atmel,pullup-gpio", 0,
1697 board->pullup_active_low = (flags & OF_GPIO_ACTIVE_LOW) ? 1 : 0;
1700 static int at91udc_probe(struct platform_device *pdev)
1702 struct device *dev = &pdev->dev;
1703 struct at91_udc *udc;
1705 struct resource *res;
1707 if (!dev_get_platdata(dev) && !pdev->dev.of_node) {
1708 /* small (so we copy it) but critical! */
1709 DBG("missing platform_data\n");
1713 if (pdev->num_resources != 2) {
1714 DBG("invalid num_resources\n");
1717 if ((pdev->resource[0].flags != IORESOURCE_MEM)
1718 || (pdev->resource[1].flags != IORESOURCE_IRQ)) {
1719 DBG("invalid resource type\n");
1723 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1727 if (!request_mem_region(res->start, resource_size(res), driver_name)) {
1728 DBG("someone's using UDC memory\n");
1732 /* init software state */
1734 udc->gadget.dev.parent = dev;
1735 if (IS_ENABLED(CONFIG_OF) && pdev->dev.of_node)
1736 at91udc_of_init(udc, pdev->dev.of_node);
1738 memcpy(&udc->board, dev_get_platdata(dev),
1739 sizeof(struct at91_udc_data));
1742 spin_lock_init(&udc->lock);
1744 /* rm9200 needs manual D+ pullup; off by default */
1745 if (cpu_is_at91rm9200()) {
1746 if (!gpio_is_valid(udc->board.pullup_pin)) {
1747 DBG("no D+ pullup?\n");
1751 retval = gpio_request(udc->board.pullup_pin, "udc_pullup");
1753 DBG("D+ pullup is busy\n");
1756 gpio_direction_output(udc->board.pullup_pin,
1757 udc->board.pullup_active_low);
1760 /* newer chips have more FIFO memory than rm9200 */
1761 if (cpu_is_at91sam9260() || cpu_is_at91sam9g20()) {
1762 udc->ep[0].maxpacket = 64;
1763 udc->ep[3].maxpacket = 64;
1764 udc->ep[4].maxpacket = 512;
1765 udc->ep[5].maxpacket = 512;
1766 } else if (cpu_is_at91sam9261() || cpu_is_at91sam9g10()) {
1767 udc->ep[3].maxpacket = 64;
1768 } else if (cpu_is_at91sam9263()) {
1769 udc->ep[0].maxpacket = 64;
1770 udc->ep[3].maxpacket = 64;
1773 udc->udp_baseaddr = ioremap(res->start, resource_size(res));
1774 if (!udc->udp_baseaddr) {
1781 /* get interface and function clocks */
1782 udc->iclk = clk_get(dev, "udc_clk");
1783 udc->fclk = clk_get(dev, "udpck");
1784 if (IS_ENABLED(CONFIG_COMMON_CLK))
1785 udc->uclk = clk_get(dev, "usb_clk");
1786 if (IS_ERR(udc->iclk) || IS_ERR(udc->fclk) ||
1787 (IS_ENABLED(CONFIG_COMMON_CLK) && IS_ERR(udc->uclk))) {
1788 DBG("clocks missing\n");
1793 /* don't do anything until we have both gadget driver and VBUS */
1794 retval = clk_prepare_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_unprepare(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 if (IS_ENABLED(CONFIG_COMMON_CLK) && !IS_ERR(udc->uclk))
1865 if (!IS_ERR(udc->fclk))
1867 if (!IS_ERR(udc->iclk))
1869 iounmap(udc->udp_baseaddr);
1871 if (cpu_is_at91rm9200())
1872 gpio_free(udc->board.pullup_pin);
1874 release_mem_region(res->start, resource_size(res));
1875 DBG("%s probe failed, %d\n", driver_name, retval);
1879 static int __exit at91udc_remove(struct platform_device *pdev)
1881 struct at91_udc *udc = platform_get_drvdata(pdev);
1882 struct resource *res;
1883 unsigned long flags;
1887 usb_del_gadget_udc(&udc->gadget);
1891 spin_lock_irqsave(&udc->lock, flags);
1893 spin_unlock_irqrestore(&udc->lock, flags);
1895 device_init_wakeup(&pdev->dev, 0);
1896 remove_debug_file(udc);
1897 if (gpio_is_valid(udc->board.vbus_pin)) {
1898 free_irq(gpio_to_irq(udc->board.vbus_pin), udc);
1899 gpio_free(udc->board.vbus_pin);
1901 free_irq(udc->udp_irq, udc);
1902 iounmap(udc->udp_baseaddr);
1904 if (cpu_is_at91rm9200())
1905 gpio_free(udc->board.pullup_pin);
1907 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1908 release_mem_region(res->start, resource_size(res));
1912 if (IS_ENABLED(CONFIG_COMMON_CLK))
1919 static int at91udc_suspend(struct platform_device *pdev, pm_message_t mesg)
1921 struct at91_udc *udc = platform_get_drvdata(pdev);
1922 int wake = udc->driver && device_may_wakeup(&pdev->dev);
1923 unsigned long flags;
1925 /* Unless we can act normally to the host (letting it wake us up
1926 * whenever it has work for us) force disconnect. Wakeup requires
1927 * PLLB for USB events (signaling for reset, wakeup, or incoming
1928 * tokens) and VBUS irqs (on systems which support them).
1930 if ((!udc->suspended && udc->addr)
1932 || at91_suspend_entering_slow_clock()) {
1933 spin_lock_irqsave(&udc->lock, flags);
1936 spin_unlock_irqrestore(&udc->lock, flags);
1938 enable_irq_wake(udc->udp_irq);
1940 udc->active_suspend = wake;
1941 if (gpio_is_valid(udc->board.vbus_pin) && !udc->board.vbus_polled && wake)
1942 enable_irq_wake(udc->board.vbus_pin);
1946 static int at91udc_resume(struct platform_device *pdev)
1948 struct at91_udc *udc = platform_get_drvdata(pdev);
1949 unsigned long flags;
1951 if (gpio_is_valid(udc->board.vbus_pin) && !udc->board.vbus_polled &&
1952 udc->active_suspend)
1953 disable_irq_wake(udc->board.vbus_pin);
1955 /* maybe reconnect to host; if so, clocks on */
1956 if (udc->active_suspend)
1957 disable_irq_wake(udc->udp_irq);
1959 spin_lock_irqsave(&udc->lock, flags);
1961 spin_unlock_irqrestore(&udc->lock, flags);
1966 #define at91udc_suspend NULL
1967 #define at91udc_resume NULL
1970 #if defined(CONFIG_OF)
1971 static const struct of_device_id at91_udc_dt_ids[] = {
1972 { .compatible = "atmel,at91rm9200-udc" },
1976 MODULE_DEVICE_TABLE(of, at91_udc_dt_ids);
1979 static struct platform_driver at91_udc_driver = {
1980 .remove = __exit_p(at91udc_remove),
1981 .shutdown = at91udc_shutdown,
1982 .suspend = at91udc_suspend,
1983 .resume = at91udc_resume,
1985 .name = (char *) driver_name,
1986 .owner = THIS_MODULE,
1987 .of_match_table = of_match_ptr(at91_udc_dt_ids),
1991 module_platform_driver_probe(at91_udc_driver, at91udc_probe);
1993 MODULE_DESCRIPTION("AT91 udc driver");
1994 MODULE_AUTHOR("Thomas Rathbone, David Brownell");
1995 MODULE_LICENSE("GPL");
1996 MODULE_ALIAS("platform:at91_udc");