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 <asm/byteorder.h>
34 #include <mach/hardware.h>
39 #include <mach/board.h>
41 #include <mach/at91sam9261_matrix.h>
47 * This controller is simple and PIO-only. It's used in many AT91-series
48 * full speed USB controllers, including the at91rm9200 (arm920T, with MMU),
49 * at91sam926x (arm926ejs, with MMU), and several no-mmu versions.
51 * This driver expects the board has been wired with two GPIOs suppporting
52 * a VBUS sensing IRQ, and a D+ pullup. (They may be omitted, but the
53 * testing hasn't covered such cases.)
55 * The pullup is most important (so it's integrated on sam926x parts). It
56 * provides software control over whether the host enumerates the device.
58 * The VBUS sensing helps during enumeration, and allows both USB clocks
59 * (and the transceiver) to stay gated off until they're necessary, saving
60 * power. During USB suspend, the 48 MHz clock is gated off in hardware;
61 * it may also be gated off by software during some Linux sleep states.
64 #define DRIVER_VERSION "3 May 2006"
66 static const char driver_name [] = "at91_udc";
67 static const char ep0name[] = "ep0";
69 #define VBUS_POLL_TIMEOUT msecs_to_jiffies(1000)
71 #define at91_udp_read(udc, reg) \
72 __raw_readl((udc)->udp_baseaddr + (reg))
73 #define at91_udp_write(udc, reg, val) \
74 __raw_writel((val), (udc)->udp_baseaddr + (reg))
76 /*-------------------------------------------------------------------------*/
78 #ifdef CONFIG_USB_GADGET_DEBUG_FILES
80 #include <linux/seq_file.h>
82 static const char debug_filename[] = "driver/udc";
84 #define FOURBITS "%s%s%s%s"
85 #define EIGHTBITS FOURBITS FOURBITS
87 static void proc_ep_show(struct seq_file *s, struct at91_ep *ep)
89 static char *types[] = {
90 "control", "out-iso", "out-bulk", "out-int",
91 "BOGUS", "in-iso", "in-bulk", "in-int"};
94 struct at91_request *req;
96 struct at91_udc *udc = ep->udc;
98 spin_lock_irqsave(&udc->lock, flags);
100 csr = __raw_readl(ep->creg);
102 /* NOTE: not collecting per-endpoint irq statistics... */
105 seq_printf(s, "%s, maxpacket %d %s%s %s%s\n",
106 ep->ep.name, ep->ep.maxpacket,
107 ep->is_in ? "in" : "out",
108 ep->is_iso ? " iso" : "",
110 ? (ep->fifo_bank ? "pong" : "ping")
112 ep->stopped ? " stopped" : "");
113 seq_printf(s, "csr %08x rxbytes=%d %s %s %s" EIGHTBITS "\n",
115 (csr & 0x07ff0000) >> 16,
116 (csr & (1 << 15)) ? "enabled" : "disabled",
117 (csr & (1 << 11)) ? "DATA1" : "DATA0",
118 types[(csr & 0x700) >> 8],
120 /* iff type is control then print current direction */
122 ? ((csr & (1 << 7)) ? " IN" : " OUT")
124 (csr & (1 << 6)) ? " rxdatabk1" : "",
125 (csr & (1 << 5)) ? " forcestall" : "",
126 (csr & (1 << 4)) ? " txpktrdy" : "",
128 (csr & (1 << 3)) ? " stallsent" : "",
129 (csr & (1 << 2)) ? " rxsetup" : "",
130 (csr & (1 << 1)) ? " rxdatabk0" : "",
131 (csr & (1 << 0)) ? " txcomp" : "");
132 if (list_empty (&ep->queue))
133 seq_printf(s, "\t(queue empty)\n");
135 else list_for_each_entry (req, &ep->queue, queue) {
136 unsigned length = req->req.actual;
138 seq_printf(s, "\treq %p len %d/%d buf %p\n",
140 req->req.length, req->req.buf);
142 spin_unlock_irqrestore(&udc->lock, flags);
145 static void proc_irq_show(struct seq_file *s, const char *label, u32 mask)
149 seq_printf(s, "%s %04x:%s%s" FOURBITS, label, mask,
150 (mask & (1 << 13)) ? " wakeup" : "",
151 (mask & (1 << 12)) ? " endbusres" : "",
153 (mask & (1 << 11)) ? " sofint" : "",
154 (mask & (1 << 10)) ? " extrsm" : "",
155 (mask & (1 << 9)) ? " rxrsm" : "",
156 (mask & (1 << 8)) ? " rxsusp" : "");
157 for (i = 0; i < 8; i++) {
159 seq_printf(s, " ep%d", i);
164 static int proc_udc_show(struct seq_file *s, void *unused)
166 struct at91_udc *udc = s->private;
170 seq_printf(s, "%s: version %s\n", driver_name, DRIVER_VERSION);
172 seq_printf(s, "vbus %s, pullup %s, %s powered%s, gadget %s\n\n",
173 udc->vbus ? "present" : "off",
175 ? (udc->vbus ? "active" : "enabled")
177 udc->selfpowered ? "self" : "VBUS",
178 udc->suspended ? ", suspended" : "",
179 udc->driver ? udc->driver->driver.name : "(none)");
181 /* don't access registers when interface isn't clocked */
183 seq_printf(s, "(not clocked)\n");
187 tmp = at91_udp_read(udc, AT91_UDP_FRM_NUM);
188 seq_printf(s, "frame %05x:%s%s frame=%d\n", tmp,
189 (tmp & AT91_UDP_FRM_OK) ? " ok" : "",
190 (tmp & AT91_UDP_FRM_ERR) ? " err" : "",
191 (tmp & AT91_UDP_NUM));
193 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT);
194 seq_printf(s, "glbstate %02x:%s" FOURBITS "\n", tmp,
195 (tmp & AT91_UDP_RMWUPE) ? " rmwupe" : "",
196 (tmp & AT91_UDP_RSMINPR) ? " rsminpr" : "",
197 (tmp & AT91_UDP_ESR) ? " esr" : "",
198 (tmp & AT91_UDP_CONFG) ? " confg" : "",
199 (tmp & AT91_UDP_FADDEN) ? " fadden" : "");
201 tmp = at91_udp_read(udc, AT91_UDP_FADDR);
202 seq_printf(s, "faddr %03x:%s fadd=%d\n", tmp,
203 (tmp & AT91_UDP_FEN) ? " fen" : "",
204 (tmp & AT91_UDP_FADD));
206 proc_irq_show(s, "imr ", at91_udp_read(udc, AT91_UDP_IMR));
207 proc_irq_show(s, "isr ", at91_udp_read(udc, AT91_UDP_ISR));
209 if (udc->enabled && udc->vbus) {
210 proc_ep_show(s, &udc->ep[0]);
211 list_for_each_entry (ep, &udc->gadget.ep_list, ep.ep_list) {
219 static int proc_udc_open(struct inode *inode, struct file *file)
221 return single_open(file, proc_udc_show, PDE(inode)->data);
224 static const struct file_operations proc_ops = {
225 .owner = THIS_MODULE,
226 .open = proc_udc_open,
229 .release = single_release,
232 static void create_debug_file(struct at91_udc *udc)
234 udc->pde = proc_create_data(debug_filename, 0, NULL, &proc_ops, udc);
237 static void remove_debug_file(struct at91_udc *udc)
240 remove_proc_entry(debug_filename, NULL);
245 static inline void create_debug_file(struct at91_udc *udc) {}
246 static inline void remove_debug_file(struct at91_udc *udc) {}
251 /*-------------------------------------------------------------------------*/
253 static void done(struct at91_ep *ep, struct at91_request *req, int status)
255 unsigned stopped = ep->stopped;
256 struct at91_udc *udc = ep->udc;
258 list_del_init(&req->queue);
259 if (req->req.status == -EINPROGRESS)
260 req->req.status = status;
262 status = req->req.status;
263 if (status && status != -ESHUTDOWN)
264 VDBG("%s done %p, status %d\n", ep->ep.name, req, status);
267 spin_unlock(&udc->lock);
268 req->req.complete(&ep->ep, &req->req);
269 spin_lock(&udc->lock);
270 ep->stopped = stopped;
272 /* ep0 is always ready; other endpoints need a non-empty queue */
273 if (list_empty(&ep->queue) && ep->int_mask != (1 << 0))
274 at91_udp_write(udc, AT91_UDP_IDR, ep->int_mask);
277 /*-------------------------------------------------------------------------*/
279 /* bits indicating OUT fifo has data ready */
280 #define RX_DATA_READY (AT91_UDP_RX_DATA_BK0 | AT91_UDP_RX_DATA_BK1)
283 * Endpoint FIFO CSR bits have a mix of bits, making it unsafe to just write
284 * back most of the value you just read (because of side effects, including
285 * bits that may change after reading and before writing).
287 * Except when changing a specific bit, always write values which:
288 * - clear SET_FX bits (setting them could change something)
289 * - set CLR_FX bits (clearing them could change something)
291 * There are also state bits like FORCESTALL, EPEDS, DIR, and EPTYPE
292 * that shouldn't normally be changed.
294 * NOTE at91sam9260 docs mention synch between UDPCK and MCK clock domains,
295 * implying a need to wait for one write to complete (test relevant bits)
296 * before starting the next write. This shouldn't be an issue given how
297 * infrequently we write, except maybe for write-then-read idioms.
299 #define SET_FX (AT91_UDP_TXPKTRDY)
300 #define CLR_FX (RX_DATA_READY | AT91_UDP_RXSETUP \
301 | AT91_UDP_STALLSENT | AT91_UDP_TXCOMP)
303 /* pull OUT packet data from the endpoint's fifo */
304 static int read_fifo (struct at91_ep *ep, struct at91_request *req)
306 u32 __iomem *creg = ep->creg;
307 u8 __iomem *dreg = ep->creg + (AT91_UDP_FDR(0) - AT91_UDP_CSR(0));
310 unsigned int count, bufferspace, is_done;
312 buf = req->req.buf + req->req.actual;
313 bufferspace = req->req.length - req->req.actual;
316 * there might be nothing to read if ep_queue() calls us,
317 * or if we already emptied both pingpong buffers
320 csr = __raw_readl(creg);
321 if ((csr & RX_DATA_READY) == 0)
324 count = (csr & AT91_UDP_RXBYTECNT) >> 16;
325 if (count > ep->ep.maxpacket)
326 count = ep->ep.maxpacket;
327 if (count > bufferspace) {
328 DBG("%s buffer overflow\n", ep->ep.name);
329 req->req.status = -EOVERFLOW;
332 __raw_readsb(dreg, buf, count);
334 /* release and swap pingpong mem bank */
336 if (ep->is_pingpong) {
337 if (ep->fifo_bank == 0) {
338 csr &= ~(SET_FX | AT91_UDP_RX_DATA_BK0);
341 csr &= ~(SET_FX | AT91_UDP_RX_DATA_BK1);
345 csr &= ~(SET_FX | AT91_UDP_RX_DATA_BK0);
346 __raw_writel(csr, creg);
348 req->req.actual += count;
349 is_done = (count < ep->ep.maxpacket);
350 if (count == bufferspace)
353 PACKET("%s %p out/%d%s\n", ep->ep.name, &req->req, count,
354 is_done ? " (done)" : "");
357 * avoid extra trips through IRQ logic for packets already in
358 * the fifo ... maybe preventing an extra (expensive) OUT-NAK
362 else if (ep->is_pingpong) {
364 * One dummy read to delay the code because of a HW glitch:
365 * CSR returns bad RXCOUNT when read too soon after updating
368 csr = __raw_readl(creg);
370 bufferspace -= count;
378 /* load fifo for an IN packet */
379 static int write_fifo(struct at91_ep *ep, struct at91_request *req)
381 u32 __iomem *creg = ep->creg;
382 u32 csr = __raw_readl(creg);
383 u8 __iomem *dreg = ep->creg + (AT91_UDP_FDR(0) - AT91_UDP_CSR(0));
384 unsigned total, count, is_last;
388 * TODO: allow for writing two packets to the fifo ... that'll
389 * reduce the amount of IN-NAKing, but probably won't affect
390 * throughput much. (Unlike preventing OUT-NAKing!)
394 * If ep_queue() calls us, the queue is empty and possibly in
395 * odd states like TXCOMP not yet cleared (we do it, saving at
396 * least one IRQ) or the fifo not yet being free. Those aren't
397 * issues normally (IRQ handler fast path).
399 if (unlikely(csr & (AT91_UDP_TXCOMP | AT91_UDP_TXPKTRDY))) {
400 if (csr & AT91_UDP_TXCOMP) {
402 csr &= ~(SET_FX | AT91_UDP_TXCOMP);
403 __raw_writel(csr, creg);
404 csr = __raw_readl(creg);
406 if (csr & AT91_UDP_TXPKTRDY)
410 buf = req->req.buf + req->req.actual;
412 total = req->req.length - req->req.actual;
413 if (ep->ep.maxpacket < total) {
414 count = ep->ep.maxpacket;
418 is_last = (count < ep->ep.maxpacket) || !req->req.zero;
422 * Write the packet, maybe it's a ZLP.
424 * NOTE: incrementing req->actual before we receive the ACK means
425 * gadget driver IN bytecounts can be wrong in fault cases. That's
426 * fixable with PIO drivers like this one (save "count" here, and
427 * do the increment later on TX irq), but not for most DMA hardware.
429 * So all gadget drivers must accept that potential error. Some
430 * hardware supports precise fifo status reporting, letting them
431 * recover when the actual bytecount matters (e.g. for USB Test
432 * and Measurement Class devices).
434 __raw_writesb(dreg, buf, count);
436 csr |= CLR_FX | AT91_UDP_TXPKTRDY;
437 __raw_writel(csr, creg);
438 req->req.actual += count;
440 PACKET("%s %p in/%d%s\n", ep->ep.name, &req->req, count,
441 is_last ? " (done)" : "");
447 static void nuke(struct at91_ep *ep, int status)
449 struct at91_request *req;
451 /* terminate any request in the queue */
453 if (list_empty(&ep->queue))
456 VDBG("%s %s\n", __func__, ep->ep.name);
457 while (!list_empty(&ep->queue)) {
458 req = list_entry(ep->queue.next, struct at91_request, queue);
459 done(ep, req, status);
463 /*-------------------------------------------------------------------------*/
465 static int at91_ep_enable(struct usb_ep *_ep,
466 const struct usb_endpoint_descriptor *desc)
468 struct at91_ep *ep = container_of(_ep, struct at91_ep, ep);
469 struct at91_udc *udc = ep->udc;
476 || _ep->name == ep0name
477 || desc->bDescriptorType != USB_DT_ENDPOINT
478 || (maxpacket = usb_endpoint_maxp(desc)) == 0
479 || maxpacket > ep->maxpacket) {
480 DBG("bad ep or descriptor\n");
484 if (!udc->driver || udc->gadget.speed == USB_SPEED_UNKNOWN) {
485 DBG("bogus device state\n");
489 tmp = usb_endpoint_type(desc);
491 case USB_ENDPOINT_XFER_CONTROL:
492 DBG("only one control endpoint\n");
494 case USB_ENDPOINT_XFER_INT:
498 case USB_ENDPOINT_XFER_BULK:
507 DBG("bogus maxpacket %d\n", maxpacket);
509 case USB_ENDPOINT_XFER_ISOC:
510 if (!ep->is_pingpong) {
511 DBG("iso requires double buffering\n");
518 spin_lock_irqsave(&udc->lock, flags);
520 /* initialize endpoint to match this descriptor */
521 ep->is_in = usb_endpoint_dir_in(desc);
522 ep->is_iso = (tmp == USB_ENDPOINT_XFER_ISOC);
527 tmp |= AT91_UDP_EPEDS;
528 __raw_writel(tmp, ep->creg);
531 ep->ep.maxpacket = maxpacket;
534 * reset/init endpoint fifo. NOTE: leaves fifo_bank alone,
535 * since endpoint resets don't reset hw pingpong state.
537 at91_udp_write(udc, AT91_UDP_RST_EP, ep->int_mask);
538 at91_udp_write(udc, AT91_UDP_RST_EP, 0);
540 spin_unlock_irqrestore(&udc->lock, flags);
544 static int at91_ep_disable (struct usb_ep * _ep)
546 struct at91_ep *ep = container_of(_ep, struct at91_ep, ep);
547 struct at91_udc *udc = ep->udc;
550 if (ep == &ep->udc->ep[0])
553 spin_lock_irqsave(&udc->lock, flags);
555 nuke(ep, -ESHUTDOWN);
557 /* 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->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 ep->ep.maxpacket = 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)
872 clk_enable(udc->iclk);
873 clk_enable(udc->fclk);
876 static void clk_off(struct at91_udc *udc)
881 udc->gadget.speed = USB_SPEED_UNKNOWN;
882 clk_disable(udc->fclk);
883 clk_disable(udc->iclk);
887 * activate/deactivate link with host; minimize power usage for
888 * inactive links by cutting clocks and transceiver power.
890 static void pullup(struct at91_udc *udc, int is_on)
892 int active = !udc->board.pullup_active_low;
894 if (!udc->enabled || !udc->vbus)
896 DBG("%sactive\n", is_on ? "" : "in");
900 at91_udp_write(udc, AT91_UDP_ICR, AT91_UDP_RXRSM);
901 at91_udp_write(udc, AT91_UDP_TXVC, 0);
902 if (cpu_is_at91rm9200())
903 gpio_set_value(udc->board.pullup_pin, active);
904 else if (cpu_is_at91sam9260() || cpu_is_at91sam9263() || cpu_is_at91sam9g20()) {
905 u32 txvc = at91_udp_read(udc, AT91_UDP_TXVC);
907 txvc |= AT91_UDP_TXVC_PUON;
908 at91_udp_write(udc, AT91_UDP_TXVC, txvc);
909 } else if (cpu_is_at91sam9261() || cpu_is_at91sam9g10()) {
912 usbpucr = at91_sys_read(AT91_MATRIX_USBPUCR);
913 usbpucr |= AT91_MATRIX_USBPUCR_PUON;
914 at91_sys_write(AT91_MATRIX_USBPUCR, usbpucr);
918 at91_udp_write(udc, AT91_UDP_IDR, AT91_UDP_RXRSM);
919 at91_udp_write(udc, AT91_UDP_TXVC, AT91_UDP_TXVC_TXVDIS);
920 if (cpu_is_at91rm9200())
921 gpio_set_value(udc->board.pullup_pin, !active);
922 else if (cpu_is_at91sam9260() || cpu_is_at91sam9263() || cpu_is_at91sam9g20()) {
923 u32 txvc = at91_udp_read(udc, AT91_UDP_TXVC);
925 txvc &= ~AT91_UDP_TXVC_PUON;
926 at91_udp_write(udc, AT91_UDP_TXVC, txvc);
927 } else if (cpu_is_at91sam9261() || cpu_is_at91sam9g10()) {
930 usbpucr = at91_sys_read(AT91_MATRIX_USBPUCR);
931 usbpucr &= ~AT91_MATRIX_USBPUCR_PUON;
932 at91_sys_write(AT91_MATRIX_USBPUCR, usbpucr);
938 /* vbus is here! turn everything on that's ready */
939 static int at91_vbus_session(struct usb_gadget *gadget, int is_active)
941 struct at91_udc *udc = to_udc(gadget);
944 /* VDBG("vbus %s\n", is_active ? "on" : "off"); */
945 spin_lock_irqsave(&udc->lock, flags);
946 udc->vbus = (is_active != 0);
948 pullup(udc, is_active);
951 spin_unlock_irqrestore(&udc->lock, flags);
955 static int at91_pullup(struct usb_gadget *gadget, int is_on)
957 struct at91_udc *udc = to_udc(gadget);
960 spin_lock_irqsave(&udc->lock, flags);
961 udc->enabled = is_on = !!is_on;
963 spin_unlock_irqrestore(&udc->lock, flags);
967 static int at91_set_selfpowered(struct usb_gadget *gadget, int is_on)
969 struct at91_udc *udc = to_udc(gadget);
972 spin_lock_irqsave(&udc->lock, flags);
973 udc->selfpowered = (is_on != 0);
974 spin_unlock_irqrestore(&udc->lock, flags);
978 static int at91_start(struct usb_gadget_driver *driver,
979 int (*bind)(struct usb_gadget *));
980 static int at91_stop(struct usb_gadget_driver *driver);
982 static const struct usb_gadget_ops at91_udc_ops = {
983 .get_frame = at91_get_frame,
984 .wakeup = at91_wakeup,
985 .set_selfpowered = at91_set_selfpowered,
986 .vbus_session = at91_vbus_session,
987 .pullup = at91_pullup,
992 * VBUS-powered devices may also also want to support bigger
993 * power budgets after an appropriate SET_CONFIGURATION.
995 /* .vbus_power = at91_vbus_power, */
998 /*-------------------------------------------------------------------------*/
1000 static int handle_ep(struct at91_ep *ep)
1002 struct at91_request *req;
1003 u32 __iomem *creg = ep->creg;
1004 u32 csr = __raw_readl(creg);
1006 if (!list_empty(&ep->queue))
1007 req = list_entry(ep->queue.next,
1008 struct at91_request, queue);
1013 if (csr & (AT91_UDP_STALLSENT | AT91_UDP_TXCOMP)) {
1015 csr &= ~(SET_FX | AT91_UDP_STALLSENT | AT91_UDP_TXCOMP);
1016 __raw_writel(csr, creg);
1019 return write_fifo(ep, req);
1022 if (csr & AT91_UDP_STALLSENT) {
1023 /* STALLSENT bit == ISOERR */
1024 if (ep->is_iso && req)
1025 req->req.status = -EILSEQ;
1027 csr &= ~(SET_FX | AT91_UDP_STALLSENT);
1028 __raw_writel(csr, creg);
1029 csr = __raw_readl(creg);
1031 if (req && (csr & RX_DATA_READY))
1032 return read_fifo(ep, req);
1039 struct usb_ctrlrequest r;
1042 static void handle_setup(struct at91_udc *udc, struct at91_ep *ep, u32 csr)
1044 u32 __iomem *creg = ep->creg;
1045 u8 __iomem *dreg = ep->creg + (AT91_UDP_FDR(0) - AT91_UDP_CSR(0));
1046 unsigned rxcount, i = 0;
1051 /* read and ack SETUP; hard-fail for bogus packets */
1052 rxcount = (csr & AT91_UDP_RXBYTECNT) >> 16;
1053 if (likely(rxcount == 8)) {
1055 pkt.raw[i++] = __raw_readb(dreg);
1056 if (pkt.r.bRequestType & USB_DIR_IN) {
1057 csr |= AT91_UDP_DIR;
1060 csr &= ~AT91_UDP_DIR;
1064 /* REVISIT this happens sometimes under load; why?? */
1065 ERR("SETUP len %d, csr %08x\n", rxcount, csr);
1069 csr &= ~(SET_FX | AT91_UDP_RXSETUP);
1070 __raw_writel(csr, creg);
1071 udc->wait_for_addr_ack = 0;
1072 udc->wait_for_config_ack = 0;
1074 if (unlikely(status != 0))
1077 #define w_index le16_to_cpu(pkt.r.wIndex)
1078 #define w_value le16_to_cpu(pkt.r.wValue)
1079 #define w_length le16_to_cpu(pkt.r.wLength)
1081 VDBG("SETUP %02x.%02x v%04x i%04x l%04x\n",
1082 pkt.r.bRequestType, pkt.r.bRequest,
1083 w_value, w_index, w_length);
1086 * A few standard requests get handled here, ones that touch
1087 * hardware ... notably for device and endpoint features.
1089 udc->req_pending = 1;
1090 csr = __raw_readl(creg);
1093 switch ((pkt.r.bRequestType << 8) | pkt.r.bRequest) {
1095 case ((USB_TYPE_STANDARD|USB_RECIP_DEVICE) << 8)
1096 | USB_REQ_SET_ADDRESS:
1097 __raw_writel(csr | AT91_UDP_TXPKTRDY, creg);
1098 udc->addr = w_value;
1099 udc->wait_for_addr_ack = 1;
1100 udc->req_pending = 0;
1101 /* FADDR is set later, when we ack host STATUS */
1104 case ((USB_TYPE_STANDARD|USB_RECIP_DEVICE) << 8)
1105 | USB_REQ_SET_CONFIGURATION:
1106 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT) & AT91_UDP_CONFG;
1108 udc->wait_for_config_ack = (tmp == 0);
1110 udc->wait_for_config_ack = (tmp != 0);
1111 if (udc->wait_for_config_ack)
1112 VDBG("wait for config\n");
1113 /* CONFG is toggled later, if gadget driver succeeds */
1117 * Hosts may set or clear remote wakeup status, and
1118 * devices may report they're VBUS powered.
1120 case ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE) << 8)
1121 | USB_REQ_GET_STATUS:
1122 tmp = (udc->selfpowered << USB_DEVICE_SELF_POWERED);
1123 if (at91_udp_read(udc, AT91_UDP_GLB_STAT) & AT91_UDP_ESR)
1124 tmp |= (1 << USB_DEVICE_REMOTE_WAKEUP);
1125 PACKET("get device status\n");
1126 __raw_writeb(tmp, dreg);
1127 __raw_writeb(0, dreg);
1129 /* then STATUS starts later, automatically */
1130 case ((USB_TYPE_STANDARD|USB_RECIP_DEVICE) << 8)
1131 | USB_REQ_SET_FEATURE:
1132 if (w_value != USB_DEVICE_REMOTE_WAKEUP)
1134 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT);
1135 tmp |= AT91_UDP_ESR;
1136 at91_udp_write(udc, AT91_UDP_GLB_STAT, tmp);
1138 case ((USB_TYPE_STANDARD|USB_RECIP_DEVICE) << 8)
1139 | USB_REQ_CLEAR_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);
1148 * Interfaces have no feature settings; this is pretty useless.
1149 * we won't even insist the interface exists...
1151 case ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE) << 8)
1152 | USB_REQ_GET_STATUS:
1153 PACKET("get interface status\n");
1154 __raw_writeb(0, dreg);
1155 __raw_writeb(0, dreg);
1157 /* then STATUS starts later, automatically */
1158 case ((USB_TYPE_STANDARD|USB_RECIP_INTERFACE) << 8)
1159 | USB_REQ_SET_FEATURE:
1160 case ((USB_TYPE_STANDARD|USB_RECIP_INTERFACE) << 8)
1161 | USB_REQ_CLEAR_FEATURE:
1165 * Hosts may clear bulk/intr endpoint halt after the gadget
1166 * driver sets it (not widely used); or set it (for testing)
1168 case ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT) << 8)
1169 | USB_REQ_GET_STATUS:
1170 tmp = w_index & USB_ENDPOINT_NUMBER_MASK;
1172 if (tmp >= NUM_ENDPOINTS || (tmp && !ep->desc))
1176 if ((w_index & USB_DIR_IN)) {
1179 } else if (ep->is_in)
1182 PACKET("get %s status\n", ep->ep.name);
1183 if (__raw_readl(ep->creg) & AT91_UDP_FORCESTALL)
1184 tmp = (1 << USB_ENDPOINT_HALT);
1187 __raw_writeb(tmp, dreg);
1188 __raw_writeb(0, dreg);
1190 /* then STATUS starts later, automatically */
1191 case ((USB_TYPE_STANDARD|USB_RECIP_ENDPOINT) << 8)
1192 | USB_REQ_SET_FEATURE:
1193 tmp = w_index & USB_ENDPOINT_NUMBER_MASK;
1195 if (w_value != USB_ENDPOINT_HALT || tmp >= NUM_ENDPOINTS)
1197 if (!ep->desc || ep->is_iso)
1199 if ((w_index & USB_DIR_IN)) {
1202 } else if (ep->is_in)
1205 tmp = __raw_readl(ep->creg);
1207 tmp |= CLR_FX | AT91_UDP_FORCESTALL;
1208 __raw_writel(tmp, ep->creg);
1210 case ((USB_TYPE_STANDARD|USB_RECIP_ENDPOINT) << 8)
1211 | USB_REQ_CLEAR_FEATURE:
1212 tmp = w_index & USB_ENDPOINT_NUMBER_MASK;
1214 if (w_value != USB_ENDPOINT_HALT || tmp >= NUM_ENDPOINTS)
1218 if (!ep->desc || ep->is_iso)
1220 if ((w_index & USB_DIR_IN)) {
1223 } else if (ep->is_in)
1226 at91_udp_write(udc, AT91_UDP_RST_EP, ep->int_mask);
1227 at91_udp_write(udc, AT91_UDP_RST_EP, 0);
1228 tmp = __raw_readl(ep->creg);
1230 tmp &= ~(SET_FX | AT91_UDP_FORCESTALL);
1231 __raw_writel(tmp, ep->creg);
1232 if (!list_empty(&ep->queue))
1241 /* pass request up to the gadget driver */
1243 spin_unlock(&udc->lock);
1244 status = udc->driver->setup(&udc->gadget, &pkt.r);
1245 spin_lock(&udc->lock);
1251 VDBG("req %02x.%02x protocol STALL; stat %d\n",
1252 pkt.r.bRequestType, pkt.r.bRequest, status);
1253 csr |= AT91_UDP_FORCESTALL;
1254 __raw_writel(csr, creg);
1255 udc->req_pending = 0;
1260 /* immediate successful (IN) STATUS after zero length DATA */
1261 PACKET("ep0 in/status\n");
1263 csr |= AT91_UDP_TXPKTRDY;
1264 __raw_writel(csr, creg);
1265 udc->req_pending = 0;
1268 static void handle_ep0(struct at91_udc *udc)
1270 struct at91_ep *ep0 = &udc->ep[0];
1271 u32 __iomem *creg = ep0->creg;
1272 u32 csr = __raw_readl(creg);
1273 struct at91_request *req;
1275 if (unlikely(csr & AT91_UDP_STALLSENT)) {
1277 udc->req_pending = 0;
1279 csr &= ~(SET_FX | AT91_UDP_STALLSENT | AT91_UDP_FORCESTALL);
1280 __raw_writel(csr, creg);
1281 VDBG("ep0 stalled\n");
1282 csr = __raw_readl(creg);
1284 if (csr & AT91_UDP_RXSETUP) {
1286 udc->req_pending = 0;
1287 handle_setup(udc, ep0, csr);
1291 if (list_empty(&ep0->queue))
1294 req = list_entry(ep0->queue.next, struct at91_request, queue);
1296 /* host ACKed an IN packet that we sent */
1297 if (csr & AT91_UDP_TXCOMP) {
1299 csr &= ~(SET_FX | AT91_UDP_TXCOMP);
1301 /* write more IN DATA? */
1302 if (req && ep0->is_in) {
1304 udc->req_pending = 0;
1308 * - last IN DATA packet (including GET_STATUS)
1309 * - IN/STATUS for OUT DATA
1310 * - IN/STATUS for any zero-length DATA stage
1311 * except for the IN DATA case, the host should send
1312 * an OUT status later, which we'll ack.
1315 udc->req_pending = 0;
1316 __raw_writel(csr, creg);
1319 * SET_ADDRESS takes effect only after the STATUS
1320 * (to the original address) gets acked.
1322 if (udc->wait_for_addr_ack) {
1325 at91_udp_write(udc, AT91_UDP_FADDR,
1326 AT91_UDP_FEN | udc->addr);
1327 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT);
1328 tmp &= ~AT91_UDP_FADDEN;
1330 tmp |= AT91_UDP_FADDEN;
1331 at91_udp_write(udc, AT91_UDP_GLB_STAT, tmp);
1333 udc->wait_for_addr_ack = 0;
1334 VDBG("address %d\n", udc->addr);
1339 /* OUT packet arrived ... */
1340 else if (csr & AT91_UDP_RX_DATA_BK0) {
1342 csr &= ~(SET_FX | AT91_UDP_RX_DATA_BK0);
1344 /* OUT DATA stage */
1347 if (handle_ep(ep0)) {
1348 /* send IN/STATUS */
1349 PACKET("ep0 in/status\n");
1350 csr = __raw_readl(creg);
1352 csr |= CLR_FX | AT91_UDP_TXPKTRDY;
1353 __raw_writel(csr, creg);
1354 udc->req_pending = 0;
1356 } else if (udc->req_pending) {
1358 * AT91 hardware has a hard time with this
1359 * "deferred response" mode for control-OUT
1360 * transfers. (For control-IN it's fine.)
1362 * The normal solution leaves OUT data in the
1363 * fifo until the gadget driver is ready.
1364 * We couldn't do that here without disabling
1365 * the IRQ that tells about SETUP packets,
1366 * e.g. when the host gets impatient...
1368 * Working around it by copying into a buffer
1369 * would almost be a non-deferred response,
1370 * except that it wouldn't permit reliable
1371 * stalling of the request. Instead, demand
1372 * that gadget drivers not use this mode.
1374 DBG("no control-OUT deferred responses!\n");
1375 __raw_writel(csr | AT91_UDP_FORCESTALL, creg);
1376 udc->req_pending = 0;
1379 /* STATUS stage for control-IN; ack. */
1381 PACKET("ep0 out/status ACK\n");
1382 __raw_writel(csr, creg);
1384 /* "early" status stage */
1391 static irqreturn_t at91_udc_irq (int irq, void *_udc)
1393 struct at91_udc *udc = _udc;
1395 int disable_clock = 0;
1396 unsigned long flags;
1398 spin_lock_irqsave(&udc->lock, flags);
1400 if (!udc->clocked) {
1408 status = at91_udp_read(udc, AT91_UDP_ISR)
1409 & at91_udp_read(udc, AT91_UDP_IMR);
1413 /* USB reset irq: not maskable */
1414 if (status & AT91_UDP_ENDBUSRES) {
1415 at91_udp_write(udc, AT91_UDP_IDR, ~MINIMUS_INTERRUPTUS);
1416 at91_udp_write(udc, AT91_UDP_IER, MINIMUS_INTERRUPTUS);
1417 /* Atmel code clears this irq twice */
1418 at91_udp_write(udc, AT91_UDP_ICR, AT91_UDP_ENDBUSRES);
1419 at91_udp_write(udc, AT91_UDP_ICR, AT91_UDP_ENDBUSRES);
1420 VDBG("end bus reset\n");
1425 at91_udp_write(udc, AT91_UDP_CSR(0),
1426 AT91_UDP_EPEDS | AT91_UDP_EPTYPE_CTRL);
1427 udc->gadget.speed = USB_SPEED_FULL;
1429 at91_udp_write(udc, AT91_UDP_IER, AT91_UDP_EP(0));
1432 * NOTE: this driver keeps clocks off unless the
1433 * USB host is present. That saves power, but for
1434 * boards that don't support VBUS detection, both
1435 * clocks need to be active most of the time.
1438 /* host initiated suspend (3+ms bus idle) */
1439 } else if (status & AT91_UDP_RXSUSP) {
1440 at91_udp_write(udc, AT91_UDP_IDR, AT91_UDP_RXSUSP);
1441 at91_udp_write(udc, AT91_UDP_IER, AT91_UDP_RXRSM);
1442 at91_udp_write(udc, AT91_UDP_ICR, AT91_UDP_RXSUSP);
1443 /* VDBG("bus suspend\n"); */
1449 * NOTE: when suspending a VBUS-powered device, the
1450 * gadget driver should switch into slow clock mode
1451 * and then into standby to avoid drawing more than
1452 * 500uA power (2500uA for some high-power configs).
1454 if (udc->driver && udc->driver->suspend) {
1455 spin_unlock(&udc->lock);
1456 udc->driver->suspend(&udc->gadget);
1457 spin_lock(&udc->lock);
1460 /* host initiated resume */
1461 } else if (status & AT91_UDP_RXRSM) {
1462 at91_udp_write(udc, AT91_UDP_IDR, AT91_UDP_RXRSM);
1463 at91_udp_write(udc, AT91_UDP_IER, AT91_UDP_RXSUSP);
1464 at91_udp_write(udc, AT91_UDP_ICR, AT91_UDP_RXRSM);
1465 /* VDBG("bus resume\n"); */
1466 if (!udc->suspended)
1471 * NOTE: for a VBUS-powered device, the gadget driver
1472 * would normally want to switch out of slow clock
1473 * mode into normal mode.
1475 if (udc->driver && udc->driver->resume) {
1476 spin_unlock(&udc->lock);
1477 udc->driver->resume(&udc->gadget);
1478 spin_lock(&udc->lock);
1481 /* endpoint IRQs are cleared by handling them */
1485 struct at91_ep *ep = &udc->ep[1];
1489 for (i = 1; i < NUM_ENDPOINTS; i++) {
1501 spin_unlock_irqrestore(&udc->lock, flags);
1506 /*-------------------------------------------------------------------------*/
1508 static void nop_release(struct device *dev)
1510 /* nothing to free */
1513 static struct at91_udc controller = {
1515 .ops = &at91_udc_ops,
1516 .ep0 = &controller.ep[0].ep,
1517 .name = driver_name,
1519 .init_name = "gadget",
1520 .release = nop_release,
1526 .ops = &at91_ep_ops,
1535 .ops = &at91_ep_ops,
1545 .ops = &at91_ep_ops,
1554 /* could actually do bulk too */
1556 .ops = &at91_ep_ops,
1565 .ops = &at91_ep_ops,
1575 .ops = &at91_ep_ops,
1582 /* ep6 and ep7 are also reserved (custom silicon might use them) */
1585 static void at91_vbus_update(struct at91_udc *udc, unsigned value)
1587 value ^= udc->board.vbus_active_low;
1588 if (value != udc->vbus)
1589 at91_vbus_session(&udc->gadget, value);
1592 static irqreturn_t at91_vbus_irq(int irq, void *_udc)
1594 struct at91_udc *udc = _udc;
1596 /* vbus needs at least brief debouncing */
1598 at91_vbus_update(udc, gpio_get_value(udc->board.vbus_pin));
1603 static void at91_vbus_timer_work(struct work_struct *work)
1605 struct at91_udc *udc = container_of(work, struct at91_udc,
1608 at91_vbus_update(udc, gpio_get_value_cansleep(udc->board.vbus_pin));
1610 if (!timer_pending(&udc->vbus_timer))
1611 mod_timer(&udc->vbus_timer, jiffies + VBUS_POLL_TIMEOUT);
1614 static void at91_vbus_timer(unsigned long data)
1616 struct at91_udc *udc = (struct at91_udc *)data;
1619 * If we are polling vbus it is likely that the gpio is on an
1620 * bus such as i2c or spi which may sleep, so schedule some work
1621 * to read the vbus gpio
1623 if (!work_pending(&udc->vbus_timer_work))
1624 schedule_work(&udc->vbus_timer_work);
1627 static int at91_start(struct usb_gadget_driver *driver,
1628 int (*bind)(struct usb_gadget *))
1630 struct at91_udc *udc = &controller;
1632 unsigned long flags;
1635 || driver->max_speed < USB_SPEED_FULL
1637 || !driver->setup) {
1638 DBG("bad parameter.\n");
1643 DBG("UDC already has a gadget driver\n");
1647 udc->driver = driver;
1648 udc->gadget.dev.driver = &driver->driver;
1649 dev_set_drvdata(&udc->gadget.dev, &driver->driver);
1651 udc->selfpowered = 1;
1653 retval = bind(&udc->gadget);
1655 DBG("bind() returned %d\n", retval);
1657 udc->gadget.dev.driver = NULL;
1658 dev_set_drvdata(&udc->gadget.dev, NULL);
1660 udc->selfpowered = 0;
1664 spin_lock_irqsave(&udc->lock, flags);
1666 spin_unlock_irqrestore(&udc->lock, flags);
1668 DBG("bound to %s\n", driver->driver.name);
1672 static int at91_stop(struct usb_gadget_driver *driver)
1674 struct at91_udc *udc = &controller;
1675 unsigned long flags;
1677 if (!driver || driver != udc->driver || !driver->unbind)
1680 spin_lock_irqsave(&udc->lock, flags);
1682 at91_udp_write(udc, AT91_UDP_IDR, ~0);
1684 spin_unlock_irqrestore(&udc->lock, flags);
1686 driver->unbind(&udc->gadget);
1687 udc->gadget.dev.driver = NULL;
1688 dev_set_drvdata(&udc->gadget.dev, NULL);
1691 DBG("unbound from %s\n", driver->driver.name);
1695 /*-------------------------------------------------------------------------*/
1697 static void at91udc_shutdown(struct platform_device *dev)
1699 struct at91_udc *udc = platform_get_drvdata(dev);
1700 unsigned long flags;
1702 /* force disconnect on reboot */
1703 spin_lock_irqsave(&udc->lock, flags);
1704 pullup(platform_get_drvdata(dev), 0);
1705 spin_unlock_irqrestore(&udc->lock, flags);
1708 static int __init at91udc_probe(struct platform_device *pdev)
1710 struct device *dev = &pdev->dev;
1711 struct at91_udc *udc;
1713 struct resource *res;
1715 if (!dev->platform_data) {
1716 /* small (so we copy it) but critical! */
1717 DBG("missing platform_data\n");
1721 if (pdev->num_resources != 2) {
1722 DBG("invalid num_resources\n");
1725 if ((pdev->resource[0].flags != IORESOURCE_MEM)
1726 || (pdev->resource[1].flags != IORESOURCE_IRQ)) {
1727 DBG("invalid resource type\n");
1731 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1735 if (!request_mem_region(res->start, resource_size(res), driver_name)) {
1736 DBG("someone's using UDC memory\n");
1740 /* init software state */
1742 udc->gadget.dev.parent = dev;
1743 udc->board = *(struct at91_udc_data *) dev->platform_data;
1746 spin_lock_init(&udc->lock);
1748 /* rm9200 needs manual D+ pullup; off by default */
1749 if (cpu_is_at91rm9200()) {
1750 if (gpio_is_valid(udc->board.pullup_pin)) {
1751 DBG("no D+ pullup?\n");
1755 retval = gpio_request(udc->board.pullup_pin, "udc_pullup");
1757 DBG("D+ pullup is busy\n");
1760 gpio_direction_output(udc->board.pullup_pin,
1761 udc->board.pullup_active_low);
1764 /* newer chips have more FIFO memory than rm9200 */
1765 if (cpu_is_at91sam9260() || cpu_is_at91sam9g20()) {
1766 udc->ep[0].maxpacket = 64;
1767 udc->ep[3].maxpacket = 64;
1768 udc->ep[4].maxpacket = 512;
1769 udc->ep[5].maxpacket = 512;
1770 } else if (cpu_is_at91sam9261() || cpu_is_at91sam9g10()) {
1771 udc->ep[3].maxpacket = 64;
1772 } else if (cpu_is_at91sam9263()) {
1773 udc->ep[0].maxpacket = 64;
1774 udc->ep[3].maxpacket = 64;
1777 udc->udp_baseaddr = ioremap(res->start, resource_size(res));
1778 if (!udc->udp_baseaddr) {
1785 /* get interface and function clocks */
1786 udc->iclk = clk_get(dev, "udc_clk");
1787 udc->fclk = clk_get(dev, "udpck");
1788 if (IS_ERR(udc->iclk) || IS_ERR(udc->fclk)) {
1789 DBG("clocks missing\n");
1791 /* NOTE: we "know" here that refcounts on these are NOPs */
1795 retval = device_register(&udc->gadget.dev);
1797 put_device(&udc->gadget.dev);
1801 /* don't do anything until we have both gadget driver and VBUS */
1802 clk_enable(udc->iclk);
1803 at91_udp_write(udc, AT91_UDP_TXVC, AT91_UDP_TXVC_TXVDIS);
1804 at91_udp_write(udc, AT91_UDP_IDR, 0xffffffff);
1805 /* Clear all pending interrupts - UDP may be used by bootloader. */
1806 at91_udp_write(udc, AT91_UDP_ICR, 0xffffffff);
1807 clk_disable(udc->iclk);
1809 /* request UDC and maybe VBUS irqs */
1810 udc->udp_irq = platform_get_irq(pdev, 0);
1811 retval = request_irq(udc->udp_irq, at91_udc_irq,
1812 0, driver_name, udc);
1814 DBG("request irq %d failed\n", udc->udp_irq);
1817 if (gpio_is_valid(udc->board.vbus_pin)) {
1818 retval = gpio_request(udc->board.vbus_pin, "udc_vbus");
1820 DBG("request vbus pin failed\n");
1823 gpio_direction_input(udc->board.vbus_pin);
1826 * Get the initial state of VBUS - we cannot expect
1827 * a pending interrupt.
1829 udc->vbus = gpio_get_value_cansleep(udc->board.vbus_pin) ^
1830 udc->board.vbus_active_low;
1832 if (udc->board.vbus_polled) {
1833 INIT_WORK(&udc->vbus_timer_work, at91_vbus_timer_work);
1834 setup_timer(&udc->vbus_timer, at91_vbus_timer,
1835 (unsigned long)udc);
1836 mod_timer(&udc->vbus_timer,
1837 jiffies + VBUS_POLL_TIMEOUT);
1839 if (request_irq(udc->board.vbus_pin, at91_vbus_irq,
1840 0, driver_name, udc)) {
1841 DBG("request vbus irq %d failed\n",
1842 udc->board.vbus_pin);
1848 DBG("no VBUS detection, assuming always-on\n");
1851 retval = usb_add_gadget_udc(dev, &udc->gadget);
1854 dev_set_drvdata(dev, udc);
1855 device_init_wakeup(dev, 1);
1856 create_debug_file(udc);
1858 INFO("%s version %s\n", driver_name, DRIVER_VERSION);
1861 if (gpio_is_valid(udc->board.vbus_pin) && !udc->board.vbus_polled)
1862 free_irq(udc->board.vbus_pin, udc);
1864 if (gpio_is_valid(udc->board.vbus_pin))
1865 gpio_free(udc->board.vbus_pin);
1867 free_irq(udc->udp_irq, udc);
1869 device_unregister(&udc->gadget.dev);
1871 iounmap(udc->udp_baseaddr);
1873 if (cpu_is_at91rm9200())
1874 gpio_free(udc->board.pullup_pin);
1876 release_mem_region(res->start, resource_size(res));
1877 DBG("%s probe failed, %d\n", driver_name, retval);
1881 static int __exit at91udc_remove(struct platform_device *pdev)
1883 struct at91_udc *udc = platform_get_drvdata(pdev);
1884 struct resource *res;
1885 unsigned long flags;
1889 usb_del_gadget_udc(&udc->gadget);
1893 spin_lock_irqsave(&udc->lock, flags);
1895 spin_unlock_irqrestore(&udc->lock, flags);
1897 device_init_wakeup(&pdev->dev, 0);
1898 remove_debug_file(udc);
1899 if (gpio_is_valid(udc->board.vbus_pin)) {
1900 free_irq(udc->board.vbus_pin, udc);
1901 gpio_free(udc->board.vbus_pin);
1903 free_irq(udc->udp_irq, udc);
1904 device_unregister(&udc->gadget.dev);
1906 iounmap(udc->udp_baseaddr);
1908 if (cpu_is_at91rm9200())
1909 gpio_free(udc->board.pullup_pin);
1911 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1912 release_mem_region(res->start, resource_size(res));
1921 static int at91udc_suspend(struct platform_device *pdev, pm_message_t mesg)
1923 struct at91_udc *udc = platform_get_drvdata(pdev);
1924 int wake = udc->driver && device_may_wakeup(&pdev->dev);
1925 unsigned long flags;
1927 /* Unless we can act normally to the host (letting it wake us up
1928 * whenever it has work for us) force disconnect. Wakeup requires
1929 * PLLB for USB events (signaling for reset, wakeup, or incoming
1930 * tokens) and VBUS irqs (on systems which support them).
1932 if ((!udc->suspended && udc->addr)
1934 || at91_suspend_entering_slow_clock()) {
1935 spin_lock_irqsave(&udc->lock, flags);
1938 spin_unlock_irqrestore(&udc->lock, flags);
1940 enable_irq_wake(udc->udp_irq);
1942 udc->active_suspend = wake;
1943 if (gpio_is_valid(udc->board.vbus_pin) && !udc->board.vbus_polled && wake)
1944 enable_irq_wake(udc->board.vbus_pin);
1948 static int at91udc_resume(struct platform_device *pdev)
1950 struct at91_udc *udc = platform_get_drvdata(pdev);
1951 unsigned long flags;
1953 if (gpio_is_valid(udc->board.vbus_pin) && !udc->board.vbus_polled &&
1954 udc->active_suspend)
1955 disable_irq_wake(udc->board.vbus_pin);
1957 /* maybe reconnect to host; if so, clocks on */
1958 if (udc->active_suspend)
1959 disable_irq_wake(udc->udp_irq);
1961 spin_lock_irqsave(&udc->lock, flags);
1963 spin_unlock_irqrestore(&udc->lock, flags);
1968 #define at91udc_suspend NULL
1969 #define at91udc_resume NULL
1972 static struct platform_driver at91_udc_driver = {
1973 .remove = __exit_p(at91udc_remove),
1974 .shutdown = at91udc_shutdown,
1975 .suspend = at91udc_suspend,
1976 .resume = at91udc_resume,
1978 .name = (char *) driver_name,
1979 .owner = THIS_MODULE,
1983 static int __init udc_init_module(void)
1985 return platform_driver_probe(&at91_udc_driver, at91udc_probe);
1987 module_init(udc_init_module);
1989 static void __exit udc_exit_module(void)
1991 platform_driver_unregister(&at91_udc_driver);
1993 module_exit(udc_exit_module);
1995 MODULE_DESCRIPTION("AT91 udc driver");
1996 MODULE_AUTHOR("Thomas Rathbone, David Brownell");
1997 MODULE_LICENSE("GPL");
1998 MODULE_ALIAS("platform:at91_udc");