1 // SPDX-License-Identifier: GPL-2.0+
3 * at91_udc -- driver for at91-series USB peripheral controller
5 * Copyright (C) 2004 by Thomas Rathbone
6 * Copyright (C) 2005 by HP Labs
7 * Copyright (C) 2005 by David Brownell
13 #include <linux/kernel.h>
14 #include <linux/module.h>
15 #include <linux/platform_device.h>
16 #include <linux/delay.h>
17 #include <linux/ioport.h>
18 #include <linux/slab.h>
19 #include <linux/errno.h>
20 #include <linux/list.h>
21 #include <linux/interrupt.h>
22 #include <linux/proc_fs.h>
23 #include <linux/prefetch.h>
24 #include <linux/clk.h>
25 #include <linux/usb/ch9.h>
26 #include <linux/usb/gadget.h>
28 #include <linux/of_gpio.h>
29 #include <linux/platform_data/atmel.h>
30 #include <linux/regmap.h>
31 #include <linux/mfd/syscon.h>
32 #include <linux/mfd/syscon/atmel-matrix.h>
38 * This controller is simple and PIO-only. It's used in many AT91-series
39 * full speed USB controllers, including the at91rm9200 (arm920T, with MMU),
40 * at91sam926x (arm926ejs, with MMU), and several no-mmu versions.
42 * This driver expects the board has been wired with two GPIOs supporting
43 * a VBUS sensing IRQ, and a D+ pullup. (They may be omitted, but the
44 * testing hasn't covered such cases.)
46 * The pullup is most important (so it's integrated on sam926x parts). It
47 * provides software control over whether the host enumerates the device.
49 * The VBUS sensing helps during enumeration, and allows both USB clocks
50 * (and the transceiver) to stay gated off until they're necessary, saving
51 * power. During USB suspend, the 48 MHz clock is gated off in hardware;
52 * it may also be gated off by software during some Linux sleep states.
55 #define DRIVER_VERSION "3 May 2006"
57 static const char driver_name [] = "at91_udc";
61 const struct usb_ep_caps caps;
63 #define EP_INFO(_name, _caps) \
70 USB_EP_CAPS(USB_EP_CAPS_TYPE_CONTROL, USB_EP_CAPS_DIR_ALL)),
72 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_ALL)),
74 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_ALL)),
76 USB_EP_CAPS(USB_EP_CAPS_TYPE_INT, USB_EP_CAPS_DIR_ALL)),
78 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_ALL)),
80 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_ALL)),
85 #define ep0name ep_info[0].name
87 #define VBUS_POLL_TIMEOUT msecs_to_jiffies(1000)
89 #define at91_udp_read(udc, reg) \
90 __raw_readl((udc)->udp_baseaddr + (reg))
91 #define at91_udp_write(udc, reg, val) \
92 __raw_writel((val), (udc)->udp_baseaddr + (reg))
94 /*-------------------------------------------------------------------------*/
96 #ifdef CONFIG_USB_GADGET_DEBUG_FILES
98 #include <linux/seq_file.h>
100 static const char debug_filename[] = "driver/udc";
102 #define FOURBITS "%s%s%s%s"
103 #define EIGHTBITS FOURBITS FOURBITS
105 static void proc_ep_show(struct seq_file *s, struct at91_ep *ep)
107 static char *types[] = {
108 "control", "out-iso", "out-bulk", "out-int",
109 "BOGUS", "in-iso", "in-bulk", "in-int"};
112 struct at91_request *req;
114 struct at91_udc *udc = ep->udc;
116 spin_lock_irqsave(&udc->lock, flags);
118 csr = __raw_readl(ep->creg);
120 /* NOTE: not collecting per-endpoint irq statistics... */
123 seq_printf(s, "%s, maxpacket %d %s%s %s%s\n",
124 ep->ep.name, ep->ep.maxpacket,
125 ep->is_in ? "in" : "out",
126 ep->is_iso ? " iso" : "",
128 ? (ep->fifo_bank ? "pong" : "ping")
130 ep->stopped ? " stopped" : "");
131 seq_printf(s, "csr %08x rxbytes=%d %s %s %s" EIGHTBITS "\n",
133 (csr & 0x07ff0000) >> 16,
134 (csr & (1 << 15)) ? "enabled" : "disabled",
135 (csr & (1 << 11)) ? "DATA1" : "DATA0",
136 types[(csr & 0x700) >> 8],
138 /* iff type is control then print current direction */
140 ? ((csr & (1 << 7)) ? " IN" : " OUT")
142 (csr & (1 << 6)) ? " rxdatabk1" : "",
143 (csr & (1 << 5)) ? " forcestall" : "",
144 (csr & (1 << 4)) ? " txpktrdy" : "",
146 (csr & (1 << 3)) ? " stallsent" : "",
147 (csr & (1 << 2)) ? " rxsetup" : "",
148 (csr & (1 << 1)) ? " rxdatabk0" : "",
149 (csr & (1 << 0)) ? " txcomp" : "");
150 if (list_empty (&ep->queue))
151 seq_printf(s, "\t(queue empty)\n");
153 else list_for_each_entry (req, &ep->queue, queue) {
154 unsigned length = req->req.actual;
156 seq_printf(s, "\treq %p len %d/%d buf %p\n",
158 req->req.length, req->req.buf);
160 spin_unlock_irqrestore(&udc->lock, flags);
163 static void proc_irq_show(struct seq_file *s, const char *label, u32 mask)
167 seq_printf(s, "%s %04x:%s%s" FOURBITS, label, mask,
168 (mask & (1 << 13)) ? " wakeup" : "",
169 (mask & (1 << 12)) ? " endbusres" : "",
171 (mask & (1 << 11)) ? " sofint" : "",
172 (mask & (1 << 10)) ? " extrsm" : "",
173 (mask & (1 << 9)) ? " rxrsm" : "",
174 (mask & (1 << 8)) ? " rxsusp" : "");
175 for (i = 0; i < 8; i++) {
177 seq_printf(s, " ep%d", i);
182 static int proc_udc_show(struct seq_file *s, void *unused)
184 struct at91_udc *udc = s->private;
188 seq_printf(s, "%s: version %s\n", driver_name, DRIVER_VERSION);
190 seq_printf(s, "vbus %s, pullup %s, %s powered%s, gadget %s\n\n",
191 udc->vbus ? "present" : "off",
193 ? (udc->vbus ? "active" : "enabled")
195 udc->gadget.is_selfpowered ? "self" : "VBUS",
196 udc->suspended ? ", suspended" : "",
197 udc->driver ? udc->driver->driver.name : "(none)");
199 /* don't access registers when interface isn't clocked */
201 seq_printf(s, "(not clocked)\n");
205 tmp = at91_udp_read(udc, AT91_UDP_FRM_NUM);
206 seq_printf(s, "frame %05x:%s%s frame=%d\n", tmp,
207 (tmp & AT91_UDP_FRM_OK) ? " ok" : "",
208 (tmp & AT91_UDP_FRM_ERR) ? " err" : "",
209 (tmp & AT91_UDP_NUM));
211 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT);
212 seq_printf(s, "glbstate %02x:%s" FOURBITS "\n", tmp,
213 (tmp & AT91_UDP_RMWUPE) ? " rmwupe" : "",
214 (tmp & AT91_UDP_RSMINPR) ? " rsminpr" : "",
215 (tmp & AT91_UDP_ESR) ? " esr" : "",
216 (tmp & AT91_UDP_CONFG) ? " confg" : "",
217 (tmp & AT91_UDP_FADDEN) ? " fadden" : "");
219 tmp = at91_udp_read(udc, AT91_UDP_FADDR);
220 seq_printf(s, "faddr %03x:%s fadd=%d\n", tmp,
221 (tmp & AT91_UDP_FEN) ? " fen" : "",
222 (tmp & AT91_UDP_FADD));
224 proc_irq_show(s, "imr ", at91_udp_read(udc, AT91_UDP_IMR));
225 proc_irq_show(s, "isr ", at91_udp_read(udc, AT91_UDP_ISR));
227 if (udc->enabled && udc->vbus) {
228 proc_ep_show(s, &udc->ep[0]);
229 list_for_each_entry (ep, &udc->gadget.ep_list, ep.ep_list) {
237 static void create_debug_file(struct at91_udc *udc)
239 udc->pde = proc_create_single_data(debug_filename, 0, NULL,
243 static void remove_debug_file(struct at91_udc *udc)
246 remove_proc_entry(debug_filename, NULL);
251 static inline void create_debug_file(struct at91_udc *udc) {}
252 static inline void remove_debug_file(struct at91_udc *udc) {}
257 /*-------------------------------------------------------------------------*/
259 static void done(struct at91_ep *ep, struct at91_request *req, int status)
261 unsigned stopped = ep->stopped;
262 struct at91_udc *udc = ep->udc;
264 list_del_init(&req->queue);
265 if (req->req.status == -EINPROGRESS)
266 req->req.status = status;
268 status = req->req.status;
269 if (status && status != -ESHUTDOWN)
270 VDBG("%s done %p, status %d\n", ep->ep.name, req, status);
273 spin_unlock(&udc->lock);
274 usb_gadget_giveback_request(&ep->ep, &req->req);
275 spin_lock(&udc->lock);
276 ep->stopped = stopped;
278 /* ep0 is always ready; other endpoints need a non-empty queue */
279 if (list_empty(&ep->queue) && ep->int_mask != (1 << 0))
280 at91_udp_write(udc, AT91_UDP_IDR, ep->int_mask);
283 /*-------------------------------------------------------------------------*/
285 /* bits indicating OUT fifo has data ready */
286 #define RX_DATA_READY (AT91_UDP_RX_DATA_BK0 | AT91_UDP_RX_DATA_BK1)
289 * Endpoint FIFO CSR bits have a mix of bits, making it unsafe to just write
290 * back most of the value you just read (because of side effects, including
291 * bits that may change after reading and before writing).
293 * Except when changing a specific bit, always write values which:
294 * - clear SET_FX bits (setting them could change something)
295 * - set CLR_FX bits (clearing them could change something)
297 * There are also state bits like FORCESTALL, EPEDS, DIR, and EPTYPE
298 * that shouldn't normally be changed.
300 * NOTE at91sam9260 docs mention synch between UDPCK and MCK clock domains,
301 * implying a need to wait for one write to complete (test relevant bits)
302 * before starting the next write. This shouldn't be an issue given how
303 * infrequently we write, except maybe for write-then-read idioms.
305 #define SET_FX (AT91_UDP_TXPKTRDY)
306 #define CLR_FX (RX_DATA_READY | AT91_UDP_RXSETUP \
307 | AT91_UDP_STALLSENT | AT91_UDP_TXCOMP)
309 /* pull OUT packet data from the endpoint's fifo */
310 static int read_fifo (struct at91_ep *ep, struct at91_request *req)
312 u32 __iomem *creg = ep->creg;
313 u8 __iomem *dreg = ep->creg + (AT91_UDP_FDR(0) - AT91_UDP_CSR(0));
316 unsigned int count, bufferspace, is_done;
318 buf = req->req.buf + req->req.actual;
319 bufferspace = req->req.length - req->req.actual;
322 * there might be nothing to read if ep_queue() calls us,
323 * or if we already emptied both pingpong buffers
326 csr = __raw_readl(creg);
327 if ((csr & RX_DATA_READY) == 0)
330 count = (csr & AT91_UDP_RXBYTECNT) >> 16;
331 if (count > ep->ep.maxpacket)
332 count = ep->ep.maxpacket;
333 if (count > bufferspace) {
334 DBG("%s buffer overflow\n", ep->ep.name);
335 req->req.status = -EOVERFLOW;
338 __raw_readsb(dreg, buf, count);
340 /* release and swap pingpong mem bank */
342 if (ep->is_pingpong) {
343 if (ep->fifo_bank == 0) {
344 csr &= ~(SET_FX | AT91_UDP_RX_DATA_BK0);
347 csr &= ~(SET_FX | AT91_UDP_RX_DATA_BK1);
351 csr &= ~(SET_FX | AT91_UDP_RX_DATA_BK0);
352 __raw_writel(csr, creg);
354 req->req.actual += count;
355 is_done = (count < ep->ep.maxpacket);
356 if (count == bufferspace)
359 PACKET("%s %p out/%d%s\n", ep->ep.name, &req->req, count,
360 is_done ? " (done)" : "");
363 * avoid extra trips through IRQ logic for packets already in
364 * the fifo ... maybe preventing an extra (expensive) OUT-NAK
368 else if (ep->is_pingpong) {
370 * One dummy read to delay the code because of a HW glitch:
371 * CSR returns bad RXCOUNT when read too soon after updating
374 csr = __raw_readl(creg);
376 bufferspace -= count;
384 /* load fifo for an IN packet */
385 static int write_fifo(struct at91_ep *ep, struct at91_request *req)
387 u32 __iomem *creg = ep->creg;
388 u32 csr = __raw_readl(creg);
389 u8 __iomem *dreg = ep->creg + (AT91_UDP_FDR(0) - AT91_UDP_CSR(0));
390 unsigned total, count, is_last;
394 * TODO: allow for writing two packets to the fifo ... that'll
395 * reduce the amount of IN-NAKing, but probably won't affect
396 * throughput much. (Unlike preventing OUT-NAKing!)
400 * If ep_queue() calls us, the queue is empty and possibly in
401 * odd states like TXCOMP not yet cleared (we do it, saving at
402 * least one IRQ) or the fifo not yet being free. Those aren't
403 * issues normally (IRQ handler fast path).
405 if (unlikely(csr & (AT91_UDP_TXCOMP | AT91_UDP_TXPKTRDY))) {
406 if (csr & AT91_UDP_TXCOMP) {
408 csr &= ~(SET_FX | AT91_UDP_TXCOMP);
409 __raw_writel(csr, creg);
410 csr = __raw_readl(creg);
412 if (csr & AT91_UDP_TXPKTRDY)
416 buf = req->req.buf + req->req.actual;
418 total = req->req.length - req->req.actual;
419 if (ep->ep.maxpacket < total) {
420 count = ep->ep.maxpacket;
424 is_last = (count < ep->ep.maxpacket) || !req->req.zero;
428 * Write the packet, maybe it's a ZLP.
430 * NOTE: incrementing req->actual before we receive the ACK means
431 * gadget driver IN bytecounts can be wrong in fault cases. That's
432 * fixable with PIO drivers like this one (save "count" here, and
433 * do the increment later on TX irq), but not for most DMA hardware.
435 * So all gadget drivers must accept that potential error. Some
436 * hardware supports precise fifo status reporting, letting them
437 * recover when the actual bytecount matters (e.g. for USB Test
438 * and Measurement Class devices).
440 __raw_writesb(dreg, buf, count);
442 csr |= CLR_FX | AT91_UDP_TXPKTRDY;
443 __raw_writel(csr, creg);
444 req->req.actual += count;
446 PACKET("%s %p in/%d%s\n", ep->ep.name, &req->req, count,
447 is_last ? " (done)" : "");
453 static void nuke(struct at91_ep *ep, int status)
455 struct at91_request *req;
457 /* terminate any request in the queue */
459 if (list_empty(&ep->queue))
462 VDBG("%s %s\n", __func__, ep->ep.name);
463 while (!list_empty(&ep->queue)) {
464 req = list_entry(ep->queue.next, struct at91_request, queue);
465 done(ep, req, status);
469 /*-------------------------------------------------------------------------*/
471 static int at91_ep_enable(struct usb_ep *_ep,
472 const struct usb_endpoint_descriptor *desc)
474 struct at91_ep *ep = container_of(_ep, struct at91_ep, ep);
475 struct at91_udc *udc;
481 || !desc || _ep->name == ep0name
482 || desc->bDescriptorType != USB_DT_ENDPOINT
483 || (maxpacket = usb_endpoint_maxp(desc)) == 0
484 || maxpacket > ep->maxpacket) {
485 DBG("bad ep or descriptor\n");
490 if (!udc->driver || udc->gadget.speed == USB_SPEED_UNKNOWN) {
491 DBG("bogus device state\n");
495 tmp = usb_endpoint_type(desc);
497 case USB_ENDPOINT_XFER_CONTROL:
498 DBG("only one control endpoint\n");
500 case USB_ENDPOINT_XFER_INT:
504 case USB_ENDPOINT_XFER_BULK:
513 DBG("bogus maxpacket %d\n", maxpacket);
515 case USB_ENDPOINT_XFER_ISOC:
516 if (!ep->is_pingpong) {
517 DBG("iso requires double buffering\n");
524 spin_lock_irqsave(&udc->lock, flags);
526 /* initialize endpoint to match this descriptor */
527 ep->is_in = usb_endpoint_dir_in(desc);
528 ep->is_iso = (tmp == USB_ENDPOINT_XFER_ISOC);
533 tmp |= AT91_UDP_EPEDS;
534 __raw_writel(tmp, ep->creg);
536 ep->ep.maxpacket = maxpacket;
539 * reset/init endpoint fifo. NOTE: leaves fifo_bank alone,
540 * since endpoint resets don't reset hw pingpong state.
542 at91_udp_write(udc, AT91_UDP_RST_EP, ep->int_mask);
543 at91_udp_write(udc, AT91_UDP_RST_EP, 0);
545 spin_unlock_irqrestore(&udc->lock, flags);
549 static int at91_ep_disable (struct usb_ep * _ep)
551 struct at91_ep *ep = container_of(_ep, struct at91_ep, ep);
552 struct at91_udc *udc = ep->udc;
555 if (ep == &ep->udc->ep[0])
558 spin_lock_irqsave(&udc->lock, flags);
560 nuke(ep, -ESHUTDOWN);
562 /* restore the endpoint's pristine config */
564 ep->ep.maxpacket = ep->maxpacket;
566 /* reset fifos and endpoint */
567 if (ep->udc->clocked) {
568 at91_udp_write(udc, AT91_UDP_RST_EP, ep->int_mask);
569 at91_udp_write(udc, AT91_UDP_RST_EP, 0);
570 __raw_writel(0, ep->creg);
573 spin_unlock_irqrestore(&udc->lock, flags);
578 * this is a PIO-only driver, so there's nothing
579 * interesting for request or buffer allocation.
582 static struct usb_request *
583 at91_ep_alloc_request(struct usb_ep *_ep, gfp_t gfp_flags)
585 struct at91_request *req;
587 req = kzalloc(sizeof (struct at91_request), gfp_flags);
591 INIT_LIST_HEAD(&req->queue);
595 static void at91_ep_free_request(struct usb_ep *_ep, struct usb_request *_req)
597 struct at91_request *req;
599 req = container_of(_req, struct at91_request, req);
600 BUG_ON(!list_empty(&req->queue));
604 static int at91_ep_queue(struct usb_ep *_ep,
605 struct usb_request *_req, gfp_t gfp_flags)
607 struct at91_request *req;
609 struct at91_udc *udc;
613 req = container_of(_req, struct at91_request, req);
614 ep = container_of(_ep, struct at91_ep, ep);
616 if (!_req || !_req->complete
617 || !_req->buf || !list_empty(&req->queue)) {
618 DBG("invalid request\n");
622 if (!_ep || (!ep->ep.desc && ep->ep.name != ep0name)) {
629 if (!udc || !udc->driver || udc->gadget.speed == USB_SPEED_UNKNOWN) {
630 DBG("invalid device\n");
634 _req->status = -EINPROGRESS;
637 spin_lock_irqsave(&udc->lock, flags);
639 /* try to kickstart any empty and idle queue */
640 if (list_empty(&ep->queue) && !ep->stopped) {
644 * If this control request has a non-empty DATA stage, this
645 * will start that stage. It works just like a non-control
646 * request (until the status stage starts, maybe early).
648 * If the data stage is empty, then this starts a successful
649 * IN/STATUS stage. (Unsuccessful ones use set_halt.)
651 is_ep0 = (ep->ep.name == ep0name);
655 if (!udc->req_pending) {
661 * defer changing CONFG until after the gadget driver
662 * reconfigures the endpoints.
664 if (udc->wait_for_config_ack) {
665 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT);
666 tmp ^= AT91_UDP_CONFG;
667 VDBG("toggle config\n");
668 at91_udp_write(udc, AT91_UDP_GLB_STAT, tmp);
670 if (req->req.length == 0) {
672 PACKET("ep0 in/status\n");
674 tmp = __raw_readl(ep->creg);
676 tmp |= CLR_FX | AT91_UDP_TXPKTRDY;
677 __raw_writel(tmp, ep->creg);
678 udc->req_pending = 0;
684 status = write_fifo(ep, req);
686 status = read_fifo(ep, req);
688 /* IN/STATUS stage is otherwise triggered by irq */
689 if (status && is_ep0)
695 if (req && !status) {
696 list_add_tail (&req->queue, &ep->queue);
697 at91_udp_write(udc, AT91_UDP_IER, ep->int_mask);
700 spin_unlock_irqrestore(&udc->lock, flags);
701 return (status < 0) ? status : 0;
704 static int at91_ep_dequeue(struct usb_ep *_ep, struct usb_request *_req)
707 struct at91_request *req;
709 struct at91_udc *udc;
711 ep = container_of(_ep, struct at91_ep, ep);
712 if (!_ep || ep->ep.name == ep0name)
717 spin_lock_irqsave(&udc->lock, flags);
719 /* make sure it's actually queued on this endpoint */
720 list_for_each_entry (req, &ep->queue, queue) {
721 if (&req->req == _req)
724 if (&req->req != _req) {
725 spin_unlock_irqrestore(&udc->lock, flags);
729 done(ep, req, -ECONNRESET);
730 spin_unlock_irqrestore(&udc->lock, flags);
734 static int at91_ep_set_halt(struct usb_ep *_ep, int value)
736 struct at91_ep *ep = container_of(_ep, struct at91_ep, ep);
737 struct at91_udc *udc = ep->udc;
743 if (!_ep || ep->is_iso || !ep->udc->clocked)
747 spin_lock_irqsave(&udc->lock, flags);
749 csr = __raw_readl(creg);
752 * fail with still-busy IN endpoints, ensuring correct sequencing
753 * of data tx then stall. note that the fifo rx bytecount isn't
754 * completely accurate as a tx bytecount.
756 if (ep->is_in && (!list_empty(&ep->queue) || (csr >> 16) != 0))
762 csr |= AT91_UDP_FORCESTALL;
763 VDBG("halt %s\n", ep->ep.name);
765 at91_udp_write(udc, AT91_UDP_RST_EP, ep->int_mask);
766 at91_udp_write(udc, AT91_UDP_RST_EP, 0);
767 csr &= ~AT91_UDP_FORCESTALL;
769 __raw_writel(csr, creg);
772 spin_unlock_irqrestore(&udc->lock, flags);
776 static const struct usb_ep_ops at91_ep_ops = {
777 .enable = at91_ep_enable,
778 .disable = at91_ep_disable,
779 .alloc_request = at91_ep_alloc_request,
780 .free_request = at91_ep_free_request,
781 .queue = at91_ep_queue,
782 .dequeue = at91_ep_dequeue,
783 .set_halt = at91_ep_set_halt,
784 /* there's only imprecise fifo status reporting */
787 /*-------------------------------------------------------------------------*/
789 static int at91_get_frame(struct usb_gadget *gadget)
791 struct at91_udc *udc = to_udc(gadget);
793 if (!to_udc(gadget)->clocked)
795 return at91_udp_read(udc, AT91_UDP_FRM_NUM) & AT91_UDP_NUM;
798 static int at91_wakeup(struct usb_gadget *gadget)
800 struct at91_udc *udc = to_udc(gadget);
802 int status = -EINVAL;
805 DBG("%s\n", __func__ );
806 spin_lock_irqsave(&udc->lock, flags);
808 if (!udc->clocked || !udc->suspended)
811 /* NOTE: some "early versions" handle ESR differently ... */
813 glbstate = at91_udp_read(udc, AT91_UDP_GLB_STAT);
814 if (!(glbstate & AT91_UDP_ESR))
816 glbstate |= AT91_UDP_ESR;
817 at91_udp_write(udc, AT91_UDP_GLB_STAT, glbstate);
820 spin_unlock_irqrestore(&udc->lock, flags);
824 /* reinit == restore initial software state */
825 static void udc_reinit(struct at91_udc *udc)
829 INIT_LIST_HEAD(&udc->gadget.ep_list);
830 INIT_LIST_HEAD(&udc->gadget.ep0->ep_list);
831 udc->gadget.quirk_stall_not_supp = 1;
833 for (i = 0; i < NUM_ENDPOINTS; i++) {
834 struct at91_ep *ep = &udc->ep[i];
837 list_add_tail(&ep->ep.ep_list, &udc->gadget.ep_list);
841 usb_ep_set_maxpacket_limit(&ep->ep, ep->maxpacket);
842 ep->creg = (void __iomem *) udc->udp_baseaddr + AT91_UDP_CSR(i);
843 /* initialize one queue per endpoint */
844 INIT_LIST_HEAD(&ep->queue);
848 static void reset_gadget(struct at91_udc *udc)
850 struct usb_gadget_driver *driver = udc->driver;
853 if (udc->gadget.speed == USB_SPEED_UNKNOWN)
855 udc->gadget.speed = USB_SPEED_UNKNOWN;
858 for (i = 0; i < NUM_ENDPOINTS; i++) {
859 struct at91_ep *ep = &udc->ep[i];
862 nuke(ep, -ESHUTDOWN);
865 spin_unlock(&udc->lock);
866 usb_gadget_udc_reset(&udc->gadget, driver);
867 spin_lock(&udc->lock);
873 static void stop_activity(struct at91_udc *udc)
875 struct usb_gadget_driver *driver = udc->driver;
878 if (udc->gadget.speed == USB_SPEED_UNKNOWN)
880 udc->gadget.speed = USB_SPEED_UNKNOWN;
883 for (i = 0; i < NUM_ENDPOINTS; i++) {
884 struct at91_ep *ep = &udc->ep[i];
886 nuke(ep, -ESHUTDOWN);
889 spin_unlock(&udc->lock);
890 driver->disconnect(&udc->gadget);
891 spin_lock(&udc->lock);
897 static void clk_on(struct at91_udc *udc)
903 clk_enable(udc->iclk);
904 clk_enable(udc->fclk);
907 static void clk_off(struct at91_udc *udc)
912 udc->gadget.speed = USB_SPEED_UNKNOWN;
913 clk_disable(udc->fclk);
914 clk_disable(udc->iclk);
918 * activate/deactivate link with host; minimize power usage for
919 * inactive links by cutting clocks and transceiver power.
921 static void pullup(struct at91_udc *udc, int is_on)
923 if (!udc->enabled || !udc->vbus)
925 DBG("%sactive\n", is_on ? "" : "in");
929 at91_udp_write(udc, AT91_UDP_ICR, AT91_UDP_RXRSM);
930 at91_udp_write(udc, AT91_UDP_TXVC, 0);
933 at91_udp_write(udc, AT91_UDP_IDR, AT91_UDP_RXRSM);
934 at91_udp_write(udc, AT91_UDP_TXVC, AT91_UDP_TXVC_TXVDIS);
938 if (udc->caps && udc->caps->pullup)
939 udc->caps->pullup(udc, is_on);
942 /* vbus is here! turn everything on that's ready */
943 static int at91_vbus_session(struct usb_gadget *gadget, int is_active)
945 struct at91_udc *udc = to_udc(gadget);
948 /* VDBG("vbus %s\n", is_active ? "on" : "off"); */
949 spin_lock_irqsave(&udc->lock, flags);
950 udc->vbus = (is_active != 0);
952 pullup(udc, is_active);
955 spin_unlock_irqrestore(&udc->lock, flags);
959 static int at91_pullup(struct usb_gadget *gadget, int is_on)
961 struct at91_udc *udc = to_udc(gadget);
964 spin_lock_irqsave(&udc->lock, flags);
965 udc->enabled = is_on = !!is_on;
967 spin_unlock_irqrestore(&udc->lock, flags);
971 static int at91_set_selfpowered(struct usb_gadget *gadget, int is_on)
973 struct at91_udc *udc = to_udc(gadget);
976 spin_lock_irqsave(&udc->lock, flags);
977 gadget->is_selfpowered = (is_on != 0);
978 spin_unlock_irqrestore(&udc->lock, flags);
982 static int at91_start(struct usb_gadget *gadget,
983 struct usb_gadget_driver *driver);
984 static int at91_stop(struct usb_gadget *gadget);
986 static const struct usb_gadget_ops at91_udc_ops = {
987 .get_frame = at91_get_frame,
988 .wakeup = at91_wakeup,
989 .set_selfpowered = at91_set_selfpowered,
990 .vbus_session = at91_vbus_session,
991 .pullup = at91_pullup,
992 .udc_start = at91_start,
993 .udc_stop = at91_stop,
996 * VBUS-powered devices may also also want to support bigger
997 * power budgets after an appropriate SET_CONFIGURATION.
999 /* .vbus_power = at91_vbus_power, */
1002 /*-------------------------------------------------------------------------*/
1004 static int handle_ep(struct at91_ep *ep)
1006 struct at91_request *req;
1007 u32 __iomem *creg = ep->creg;
1008 u32 csr = __raw_readl(creg);
1010 if (!list_empty(&ep->queue))
1011 req = list_entry(ep->queue.next,
1012 struct at91_request, queue);
1017 if (csr & (AT91_UDP_STALLSENT | AT91_UDP_TXCOMP)) {
1019 csr &= ~(SET_FX | AT91_UDP_STALLSENT | AT91_UDP_TXCOMP);
1020 __raw_writel(csr, creg);
1023 return write_fifo(ep, req);
1026 if (csr & AT91_UDP_STALLSENT) {
1027 /* STALLSENT bit == ISOERR */
1028 if (ep->is_iso && req)
1029 req->req.status = -EILSEQ;
1031 csr &= ~(SET_FX | AT91_UDP_STALLSENT);
1032 __raw_writel(csr, creg);
1033 csr = __raw_readl(creg);
1035 if (req && (csr & RX_DATA_READY))
1036 return read_fifo(ep, req);
1043 struct usb_ctrlrequest r;
1046 static void handle_setup(struct at91_udc *udc, struct at91_ep *ep, u32 csr)
1048 u32 __iomem *creg = ep->creg;
1049 u8 __iomem *dreg = ep->creg + (AT91_UDP_FDR(0) - AT91_UDP_CSR(0));
1050 unsigned rxcount, i = 0;
1055 /* read and ack SETUP; hard-fail for bogus packets */
1056 rxcount = (csr & AT91_UDP_RXBYTECNT) >> 16;
1057 if (likely(rxcount == 8)) {
1059 pkt.raw[i++] = __raw_readb(dreg);
1060 if (pkt.r.bRequestType & USB_DIR_IN) {
1061 csr |= AT91_UDP_DIR;
1064 csr &= ~AT91_UDP_DIR;
1068 /* REVISIT this happens sometimes under load; why?? */
1069 ERR("SETUP len %d, csr %08x\n", rxcount, csr);
1073 csr &= ~(SET_FX | AT91_UDP_RXSETUP);
1074 __raw_writel(csr, creg);
1075 udc->wait_for_addr_ack = 0;
1076 udc->wait_for_config_ack = 0;
1078 if (unlikely(status != 0))
1081 #define w_index le16_to_cpu(pkt.r.wIndex)
1082 #define w_value le16_to_cpu(pkt.r.wValue)
1083 #define w_length le16_to_cpu(pkt.r.wLength)
1085 VDBG("SETUP %02x.%02x v%04x i%04x l%04x\n",
1086 pkt.r.bRequestType, pkt.r.bRequest,
1087 w_value, w_index, w_length);
1090 * A few standard requests get handled here, ones that touch
1091 * hardware ... notably for device and endpoint features.
1093 udc->req_pending = 1;
1094 csr = __raw_readl(creg);
1097 switch ((pkt.r.bRequestType << 8) | pkt.r.bRequest) {
1099 case ((USB_TYPE_STANDARD|USB_RECIP_DEVICE) << 8)
1100 | USB_REQ_SET_ADDRESS:
1101 __raw_writel(csr | AT91_UDP_TXPKTRDY, creg);
1102 udc->addr = w_value;
1103 udc->wait_for_addr_ack = 1;
1104 udc->req_pending = 0;
1105 /* FADDR is set later, when we ack host STATUS */
1108 case ((USB_TYPE_STANDARD|USB_RECIP_DEVICE) << 8)
1109 | USB_REQ_SET_CONFIGURATION:
1110 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT) & AT91_UDP_CONFG;
1112 udc->wait_for_config_ack = (tmp == 0);
1114 udc->wait_for_config_ack = (tmp != 0);
1115 if (udc->wait_for_config_ack)
1116 VDBG("wait for config\n");
1117 /* CONFG is toggled later, if gadget driver succeeds */
1121 * Hosts may set or clear remote wakeup status, and
1122 * devices may report they're VBUS powered.
1124 case ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE) << 8)
1125 | USB_REQ_GET_STATUS:
1126 tmp = (udc->gadget.is_selfpowered << USB_DEVICE_SELF_POWERED);
1127 if (at91_udp_read(udc, AT91_UDP_GLB_STAT) & AT91_UDP_ESR)
1128 tmp |= (1 << USB_DEVICE_REMOTE_WAKEUP);
1129 PACKET("get device status\n");
1130 __raw_writeb(tmp, dreg);
1131 __raw_writeb(0, dreg);
1133 /* then STATUS starts later, automatically */
1134 case ((USB_TYPE_STANDARD|USB_RECIP_DEVICE) << 8)
1135 | USB_REQ_SET_FEATURE:
1136 if (w_value != USB_DEVICE_REMOTE_WAKEUP)
1138 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT);
1139 tmp |= AT91_UDP_ESR;
1140 at91_udp_write(udc, AT91_UDP_GLB_STAT, tmp);
1142 case ((USB_TYPE_STANDARD|USB_RECIP_DEVICE) << 8)
1143 | USB_REQ_CLEAR_FEATURE:
1144 if (w_value != USB_DEVICE_REMOTE_WAKEUP)
1146 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT);
1147 tmp &= ~AT91_UDP_ESR;
1148 at91_udp_write(udc, AT91_UDP_GLB_STAT, tmp);
1152 * Interfaces have no feature settings; this is pretty useless.
1153 * we won't even insist the interface exists...
1155 case ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE) << 8)
1156 | USB_REQ_GET_STATUS:
1157 PACKET("get interface status\n");
1158 __raw_writeb(0, dreg);
1159 __raw_writeb(0, dreg);
1161 /* then STATUS starts later, automatically */
1162 case ((USB_TYPE_STANDARD|USB_RECIP_INTERFACE) << 8)
1163 | USB_REQ_SET_FEATURE:
1164 case ((USB_TYPE_STANDARD|USB_RECIP_INTERFACE) << 8)
1165 | USB_REQ_CLEAR_FEATURE:
1169 * Hosts may clear bulk/intr endpoint halt after the gadget
1170 * driver sets it (not widely used); or set it (for testing)
1172 case ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT) << 8)
1173 | USB_REQ_GET_STATUS:
1174 tmp = w_index & USB_ENDPOINT_NUMBER_MASK;
1176 if (tmp >= NUM_ENDPOINTS || (tmp && !ep->ep.desc))
1180 if ((w_index & USB_DIR_IN)) {
1183 } else if (ep->is_in)
1186 PACKET("get %s status\n", ep->ep.name);
1187 if (__raw_readl(ep->creg) & AT91_UDP_FORCESTALL)
1188 tmp = (1 << USB_ENDPOINT_HALT);
1191 __raw_writeb(tmp, dreg);
1192 __raw_writeb(0, dreg);
1194 /* then STATUS starts later, automatically */
1195 case ((USB_TYPE_STANDARD|USB_RECIP_ENDPOINT) << 8)
1196 | USB_REQ_SET_FEATURE:
1197 tmp = w_index & USB_ENDPOINT_NUMBER_MASK;
1199 if (w_value != USB_ENDPOINT_HALT || tmp >= NUM_ENDPOINTS)
1201 if (!ep->ep.desc || ep->is_iso)
1203 if ((w_index & USB_DIR_IN)) {
1206 } else if (ep->is_in)
1209 tmp = __raw_readl(ep->creg);
1211 tmp |= CLR_FX | AT91_UDP_FORCESTALL;
1212 __raw_writel(tmp, ep->creg);
1214 case ((USB_TYPE_STANDARD|USB_RECIP_ENDPOINT) << 8)
1215 | USB_REQ_CLEAR_FEATURE:
1216 tmp = w_index & USB_ENDPOINT_NUMBER_MASK;
1218 if (w_value != USB_ENDPOINT_HALT || tmp >= NUM_ENDPOINTS)
1222 if (!ep->ep.desc || ep->is_iso)
1224 if ((w_index & USB_DIR_IN)) {
1227 } else if (ep->is_in)
1230 at91_udp_write(udc, AT91_UDP_RST_EP, ep->int_mask);
1231 at91_udp_write(udc, AT91_UDP_RST_EP, 0);
1232 tmp = __raw_readl(ep->creg);
1234 tmp &= ~(SET_FX | AT91_UDP_FORCESTALL);
1235 __raw_writel(tmp, ep->creg);
1236 if (!list_empty(&ep->queue))
1245 /* pass request up to the gadget driver */
1247 spin_unlock(&udc->lock);
1248 status = udc->driver->setup(&udc->gadget, &pkt.r);
1249 spin_lock(&udc->lock);
1255 VDBG("req %02x.%02x protocol STALL; stat %d\n",
1256 pkt.r.bRequestType, pkt.r.bRequest, status);
1257 csr |= AT91_UDP_FORCESTALL;
1258 __raw_writel(csr, creg);
1259 udc->req_pending = 0;
1264 /* immediate successful (IN) STATUS after zero length DATA */
1265 PACKET("ep0 in/status\n");
1267 csr |= AT91_UDP_TXPKTRDY;
1268 __raw_writel(csr, creg);
1269 udc->req_pending = 0;
1272 static void handle_ep0(struct at91_udc *udc)
1274 struct at91_ep *ep0 = &udc->ep[0];
1275 u32 __iomem *creg = ep0->creg;
1276 u32 csr = __raw_readl(creg);
1277 struct at91_request *req;
1279 if (unlikely(csr & AT91_UDP_STALLSENT)) {
1281 udc->req_pending = 0;
1283 csr &= ~(SET_FX | AT91_UDP_STALLSENT | AT91_UDP_FORCESTALL);
1284 __raw_writel(csr, creg);
1285 VDBG("ep0 stalled\n");
1286 csr = __raw_readl(creg);
1288 if (csr & AT91_UDP_RXSETUP) {
1290 udc->req_pending = 0;
1291 handle_setup(udc, ep0, csr);
1295 if (list_empty(&ep0->queue))
1298 req = list_entry(ep0->queue.next, struct at91_request, queue);
1300 /* host ACKed an IN packet that we sent */
1301 if (csr & AT91_UDP_TXCOMP) {
1303 csr &= ~(SET_FX | AT91_UDP_TXCOMP);
1305 /* write more IN DATA? */
1306 if (req && ep0->is_in) {
1308 udc->req_pending = 0;
1312 * - last IN DATA packet (including GET_STATUS)
1313 * - IN/STATUS for OUT DATA
1314 * - IN/STATUS for any zero-length DATA stage
1315 * except for the IN DATA case, the host should send
1316 * an OUT status later, which we'll ack.
1319 udc->req_pending = 0;
1320 __raw_writel(csr, creg);
1323 * SET_ADDRESS takes effect only after the STATUS
1324 * (to the original address) gets acked.
1326 if (udc->wait_for_addr_ack) {
1329 at91_udp_write(udc, AT91_UDP_FADDR,
1330 AT91_UDP_FEN | udc->addr);
1331 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT);
1332 tmp &= ~AT91_UDP_FADDEN;
1334 tmp |= AT91_UDP_FADDEN;
1335 at91_udp_write(udc, AT91_UDP_GLB_STAT, tmp);
1337 udc->wait_for_addr_ack = 0;
1338 VDBG("address %d\n", udc->addr);
1343 /* OUT packet arrived ... */
1344 else if (csr & AT91_UDP_RX_DATA_BK0) {
1346 csr &= ~(SET_FX | AT91_UDP_RX_DATA_BK0);
1348 /* OUT DATA stage */
1351 if (handle_ep(ep0)) {
1352 /* send IN/STATUS */
1353 PACKET("ep0 in/status\n");
1354 csr = __raw_readl(creg);
1356 csr |= CLR_FX | AT91_UDP_TXPKTRDY;
1357 __raw_writel(csr, creg);
1358 udc->req_pending = 0;
1360 } else if (udc->req_pending) {
1362 * AT91 hardware has a hard time with this
1363 * "deferred response" mode for control-OUT
1364 * transfers. (For control-IN it's fine.)
1366 * The normal solution leaves OUT data in the
1367 * fifo until the gadget driver is ready.
1368 * We couldn't do that here without disabling
1369 * the IRQ that tells about SETUP packets,
1370 * e.g. when the host gets impatient...
1372 * Working around it by copying into a buffer
1373 * would almost be a non-deferred response,
1374 * except that it wouldn't permit reliable
1375 * stalling of the request. Instead, demand
1376 * that gadget drivers not use this mode.
1378 DBG("no control-OUT deferred responses!\n");
1379 __raw_writel(csr | AT91_UDP_FORCESTALL, creg);
1380 udc->req_pending = 0;
1383 /* STATUS stage for control-IN; ack. */
1385 PACKET("ep0 out/status ACK\n");
1386 __raw_writel(csr, creg);
1388 /* "early" status stage */
1395 static irqreturn_t at91_udc_irq (int irq, void *_udc)
1397 struct at91_udc *udc = _udc;
1399 int disable_clock = 0;
1400 unsigned long flags;
1402 spin_lock_irqsave(&udc->lock, flags);
1404 if (!udc->clocked) {
1412 status = at91_udp_read(udc, AT91_UDP_ISR)
1413 & at91_udp_read(udc, AT91_UDP_IMR);
1417 /* USB reset irq: not maskable */
1418 if (status & AT91_UDP_ENDBUSRES) {
1419 at91_udp_write(udc, AT91_UDP_IDR, ~MINIMUS_INTERRUPTUS);
1420 at91_udp_write(udc, AT91_UDP_IER, MINIMUS_INTERRUPTUS);
1421 /* Atmel code clears this irq twice */
1422 at91_udp_write(udc, AT91_UDP_ICR, AT91_UDP_ENDBUSRES);
1423 at91_udp_write(udc, AT91_UDP_ICR, AT91_UDP_ENDBUSRES);
1424 VDBG("end bus reset\n");
1429 at91_udp_write(udc, AT91_UDP_CSR(0),
1430 AT91_UDP_EPEDS | AT91_UDP_EPTYPE_CTRL);
1431 udc->gadget.speed = USB_SPEED_FULL;
1433 at91_udp_write(udc, AT91_UDP_IER, AT91_UDP_EP(0));
1436 * NOTE: this driver keeps clocks off unless the
1437 * USB host is present. That saves power, but for
1438 * boards that don't support VBUS detection, both
1439 * clocks need to be active most of the time.
1442 /* host initiated suspend (3+ms bus idle) */
1443 } else if (status & AT91_UDP_RXSUSP) {
1444 at91_udp_write(udc, AT91_UDP_IDR, AT91_UDP_RXSUSP);
1445 at91_udp_write(udc, AT91_UDP_IER, AT91_UDP_RXRSM);
1446 at91_udp_write(udc, AT91_UDP_ICR, AT91_UDP_RXSUSP);
1447 /* VDBG("bus suspend\n"); */
1453 * NOTE: when suspending a VBUS-powered device, the
1454 * gadget driver should switch into slow clock mode
1455 * and then into standby to avoid drawing more than
1456 * 500uA power (2500uA for some high-power configs).
1458 if (udc->driver && udc->driver->suspend) {
1459 spin_unlock(&udc->lock);
1460 udc->driver->suspend(&udc->gadget);
1461 spin_lock(&udc->lock);
1464 /* host initiated resume */
1465 } else if (status & AT91_UDP_RXRSM) {
1466 at91_udp_write(udc, AT91_UDP_IDR, AT91_UDP_RXRSM);
1467 at91_udp_write(udc, AT91_UDP_IER, AT91_UDP_RXSUSP);
1468 at91_udp_write(udc, AT91_UDP_ICR, AT91_UDP_RXRSM);
1469 /* VDBG("bus resume\n"); */
1470 if (!udc->suspended)
1475 * NOTE: for a VBUS-powered device, the gadget driver
1476 * would normally want to switch out of slow clock
1477 * mode into normal mode.
1479 if (udc->driver && udc->driver->resume) {
1480 spin_unlock(&udc->lock);
1481 udc->driver->resume(&udc->gadget);
1482 spin_lock(&udc->lock);
1485 /* endpoint IRQs are cleared by handling them */
1489 struct at91_ep *ep = &udc->ep[1];
1493 for (i = 1; i < NUM_ENDPOINTS; i++) {
1505 spin_unlock_irqrestore(&udc->lock, flags);
1510 /*-------------------------------------------------------------------------*/
1512 static void at91_vbus_update(struct at91_udc *udc, unsigned value)
1514 value ^= udc->board.vbus_active_low;
1515 if (value != udc->vbus)
1516 at91_vbus_session(&udc->gadget, value);
1519 static irqreturn_t at91_vbus_irq(int irq, void *_udc)
1521 struct at91_udc *udc = _udc;
1523 /* vbus needs at least brief debouncing */
1525 at91_vbus_update(udc, gpio_get_value(udc->board.vbus_pin));
1530 static void at91_vbus_timer_work(struct work_struct *work)
1532 struct at91_udc *udc = container_of(work, struct at91_udc,
1535 at91_vbus_update(udc, gpio_get_value_cansleep(udc->board.vbus_pin));
1537 if (!timer_pending(&udc->vbus_timer))
1538 mod_timer(&udc->vbus_timer, jiffies + VBUS_POLL_TIMEOUT);
1541 static void at91_vbus_timer(struct timer_list *t)
1543 struct at91_udc *udc = from_timer(udc, t, vbus_timer);
1546 * If we are polling vbus it is likely that the gpio is on an
1547 * bus such as i2c or spi which may sleep, so schedule some work
1548 * to read the vbus gpio
1550 schedule_work(&udc->vbus_timer_work);
1553 static int at91_start(struct usb_gadget *gadget,
1554 struct usb_gadget_driver *driver)
1556 struct at91_udc *udc;
1558 udc = container_of(gadget, struct at91_udc, gadget);
1559 udc->driver = driver;
1560 udc->gadget.dev.of_node = udc->pdev->dev.of_node;
1562 udc->gadget.is_selfpowered = 1;
1567 static int at91_stop(struct usb_gadget *gadget)
1569 struct at91_udc *udc;
1570 unsigned long flags;
1572 udc = container_of(gadget, struct at91_udc, gadget);
1573 spin_lock_irqsave(&udc->lock, flags);
1575 at91_udp_write(udc, AT91_UDP_IDR, ~0);
1576 spin_unlock_irqrestore(&udc->lock, flags);
1583 /*-------------------------------------------------------------------------*/
1585 static void at91udc_shutdown(struct platform_device *dev)
1587 struct at91_udc *udc = platform_get_drvdata(dev);
1588 unsigned long flags;
1590 /* force disconnect on reboot */
1591 spin_lock_irqsave(&udc->lock, flags);
1592 pullup(platform_get_drvdata(dev), 0);
1593 spin_unlock_irqrestore(&udc->lock, flags);
1596 static int at91rm9200_udc_init(struct at91_udc *udc)
1602 for (i = 0; i < NUM_ENDPOINTS; i++) {
1614 ep->maxpacket = 256;
1619 if (!gpio_is_valid(udc->board.pullup_pin)) {
1620 DBG("no D+ pullup?\n");
1624 ret = devm_gpio_request(&udc->pdev->dev, udc->board.pullup_pin,
1627 DBG("D+ pullup is busy\n");
1631 gpio_direction_output(udc->board.pullup_pin,
1632 udc->board.pullup_active_low);
1637 static void at91rm9200_udc_pullup(struct at91_udc *udc, int is_on)
1639 int active = !udc->board.pullup_active_low;
1642 gpio_set_value(udc->board.pullup_pin, active);
1644 gpio_set_value(udc->board.pullup_pin, !active);
1647 static const struct at91_udc_caps at91rm9200_udc_caps = {
1648 .init = at91rm9200_udc_init,
1649 .pullup = at91rm9200_udc_pullup,
1652 static int at91sam9260_udc_init(struct at91_udc *udc)
1657 for (i = 0; i < NUM_ENDPOINTS; i++) {
1665 ep->maxpacket = 512;
1673 static void at91sam9260_udc_pullup(struct at91_udc *udc, int is_on)
1675 u32 txvc = at91_udp_read(udc, AT91_UDP_TXVC);
1678 txvc |= AT91_UDP_TXVC_PUON;
1680 txvc &= ~AT91_UDP_TXVC_PUON;
1682 at91_udp_write(udc, AT91_UDP_TXVC, txvc);
1685 static const struct at91_udc_caps at91sam9260_udc_caps = {
1686 .init = at91sam9260_udc_init,
1687 .pullup = at91sam9260_udc_pullup,
1690 static int at91sam9261_udc_init(struct at91_udc *udc)
1695 for (i = 0; i < NUM_ENDPOINTS; i++) {
1706 ep->maxpacket = 256;
1711 udc->matrix = syscon_regmap_lookup_by_phandle(udc->pdev->dev.of_node,
1713 return PTR_ERR_OR_ZERO(udc->matrix);
1716 static void at91sam9261_udc_pullup(struct at91_udc *udc, int is_on)
1721 usbpucr = AT91_MATRIX_USBPUCR_PUON;
1723 regmap_update_bits(udc->matrix, AT91SAM9261_MATRIX_USBPUCR,
1724 AT91_MATRIX_USBPUCR_PUON, usbpucr);
1727 static const struct at91_udc_caps at91sam9261_udc_caps = {
1728 .init = at91sam9261_udc_init,
1729 .pullup = at91sam9261_udc_pullup,
1732 static int at91sam9263_udc_init(struct at91_udc *udc)
1737 for (i = 0; i < NUM_ENDPOINTS; i++) {
1749 ep->maxpacket = 256;
1757 static const struct at91_udc_caps at91sam9263_udc_caps = {
1758 .init = at91sam9263_udc_init,
1759 .pullup = at91sam9260_udc_pullup,
1762 static const struct of_device_id at91_udc_dt_ids[] = {
1764 .compatible = "atmel,at91rm9200-udc",
1765 .data = &at91rm9200_udc_caps,
1768 .compatible = "atmel,at91sam9260-udc",
1769 .data = &at91sam9260_udc_caps,
1772 .compatible = "atmel,at91sam9261-udc",
1773 .data = &at91sam9261_udc_caps,
1776 .compatible = "atmel,at91sam9263-udc",
1777 .data = &at91sam9263_udc_caps,
1781 MODULE_DEVICE_TABLE(of, at91_udc_dt_ids);
1783 static void at91udc_of_init(struct at91_udc *udc, struct device_node *np)
1785 struct at91_udc_data *board = &udc->board;
1786 const struct of_device_id *match;
1787 enum of_gpio_flags flags;
1790 if (of_property_read_u32(np, "atmel,vbus-polled", &val) == 0)
1791 board->vbus_polled = 1;
1793 board->vbus_pin = of_get_named_gpio_flags(np, "atmel,vbus-gpio", 0,
1795 board->vbus_active_low = (flags & OF_GPIO_ACTIVE_LOW) ? 1 : 0;
1797 board->pullup_pin = of_get_named_gpio_flags(np, "atmel,pullup-gpio", 0,
1800 board->pullup_active_low = (flags & OF_GPIO_ACTIVE_LOW) ? 1 : 0;
1802 match = of_match_node(at91_udc_dt_ids, np);
1804 udc->caps = match->data;
1807 static int at91udc_probe(struct platform_device *pdev)
1809 struct device *dev = &pdev->dev;
1810 struct at91_udc *udc;
1812 struct resource *res;
1816 udc = devm_kzalloc(dev, sizeof(*udc), GFP_KERNEL);
1820 /* init software state */
1821 udc->gadget.dev.parent = dev;
1822 at91udc_of_init(udc, pdev->dev.of_node);
1825 spin_lock_init(&udc->lock);
1827 udc->gadget.ops = &at91_udc_ops;
1828 udc->gadget.ep0 = &udc->ep[0].ep;
1829 udc->gadget.name = driver_name;
1830 udc->gadget.dev.init_name = "gadget";
1832 for (i = 0; i < NUM_ENDPOINTS; i++) {
1834 ep->ep.name = ep_info[i].name;
1835 ep->ep.caps = ep_info[i].caps;
1836 ep->ep.ops = &at91_ep_ops;
1838 ep->int_mask = BIT(i);
1839 if (i != 0 && i != 3)
1840 ep->is_pingpong = 1;
1843 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1844 udc->udp_baseaddr = devm_ioremap_resource(dev, res);
1845 if (IS_ERR(udc->udp_baseaddr))
1846 return PTR_ERR(udc->udp_baseaddr);
1848 if (udc->caps && udc->caps->init) {
1849 retval = udc->caps->init(udc);
1856 /* get interface and function clocks */
1857 udc->iclk = devm_clk_get(dev, "pclk");
1858 if (IS_ERR(udc->iclk))
1859 return PTR_ERR(udc->iclk);
1861 udc->fclk = devm_clk_get(dev, "hclk");
1862 if (IS_ERR(udc->fclk))
1863 return PTR_ERR(udc->fclk);
1865 /* don't do anything until we have both gadget driver and VBUS */
1866 clk_set_rate(udc->fclk, 48000000);
1867 retval = clk_prepare(udc->fclk);
1871 retval = clk_prepare_enable(udc->iclk);
1873 goto err_unprepare_fclk;
1875 at91_udp_write(udc, AT91_UDP_TXVC, AT91_UDP_TXVC_TXVDIS);
1876 at91_udp_write(udc, AT91_UDP_IDR, 0xffffffff);
1877 /* Clear all pending interrupts - UDP may be used by bootloader. */
1878 at91_udp_write(udc, AT91_UDP_ICR, 0xffffffff);
1879 clk_disable(udc->iclk);
1881 /* request UDC and maybe VBUS irqs */
1882 udc->udp_irq = retval = platform_get_irq(pdev, 0);
1884 goto err_unprepare_iclk;
1885 retval = devm_request_irq(dev, udc->udp_irq, at91_udc_irq, 0,
1888 DBG("request irq %d failed\n", udc->udp_irq);
1889 goto err_unprepare_iclk;
1892 if (gpio_is_valid(udc->board.vbus_pin)) {
1893 retval = devm_gpio_request(dev, udc->board.vbus_pin,
1896 DBG("request vbus pin failed\n");
1897 goto err_unprepare_iclk;
1900 gpio_direction_input(udc->board.vbus_pin);
1903 * Get the initial state of VBUS - we cannot expect
1904 * a pending interrupt.
1906 udc->vbus = gpio_get_value_cansleep(udc->board.vbus_pin) ^
1907 udc->board.vbus_active_low;
1909 if (udc->board.vbus_polled) {
1910 INIT_WORK(&udc->vbus_timer_work, at91_vbus_timer_work);
1911 timer_setup(&udc->vbus_timer, at91_vbus_timer, 0);
1912 mod_timer(&udc->vbus_timer,
1913 jiffies + VBUS_POLL_TIMEOUT);
1915 retval = devm_request_irq(dev,
1916 gpio_to_irq(udc->board.vbus_pin),
1917 at91_vbus_irq, 0, driver_name, udc);
1919 DBG("request vbus irq %d failed\n",
1920 udc->board.vbus_pin);
1921 goto err_unprepare_iclk;
1925 DBG("no VBUS detection, assuming always-on\n");
1928 retval = usb_add_gadget_udc(dev, &udc->gadget);
1930 goto err_unprepare_iclk;
1931 dev_set_drvdata(dev, udc);
1932 device_init_wakeup(dev, 1);
1933 create_debug_file(udc);
1935 INFO("%s version %s\n", driver_name, DRIVER_VERSION);
1939 clk_unprepare(udc->iclk);
1941 clk_unprepare(udc->fclk);
1943 DBG("%s probe failed, %d\n", driver_name, retval);
1948 static int at91udc_remove(struct platform_device *pdev)
1950 struct at91_udc *udc = platform_get_drvdata(pdev);
1951 unsigned long flags;
1955 usb_del_gadget_udc(&udc->gadget);
1959 spin_lock_irqsave(&udc->lock, flags);
1961 spin_unlock_irqrestore(&udc->lock, flags);
1963 device_init_wakeup(&pdev->dev, 0);
1964 remove_debug_file(udc);
1965 clk_unprepare(udc->fclk);
1966 clk_unprepare(udc->iclk);
1972 static int at91udc_suspend(struct platform_device *pdev, pm_message_t mesg)
1974 struct at91_udc *udc = platform_get_drvdata(pdev);
1975 int wake = udc->driver && device_may_wakeup(&pdev->dev);
1976 unsigned long flags;
1978 /* Unless we can act normally to the host (letting it wake us up
1979 * whenever it has work for us) force disconnect. Wakeup requires
1980 * PLLB for USB events (signaling for reset, wakeup, or incoming
1981 * tokens) and VBUS irqs (on systems which support them).
1983 if ((!udc->suspended && udc->addr)
1985 || at91_suspend_entering_slow_clock()) {
1986 spin_lock_irqsave(&udc->lock, flags);
1989 spin_unlock_irqrestore(&udc->lock, flags);
1991 enable_irq_wake(udc->udp_irq);
1993 udc->active_suspend = wake;
1994 if (gpio_is_valid(udc->board.vbus_pin) && !udc->board.vbus_polled && wake)
1995 enable_irq_wake(udc->board.vbus_pin);
1999 static int at91udc_resume(struct platform_device *pdev)
2001 struct at91_udc *udc = platform_get_drvdata(pdev);
2002 unsigned long flags;
2004 if (gpio_is_valid(udc->board.vbus_pin) && !udc->board.vbus_polled &&
2005 udc->active_suspend)
2006 disable_irq_wake(udc->board.vbus_pin);
2008 /* maybe reconnect to host; if so, clocks on */
2009 if (udc->active_suspend)
2010 disable_irq_wake(udc->udp_irq);
2012 spin_lock_irqsave(&udc->lock, flags);
2014 spin_unlock_irqrestore(&udc->lock, flags);
2019 #define at91udc_suspend NULL
2020 #define at91udc_resume NULL
2023 static struct platform_driver at91_udc_driver = {
2024 .remove = at91udc_remove,
2025 .shutdown = at91udc_shutdown,
2026 .suspend = at91udc_suspend,
2027 .resume = at91udc_resume,
2029 .name = (char *) driver_name,
2030 .of_match_table = at91_udc_dt_ids,
2034 module_platform_driver_probe(at91_udc_driver, at91udc_probe);
2036 MODULE_DESCRIPTION("AT91 udc driver");
2037 MODULE_AUTHOR("Thomas Rathbone, David Brownell");
2038 MODULE_LICENSE("GPL");
2039 MODULE_ALIAS("platform:at91_udc");