2 * at91_udc -- driver for at91-series USB peripheral controller
4 * Copyright (C) 2004 by Thomas Rathbone
5 * Copyright (C) 2005 by HP Labs
6 * Copyright (C) 2005 by David Brownell
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
17 #include <linux/kernel.h>
18 #include <linux/module.h>
19 #include <linux/platform_device.h>
20 #include <linux/delay.h>
21 #include <linux/ioport.h>
22 #include <linux/slab.h>
23 #include <linux/errno.h>
24 #include <linux/list.h>
25 #include <linux/interrupt.h>
26 #include <linux/proc_fs.h>
27 #include <linux/prefetch.h>
28 #include <linux/clk.h>
29 #include <linux/usb/ch9.h>
30 #include <linux/usb/gadget.h>
32 #include <linux/of_gpio.h>
33 #include <linux/platform_data/atmel.h>
35 #include <asm/byteorder.h>
36 #include <mach/hardware.h>
42 #include <mach/at91sam9261_matrix.h>
43 #include <mach/at91_matrix.h>
49 * This controller is simple and PIO-only. It's used in many AT91-series
50 * full speed USB controllers, including the at91rm9200 (arm920T, with MMU),
51 * at91sam926x (arm926ejs, with MMU), and several no-mmu versions.
53 * This driver expects the board has been wired with two GPIOs supporting
54 * a VBUS sensing IRQ, and a D+ pullup. (They may be omitted, but the
55 * testing hasn't covered such cases.)
57 * The pullup is most important (so it's integrated on sam926x parts). It
58 * provides software control over whether the host enumerates the device.
60 * The VBUS sensing helps during enumeration, and allows both USB clocks
61 * (and the transceiver) to stay gated off until they're necessary, saving
62 * power. During USB suspend, the 48 MHz clock is gated off in hardware;
63 * it may also be gated off by software during some Linux sleep states.
66 #define DRIVER_VERSION "3 May 2006"
68 static const char driver_name
[] = "at91_udc";
69 static const char ep0name
[] = "ep0";
71 #define VBUS_POLL_TIMEOUT msecs_to_jiffies(1000)
73 #define at91_udp_read(udc, reg) \
74 __raw_readl((udc)->udp_baseaddr + (reg))
75 #define at91_udp_write(udc, reg, val) \
76 __raw_writel((val), (udc)->udp_baseaddr + (reg))
78 /*-------------------------------------------------------------------------*/
80 #ifdef CONFIG_USB_GADGET_DEBUG_FILES
82 #include <linux/seq_file.h>
84 static const char debug_filename
[] = "driver/udc";
86 #define FOURBITS "%s%s%s%s"
87 #define EIGHTBITS FOURBITS FOURBITS
89 static void proc_ep_show(struct seq_file
*s
, struct at91_ep
*ep
)
91 static char *types
[] = {
92 "control", "out-iso", "out-bulk", "out-int",
93 "BOGUS", "in-iso", "in-bulk", "in-int"};
96 struct at91_request
*req
;
98 struct at91_udc
*udc
= ep
->udc
;
100 spin_lock_irqsave(&udc
->lock
, flags
);
102 csr
= __raw_readl(ep
->creg
);
104 /* NOTE: not collecting per-endpoint irq statistics... */
107 seq_printf(s
, "%s, maxpacket %d %s%s %s%s\n",
108 ep
->ep
.name
, ep
->ep
.maxpacket
,
109 ep
->is_in
? "in" : "out",
110 ep
->is_iso
? " iso" : "",
112 ? (ep
->fifo_bank
? "pong" : "ping")
114 ep
->stopped
? " stopped" : "");
115 seq_printf(s
, "csr %08x rxbytes=%d %s %s %s" EIGHTBITS
"\n",
117 (csr
& 0x07ff0000) >> 16,
118 (csr
& (1 << 15)) ? "enabled" : "disabled",
119 (csr
& (1 << 11)) ? "DATA1" : "DATA0",
120 types
[(csr
& 0x700) >> 8],
122 /* iff type is control then print current direction */
124 ? ((csr
& (1 << 7)) ? " IN" : " OUT")
126 (csr
& (1 << 6)) ? " rxdatabk1" : "",
127 (csr
& (1 << 5)) ? " forcestall" : "",
128 (csr
& (1 << 4)) ? " txpktrdy" : "",
130 (csr
& (1 << 3)) ? " stallsent" : "",
131 (csr
& (1 << 2)) ? " rxsetup" : "",
132 (csr
& (1 << 1)) ? " rxdatabk0" : "",
133 (csr
& (1 << 0)) ? " txcomp" : "");
134 if (list_empty (&ep
->queue
))
135 seq_printf(s
, "\t(queue empty)\n");
137 else list_for_each_entry (req
, &ep
->queue
, queue
) {
138 unsigned length
= req
->req
.actual
;
140 seq_printf(s
, "\treq %p len %d/%d buf %p\n",
142 req
->req
.length
, req
->req
.buf
);
144 spin_unlock_irqrestore(&udc
->lock
, flags
);
147 static void proc_irq_show(struct seq_file
*s
, const char *label
, u32 mask
)
151 seq_printf(s
, "%s %04x:%s%s" FOURBITS
, label
, mask
,
152 (mask
& (1 << 13)) ? " wakeup" : "",
153 (mask
& (1 << 12)) ? " endbusres" : "",
155 (mask
& (1 << 11)) ? " sofint" : "",
156 (mask
& (1 << 10)) ? " extrsm" : "",
157 (mask
& (1 << 9)) ? " rxrsm" : "",
158 (mask
& (1 << 8)) ? " rxsusp" : "");
159 for (i
= 0; i
< 8; i
++) {
161 seq_printf(s
, " ep%d", i
);
166 static int proc_udc_show(struct seq_file
*s
, void *unused
)
168 struct at91_udc
*udc
= s
->private;
172 seq_printf(s
, "%s: version %s\n", driver_name
, DRIVER_VERSION
);
174 seq_printf(s
, "vbus %s, pullup %s, %s powered%s, gadget %s\n\n",
175 udc
->vbus
? "present" : "off",
177 ? (udc
->vbus
? "active" : "enabled")
179 udc
->selfpowered
? "self" : "VBUS",
180 udc
->suspended
? ", suspended" : "",
181 udc
->driver
? udc
->driver
->driver
.name
: "(none)");
183 /* don't access registers when interface isn't clocked */
185 seq_printf(s
, "(not clocked)\n");
189 tmp
= at91_udp_read(udc
, AT91_UDP_FRM_NUM
);
190 seq_printf(s
, "frame %05x:%s%s frame=%d\n", tmp
,
191 (tmp
& AT91_UDP_FRM_OK
) ? " ok" : "",
192 (tmp
& AT91_UDP_FRM_ERR
) ? " err" : "",
193 (tmp
& AT91_UDP_NUM
));
195 tmp
= at91_udp_read(udc
, AT91_UDP_GLB_STAT
);
196 seq_printf(s
, "glbstate %02x:%s" FOURBITS
"\n", tmp
,
197 (tmp
& AT91_UDP_RMWUPE
) ? " rmwupe" : "",
198 (tmp
& AT91_UDP_RSMINPR
) ? " rsminpr" : "",
199 (tmp
& AT91_UDP_ESR
) ? " esr" : "",
200 (tmp
& AT91_UDP_CONFG
) ? " confg" : "",
201 (tmp
& AT91_UDP_FADDEN
) ? " fadden" : "");
203 tmp
= at91_udp_read(udc
, AT91_UDP_FADDR
);
204 seq_printf(s
, "faddr %03x:%s fadd=%d\n", tmp
,
205 (tmp
& AT91_UDP_FEN
) ? " fen" : "",
206 (tmp
& AT91_UDP_FADD
));
208 proc_irq_show(s
, "imr ", at91_udp_read(udc
, AT91_UDP_IMR
));
209 proc_irq_show(s
, "isr ", at91_udp_read(udc
, AT91_UDP_ISR
));
211 if (udc
->enabled
&& udc
->vbus
) {
212 proc_ep_show(s
, &udc
->ep
[0]);
213 list_for_each_entry (ep
, &udc
->gadget
.ep_list
, ep
.ep_list
) {
221 static int proc_udc_open(struct inode
*inode
, struct file
*file
)
223 return single_open(file
, proc_udc_show
, PDE_DATA(inode
));
226 static const struct file_operations proc_ops
= {
227 .owner
= THIS_MODULE
,
228 .open
= proc_udc_open
,
231 .release
= single_release
,
234 static void create_debug_file(struct at91_udc
*udc
)
236 udc
->pde
= proc_create_data(debug_filename
, 0, NULL
, &proc_ops
, udc
);
239 static void remove_debug_file(struct at91_udc
*udc
)
242 remove_proc_entry(debug_filename
, NULL
);
247 static inline void create_debug_file(struct at91_udc
*udc
) {}
248 static inline void remove_debug_file(struct at91_udc
*udc
) {}
253 /*-------------------------------------------------------------------------*/
255 static void done(struct at91_ep
*ep
, struct at91_request
*req
, int status
)
257 unsigned stopped
= ep
->stopped
;
258 struct at91_udc
*udc
= ep
->udc
;
260 list_del_init(&req
->queue
);
261 if (req
->req
.status
== -EINPROGRESS
)
262 req
->req
.status
= status
;
264 status
= req
->req
.status
;
265 if (status
&& status
!= -ESHUTDOWN
)
266 VDBG("%s done %p, status %d\n", ep
->ep
.name
, req
, status
);
269 spin_unlock(&udc
->lock
);
270 usb_gadget_giveback_request(&ep
->ep
, &req
->req
);
271 spin_lock(&udc
->lock
);
272 ep
->stopped
= stopped
;
274 /* ep0 is always ready; other endpoints need a non-empty queue */
275 if (list_empty(&ep
->queue
) && ep
->int_mask
!= (1 << 0))
276 at91_udp_write(udc
, AT91_UDP_IDR
, ep
->int_mask
);
279 /*-------------------------------------------------------------------------*/
281 /* bits indicating OUT fifo has data ready */
282 #define RX_DATA_READY (AT91_UDP_RX_DATA_BK0 | AT91_UDP_RX_DATA_BK1)
285 * Endpoint FIFO CSR bits have a mix of bits, making it unsafe to just write
286 * back most of the value you just read (because of side effects, including
287 * bits that may change after reading and before writing).
289 * Except when changing a specific bit, always write values which:
290 * - clear SET_FX bits (setting them could change something)
291 * - set CLR_FX bits (clearing them could change something)
293 * There are also state bits like FORCESTALL, EPEDS, DIR, and EPTYPE
294 * that shouldn't normally be changed.
296 * NOTE at91sam9260 docs mention synch between UDPCK and MCK clock domains,
297 * implying a need to wait for one write to complete (test relevant bits)
298 * before starting the next write. This shouldn't be an issue given how
299 * infrequently we write, except maybe for write-then-read idioms.
301 #define SET_FX (AT91_UDP_TXPKTRDY)
302 #define CLR_FX (RX_DATA_READY | AT91_UDP_RXSETUP \
303 | AT91_UDP_STALLSENT | AT91_UDP_TXCOMP)
305 /* pull OUT packet data from the endpoint's fifo */
306 static int read_fifo (struct at91_ep
*ep
, struct at91_request
*req
)
308 u32 __iomem
*creg
= ep
->creg
;
309 u8 __iomem
*dreg
= ep
->creg
+ (AT91_UDP_FDR(0) - AT91_UDP_CSR(0));
312 unsigned int count
, bufferspace
, is_done
;
314 buf
= req
->req
.buf
+ req
->req
.actual
;
315 bufferspace
= req
->req
.length
- req
->req
.actual
;
318 * there might be nothing to read if ep_queue() calls us,
319 * or if we already emptied both pingpong buffers
322 csr
= __raw_readl(creg
);
323 if ((csr
& RX_DATA_READY
) == 0)
326 count
= (csr
& AT91_UDP_RXBYTECNT
) >> 16;
327 if (count
> ep
->ep
.maxpacket
)
328 count
= ep
->ep
.maxpacket
;
329 if (count
> bufferspace
) {
330 DBG("%s buffer overflow\n", ep
->ep
.name
);
331 req
->req
.status
= -EOVERFLOW
;
334 __raw_readsb(dreg
, buf
, count
);
336 /* release and swap pingpong mem bank */
338 if (ep
->is_pingpong
) {
339 if (ep
->fifo_bank
== 0) {
340 csr
&= ~(SET_FX
| AT91_UDP_RX_DATA_BK0
);
343 csr
&= ~(SET_FX
| AT91_UDP_RX_DATA_BK1
);
347 csr
&= ~(SET_FX
| AT91_UDP_RX_DATA_BK0
);
348 __raw_writel(csr
, creg
);
350 req
->req
.actual
+= count
;
351 is_done
= (count
< ep
->ep
.maxpacket
);
352 if (count
== bufferspace
)
355 PACKET("%s %p out/%d%s\n", ep
->ep
.name
, &req
->req
, count
,
356 is_done
? " (done)" : "");
359 * avoid extra trips through IRQ logic for packets already in
360 * the fifo ... maybe preventing an extra (expensive) OUT-NAK
364 else if (ep
->is_pingpong
) {
366 * One dummy read to delay the code because of a HW glitch:
367 * CSR returns bad RXCOUNT when read too soon after updating
370 csr
= __raw_readl(creg
);
372 bufferspace
-= count
;
380 /* load fifo for an IN packet */
381 static int write_fifo(struct at91_ep
*ep
, struct at91_request
*req
)
383 u32 __iomem
*creg
= ep
->creg
;
384 u32 csr
= __raw_readl(creg
);
385 u8 __iomem
*dreg
= ep
->creg
+ (AT91_UDP_FDR(0) - AT91_UDP_CSR(0));
386 unsigned total
, count
, is_last
;
390 * TODO: allow for writing two packets to the fifo ... that'll
391 * reduce the amount of IN-NAKing, but probably won't affect
392 * throughput much. (Unlike preventing OUT-NAKing!)
396 * If ep_queue() calls us, the queue is empty and possibly in
397 * odd states like TXCOMP not yet cleared (we do it, saving at
398 * least one IRQ) or the fifo not yet being free. Those aren't
399 * issues normally (IRQ handler fast path).
401 if (unlikely(csr
& (AT91_UDP_TXCOMP
| AT91_UDP_TXPKTRDY
))) {
402 if (csr
& AT91_UDP_TXCOMP
) {
404 csr
&= ~(SET_FX
| AT91_UDP_TXCOMP
);
405 __raw_writel(csr
, creg
);
406 csr
= __raw_readl(creg
);
408 if (csr
& AT91_UDP_TXPKTRDY
)
412 buf
= req
->req
.buf
+ req
->req
.actual
;
414 total
= req
->req
.length
- req
->req
.actual
;
415 if (ep
->ep
.maxpacket
< total
) {
416 count
= ep
->ep
.maxpacket
;
420 is_last
= (count
< ep
->ep
.maxpacket
) || !req
->req
.zero
;
424 * Write the packet, maybe it's a ZLP.
426 * NOTE: incrementing req->actual before we receive the ACK means
427 * gadget driver IN bytecounts can be wrong in fault cases. That's
428 * fixable with PIO drivers like this one (save "count" here, and
429 * do the increment later on TX irq), but not for most DMA hardware.
431 * So all gadget drivers must accept that potential error. Some
432 * hardware supports precise fifo status reporting, letting them
433 * recover when the actual bytecount matters (e.g. for USB Test
434 * and Measurement Class devices).
436 __raw_writesb(dreg
, buf
, count
);
438 csr
|= CLR_FX
| AT91_UDP_TXPKTRDY
;
439 __raw_writel(csr
, creg
);
440 req
->req
.actual
+= count
;
442 PACKET("%s %p in/%d%s\n", ep
->ep
.name
, &req
->req
, count
,
443 is_last
? " (done)" : "");
449 static void nuke(struct at91_ep
*ep
, int status
)
451 struct at91_request
*req
;
453 /* terminate any request in the queue */
455 if (list_empty(&ep
->queue
))
458 VDBG("%s %s\n", __func__
, ep
->ep
.name
);
459 while (!list_empty(&ep
->queue
)) {
460 req
= list_entry(ep
->queue
.next
, struct at91_request
, queue
);
461 done(ep
, req
, status
);
465 /*-------------------------------------------------------------------------*/
467 static int at91_ep_enable(struct usb_ep
*_ep
,
468 const struct usb_endpoint_descriptor
*desc
)
470 struct at91_ep
*ep
= container_of(_ep
, struct at91_ep
, ep
);
471 struct at91_udc
*udc
;
477 || !desc
|| _ep
->name
== ep0name
478 || desc
->bDescriptorType
!= USB_DT_ENDPOINT
479 || (maxpacket
= usb_endpoint_maxp(desc
)) == 0
480 || maxpacket
> ep
->maxpacket
) {
481 DBG("bad ep or descriptor\n");
486 if (!udc
->driver
|| udc
->gadget
.speed
== USB_SPEED_UNKNOWN
) {
487 DBG("bogus device state\n");
491 tmp
= usb_endpoint_type(desc
);
493 case USB_ENDPOINT_XFER_CONTROL
:
494 DBG("only one control endpoint\n");
496 case USB_ENDPOINT_XFER_INT
:
500 case USB_ENDPOINT_XFER_BULK
:
509 DBG("bogus maxpacket %d\n", maxpacket
);
511 case USB_ENDPOINT_XFER_ISOC
:
512 if (!ep
->is_pingpong
) {
513 DBG("iso requires double buffering\n");
520 spin_lock_irqsave(&udc
->lock
, flags
);
522 /* initialize endpoint to match this descriptor */
523 ep
->is_in
= usb_endpoint_dir_in(desc
);
524 ep
->is_iso
= (tmp
== USB_ENDPOINT_XFER_ISOC
);
529 tmp
|= AT91_UDP_EPEDS
;
530 __raw_writel(tmp
, ep
->creg
);
532 ep
->ep
.maxpacket
= maxpacket
;
535 * reset/init endpoint fifo. NOTE: leaves fifo_bank alone,
536 * since endpoint resets don't reset hw pingpong state.
538 at91_udp_write(udc
, AT91_UDP_RST_EP
, ep
->int_mask
);
539 at91_udp_write(udc
, AT91_UDP_RST_EP
, 0);
541 spin_unlock_irqrestore(&udc
->lock
, flags
);
545 static int at91_ep_disable (struct usb_ep
* _ep
)
547 struct at91_ep
*ep
= container_of(_ep
, struct at91_ep
, ep
);
548 struct at91_udc
*udc
= ep
->udc
;
551 if (ep
== &ep
->udc
->ep
[0])
554 spin_lock_irqsave(&udc
->lock
, flags
);
556 nuke(ep
, -ESHUTDOWN
);
558 /* restore the endpoint's pristine config */
560 ep
->ep
.maxpacket
= ep
->maxpacket
;
562 /* reset fifos and endpoint */
563 if (ep
->udc
->clocked
) {
564 at91_udp_write(udc
, AT91_UDP_RST_EP
, ep
->int_mask
);
565 at91_udp_write(udc
, AT91_UDP_RST_EP
, 0);
566 __raw_writel(0, ep
->creg
);
569 spin_unlock_irqrestore(&udc
->lock
, flags
);
574 * this is a PIO-only driver, so there's nothing
575 * interesting for request or buffer allocation.
578 static struct usb_request
*
579 at91_ep_alloc_request(struct usb_ep
*_ep
, gfp_t gfp_flags
)
581 struct at91_request
*req
;
583 req
= kzalloc(sizeof (struct at91_request
), gfp_flags
);
587 INIT_LIST_HEAD(&req
->queue
);
591 static void at91_ep_free_request(struct usb_ep
*_ep
, struct usb_request
*_req
)
593 struct at91_request
*req
;
595 req
= container_of(_req
, struct at91_request
, req
);
596 BUG_ON(!list_empty(&req
->queue
));
600 static int at91_ep_queue(struct usb_ep
*_ep
,
601 struct usb_request
*_req
, gfp_t gfp_flags
)
603 struct at91_request
*req
;
605 struct at91_udc
*udc
;
609 req
= container_of(_req
, struct at91_request
, req
);
610 ep
= container_of(_ep
, struct at91_ep
, ep
);
612 if (!_req
|| !_req
->complete
613 || !_req
->buf
|| !list_empty(&req
->queue
)) {
614 DBG("invalid request\n");
618 if (!_ep
|| (!ep
->ep
.desc
&& ep
->ep
.name
!= ep0name
)) {
625 if (!udc
|| !udc
->driver
|| udc
->gadget
.speed
== USB_SPEED_UNKNOWN
) {
626 DBG("invalid device\n");
630 _req
->status
= -EINPROGRESS
;
633 spin_lock_irqsave(&udc
->lock
, flags
);
635 /* try to kickstart any empty and idle queue */
636 if (list_empty(&ep
->queue
) && !ep
->stopped
) {
640 * If this control request has a non-empty DATA stage, this
641 * will start that stage. It works just like a non-control
642 * request (until the status stage starts, maybe early).
644 * If the data stage is empty, then this starts a successful
645 * IN/STATUS stage. (Unsuccessful ones use set_halt.)
647 is_ep0
= (ep
->ep
.name
== ep0name
);
651 if (!udc
->req_pending
) {
657 * defer changing CONFG until after the gadget driver
658 * reconfigures the endpoints.
660 if (udc
->wait_for_config_ack
) {
661 tmp
= at91_udp_read(udc
, AT91_UDP_GLB_STAT
);
662 tmp
^= AT91_UDP_CONFG
;
663 VDBG("toggle config\n");
664 at91_udp_write(udc
, AT91_UDP_GLB_STAT
, tmp
);
666 if (req
->req
.length
== 0) {
668 PACKET("ep0 in/status\n");
670 tmp
= __raw_readl(ep
->creg
);
672 tmp
|= CLR_FX
| AT91_UDP_TXPKTRDY
;
673 __raw_writel(tmp
, ep
->creg
);
674 udc
->req_pending
= 0;
680 status
= write_fifo(ep
, req
);
682 status
= read_fifo(ep
, req
);
684 /* IN/STATUS stage is otherwise triggered by irq */
685 if (status
&& is_ep0
)
691 if (req
&& !status
) {
692 list_add_tail (&req
->queue
, &ep
->queue
);
693 at91_udp_write(udc
, AT91_UDP_IER
, ep
->int_mask
);
696 spin_unlock_irqrestore(&udc
->lock
, flags
);
697 return (status
< 0) ? status
: 0;
700 static int at91_ep_dequeue(struct usb_ep
*_ep
, struct usb_request
*_req
)
703 struct at91_request
*req
;
705 struct at91_udc
*udc
;
707 ep
= container_of(_ep
, struct at91_ep
, ep
);
708 if (!_ep
|| ep
->ep
.name
== ep0name
)
713 spin_lock_irqsave(&udc
->lock
, flags
);
715 /* make sure it's actually queued on this endpoint */
716 list_for_each_entry (req
, &ep
->queue
, queue
) {
717 if (&req
->req
== _req
)
720 if (&req
->req
!= _req
) {
721 spin_unlock_irqrestore(&udc
->lock
, flags
);
725 done(ep
, req
, -ECONNRESET
);
726 spin_unlock_irqrestore(&udc
->lock
, flags
);
730 static int at91_ep_set_halt(struct usb_ep
*_ep
, int value
)
732 struct at91_ep
*ep
= container_of(_ep
, struct at91_ep
, ep
);
733 struct at91_udc
*udc
= ep
->udc
;
739 if (!_ep
|| ep
->is_iso
|| !ep
->udc
->clocked
)
743 spin_lock_irqsave(&udc
->lock
, flags
);
745 csr
= __raw_readl(creg
);
748 * fail with still-busy IN endpoints, ensuring correct sequencing
749 * of data tx then stall. note that the fifo rx bytecount isn't
750 * completely accurate as a tx bytecount.
752 if (ep
->is_in
&& (!list_empty(&ep
->queue
) || (csr
>> 16) != 0))
758 csr
|= AT91_UDP_FORCESTALL
;
759 VDBG("halt %s\n", ep
->ep
.name
);
761 at91_udp_write(udc
, AT91_UDP_RST_EP
, ep
->int_mask
);
762 at91_udp_write(udc
, AT91_UDP_RST_EP
, 0);
763 csr
&= ~AT91_UDP_FORCESTALL
;
765 __raw_writel(csr
, creg
);
768 spin_unlock_irqrestore(&udc
->lock
, flags
);
772 static const struct usb_ep_ops at91_ep_ops
= {
773 .enable
= at91_ep_enable
,
774 .disable
= at91_ep_disable
,
775 .alloc_request
= at91_ep_alloc_request
,
776 .free_request
= at91_ep_free_request
,
777 .queue
= at91_ep_queue
,
778 .dequeue
= at91_ep_dequeue
,
779 .set_halt
= at91_ep_set_halt
,
780 /* there's only imprecise fifo status reporting */
783 /*-------------------------------------------------------------------------*/
785 static int at91_get_frame(struct usb_gadget
*gadget
)
787 struct at91_udc
*udc
= to_udc(gadget
);
789 if (!to_udc(gadget
)->clocked
)
791 return at91_udp_read(udc
, AT91_UDP_FRM_NUM
) & AT91_UDP_NUM
;
794 static int at91_wakeup(struct usb_gadget
*gadget
)
796 struct at91_udc
*udc
= to_udc(gadget
);
798 int status
= -EINVAL
;
801 DBG("%s\n", __func__
);
802 spin_lock_irqsave(&udc
->lock
, flags
);
804 if (!udc
->clocked
|| !udc
->suspended
)
807 /* NOTE: some "early versions" handle ESR differently ... */
809 glbstate
= at91_udp_read(udc
, AT91_UDP_GLB_STAT
);
810 if (!(glbstate
& AT91_UDP_ESR
))
812 glbstate
|= AT91_UDP_ESR
;
813 at91_udp_write(udc
, AT91_UDP_GLB_STAT
, glbstate
);
816 spin_unlock_irqrestore(&udc
->lock
, flags
);
820 /* reinit == restore initial software state */
821 static void udc_reinit(struct at91_udc
*udc
)
825 INIT_LIST_HEAD(&udc
->gadget
.ep_list
);
826 INIT_LIST_HEAD(&udc
->gadget
.ep0
->ep_list
);
828 for (i
= 0; i
< NUM_ENDPOINTS
; i
++) {
829 struct at91_ep
*ep
= &udc
->ep
[i
];
832 list_add_tail(&ep
->ep
.ep_list
, &udc
->gadget
.ep_list
);
836 usb_ep_set_maxpacket_limit(&ep
->ep
, ep
->maxpacket
);
837 ep
->creg
= (void __iomem
*) udc
->udp_baseaddr
+ AT91_UDP_CSR(i
);
838 /* initialize one queue per endpoint */
839 INIT_LIST_HEAD(&ep
->queue
);
843 static void reset_gadget(struct at91_udc
*udc
)
845 struct usb_gadget_driver
*driver
= udc
->driver
;
848 if (udc
->gadget
.speed
== USB_SPEED_UNKNOWN
)
850 udc
->gadget
.speed
= USB_SPEED_UNKNOWN
;
853 for (i
= 0; i
< NUM_ENDPOINTS
; i
++) {
854 struct at91_ep
*ep
= &udc
->ep
[i
];
857 nuke(ep
, -ESHUTDOWN
);
860 spin_unlock(&udc
->lock
);
861 usb_gadget_udc_reset(&udc
->gadget
, driver
);
862 spin_lock(&udc
->lock
);
868 static void stop_activity(struct at91_udc
*udc
)
870 struct usb_gadget_driver
*driver
= udc
->driver
;
873 if (udc
->gadget
.speed
== USB_SPEED_UNKNOWN
)
875 udc
->gadget
.speed
= USB_SPEED_UNKNOWN
;
878 for (i
= 0; i
< NUM_ENDPOINTS
; i
++) {
879 struct at91_ep
*ep
= &udc
->ep
[i
];
881 nuke(ep
, -ESHUTDOWN
);
884 spin_unlock(&udc
->lock
);
885 driver
->disconnect(&udc
->gadget
);
886 spin_lock(&udc
->lock
);
892 static void clk_on(struct at91_udc
*udc
)
898 if (IS_ENABLED(CONFIG_COMMON_CLK
))
899 clk_enable(udc
->uclk
);
900 clk_enable(udc
->iclk
);
901 clk_enable(udc
->fclk
);
904 static void clk_off(struct at91_udc
*udc
)
909 udc
->gadget
.speed
= USB_SPEED_UNKNOWN
;
910 clk_disable(udc
->fclk
);
911 clk_disable(udc
->iclk
);
912 if (IS_ENABLED(CONFIG_COMMON_CLK
))
913 clk_disable(udc
->uclk
);
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 int active
= !udc
->board
.pullup_active_low
;
924 if (!udc
->enabled
|| !udc
->vbus
)
926 DBG("%sactive\n", is_on
? "" : "in");
930 at91_udp_write(udc
, AT91_UDP_ICR
, AT91_UDP_RXRSM
);
931 at91_udp_write(udc
, AT91_UDP_TXVC
, 0);
932 if (cpu_is_at91rm9200())
933 gpio_set_value(udc
->board
.pullup_pin
, active
);
934 else if (cpu_is_at91sam9260() || cpu_is_at91sam9263() || cpu_is_at91sam9g20()) {
935 u32 txvc
= at91_udp_read(udc
, AT91_UDP_TXVC
);
937 txvc
|= AT91_UDP_TXVC_PUON
;
938 at91_udp_write(udc
, AT91_UDP_TXVC
, txvc
);
939 } else if (cpu_is_at91sam9261() || cpu_is_at91sam9g10()) {
942 usbpucr
= at91_matrix_read(AT91_MATRIX_USBPUCR
);
943 usbpucr
|= AT91_MATRIX_USBPUCR_PUON
;
944 at91_matrix_write(AT91_MATRIX_USBPUCR
, usbpucr
);
948 at91_udp_write(udc
, AT91_UDP_IDR
, AT91_UDP_RXRSM
);
949 at91_udp_write(udc
, AT91_UDP_TXVC
, AT91_UDP_TXVC_TXVDIS
);
950 if (cpu_is_at91rm9200())
951 gpio_set_value(udc
->board
.pullup_pin
, !active
);
952 else if (cpu_is_at91sam9260() || cpu_is_at91sam9263() || cpu_is_at91sam9g20()) {
953 u32 txvc
= at91_udp_read(udc
, AT91_UDP_TXVC
);
955 txvc
&= ~AT91_UDP_TXVC_PUON
;
956 at91_udp_write(udc
, AT91_UDP_TXVC
, txvc
);
957 } else if (cpu_is_at91sam9261() || cpu_is_at91sam9g10()) {
960 usbpucr
= at91_matrix_read(AT91_MATRIX_USBPUCR
);
961 usbpucr
&= ~AT91_MATRIX_USBPUCR_PUON
;
962 at91_matrix_write(AT91_MATRIX_USBPUCR
, usbpucr
);
968 /* vbus is here! turn everything on that's ready */
969 static int at91_vbus_session(struct usb_gadget
*gadget
, int is_active
)
971 struct at91_udc
*udc
= to_udc(gadget
);
974 /* VDBG("vbus %s\n", is_active ? "on" : "off"); */
975 spin_lock_irqsave(&udc
->lock
, flags
);
976 udc
->vbus
= (is_active
!= 0);
978 pullup(udc
, is_active
);
981 spin_unlock_irqrestore(&udc
->lock
, flags
);
985 static int at91_pullup(struct usb_gadget
*gadget
, int is_on
)
987 struct at91_udc
*udc
= to_udc(gadget
);
990 spin_lock_irqsave(&udc
->lock
, flags
);
991 udc
->enabled
= is_on
= !!is_on
;
993 spin_unlock_irqrestore(&udc
->lock
, flags
);
997 static int at91_set_selfpowered(struct usb_gadget
*gadget
, int is_on
)
999 struct at91_udc
*udc
= to_udc(gadget
);
1000 unsigned long flags
;
1002 spin_lock_irqsave(&udc
->lock
, flags
);
1003 udc
->selfpowered
= (is_on
!= 0);
1004 spin_unlock_irqrestore(&udc
->lock
, flags
);
1008 static int at91_start(struct usb_gadget
*gadget
,
1009 struct usb_gadget_driver
*driver
);
1010 static int at91_stop(struct usb_gadget
*gadget
);
1012 static const struct usb_gadget_ops at91_udc_ops
= {
1013 .get_frame
= at91_get_frame
,
1014 .wakeup
= at91_wakeup
,
1015 .set_selfpowered
= at91_set_selfpowered
,
1016 .vbus_session
= at91_vbus_session
,
1017 .pullup
= at91_pullup
,
1018 .udc_start
= at91_start
,
1019 .udc_stop
= at91_stop
,
1022 * VBUS-powered devices may also also want to support bigger
1023 * power budgets after an appropriate SET_CONFIGURATION.
1025 /* .vbus_power = at91_vbus_power, */
1028 /*-------------------------------------------------------------------------*/
1030 static int handle_ep(struct at91_ep
*ep
)
1032 struct at91_request
*req
;
1033 u32 __iomem
*creg
= ep
->creg
;
1034 u32 csr
= __raw_readl(creg
);
1036 if (!list_empty(&ep
->queue
))
1037 req
= list_entry(ep
->queue
.next
,
1038 struct at91_request
, queue
);
1043 if (csr
& (AT91_UDP_STALLSENT
| AT91_UDP_TXCOMP
)) {
1045 csr
&= ~(SET_FX
| AT91_UDP_STALLSENT
| AT91_UDP_TXCOMP
);
1046 __raw_writel(csr
, creg
);
1049 return write_fifo(ep
, req
);
1052 if (csr
& AT91_UDP_STALLSENT
) {
1053 /* STALLSENT bit == ISOERR */
1054 if (ep
->is_iso
&& req
)
1055 req
->req
.status
= -EILSEQ
;
1057 csr
&= ~(SET_FX
| AT91_UDP_STALLSENT
);
1058 __raw_writel(csr
, creg
);
1059 csr
= __raw_readl(creg
);
1061 if (req
&& (csr
& RX_DATA_READY
))
1062 return read_fifo(ep
, req
);
1069 struct usb_ctrlrequest r
;
1072 static void handle_setup(struct at91_udc
*udc
, struct at91_ep
*ep
, u32 csr
)
1074 u32 __iomem
*creg
= ep
->creg
;
1075 u8 __iomem
*dreg
= ep
->creg
+ (AT91_UDP_FDR(0) - AT91_UDP_CSR(0));
1076 unsigned rxcount
, i
= 0;
1081 /* read and ack SETUP; hard-fail for bogus packets */
1082 rxcount
= (csr
& AT91_UDP_RXBYTECNT
) >> 16;
1083 if (likely(rxcount
== 8)) {
1085 pkt
.raw
[i
++] = __raw_readb(dreg
);
1086 if (pkt
.r
.bRequestType
& USB_DIR_IN
) {
1087 csr
|= AT91_UDP_DIR
;
1090 csr
&= ~AT91_UDP_DIR
;
1094 /* REVISIT this happens sometimes under load; why?? */
1095 ERR("SETUP len %d, csr %08x\n", rxcount
, csr
);
1099 csr
&= ~(SET_FX
| AT91_UDP_RXSETUP
);
1100 __raw_writel(csr
, creg
);
1101 udc
->wait_for_addr_ack
= 0;
1102 udc
->wait_for_config_ack
= 0;
1104 if (unlikely(status
!= 0))
1107 #define w_index le16_to_cpu(pkt.r.wIndex)
1108 #define w_value le16_to_cpu(pkt.r.wValue)
1109 #define w_length le16_to_cpu(pkt.r.wLength)
1111 VDBG("SETUP %02x.%02x v%04x i%04x l%04x\n",
1112 pkt
.r
.bRequestType
, pkt
.r
.bRequest
,
1113 w_value
, w_index
, w_length
);
1116 * A few standard requests get handled here, ones that touch
1117 * hardware ... notably for device and endpoint features.
1119 udc
->req_pending
= 1;
1120 csr
= __raw_readl(creg
);
1123 switch ((pkt
.r
.bRequestType
<< 8) | pkt
.r
.bRequest
) {
1125 case ((USB_TYPE_STANDARD
|USB_RECIP_DEVICE
) << 8)
1126 | USB_REQ_SET_ADDRESS
:
1127 __raw_writel(csr
| AT91_UDP_TXPKTRDY
, creg
);
1128 udc
->addr
= w_value
;
1129 udc
->wait_for_addr_ack
= 1;
1130 udc
->req_pending
= 0;
1131 /* FADDR is set later, when we ack host STATUS */
1134 case ((USB_TYPE_STANDARD
|USB_RECIP_DEVICE
) << 8)
1135 | USB_REQ_SET_CONFIGURATION
:
1136 tmp
= at91_udp_read(udc
, AT91_UDP_GLB_STAT
) & AT91_UDP_CONFG
;
1138 udc
->wait_for_config_ack
= (tmp
== 0);
1140 udc
->wait_for_config_ack
= (tmp
!= 0);
1141 if (udc
->wait_for_config_ack
)
1142 VDBG("wait for config\n");
1143 /* CONFG is toggled later, if gadget driver succeeds */
1147 * Hosts may set or clear remote wakeup status, and
1148 * devices may report they're VBUS powered.
1150 case ((USB_DIR_IN
|USB_TYPE_STANDARD
|USB_RECIP_DEVICE
) << 8)
1151 | USB_REQ_GET_STATUS
:
1152 tmp
= (udc
->selfpowered
<< USB_DEVICE_SELF_POWERED
);
1153 if (at91_udp_read(udc
, AT91_UDP_GLB_STAT
) & AT91_UDP_ESR
)
1154 tmp
|= (1 << USB_DEVICE_REMOTE_WAKEUP
);
1155 PACKET("get device status\n");
1156 __raw_writeb(tmp
, dreg
);
1157 __raw_writeb(0, dreg
);
1159 /* then STATUS starts later, automatically */
1160 case ((USB_TYPE_STANDARD
|USB_RECIP_DEVICE
) << 8)
1161 | USB_REQ_SET_FEATURE
:
1162 if (w_value
!= USB_DEVICE_REMOTE_WAKEUP
)
1164 tmp
= at91_udp_read(udc
, AT91_UDP_GLB_STAT
);
1165 tmp
|= AT91_UDP_ESR
;
1166 at91_udp_write(udc
, AT91_UDP_GLB_STAT
, tmp
);
1168 case ((USB_TYPE_STANDARD
|USB_RECIP_DEVICE
) << 8)
1169 | USB_REQ_CLEAR_FEATURE
:
1170 if (w_value
!= USB_DEVICE_REMOTE_WAKEUP
)
1172 tmp
= at91_udp_read(udc
, AT91_UDP_GLB_STAT
);
1173 tmp
&= ~AT91_UDP_ESR
;
1174 at91_udp_write(udc
, AT91_UDP_GLB_STAT
, tmp
);
1178 * Interfaces have no feature settings; this is pretty useless.
1179 * we won't even insist the interface exists...
1181 case ((USB_DIR_IN
|USB_TYPE_STANDARD
|USB_RECIP_INTERFACE
) << 8)
1182 | USB_REQ_GET_STATUS
:
1183 PACKET("get interface status\n");
1184 __raw_writeb(0, dreg
);
1185 __raw_writeb(0, dreg
);
1187 /* then STATUS starts later, automatically */
1188 case ((USB_TYPE_STANDARD
|USB_RECIP_INTERFACE
) << 8)
1189 | USB_REQ_SET_FEATURE
:
1190 case ((USB_TYPE_STANDARD
|USB_RECIP_INTERFACE
) << 8)
1191 | USB_REQ_CLEAR_FEATURE
:
1195 * Hosts may clear bulk/intr endpoint halt after the gadget
1196 * driver sets it (not widely used); or set it (for testing)
1198 case ((USB_DIR_IN
|USB_TYPE_STANDARD
|USB_RECIP_ENDPOINT
) << 8)
1199 | USB_REQ_GET_STATUS
:
1200 tmp
= w_index
& USB_ENDPOINT_NUMBER_MASK
;
1202 if (tmp
>= NUM_ENDPOINTS
|| (tmp
&& !ep
->ep
.desc
))
1206 if ((w_index
& USB_DIR_IN
)) {
1209 } else if (ep
->is_in
)
1212 PACKET("get %s status\n", ep
->ep
.name
);
1213 if (__raw_readl(ep
->creg
) & AT91_UDP_FORCESTALL
)
1214 tmp
= (1 << USB_ENDPOINT_HALT
);
1217 __raw_writeb(tmp
, dreg
);
1218 __raw_writeb(0, dreg
);
1220 /* then STATUS starts later, automatically */
1221 case ((USB_TYPE_STANDARD
|USB_RECIP_ENDPOINT
) << 8)
1222 | USB_REQ_SET_FEATURE
:
1223 tmp
= w_index
& USB_ENDPOINT_NUMBER_MASK
;
1225 if (w_value
!= USB_ENDPOINT_HALT
|| tmp
>= NUM_ENDPOINTS
)
1227 if (!ep
->ep
.desc
|| ep
->is_iso
)
1229 if ((w_index
& USB_DIR_IN
)) {
1232 } else if (ep
->is_in
)
1235 tmp
= __raw_readl(ep
->creg
);
1237 tmp
|= CLR_FX
| AT91_UDP_FORCESTALL
;
1238 __raw_writel(tmp
, ep
->creg
);
1240 case ((USB_TYPE_STANDARD
|USB_RECIP_ENDPOINT
) << 8)
1241 | USB_REQ_CLEAR_FEATURE
:
1242 tmp
= w_index
& USB_ENDPOINT_NUMBER_MASK
;
1244 if (w_value
!= USB_ENDPOINT_HALT
|| tmp
>= NUM_ENDPOINTS
)
1248 if (!ep
->ep
.desc
|| ep
->is_iso
)
1250 if ((w_index
& USB_DIR_IN
)) {
1253 } else if (ep
->is_in
)
1256 at91_udp_write(udc
, AT91_UDP_RST_EP
, ep
->int_mask
);
1257 at91_udp_write(udc
, AT91_UDP_RST_EP
, 0);
1258 tmp
= __raw_readl(ep
->creg
);
1260 tmp
&= ~(SET_FX
| AT91_UDP_FORCESTALL
);
1261 __raw_writel(tmp
, ep
->creg
);
1262 if (!list_empty(&ep
->queue
))
1271 /* pass request up to the gadget driver */
1273 spin_unlock(&udc
->lock
);
1274 status
= udc
->driver
->setup(&udc
->gadget
, &pkt
.r
);
1275 spin_lock(&udc
->lock
);
1281 VDBG("req %02x.%02x protocol STALL; stat %d\n",
1282 pkt
.r
.bRequestType
, pkt
.r
.bRequest
, status
);
1283 csr
|= AT91_UDP_FORCESTALL
;
1284 __raw_writel(csr
, creg
);
1285 udc
->req_pending
= 0;
1290 /* immediate successful (IN) STATUS after zero length DATA */
1291 PACKET("ep0 in/status\n");
1293 csr
|= AT91_UDP_TXPKTRDY
;
1294 __raw_writel(csr
, creg
);
1295 udc
->req_pending
= 0;
1298 static void handle_ep0(struct at91_udc
*udc
)
1300 struct at91_ep
*ep0
= &udc
->ep
[0];
1301 u32 __iomem
*creg
= ep0
->creg
;
1302 u32 csr
= __raw_readl(creg
);
1303 struct at91_request
*req
;
1305 if (unlikely(csr
& AT91_UDP_STALLSENT
)) {
1307 udc
->req_pending
= 0;
1309 csr
&= ~(SET_FX
| AT91_UDP_STALLSENT
| AT91_UDP_FORCESTALL
);
1310 __raw_writel(csr
, creg
);
1311 VDBG("ep0 stalled\n");
1312 csr
= __raw_readl(creg
);
1314 if (csr
& AT91_UDP_RXSETUP
) {
1316 udc
->req_pending
= 0;
1317 handle_setup(udc
, ep0
, csr
);
1321 if (list_empty(&ep0
->queue
))
1324 req
= list_entry(ep0
->queue
.next
, struct at91_request
, queue
);
1326 /* host ACKed an IN packet that we sent */
1327 if (csr
& AT91_UDP_TXCOMP
) {
1329 csr
&= ~(SET_FX
| AT91_UDP_TXCOMP
);
1331 /* write more IN DATA? */
1332 if (req
&& ep0
->is_in
) {
1334 udc
->req_pending
= 0;
1338 * - last IN DATA packet (including GET_STATUS)
1339 * - IN/STATUS for OUT DATA
1340 * - IN/STATUS for any zero-length DATA stage
1341 * except for the IN DATA case, the host should send
1342 * an OUT status later, which we'll ack.
1345 udc
->req_pending
= 0;
1346 __raw_writel(csr
, creg
);
1349 * SET_ADDRESS takes effect only after the STATUS
1350 * (to the original address) gets acked.
1352 if (udc
->wait_for_addr_ack
) {
1355 at91_udp_write(udc
, AT91_UDP_FADDR
,
1356 AT91_UDP_FEN
| udc
->addr
);
1357 tmp
= at91_udp_read(udc
, AT91_UDP_GLB_STAT
);
1358 tmp
&= ~AT91_UDP_FADDEN
;
1360 tmp
|= AT91_UDP_FADDEN
;
1361 at91_udp_write(udc
, AT91_UDP_GLB_STAT
, tmp
);
1363 udc
->wait_for_addr_ack
= 0;
1364 VDBG("address %d\n", udc
->addr
);
1369 /* OUT packet arrived ... */
1370 else if (csr
& AT91_UDP_RX_DATA_BK0
) {
1372 csr
&= ~(SET_FX
| AT91_UDP_RX_DATA_BK0
);
1374 /* OUT DATA stage */
1377 if (handle_ep(ep0
)) {
1378 /* send IN/STATUS */
1379 PACKET("ep0 in/status\n");
1380 csr
= __raw_readl(creg
);
1382 csr
|= CLR_FX
| AT91_UDP_TXPKTRDY
;
1383 __raw_writel(csr
, creg
);
1384 udc
->req_pending
= 0;
1386 } else if (udc
->req_pending
) {
1388 * AT91 hardware has a hard time with this
1389 * "deferred response" mode for control-OUT
1390 * transfers. (For control-IN it's fine.)
1392 * The normal solution leaves OUT data in the
1393 * fifo until the gadget driver is ready.
1394 * We couldn't do that here without disabling
1395 * the IRQ that tells about SETUP packets,
1396 * e.g. when the host gets impatient...
1398 * Working around it by copying into a buffer
1399 * would almost be a non-deferred response,
1400 * except that it wouldn't permit reliable
1401 * stalling of the request. Instead, demand
1402 * that gadget drivers not use this mode.
1404 DBG("no control-OUT deferred responses!\n");
1405 __raw_writel(csr
| AT91_UDP_FORCESTALL
, creg
);
1406 udc
->req_pending
= 0;
1409 /* STATUS stage for control-IN; ack. */
1411 PACKET("ep0 out/status ACK\n");
1412 __raw_writel(csr
, creg
);
1414 /* "early" status stage */
1421 static irqreturn_t
at91_udc_irq (int irq
, void *_udc
)
1423 struct at91_udc
*udc
= _udc
;
1425 int disable_clock
= 0;
1426 unsigned long flags
;
1428 spin_lock_irqsave(&udc
->lock
, flags
);
1430 if (!udc
->clocked
) {
1438 status
= at91_udp_read(udc
, AT91_UDP_ISR
)
1439 & at91_udp_read(udc
, AT91_UDP_IMR
);
1443 /* USB reset irq: not maskable */
1444 if (status
& AT91_UDP_ENDBUSRES
) {
1445 at91_udp_write(udc
, AT91_UDP_IDR
, ~MINIMUS_INTERRUPTUS
);
1446 at91_udp_write(udc
, AT91_UDP_IER
, MINIMUS_INTERRUPTUS
);
1447 /* Atmel code clears this irq twice */
1448 at91_udp_write(udc
, AT91_UDP_ICR
, AT91_UDP_ENDBUSRES
);
1449 at91_udp_write(udc
, AT91_UDP_ICR
, AT91_UDP_ENDBUSRES
);
1450 VDBG("end bus reset\n");
1455 at91_udp_write(udc
, AT91_UDP_CSR(0),
1456 AT91_UDP_EPEDS
| AT91_UDP_EPTYPE_CTRL
);
1457 udc
->gadget
.speed
= USB_SPEED_FULL
;
1459 at91_udp_write(udc
, AT91_UDP_IER
, AT91_UDP_EP(0));
1462 * NOTE: this driver keeps clocks off unless the
1463 * USB host is present. That saves power, but for
1464 * boards that don't support VBUS detection, both
1465 * clocks need to be active most of the time.
1468 /* host initiated suspend (3+ms bus idle) */
1469 } else if (status
& AT91_UDP_RXSUSP
) {
1470 at91_udp_write(udc
, AT91_UDP_IDR
, AT91_UDP_RXSUSP
);
1471 at91_udp_write(udc
, AT91_UDP_IER
, AT91_UDP_RXRSM
);
1472 at91_udp_write(udc
, AT91_UDP_ICR
, AT91_UDP_RXSUSP
);
1473 /* VDBG("bus suspend\n"); */
1479 * NOTE: when suspending a VBUS-powered device, the
1480 * gadget driver should switch into slow clock mode
1481 * and then into standby to avoid drawing more than
1482 * 500uA power (2500uA for some high-power configs).
1484 if (udc
->driver
&& udc
->driver
->suspend
) {
1485 spin_unlock(&udc
->lock
);
1486 udc
->driver
->suspend(&udc
->gadget
);
1487 spin_lock(&udc
->lock
);
1490 /* host initiated resume */
1491 } else if (status
& AT91_UDP_RXRSM
) {
1492 at91_udp_write(udc
, AT91_UDP_IDR
, AT91_UDP_RXRSM
);
1493 at91_udp_write(udc
, AT91_UDP_IER
, AT91_UDP_RXSUSP
);
1494 at91_udp_write(udc
, AT91_UDP_ICR
, AT91_UDP_RXRSM
);
1495 /* VDBG("bus resume\n"); */
1496 if (!udc
->suspended
)
1501 * NOTE: for a VBUS-powered device, the gadget driver
1502 * would normally want to switch out of slow clock
1503 * mode into normal mode.
1505 if (udc
->driver
&& udc
->driver
->resume
) {
1506 spin_unlock(&udc
->lock
);
1507 udc
->driver
->resume(&udc
->gadget
);
1508 spin_lock(&udc
->lock
);
1511 /* endpoint IRQs are cleared by handling them */
1515 struct at91_ep
*ep
= &udc
->ep
[1];
1519 for (i
= 1; i
< NUM_ENDPOINTS
; i
++) {
1531 spin_unlock_irqrestore(&udc
->lock
, flags
);
1536 /*-------------------------------------------------------------------------*/
1538 static struct at91_udc controller
= {
1540 .ops
= &at91_udc_ops
,
1541 .ep0
= &controller
.ep
[0].ep
,
1542 .name
= driver_name
,
1547 .ops
= &at91_ep_ops
,
1556 .ops
= &at91_ep_ops
,
1566 .ops
= &at91_ep_ops
,
1575 /* could actually do bulk too */
1577 .ops
= &at91_ep_ops
,
1586 .ops
= &at91_ep_ops
,
1596 .ops
= &at91_ep_ops
,
1603 /* ep6 and ep7 are also reserved (custom silicon might use them) */
1606 static void at91_vbus_update(struct at91_udc
*udc
, unsigned value
)
1608 value
^= udc
->board
.vbus_active_low
;
1609 if (value
!= udc
->vbus
)
1610 at91_vbus_session(&udc
->gadget
, value
);
1613 static irqreturn_t
at91_vbus_irq(int irq
, void *_udc
)
1615 struct at91_udc
*udc
= _udc
;
1617 /* vbus needs at least brief debouncing */
1619 at91_vbus_update(udc
, gpio_get_value(udc
->board
.vbus_pin
));
1624 static void at91_vbus_timer_work(struct work_struct
*work
)
1626 struct at91_udc
*udc
= container_of(work
, struct at91_udc
,
1629 at91_vbus_update(udc
, gpio_get_value_cansleep(udc
->board
.vbus_pin
));
1631 if (!timer_pending(&udc
->vbus_timer
))
1632 mod_timer(&udc
->vbus_timer
, jiffies
+ VBUS_POLL_TIMEOUT
);
1635 static void at91_vbus_timer(unsigned long data
)
1637 struct at91_udc
*udc
= (struct at91_udc
*)data
;
1640 * If we are polling vbus it is likely that the gpio is on an
1641 * bus such as i2c or spi which may sleep, so schedule some work
1642 * to read the vbus gpio
1644 schedule_work(&udc
->vbus_timer_work
);
1647 static int at91_start(struct usb_gadget
*gadget
,
1648 struct usb_gadget_driver
*driver
)
1650 struct at91_udc
*udc
;
1652 udc
= container_of(gadget
, struct at91_udc
, gadget
);
1653 udc
->driver
= driver
;
1654 udc
->gadget
.dev
.of_node
= udc
->pdev
->dev
.of_node
;
1656 udc
->selfpowered
= 1;
1661 static int at91_stop(struct usb_gadget
*gadget
)
1663 struct at91_udc
*udc
;
1664 unsigned long flags
;
1666 udc
= container_of(gadget
, struct at91_udc
, gadget
);
1667 spin_lock_irqsave(&udc
->lock
, flags
);
1669 at91_udp_write(udc
, AT91_UDP_IDR
, ~0);
1670 spin_unlock_irqrestore(&udc
->lock
, flags
);
1677 /*-------------------------------------------------------------------------*/
1679 static void at91udc_shutdown(struct platform_device
*dev
)
1681 struct at91_udc
*udc
= platform_get_drvdata(dev
);
1682 unsigned long flags
;
1684 /* force disconnect on reboot */
1685 spin_lock_irqsave(&udc
->lock
, flags
);
1686 pullup(platform_get_drvdata(dev
), 0);
1687 spin_unlock_irqrestore(&udc
->lock
, flags
);
1690 static void at91udc_of_init(struct at91_udc
*udc
,
1691 struct device_node
*np
)
1693 struct at91_udc_data
*board
= &udc
->board
;
1695 enum of_gpio_flags flags
;
1697 if (of_property_read_u32(np
, "atmel,vbus-polled", &val
) == 0)
1698 board
->vbus_polled
= 1;
1700 board
->vbus_pin
= of_get_named_gpio_flags(np
, "atmel,vbus-gpio", 0,
1702 board
->vbus_active_low
= (flags
& OF_GPIO_ACTIVE_LOW
) ? 1 : 0;
1704 board
->pullup_pin
= of_get_named_gpio_flags(np
, "atmel,pullup-gpio", 0,
1707 board
->pullup_active_low
= (flags
& OF_GPIO_ACTIVE_LOW
) ? 1 : 0;
1710 static int at91udc_probe(struct platform_device
*pdev
)
1712 struct device
*dev
= &pdev
->dev
;
1713 struct at91_udc
*udc
;
1715 struct resource
*res
;
1717 if (!dev_get_platdata(dev
) && !pdev
->dev
.of_node
) {
1718 /* small (so we copy it) but critical! */
1719 DBG("missing platform_data\n");
1723 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
1727 if (!request_mem_region(res
->start
, resource_size(res
), driver_name
)) {
1728 DBG("someone's using UDC memory\n");
1732 /* init software state */
1734 udc
->gadget
.dev
.parent
= dev
;
1735 if (IS_ENABLED(CONFIG_OF
) && pdev
->dev
.of_node
)
1736 at91udc_of_init(udc
, pdev
->dev
.of_node
);
1738 memcpy(&udc
->board
, dev_get_platdata(dev
),
1739 sizeof(struct at91_udc_data
));
1742 spin_lock_init(&udc
->lock
);
1744 /* rm9200 needs manual D+ pullup; off by default */
1745 if (cpu_is_at91rm9200()) {
1746 if (!gpio_is_valid(udc
->board
.pullup_pin
)) {
1747 DBG("no D+ pullup?\n");
1751 retval
= gpio_request(udc
->board
.pullup_pin
, "udc_pullup");
1753 DBG("D+ pullup is busy\n");
1756 gpio_direction_output(udc
->board
.pullup_pin
,
1757 udc
->board
.pullup_active_low
);
1760 /* newer chips have more FIFO memory than rm9200 */
1761 if (cpu_is_at91sam9260() || cpu_is_at91sam9g20()) {
1762 udc
->ep
[0].maxpacket
= 64;
1763 udc
->ep
[3].maxpacket
= 64;
1764 udc
->ep
[4].maxpacket
= 512;
1765 udc
->ep
[5].maxpacket
= 512;
1766 } else if (cpu_is_at91sam9261() || cpu_is_at91sam9g10()) {
1767 udc
->ep
[3].maxpacket
= 64;
1768 } else if (cpu_is_at91sam9263()) {
1769 udc
->ep
[0].maxpacket
= 64;
1770 udc
->ep
[3].maxpacket
= 64;
1773 udc
->udp_baseaddr
= ioremap(res
->start
, resource_size(res
));
1774 if (!udc
->udp_baseaddr
) {
1781 /* get interface and function clocks */
1782 udc
->iclk
= clk_get(dev
, "udc_clk");
1783 udc
->fclk
= clk_get(dev
, "udpck");
1784 if (IS_ENABLED(CONFIG_COMMON_CLK
))
1785 udc
->uclk
= clk_get(dev
, "usb_clk");
1786 if (IS_ERR(udc
->iclk
) || IS_ERR(udc
->fclk
) ||
1787 (IS_ENABLED(CONFIG_COMMON_CLK
) && IS_ERR(udc
->uclk
))) {
1788 DBG("clocks missing\n");
1793 /* don't do anything until we have both gadget driver and VBUS */
1794 if (IS_ENABLED(CONFIG_COMMON_CLK
)) {
1795 clk_set_rate(udc
->uclk
, 48000000);
1796 retval
= clk_prepare(udc
->uclk
);
1800 retval
= clk_prepare(udc
->fclk
);
1804 retval
= clk_prepare_enable(udc
->iclk
);
1807 at91_udp_write(udc
, AT91_UDP_TXVC
, AT91_UDP_TXVC_TXVDIS
);
1808 at91_udp_write(udc
, AT91_UDP_IDR
, 0xffffffff);
1809 /* Clear all pending interrupts - UDP may be used by bootloader. */
1810 at91_udp_write(udc
, AT91_UDP_ICR
, 0xffffffff);
1811 clk_disable(udc
->iclk
);
1813 /* request UDC and maybe VBUS irqs */
1814 udc
->udp_irq
= platform_get_irq(pdev
, 0);
1815 retval
= request_irq(udc
->udp_irq
, at91_udc_irq
,
1816 0, driver_name
, udc
);
1818 DBG("request irq %d failed\n", udc
->udp_irq
);
1821 if (gpio_is_valid(udc
->board
.vbus_pin
)) {
1822 retval
= gpio_request(udc
->board
.vbus_pin
, "udc_vbus");
1824 DBG("request vbus pin failed\n");
1827 gpio_direction_input(udc
->board
.vbus_pin
);
1830 * Get the initial state of VBUS - we cannot expect
1831 * a pending interrupt.
1833 udc
->vbus
= gpio_get_value_cansleep(udc
->board
.vbus_pin
) ^
1834 udc
->board
.vbus_active_low
;
1836 if (udc
->board
.vbus_polled
) {
1837 INIT_WORK(&udc
->vbus_timer_work
, at91_vbus_timer_work
);
1838 setup_timer(&udc
->vbus_timer
, at91_vbus_timer
,
1839 (unsigned long)udc
);
1840 mod_timer(&udc
->vbus_timer
,
1841 jiffies
+ VBUS_POLL_TIMEOUT
);
1843 if (request_irq(gpio_to_irq(udc
->board
.vbus_pin
),
1844 at91_vbus_irq
, 0, driver_name
, udc
)) {
1845 DBG("request vbus irq %d failed\n",
1846 udc
->board
.vbus_pin
);
1852 DBG("no VBUS detection, assuming always-on\n");
1855 retval
= usb_add_gadget_udc(dev
, &udc
->gadget
);
1858 dev_set_drvdata(dev
, udc
);
1859 device_init_wakeup(dev
, 1);
1860 create_debug_file(udc
);
1862 INFO("%s version %s\n", driver_name
, DRIVER_VERSION
);
1865 if (gpio_is_valid(udc
->board
.vbus_pin
) && !udc
->board
.vbus_polled
)
1866 free_irq(gpio_to_irq(udc
->board
.vbus_pin
), udc
);
1868 if (gpio_is_valid(udc
->board
.vbus_pin
))
1869 gpio_free(udc
->board
.vbus_pin
);
1871 free_irq(udc
->udp_irq
, udc
);
1873 clk_unprepare(udc
->iclk
);
1875 clk_unprepare(udc
->fclk
);
1877 if (IS_ENABLED(CONFIG_COMMON_CLK
))
1878 clk_unprepare(udc
->uclk
);
1880 if (IS_ENABLED(CONFIG_COMMON_CLK
) && !IS_ERR(udc
->uclk
))
1882 if (!IS_ERR(udc
->fclk
))
1884 if (!IS_ERR(udc
->iclk
))
1886 iounmap(udc
->udp_baseaddr
);
1888 if (cpu_is_at91rm9200())
1889 gpio_free(udc
->board
.pullup_pin
);
1891 release_mem_region(res
->start
, resource_size(res
));
1892 DBG("%s probe failed, %d\n", driver_name
, retval
);
1896 static int __exit
at91udc_remove(struct platform_device
*pdev
)
1898 struct at91_udc
*udc
= platform_get_drvdata(pdev
);
1899 struct resource
*res
;
1900 unsigned long flags
;
1904 usb_del_gadget_udc(&udc
->gadget
);
1908 spin_lock_irqsave(&udc
->lock
, flags
);
1910 spin_unlock_irqrestore(&udc
->lock
, flags
);
1912 device_init_wakeup(&pdev
->dev
, 0);
1913 remove_debug_file(udc
);
1914 if (gpio_is_valid(udc
->board
.vbus_pin
)) {
1915 free_irq(gpio_to_irq(udc
->board
.vbus_pin
), udc
);
1916 gpio_free(udc
->board
.vbus_pin
);
1918 free_irq(udc
->udp_irq
, udc
);
1919 iounmap(udc
->udp_baseaddr
);
1921 if (cpu_is_at91rm9200())
1922 gpio_free(udc
->board
.pullup_pin
);
1924 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
1925 release_mem_region(res
->start
, resource_size(res
));
1927 if (IS_ENABLED(CONFIG_COMMON_CLK
))
1928 clk_unprepare(udc
->uclk
);
1929 clk_unprepare(udc
->fclk
);
1930 clk_unprepare(udc
->iclk
);
1934 if (IS_ENABLED(CONFIG_COMMON_CLK
))
1941 static int at91udc_suspend(struct platform_device
*pdev
, pm_message_t mesg
)
1943 struct at91_udc
*udc
= platform_get_drvdata(pdev
);
1944 int wake
= udc
->driver
&& device_may_wakeup(&pdev
->dev
);
1945 unsigned long flags
;
1947 /* Unless we can act normally to the host (letting it wake us up
1948 * whenever it has work for us) force disconnect. Wakeup requires
1949 * PLLB for USB events (signaling for reset, wakeup, or incoming
1950 * tokens) and VBUS irqs (on systems which support them).
1952 if ((!udc
->suspended
&& udc
->addr
)
1954 || at91_suspend_entering_slow_clock()) {
1955 spin_lock_irqsave(&udc
->lock
, flags
);
1958 spin_unlock_irqrestore(&udc
->lock
, flags
);
1960 enable_irq_wake(udc
->udp_irq
);
1962 udc
->active_suspend
= wake
;
1963 if (gpio_is_valid(udc
->board
.vbus_pin
) && !udc
->board
.vbus_polled
&& wake
)
1964 enable_irq_wake(udc
->board
.vbus_pin
);
1968 static int at91udc_resume(struct platform_device
*pdev
)
1970 struct at91_udc
*udc
= platform_get_drvdata(pdev
);
1971 unsigned long flags
;
1973 if (gpio_is_valid(udc
->board
.vbus_pin
) && !udc
->board
.vbus_polled
&&
1974 udc
->active_suspend
)
1975 disable_irq_wake(udc
->board
.vbus_pin
);
1977 /* maybe reconnect to host; if so, clocks on */
1978 if (udc
->active_suspend
)
1979 disable_irq_wake(udc
->udp_irq
);
1981 spin_lock_irqsave(&udc
->lock
, flags
);
1983 spin_unlock_irqrestore(&udc
->lock
, flags
);
1988 #define at91udc_suspend NULL
1989 #define at91udc_resume NULL
1992 #if defined(CONFIG_OF)
1993 static const struct of_device_id at91_udc_dt_ids
[] = {
1994 { .compatible
= "atmel,at91rm9200-udc" },
1998 MODULE_DEVICE_TABLE(of
, at91_udc_dt_ids
);
2001 static struct platform_driver at91_udc_driver
= {
2002 .remove
= __exit_p(at91udc_remove
),
2003 .shutdown
= at91udc_shutdown
,
2004 .suspend
= at91udc_suspend
,
2005 .resume
= at91udc_resume
,
2007 .name
= (char *) driver_name
,
2008 .of_match_table
= of_match_ptr(at91_udc_dt_ids
),
2012 module_platform_driver_probe(at91_udc_driver
, at91udc_probe
);
2014 MODULE_DESCRIPTION("AT91 udc driver");
2015 MODULE_AUTHOR("Thomas Rathbone, David Brownell");
2016 MODULE_LICENSE("GPL");
2017 MODULE_ALIAS("platform:at91_udc");