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/list.h>
25 #include <linux/interrupt.h>
26 #include <linux/proc_fs.h>
27 #include <linux/prefetch.h>
28 #include <linux/clk.h>
29 #include <linux/usb/ch9.h>
30 #include <linux/usb/gadget.h>
32 #include <linux/of_gpio.h>
33 #include <linux/platform_data/atmel.h>
35 #include <asm/byteorder.h>
36 #include <mach/hardware.h>
42 #include <mach/at91sam9261_matrix.h>
43 #include <mach/at91_matrix.h>
49 * This controller is simple and PIO-only. It's used in many AT91-series
50 * full speed USB controllers, including the at91rm9200 (arm920T, with MMU),
51 * at91sam926x (arm926ejs, with MMU), and several no-mmu versions.
53 * This driver expects the board has been wired with two GPIOs supporting
54 * a VBUS sensing IRQ, and a D+ pullup. (They may be omitted, but the
55 * testing hasn't covered such cases.)
57 * The pullup is most important (so it's integrated on sam926x parts). It
58 * provides software control over whether the host enumerates the device.
60 * The VBUS sensing helps during enumeration, and allows both USB clocks
61 * (and the transceiver) to stay gated off until they're necessary, saving
62 * power. During USB suspend, the 48 MHz clock is gated off in hardware;
63 * it may also be gated off by software during some Linux sleep states.
66 #define DRIVER_VERSION "3 May 2006"
68 static const char driver_name [] = "at91_udc";
69 static const char ep0name[] = "ep0";
71 #define VBUS_POLL_TIMEOUT msecs_to_jiffies(1000)
73 #define at91_udp_read(udc, reg) \
74 __raw_readl((udc)->udp_baseaddr + (reg))
75 #define at91_udp_write(udc, reg, val) \
76 __raw_writel((val), (udc)->udp_baseaddr + (reg))
78 /*-------------------------------------------------------------------------*/
80 #ifdef CONFIG_USB_GADGET_DEBUG_FILES
82 #include <linux/seq_file.h>
84 static const char debug_filename[] = "driver/udc";
86 #define FOURBITS "%s%s%s%s"
87 #define EIGHTBITS FOURBITS FOURBITS
89 static void proc_ep_show(struct seq_file *s, struct at91_ep *ep)
91 static char *types[] = {
92 "control", "out-iso", "out-bulk", "out-int",
93 "BOGUS", "in-iso", "in-bulk", "in-int"};
96 struct at91_request *req;
98 struct at91_udc *udc = ep->udc;
100 spin_lock_irqsave(&udc->lock, flags);
102 csr = __raw_readl(ep->creg);
104 /* NOTE: not collecting per-endpoint irq statistics... */
107 seq_printf(s, "%s, maxpacket %d %s%s %s%s\n",
108 ep->ep.name, ep->ep.maxpacket,
109 ep->is_in ? "in" : "out",
110 ep->is_iso ? " iso" : "",
112 ? (ep->fifo_bank ? "pong" : "ping")
114 ep->stopped ? " stopped" : "");
115 seq_printf(s, "csr %08x rxbytes=%d %s %s %s" EIGHTBITS "\n",
117 (csr & 0x07ff0000) >> 16,
118 (csr & (1 << 15)) ? "enabled" : "disabled",
119 (csr & (1 << 11)) ? "DATA1" : "DATA0",
120 types[(csr & 0x700) >> 8],
122 /* iff type is control then print current direction */
124 ? ((csr & (1 << 7)) ? " IN" : " OUT")
126 (csr & (1 << 6)) ? " rxdatabk1" : "",
127 (csr & (1 << 5)) ? " forcestall" : "",
128 (csr & (1 << 4)) ? " txpktrdy" : "",
130 (csr & (1 << 3)) ? " stallsent" : "",
131 (csr & (1 << 2)) ? " rxsetup" : "",
132 (csr & (1 << 1)) ? " rxdatabk0" : "",
133 (csr & (1 << 0)) ? " txcomp" : "");
134 if (list_empty (&ep->queue))
135 seq_printf(s, "\t(queue empty)\n");
137 else list_for_each_entry (req, &ep->queue, queue) {
138 unsigned length = req->req.actual;
140 seq_printf(s, "\treq %p len %d/%d buf %p\n",
142 req->req.length, req->req.buf);
144 spin_unlock_irqrestore(&udc->lock, flags);
147 static void proc_irq_show(struct seq_file *s, const char *label, u32 mask)
151 seq_printf(s, "%s %04x:%s%s" FOURBITS, label, mask,
152 (mask & (1 << 13)) ? " wakeup" : "",
153 (mask & (1 << 12)) ? " endbusres" : "",
155 (mask & (1 << 11)) ? " sofint" : "",
156 (mask & (1 << 10)) ? " extrsm" : "",
157 (mask & (1 << 9)) ? " rxrsm" : "",
158 (mask & (1 << 8)) ? " rxsusp" : "");
159 for (i = 0; i < 8; i++) {
161 seq_printf(s, " ep%d", i);
166 static int proc_udc_show(struct seq_file *s, void *unused)
168 struct at91_udc *udc = s->private;
172 seq_printf(s, "%s: version %s\n", driver_name, DRIVER_VERSION);
174 seq_printf(s, "vbus %s, pullup %s, %s powered%s, gadget %s\n\n",
175 udc->vbus ? "present" : "off",
177 ? (udc->vbus ? "active" : "enabled")
179 udc->selfpowered ? "self" : "VBUS",
180 udc->suspended ? ", suspended" : "",
181 udc->driver ? udc->driver->driver.name : "(none)");
183 /* don't access registers when interface isn't clocked */
185 seq_printf(s, "(not clocked)\n");
189 tmp = at91_udp_read(udc, AT91_UDP_FRM_NUM);
190 seq_printf(s, "frame %05x:%s%s frame=%d\n", tmp,
191 (tmp & AT91_UDP_FRM_OK) ? " ok" : "",
192 (tmp & AT91_UDP_FRM_ERR) ? " err" : "",
193 (tmp & AT91_UDP_NUM));
195 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT);
196 seq_printf(s, "glbstate %02x:%s" FOURBITS "\n", tmp,
197 (tmp & AT91_UDP_RMWUPE) ? " rmwupe" : "",
198 (tmp & AT91_UDP_RSMINPR) ? " rsminpr" : "",
199 (tmp & AT91_UDP_ESR) ? " esr" : "",
200 (tmp & AT91_UDP_CONFG) ? " confg" : "",
201 (tmp & AT91_UDP_FADDEN) ? " fadden" : "");
203 tmp = at91_udp_read(udc, AT91_UDP_FADDR);
204 seq_printf(s, "faddr %03x:%s fadd=%d\n", tmp,
205 (tmp & AT91_UDP_FEN) ? " fen" : "",
206 (tmp & AT91_UDP_FADD));
208 proc_irq_show(s, "imr ", at91_udp_read(udc, AT91_UDP_IMR));
209 proc_irq_show(s, "isr ", at91_udp_read(udc, AT91_UDP_ISR));
211 if (udc->enabled && udc->vbus) {
212 proc_ep_show(s, &udc->ep[0]);
213 list_for_each_entry (ep, &udc->gadget.ep_list, ep.ep_list) {
221 static int proc_udc_open(struct inode *inode, struct file *file)
223 return single_open(file, proc_udc_show, PDE_DATA(inode));
226 static const struct file_operations proc_ops = {
227 .owner = THIS_MODULE,
228 .open = proc_udc_open,
231 .release = single_release,
234 static void create_debug_file(struct at91_udc *udc)
236 udc->pde = proc_create_data(debug_filename, 0, NULL, &proc_ops, udc);
239 static void remove_debug_file(struct at91_udc *udc)
242 remove_proc_entry(debug_filename, NULL);
247 static inline void create_debug_file(struct at91_udc *udc) {}
248 static inline void remove_debug_file(struct at91_udc *udc) {}
253 /*-------------------------------------------------------------------------*/
255 static void done(struct at91_ep *ep, struct at91_request *req, int status)
257 unsigned stopped = ep->stopped;
258 struct at91_udc *udc = ep->udc;
260 list_del_init(&req->queue);
261 if (req->req.status == -EINPROGRESS)
262 req->req.status = status;
264 status = req->req.status;
265 if (status && status != -ESHUTDOWN)
266 VDBG("%s done %p, status %d\n", ep->ep.name, req, status);
269 spin_unlock(&udc->lock);
270 req->req.complete(&ep->ep, &req->req);
271 spin_lock(&udc->lock);
272 ep->stopped = stopped;
274 /* ep0 is always ready; other endpoints need a non-empty queue */
275 if (list_empty(&ep->queue) && ep->int_mask != (1 << 0))
276 at91_udp_write(udc, AT91_UDP_IDR, ep->int_mask);
279 /*-------------------------------------------------------------------------*/
281 /* bits indicating OUT fifo has data ready */
282 #define RX_DATA_READY (AT91_UDP_RX_DATA_BK0 | AT91_UDP_RX_DATA_BK1)
285 * Endpoint FIFO CSR bits have a mix of bits, making it unsafe to just write
286 * back most of the value you just read (because of side effects, including
287 * bits that may change after reading and before writing).
289 * Except when changing a specific bit, always write values which:
290 * - clear SET_FX bits (setting them could change something)
291 * - set CLR_FX bits (clearing them could change something)
293 * There are also state bits like FORCESTALL, EPEDS, DIR, and EPTYPE
294 * that shouldn't normally be changed.
296 * NOTE at91sam9260 docs mention synch between UDPCK and MCK clock domains,
297 * implying a need to wait for one write to complete (test relevant bits)
298 * before starting the next write. This shouldn't be an issue given how
299 * infrequently we write, except maybe for write-then-read idioms.
301 #define SET_FX (AT91_UDP_TXPKTRDY)
302 #define CLR_FX (RX_DATA_READY | AT91_UDP_RXSETUP \
303 | AT91_UDP_STALLSENT | AT91_UDP_TXCOMP)
305 /* pull OUT packet data from the endpoint's fifo */
306 static int read_fifo (struct at91_ep *ep, struct at91_request *req)
308 u32 __iomem *creg = ep->creg;
309 u8 __iomem *dreg = ep->creg + (AT91_UDP_FDR(0) - AT91_UDP_CSR(0));
312 unsigned int count, bufferspace, is_done;
314 buf = req->req.buf + req->req.actual;
315 bufferspace = req->req.length - req->req.actual;
318 * there might be nothing to read if ep_queue() calls us,
319 * or if we already emptied both pingpong buffers
322 csr = __raw_readl(creg);
323 if ((csr & RX_DATA_READY) == 0)
326 count = (csr & AT91_UDP_RXBYTECNT) >> 16;
327 if (count > ep->ep.maxpacket)
328 count = ep->ep.maxpacket;
329 if (count > bufferspace) {
330 DBG("%s buffer overflow\n", ep->ep.name);
331 req->req.status = -EOVERFLOW;
334 __raw_readsb(dreg, buf, count);
336 /* release and swap pingpong mem bank */
338 if (ep->is_pingpong) {
339 if (ep->fifo_bank == 0) {
340 csr &= ~(SET_FX | AT91_UDP_RX_DATA_BK0);
343 csr &= ~(SET_FX | AT91_UDP_RX_DATA_BK1);
347 csr &= ~(SET_FX | AT91_UDP_RX_DATA_BK0);
348 __raw_writel(csr, creg);
350 req->req.actual += count;
351 is_done = (count < ep->ep.maxpacket);
352 if (count == bufferspace)
355 PACKET("%s %p out/%d%s\n", ep->ep.name, &req->req, count,
356 is_done ? " (done)" : "");
359 * avoid extra trips through IRQ logic for packets already in
360 * the fifo ... maybe preventing an extra (expensive) OUT-NAK
364 else if (ep->is_pingpong) {
366 * One dummy read to delay the code because of a HW glitch:
367 * CSR returns bad RXCOUNT when read too soon after updating
370 csr = __raw_readl(creg);
372 bufferspace -= count;
380 /* load fifo for an IN packet */
381 static int write_fifo(struct at91_ep *ep, struct at91_request *req)
383 u32 __iomem *creg = ep->creg;
384 u32 csr = __raw_readl(creg);
385 u8 __iomem *dreg = ep->creg + (AT91_UDP_FDR(0) - AT91_UDP_CSR(0));
386 unsigned total, count, is_last;
390 * TODO: allow for writing two packets to the fifo ... that'll
391 * reduce the amount of IN-NAKing, but probably won't affect
392 * throughput much. (Unlike preventing OUT-NAKing!)
396 * If ep_queue() calls us, the queue is empty and possibly in
397 * odd states like TXCOMP not yet cleared (we do it, saving at
398 * least one IRQ) or the fifo not yet being free. Those aren't
399 * issues normally (IRQ handler fast path).
401 if (unlikely(csr & (AT91_UDP_TXCOMP | AT91_UDP_TXPKTRDY))) {
402 if (csr & AT91_UDP_TXCOMP) {
404 csr &= ~(SET_FX | AT91_UDP_TXCOMP);
405 __raw_writel(csr, creg);
406 csr = __raw_readl(creg);
408 if (csr & AT91_UDP_TXPKTRDY)
412 buf = req->req.buf + req->req.actual;
414 total = req->req.length - req->req.actual;
415 if (ep->ep.maxpacket < total) {
416 count = ep->ep.maxpacket;
420 is_last = (count < ep->ep.maxpacket) || !req->req.zero;
424 * Write the packet, maybe it's a ZLP.
426 * NOTE: incrementing req->actual before we receive the ACK means
427 * gadget driver IN bytecounts can be wrong in fault cases. That's
428 * fixable with PIO drivers like this one (save "count" here, and
429 * do the increment later on TX irq), but not for most DMA hardware.
431 * So all gadget drivers must accept that potential error. Some
432 * hardware supports precise fifo status reporting, letting them
433 * recover when the actual bytecount matters (e.g. for USB Test
434 * and Measurement Class devices).
436 __raw_writesb(dreg, buf, count);
438 csr |= CLR_FX | AT91_UDP_TXPKTRDY;
439 __raw_writel(csr, creg);
440 req->req.actual += count;
442 PACKET("%s %p in/%d%s\n", ep->ep.name, &req->req, count,
443 is_last ? " (done)" : "");
449 static void nuke(struct at91_ep *ep, int status)
451 struct at91_request *req;
453 /* terminate any request in the queue */
455 if (list_empty(&ep->queue))
458 VDBG("%s %s\n", __func__, ep->ep.name);
459 while (!list_empty(&ep->queue)) {
460 req = list_entry(ep->queue.next, struct at91_request, queue);
461 done(ep, req, status);
465 /*-------------------------------------------------------------------------*/
467 static int at91_ep_enable(struct usb_ep *_ep,
468 const struct usb_endpoint_descriptor *desc)
470 struct at91_ep *ep = container_of(_ep, struct at91_ep, ep);
471 struct at91_udc *udc;
477 || !desc || _ep->name == ep0name
478 || desc->bDescriptorType != USB_DT_ENDPOINT
479 || (maxpacket = usb_endpoint_maxp(desc)) == 0
480 || maxpacket > ep->maxpacket) {
481 DBG("bad ep or descriptor\n");
486 if (!udc->driver || udc->gadget.speed == USB_SPEED_UNKNOWN) {
487 DBG("bogus device state\n");
491 tmp = usb_endpoint_type(desc);
493 case USB_ENDPOINT_XFER_CONTROL:
494 DBG("only one control endpoint\n");
496 case USB_ENDPOINT_XFER_INT:
500 case USB_ENDPOINT_XFER_BULK:
509 DBG("bogus maxpacket %d\n", maxpacket);
511 case USB_ENDPOINT_XFER_ISOC:
512 if (!ep->is_pingpong) {
513 DBG("iso requires double buffering\n");
520 spin_lock_irqsave(&udc->lock, flags);
522 /* initialize endpoint to match this descriptor */
523 ep->is_in = usb_endpoint_dir_in(desc);
524 ep->is_iso = (tmp == USB_ENDPOINT_XFER_ISOC);
529 tmp |= AT91_UDP_EPEDS;
530 __raw_writel(tmp, ep->creg);
532 ep->ep.maxpacket = maxpacket;
535 * reset/init endpoint fifo. NOTE: leaves fifo_bank alone,
536 * since endpoint resets don't reset hw pingpong state.
538 at91_udp_write(udc, AT91_UDP_RST_EP, ep->int_mask);
539 at91_udp_write(udc, AT91_UDP_RST_EP, 0);
541 spin_unlock_irqrestore(&udc->lock, flags);
545 static int at91_ep_disable (struct usb_ep * _ep)
547 struct at91_ep *ep = container_of(_ep, struct at91_ep, ep);
548 struct at91_udc *udc = ep->udc;
551 if (ep == &ep->udc->ep[0])
554 spin_lock_irqsave(&udc->lock, flags);
556 nuke(ep, -ESHUTDOWN);
558 /* restore the endpoint's pristine config */
560 ep->ep.maxpacket = ep->maxpacket;
562 /* reset fifos and endpoint */
563 if (ep->udc->clocked) {
564 at91_udp_write(udc, AT91_UDP_RST_EP, ep->int_mask);
565 at91_udp_write(udc, AT91_UDP_RST_EP, 0);
566 __raw_writel(0, ep->creg);
569 spin_unlock_irqrestore(&udc->lock, flags);
574 * this is a PIO-only driver, so there's nothing
575 * interesting for request or buffer allocation.
578 static struct usb_request *
579 at91_ep_alloc_request(struct usb_ep *_ep, gfp_t gfp_flags)
581 struct at91_request *req;
583 req = kzalloc(sizeof (struct at91_request), gfp_flags);
587 INIT_LIST_HEAD(&req->queue);
591 static void at91_ep_free_request(struct usb_ep *_ep, struct usb_request *_req)
593 struct at91_request *req;
595 req = container_of(_req, struct at91_request, req);
596 BUG_ON(!list_empty(&req->queue));
600 static int at91_ep_queue(struct usb_ep *_ep,
601 struct usb_request *_req, gfp_t gfp_flags)
603 struct at91_request *req;
605 struct at91_udc *udc;
609 req = container_of(_req, struct at91_request, req);
610 ep = container_of(_ep, struct at91_ep, ep);
612 if (!_req || !_req->complete
613 || !_req->buf || !list_empty(&req->queue)) {
614 DBG("invalid request\n");
618 if (!_ep || (!ep->ep.desc && ep->ep.name != ep0name)) {
625 if (!udc || !udc->driver || udc->gadget.speed == USB_SPEED_UNKNOWN) {
626 DBG("invalid device\n");
630 _req->status = -EINPROGRESS;
633 spin_lock_irqsave(&udc->lock, flags);
635 /* try to kickstart any empty and idle queue */
636 if (list_empty(&ep->queue) && !ep->stopped) {
640 * If this control request has a non-empty DATA stage, this
641 * will start that stage. It works just like a non-control
642 * request (until the status stage starts, maybe early).
644 * If the data stage is empty, then this starts a successful
645 * IN/STATUS stage. (Unsuccessful ones use set_halt.)
647 is_ep0 = (ep->ep.name == ep0name);
651 if (!udc->req_pending) {
657 * defer changing CONFG until after the gadget driver
658 * reconfigures the endpoints.
660 if (udc->wait_for_config_ack) {
661 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT);
662 tmp ^= AT91_UDP_CONFG;
663 VDBG("toggle config\n");
664 at91_udp_write(udc, AT91_UDP_GLB_STAT, tmp);
666 if (req->req.length == 0) {
668 PACKET("ep0 in/status\n");
670 tmp = __raw_readl(ep->creg);
672 tmp |= CLR_FX | AT91_UDP_TXPKTRDY;
673 __raw_writel(tmp, ep->creg);
674 udc->req_pending = 0;
680 status = write_fifo(ep, req);
682 status = read_fifo(ep, req);
684 /* IN/STATUS stage is otherwise triggered by irq */
685 if (status && is_ep0)
691 if (req && !status) {
692 list_add_tail (&req->queue, &ep->queue);
693 at91_udp_write(udc, AT91_UDP_IER, ep->int_mask);
696 spin_unlock_irqrestore(&udc->lock, flags);
697 return (status < 0) ? status : 0;
700 static int at91_ep_dequeue(struct usb_ep *_ep, struct usb_request *_req)
703 struct at91_request *req;
705 struct at91_udc *udc;
707 ep = container_of(_ep, struct at91_ep, ep);
708 if (!_ep || ep->ep.name == ep0name)
713 spin_lock_irqsave(&udc->lock, flags);
715 /* make sure it's actually queued on this endpoint */
716 list_for_each_entry (req, &ep->queue, queue) {
717 if (&req->req == _req)
720 if (&req->req != _req) {
721 spin_unlock_irqrestore(&udc->lock, flags);
725 done(ep, req, -ECONNRESET);
726 spin_unlock_irqrestore(&udc->lock, flags);
730 static int at91_ep_set_halt(struct usb_ep *_ep, int value)
732 struct at91_ep *ep = container_of(_ep, struct at91_ep, ep);
733 struct at91_udc *udc = ep->udc;
739 if (!_ep || ep->is_iso || !ep->udc->clocked)
743 spin_lock_irqsave(&udc->lock, flags);
745 csr = __raw_readl(creg);
748 * fail with still-busy IN endpoints, ensuring correct sequencing
749 * of data tx then stall. note that the fifo rx bytecount isn't
750 * completely accurate as a tx bytecount.
752 if (ep->is_in && (!list_empty(&ep->queue) || (csr >> 16) != 0))
758 csr |= AT91_UDP_FORCESTALL;
759 VDBG("halt %s\n", ep->ep.name);
761 at91_udp_write(udc, AT91_UDP_RST_EP, ep->int_mask);
762 at91_udp_write(udc, AT91_UDP_RST_EP, 0);
763 csr &= ~AT91_UDP_FORCESTALL;
765 __raw_writel(csr, creg);
768 spin_unlock_irqrestore(&udc->lock, flags);
772 static const struct usb_ep_ops at91_ep_ops = {
773 .enable = at91_ep_enable,
774 .disable = at91_ep_disable,
775 .alloc_request = at91_ep_alloc_request,
776 .free_request = at91_ep_free_request,
777 .queue = at91_ep_queue,
778 .dequeue = at91_ep_dequeue,
779 .set_halt = at91_ep_set_halt,
780 /* there's only imprecise fifo status reporting */
783 /*-------------------------------------------------------------------------*/
785 static int at91_get_frame(struct usb_gadget *gadget)
787 struct at91_udc *udc = to_udc(gadget);
789 if (!to_udc(gadget)->clocked)
791 return at91_udp_read(udc, AT91_UDP_FRM_NUM) & AT91_UDP_NUM;
794 static int at91_wakeup(struct usb_gadget *gadget)
796 struct at91_udc *udc = to_udc(gadget);
798 int status = -EINVAL;
801 DBG("%s\n", __func__ );
802 spin_lock_irqsave(&udc->lock, flags);
804 if (!udc->clocked || !udc->suspended)
807 /* NOTE: some "early versions" handle ESR differently ... */
809 glbstate = at91_udp_read(udc, AT91_UDP_GLB_STAT);
810 if (!(glbstate & AT91_UDP_ESR))
812 glbstate |= AT91_UDP_ESR;
813 at91_udp_write(udc, AT91_UDP_GLB_STAT, glbstate);
816 spin_unlock_irqrestore(&udc->lock, flags);
820 /* reinit == restore initial software state */
821 static void udc_reinit(struct at91_udc *udc)
825 INIT_LIST_HEAD(&udc->gadget.ep_list);
826 INIT_LIST_HEAD(&udc->gadget.ep0->ep_list);
828 for (i = 0; i < NUM_ENDPOINTS; i++) {
829 struct at91_ep *ep = &udc->ep[i];
832 list_add_tail(&ep->ep.ep_list, &udc->gadget.ep_list);
836 usb_ep_set_maxpacket_limit(&ep->ep, ep->maxpacket);
837 ep->creg = (void __iomem *) udc->udp_baseaddr + AT91_UDP_CSR(i);
838 /* initialize one queue per endpoint */
839 INIT_LIST_HEAD(&ep->queue);
843 static void stop_activity(struct at91_udc *udc)
845 struct usb_gadget_driver *driver = udc->driver;
848 if (udc->gadget.speed == USB_SPEED_UNKNOWN)
850 udc->gadget.speed = USB_SPEED_UNKNOWN;
853 for (i = 0; i < NUM_ENDPOINTS; i++) {
854 struct at91_ep *ep = &udc->ep[i];
856 nuke(ep, -ESHUTDOWN);
859 spin_unlock(&udc->lock);
860 driver->disconnect(&udc->gadget);
861 spin_lock(&udc->lock);
867 static void clk_on(struct at91_udc *udc)
873 if (IS_ENABLED(CONFIG_COMMON_CLK)) {
874 clk_set_rate(udc->uclk, 48000000);
875 clk_prepare_enable(udc->uclk);
877 clk_prepare_enable(udc->iclk);
878 clk_prepare_enable(udc->fclk);
881 static void clk_off(struct at91_udc *udc)
886 udc->gadget.speed = USB_SPEED_UNKNOWN;
887 clk_disable_unprepare(udc->fclk);
888 clk_disable_unprepare(udc->iclk);
889 if (IS_ENABLED(CONFIG_COMMON_CLK))
890 clk_disable_unprepare(udc->uclk);
894 * activate/deactivate link with host; minimize power usage for
895 * inactive links by cutting clocks and transceiver power.
897 static void pullup(struct at91_udc *udc, int is_on)
899 int active = !udc->board.pullup_active_low;
901 if (!udc->enabled || !udc->vbus)
903 DBG("%sactive\n", is_on ? "" : "in");
907 at91_udp_write(udc, AT91_UDP_ICR, AT91_UDP_RXRSM);
908 at91_udp_write(udc, AT91_UDP_TXVC, 0);
909 if (cpu_is_at91rm9200())
910 gpio_set_value(udc->board.pullup_pin, active);
911 else if (cpu_is_at91sam9260() || cpu_is_at91sam9263() || cpu_is_at91sam9g20()) {
912 u32 txvc = at91_udp_read(udc, AT91_UDP_TXVC);
914 txvc |= AT91_UDP_TXVC_PUON;
915 at91_udp_write(udc, AT91_UDP_TXVC, txvc);
916 } else if (cpu_is_at91sam9261() || cpu_is_at91sam9g10()) {
919 usbpucr = at91_matrix_read(AT91_MATRIX_USBPUCR);
920 usbpucr |= AT91_MATRIX_USBPUCR_PUON;
921 at91_matrix_write(AT91_MATRIX_USBPUCR, usbpucr);
925 at91_udp_write(udc, AT91_UDP_IDR, AT91_UDP_RXRSM);
926 at91_udp_write(udc, AT91_UDP_TXVC, AT91_UDP_TXVC_TXVDIS);
927 if (cpu_is_at91rm9200())
928 gpio_set_value(udc->board.pullup_pin, !active);
929 else if (cpu_is_at91sam9260() || cpu_is_at91sam9263() || cpu_is_at91sam9g20()) {
930 u32 txvc = at91_udp_read(udc, AT91_UDP_TXVC);
932 txvc &= ~AT91_UDP_TXVC_PUON;
933 at91_udp_write(udc, AT91_UDP_TXVC, txvc);
934 } else if (cpu_is_at91sam9261() || cpu_is_at91sam9g10()) {
937 usbpucr = at91_matrix_read(AT91_MATRIX_USBPUCR);
938 usbpucr &= ~AT91_MATRIX_USBPUCR_PUON;
939 at91_matrix_write(AT91_MATRIX_USBPUCR, usbpucr);
945 /* vbus is here! turn everything on that's ready */
946 static int at91_vbus_session(struct usb_gadget *gadget, int is_active)
948 struct at91_udc *udc = to_udc(gadget);
951 /* VDBG("vbus %s\n", is_active ? "on" : "off"); */
952 spin_lock_irqsave(&udc->lock, flags);
953 udc->vbus = (is_active != 0);
955 pullup(udc, is_active);
958 spin_unlock_irqrestore(&udc->lock, flags);
962 static int at91_pullup(struct usb_gadget *gadget, int is_on)
964 struct at91_udc *udc = to_udc(gadget);
967 spin_lock_irqsave(&udc->lock, flags);
968 udc->enabled = is_on = !!is_on;
970 spin_unlock_irqrestore(&udc->lock, flags);
974 static int at91_set_selfpowered(struct usb_gadget *gadget, int is_on)
976 struct at91_udc *udc = to_udc(gadget);
979 spin_lock_irqsave(&udc->lock, flags);
980 udc->selfpowered = (is_on != 0);
981 spin_unlock_irqrestore(&udc->lock, flags);
985 static int at91_start(struct usb_gadget *gadget,
986 struct usb_gadget_driver *driver);
987 static int at91_stop(struct usb_gadget *gadget,
988 struct usb_gadget_driver *driver);
989 static const struct usb_gadget_ops at91_udc_ops = {
990 .get_frame = at91_get_frame,
991 .wakeup = at91_wakeup,
992 .set_selfpowered = at91_set_selfpowered,
993 .vbus_session = at91_vbus_session,
994 .pullup = at91_pullup,
995 .udc_start = at91_start,
996 .udc_stop = at91_stop,
999 * VBUS-powered devices may also also want to support bigger
1000 * power budgets after an appropriate SET_CONFIGURATION.
1002 /* .vbus_power = at91_vbus_power, */
1005 /*-------------------------------------------------------------------------*/
1007 static int handle_ep(struct at91_ep *ep)
1009 struct at91_request *req;
1010 u32 __iomem *creg = ep->creg;
1011 u32 csr = __raw_readl(creg);
1013 if (!list_empty(&ep->queue))
1014 req = list_entry(ep->queue.next,
1015 struct at91_request, queue);
1020 if (csr & (AT91_UDP_STALLSENT | AT91_UDP_TXCOMP)) {
1022 csr &= ~(SET_FX | AT91_UDP_STALLSENT | AT91_UDP_TXCOMP);
1023 __raw_writel(csr, creg);
1026 return write_fifo(ep, req);
1029 if (csr & AT91_UDP_STALLSENT) {
1030 /* STALLSENT bit == ISOERR */
1031 if (ep->is_iso && req)
1032 req->req.status = -EILSEQ;
1034 csr &= ~(SET_FX | AT91_UDP_STALLSENT);
1035 __raw_writel(csr, creg);
1036 csr = __raw_readl(creg);
1038 if (req && (csr & RX_DATA_READY))
1039 return read_fifo(ep, req);
1046 struct usb_ctrlrequest r;
1049 static void handle_setup(struct at91_udc *udc, struct at91_ep *ep, u32 csr)
1051 u32 __iomem *creg = ep->creg;
1052 u8 __iomem *dreg = ep->creg + (AT91_UDP_FDR(0) - AT91_UDP_CSR(0));
1053 unsigned rxcount, i = 0;
1058 /* read and ack SETUP; hard-fail for bogus packets */
1059 rxcount = (csr & AT91_UDP_RXBYTECNT) >> 16;
1060 if (likely(rxcount == 8)) {
1062 pkt.raw[i++] = __raw_readb(dreg);
1063 if (pkt.r.bRequestType & USB_DIR_IN) {
1064 csr |= AT91_UDP_DIR;
1067 csr &= ~AT91_UDP_DIR;
1071 /* REVISIT this happens sometimes under load; why?? */
1072 ERR("SETUP len %d, csr %08x\n", rxcount, csr);
1076 csr &= ~(SET_FX | AT91_UDP_RXSETUP);
1077 __raw_writel(csr, creg);
1078 udc->wait_for_addr_ack = 0;
1079 udc->wait_for_config_ack = 0;
1081 if (unlikely(status != 0))
1084 #define w_index le16_to_cpu(pkt.r.wIndex)
1085 #define w_value le16_to_cpu(pkt.r.wValue)
1086 #define w_length le16_to_cpu(pkt.r.wLength)
1088 VDBG("SETUP %02x.%02x v%04x i%04x l%04x\n",
1089 pkt.r.bRequestType, pkt.r.bRequest,
1090 w_value, w_index, w_length);
1093 * A few standard requests get handled here, ones that touch
1094 * hardware ... notably for device and endpoint features.
1096 udc->req_pending = 1;
1097 csr = __raw_readl(creg);
1100 switch ((pkt.r.bRequestType << 8) | pkt.r.bRequest) {
1102 case ((USB_TYPE_STANDARD|USB_RECIP_DEVICE) << 8)
1103 | USB_REQ_SET_ADDRESS:
1104 __raw_writel(csr | AT91_UDP_TXPKTRDY, creg);
1105 udc->addr = w_value;
1106 udc->wait_for_addr_ack = 1;
1107 udc->req_pending = 0;
1108 /* FADDR is set later, when we ack host STATUS */
1111 case ((USB_TYPE_STANDARD|USB_RECIP_DEVICE) << 8)
1112 | USB_REQ_SET_CONFIGURATION:
1113 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT) & AT91_UDP_CONFG;
1115 udc->wait_for_config_ack = (tmp == 0);
1117 udc->wait_for_config_ack = (tmp != 0);
1118 if (udc->wait_for_config_ack)
1119 VDBG("wait for config\n");
1120 /* CONFG is toggled later, if gadget driver succeeds */
1124 * Hosts may set or clear remote wakeup status, and
1125 * devices may report they're VBUS powered.
1127 case ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE) << 8)
1128 | USB_REQ_GET_STATUS:
1129 tmp = (udc->selfpowered << USB_DEVICE_SELF_POWERED);
1130 if (at91_udp_read(udc, AT91_UDP_GLB_STAT) & AT91_UDP_ESR)
1131 tmp |= (1 << USB_DEVICE_REMOTE_WAKEUP);
1132 PACKET("get device status\n");
1133 __raw_writeb(tmp, dreg);
1134 __raw_writeb(0, dreg);
1136 /* then STATUS starts later, automatically */
1137 case ((USB_TYPE_STANDARD|USB_RECIP_DEVICE) << 8)
1138 | USB_REQ_SET_FEATURE:
1139 if (w_value != USB_DEVICE_REMOTE_WAKEUP)
1141 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT);
1142 tmp |= AT91_UDP_ESR;
1143 at91_udp_write(udc, AT91_UDP_GLB_STAT, tmp);
1145 case ((USB_TYPE_STANDARD|USB_RECIP_DEVICE) << 8)
1146 | USB_REQ_CLEAR_FEATURE:
1147 if (w_value != USB_DEVICE_REMOTE_WAKEUP)
1149 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT);
1150 tmp &= ~AT91_UDP_ESR;
1151 at91_udp_write(udc, AT91_UDP_GLB_STAT, tmp);
1155 * Interfaces have no feature settings; this is pretty useless.
1156 * we won't even insist the interface exists...
1158 case ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE) << 8)
1159 | USB_REQ_GET_STATUS:
1160 PACKET("get interface status\n");
1161 __raw_writeb(0, dreg);
1162 __raw_writeb(0, dreg);
1164 /* then STATUS starts later, automatically */
1165 case ((USB_TYPE_STANDARD|USB_RECIP_INTERFACE) << 8)
1166 | USB_REQ_SET_FEATURE:
1167 case ((USB_TYPE_STANDARD|USB_RECIP_INTERFACE) << 8)
1168 | USB_REQ_CLEAR_FEATURE:
1172 * Hosts may clear bulk/intr endpoint halt after the gadget
1173 * driver sets it (not widely used); or set it (for testing)
1175 case ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT) << 8)
1176 | USB_REQ_GET_STATUS:
1177 tmp = w_index & USB_ENDPOINT_NUMBER_MASK;
1179 if (tmp >= NUM_ENDPOINTS || (tmp && !ep->ep.desc))
1183 if ((w_index & USB_DIR_IN)) {
1186 } else if (ep->is_in)
1189 PACKET("get %s status\n", ep->ep.name);
1190 if (__raw_readl(ep->creg) & AT91_UDP_FORCESTALL)
1191 tmp = (1 << USB_ENDPOINT_HALT);
1194 __raw_writeb(tmp, dreg);
1195 __raw_writeb(0, dreg);
1197 /* then STATUS starts later, automatically */
1198 case ((USB_TYPE_STANDARD|USB_RECIP_ENDPOINT) << 8)
1199 | USB_REQ_SET_FEATURE:
1200 tmp = w_index & USB_ENDPOINT_NUMBER_MASK;
1202 if (w_value != USB_ENDPOINT_HALT || tmp >= NUM_ENDPOINTS)
1204 if (!ep->ep.desc || ep->is_iso)
1206 if ((w_index & USB_DIR_IN)) {
1209 } else if (ep->is_in)
1212 tmp = __raw_readl(ep->creg);
1214 tmp |= CLR_FX | AT91_UDP_FORCESTALL;
1215 __raw_writel(tmp, ep->creg);
1217 case ((USB_TYPE_STANDARD|USB_RECIP_ENDPOINT) << 8)
1218 | USB_REQ_CLEAR_FEATURE:
1219 tmp = w_index & USB_ENDPOINT_NUMBER_MASK;
1221 if (w_value != USB_ENDPOINT_HALT || tmp >= NUM_ENDPOINTS)
1225 if (!ep->ep.desc || ep->is_iso)
1227 if ((w_index & USB_DIR_IN)) {
1230 } else if (ep->is_in)
1233 at91_udp_write(udc, AT91_UDP_RST_EP, ep->int_mask);
1234 at91_udp_write(udc, AT91_UDP_RST_EP, 0);
1235 tmp = __raw_readl(ep->creg);
1237 tmp &= ~(SET_FX | AT91_UDP_FORCESTALL);
1238 __raw_writel(tmp, ep->creg);
1239 if (!list_empty(&ep->queue))
1248 /* pass request up to the gadget driver */
1250 spin_unlock(&udc->lock);
1251 status = udc->driver->setup(&udc->gadget, &pkt.r);
1252 spin_lock(&udc->lock);
1258 VDBG("req %02x.%02x protocol STALL; stat %d\n",
1259 pkt.r.bRequestType, pkt.r.bRequest, status);
1260 csr |= AT91_UDP_FORCESTALL;
1261 __raw_writel(csr, creg);
1262 udc->req_pending = 0;
1267 /* immediate successful (IN) STATUS after zero length DATA */
1268 PACKET("ep0 in/status\n");
1270 csr |= AT91_UDP_TXPKTRDY;
1271 __raw_writel(csr, creg);
1272 udc->req_pending = 0;
1275 static void handle_ep0(struct at91_udc *udc)
1277 struct at91_ep *ep0 = &udc->ep[0];
1278 u32 __iomem *creg = ep0->creg;
1279 u32 csr = __raw_readl(creg);
1280 struct at91_request *req;
1282 if (unlikely(csr & AT91_UDP_STALLSENT)) {
1284 udc->req_pending = 0;
1286 csr &= ~(SET_FX | AT91_UDP_STALLSENT | AT91_UDP_FORCESTALL);
1287 __raw_writel(csr, creg);
1288 VDBG("ep0 stalled\n");
1289 csr = __raw_readl(creg);
1291 if (csr & AT91_UDP_RXSETUP) {
1293 udc->req_pending = 0;
1294 handle_setup(udc, ep0, csr);
1298 if (list_empty(&ep0->queue))
1301 req = list_entry(ep0->queue.next, struct at91_request, queue);
1303 /* host ACKed an IN packet that we sent */
1304 if (csr & AT91_UDP_TXCOMP) {
1306 csr &= ~(SET_FX | AT91_UDP_TXCOMP);
1308 /* write more IN DATA? */
1309 if (req && ep0->is_in) {
1311 udc->req_pending = 0;
1315 * - last IN DATA packet (including GET_STATUS)
1316 * - IN/STATUS for OUT DATA
1317 * - IN/STATUS for any zero-length DATA stage
1318 * except for the IN DATA case, the host should send
1319 * an OUT status later, which we'll ack.
1322 udc->req_pending = 0;
1323 __raw_writel(csr, creg);
1326 * SET_ADDRESS takes effect only after the STATUS
1327 * (to the original address) gets acked.
1329 if (udc->wait_for_addr_ack) {
1332 at91_udp_write(udc, AT91_UDP_FADDR,
1333 AT91_UDP_FEN | udc->addr);
1334 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT);
1335 tmp &= ~AT91_UDP_FADDEN;
1337 tmp |= AT91_UDP_FADDEN;
1338 at91_udp_write(udc, AT91_UDP_GLB_STAT, tmp);
1340 udc->wait_for_addr_ack = 0;
1341 VDBG("address %d\n", udc->addr);
1346 /* OUT packet arrived ... */
1347 else if (csr & AT91_UDP_RX_DATA_BK0) {
1349 csr &= ~(SET_FX | AT91_UDP_RX_DATA_BK0);
1351 /* OUT DATA stage */
1354 if (handle_ep(ep0)) {
1355 /* send IN/STATUS */
1356 PACKET("ep0 in/status\n");
1357 csr = __raw_readl(creg);
1359 csr |= CLR_FX | AT91_UDP_TXPKTRDY;
1360 __raw_writel(csr, creg);
1361 udc->req_pending = 0;
1363 } else if (udc->req_pending) {
1365 * AT91 hardware has a hard time with this
1366 * "deferred response" mode for control-OUT
1367 * transfers. (For control-IN it's fine.)
1369 * The normal solution leaves OUT data in the
1370 * fifo until the gadget driver is ready.
1371 * We couldn't do that here without disabling
1372 * the IRQ that tells about SETUP packets,
1373 * e.g. when the host gets impatient...
1375 * Working around it by copying into a buffer
1376 * would almost be a non-deferred response,
1377 * except that it wouldn't permit reliable
1378 * stalling of the request. Instead, demand
1379 * that gadget drivers not use this mode.
1381 DBG("no control-OUT deferred responses!\n");
1382 __raw_writel(csr | AT91_UDP_FORCESTALL, creg);
1383 udc->req_pending = 0;
1386 /* STATUS stage for control-IN; ack. */
1388 PACKET("ep0 out/status ACK\n");
1389 __raw_writel(csr, creg);
1391 /* "early" status stage */
1398 static irqreturn_t at91_udc_irq (int irq, void *_udc)
1400 struct at91_udc *udc = _udc;
1402 int disable_clock = 0;
1403 unsigned long flags;
1405 spin_lock_irqsave(&udc->lock, flags);
1407 if (!udc->clocked) {
1415 status = at91_udp_read(udc, AT91_UDP_ISR)
1416 & at91_udp_read(udc, AT91_UDP_IMR);
1420 /* USB reset irq: not maskable */
1421 if (status & AT91_UDP_ENDBUSRES) {
1422 at91_udp_write(udc, AT91_UDP_IDR, ~MINIMUS_INTERRUPTUS);
1423 at91_udp_write(udc, AT91_UDP_IER, MINIMUS_INTERRUPTUS);
1424 /* Atmel code clears this irq twice */
1425 at91_udp_write(udc, AT91_UDP_ICR, AT91_UDP_ENDBUSRES);
1426 at91_udp_write(udc, AT91_UDP_ICR, AT91_UDP_ENDBUSRES);
1427 VDBG("end bus reset\n");
1432 at91_udp_write(udc, AT91_UDP_CSR(0),
1433 AT91_UDP_EPEDS | AT91_UDP_EPTYPE_CTRL);
1434 udc->gadget.speed = USB_SPEED_FULL;
1436 at91_udp_write(udc, AT91_UDP_IER, AT91_UDP_EP(0));
1439 * NOTE: this driver keeps clocks off unless the
1440 * USB host is present. That saves power, but for
1441 * boards that don't support VBUS detection, both
1442 * clocks need to be active most of the time.
1445 /* host initiated suspend (3+ms bus idle) */
1446 } else if (status & AT91_UDP_RXSUSP) {
1447 at91_udp_write(udc, AT91_UDP_IDR, AT91_UDP_RXSUSP);
1448 at91_udp_write(udc, AT91_UDP_IER, AT91_UDP_RXRSM);
1449 at91_udp_write(udc, AT91_UDP_ICR, AT91_UDP_RXSUSP);
1450 /* VDBG("bus suspend\n"); */
1456 * NOTE: when suspending a VBUS-powered device, the
1457 * gadget driver should switch into slow clock mode
1458 * and then into standby to avoid drawing more than
1459 * 500uA power (2500uA for some high-power configs).
1461 if (udc->driver && udc->driver->suspend) {
1462 spin_unlock(&udc->lock);
1463 udc->driver->suspend(&udc->gadget);
1464 spin_lock(&udc->lock);
1467 /* host initiated resume */
1468 } else if (status & AT91_UDP_RXRSM) {
1469 at91_udp_write(udc, AT91_UDP_IDR, AT91_UDP_RXRSM);
1470 at91_udp_write(udc, AT91_UDP_IER, AT91_UDP_RXSUSP);
1471 at91_udp_write(udc, AT91_UDP_ICR, AT91_UDP_RXRSM);
1472 /* VDBG("bus resume\n"); */
1473 if (!udc->suspended)
1478 * NOTE: for a VBUS-powered device, the gadget driver
1479 * would normally want to switch out of slow clock
1480 * mode into normal mode.
1482 if (udc->driver && udc->driver->resume) {
1483 spin_unlock(&udc->lock);
1484 udc->driver->resume(&udc->gadget);
1485 spin_lock(&udc->lock);
1488 /* endpoint IRQs are cleared by handling them */
1492 struct at91_ep *ep = &udc->ep[1];
1496 for (i = 1; i < NUM_ENDPOINTS; i++) {
1508 spin_unlock_irqrestore(&udc->lock, flags);
1513 /*-------------------------------------------------------------------------*/
1515 static void nop_release(struct device *dev)
1517 /* nothing to free */
1520 static struct at91_udc controller = {
1522 .ops = &at91_udc_ops,
1523 .ep0 = &controller.ep[0].ep,
1524 .name = driver_name,
1526 .init_name = "gadget",
1527 .release = nop_release,
1533 .ops = &at91_ep_ops,
1542 .ops = &at91_ep_ops,
1552 .ops = &at91_ep_ops,
1561 /* could actually do bulk too */
1563 .ops = &at91_ep_ops,
1572 .ops = &at91_ep_ops,
1582 .ops = &at91_ep_ops,
1589 /* ep6 and ep7 are also reserved (custom silicon might use them) */
1592 static void at91_vbus_update(struct at91_udc *udc, unsigned value)
1594 value ^= udc->board.vbus_active_low;
1595 if (value != udc->vbus)
1596 at91_vbus_session(&udc->gadget, value);
1599 static irqreturn_t at91_vbus_irq(int irq, void *_udc)
1601 struct at91_udc *udc = _udc;
1603 /* vbus needs at least brief debouncing */
1605 at91_vbus_update(udc, gpio_get_value(udc->board.vbus_pin));
1610 static void at91_vbus_timer_work(struct work_struct *work)
1612 struct at91_udc *udc = container_of(work, struct at91_udc,
1615 at91_vbus_update(udc, gpio_get_value_cansleep(udc->board.vbus_pin));
1617 if (!timer_pending(&udc->vbus_timer))
1618 mod_timer(&udc->vbus_timer, jiffies + VBUS_POLL_TIMEOUT);
1621 static void at91_vbus_timer(unsigned long data)
1623 struct at91_udc *udc = (struct at91_udc *)data;
1626 * If we are polling vbus it is likely that the gpio is on an
1627 * bus such as i2c or spi which may sleep, so schedule some work
1628 * to read the vbus gpio
1630 schedule_work(&udc->vbus_timer_work);
1633 static int at91_start(struct usb_gadget *gadget,
1634 struct usb_gadget_driver *driver)
1636 struct at91_udc *udc;
1638 udc = container_of(gadget, struct at91_udc, gadget);
1639 udc->driver = driver;
1640 udc->gadget.dev.of_node = udc->pdev->dev.of_node;
1642 udc->selfpowered = 1;
1644 DBG("bound to %s\n", driver->driver.name);
1648 static int at91_stop(struct usb_gadget *gadget,
1649 struct usb_gadget_driver *driver)
1651 struct at91_udc *udc;
1652 unsigned long flags;
1654 udc = container_of(gadget, struct at91_udc, gadget);
1655 spin_lock_irqsave(&udc->lock, flags);
1657 at91_udp_write(udc, AT91_UDP_IDR, ~0);
1658 spin_unlock_irqrestore(&udc->lock, flags);
1662 DBG("unbound from %s\n", driver->driver.name);
1666 /*-------------------------------------------------------------------------*/
1668 static void at91udc_shutdown(struct platform_device *dev)
1670 struct at91_udc *udc = platform_get_drvdata(dev);
1671 unsigned long flags;
1673 /* force disconnect on reboot */
1674 spin_lock_irqsave(&udc->lock, flags);
1675 pullup(platform_get_drvdata(dev), 0);
1676 spin_unlock_irqrestore(&udc->lock, flags);
1679 static void at91udc_of_init(struct at91_udc *udc,
1680 struct device_node *np)
1682 struct at91_udc_data *board = &udc->board;
1684 enum of_gpio_flags flags;
1686 if (of_property_read_u32(np, "atmel,vbus-polled", &val) == 0)
1687 board->vbus_polled = 1;
1689 board->vbus_pin = of_get_named_gpio_flags(np, "atmel,vbus-gpio", 0,
1691 board->vbus_active_low = (flags & OF_GPIO_ACTIVE_LOW) ? 1 : 0;
1693 board->pullup_pin = of_get_named_gpio_flags(np, "atmel,pullup-gpio", 0,
1696 board->pullup_active_low = (flags & OF_GPIO_ACTIVE_LOW) ? 1 : 0;
1699 static int at91udc_probe(struct platform_device *pdev)
1701 struct device *dev = &pdev->dev;
1702 struct at91_udc *udc;
1704 struct resource *res;
1706 if (!dev_get_platdata(dev) && !pdev->dev.of_node) {
1707 /* small (so we copy it) but critical! */
1708 DBG("missing platform_data\n");
1712 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1716 if (!request_mem_region(res->start, resource_size(res), driver_name)) {
1717 DBG("someone's using UDC memory\n");
1721 /* init software state */
1723 udc->gadget.dev.parent = dev;
1724 if (IS_ENABLED(CONFIG_OF) && pdev->dev.of_node)
1725 at91udc_of_init(udc, pdev->dev.of_node);
1727 memcpy(&udc->board, dev_get_platdata(dev),
1728 sizeof(struct at91_udc_data));
1731 spin_lock_init(&udc->lock);
1733 /* rm9200 needs manual D+ pullup; off by default */
1734 if (cpu_is_at91rm9200()) {
1735 if (!gpio_is_valid(udc->board.pullup_pin)) {
1736 DBG("no D+ pullup?\n");
1740 retval = gpio_request(udc->board.pullup_pin, "udc_pullup");
1742 DBG("D+ pullup is busy\n");
1745 gpio_direction_output(udc->board.pullup_pin,
1746 udc->board.pullup_active_low);
1749 /* newer chips have more FIFO memory than rm9200 */
1750 if (cpu_is_at91sam9260() || cpu_is_at91sam9g20()) {
1751 udc->ep[0].maxpacket = 64;
1752 udc->ep[3].maxpacket = 64;
1753 udc->ep[4].maxpacket = 512;
1754 udc->ep[5].maxpacket = 512;
1755 } else if (cpu_is_at91sam9261() || cpu_is_at91sam9g10()) {
1756 udc->ep[3].maxpacket = 64;
1757 } else if (cpu_is_at91sam9263()) {
1758 udc->ep[0].maxpacket = 64;
1759 udc->ep[3].maxpacket = 64;
1762 udc->udp_baseaddr = ioremap(res->start, resource_size(res));
1763 if (!udc->udp_baseaddr) {
1770 /* get interface and function clocks */
1771 udc->iclk = clk_get(dev, "udc_clk");
1772 udc->fclk = clk_get(dev, "udpck");
1773 if (IS_ENABLED(CONFIG_COMMON_CLK))
1774 udc->uclk = clk_get(dev, "usb_clk");
1775 if (IS_ERR(udc->iclk) || IS_ERR(udc->fclk) ||
1776 (IS_ENABLED(CONFIG_COMMON_CLK) && IS_ERR(udc->uclk))) {
1777 DBG("clocks missing\n");
1782 /* don't do anything until we have both gadget driver and VBUS */
1783 retval = clk_prepare_enable(udc->iclk);
1786 at91_udp_write(udc, AT91_UDP_TXVC, AT91_UDP_TXVC_TXVDIS);
1787 at91_udp_write(udc, AT91_UDP_IDR, 0xffffffff);
1788 /* Clear all pending interrupts - UDP may be used by bootloader. */
1789 at91_udp_write(udc, AT91_UDP_ICR, 0xffffffff);
1790 clk_disable_unprepare(udc->iclk);
1792 /* request UDC and maybe VBUS irqs */
1793 udc->udp_irq = platform_get_irq(pdev, 0);
1794 retval = request_irq(udc->udp_irq, at91_udc_irq,
1795 0, driver_name, udc);
1797 DBG("request irq %d failed\n", udc->udp_irq);
1800 if (gpio_is_valid(udc->board.vbus_pin)) {
1801 retval = gpio_request(udc->board.vbus_pin, "udc_vbus");
1803 DBG("request vbus pin failed\n");
1806 gpio_direction_input(udc->board.vbus_pin);
1809 * Get the initial state of VBUS - we cannot expect
1810 * a pending interrupt.
1812 udc->vbus = gpio_get_value_cansleep(udc->board.vbus_pin) ^
1813 udc->board.vbus_active_low;
1815 if (udc->board.vbus_polled) {
1816 INIT_WORK(&udc->vbus_timer_work, at91_vbus_timer_work);
1817 setup_timer(&udc->vbus_timer, at91_vbus_timer,
1818 (unsigned long)udc);
1819 mod_timer(&udc->vbus_timer,
1820 jiffies + VBUS_POLL_TIMEOUT);
1822 if (request_irq(gpio_to_irq(udc->board.vbus_pin),
1823 at91_vbus_irq, 0, driver_name, udc)) {
1824 DBG("request vbus irq %d failed\n",
1825 udc->board.vbus_pin);
1831 DBG("no VBUS detection, assuming always-on\n");
1834 retval = usb_add_gadget_udc(dev, &udc->gadget);
1837 dev_set_drvdata(dev, udc);
1838 device_init_wakeup(dev, 1);
1839 create_debug_file(udc);
1841 INFO("%s version %s\n", driver_name, DRIVER_VERSION);
1844 if (gpio_is_valid(udc->board.vbus_pin) && !udc->board.vbus_polled)
1845 free_irq(gpio_to_irq(udc->board.vbus_pin), udc);
1847 if (gpio_is_valid(udc->board.vbus_pin))
1848 gpio_free(udc->board.vbus_pin);
1850 free_irq(udc->udp_irq, udc);
1852 if (IS_ENABLED(CONFIG_COMMON_CLK) && !IS_ERR(udc->uclk))
1854 if (!IS_ERR(udc->fclk))
1856 if (!IS_ERR(udc->iclk))
1858 iounmap(udc->udp_baseaddr);
1860 if (cpu_is_at91rm9200())
1861 gpio_free(udc->board.pullup_pin);
1863 release_mem_region(res->start, resource_size(res));
1864 DBG("%s probe failed, %d\n", driver_name, retval);
1868 static int __exit at91udc_remove(struct platform_device *pdev)
1870 struct at91_udc *udc = platform_get_drvdata(pdev);
1871 struct resource *res;
1872 unsigned long flags;
1876 usb_del_gadget_udc(&udc->gadget);
1880 spin_lock_irqsave(&udc->lock, flags);
1882 spin_unlock_irqrestore(&udc->lock, flags);
1884 device_init_wakeup(&pdev->dev, 0);
1885 remove_debug_file(udc);
1886 if (gpio_is_valid(udc->board.vbus_pin)) {
1887 free_irq(gpio_to_irq(udc->board.vbus_pin), udc);
1888 gpio_free(udc->board.vbus_pin);
1890 free_irq(udc->udp_irq, udc);
1891 iounmap(udc->udp_baseaddr);
1893 if (cpu_is_at91rm9200())
1894 gpio_free(udc->board.pullup_pin);
1896 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1897 release_mem_region(res->start, resource_size(res));
1901 if (IS_ENABLED(CONFIG_COMMON_CLK))
1908 static int at91udc_suspend(struct platform_device *pdev, pm_message_t mesg)
1910 struct at91_udc *udc = platform_get_drvdata(pdev);
1911 int wake = udc->driver && device_may_wakeup(&pdev->dev);
1912 unsigned long flags;
1914 /* Unless we can act normally to the host (letting it wake us up
1915 * whenever it has work for us) force disconnect. Wakeup requires
1916 * PLLB for USB events (signaling for reset, wakeup, or incoming
1917 * tokens) and VBUS irqs (on systems which support them).
1919 if ((!udc->suspended && udc->addr)
1921 || at91_suspend_entering_slow_clock()) {
1922 spin_lock_irqsave(&udc->lock, flags);
1925 spin_unlock_irqrestore(&udc->lock, flags);
1927 enable_irq_wake(udc->udp_irq);
1929 udc->active_suspend = wake;
1930 if (gpio_is_valid(udc->board.vbus_pin) && !udc->board.vbus_polled && wake)
1931 enable_irq_wake(udc->board.vbus_pin);
1935 static int at91udc_resume(struct platform_device *pdev)
1937 struct at91_udc *udc = platform_get_drvdata(pdev);
1938 unsigned long flags;
1940 if (gpio_is_valid(udc->board.vbus_pin) && !udc->board.vbus_polled &&
1941 udc->active_suspend)
1942 disable_irq_wake(udc->board.vbus_pin);
1944 /* maybe reconnect to host; if so, clocks on */
1945 if (udc->active_suspend)
1946 disable_irq_wake(udc->udp_irq);
1948 spin_lock_irqsave(&udc->lock, flags);
1950 spin_unlock_irqrestore(&udc->lock, flags);
1955 #define at91udc_suspend NULL
1956 #define at91udc_resume NULL
1959 #if defined(CONFIG_OF)
1960 static const struct of_device_id at91_udc_dt_ids[] = {
1961 { .compatible = "atmel,at91rm9200-udc" },
1965 MODULE_DEVICE_TABLE(of, at91_udc_dt_ids);
1968 static struct platform_driver at91_udc_driver = {
1969 .remove = __exit_p(at91udc_remove),
1970 .shutdown = at91udc_shutdown,
1971 .suspend = at91udc_suspend,
1972 .resume = at91udc_resume,
1974 .name = (char *) driver_name,
1975 .owner = THIS_MODULE,
1976 .of_match_table = of_match_ptr(at91_udc_dt_ids),
1980 module_platform_driver_probe(at91_udc_driver, at91udc_probe);
1982 MODULE_DESCRIPTION("AT91 udc driver");
1983 MODULE_AUTHOR("Thomas Rathbone, David Brownell");
1984 MODULE_LICENSE("GPL");
1985 MODULE_ALIAS("platform:at91_udc");