spi: spi-fsl-qspi: Fix return value check of devm_ioremap() in probe
[linux/fpc-iii.git] / drivers / usb / gadget / udc / at91_udc.c
blobeede5cedacb4a3785000f72439b4145638dbf8b2
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
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
8 */
10 #undef VERBOSE_DEBUG
11 #undef PACKET_TRACE
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>
27 #include <linux/of.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>
34 #include "at91_udc.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";
59 static const struct {
60 const char *name;
61 const struct usb_ep_caps caps;
62 } ep_info[] = {
63 #define EP_INFO(_name, _caps) \
64 { \
65 .name = _name, \
66 .caps = _caps, \
69 EP_INFO("ep0",
70 USB_EP_CAPS(USB_EP_CAPS_TYPE_CONTROL, USB_EP_CAPS_DIR_ALL)),
71 EP_INFO("ep1",
72 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_ALL)),
73 EP_INFO("ep2",
74 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_ALL)),
75 EP_INFO("ep3-int",
76 USB_EP_CAPS(USB_EP_CAPS_TYPE_INT, USB_EP_CAPS_DIR_ALL)),
77 EP_INFO("ep4",
78 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_ALL)),
79 EP_INFO("ep5",
80 USB_EP_CAPS(USB_EP_CAPS_TYPE_ALL, USB_EP_CAPS_DIR_ALL)),
82 #undef EP_INFO
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"};
111 u32 csr;
112 struct at91_request *req;
113 unsigned long flags;
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... */
122 seq_printf(s, "\n");
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" : "",
127 ep->is_pingpong
128 ? (ep->fifo_bank ? "pong" : "ping")
129 : "",
130 ep->stopped ? " stopped" : "");
131 seq_printf(s, "csr %08x rxbytes=%d %s %s %s" EIGHTBITS "\n",
132 csr,
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 */
139 (!(csr & 0x700))
140 ? ((csr & (1 << 7)) ? " IN" : " OUT")
141 : "",
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",
157 &req->req, length,
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)
165 int i;
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++) {
176 if (mask & (1 << i))
177 seq_printf(s, " ep%d", i);
179 seq_printf(s, "\n");
182 static int proc_udc_show(struct seq_file *s, void *unused)
184 struct at91_udc *udc = s->private;
185 struct at91_ep *ep;
186 u32 tmp;
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",
192 udc->enabled
193 ? (udc->vbus ? "active" : "enabled")
194 : "disabled",
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 */
200 if (!udc->clocked) {
201 seq_printf(s, "(not clocked)\n");
202 return 0;
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) {
230 if (ep->ep.desc)
231 proc_ep_show(s, ep);
234 return 0;
237 static void create_debug_file(struct at91_udc *udc)
239 udc->pde = proc_create_single_data(debug_filename, 0, NULL,
240 proc_udc_show, udc);
243 static void remove_debug_file(struct at91_udc *udc)
245 if (udc->pde)
246 remove_proc_entry(debug_filename, NULL);
249 #else
251 static inline void create_debug_file(struct at91_udc *udc) {}
252 static inline void remove_debug_file(struct at91_udc *udc) {}
254 #endif
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;
267 else
268 status = req->req.status;
269 if (status && status != -ESHUTDOWN)
270 VDBG("%s done %p, status %d\n", ep->ep.name, req, status);
272 ep->stopped = 1;
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));
314 u32 csr;
315 u8 *buf;
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
325 rescan:
326 csr = __raw_readl(creg);
327 if ((csr & RX_DATA_READY) == 0)
328 return 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;
336 count = bufferspace;
338 __raw_readsb(dreg, buf, count);
340 /* release and swap pingpong mem bank */
341 csr |= CLR_FX;
342 if (ep->is_pingpong) {
343 if (ep->fifo_bank == 0) {
344 csr &= ~(SET_FX | AT91_UDP_RX_DATA_BK0);
345 ep->fifo_bank = 1;
346 } else {
347 csr &= ~(SET_FX | AT91_UDP_RX_DATA_BK1);
348 ep->fifo_bank = 0;
350 } else
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)
357 is_done = 1;
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
366 if (is_done)
367 done(ep, req, 0);
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
372 * RX_DATA_BK flags.
374 csr = __raw_readl(creg);
376 bufferspace -= count;
377 buf += count;
378 goto rescan;
381 return is_done;
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;
391 u8 *buf;
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) {
407 csr |= CLR_FX;
408 csr &= ~(SET_FX | AT91_UDP_TXCOMP);
409 __raw_writel(csr, creg);
410 csr = __raw_readl(creg);
412 if (csr & AT91_UDP_TXPKTRDY)
413 return 0;
416 buf = req->req.buf + req->req.actual;
417 prefetch(buf);
418 total = req->req.length - req->req.actual;
419 if (ep->ep.maxpacket < total) {
420 count = ep->ep.maxpacket;
421 is_last = 0;
422 } else {
423 count = total;
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);
441 csr &= ~SET_FX;
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)" : "");
448 if (is_last)
449 done(ep, req, 0);
450 return is_last;
453 static void nuke(struct at91_ep *ep, int status)
455 struct at91_request *req;
457 /* terminate any request in the queue */
458 ep->stopped = 1;
459 if (list_empty(&ep->queue))
460 return;
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;
476 u16 maxpacket;
477 u32 tmp;
478 unsigned long flags;
480 if (!_ep || !ep
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");
486 return -EINVAL;
489 udc = ep->udc;
490 if (!udc->driver || udc->gadget.speed == USB_SPEED_UNKNOWN) {
491 DBG("bogus device state\n");
492 return -ESHUTDOWN;
495 tmp = usb_endpoint_type(desc);
496 switch (tmp) {
497 case USB_ENDPOINT_XFER_CONTROL:
498 DBG("only one control endpoint\n");
499 return -EINVAL;
500 case USB_ENDPOINT_XFER_INT:
501 if (maxpacket > 64)
502 goto bogus_max;
503 break;
504 case USB_ENDPOINT_XFER_BULK:
505 switch (maxpacket) {
506 case 8:
507 case 16:
508 case 32:
509 case 64:
510 goto ok;
512 bogus_max:
513 DBG("bogus maxpacket %d\n", maxpacket);
514 return -EINVAL;
515 case USB_ENDPOINT_XFER_ISOC:
516 if (!ep->is_pingpong) {
517 DBG("iso requires double buffering\n");
518 return -EINVAL;
520 break;
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);
529 ep->stopped = 0;
530 if (ep->is_in)
531 tmp |= 0x04;
532 tmp <<= 8;
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);
546 return 0;
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;
553 unsigned long flags;
555 if (ep == &ep->udc->ep[0])
556 return -EINVAL;
558 spin_lock_irqsave(&udc->lock, flags);
560 nuke(ep, -ESHUTDOWN);
562 /* restore the endpoint's pristine config */
563 ep->ep.desc = NULL;
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);
574 return 0;
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);
588 if (!req)
589 return NULL;
591 INIT_LIST_HEAD(&req->queue);
592 return &req->req;
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));
601 kfree(req);
604 static int at91_ep_queue(struct usb_ep *_ep,
605 struct usb_request *_req, gfp_t gfp_flags)
607 struct at91_request *req;
608 struct at91_ep *ep;
609 struct at91_udc *udc;
610 int status;
611 unsigned long flags;
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");
619 return -EINVAL;
622 if (!_ep || (!ep->ep.desc && ep->ep.name != ep0name)) {
623 DBG("invalid ep\n");
624 return -EINVAL;
627 udc = ep->udc;
629 if (!udc || !udc->driver || udc->gadget.speed == USB_SPEED_UNKNOWN) {
630 DBG("invalid device\n");
631 return -EINVAL;
634 _req->status = -EINPROGRESS;
635 _req->actual = 0;
637 spin_lock_irqsave(&udc->lock, flags);
639 /* try to kickstart any empty and idle queue */
640 if (list_empty(&ep->queue) && !ep->stopped) {
641 int is_ep0;
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);
652 if (is_ep0) {
653 u32 tmp;
655 if (!udc->req_pending) {
656 status = -EINVAL;
657 goto done;
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) {
671 ep0_in_status:
672 PACKET("ep0 in/status\n");
673 status = 0;
674 tmp = __raw_readl(ep->creg);
675 tmp &= ~SET_FX;
676 tmp |= CLR_FX | AT91_UDP_TXPKTRDY;
677 __raw_writel(tmp, ep->creg);
678 udc->req_pending = 0;
679 goto done;
683 if (ep->is_in)
684 status = write_fifo(ep, req);
685 else {
686 status = read_fifo(ep, req);
688 /* IN/STATUS stage is otherwise triggered by irq */
689 if (status && is_ep0)
690 goto ep0_in_status;
692 } else
693 status = 0;
695 if (req && !status) {
696 list_add_tail (&req->queue, &ep->queue);
697 at91_udp_write(udc, AT91_UDP_IER, ep->int_mask);
699 done:
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)
706 struct at91_ep *ep;
707 struct at91_request *req;
708 unsigned long flags;
709 struct at91_udc *udc;
711 ep = container_of(_ep, struct at91_ep, ep);
712 if (!_ep || ep->ep.name == ep0name)
713 return -EINVAL;
715 udc = ep->udc;
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)
722 break;
724 if (&req->req != _req) {
725 spin_unlock_irqrestore(&udc->lock, flags);
726 return -EINVAL;
729 done(ep, req, -ECONNRESET);
730 spin_unlock_irqrestore(&udc->lock, flags);
731 return 0;
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;
738 u32 __iomem *creg;
739 u32 csr;
740 unsigned long flags;
741 int status = 0;
743 if (!_ep || ep->is_iso || !ep->udc->clocked)
744 return -EINVAL;
746 creg = ep->creg;
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))
757 status = -EAGAIN;
758 else {
759 csr |= CLR_FX;
760 csr &= ~SET_FX;
761 if (value) {
762 csr |= AT91_UDP_FORCESTALL;
763 VDBG("halt %s\n", ep->ep.name);
764 } else {
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);
773 return status;
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)
794 return -EINVAL;
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);
801 u32 glbstate;
802 unsigned long flags;
804 DBG("%s\n", __func__ );
805 spin_lock_irqsave(&udc->lock, flags);
807 if (!udc->clocked || !udc->suspended)
808 goto done;
810 /* NOTE: some "early versions" handle ESR differently ... */
812 glbstate = at91_udp_read(udc, AT91_UDP_GLB_STAT);
813 if (!(glbstate & AT91_UDP_ESR))
814 goto done;
815 glbstate |= AT91_UDP_ESR;
816 at91_udp_write(udc, AT91_UDP_GLB_STAT, glbstate);
818 done:
819 spin_unlock_irqrestore(&udc->lock, flags);
820 return 0;
823 /* reinit == restore initial software state */
824 static void udc_reinit(struct at91_udc *udc)
826 u32 i;
828 INIT_LIST_HEAD(&udc->gadget.ep_list);
829 INIT_LIST_HEAD(&udc->gadget.ep0->ep_list);
830 udc->gadget.quirk_stall_not_supp = 1;
832 for (i = 0; i < NUM_ENDPOINTS; i++) {
833 struct at91_ep *ep = &udc->ep[i];
835 if (i != 0)
836 list_add_tail(&ep->ep.ep_list, &udc->gadget.ep_list);
837 ep->ep.desc = NULL;
838 ep->stopped = 0;
839 ep->fifo_bank = 0;
840 usb_ep_set_maxpacket_limit(&ep->ep, ep->maxpacket);
841 ep->creg = (void __iomem *) udc->udp_baseaddr + AT91_UDP_CSR(i);
842 /* initialize one queue per endpoint */
843 INIT_LIST_HEAD(&ep->queue);
847 static void reset_gadget(struct at91_udc *udc)
849 struct usb_gadget_driver *driver = udc->driver;
850 int i;
852 if (udc->gadget.speed == USB_SPEED_UNKNOWN)
853 driver = NULL;
854 udc->gadget.speed = USB_SPEED_UNKNOWN;
855 udc->suspended = 0;
857 for (i = 0; i < NUM_ENDPOINTS; i++) {
858 struct at91_ep *ep = &udc->ep[i];
860 ep->stopped = 1;
861 nuke(ep, -ESHUTDOWN);
863 if (driver) {
864 spin_unlock(&udc->lock);
865 usb_gadget_udc_reset(&udc->gadget, driver);
866 spin_lock(&udc->lock);
869 udc_reinit(udc);
872 static void stop_activity(struct at91_udc *udc)
874 struct usb_gadget_driver *driver = udc->driver;
875 int i;
877 if (udc->gadget.speed == USB_SPEED_UNKNOWN)
878 driver = NULL;
879 udc->gadget.speed = USB_SPEED_UNKNOWN;
880 udc->suspended = 0;
882 for (i = 0; i < NUM_ENDPOINTS; i++) {
883 struct at91_ep *ep = &udc->ep[i];
884 ep->stopped = 1;
885 nuke(ep, -ESHUTDOWN);
887 if (driver) {
888 spin_unlock(&udc->lock);
889 driver->disconnect(&udc->gadget);
890 spin_lock(&udc->lock);
893 udc_reinit(udc);
896 static void clk_on(struct at91_udc *udc)
898 if (udc->clocked)
899 return;
900 udc->clocked = 1;
902 clk_enable(udc->iclk);
903 clk_enable(udc->fclk);
906 static void clk_off(struct at91_udc *udc)
908 if (!udc->clocked)
909 return;
910 udc->clocked = 0;
911 udc->gadget.speed = USB_SPEED_UNKNOWN;
912 clk_disable(udc->fclk);
913 clk_disable(udc->iclk);
917 * activate/deactivate link with host; minimize power usage for
918 * inactive links by cutting clocks and transceiver power.
920 static void pullup(struct at91_udc *udc, int is_on)
922 if (!udc->enabled || !udc->vbus)
923 is_on = 0;
924 DBG("%sactive\n", is_on ? "" : "in");
926 if (is_on) {
927 clk_on(udc);
928 at91_udp_write(udc, AT91_UDP_ICR, AT91_UDP_RXRSM);
929 at91_udp_write(udc, AT91_UDP_TXVC, 0);
930 } else {
931 stop_activity(udc);
932 at91_udp_write(udc, AT91_UDP_IDR, AT91_UDP_RXRSM);
933 at91_udp_write(udc, AT91_UDP_TXVC, AT91_UDP_TXVC_TXVDIS);
934 clk_off(udc);
937 if (udc->caps && udc->caps->pullup)
938 udc->caps->pullup(udc, is_on);
941 /* vbus is here! turn everything on that's ready */
942 static int at91_vbus_session(struct usb_gadget *gadget, int is_active)
944 struct at91_udc *udc = to_udc(gadget);
945 unsigned long flags;
947 /* VDBG("vbus %s\n", is_active ? "on" : "off"); */
948 spin_lock_irqsave(&udc->lock, flags);
949 udc->vbus = (is_active != 0);
950 if (udc->driver)
951 pullup(udc, is_active);
952 else
953 pullup(udc, 0);
954 spin_unlock_irqrestore(&udc->lock, flags);
955 return 0;
958 static int at91_pullup(struct usb_gadget *gadget, int is_on)
960 struct at91_udc *udc = to_udc(gadget);
961 unsigned long flags;
963 spin_lock_irqsave(&udc->lock, flags);
964 udc->enabled = is_on = !!is_on;
965 pullup(udc, is_on);
966 spin_unlock_irqrestore(&udc->lock, flags);
967 return 0;
970 static int at91_set_selfpowered(struct usb_gadget *gadget, int is_on)
972 struct at91_udc *udc = to_udc(gadget);
973 unsigned long flags;
975 spin_lock_irqsave(&udc->lock, flags);
976 gadget->is_selfpowered = (is_on != 0);
977 spin_unlock_irqrestore(&udc->lock, flags);
978 return 0;
981 static int at91_start(struct usb_gadget *gadget,
982 struct usb_gadget_driver *driver);
983 static int at91_stop(struct usb_gadget *gadget);
985 static const struct usb_gadget_ops at91_udc_ops = {
986 .get_frame = at91_get_frame,
987 .wakeup = at91_wakeup,
988 .set_selfpowered = at91_set_selfpowered,
989 .vbus_session = at91_vbus_session,
990 .pullup = at91_pullup,
991 .udc_start = at91_start,
992 .udc_stop = at91_stop,
995 * VBUS-powered devices may also also want to support bigger
996 * power budgets after an appropriate SET_CONFIGURATION.
998 /* .vbus_power = at91_vbus_power, */
1001 /*-------------------------------------------------------------------------*/
1003 static int handle_ep(struct at91_ep *ep)
1005 struct at91_request *req;
1006 u32 __iomem *creg = ep->creg;
1007 u32 csr = __raw_readl(creg);
1009 if (!list_empty(&ep->queue))
1010 req = list_entry(ep->queue.next,
1011 struct at91_request, queue);
1012 else
1013 req = NULL;
1015 if (ep->is_in) {
1016 if (csr & (AT91_UDP_STALLSENT | AT91_UDP_TXCOMP)) {
1017 csr |= CLR_FX;
1018 csr &= ~(SET_FX | AT91_UDP_STALLSENT | AT91_UDP_TXCOMP);
1019 __raw_writel(csr, creg);
1021 if (req)
1022 return write_fifo(ep, req);
1024 } else {
1025 if (csr & AT91_UDP_STALLSENT) {
1026 /* STALLSENT bit == ISOERR */
1027 if (ep->is_iso && req)
1028 req->req.status = -EILSEQ;
1029 csr |= CLR_FX;
1030 csr &= ~(SET_FX | AT91_UDP_STALLSENT);
1031 __raw_writel(csr, creg);
1032 csr = __raw_readl(creg);
1034 if (req && (csr & RX_DATA_READY))
1035 return read_fifo(ep, req);
1037 return 0;
1040 union setup {
1041 u8 raw[8];
1042 struct usb_ctrlrequest r;
1045 static void handle_setup(struct at91_udc *udc, struct at91_ep *ep, u32 csr)
1047 u32 __iomem *creg = ep->creg;
1048 u8 __iomem *dreg = ep->creg + (AT91_UDP_FDR(0) - AT91_UDP_CSR(0));
1049 unsigned rxcount, i = 0;
1050 u32 tmp;
1051 union setup pkt;
1052 int status = 0;
1054 /* read and ack SETUP; hard-fail for bogus packets */
1055 rxcount = (csr & AT91_UDP_RXBYTECNT) >> 16;
1056 if (likely(rxcount == 8)) {
1057 while (rxcount--)
1058 pkt.raw[i++] = __raw_readb(dreg);
1059 if (pkt.r.bRequestType & USB_DIR_IN) {
1060 csr |= AT91_UDP_DIR;
1061 ep->is_in = 1;
1062 } else {
1063 csr &= ~AT91_UDP_DIR;
1064 ep->is_in = 0;
1066 } else {
1067 /* REVISIT this happens sometimes under load; why?? */
1068 ERR("SETUP len %d, csr %08x\n", rxcount, csr);
1069 status = -EINVAL;
1071 csr |= CLR_FX;
1072 csr &= ~(SET_FX | AT91_UDP_RXSETUP);
1073 __raw_writel(csr, creg);
1074 udc->wait_for_addr_ack = 0;
1075 udc->wait_for_config_ack = 0;
1076 ep->stopped = 0;
1077 if (unlikely(status != 0))
1078 goto stall;
1080 #define w_index le16_to_cpu(pkt.r.wIndex)
1081 #define w_value le16_to_cpu(pkt.r.wValue)
1082 #define w_length le16_to_cpu(pkt.r.wLength)
1084 VDBG("SETUP %02x.%02x v%04x i%04x l%04x\n",
1085 pkt.r.bRequestType, pkt.r.bRequest,
1086 w_value, w_index, w_length);
1089 * A few standard requests get handled here, ones that touch
1090 * hardware ... notably for device and endpoint features.
1092 udc->req_pending = 1;
1093 csr = __raw_readl(creg);
1094 csr |= CLR_FX;
1095 csr &= ~SET_FX;
1096 switch ((pkt.r.bRequestType << 8) | pkt.r.bRequest) {
1098 case ((USB_TYPE_STANDARD|USB_RECIP_DEVICE) << 8)
1099 | USB_REQ_SET_ADDRESS:
1100 __raw_writel(csr | AT91_UDP_TXPKTRDY, creg);
1101 udc->addr = w_value;
1102 udc->wait_for_addr_ack = 1;
1103 udc->req_pending = 0;
1104 /* FADDR is set later, when we ack host STATUS */
1105 return;
1107 case ((USB_TYPE_STANDARD|USB_RECIP_DEVICE) << 8)
1108 | USB_REQ_SET_CONFIGURATION:
1109 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT) & AT91_UDP_CONFG;
1110 if (pkt.r.wValue)
1111 udc->wait_for_config_ack = (tmp == 0);
1112 else
1113 udc->wait_for_config_ack = (tmp != 0);
1114 if (udc->wait_for_config_ack)
1115 VDBG("wait for config\n");
1116 /* CONFG is toggled later, if gadget driver succeeds */
1117 break;
1120 * Hosts may set or clear remote wakeup status, and
1121 * devices may report they're VBUS powered.
1123 case ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE) << 8)
1124 | USB_REQ_GET_STATUS:
1125 tmp = (udc->gadget.is_selfpowered << USB_DEVICE_SELF_POWERED);
1126 if (at91_udp_read(udc, AT91_UDP_GLB_STAT) & AT91_UDP_ESR)
1127 tmp |= (1 << USB_DEVICE_REMOTE_WAKEUP);
1128 PACKET("get device status\n");
1129 __raw_writeb(tmp, dreg);
1130 __raw_writeb(0, dreg);
1131 goto write_in;
1132 /* then STATUS starts later, automatically */
1133 case ((USB_TYPE_STANDARD|USB_RECIP_DEVICE) << 8)
1134 | USB_REQ_SET_FEATURE:
1135 if (w_value != USB_DEVICE_REMOTE_WAKEUP)
1136 goto stall;
1137 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT);
1138 tmp |= AT91_UDP_ESR;
1139 at91_udp_write(udc, AT91_UDP_GLB_STAT, tmp);
1140 goto succeed;
1141 case ((USB_TYPE_STANDARD|USB_RECIP_DEVICE) << 8)
1142 | USB_REQ_CLEAR_FEATURE:
1143 if (w_value != USB_DEVICE_REMOTE_WAKEUP)
1144 goto stall;
1145 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT);
1146 tmp &= ~AT91_UDP_ESR;
1147 at91_udp_write(udc, AT91_UDP_GLB_STAT, tmp);
1148 goto succeed;
1151 * Interfaces have no feature settings; this is pretty useless.
1152 * we won't even insist the interface exists...
1154 case ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE) << 8)
1155 | USB_REQ_GET_STATUS:
1156 PACKET("get interface status\n");
1157 __raw_writeb(0, dreg);
1158 __raw_writeb(0, dreg);
1159 goto write_in;
1160 /* then STATUS starts later, automatically */
1161 case ((USB_TYPE_STANDARD|USB_RECIP_INTERFACE) << 8)
1162 | USB_REQ_SET_FEATURE:
1163 case ((USB_TYPE_STANDARD|USB_RECIP_INTERFACE) << 8)
1164 | USB_REQ_CLEAR_FEATURE:
1165 goto stall;
1168 * Hosts may clear bulk/intr endpoint halt after the gadget
1169 * driver sets it (not widely used); or set it (for testing)
1171 case ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT) << 8)
1172 | USB_REQ_GET_STATUS:
1173 tmp = w_index & USB_ENDPOINT_NUMBER_MASK;
1174 ep = &udc->ep[tmp];
1175 if (tmp >= NUM_ENDPOINTS || (tmp && !ep->ep.desc))
1176 goto stall;
1178 if (tmp) {
1179 if ((w_index & USB_DIR_IN)) {
1180 if (!ep->is_in)
1181 goto stall;
1182 } else if (ep->is_in)
1183 goto stall;
1185 PACKET("get %s status\n", ep->ep.name);
1186 if (__raw_readl(ep->creg) & AT91_UDP_FORCESTALL)
1187 tmp = (1 << USB_ENDPOINT_HALT);
1188 else
1189 tmp = 0;
1190 __raw_writeb(tmp, dreg);
1191 __raw_writeb(0, dreg);
1192 goto write_in;
1193 /* then STATUS starts later, automatically */
1194 case ((USB_TYPE_STANDARD|USB_RECIP_ENDPOINT) << 8)
1195 | USB_REQ_SET_FEATURE:
1196 tmp = w_index & USB_ENDPOINT_NUMBER_MASK;
1197 ep = &udc->ep[tmp];
1198 if (w_value != USB_ENDPOINT_HALT || tmp >= NUM_ENDPOINTS)
1199 goto stall;
1200 if (!ep->ep.desc || ep->is_iso)
1201 goto stall;
1202 if ((w_index & USB_DIR_IN)) {
1203 if (!ep->is_in)
1204 goto stall;
1205 } else if (ep->is_in)
1206 goto stall;
1208 tmp = __raw_readl(ep->creg);
1209 tmp &= ~SET_FX;
1210 tmp |= CLR_FX | AT91_UDP_FORCESTALL;
1211 __raw_writel(tmp, ep->creg);
1212 goto succeed;
1213 case ((USB_TYPE_STANDARD|USB_RECIP_ENDPOINT) << 8)
1214 | USB_REQ_CLEAR_FEATURE:
1215 tmp = w_index & USB_ENDPOINT_NUMBER_MASK;
1216 ep = &udc->ep[tmp];
1217 if (w_value != USB_ENDPOINT_HALT || tmp >= NUM_ENDPOINTS)
1218 goto stall;
1219 if (tmp == 0)
1220 goto succeed;
1221 if (!ep->ep.desc || ep->is_iso)
1222 goto stall;
1223 if ((w_index & USB_DIR_IN)) {
1224 if (!ep->is_in)
1225 goto stall;
1226 } else if (ep->is_in)
1227 goto stall;
1229 at91_udp_write(udc, AT91_UDP_RST_EP, ep->int_mask);
1230 at91_udp_write(udc, AT91_UDP_RST_EP, 0);
1231 tmp = __raw_readl(ep->creg);
1232 tmp |= CLR_FX;
1233 tmp &= ~(SET_FX | AT91_UDP_FORCESTALL);
1234 __raw_writel(tmp, ep->creg);
1235 if (!list_empty(&ep->queue))
1236 handle_ep(ep);
1237 goto succeed;
1240 #undef w_value
1241 #undef w_index
1242 #undef w_length
1244 /* pass request up to the gadget driver */
1245 if (udc->driver) {
1246 spin_unlock(&udc->lock);
1247 status = udc->driver->setup(&udc->gadget, &pkt.r);
1248 spin_lock(&udc->lock);
1250 else
1251 status = -ENODEV;
1252 if (status < 0) {
1253 stall:
1254 VDBG("req %02x.%02x protocol STALL; stat %d\n",
1255 pkt.r.bRequestType, pkt.r.bRequest, status);
1256 csr |= AT91_UDP_FORCESTALL;
1257 __raw_writel(csr, creg);
1258 udc->req_pending = 0;
1260 return;
1262 succeed:
1263 /* immediate successful (IN) STATUS after zero length DATA */
1264 PACKET("ep0 in/status\n");
1265 write_in:
1266 csr |= AT91_UDP_TXPKTRDY;
1267 __raw_writel(csr, creg);
1268 udc->req_pending = 0;
1271 static void handle_ep0(struct at91_udc *udc)
1273 struct at91_ep *ep0 = &udc->ep[0];
1274 u32 __iomem *creg = ep0->creg;
1275 u32 csr = __raw_readl(creg);
1276 struct at91_request *req;
1278 if (unlikely(csr & AT91_UDP_STALLSENT)) {
1279 nuke(ep0, -EPROTO);
1280 udc->req_pending = 0;
1281 csr |= CLR_FX;
1282 csr &= ~(SET_FX | AT91_UDP_STALLSENT | AT91_UDP_FORCESTALL);
1283 __raw_writel(csr, creg);
1284 VDBG("ep0 stalled\n");
1285 csr = __raw_readl(creg);
1287 if (csr & AT91_UDP_RXSETUP) {
1288 nuke(ep0, 0);
1289 udc->req_pending = 0;
1290 handle_setup(udc, ep0, csr);
1291 return;
1294 if (list_empty(&ep0->queue))
1295 req = NULL;
1296 else
1297 req = list_entry(ep0->queue.next, struct at91_request, queue);
1299 /* host ACKed an IN packet that we sent */
1300 if (csr & AT91_UDP_TXCOMP) {
1301 csr |= CLR_FX;
1302 csr &= ~(SET_FX | AT91_UDP_TXCOMP);
1304 /* write more IN DATA? */
1305 if (req && ep0->is_in) {
1306 if (handle_ep(ep0))
1307 udc->req_pending = 0;
1310 * Ack after:
1311 * - last IN DATA packet (including GET_STATUS)
1312 * - IN/STATUS for OUT DATA
1313 * - IN/STATUS for any zero-length DATA stage
1314 * except for the IN DATA case, the host should send
1315 * an OUT status later, which we'll ack.
1317 } else {
1318 udc->req_pending = 0;
1319 __raw_writel(csr, creg);
1322 * SET_ADDRESS takes effect only after the STATUS
1323 * (to the original address) gets acked.
1325 if (udc->wait_for_addr_ack) {
1326 u32 tmp;
1328 at91_udp_write(udc, AT91_UDP_FADDR,
1329 AT91_UDP_FEN | udc->addr);
1330 tmp = at91_udp_read(udc, AT91_UDP_GLB_STAT);
1331 tmp &= ~AT91_UDP_FADDEN;
1332 if (udc->addr)
1333 tmp |= AT91_UDP_FADDEN;
1334 at91_udp_write(udc, AT91_UDP_GLB_STAT, tmp);
1336 udc->wait_for_addr_ack = 0;
1337 VDBG("address %d\n", udc->addr);
1342 /* OUT packet arrived ... */
1343 else if (csr & AT91_UDP_RX_DATA_BK0) {
1344 csr |= CLR_FX;
1345 csr &= ~(SET_FX | AT91_UDP_RX_DATA_BK0);
1347 /* OUT DATA stage */
1348 if (!ep0->is_in) {
1349 if (req) {
1350 if (handle_ep(ep0)) {
1351 /* send IN/STATUS */
1352 PACKET("ep0 in/status\n");
1353 csr = __raw_readl(creg);
1354 csr &= ~SET_FX;
1355 csr |= CLR_FX | AT91_UDP_TXPKTRDY;
1356 __raw_writel(csr, creg);
1357 udc->req_pending = 0;
1359 } else if (udc->req_pending) {
1361 * AT91 hardware has a hard time with this
1362 * "deferred response" mode for control-OUT
1363 * transfers. (For control-IN it's fine.)
1365 * The normal solution leaves OUT data in the
1366 * fifo until the gadget driver is ready.
1367 * We couldn't do that here without disabling
1368 * the IRQ that tells about SETUP packets,
1369 * e.g. when the host gets impatient...
1371 * Working around it by copying into a buffer
1372 * would almost be a non-deferred response,
1373 * except that it wouldn't permit reliable
1374 * stalling of the request. Instead, demand
1375 * that gadget drivers not use this mode.
1377 DBG("no control-OUT deferred responses!\n");
1378 __raw_writel(csr | AT91_UDP_FORCESTALL, creg);
1379 udc->req_pending = 0;
1382 /* STATUS stage for control-IN; ack. */
1383 } else {
1384 PACKET("ep0 out/status ACK\n");
1385 __raw_writel(csr, creg);
1387 /* "early" status stage */
1388 if (req)
1389 done(ep0, req, 0);
1394 static irqreturn_t at91_udc_irq (int irq, void *_udc)
1396 struct at91_udc *udc = _udc;
1397 u32 rescans = 5;
1398 int disable_clock = 0;
1399 unsigned long flags;
1401 spin_lock_irqsave(&udc->lock, flags);
1403 if (!udc->clocked) {
1404 clk_on(udc);
1405 disable_clock = 1;
1408 while (rescans--) {
1409 u32 status;
1411 status = at91_udp_read(udc, AT91_UDP_ISR)
1412 & at91_udp_read(udc, AT91_UDP_IMR);
1413 if (!status)
1414 break;
1416 /* USB reset irq: not maskable */
1417 if (status & AT91_UDP_ENDBUSRES) {
1418 at91_udp_write(udc, AT91_UDP_IDR, ~MINIMUS_INTERRUPTUS);
1419 at91_udp_write(udc, AT91_UDP_IER, MINIMUS_INTERRUPTUS);
1420 /* Atmel code clears this irq twice */
1421 at91_udp_write(udc, AT91_UDP_ICR, AT91_UDP_ENDBUSRES);
1422 at91_udp_write(udc, AT91_UDP_ICR, AT91_UDP_ENDBUSRES);
1423 VDBG("end bus reset\n");
1424 udc->addr = 0;
1425 reset_gadget(udc);
1427 /* enable ep0 */
1428 at91_udp_write(udc, AT91_UDP_CSR(0),
1429 AT91_UDP_EPEDS | AT91_UDP_EPTYPE_CTRL);
1430 udc->gadget.speed = USB_SPEED_FULL;
1431 udc->suspended = 0;
1432 at91_udp_write(udc, AT91_UDP_IER, AT91_UDP_EP(0));
1435 * NOTE: this driver keeps clocks off unless the
1436 * USB host is present. That saves power, but for
1437 * boards that don't support VBUS detection, both
1438 * clocks need to be active most of the time.
1441 /* host initiated suspend (3+ms bus idle) */
1442 } else if (status & AT91_UDP_RXSUSP) {
1443 at91_udp_write(udc, AT91_UDP_IDR, AT91_UDP_RXSUSP);
1444 at91_udp_write(udc, AT91_UDP_IER, AT91_UDP_RXRSM);
1445 at91_udp_write(udc, AT91_UDP_ICR, AT91_UDP_RXSUSP);
1446 /* VDBG("bus suspend\n"); */
1447 if (udc->suspended)
1448 continue;
1449 udc->suspended = 1;
1452 * NOTE: when suspending a VBUS-powered device, the
1453 * gadget driver should switch into slow clock mode
1454 * and then into standby to avoid drawing more than
1455 * 500uA power (2500uA for some high-power configs).
1457 if (udc->driver && udc->driver->suspend) {
1458 spin_unlock(&udc->lock);
1459 udc->driver->suspend(&udc->gadget);
1460 spin_lock(&udc->lock);
1463 /* host initiated resume */
1464 } else if (status & AT91_UDP_RXRSM) {
1465 at91_udp_write(udc, AT91_UDP_IDR, AT91_UDP_RXRSM);
1466 at91_udp_write(udc, AT91_UDP_IER, AT91_UDP_RXSUSP);
1467 at91_udp_write(udc, AT91_UDP_ICR, AT91_UDP_RXRSM);
1468 /* VDBG("bus resume\n"); */
1469 if (!udc->suspended)
1470 continue;
1471 udc->suspended = 0;
1474 * NOTE: for a VBUS-powered device, the gadget driver
1475 * would normally want to switch out of slow clock
1476 * mode into normal mode.
1478 if (udc->driver && udc->driver->resume) {
1479 spin_unlock(&udc->lock);
1480 udc->driver->resume(&udc->gadget);
1481 spin_lock(&udc->lock);
1484 /* endpoint IRQs are cleared by handling them */
1485 } else {
1486 int i;
1487 unsigned mask = 1;
1488 struct at91_ep *ep = &udc->ep[1];
1490 if (status & mask)
1491 handle_ep0(udc);
1492 for (i = 1; i < NUM_ENDPOINTS; i++) {
1493 mask <<= 1;
1494 if (status & mask)
1495 handle_ep(ep);
1496 ep++;
1501 if (disable_clock)
1502 clk_off(udc);
1504 spin_unlock_irqrestore(&udc->lock, flags);
1506 return IRQ_HANDLED;
1509 /*-------------------------------------------------------------------------*/
1511 static void at91_vbus_update(struct at91_udc *udc, unsigned value)
1513 value ^= udc->board.vbus_active_low;
1514 if (value != udc->vbus)
1515 at91_vbus_session(&udc->gadget, value);
1518 static irqreturn_t at91_vbus_irq(int irq, void *_udc)
1520 struct at91_udc *udc = _udc;
1522 /* vbus needs at least brief debouncing */
1523 udelay(10);
1524 at91_vbus_update(udc, gpio_get_value(udc->board.vbus_pin));
1526 return IRQ_HANDLED;
1529 static void at91_vbus_timer_work(struct work_struct *work)
1531 struct at91_udc *udc = container_of(work, struct at91_udc,
1532 vbus_timer_work);
1534 at91_vbus_update(udc, gpio_get_value_cansleep(udc->board.vbus_pin));
1536 if (!timer_pending(&udc->vbus_timer))
1537 mod_timer(&udc->vbus_timer, jiffies + VBUS_POLL_TIMEOUT);
1540 static void at91_vbus_timer(struct timer_list *t)
1542 struct at91_udc *udc = from_timer(udc, t, vbus_timer);
1545 * If we are polling vbus it is likely that the gpio is on an
1546 * bus such as i2c or spi which may sleep, so schedule some work
1547 * to read the vbus gpio
1549 schedule_work(&udc->vbus_timer_work);
1552 static int at91_start(struct usb_gadget *gadget,
1553 struct usb_gadget_driver *driver)
1555 struct at91_udc *udc;
1557 udc = container_of(gadget, struct at91_udc, gadget);
1558 udc->driver = driver;
1559 udc->gadget.dev.of_node = udc->pdev->dev.of_node;
1560 udc->enabled = 1;
1561 udc->gadget.is_selfpowered = 1;
1563 return 0;
1566 static int at91_stop(struct usb_gadget *gadget)
1568 struct at91_udc *udc;
1569 unsigned long flags;
1571 udc = container_of(gadget, struct at91_udc, gadget);
1572 spin_lock_irqsave(&udc->lock, flags);
1573 udc->enabled = 0;
1574 at91_udp_write(udc, AT91_UDP_IDR, ~0);
1575 spin_unlock_irqrestore(&udc->lock, flags);
1577 udc->driver = NULL;
1579 return 0;
1582 /*-------------------------------------------------------------------------*/
1584 static void at91udc_shutdown(struct platform_device *dev)
1586 struct at91_udc *udc = platform_get_drvdata(dev);
1587 unsigned long flags;
1589 /* force disconnect on reboot */
1590 spin_lock_irqsave(&udc->lock, flags);
1591 pullup(platform_get_drvdata(dev), 0);
1592 spin_unlock_irqrestore(&udc->lock, flags);
1595 static int at91rm9200_udc_init(struct at91_udc *udc)
1597 struct at91_ep *ep;
1598 int ret;
1599 int i;
1601 for (i = 0; i < NUM_ENDPOINTS; i++) {
1602 ep = &udc->ep[i];
1604 switch (i) {
1605 case 0:
1606 case 3:
1607 ep->maxpacket = 8;
1608 break;
1609 case 1 ... 2:
1610 ep->maxpacket = 64;
1611 break;
1612 case 4 ... 5:
1613 ep->maxpacket = 256;
1614 break;
1618 if (!gpio_is_valid(udc->board.pullup_pin)) {
1619 DBG("no D+ pullup?\n");
1620 return -ENODEV;
1623 ret = devm_gpio_request(&udc->pdev->dev, udc->board.pullup_pin,
1624 "udc_pullup");
1625 if (ret) {
1626 DBG("D+ pullup is busy\n");
1627 return ret;
1630 gpio_direction_output(udc->board.pullup_pin,
1631 udc->board.pullup_active_low);
1633 return 0;
1636 static void at91rm9200_udc_pullup(struct at91_udc *udc, int is_on)
1638 int active = !udc->board.pullup_active_low;
1640 if (is_on)
1641 gpio_set_value(udc->board.pullup_pin, active);
1642 else
1643 gpio_set_value(udc->board.pullup_pin, !active);
1646 static const struct at91_udc_caps at91rm9200_udc_caps = {
1647 .init = at91rm9200_udc_init,
1648 .pullup = at91rm9200_udc_pullup,
1651 static int at91sam9260_udc_init(struct at91_udc *udc)
1653 struct at91_ep *ep;
1654 int i;
1656 for (i = 0; i < NUM_ENDPOINTS; i++) {
1657 ep = &udc->ep[i];
1659 switch (i) {
1660 case 0 ... 3:
1661 ep->maxpacket = 64;
1662 break;
1663 case 4 ... 5:
1664 ep->maxpacket = 512;
1665 break;
1669 return 0;
1672 static void at91sam9260_udc_pullup(struct at91_udc *udc, int is_on)
1674 u32 txvc = at91_udp_read(udc, AT91_UDP_TXVC);
1676 if (is_on)
1677 txvc |= AT91_UDP_TXVC_PUON;
1678 else
1679 txvc &= ~AT91_UDP_TXVC_PUON;
1681 at91_udp_write(udc, AT91_UDP_TXVC, txvc);
1684 static const struct at91_udc_caps at91sam9260_udc_caps = {
1685 .init = at91sam9260_udc_init,
1686 .pullup = at91sam9260_udc_pullup,
1689 static int at91sam9261_udc_init(struct at91_udc *udc)
1691 struct at91_ep *ep;
1692 int i;
1694 for (i = 0; i < NUM_ENDPOINTS; i++) {
1695 ep = &udc->ep[i];
1697 switch (i) {
1698 case 0:
1699 ep->maxpacket = 8;
1700 break;
1701 case 1 ... 3:
1702 ep->maxpacket = 64;
1703 break;
1704 case 4 ... 5:
1705 ep->maxpacket = 256;
1706 break;
1710 udc->matrix = syscon_regmap_lookup_by_phandle(udc->pdev->dev.of_node,
1711 "atmel,matrix");
1712 return PTR_ERR_OR_ZERO(udc->matrix);
1715 static void at91sam9261_udc_pullup(struct at91_udc *udc, int is_on)
1717 u32 usbpucr = 0;
1719 if (is_on)
1720 usbpucr = AT91_MATRIX_USBPUCR_PUON;
1722 regmap_update_bits(udc->matrix, AT91SAM9261_MATRIX_USBPUCR,
1723 AT91_MATRIX_USBPUCR_PUON, usbpucr);
1726 static const struct at91_udc_caps at91sam9261_udc_caps = {
1727 .init = at91sam9261_udc_init,
1728 .pullup = at91sam9261_udc_pullup,
1731 static int at91sam9263_udc_init(struct at91_udc *udc)
1733 struct at91_ep *ep;
1734 int i;
1736 for (i = 0; i < NUM_ENDPOINTS; i++) {
1737 ep = &udc->ep[i];
1739 switch (i) {
1740 case 0:
1741 case 1:
1742 case 2:
1743 case 3:
1744 ep->maxpacket = 64;
1745 break;
1746 case 4:
1747 case 5:
1748 ep->maxpacket = 256;
1749 break;
1753 return 0;
1756 static const struct at91_udc_caps at91sam9263_udc_caps = {
1757 .init = at91sam9263_udc_init,
1758 .pullup = at91sam9260_udc_pullup,
1761 static const struct of_device_id at91_udc_dt_ids[] = {
1763 .compatible = "atmel,at91rm9200-udc",
1764 .data = &at91rm9200_udc_caps,
1767 .compatible = "atmel,at91sam9260-udc",
1768 .data = &at91sam9260_udc_caps,
1771 .compatible = "atmel,at91sam9261-udc",
1772 .data = &at91sam9261_udc_caps,
1775 .compatible = "atmel,at91sam9263-udc",
1776 .data = &at91sam9263_udc_caps,
1778 { /* sentinel */ }
1780 MODULE_DEVICE_TABLE(of, at91_udc_dt_ids);
1782 static void at91udc_of_init(struct at91_udc *udc, struct device_node *np)
1784 struct at91_udc_data *board = &udc->board;
1785 const struct of_device_id *match;
1786 enum of_gpio_flags flags;
1787 u32 val;
1789 if (of_property_read_u32(np, "atmel,vbus-polled", &val) == 0)
1790 board->vbus_polled = 1;
1792 board->vbus_pin = of_get_named_gpio_flags(np, "atmel,vbus-gpio", 0,
1793 &flags);
1794 board->vbus_active_low = (flags & OF_GPIO_ACTIVE_LOW) ? 1 : 0;
1796 board->pullup_pin = of_get_named_gpio_flags(np, "atmel,pullup-gpio", 0,
1797 &flags);
1799 board->pullup_active_low = (flags & OF_GPIO_ACTIVE_LOW) ? 1 : 0;
1801 match = of_match_node(at91_udc_dt_ids, np);
1802 if (match)
1803 udc->caps = match->data;
1806 static int at91udc_probe(struct platform_device *pdev)
1808 struct device *dev = &pdev->dev;
1809 struct at91_udc *udc;
1810 int retval;
1811 struct at91_ep *ep;
1812 int i;
1814 udc = devm_kzalloc(dev, sizeof(*udc), GFP_KERNEL);
1815 if (!udc)
1816 return -ENOMEM;
1818 /* init software state */
1819 udc->gadget.dev.parent = dev;
1820 at91udc_of_init(udc, pdev->dev.of_node);
1821 udc->pdev = pdev;
1822 udc->enabled = 0;
1823 spin_lock_init(&udc->lock);
1825 udc->gadget.ops = &at91_udc_ops;
1826 udc->gadget.ep0 = &udc->ep[0].ep;
1827 udc->gadget.name = driver_name;
1828 udc->gadget.dev.init_name = "gadget";
1830 for (i = 0; i < NUM_ENDPOINTS; i++) {
1831 ep = &udc->ep[i];
1832 ep->ep.name = ep_info[i].name;
1833 ep->ep.caps = ep_info[i].caps;
1834 ep->ep.ops = &at91_ep_ops;
1835 ep->udc = udc;
1836 ep->int_mask = BIT(i);
1837 if (i != 0 && i != 3)
1838 ep->is_pingpong = 1;
1841 udc->udp_baseaddr = devm_platform_ioremap_resource(pdev, 0);
1842 if (IS_ERR(udc->udp_baseaddr))
1843 return PTR_ERR(udc->udp_baseaddr);
1845 if (udc->caps && udc->caps->init) {
1846 retval = udc->caps->init(udc);
1847 if (retval)
1848 return retval;
1851 udc_reinit(udc);
1853 /* get interface and function clocks */
1854 udc->iclk = devm_clk_get(dev, "pclk");
1855 if (IS_ERR(udc->iclk))
1856 return PTR_ERR(udc->iclk);
1858 udc->fclk = devm_clk_get(dev, "hclk");
1859 if (IS_ERR(udc->fclk))
1860 return PTR_ERR(udc->fclk);
1862 /* don't do anything until we have both gadget driver and VBUS */
1863 clk_set_rate(udc->fclk, 48000000);
1864 retval = clk_prepare(udc->fclk);
1865 if (retval)
1866 return retval;
1868 retval = clk_prepare_enable(udc->iclk);
1869 if (retval)
1870 goto err_unprepare_fclk;
1872 at91_udp_write(udc, AT91_UDP_TXVC, AT91_UDP_TXVC_TXVDIS);
1873 at91_udp_write(udc, AT91_UDP_IDR, 0xffffffff);
1874 /* Clear all pending interrupts - UDP may be used by bootloader. */
1875 at91_udp_write(udc, AT91_UDP_ICR, 0xffffffff);
1876 clk_disable(udc->iclk);
1878 /* request UDC and maybe VBUS irqs */
1879 udc->udp_irq = platform_get_irq(pdev, 0);
1880 retval = devm_request_irq(dev, udc->udp_irq, at91_udc_irq, 0,
1881 driver_name, udc);
1882 if (retval) {
1883 DBG("request irq %d failed\n", udc->udp_irq);
1884 goto err_unprepare_iclk;
1887 if (gpio_is_valid(udc->board.vbus_pin)) {
1888 retval = devm_gpio_request(dev, udc->board.vbus_pin,
1889 "udc_vbus");
1890 if (retval) {
1891 DBG("request vbus pin failed\n");
1892 goto err_unprepare_iclk;
1895 gpio_direction_input(udc->board.vbus_pin);
1898 * Get the initial state of VBUS - we cannot expect
1899 * a pending interrupt.
1901 udc->vbus = gpio_get_value_cansleep(udc->board.vbus_pin) ^
1902 udc->board.vbus_active_low;
1904 if (udc->board.vbus_polled) {
1905 INIT_WORK(&udc->vbus_timer_work, at91_vbus_timer_work);
1906 timer_setup(&udc->vbus_timer, at91_vbus_timer, 0);
1907 mod_timer(&udc->vbus_timer,
1908 jiffies + VBUS_POLL_TIMEOUT);
1909 } else {
1910 retval = devm_request_irq(dev,
1911 gpio_to_irq(udc->board.vbus_pin),
1912 at91_vbus_irq, 0, driver_name, udc);
1913 if (retval) {
1914 DBG("request vbus irq %d failed\n",
1915 udc->board.vbus_pin);
1916 goto err_unprepare_iclk;
1919 } else {
1920 DBG("no VBUS detection, assuming always-on\n");
1921 udc->vbus = 1;
1923 retval = usb_add_gadget_udc(dev, &udc->gadget);
1924 if (retval)
1925 goto err_unprepare_iclk;
1926 dev_set_drvdata(dev, udc);
1927 device_init_wakeup(dev, 1);
1928 create_debug_file(udc);
1930 INFO("%s version %s\n", driver_name, DRIVER_VERSION);
1931 return 0;
1933 err_unprepare_iclk:
1934 clk_unprepare(udc->iclk);
1935 err_unprepare_fclk:
1936 clk_unprepare(udc->fclk);
1938 DBG("%s probe failed, %d\n", driver_name, retval);
1940 return retval;
1943 static int at91udc_remove(struct platform_device *pdev)
1945 struct at91_udc *udc = platform_get_drvdata(pdev);
1946 unsigned long flags;
1948 DBG("remove\n");
1950 usb_del_gadget_udc(&udc->gadget);
1951 if (udc->driver)
1952 return -EBUSY;
1954 spin_lock_irqsave(&udc->lock, flags);
1955 pullup(udc, 0);
1956 spin_unlock_irqrestore(&udc->lock, flags);
1958 device_init_wakeup(&pdev->dev, 0);
1959 remove_debug_file(udc);
1960 clk_unprepare(udc->fclk);
1961 clk_unprepare(udc->iclk);
1963 return 0;
1966 #ifdef CONFIG_PM
1967 static int at91udc_suspend(struct platform_device *pdev, pm_message_t mesg)
1969 struct at91_udc *udc = platform_get_drvdata(pdev);
1970 int wake = udc->driver && device_may_wakeup(&pdev->dev);
1971 unsigned long flags;
1973 /* Unless we can act normally to the host (letting it wake us up
1974 * whenever it has work for us) force disconnect. Wakeup requires
1975 * PLLB for USB events (signaling for reset, wakeup, or incoming
1976 * tokens) and VBUS irqs (on systems which support them).
1978 if ((!udc->suspended && udc->addr)
1979 || !wake
1980 || at91_suspend_entering_slow_clock()) {
1981 spin_lock_irqsave(&udc->lock, flags);
1982 pullup(udc, 0);
1983 wake = 0;
1984 spin_unlock_irqrestore(&udc->lock, flags);
1985 } else
1986 enable_irq_wake(udc->udp_irq);
1988 udc->active_suspend = wake;
1989 if (gpio_is_valid(udc->board.vbus_pin) && !udc->board.vbus_polled && wake)
1990 enable_irq_wake(udc->board.vbus_pin);
1991 return 0;
1994 static int at91udc_resume(struct platform_device *pdev)
1996 struct at91_udc *udc = platform_get_drvdata(pdev);
1997 unsigned long flags;
1999 if (gpio_is_valid(udc->board.vbus_pin) && !udc->board.vbus_polled &&
2000 udc->active_suspend)
2001 disable_irq_wake(udc->board.vbus_pin);
2003 /* maybe reconnect to host; if so, clocks on */
2004 if (udc->active_suspend)
2005 disable_irq_wake(udc->udp_irq);
2006 else {
2007 spin_lock_irqsave(&udc->lock, flags);
2008 pullup(udc, 1);
2009 spin_unlock_irqrestore(&udc->lock, flags);
2011 return 0;
2013 #else
2014 #define at91udc_suspend NULL
2015 #define at91udc_resume NULL
2016 #endif
2018 static struct platform_driver at91_udc_driver = {
2019 .remove = at91udc_remove,
2020 .shutdown = at91udc_shutdown,
2021 .suspend = at91udc_suspend,
2022 .resume = at91udc_resume,
2023 .driver = {
2024 .name = driver_name,
2025 .of_match_table = at91_udc_dt_ids,
2029 module_platform_driver_probe(at91_udc_driver, at91udc_probe);
2031 MODULE_DESCRIPTION("AT91 udc driver");
2032 MODULE_AUTHOR("Thomas Rathbone, David Brownell");
2033 MODULE_LICENSE("GPL");
2034 MODULE_ALIAS("platform:at91_udc");