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 int proc_udc_open(struct inode
*inode
, struct file
*file
)
239 return single_open(file
, proc_udc_show
, PDE_DATA(inode
));
242 static const struct file_operations proc_ops
= {
243 .owner
= THIS_MODULE
,
244 .open
= proc_udc_open
,
247 .release
= single_release
,
250 static void create_debug_file(struct at91_udc
*udc
)
252 udc
->pde
= proc_create_data(debug_filename
, 0, NULL
, &proc_ops
, udc
);
255 static void remove_debug_file(struct at91_udc
*udc
)
258 remove_proc_entry(debug_filename
, NULL
);
263 static inline void create_debug_file(struct at91_udc
*udc
) {}
264 static inline void remove_debug_file(struct at91_udc
*udc
) {}
269 /*-------------------------------------------------------------------------*/
271 static void done(struct at91_ep
*ep
, struct at91_request
*req
, int status
)
273 unsigned stopped
= ep
->stopped
;
274 struct at91_udc
*udc
= ep
->udc
;
276 list_del_init(&req
->queue
);
277 if (req
->req
.status
== -EINPROGRESS
)
278 req
->req
.status
= status
;
280 status
= req
->req
.status
;
281 if (status
&& status
!= -ESHUTDOWN
)
282 VDBG("%s done %p, status %d\n", ep
->ep
.name
, req
, status
);
285 spin_unlock(&udc
->lock
);
286 usb_gadget_giveback_request(&ep
->ep
, &req
->req
);
287 spin_lock(&udc
->lock
);
288 ep
->stopped
= stopped
;
290 /* ep0 is always ready; other endpoints need a non-empty queue */
291 if (list_empty(&ep
->queue
) && ep
->int_mask
!= (1 << 0))
292 at91_udp_write(udc
, AT91_UDP_IDR
, ep
->int_mask
);
295 /*-------------------------------------------------------------------------*/
297 /* bits indicating OUT fifo has data ready */
298 #define RX_DATA_READY (AT91_UDP_RX_DATA_BK0 | AT91_UDP_RX_DATA_BK1)
301 * Endpoint FIFO CSR bits have a mix of bits, making it unsafe to just write
302 * back most of the value you just read (because of side effects, including
303 * bits that may change after reading and before writing).
305 * Except when changing a specific bit, always write values which:
306 * - clear SET_FX bits (setting them could change something)
307 * - set CLR_FX bits (clearing them could change something)
309 * There are also state bits like FORCESTALL, EPEDS, DIR, and EPTYPE
310 * that shouldn't normally be changed.
312 * NOTE at91sam9260 docs mention synch between UDPCK and MCK clock domains,
313 * implying a need to wait for one write to complete (test relevant bits)
314 * before starting the next write. This shouldn't be an issue given how
315 * infrequently we write, except maybe for write-then-read idioms.
317 #define SET_FX (AT91_UDP_TXPKTRDY)
318 #define CLR_FX (RX_DATA_READY | AT91_UDP_RXSETUP \
319 | AT91_UDP_STALLSENT | AT91_UDP_TXCOMP)
321 /* pull OUT packet data from the endpoint's fifo */
322 static int read_fifo (struct at91_ep
*ep
, struct at91_request
*req
)
324 u32 __iomem
*creg
= ep
->creg
;
325 u8 __iomem
*dreg
= ep
->creg
+ (AT91_UDP_FDR(0) - AT91_UDP_CSR(0));
328 unsigned int count
, bufferspace
, is_done
;
330 buf
= req
->req
.buf
+ req
->req
.actual
;
331 bufferspace
= req
->req
.length
- req
->req
.actual
;
334 * there might be nothing to read if ep_queue() calls us,
335 * or if we already emptied both pingpong buffers
338 csr
= __raw_readl(creg
);
339 if ((csr
& RX_DATA_READY
) == 0)
342 count
= (csr
& AT91_UDP_RXBYTECNT
) >> 16;
343 if (count
> ep
->ep
.maxpacket
)
344 count
= ep
->ep
.maxpacket
;
345 if (count
> bufferspace
) {
346 DBG("%s buffer overflow\n", ep
->ep
.name
);
347 req
->req
.status
= -EOVERFLOW
;
350 __raw_readsb(dreg
, buf
, count
);
352 /* release and swap pingpong mem bank */
354 if (ep
->is_pingpong
) {
355 if (ep
->fifo_bank
== 0) {
356 csr
&= ~(SET_FX
| AT91_UDP_RX_DATA_BK0
);
359 csr
&= ~(SET_FX
| AT91_UDP_RX_DATA_BK1
);
363 csr
&= ~(SET_FX
| AT91_UDP_RX_DATA_BK0
);
364 __raw_writel(csr
, creg
);
366 req
->req
.actual
+= count
;
367 is_done
= (count
< ep
->ep
.maxpacket
);
368 if (count
== bufferspace
)
371 PACKET("%s %p out/%d%s\n", ep
->ep
.name
, &req
->req
, count
,
372 is_done
? " (done)" : "");
375 * avoid extra trips through IRQ logic for packets already in
376 * the fifo ... maybe preventing an extra (expensive) OUT-NAK
380 else if (ep
->is_pingpong
) {
382 * One dummy read to delay the code because of a HW glitch:
383 * CSR returns bad RXCOUNT when read too soon after updating
386 csr
= __raw_readl(creg
);
388 bufferspace
-= count
;
396 /* load fifo for an IN packet */
397 static int write_fifo(struct at91_ep
*ep
, struct at91_request
*req
)
399 u32 __iomem
*creg
= ep
->creg
;
400 u32 csr
= __raw_readl(creg
);
401 u8 __iomem
*dreg
= ep
->creg
+ (AT91_UDP_FDR(0) - AT91_UDP_CSR(0));
402 unsigned total
, count
, is_last
;
406 * TODO: allow for writing two packets to the fifo ... that'll
407 * reduce the amount of IN-NAKing, but probably won't affect
408 * throughput much. (Unlike preventing OUT-NAKing!)
412 * If ep_queue() calls us, the queue is empty and possibly in
413 * odd states like TXCOMP not yet cleared (we do it, saving at
414 * least one IRQ) or the fifo not yet being free. Those aren't
415 * issues normally (IRQ handler fast path).
417 if (unlikely(csr
& (AT91_UDP_TXCOMP
| AT91_UDP_TXPKTRDY
))) {
418 if (csr
& AT91_UDP_TXCOMP
) {
420 csr
&= ~(SET_FX
| AT91_UDP_TXCOMP
);
421 __raw_writel(csr
, creg
);
422 csr
= __raw_readl(creg
);
424 if (csr
& AT91_UDP_TXPKTRDY
)
428 buf
= req
->req
.buf
+ req
->req
.actual
;
430 total
= req
->req
.length
- req
->req
.actual
;
431 if (ep
->ep
.maxpacket
< total
) {
432 count
= ep
->ep
.maxpacket
;
436 is_last
= (count
< ep
->ep
.maxpacket
) || !req
->req
.zero
;
440 * Write the packet, maybe it's a ZLP.
442 * NOTE: incrementing req->actual before we receive the ACK means
443 * gadget driver IN bytecounts can be wrong in fault cases. That's
444 * fixable with PIO drivers like this one (save "count" here, and
445 * do the increment later on TX irq), but not for most DMA hardware.
447 * So all gadget drivers must accept that potential error. Some
448 * hardware supports precise fifo status reporting, letting them
449 * recover when the actual bytecount matters (e.g. for USB Test
450 * and Measurement Class devices).
452 __raw_writesb(dreg
, buf
, count
);
454 csr
|= CLR_FX
| AT91_UDP_TXPKTRDY
;
455 __raw_writel(csr
, creg
);
456 req
->req
.actual
+= count
;
458 PACKET("%s %p in/%d%s\n", ep
->ep
.name
, &req
->req
, count
,
459 is_last
? " (done)" : "");
465 static void nuke(struct at91_ep
*ep
, int status
)
467 struct at91_request
*req
;
469 /* terminate any request in the queue */
471 if (list_empty(&ep
->queue
))
474 VDBG("%s %s\n", __func__
, ep
->ep
.name
);
475 while (!list_empty(&ep
->queue
)) {
476 req
= list_entry(ep
->queue
.next
, struct at91_request
, queue
);
477 done(ep
, req
, status
);
481 /*-------------------------------------------------------------------------*/
483 static int at91_ep_enable(struct usb_ep
*_ep
,
484 const struct usb_endpoint_descriptor
*desc
)
486 struct at91_ep
*ep
= container_of(_ep
, struct at91_ep
, ep
);
487 struct at91_udc
*udc
;
493 || !desc
|| _ep
->name
== ep0name
494 || desc
->bDescriptorType
!= USB_DT_ENDPOINT
495 || (maxpacket
= usb_endpoint_maxp(desc
)) == 0
496 || maxpacket
> ep
->maxpacket
) {
497 DBG("bad ep or descriptor\n");
502 if (!udc
->driver
|| udc
->gadget
.speed
== USB_SPEED_UNKNOWN
) {
503 DBG("bogus device state\n");
507 tmp
= usb_endpoint_type(desc
);
509 case USB_ENDPOINT_XFER_CONTROL
:
510 DBG("only one control endpoint\n");
512 case USB_ENDPOINT_XFER_INT
:
516 case USB_ENDPOINT_XFER_BULK
:
525 DBG("bogus maxpacket %d\n", maxpacket
);
527 case USB_ENDPOINT_XFER_ISOC
:
528 if (!ep
->is_pingpong
) {
529 DBG("iso requires double buffering\n");
536 spin_lock_irqsave(&udc
->lock
, flags
);
538 /* initialize endpoint to match this descriptor */
539 ep
->is_in
= usb_endpoint_dir_in(desc
);
540 ep
->is_iso
= (tmp
== USB_ENDPOINT_XFER_ISOC
);
545 tmp
|= AT91_UDP_EPEDS
;
546 __raw_writel(tmp
, ep
->creg
);
548 ep
->ep
.maxpacket
= maxpacket
;
551 * reset/init endpoint fifo. NOTE: leaves fifo_bank alone,
552 * since endpoint resets don't reset hw pingpong state.
554 at91_udp_write(udc
, AT91_UDP_RST_EP
, ep
->int_mask
);
555 at91_udp_write(udc
, AT91_UDP_RST_EP
, 0);
557 spin_unlock_irqrestore(&udc
->lock
, flags
);
561 static int at91_ep_disable (struct usb_ep
* _ep
)
563 struct at91_ep
*ep
= container_of(_ep
, struct at91_ep
, ep
);
564 struct at91_udc
*udc
= ep
->udc
;
567 if (ep
== &ep
->udc
->ep
[0])
570 spin_lock_irqsave(&udc
->lock
, flags
);
572 nuke(ep
, -ESHUTDOWN
);
574 /* restore the endpoint's pristine config */
576 ep
->ep
.maxpacket
= ep
->maxpacket
;
578 /* reset fifos and endpoint */
579 if (ep
->udc
->clocked
) {
580 at91_udp_write(udc
, AT91_UDP_RST_EP
, ep
->int_mask
);
581 at91_udp_write(udc
, AT91_UDP_RST_EP
, 0);
582 __raw_writel(0, ep
->creg
);
585 spin_unlock_irqrestore(&udc
->lock
, flags
);
590 * this is a PIO-only driver, so there's nothing
591 * interesting for request or buffer allocation.
594 static struct usb_request
*
595 at91_ep_alloc_request(struct usb_ep
*_ep
, gfp_t gfp_flags
)
597 struct at91_request
*req
;
599 req
= kzalloc(sizeof (struct at91_request
), gfp_flags
);
603 INIT_LIST_HEAD(&req
->queue
);
607 static void at91_ep_free_request(struct usb_ep
*_ep
, struct usb_request
*_req
)
609 struct at91_request
*req
;
611 req
= container_of(_req
, struct at91_request
, req
);
612 BUG_ON(!list_empty(&req
->queue
));
616 static int at91_ep_queue(struct usb_ep
*_ep
,
617 struct usb_request
*_req
, gfp_t gfp_flags
)
619 struct at91_request
*req
;
621 struct at91_udc
*udc
;
625 req
= container_of(_req
, struct at91_request
, req
);
626 ep
= container_of(_ep
, struct at91_ep
, ep
);
628 if (!_req
|| !_req
->complete
629 || !_req
->buf
|| !list_empty(&req
->queue
)) {
630 DBG("invalid request\n");
634 if (!_ep
|| (!ep
->ep
.desc
&& ep
->ep
.name
!= ep0name
)) {
641 if (!udc
|| !udc
->driver
|| udc
->gadget
.speed
== USB_SPEED_UNKNOWN
) {
642 DBG("invalid device\n");
646 _req
->status
= -EINPROGRESS
;
649 spin_lock_irqsave(&udc
->lock
, flags
);
651 /* try to kickstart any empty and idle queue */
652 if (list_empty(&ep
->queue
) && !ep
->stopped
) {
656 * If this control request has a non-empty DATA stage, this
657 * will start that stage. It works just like a non-control
658 * request (until the status stage starts, maybe early).
660 * If the data stage is empty, then this starts a successful
661 * IN/STATUS stage. (Unsuccessful ones use set_halt.)
663 is_ep0
= (ep
->ep
.name
== ep0name
);
667 if (!udc
->req_pending
) {
673 * defer changing CONFG until after the gadget driver
674 * reconfigures the endpoints.
676 if (udc
->wait_for_config_ack
) {
677 tmp
= at91_udp_read(udc
, AT91_UDP_GLB_STAT
);
678 tmp
^= AT91_UDP_CONFG
;
679 VDBG("toggle config\n");
680 at91_udp_write(udc
, AT91_UDP_GLB_STAT
, tmp
);
682 if (req
->req
.length
== 0) {
684 PACKET("ep0 in/status\n");
686 tmp
= __raw_readl(ep
->creg
);
688 tmp
|= CLR_FX
| AT91_UDP_TXPKTRDY
;
689 __raw_writel(tmp
, ep
->creg
);
690 udc
->req_pending
= 0;
696 status
= write_fifo(ep
, req
);
698 status
= read_fifo(ep
, req
);
700 /* IN/STATUS stage is otherwise triggered by irq */
701 if (status
&& is_ep0
)
707 if (req
&& !status
) {
708 list_add_tail (&req
->queue
, &ep
->queue
);
709 at91_udp_write(udc
, AT91_UDP_IER
, ep
->int_mask
);
712 spin_unlock_irqrestore(&udc
->lock
, flags
);
713 return (status
< 0) ? status
: 0;
716 static int at91_ep_dequeue(struct usb_ep
*_ep
, struct usb_request
*_req
)
719 struct at91_request
*req
;
721 struct at91_udc
*udc
;
723 ep
= container_of(_ep
, struct at91_ep
, ep
);
724 if (!_ep
|| ep
->ep
.name
== ep0name
)
729 spin_lock_irqsave(&udc
->lock
, flags
);
731 /* make sure it's actually queued on this endpoint */
732 list_for_each_entry (req
, &ep
->queue
, queue
) {
733 if (&req
->req
== _req
)
736 if (&req
->req
!= _req
) {
737 spin_unlock_irqrestore(&udc
->lock
, flags
);
741 done(ep
, req
, -ECONNRESET
);
742 spin_unlock_irqrestore(&udc
->lock
, flags
);
746 static int at91_ep_set_halt(struct usb_ep
*_ep
, int value
)
748 struct at91_ep
*ep
= container_of(_ep
, struct at91_ep
, ep
);
749 struct at91_udc
*udc
= ep
->udc
;
755 if (!_ep
|| ep
->is_iso
|| !ep
->udc
->clocked
)
759 spin_lock_irqsave(&udc
->lock
, flags
);
761 csr
= __raw_readl(creg
);
764 * fail with still-busy IN endpoints, ensuring correct sequencing
765 * of data tx then stall. note that the fifo rx bytecount isn't
766 * completely accurate as a tx bytecount.
768 if (ep
->is_in
&& (!list_empty(&ep
->queue
) || (csr
>> 16) != 0))
774 csr
|= AT91_UDP_FORCESTALL
;
775 VDBG("halt %s\n", ep
->ep
.name
);
777 at91_udp_write(udc
, AT91_UDP_RST_EP
, ep
->int_mask
);
778 at91_udp_write(udc
, AT91_UDP_RST_EP
, 0);
779 csr
&= ~AT91_UDP_FORCESTALL
;
781 __raw_writel(csr
, creg
);
784 spin_unlock_irqrestore(&udc
->lock
, flags
);
788 static const struct usb_ep_ops at91_ep_ops
= {
789 .enable
= at91_ep_enable
,
790 .disable
= at91_ep_disable
,
791 .alloc_request
= at91_ep_alloc_request
,
792 .free_request
= at91_ep_free_request
,
793 .queue
= at91_ep_queue
,
794 .dequeue
= at91_ep_dequeue
,
795 .set_halt
= at91_ep_set_halt
,
796 /* there's only imprecise fifo status reporting */
799 /*-------------------------------------------------------------------------*/
801 static int at91_get_frame(struct usb_gadget
*gadget
)
803 struct at91_udc
*udc
= to_udc(gadget
);
805 if (!to_udc(gadget
)->clocked
)
807 return at91_udp_read(udc
, AT91_UDP_FRM_NUM
) & AT91_UDP_NUM
;
810 static int at91_wakeup(struct usb_gadget
*gadget
)
812 struct at91_udc
*udc
= to_udc(gadget
);
814 int status
= -EINVAL
;
817 DBG("%s\n", __func__
);
818 spin_lock_irqsave(&udc
->lock
, flags
);
820 if (!udc
->clocked
|| !udc
->suspended
)
823 /* NOTE: some "early versions" handle ESR differently ... */
825 glbstate
= at91_udp_read(udc
, AT91_UDP_GLB_STAT
);
826 if (!(glbstate
& AT91_UDP_ESR
))
828 glbstate
|= AT91_UDP_ESR
;
829 at91_udp_write(udc
, AT91_UDP_GLB_STAT
, glbstate
);
832 spin_unlock_irqrestore(&udc
->lock
, flags
);
836 /* reinit == restore initial software state */
837 static void udc_reinit(struct at91_udc
*udc
)
841 INIT_LIST_HEAD(&udc
->gadget
.ep_list
);
842 INIT_LIST_HEAD(&udc
->gadget
.ep0
->ep_list
);
843 udc
->gadget
.quirk_stall_not_supp
= 1;
845 for (i
= 0; i
< NUM_ENDPOINTS
; i
++) {
846 struct at91_ep
*ep
= &udc
->ep
[i
];
849 list_add_tail(&ep
->ep
.ep_list
, &udc
->gadget
.ep_list
);
853 usb_ep_set_maxpacket_limit(&ep
->ep
, ep
->maxpacket
);
854 ep
->creg
= (void __iomem
*) udc
->udp_baseaddr
+ AT91_UDP_CSR(i
);
855 /* initialize one queue per endpoint */
856 INIT_LIST_HEAD(&ep
->queue
);
860 static void reset_gadget(struct at91_udc
*udc
)
862 struct usb_gadget_driver
*driver
= udc
->driver
;
865 if (udc
->gadget
.speed
== USB_SPEED_UNKNOWN
)
867 udc
->gadget
.speed
= USB_SPEED_UNKNOWN
;
870 for (i
= 0; i
< NUM_ENDPOINTS
; i
++) {
871 struct at91_ep
*ep
= &udc
->ep
[i
];
874 nuke(ep
, -ESHUTDOWN
);
877 spin_unlock(&udc
->lock
);
878 usb_gadget_udc_reset(&udc
->gadget
, driver
);
879 spin_lock(&udc
->lock
);
885 static void stop_activity(struct at91_udc
*udc
)
887 struct usb_gadget_driver
*driver
= udc
->driver
;
890 if (udc
->gadget
.speed
== USB_SPEED_UNKNOWN
)
892 udc
->gadget
.speed
= USB_SPEED_UNKNOWN
;
895 for (i
= 0; i
< NUM_ENDPOINTS
; i
++) {
896 struct at91_ep
*ep
= &udc
->ep
[i
];
898 nuke(ep
, -ESHUTDOWN
);
901 spin_unlock(&udc
->lock
);
902 driver
->disconnect(&udc
->gadget
);
903 spin_lock(&udc
->lock
);
909 static void clk_on(struct at91_udc
*udc
)
915 clk_enable(udc
->iclk
);
916 clk_enable(udc
->fclk
);
919 static void clk_off(struct at91_udc
*udc
)
924 udc
->gadget
.speed
= USB_SPEED_UNKNOWN
;
925 clk_disable(udc
->fclk
);
926 clk_disable(udc
->iclk
);
930 * activate/deactivate link with host; minimize power usage for
931 * inactive links by cutting clocks and transceiver power.
933 static void pullup(struct at91_udc
*udc
, int is_on
)
935 if (!udc
->enabled
|| !udc
->vbus
)
937 DBG("%sactive\n", is_on
? "" : "in");
941 at91_udp_write(udc
, AT91_UDP_ICR
, AT91_UDP_RXRSM
);
942 at91_udp_write(udc
, AT91_UDP_TXVC
, 0);
945 at91_udp_write(udc
, AT91_UDP_IDR
, AT91_UDP_RXRSM
);
946 at91_udp_write(udc
, AT91_UDP_TXVC
, AT91_UDP_TXVC_TXVDIS
);
950 if (udc
->caps
&& udc
->caps
->pullup
)
951 udc
->caps
->pullup(udc
, is_on
);
954 /* vbus is here! turn everything on that's ready */
955 static int at91_vbus_session(struct usb_gadget
*gadget
, int is_active
)
957 struct at91_udc
*udc
= to_udc(gadget
);
960 /* VDBG("vbus %s\n", is_active ? "on" : "off"); */
961 spin_lock_irqsave(&udc
->lock
, flags
);
962 udc
->vbus
= (is_active
!= 0);
964 pullup(udc
, is_active
);
967 spin_unlock_irqrestore(&udc
->lock
, flags
);
971 static int at91_pullup(struct usb_gadget
*gadget
, int is_on
)
973 struct at91_udc
*udc
= to_udc(gadget
);
976 spin_lock_irqsave(&udc
->lock
, flags
);
977 udc
->enabled
= is_on
= !!is_on
;
979 spin_unlock_irqrestore(&udc
->lock
, flags
);
983 static int at91_set_selfpowered(struct usb_gadget
*gadget
, int is_on
)
985 struct at91_udc
*udc
= to_udc(gadget
);
988 spin_lock_irqsave(&udc
->lock
, flags
);
989 gadget
->is_selfpowered
= (is_on
!= 0);
990 spin_unlock_irqrestore(&udc
->lock
, flags
);
994 static int at91_start(struct usb_gadget
*gadget
,
995 struct usb_gadget_driver
*driver
);
996 static int at91_stop(struct usb_gadget
*gadget
);
998 static const struct usb_gadget_ops at91_udc_ops
= {
999 .get_frame
= at91_get_frame
,
1000 .wakeup
= at91_wakeup
,
1001 .set_selfpowered
= at91_set_selfpowered
,
1002 .vbus_session
= at91_vbus_session
,
1003 .pullup
= at91_pullup
,
1004 .udc_start
= at91_start
,
1005 .udc_stop
= at91_stop
,
1008 * VBUS-powered devices may also also want to support bigger
1009 * power budgets after an appropriate SET_CONFIGURATION.
1011 /* .vbus_power = at91_vbus_power, */
1014 /*-------------------------------------------------------------------------*/
1016 static int handle_ep(struct at91_ep
*ep
)
1018 struct at91_request
*req
;
1019 u32 __iomem
*creg
= ep
->creg
;
1020 u32 csr
= __raw_readl(creg
);
1022 if (!list_empty(&ep
->queue
))
1023 req
= list_entry(ep
->queue
.next
,
1024 struct at91_request
, queue
);
1029 if (csr
& (AT91_UDP_STALLSENT
| AT91_UDP_TXCOMP
)) {
1031 csr
&= ~(SET_FX
| AT91_UDP_STALLSENT
| AT91_UDP_TXCOMP
);
1032 __raw_writel(csr
, creg
);
1035 return write_fifo(ep
, req
);
1038 if (csr
& AT91_UDP_STALLSENT
) {
1039 /* STALLSENT bit == ISOERR */
1040 if (ep
->is_iso
&& req
)
1041 req
->req
.status
= -EILSEQ
;
1043 csr
&= ~(SET_FX
| AT91_UDP_STALLSENT
);
1044 __raw_writel(csr
, creg
);
1045 csr
= __raw_readl(creg
);
1047 if (req
&& (csr
& RX_DATA_READY
))
1048 return read_fifo(ep
, req
);
1055 struct usb_ctrlrequest r
;
1058 static void handle_setup(struct at91_udc
*udc
, struct at91_ep
*ep
, u32 csr
)
1060 u32 __iomem
*creg
= ep
->creg
;
1061 u8 __iomem
*dreg
= ep
->creg
+ (AT91_UDP_FDR(0) - AT91_UDP_CSR(0));
1062 unsigned rxcount
, i
= 0;
1067 /* read and ack SETUP; hard-fail for bogus packets */
1068 rxcount
= (csr
& AT91_UDP_RXBYTECNT
) >> 16;
1069 if (likely(rxcount
== 8)) {
1071 pkt
.raw
[i
++] = __raw_readb(dreg
);
1072 if (pkt
.r
.bRequestType
& USB_DIR_IN
) {
1073 csr
|= AT91_UDP_DIR
;
1076 csr
&= ~AT91_UDP_DIR
;
1080 /* REVISIT this happens sometimes under load; why?? */
1081 ERR("SETUP len %d, csr %08x\n", rxcount
, csr
);
1085 csr
&= ~(SET_FX
| AT91_UDP_RXSETUP
);
1086 __raw_writel(csr
, creg
);
1087 udc
->wait_for_addr_ack
= 0;
1088 udc
->wait_for_config_ack
= 0;
1090 if (unlikely(status
!= 0))
1093 #define w_index le16_to_cpu(pkt.r.wIndex)
1094 #define w_value le16_to_cpu(pkt.r.wValue)
1095 #define w_length le16_to_cpu(pkt.r.wLength)
1097 VDBG("SETUP %02x.%02x v%04x i%04x l%04x\n",
1098 pkt
.r
.bRequestType
, pkt
.r
.bRequest
,
1099 w_value
, w_index
, w_length
);
1102 * A few standard requests get handled here, ones that touch
1103 * hardware ... notably for device and endpoint features.
1105 udc
->req_pending
= 1;
1106 csr
= __raw_readl(creg
);
1109 switch ((pkt
.r
.bRequestType
<< 8) | pkt
.r
.bRequest
) {
1111 case ((USB_TYPE_STANDARD
|USB_RECIP_DEVICE
) << 8)
1112 | USB_REQ_SET_ADDRESS
:
1113 __raw_writel(csr
| AT91_UDP_TXPKTRDY
, creg
);
1114 udc
->addr
= w_value
;
1115 udc
->wait_for_addr_ack
= 1;
1116 udc
->req_pending
= 0;
1117 /* FADDR is set later, when we ack host STATUS */
1120 case ((USB_TYPE_STANDARD
|USB_RECIP_DEVICE
) << 8)
1121 | USB_REQ_SET_CONFIGURATION
:
1122 tmp
= at91_udp_read(udc
, AT91_UDP_GLB_STAT
) & AT91_UDP_CONFG
;
1124 udc
->wait_for_config_ack
= (tmp
== 0);
1126 udc
->wait_for_config_ack
= (tmp
!= 0);
1127 if (udc
->wait_for_config_ack
)
1128 VDBG("wait for config\n");
1129 /* CONFG is toggled later, if gadget driver succeeds */
1133 * Hosts may set or clear remote wakeup status, and
1134 * devices may report they're VBUS powered.
1136 case ((USB_DIR_IN
|USB_TYPE_STANDARD
|USB_RECIP_DEVICE
) << 8)
1137 | USB_REQ_GET_STATUS
:
1138 tmp
= (udc
->gadget
.is_selfpowered
<< USB_DEVICE_SELF_POWERED
);
1139 if (at91_udp_read(udc
, AT91_UDP_GLB_STAT
) & AT91_UDP_ESR
)
1140 tmp
|= (1 << USB_DEVICE_REMOTE_WAKEUP
);
1141 PACKET("get device status\n");
1142 __raw_writeb(tmp
, dreg
);
1143 __raw_writeb(0, dreg
);
1145 /* then STATUS starts later, automatically */
1146 case ((USB_TYPE_STANDARD
|USB_RECIP_DEVICE
) << 8)
1147 | USB_REQ_SET_FEATURE
:
1148 if (w_value
!= USB_DEVICE_REMOTE_WAKEUP
)
1150 tmp
= at91_udp_read(udc
, AT91_UDP_GLB_STAT
);
1151 tmp
|= AT91_UDP_ESR
;
1152 at91_udp_write(udc
, AT91_UDP_GLB_STAT
, tmp
);
1154 case ((USB_TYPE_STANDARD
|USB_RECIP_DEVICE
) << 8)
1155 | USB_REQ_CLEAR_FEATURE
:
1156 if (w_value
!= USB_DEVICE_REMOTE_WAKEUP
)
1158 tmp
= at91_udp_read(udc
, AT91_UDP_GLB_STAT
);
1159 tmp
&= ~AT91_UDP_ESR
;
1160 at91_udp_write(udc
, AT91_UDP_GLB_STAT
, tmp
);
1164 * Interfaces have no feature settings; this is pretty useless.
1165 * we won't even insist the interface exists...
1167 case ((USB_DIR_IN
|USB_TYPE_STANDARD
|USB_RECIP_INTERFACE
) << 8)
1168 | USB_REQ_GET_STATUS
:
1169 PACKET("get interface status\n");
1170 __raw_writeb(0, dreg
);
1171 __raw_writeb(0, dreg
);
1173 /* then STATUS starts later, automatically */
1174 case ((USB_TYPE_STANDARD
|USB_RECIP_INTERFACE
) << 8)
1175 | USB_REQ_SET_FEATURE
:
1176 case ((USB_TYPE_STANDARD
|USB_RECIP_INTERFACE
) << 8)
1177 | USB_REQ_CLEAR_FEATURE
:
1181 * Hosts may clear bulk/intr endpoint halt after the gadget
1182 * driver sets it (not widely used); or set it (for testing)
1184 case ((USB_DIR_IN
|USB_TYPE_STANDARD
|USB_RECIP_ENDPOINT
) << 8)
1185 | USB_REQ_GET_STATUS
:
1186 tmp
= w_index
& USB_ENDPOINT_NUMBER_MASK
;
1188 if (tmp
>= NUM_ENDPOINTS
|| (tmp
&& !ep
->ep
.desc
))
1192 if ((w_index
& USB_DIR_IN
)) {
1195 } else if (ep
->is_in
)
1198 PACKET("get %s status\n", ep
->ep
.name
);
1199 if (__raw_readl(ep
->creg
) & AT91_UDP_FORCESTALL
)
1200 tmp
= (1 << USB_ENDPOINT_HALT
);
1203 __raw_writeb(tmp
, dreg
);
1204 __raw_writeb(0, dreg
);
1206 /* then STATUS starts later, automatically */
1207 case ((USB_TYPE_STANDARD
|USB_RECIP_ENDPOINT
) << 8)
1208 | USB_REQ_SET_FEATURE
:
1209 tmp
= w_index
& USB_ENDPOINT_NUMBER_MASK
;
1211 if (w_value
!= USB_ENDPOINT_HALT
|| tmp
>= NUM_ENDPOINTS
)
1213 if (!ep
->ep
.desc
|| ep
->is_iso
)
1215 if ((w_index
& USB_DIR_IN
)) {
1218 } else if (ep
->is_in
)
1221 tmp
= __raw_readl(ep
->creg
);
1223 tmp
|= CLR_FX
| AT91_UDP_FORCESTALL
;
1224 __raw_writel(tmp
, ep
->creg
);
1226 case ((USB_TYPE_STANDARD
|USB_RECIP_ENDPOINT
) << 8)
1227 | USB_REQ_CLEAR_FEATURE
:
1228 tmp
= w_index
& USB_ENDPOINT_NUMBER_MASK
;
1230 if (w_value
!= USB_ENDPOINT_HALT
|| tmp
>= NUM_ENDPOINTS
)
1234 if (!ep
->ep
.desc
|| ep
->is_iso
)
1236 if ((w_index
& USB_DIR_IN
)) {
1239 } else if (ep
->is_in
)
1242 at91_udp_write(udc
, AT91_UDP_RST_EP
, ep
->int_mask
);
1243 at91_udp_write(udc
, AT91_UDP_RST_EP
, 0);
1244 tmp
= __raw_readl(ep
->creg
);
1246 tmp
&= ~(SET_FX
| AT91_UDP_FORCESTALL
);
1247 __raw_writel(tmp
, ep
->creg
);
1248 if (!list_empty(&ep
->queue
))
1257 /* pass request up to the gadget driver */
1259 spin_unlock(&udc
->lock
);
1260 status
= udc
->driver
->setup(&udc
->gadget
, &pkt
.r
);
1261 spin_lock(&udc
->lock
);
1267 VDBG("req %02x.%02x protocol STALL; stat %d\n",
1268 pkt
.r
.bRequestType
, pkt
.r
.bRequest
, status
);
1269 csr
|= AT91_UDP_FORCESTALL
;
1270 __raw_writel(csr
, creg
);
1271 udc
->req_pending
= 0;
1276 /* immediate successful (IN) STATUS after zero length DATA */
1277 PACKET("ep0 in/status\n");
1279 csr
|= AT91_UDP_TXPKTRDY
;
1280 __raw_writel(csr
, creg
);
1281 udc
->req_pending
= 0;
1284 static void handle_ep0(struct at91_udc
*udc
)
1286 struct at91_ep
*ep0
= &udc
->ep
[0];
1287 u32 __iomem
*creg
= ep0
->creg
;
1288 u32 csr
= __raw_readl(creg
);
1289 struct at91_request
*req
;
1291 if (unlikely(csr
& AT91_UDP_STALLSENT
)) {
1293 udc
->req_pending
= 0;
1295 csr
&= ~(SET_FX
| AT91_UDP_STALLSENT
| AT91_UDP_FORCESTALL
);
1296 __raw_writel(csr
, creg
);
1297 VDBG("ep0 stalled\n");
1298 csr
= __raw_readl(creg
);
1300 if (csr
& AT91_UDP_RXSETUP
) {
1302 udc
->req_pending
= 0;
1303 handle_setup(udc
, ep0
, csr
);
1307 if (list_empty(&ep0
->queue
))
1310 req
= list_entry(ep0
->queue
.next
, struct at91_request
, queue
);
1312 /* host ACKed an IN packet that we sent */
1313 if (csr
& AT91_UDP_TXCOMP
) {
1315 csr
&= ~(SET_FX
| AT91_UDP_TXCOMP
);
1317 /* write more IN DATA? */
1318 if (req
&& ep0
->is_in
) {
1320 udc
->req_pending
= 0;
1324 * - last IN DATA packet (including GET_STATUS)
1325 * - IN/STATUS for OUT DATA
1326 * - IN/STATUS for any zero-length DATA stage
1327 * except for the IN DATA case, the host should send
1328 * an OUT status later, which we'll ack.
1331 udc
->req_pending
= 0;
1332 __raw_writel(csr
, creg
);
1335 * SET_ADDRESS takes effect only after the STATUS
1336 * (to the original address) gets acked.
1338 if (udc
->wait_for_addr_ack
) {
1341 at91_udp_write(udc
, AT91_UDP_FADDR
,
1342 AT91_UDP_FEN
| udc
->addr
);
1343 tmp
= at91_udp_read(udc
, AT91_UDP_GLB_STAT
);
1344 tmp
&= ~AT91_UDP_FADDEN
;
1346 tmp
|= AT91_UDP_FADDEN
;
1347 at91_udp_write(udc
, AT91_UDP_GLB_STAT
, tmp
);
1349 udc
->wait_for_addr_ack
= 0;
1350 VDBG("address %d\n", udc
->addr
);
1355 /* OUT packet arrived ... */
1356 else if (csr
& AT91_UDP_RX_DATA_BK0
) {
1358 csr
&= ~(SET_FX
| AT91_UDP_RX_DATA_BK0
);
1360 /* OUT DATA stage */
1363 if (handle_ep(ep0
)) {
1364 /* send IN/STATUS */
1365 PACKET("ep0 in/status\n");
1366 csr
= __raw_readl(creg
);
1368 csr
|= CLR_FX
| AT91_UDP_TXPKTRDY
;
1369 __raw_writel(csr
, creg
);
1370 udc
->req_pending
= 0;
1372 } else if (udc
->req_pending
) {
1374 * AT91 hardware has a hard time with this
1375 * "deferred response" mode for control-OUT
1376 * transfers. (For control-IN it's fine.)
1378 * The normal solution leaves OUT data in the
1379 * fifo until the gadget driver is ready.
1380 * We couldn't do that here without disabling
1381 * the IRQ that tells about SETUP packets,
1382 * e.g. when the host gets impatient...
1384 * Working around it by copying into a buffer
1385 * would almost be a non-deferred response,
1386 * except that it wouldn't permit reliable
1387 * stalling of the request. Instead, demand
1388 * that gadget drivers not use this mode.
1390 DBG("no control-OUT deferred responses!\n");
1391 __raw_writel(csr
| AT91_UDP_FORCESTALL
, creg
);
1392 udc
->req_pending
= 0;
1395 /* STATUS stage for control-IN; ack. */
1397 PACKET("ep0 out/status ACK\n");
1398 __raw_writel(csr
, creg
);
1400 /* "early" status stage */
1407 static irqreturn_t
at91_udc_irq (int irq
, void *_udc
)
1409 struct at91_udc
*udc
= _udc
;
1411 int disable_clock
= 0;
1412 unsigned long flags
;
1414 spin_lock_irqsave(&udc
->lock
, flags
);
1416 if (!udc
->clocked
) {
1424 status
= at91_udp_read(udc
, AT91_UDP_ISR
)
1425 & at91_udp_read(udc
, AT91_UDP_IMR
);
1429 /* USB reset irq: not maskable */
1430 if (status
& AT91_UDP_ENDBUSRES
) {
1431 at91_udp_write(udc
, AT91_UDP_IDR
, ~MINIMUS_INTERRUPTUS
);
1432 at91_udp_write(udc
, AT91_UDP_IER
, MINIMUS_INTERRUPTUS
);
1433 /* Atmel code clears this irq twice */
1434 at91_udp_write(udc
, AT91_UDP_ICR
, AT91_UDP_ENDBUSRES
);
1435 at91_udp_write(udc
, AT91_UDP_ICR
, AT91_UDP_ENDBUSRES
);
1436 VDBG("end bus reset\n");
1441 at91_udp_write(udc
, AT91_UDP_CSR(0),
1442 AT91_UDP_EPEDS
| AT91_UDP_EPTYPE_CTRL
);
1443 udc
->gadget
.speed
= USB_SPEED_FULL
;
1445 at91_udp_write(udc
, AT91_UDP_IER
, AT91_UDP_EP(0));
1448 * NOTE: this driver keeps clocks off unless the
1449 * USB host is present. That saves power, but for
1450 * boards that don't support VBUS detection, both
1451 * clocks need to be active most of the time.
1454 /* host initiated suspend (3+ms bus idle) */
1455 } else if (status
& AT91_UDP_RXSUSP
) {
1456 at91_udp_write(udc
, AT91_UDP_IDR
, AT91_UDP_RXSUSP
);
1457 at91_udp_write(udc
, AT91_UDP_IER
, AT91_UDP_RXRSM
);
1458 at91_udp_write(udc
, AT91_UDP_ICR
, AT91_UDP_RXSUSP
);
1459 /* VDBG("bus suspend\n"); */
1465 * NOTE: when suspending a VBUS-powered device, the
1466 * gadget driver should switch into slow clock mode
1467 * and then into standby to avoid drawing more than
1468 * 500uA power (2500uA for some high-power configs).
1470 if (udc
->driver
&& udc
->driver
->suspend
) {
1471 spin_unlock(&udc
->lock
);
1472 udc
->driver
->suspend(&udc
->gadget
);
1473 spin_lock(&udc
->lock
);
1476 /* host initiated resume */
1477 } else if (status
& AT91_UDP_RXRSM
) {
1478 at91_udp_write(udc
, AT91_UDP_IDR
, AT91_UDP_RXRSM
);
1479 at91_udp_write(udc
, AT91_UDP_IER
, AT91_UDP_RXSUSP
);
1480 at91_udp_write(udc
, AT91_UDP_ICR
, AT91_UDP_RXRSM
);
1481 /* VDBG("bus resume\n"); */
1482 if (!udc
->suspended
)
1487 * NOTE: for a VBUS-powered device, the gadget driver
1488 * would normally want to switch out of slow clock
1489 * mode into normal mode.
1491 if (udc
->driver
&& udc
->driver
->resume
) {
1492 spin_unlock(&udc
->lock
);
1493 udc
->driver
->resume(&udc
->gadget
);
1494 spin_lock(&udc
->lock
);
1497 /* endpoint IRQs are cleared by handling them */
1501 struct at91_ep
*ep
= &udc
->ep
[1];
1505 for (i
= 1; i
< NUM_ENDPOINTS
; i
++) {
1517 spin_unlock_irqrestore(&udc
->lock
, flags
);
1522 /*-------------------------------------------------------------------------*/
1524 static void at91_vbus_update(struct at91_udc
*udc
, unsigned value
)
1526 value
^= udc
->board
.vbus_active_low
;
1527 if (value
!= udc
->vbus
)
1528 at91_vbus_session(&udc
->gadget
, value
);
1531 static irqreturn_t
at91_vbus_irq(int irq
, void *_udc
)
1533 struct at91_udc
*udc
= _udc
;
1535 /* vbus needs at least brief debouncing */
1537 at91_vbus_update(udc
, gpio_get_value(udc
->board
.vbus_pin
));
1542 static void at91_vbus_timer_work(struct work_struct
*work
)
1544 struct at91_udc
*udc
= container_of(work
, struct at91_udc
,
1547 at91_vbus_update(udc
, gpio_get_value_cansleep(udc
->board
.vbus_pin
));
1549 if (!timer_pending(&udc
->vbus_timer
))
1550 mod_timer(&udc
->vbus_timer
, jiffies
+ VBUS_POLL_TIMEOUT
);
1553 static void at91_vbus_timer(struct timer_list
*t
)
1555 struct at91_udc
*udc
= from_timer(udc
, t
, vbus_timer
);
1558 * If we are polling vbus it is likely that the gpio is on an
1559 * bus such as i2c or spi which may sleep, so schedule some work
1560 * to read the vbus gpio
1562 schedule_work(&udc
->vbus_timer_work
);
1565 static int at91_start(struct usb_gadget
*gadget
,
1566 struct usb_gadget_driver
*driver
)
1568 struct at91_udc
*udc
;
1570 udc
= container_of(gadget
, struct at91_udc
, gadget
);
1571 udc
->driver
= driver
;
1572 udc
->gadget
.dev
.of_node
= udc
->pdev
->dev
.of_node
;
1574 udc
->gadget
.is_selfpowered
= 1;
1579 static int at91_stop(struct usb_gadget
*gadget
)
1581 struct at91_udc
*udc
;
1582 unsigned long flags
;
1584 udc
= container_of(gadget
, struct at91_udc
, gadget
);
1585 spin_lock_irqsave(&udc
->lock
, flags
);
1587 at91_udp_write(udc
, AT91_UDP_IDR
, ~0);
1588 spin_unlock_irqrestore(&udc
->lock
, flags
);
1595 /*-------------------------------------------------------------------------*/
1597 static void at91udc_shutdown(struct platform_device
*dev
)
1599 struct at91_udc
*udc
= platform_get_drvdata(dev
);
1600 unsigned long flags
;
1602 /* force disconnect on reboot */
1603 spin_lock_irqsave(&udc
->lock
, flags
);
1604 pullup(platform_get_drvdata(dev
), 0);
1605 spin_unlock_irqrestore(&udc
->lock
, flags
);
1608 static int at91rm9200_udc_init(struct at91_udc
*udc
)
1614 for (i
= 0; i
< NUM_ENDPOINTS
; i
++) {
1626 ep
->maxpacket
= 256;
1631 if (!gpio_is_valid(udc
->board
.pullup_pin
)) {
1632 DBG("no D+ pullup?\n");
1636 ret
= devm_gpio_request(&udc
->pdev
->dev
, udc
->board
.pullup_pin
,
1639 DBG("D+ pullup is busy\n");
1643 gpio_direction_output(udc
->board
.pullup_pin
,
1644 udc
->board
.pullup_active_low
);
1649 static void at91rm9200_udc_pullup(struct at91_udc
*udc
, int is_on
)
1651 int active
= !udc
->board
.pullup_active_low
;
1654 gpio_set_value(udc
->board
.pullup_pin
, active
);
1656 gpio_set_value(udc
->board
.pullup_pin
, !active
);
1659 static const struct at91_udc_caps at91rm9200_udc_caps
= {
1660 .init
= at91rm9200_udc_init
,
1661 .pullup
= at91rm9200_udc_pullup
,
1664 static int at91sam9260_udc_init(struct at91_udc
*udc
)
1669 for (i
= 0; i
< NUM_ENDPOINTS
; i
++) {
1677 ep
->maxpacket
= 512;
1685 static void at91sam9260_udc_pullup(struct at91_udc
*udc
, int is_on
)
1687 u32 txvc
= at91_udp_read(udc
, AT91_UDP_TXVC
);
1690 txvc
|= AT91_UDP_TXVC_PUON
;
1692 txvc
&= ~AT91_UDP_TXVC_PUON
;
1694 at91_udp_write(udc
, AT91_UDP_TXVC
, txvc
);
1697 static const struct at91_udc_caps at91sam9260_udc_caps
= {
1698 .init
= at91sam9260_udc_init
,
1699 .pullup
= at91sam9260_udc_pullup
,
1702 static int at91sam9261_udc_init(struct at91_udc
*udc
)
1707 for (i
= 0; i
< NUM_ENDPOINTS
; i
++) {
1718 ep
->maxpacket
= 256;
1723 udc
->matrix
= syscon_regmap_lookup_by_phandle(udc
->pdev
->dev
.of_node
,
1725 return PTR_ERR_OR_ZERO(udc
->matrix
);
1728 static void at91sam9261_udc_pullup(struct at91_udc
*udc
, int is_on
)
1733 usbpucr
= AT91_MATRIX_USBPUCR_PUON
;
1735 regmap_update_bits(udc
->matrix
, AT91SAM9261_MATRIX_USBPUCR
,
1736 AT91_MATRIX_USBPUCR_PUON
, usbpucr
);
1739 static const struct at91_udc_caps at91sam9261_udc_caps
= {
1740 .init
= at91sam9261_udc_init
,
1741 .pullup
= at91sam9261_udc_pullup
,
1744 static int at91sam9263_udc_init(struct at91_udc
*udc
)
1749 for (i
= 0; i
< NUM_ENDPOINTS
; i
++) {
1761 ep
->maxpacket
= 256;
1769 static const struct at91_udc_caps at91sam9263_udc_caps
= {
1770 .init
= at91sam9263_udc_init
,
1771 .pullup
= at91sam9260_udc_pullup
,
1774 static const struct of_device_id at91_udc_dt_ids
[] = {
1776 .compatible
= "atmel,at91rm9200-udc",
1777 .data
= &at91rm9200_udc_caps
,
1780 .compatible
= "atmel,at91sam9260-udc",
1781 .data
= &at91sam9260_udc_caps
,
1784 .compatible
= "atmel,at91sam9261-udc",
1785 .data
= &at91sam9261_udc_caps
,
1788 .compatible
= "atmel,at91sam9263-udc",
1789 .data
= &at91sam9263_udc_caps
,
1793 MODULE_DEVICE_TABLE(of
, at91_udc_dt_ids
);
1795 static void at91udc_of_init(struct at91_udc
*udc
, struct device_node
*np
)
1797 struct at91_udc_data
*board
= &udc
->board
;
1798 const struct of_device_id
*match
;
1799 enum of_gpio_flags flags
;
1802 if (of_property_read_u32(np
, "atmel,vbus-polled", &val
) == 0)
1803 board
->vbus_polled
= 1;
1805 board
->vbus_pin
= of_get_named_gpio_flags(np
, "atmel,vbus-gpio", 0,
1807 board
->vbus_active_low
= (flags
& OF_GPIO_ACTIVE_LOW
) ? 1 : 0;
1809 board
->pullup_pin
= of_get_named_gpio_flags(np
, "atmel,pullup-gpio", 0,
1812 board
->pullup_active_low
= (flags
& OF_GPIO_ACTIVE_LOW
) ? 1 : 0;
1814 match
= of_match_node(at91_udc_dt_ids
, np
);
1816 udc
->caps
= match
->data
;
1819 static int at91udc_probe(struct platform_device
*pdev
)
1821 struct device
*dev
= &pdev
->dev
;
1822 struct at91_udc
*udc
;
1824 struct resource
*res
;
1828 udc
= devm_kzalloc(dev
, sizeof(*udc
), GFP_KERNEL
);
1832 /* init software state */
1833 udc
->gadget
.dev
.parent
= dev
;
1834 at91udc_of_init(udc
, pdev
->dev
.of_node
);
1837 spin_lock_init(&udc
->lock
);
1839 udc
->gadget
.ops
= &at91_udc_ops
;
1840 udc
->gadget
.ep0
= &udc
->ep
[0].ep
;
1841 udc
->gadget
.name
= driver_name
;
1842 udc
->gadget
.dev
.init_name
= "gadget";
1844 for (i
= 0; i
< NUM_ENDPOINTS
; i
++) {
1846 ep
->ep
.name
= ep_info
[i
].name
;
1847 ep
->ep
.caps
= ep_info
[i
].caps
;
1848 ep
->ep
.ops
= &at91_ep_ops
;
1850 ep
->int_mask
= BIT(i
);
1851 if (i
!= 0 && i
!= 3)
1852 ep
->is_pingpong
= 1;
1855 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
1856 udc
->udp_baseaddr
= devm_ioremap_resource(dev
, res
);
1857 if (IS_ERR(udc
->udp_baseaddr
))
1858 return PTR_ERR(udc
->udp_baseaddr
);
1860 if (udc
->caps
&& udc
->caps
->init
) {
1861 retval
= udc
->caps
->init(udc
);
1868 /* get interface and function clocks */
1869 udc
->iclk
= devm_clk_get(dev
, "pclk");
1870 if (IS_ERR(udc
->iclk
))
1871 return PTR_ERR(udc
->iclk
);
1873 udc
->fclk
= devm_clk_get(dev
, "hclk");
1874 if (IS_ERR(udc
->fclk
))
1875 return PTR_ERR(udc
->fclk
);
1877 /* don't do anything until we have both gadget driver and VBUS */
1878 clk_set_rate(udc
->fclk
, 48000000);
1879 retval
= clk_prepare(udc
->fclk
);
1883 retval
= clk_prepare_enable(udc
->iclk
);
1885 goto err_unprepare_fclk
;
1887 at91_udp_write(udc
, AT91_UDP_TXVC
, AT91_UDP_TXVC_TXVDIS
);
1888 at91_udp_write(udc
, AT91_UDP_IDR
, 0xffffffff);
1889 /* Clear all pending interrupts - UDP may be used by bootloader. */
1890 at91_udp_write(udc
, AT91_UDP_ICR
, 0xffffffff);
1891 clk_disable(udc
->iclk
);
1893 /* request UDC and maybe VBUS irqs */
1894 udc
->udp_irq
= platform_get_irq(pdev
, 0);
1895 retval
= devm_request_irq(dev
, udc
->udp_irq
, at91_udc_irq
, 0,
1898 DBG("request irq %d failed\n", udc
->udp_irq
);
1899 goto err_unprepare_iclk
;
1902 if (gpio_is_valid(udc
->board
.vbus_pin
)) {
1903 retval
= devm_gpio_request(dev
, udc
->board
.vbus_pin
,
1906 DBG("request vbus pin failed\n");
1907 goto err_unprepare_iclk
;
1910 gpio_direction_input(udc
->board
.vbus_pin
);
1913 * Get the initial state of VBUS - we cannot expect
1914 * a pending interrupt.
1916 udc
->vbus
= gpio_get_value_cansleep(udc
->board
.vbus_pin
) ^
1917 udc
->board
.vbus_active_low
;
1919 if (udc
->board
.vbus_polled
) {
1920 INIT_WORK(&udc
->vbus_timer_work
, at91_vbus_timer_work
);
1921 timer_setup(&udc
->vbus_timer
, at91_vbus_timer
, 0);
1922 mod_timer(&udc
->vbus_timer
,
1923 jiffies
+ VBUS_POLL_TIMEOUT
);
1925 retval
= devm_request_irq(dev
,
1926 gpio_to_irq(udc
->board
.vbus_pin
),
1927 at91_vbus_irq
, 0, driver_name
, udc
);
1929 DBG("request vbus irq %d failed\n",
1930 udc
->board
.vbus_pin
);
1931 goto err_unprepare_iclk
;
1935 DBG("no VBUS detection, assuming always-on\n");
1938 retval
= usb_add_gadget_udc(dev
, &udc
->gadget
);
1940 goto err_unprepare_iclk
;
1941 dev_set_drvdata(dev
, udc
);
1942 device_init_wakeup(dev
, 1);
1943 create_debug_file(udc
);
1945 INFO("%s version %s\n", driver_name
, DRIVER_VERSION
);
1949 clk_unprepare(udc
->iclk
);
1951 clk_unprepare(udc
->fclk
);
1953 DBG("%s probe failed, %d\n", driver_name
, retval
);
1958 static int at91udc_remove(struct platform_device
*pdev
)
1960 struct at91_udc
*udc
= platform_get_drvdata(pdev
);
1961 unsigned long flags
;
1965 usb_del_gadget_udc(&udc
->gadget
);
1969 spin_lock_irqsave(&udc
->lock
, flags
);
1971 spin_unlock_irqrestore(&udc
->lock
, flags
);
1973 device_init_wakeup(&pdev
->dev
, 0);
1974 remove_debug_file(udc
);
1975 clk_unprepare(udc
->fclk
);
1976 clk_unprepare(udc
->iclk
);
1982 static int at91udc_suspend(struct platform_device
*pdev
, pm_message_t mesg
)
1984 struct at91_udc
*udc
= platform_get_drvdata(pdev
);
1985 int wake
= udc
->driver
&& device_may_wakeup(&pdev
->dev
);
1986 unsigned long flags
;
1988 /* Unless we can act normally to the host (letting it wake us up
1989 * whenever it has work for us) force disconnect. Wakeup requires
1990 * PLLB for USB events (signaling for reset, wakeup, or incoming
1991 * tokens) and VBUS irqs (on systems which support them).
1993 if ((!udc
->suspended
&& udc
->addr
)
1995 || at91_suspend_entering_slow_clock()) {
1996 spin_lock_irqsave(&udc
->lock
, flags
);
1999 spin_unlock_irqrestore(&udc
->lock
, flags
);
2001 enable_irq_wake(udc
->udp_irq
);
2003 udc
->active_suspend
= wake
;
2004 if (gpio_is_valid(udc
->board
.vbus_pin
) && !udc
->board
.vbus_polled
&& wake
)
2005 enable_irq_wake(udc
->board
.vbus_pin
);
2009 static int at91udc_resume(struct platform_device
*pdev
)
2011 struct at91_udc
*udc
= platform_get_drvdata(pdev
);
2012 unsigned long flags
;
2014 if (gpio_is_valid(udc
->board
.vbus_pin
) && !udc
->board
.vbus_polled
&&
2015 udc
->active_suspend
)
2016 disable_irq_wake(udc
->board
.vbus_pin
);
2018 /* maybe reconnect to host; if so, clocks on */
2019 if (udc
->active_suspend
)
2020 disable_irq_wake(udc
->udp_irq
);
2022 spin_lock_irqsave(&udc
->lock
, flags
);
2024 spin_unlock_irqrestore(&udc
->lock
, flags
);
2029 #define at91udc_suspend NULL
2030 #define at91udc_resume NULL
2033 static struct platform_driver at91_udc_driver
= {
2034 .remove
= at91udc_remove
,
2035 .shutdown
= at91udc_shutdown
,
2036 .suspend
= at91udc_suspend
,
2037 .resume
= at91udc_resume
,
2039 .name
= (char *) driver_name
,
2040 .of_match_table
= at91_udc_dt_ids
,
2044 module_platform_driver_probe(at91_udc_driver
, at91udc_probe
);
2046 MODULE_DESCRIPTION("AT91 udc driver");
2047 MODULE_AUTHOR("Thomas Rathbone, David Brownell");
2048 MODULE_LICENSE("GPL");
2049 MODULE_ALIAS("platform:at91_udc");