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>
34 #include <linux/regmap.h>
35 #include <linux/mfd/syscon.h>
36 #include <linux/mfd/syscon/atmel-matrix.h>
42 * This controller is simple and PIO-only. It's used in many AT91-series
43 * full speed USB controllers, including the at91rm9200 (arm920T, with MMU),
44 * at91sam926x (arm926ejs, with MMU), and several no-mmu versions.
46 * This driver expects the board has been wired with two GPIOs supporting
47 * a VBUS sensing IRQ, and a D+ pullup. (They may be omitted, but the
48 * testing hasn't covered such cases.)
50 * The pullup is most important (so it's integrated on sam926x parts). It
51 * provides software control over whether the host enumerates the device.
53 * The VBUS sensing helps during enumeration, and allows both USB clocks
54 * (and the transceiver) to stay gated off until they're necessary, saving
55 * power. During USB suspend, the 48 MHz clock is gated off in hardware;
56 * it may also be gated off by software during some Linux sleep states.
59 #define DRIVER_VERSION "3 May 2006"
61 static const char driver_name
[] = "at91_udc";
62 static const char ep0name
[] = "ep0";
64 #define VBUS_POLL_TIMEOUT msecs_to_jiffies(1000)
66 #define at91_udp_read(udc, reg) \
67 __raw_readl((udc)->udp_baseaddr + (reg))
68 #define at91_udp_write(udc, reg, val) \
69 __raw_writel((val), (udc)->udp_baseaddr + (reg))
71 /*-------------------------------------------------------------------------*/
73 #ifdef CONFIG_USB_GADGET_DEBUG_FILES
75 #include <linux/seq_file.h>
77 static const char debug_filename
[] = "driver/udc";
79 #define FOURBITS "%s%s%s%s"
80 #define EIGHTBITS FOURBITS FOURBITS
82 static void proc_ep_show(struct seq_file
*s
, struct at91_ep
*ep
)
84 static char *types
[] = {
85 "control", "out-iso", "out-bulk", "out-int",
86 "BOGUS", "in-iso", "in-bulk", "in-int"};
89 struct at91_request
*req
;
91 struct at91_udc
*udc
= ep
->udc
;
93 spin_lock_irqsave(&udc
->lock
, flags
);
95 csr
= __raw_readl(ep
->creg
);
97 /* NOTE: not collecting per-endpoint irq statistics... */
100 seq_printf(s
, "%s, maxpacket %d %s%s %s%s\n",
101 ep
->ep
.name
, ep
->ep
.maxpacket
,
102 ep
->is_in
? "in" : "out",
103 ep
->is_iso
? " iso" : "",
105 ? (ep
->fifo_bank
? "pong" : "ping")
107 ep
->stopped
? " stopped" : "");
108 seq_printf(s
, "csr %08x rxbytes=%d %s %s %s" EIGHTBITS
"\n",
110 (csr
& 0x07ff0000) >> 16,
111 (csr
& (1 << 15)) ? "enabled" : "disabled",
112 (csr
& (1 << 11)) ? "DATA1" : "DATA0",
113 types
[(csr
& 0x700) >> 8],
115 /* iff type is control then print current direction */
117 ? ((csr
& (1 << 7)) ? " IN" : " OUT")
119 (csr
& (1 << 6)) ? " rxdatabk1" : "",
120 (csr
& (1 << 5)) ? " forcestall" : "",
121 (csr
& (1 << 4)) ? " txpktrdy" : "",
123 (csr
& (1 << 3)) ? " stallsent" : "",
124 (csr
& (1 << 2)) ? " rxsetup" : "",
125 (csr
& (1 << 1)) ? " rxdatabk0" : "",
126 (csr
& (1 << 0)) ? " txcomp" : "");
127 if (list_empty (&ep
->queue
))
128 seq_printf(s
, "\t(queue empty)\n");
130 else list_for_each_entry (req
, &ep
->queue
, queue
) {
131 unsigned length
= req
->req
.actual
;
133 seq_printf(s
, "\treq %p len %d/%d buf %p\n",
135 req
->req
.length
, req
->req
.buf
);
137 spin_unlock_irqrestore(&udc
->lock
, flags
);
140 static void proc_irq_show(struct seq_file
*s
, const char *label
, u32 mask
)
144 seq_printf(s
, "%s %04x:%s%s" FOURBITS
, label
, mask
,
145 (mask
& (1 << 13)) ? " wakeup" : "",
146 (mask
& (1 << 12)) ? " endbusres" : "",
148 (mask
& (1 << 11)) ? " sofint" : "",
149 (mask
& (1 << 10)) ? " extrsm" : "",
150 (mask
& (1 << 9)) ? " rxrsm" : "",
151 (mask
& (1 << 8)) ? " rxsusp" : "");
152 for (i
= 0; i
< 8; i
++) {
154 seq_printf(s
, " ep%d", i
);
159 static int proc_udc_show(struct seq_file
*s
, void *unused
)
161 struct at91_udc
*udc
= s
->private;
165 seq_printf(s
, "%s: version %s\n", driver_name
, DRIVER_VERSION
);
167 seq_printf(s
, "vbus %s, pullup %s, %s powered%s, gadget %s\n\n",
168 udc
->vbus
? "present" : "off",
170 ? (udc
->vbus
? "active" : "enabled")
172 udc
->selfpowered
? "self" : "VBUS",
173 udc
->suspended
? ", suspended" : "",
174 udc
->driver
? udc
->driver
->driver
.name
: "(none)");
176 /* don't access registers when interface isn't clocked */
178 seq_printf(s
, "(not clocked)\n");
182 tmp
= at91_udp_read(udc
, AT91_UDP_FRM_NUM
);
183 seq_printf(s
, "frame %05x:%s%s frame=%d\n", tmp
,
184 (tmp
& AT91_UDP_FRM_OK
) ? " ok" : "",
185 (tmp
& AT91_UDP_FRM_ERR
) ? " err" : "",
186 (tmp
& AT91_UDP_NUM
));
188 tmp
= at91_udp_read(udc
, AT91_UDP_GLB_STAT
);
189 seq_printf(s
, "glbstate %02x:%s" FOURBITS
"\n", tmp
,
190 (tmp
& AT91_UDP_RMWUPE
) ? " rmwupe" : "",
191 (tmp
& AT91_UDP_RSMINPR
) ? " rsminpr" : "",
192 (tmp
& AT91_UDP_ESR
) ? " esr" : "",
193 (tmp
& AT91_UDP_CONFG
) ? " confg" : "",
194 (tmp
& AT91_UDP_FADDEN
) ? " fadden" : "");
196 tmp
= at91_udp_read(udc
, AT91_UDP_FADDR
);
197 seq_printf(s
, "faddr %03x:%s fadd=%d\n", tmp
,
198 (tmp
& AT91_UDP_FEN
) ? " fen" : "",
199 (tmp
& AT91_UDP_FADD
));
201 proc_irq_show(s
, "imr ", at91_udp_read(udc
, AT91_UDP_IMR
));
202 proc_irq_show(s
, "isr ", at91_udp_read(udc
, AT91_UDP_ISR
));
204 if (udc
->enabled
&& udc
->vbus
) {
205 proc_ep_show(s
, &udc
->ep
[0]);
206 list_for_each_entry (ep
, &udc
->gadget
.ep_list
, ep
.ep_list
) {
214 static int proc_udc_open(struct inode
*inode
, struct file
*file
)
216 return single_open(file
, proc_udc_show
, PDE_DATA(inode
));
219 static const struct file_operations proc_ops
= {
220 .owner
= THIS_MODULE
,
221 .open
= proc_udc_open
,
224 .release
= single_release
,
227 static void create_debug_file(struct at91_udc
*udc
)
229 udc
->pde
= proc_create_data(debug_filename
, 0, NULL
, &proc_ops
, udc
);
232 static void remove_debug_file(struct at91_udc
*udc
)
235 remove_proc_entry(debug_filename
, NULL
);
240 static inline void create_debug_file(struct at91_udc
*udc
) {}
241 static inline void remove_debug_file(struct at91_udc
*udc
) {}
246 /*-------------------------------------------------------------------------*/
248 static void done(struct at91_ep
*ep
, struct at91_request
*req
, int status
)
250 unsigned stopped
= ep
->stopped
;
251 struct at91_udc
*udc
= ep
->udc
;
253 list_del_init(&req
->queue
);
254 if (req
->req
.status
== -EINPROGRESS
)
255 req
->req
.status
= status
;
257 status
= req
->req
.status
;
258 if (status
&& status
!= -ESHUTDOWN
)
259 VDBG("%s done %p, status %d\n", ep
->ep
.name
, req
, status
);
262 spin_unlock(&udc
->lock
);
263 usb_gadget_giveback_request(&ep
->ep
, &req
->req
);
264 spin_lock(&udc
->lock
);
265 ep
->stopped
= stopped
;
267 /* ep0 is always ready; other endpoints need a non-empty queue */
268 if (list_empty(&ep
->queue
) && ep
->int_mask
!= (1 << 0))
269 at91_udp_write(udc
, AT91_UDP_IDR
, ep
->int_mask
);
272 /*-------------------------------------------------------------------------*/
274 /* bits indicating OUT fifo has data ready */
275 #define RX_DATA_READY (AT91_UDP_RX_DATA_BK0 | AT91_UDP_RX_DATA_BK1)
278 * Endpoint FIFO CSR bits have a mix of bits, making it unsafe to just write
279 * back most of the value you just read (because of side effects, including
280 * bits that may change after reading and before writing).
282 * Except when changing a specific bit, always write values which:
283 * - clear SET_FX bits (setting them could change something)
284 * - set CLR_FX bits (clearing them could change something)
286 * There are also state bits like FORCESTALL, EPEDS, DIR, and EPTYPE
287 * that shouldn't normally be changed.
289 * NOTE at91sam9260 docs mention synch between UDPCK and MCK clock domains,
290 * implying a need to wait for one write to complete (test relevant bits)
291 * before starting the next write. This shouldn't be an issue given how
292 * infrequently we write, except maybe for write-then-read idioms.
294 #define SET_FX (AT91_UDP_TXPKTRDY)
295 #define CLR_FX (RX_DATA_READY | AT91_UDP_RXSETUP \
296 | AT91_UDP_STALLSENT | AT91_UDP_TXCOMP)
298 /* pull OUT packet data from the endpoint's fifo */
299 static int read_fifo (struct at91_ep
*ep
, struct at91_request
*req
)
301 u32 __iomem
*creg
= ep
->creg
;
302 u8 __iomem
*dreg
= ep
->creg
+ (AT91_UDP_FDR(0) - AT91_UDP_CSR(0));
305 unsigned int count
, bufferspace
, is_done
;
307 buf
= req
->req
.buf
+ req
->req
.actual
;
308 bufferspace
= req
->req
.length
- req
->req
.actual
;
311 * there might be nothing to read if ep_queue() calls us,
312 * or if we already emptied both pingpong buffers
315 csr
= __raw_readl(creg
);
316 if ((csr
& RX_DATA_READY
) == 0)
319 count
= (csr
& AT91_UDP_RXBYTECNT
) >> 16;
320 if (count
> ep
->ep
.maxpacket
)
321 count
= ep
->ep
.maxpacket
;
322 if (count
> bufferspace
) {
323 DBG("%s buffer overflow\n", ep
->ep
.name
);
324 req
->req
.status
= -EOVERFLOW
;
327 __raw_readsb(dreg
, buf
, count
);
329 /* release and swap pingpong mem bank */
331 if (ep
->is_pingpong
) {
332 if (ep
->fifo_bank
== 0) {
333 csr
&= ~(SET_FX
| AT91_UDP_RX_DATA_BK0
);
336 csr
&= ~(SET_FX
| AT91_UDP_RX_DATA_BK1
);
340 csr
&= ~(SET_FX
| AT91_UDP_RX_DATA_BK0
);
341 __raw_writel(csr
, creg
);
343 req
->req
.actual
+= count
;
344 is_done
= (count
< ep
->ep
.maxpacket
);
345 if (count
== bufferspace
)
348 PACKET("%s %p out/%d%s\n", ep
->ep
.name
, &req
->req
, count
,
349 is_done
? " (done)" : "");
352 * avoid extra trips through IRQ logic for packets already in
353 * the fifo ... maybe preventing an extra (expensive) OUT-NAK
357 else if (ep
->is_pingpong
) {
359 * One dummy read to delay the code because of a HW glitch:
360 * CSR returns bad RXCOUNT when read too soon after updating
363 csr
= __raw_readl(creg
);
365 bufferspace
-= count
;
373 /* load fifo for an IN packet */
374 static int write_fifo(struct at91_ep
*ep
, struct at91_request
*req
)
376 u32 __iomem
*creg
= ep
->creg
;
377 u32 csr
= __raw_readl(creg
);
378 u8 __iomem
*dreg
= ep
->creg
+ (AT91_UDP_FDR(0) - AT91_UDP_CSR(0));
379 unsigned total
, count
, is_last
;
383 * TODO: allow for writing two packets to the fifo ... that'll
384 * reduce the amount of IN-NAKing, but probably won't affect
385 * throughput much. (Unlike preventing OUT-NAKing!)
389 * If ep_queue() calls us, the queue is empty and possibly in
390 * odd states like TXCOMP not yet cleared (we do it, saving at
391 * least one IRQ) or the fifo not yet being free. Those aren't
392 * issues normally (IRQ handler fast path).
394 if (unlikely(csr
& (AT91_UDP_TXCOMP
| AT91_UDP_TXPKTRDY
))) {
395 if (csr
& AT91_UDP_TXCOMP
) {
397 csr
&= ~(SET_FX
| AT91_UDP_TXCOMP
);
398 __raw_writel(csr
, creg
);
399 csr
= __raw_readl(creg
);
401 if (csr
& AT91_UDP_TXPKTRDY
)
405 buf
= req
->req
.buf
+ req
->req
.actual
;
407 total
= req
->req
.length
- req
->req
.actual
;
408 if (ep
->ep
.maxpacket
< total
) {
409 count
= ep
->ep
.maxpacket
;
413 is_last
= (count
< ep
->ep
.maxpacket
) || !req
->req
.zero
;
417 * Write the packet, maybe it's a ZLP.
419 * NOTE: incrementing req->actual before we receive the ACK means
420 * gadget driver IN bytecounts can be wrong in fault cases. That's
421 * fixable with PIO drivers like this one (save "count" here, and
422 * do the increment later on TX irq), but not for most DMA hardware.
424 * So all gadget drivers must accept that potential error. Some
425 * hardware supports precise fifo status reporting, letting them
426 * recover when the actual bytecount matters (e.g. for USB Test
427 * and Measurement Class devices).
429 __raw_writesb(dreg
, buf
, count
);
431 csr
|= CLR_FX
| AT91_UDP_TXPKTRDY
;
432 __raw_writel(csr
, creg
);
433 req
->req
.actual
+= count
;
435 PACKET("%s %p in/%d%s\n", ep
->ep
.name
, &req
->req
, count
,
436 is_last
? " (done)" : "");
442 static void nuke(struct at91_ep
*ep
, int status
)
444 struct at91_request
*req
;
446 /* terminate any request in the queue */
448 if (list_empty(&ep
->queue
))
451 VDBG("%s %s\n", __func__
, ep
->ep
.name
);
452 while (!list_empty(&ep
->queue
)) {
453 req
= list_entry(ep
->queue
.next
, struct at91_request
, queue
);
454 done(ep
, req
, status
);
458 /*-------------------------------------------------------------------------*/
460 static int at91_ep_enable(struct usb_ep
*_ep
,
461 const struct usb_endpoint_descriptor
*desc
)
463 struct at91_ep
*ep
= container_of(_ep
, struct at91_ep
, ep
);
464 struct at91_udc
*udc
;
470 || !desc
|| _ep
->name
== ep0name
471 || desc
->bDescriptorType
!= USB_DT_ENDPOINT
472 || (maxpacket
= usb_endpoint_maxp(desc
)) == 0
473 || maxpacket
> ep
->maxpacket
) {
474 DBG("bad ep or descriptor\n");
479 if (!udc
->driver
|| udc
->gadget
.speed
== USB_SPEED_UNKNOWN
) {
480 DBG("bogus device state\n");
484 tmp
= usb_endpoint_type(desc
);
486 case USB_ENDPOINT_XFER_CONTROL
:
487 DBG("only one control endpoint\n");
489 case USB_ENDPOINT_XFER_INT
:
493 case USB_ENDPOINT_XFER_BULK
:
502 DBG("bogus maxpacket %d\n", maxpacket
);
504 case USB_ENDPOINT_XFER_ISOC
:
505 if (!ep
->is_pingpong
) {
506 DBG("iso requires double buffering\n");
513 spin_lock_irqsave(&udc
->lock
, flags
);
515 /* initialize endpoint to match this descriptor */
516 ep
->is_in
= usb_endpoint_dir_in(desc
);
517 ep
->is_iso
= (tmp
== USB_ENDPOINT_XFER_ISOC
);
522 tmp
|= AT91_UDP_EPEDS
;
523 __raw_writel(tmp
, ep
->creg
);
525 ep
->ep
.maxpacket
= maxpacket
;
528 * reset/init endpoint fifo. NOTE: leaves fifo_bank alone,
529 * since endpoint resets don't reset hw pingpong state.
531 at91_udp_write(udc
, AT91_UDP_RST_EP
, ep
->int_mask
);
532 at91_udp_write(udc
, AT91_UDP_RST_EP
, 0);
534 spin_unlock_irqrestore(&udc
->lock
, flags
);
538 static int at91_ep_disable (struct usb_ep
* _ep
)
540 struct at91_ep
*ep
= container_of(_ep
, struct at91_ep
, ep
);
541 struct at91_udc
*udc
= ep
->udc
;
544 if (ep
== &ep
->udc
->ep
[0])
547 spin_lock_irqsave(&udc
->lock
, flags
);
549 nuke(ep
, -ESHUTDOWN
);
551 /* restore the endpoint's pristine config */
553 ep
->ep
.maxpacket
= ep
->maxpacket
;
555 /* reset fifos and endpoint */
556 if (ep
->udc
->clocked
) {
557 at91_udp_write(udc
, AT91_UDP_RST_EP
, ep
->int_mask
);
558 at91_udp_write(udc
, AT91_UDP_RST_EP
, 0);
559 __raw_writel(0, ep
->creg
);
562 spin_unlock_irqrestore(&udc
->lock
, flags
);
567 * this is a PIO-only driver, so there's nothing
568 * interesting for request or buffer allocation.
571 static struct usb_request
*
572 at91_ep_alloc_request(struct usb_ep
*_ep
, gfp_t gfp_flags
)
574 struct at91_request
*req
;
576 req
= kzalloc(sizeof (struct at91_request
), gfp_flags
);
580 INIT_LIST_HEAD(&req
->queue
);
584 static void at91_ep_free_request(struct usb_ep
*_ep
, struct usb_request
*_req
)
586 struct at91_request
*req
;
588 req
= container_of(_req
, struct at91_request
, req
);
589 BUG_ON(!list_empty(&req
->queue
));
593 static int at91_ep_queue(struct usb_ep
*_ep
,
594 struct usb_request
*_req
, gfp_t gfp_flags
)
596 struct at91_request
*req
;
598 struct at91_udc
*udc
;
602 req
= container_of(_req
, struct at91_request
, req
);
603 ep
= container_of(_ep
, struct at91_ep
, ep
);
605 if (!_req
|| !_req
->complete
606 || !_req
->buf
|| !list_empty(&req
->queue
)) {
607 DBG("invalid request\n");
611 if (!_ep
|| (!ep
->ep
.desc
&& ep
->ep
.name
!= ep0name
)) {
618 if (!udc
|| !udc
->driver
|| udc
->gadget
.speed
== USB_SPEED_UNKNOWN
) {
619 DBG("invalid device\n");
623 _req
->status
= -EINPROGRESS
;
626 spin_lock_irqsave(&udc
->lock
, flags
);
628 /* try to kickstart any empty and idle queue */
629 if (list_empty(&ep
->queue
) && !ep
->stopped
) {
633 * If this control request has a non-empty DATA stage, this
634 * will start that stage. It works just like a non-control
635 * request (until the status stage starts, maybe early).
637 * If the data stage is empty, then this starts a successful
638 * IN/STATUS stage. (Unsuccessful ones use set_halt.)
640 is_ep0
= (ep
->ep
.name
== ep0name
);
644 if (!udc
->req_pending
) {
650 * defer changing CONFG until after the gadget driver
651 * reconfigures the endpoints.
653 if (udc
->wait_for_config_ack
) {
654 tmp
= at91_udp_read(udc
, AT91_UDP_GLB_STAT
);
655 tmp
^= AT91_UDP_CONFG
;
656 VDBG("toggle config\n");
657 at91_udp_write(udc
, AT91_UDP_GLB_STAT
, tmp
);
659 if (req
->req
.length
== 0) {
661 PACKET("ep0 in/status\n");
663 tmp
= __raw_readl(ep
->creg
);
665 tmp
|= CLR_FX
| AT91_UDP_TXPKTRDY
;
666 __raw_writel(tmp
, ep
->creg
);
667 udc
->req_pending
= 0;
673 status
= write_fifo(ep
, req
);
675 status
= read_fifo(ep
, req
);
677 /* IN/STATUS stage is otherwise triggered by irq */
678 if (status
&& is_ep0
)
684 if (req
&& !status
) {
685 list_add_tail (&req
->queue
, &ep
->queue
);
686 at91_udp_write(udc
, AT91_UDP_IER
, ep
->int_mask
);
689 spin_unlock_irqrestore(&udc
->lock
, flags
);
690 return (status
< 0) ? status
: 0;
693 static int at91_ep_dequeue(struct usb_ep
*_ep
, struct usb_request
*_req
)
696 struct at91_request
*req
;
698 struct at91_udc
*udc
;
700 ep
= container_of(_ep
, struct at91_ep
, ep
);
701 if (!_ep
|| ep
->ep
.name
== ep0name
)
706 spin_lock_irqsave(&udc
->lock
, flags
);
708 /* make sure it's actually queued on this endpoint */
709 list_for_each_entry (req
, &ep
->queue
, queue
) {
710 if (&req
->req
== _req
)
713 if (&req
->req
!= _req
) {
714 spin_unlock_irqrestore(&udc
->lock
, flags
);
718 done(ep
, req
, -ECONNRESET
);
719 spin_unlock_irqrestore(&udc
->lock
, flags
);
723 static int at91_ep_set_halt(struct usb_ep
*_ep
, int value
)
725 struct at91_ep
*ep
= container_of(_ep
, struct at91_ep
, ep
);
726 struct at91_udc
*udc
= ep
->udc
;
732 if (!_ep
|| ep
->is_iso
|| !ep
->udc
->clocked
)
736 spin_lock_irqsave(&udc
->lock
, flags
);
738 csr
= __raw_readl(creg
);
741 * fail with still-busy IN endpoints, ensuring correct sequencing
742 * of data tx then stall. note that the fifo rx bytecount isn't
743 * completely accurate as a tx bytecount.
745 if (ep
->is_in
&& (!list_empty(&ep
->queue
) || (csr
>> 16) != 0))
751 csr
|= AT91_UDP_FORCESTALL
;
752 VDBG("halt %s\n", ep
->ep
.name
);
754 at91_udp_write(udc
, AT91_UDP_RST_EP
, ep
->int_mask
);
755 at91_udp_write(udc
, AT91_UDP_RST_EP
, 0);
756 csr
&= ~AT91_UDP_FORCESTALL
;
758 __raw_writel(csr
, creg
);
761 spin_unlock_irqrestore(&udc
->lock
, flags
);
765 static const struct usb_ep_ops at91_ep_ops
= {
766 .enable
= at91_ep_enable
,
767 .disable
= at91_ep_disable
,
768 .alloc_request
= at91_ep_alloc_request
,
769 .free_request
= at91_ep_free_request
,
770 .queue
= at91_ep_queue
,
771 .dequeue
= at91_ep_dequeue
,
772 .set_halt
= at91_ep_set_halt
,
773 /* there's only imprecise fifo status reporting */
776 /*-------------------------------------------------------------------------*/
778 static int at91_get_frame(struct usb_gadget
*gadget
)
780 struct at91_udc
*udc
= to_udc(gadget
);
782 if (!to_udc(gadget
)->clocked
)
784 return at91_udp_read(udc
, AT91_UDP_FRM_NUM
) & AT91_UDP_NUM
;
787 static int at91_wakeup(struct usb_gadget
*gadget
)
789 struct at91_udc
*udc
= to_udc(gadget
);
791 int status
= -EINVAL
;
794 DBG("%s\n", __func__
);
795 spin_lock_irqsave(&udc
->lock
, flags
);
797 if (!udc
->clocked
|| !udc
->suspended
)
800 /* NOTE: some "early versions" handle ESR differently ... */
802 glbstate
= at91_udp_read(udc
, AT91_UDP_GLB_STAT
);
803 if (!(glbstate
& AT91_UDP_ESR
))
805 glbstate
|= AT91_UDP_ESR
;
806 at91_udp_write(udc
, AT91_UDP_GLB_STAT
, glbstate
);
809 spin_unlock_irqrestore(&udc
->lock
, flags
);
813 /* reinit == restore initial software state */
814 static void udc_reinit(struct at91_udc
*udc
)
818 INIT_LIST_HEAD(&udc
->gadget
.ep_list
);
819 INIT_LIST_HEAD(&udc
->gadget
.ep0
->ep_list
);
821 for (i
= 0; i
< NUM_ENDPOINTS
; i
++) {
822 struct at91_ep
*ep
= &udc
->ep
[i
];
825 list_add_tail(&ep
->ep
.ep_list
, &udc
->gadget
.ep_list
);
829 usb_ep_set_maxpacket_limit(&ep
->ep
, ep
->maxpacket
);
830 ep
->creg
= (void __iomem
*) udc
->udp_baseaddr
+ AT91_UDP_CSR(i
);
831 /* initialize one queue per endpoint */
832 INIT_LIST_HEAD(&ep
->queue
);
836 static void reset_gadget(struct at91_udc
*udc
)
838 struct usb_gadget_driver
*driver
= udc
->driver
;
841 if (udc
->gadget
.speed
== USB_SPEED_UNKNOWN
)
843 udc
->gadget
.speed
= USB_SPEED_UNKNOWN
;
846 for (i
= 0; i
< NUM_ENDPOINTS
; i
++) {
847 struct at91_ep
*ep
= &udc
->ep
[i
];
850 nuke(ep
, -ESHUTDOWN
);
853 spin_unlock(&udc
->lock
);
854 usb_gadget_udc_reset(&udc
->gadget
, driver
);
855 spin_lock(&udc
->lock
);
861 static void stop_activity(struct at91_udc
*udc
)
863 struct usb_gadget_driver
*driver
= udc
->driver
;
866 if (udc
->gadget
.speed
== USB_SPEED_UNKNOWN
)
868 udc
->gadget
.speed
= USB_SPEED_UNKNOWN
;
871 for (i
= 0; i
< NUM_ENDPOINTS
; i
++) {
872 struct at91_ep
*ep
= &udc
->ep
[i
];
874 nuke(ep
, -ESHUTDOWN
);
877 spin_unlock(&udc
->lock
);
878 driver
->disconnect(&udc
->gadget
);
879 spin_lock(&udc
->lock
);
885 static void clk_on(struct at91_udc
*udc
)
891 clk_enable(udc
->iclk
);
892 clk_enable(udc
->fclk
);
895 static void clk_off(struct at91_udc
*udc
)
900 udc
->gadget
.speed
= USB_SPEED_UNKNOWN
;
901 clk_disable(udc
->fclk
);
902 clk_disable(udc
->iclk
);
906 * activate/deactivate link with host; minimize power usage for
907 * inactive links by cutting clocks and transceiver power.
909 static void pullup(struct at91_udc
*udc
, int is_on
)
911 if (!udc
->enabled
|| !udc
->vbus
)
913 DBG("%sactive\n", is_on
? "" : "in");
917 at91_udp_write(udc
, AT91_UDP_ICR
, AT91_UDP_RXRSM
);
918 at91_udp_write(udc
, AT91_UDP_TXVC
, 0);
921 at91_udp_write(udc
, AT91_UDP_IDR
, AT91_UDP_RXRSM
);
922 at91_udp_write(udc
, AT91_UDP_TXVC
, AT91_UDP_TXVC_TXVDIS
);
926 if (udc
->caps
&& udc
->caps
->pullup
)
927 udc
->caps
->pullup(udc
, is_on
);
930 /* vbus is here! turn everything on that's ready */
931 static int at91_vbus_session(struct usb_gadget
*gadget
, int is_active
)
933 struct at91_udc
*udc
= to_udc(gadget
);
936 /* VDBG("vbus %s\n", is_active ? "on" : "off"); */
937 spin_lock_irqsave(&udc
->lock
, flags
);
938 udc
->vbus
= (is_active
!= 0);
940 pullup(udc
, is_active
);
943 spin_unlock_irqrestore(&udc
->lock
, flags
);
947 static int at91_pullup(struct usb_gadget
*gadget
, int is_on
)
949 struct at91_udc
*udc
= to_udc(gadget
);
952 spin_lock_irqsave(&udc
->lock
, flags
);
953 udc
->enabled
= is_on
= !!is_on
;
955 spin_unlock_irqrestore(&udc
->lock
, flags
);
959 static int at91_set_selfpowered(struct usb_gadget
*gadget
, int is_on
)
961 struct at91_udc
*udc
= to_udc(gadget
);
964 spin_lock_irqsave(&udc
->lock
, flags
);
965 udc
->selfpowered
= (is_on
!= 0);
966 spin_unlock_irqrestore(&udc
->lock
, flags
);
970 static int at91_start(struct usb_gadget
*gadget
,
971 struct usb_gadget_driver
*driver
);
972 static int at91_stop(struct usb_gadget
*gadget
);
974 static const struct usb_gadget_ops at91_udc_ops
= {
975 .get_frame
= at91_get_frame
,
976 .wakeup
= at91_wakeup
,
977 .set_selfpowered
= at91_set_selfpowered
,
978 .vbus_session
= at91_vbus_session
,
979 .pullup
= at91_pullup
,
980 .udc_start
= at91_start
,
981 .udc_stop
= at91_stop
,
984 * VBUS-powered devices may also also want to support bigger
985 * power budgets after an appropriate SET_CONFIGURATION.
987 /* .vbus_power = at91_vbus_power, */
990 /*-------------------------------------------------------------------------*/
992 static int handle_ep(struct at91_ep
*ep
)
994 struct at91_request
*req
;
995 u32 __iomem
*creg
= ep
->creg
;
996 u32 csr
= __raw_readl(creg
);
998 if (!list_empty(&ep
->queue
))
999 req
= list_entry(ep
->queue
.next
,
1000 struct at91_request
, queue
);
1005 if (csr
& (AT91_UDP_STALLSENT
| AT91_UDP_TXCOMP
)) {
1007 csr
&= ~(SET_FX
| AT91_UDP_STALLSENT
| AT91_UDP_TXCOMP
);
1008 __raw_writel(csr
, creg
);
1011 return write_fifo(ep
, req
);
1014 if (csr
& AT91_UDP_STALLSENT
) {
1015 /* STALLSENT bit == ISOERR */
1016 if (ep
->is_iso
&& req
)
1017 req
->req
.status
= -EILSEQ
;
1019 csr
&= ~(SET_FX
| AT91_UDP_STALLSENT
);
1020 __raw_writel(csr
, creg
);
1021 csr
= __raw_readl(creg
);
1023 if (req
&& (csr
& RX_DATA_READY
))
1024 return read_fifo(ep
, req
);
1031 struct usb_ctrlrequest r
;
1034 static void handle_setup(struct at91_udc
*udc
, struct at91_ep
*ep
, u32 csr
)
1036 u32 __iomem
*creg
= ep
->creg
;
1037 u8 __iomem
*dreg
= ep
->creg
+ (AT91_UDP_FDR(0) - AT91_UDP_CSR(0));
1038 unsigned rxcount
, i
= 0;
1043 /* read and ack SETUP; hard-fail for bogus packets */
1044 rxcount
= (csr
& AT91_UDP_RXBYTECNT
) >> 16;
1045 if (likely(rxcount
== 8)) {
1047 pkt
.raw
[i
++] = __raw_readb(dreg
);
1048 if (pkt
.r
.bRequestType
& USB_DIR_IN
) {
1049 csr
|= AT91_UDP_DIR
;
1052 csr
&= ~AT91_UDP_DIR
;
1056 /* REVISIT this happens sometimes under load; why?? */
1057 ERR("SETUP len %d, csr %08x\n", rxcount
, csr
);
1061 csr
&= ~(SET_FX
| AT91_UDP_RXSETUP
);
1062 __raw_writel(csr
, creg
);
1063 udc
->wait_for_addr_ack
= 0;
1064 udc
->wait_for_config_ack
= 0;
1066 if (unlikely(status
!= 0))
1069 #define w_index le16_to_cpu(pkt.r.wIndex)
1070 #define w_value le16_to_cpu(pkt.r.wValue)
1071 #define w_length le16_to_cpu(pkt.r.wLength)
1073 VDBG("SETUP %02x.%02x v%04x i%04x l%04x\n",
1074 pkt
.r
.bRequestType
, pkt
.r
.bRequest
,
1075 w_value
, w_index
, w_length
);
1078 * A few standard requests get handled here, ones that touch
1079 * hardware ... notably for device and endpoint features.
1081 udc
->req_pending
= 1;
1082 csr
= __raw_readl(creg
);
1085 switch ((pkt
.r
.bRequestType
<< 8) | pkt
.r
.bRequest
) {
1087 case ((USB_TYPE_STANDARD
|USB_RECIP_DEVICE
) << 8)
1088 | USB_REQ_SET_ADDRESS
:
1089 __raw_writel(csr
| AT91_UDP_TXPKTRDY
, creg
);
1090 udc
->addr
= w_value
;
1091 udc
->wait_for_addr_ack
= 1;
1092 udc
->req_pending
= 0;
1093 /* FADDR is set later, when we ack host STATUS */
1096 case ((USB_TYPE_STANDARD
|USB_RECIP_DEVICE
) << 8)
1097 | USB_REQ_SET_CONFIGURATION
:
1098 tmp
= at91_udp_read(udc
, AT91_UDP_GLB_STAT
) & AT91_UDP_CONFG
;
1100 udc
->wait_for_config_ack
= (tmp
== 0);
1102 udc
->wait_for_config_ack
= (tmp
!= 0);
1103 if (udc
->wait_for_config_ack
)
1104 VDBG("wait for config\n");
1105 /* CONFG is toggled later, if gadget driver succeeds */
1109 * Hosts may set or clear remote wakeup status, and
1110 * devices may report they're VBUS powered.
1112 case ((USB_DIR_IN
|USB_TYPE_STANDARD
|USB_RECIP_DEVICE
) << 8)
1113 | USB_REQ_GET_STATUS
:
1114 tmp
= (udc
->selfpowered
<< USB_DEVICE_SELF_POWERED
);
1115 if (at91_udp_read(udc
, AT91_UDP_GLB_STAT
) & AT91_UDP_ESR
)
1116 tmp
|= (1 << USB_DEVICE_REMOTE_WAKEUP
);
1117 PACKET("get device status\n");
1118 __raw_writeb(tmp
, dreg
);
1119 __raw_writeb(0, dreg
);
1121 /* then STATUS starts later, automatically */
1122 case ((USB_TYPE_STANDARD
|USB_RECIP_DEVICE
) << 8)
1123 | USB_REQ_SET_FEATURE
:
1124 if (w_value
!= USB_DEVICE_REMOTE_WAKEUP
)
1126 tmp
= at91_udp_read(udc
, AT91_UDP_GLB_STAT
);
1127 tmp
|= AT91_UDP_ESR
;
1128 at91_udp_write(udc
, AT91_UDP_GLB_STAT
, tmp
);
1130 case ((USB_TYPE_STANDARD
|USB_RECIP_DEVICE
) << 8)
1131 | USB_REQ_CLEAR_FEATURE
:
1132 if (w_value
!= USB_DEVICE_REMOTE_WAKEUP
)
1134 tmp
= at91_udp_read(udc
, AT91_UDP_GLB_STAT
);
1135 tmp
&= ~AT91_UDP_ESR
;
1136 at91_udp_write(udc
, AT91_UDP_GLB_STAT
, tmp
);
1140 * Interfaces have no feature settings; this is pretty useless.
1141 * we won't even insist the interface exists...
1143 case ((USB_DIR_IN
|USB_TYPE_STANDARD
|USB_RECIP_INTERFACE
) << 8)
1144 | USB_REQ_GET_STATUS
:
1145 PACKET("get interface status\n");
1146 __raw_writeb(0, dreg
);
1147 __raw_writeb(0, dreg
);
1149 /* then STATUS starts later, automatically */
1150 case ((USB_TYPE_STANDARD
|USB_RECIP_INTERFACE
) << 8)
1151 | USB_REQ_SET_FEATURE
:
1152 case ((USB_TYPE_STANDARD
|USB_RECIP_INTERFACE
) << 8)
1153 | USB_REQ_CLEAR_FEATURE
:
1157 * Hosts may clear bulk/intr endpoint halt after the gadget
1158 * driver sets it (not widely used); or set it (for testing)
1160 case ((USB_DIR_IN
|USB_TYPE_STANDARD
|USB_RECIP_ENDPOINT
) << 8)
1161 | USB_REQ_GET_STATUS
:
1162 tmp
= w_index
& USB_ENDPOINT_NUMBER_MASK
;
1164 if (tmp
>= NUM_ENDPOINTS
|| (tmp
&& !ep
->ep
.desc
))
1168 if ((w_index
& USB_DIR_IN
)) {
1171 } else if (ep
->is_in
)
1174 PACKET("get %s status\n", ep
->ep
.name
);
1175 if (__raw_readl(ep
->creg
) & AT91_UDP_FORCESTALL
)
1176 tmp
= (1 << USB_ENDPOINT_HALT
);
1179 __raw_writeb(tmp
, dreg
);
1180 __raw_writeb(0, dreg
);
1182 /* then STATUS starts later, automatically */
1183 case ((USB_TYPE_STANDARD
|USB_RECIP_ENDPOINT
) << 8)
1184 | USB_REQ_SET_FEATURE
:
1185 tmp
= w_index
& USB_ENDPOINT_NUMBER_MASK
;
1187 if (w_value
!= USB_ENDPOINT_HALT
|| tmp
>= NUM_ENDPOINTS
)
1189 if (!ep
->ep
.desc
|| ep
->is_iso
)
1191 if ((w_index
& USB_DIR_IN
)) {
1194 } else if (ep
->is_in
)
1197 tmp
= __raw_readl(ep
->creg
);
1199 tmp
|= CLR_FX
| AT91_UDP_FORCESTALL
;
1200 __raw_writel(tmp
, ep
->creg
);
1202 case ((USB_TYPE_STANDARD
|USB_RECIP_ENDPOINT
) << 8)
1203 | USB_REQ_CLEAR_FEATURE
:
1204 tmp
= w_index
& USB_ENDPOINT_NUMBER_MASK
;
1206 if (w_value
!= USB_ENDPOINT_HALT
|| tmp
>= NUM_ENDPOINTS
)
1210 if (!ep
->ep
.desc
|| ep
->is_iso
)
1212 if ((w_index
& USB_DIR_IN
)) {
1215 } else if (ep
->is_in
)
1218 at91_udp_write(udc
, AT91_UDP_RST_EP
, ep
->int_mask
);
1219 at91_udp_write(udc
, AT91_UDP_RST_EP
, 0);
1220 tmp
= __raw_readl(ep
->creg
);
1222 tmp
&= ~(SET_FX
| AT91_UDP_FORCESTALL
);
1223 __raw_writel(tmp
, ep
->creg
);
1224 if (!list_empty(&ep
->queue
))
1233 /* pass request up to the gadget driver */
1235 spin_unlock(&udc
->lock
);
1236 status
= udc
->driver
->setup(&udc
->gadget
, &pkt
.r
);
1237 spin_lock(&udc
->lock
);
1243 VDBG("req %02x.%02x protocol STALL; stat %d\n",
1244 pkt
.r
.bRequestType
, pkt
.r
.bRequest
, status
);
1245 csr
|= AT91_UDP_FORCESTALL
;
1246 __raw_writel(csr
, creg
);
1247 udc
->req_pending
= 0;
1252 /* immediate successful (IN) STATUS after zero length DATA */
1253 PACKET("ep0 in/status\n");
1255 csr
|= AT91_UDP_TXPKTRDY
;
1256 __raw_writel(csr
, creg
);
1257 udc
->req_pending
= 0;
1260 static void handle_ep0(struct at91_udc
*udc
)
1262 struct at91_ep
*ep0
= &udc
->ep
[0];
1263 u32 __iomem
*creg
= ep0
->creg
;
1264 u32 csr
= __raw_readl(creg
);
1265 struct at91_request
*req
;
1267 if (unlikely(csr
& AT91_UDP_STALLSENT
)) {
1269 udc
->req_pending
= 0;
1271 csr
&= ~(SET_FX
| AT91_UDP_STALLSENT
| AT91_UDP_FORCESTALL
);
1272 __raw_writel(csr
, creg
);
1273 VDBG("ep0 stalled\n");
1274 csr
= __raw_readl(creg
);
1276 if (csr
& AT91_UDP_RXSETUP
) {
1278 udc
->req_pending
= 0;
1279 handle_setup(udc
, ep0
, csr
);
1283 if (list_empty(&ep0
->queue
))
1286 req
= list_entry(ep0
->queue
.next
, struct at91_request
, queue
);
1288 /* host ACKed an IN packet that we sent */
1289 if (csr
& AT91_UDP_TXCOMP
) {
1291 csr
&= ~(SET_FX
| AT91_UDP_TXCOMP
);
1293 /* write more IN DATA? */
1294 if (req
&& ep0
->is_in
) {
1296 udc
->req_pending
= 0;
1300 * - last IN DATA packet (including GET_STATUS)
1301 * - IN/STATUS for OUT DATA
1302 * - IN/STATUS for any zero-length DATA stage
1303 * except for the IN DATA case, the host should send
1304 * an OUT status later, which we'll ack.
1307 udc
->req_pending
= 0;
1308 __raw_writel(csr
, creg
);
1311 * SET_ADDRESS takes effect only after the STATUS
1312 * (to the original address) gets acked.
1314 if (udc
->wait_for_addr_ack
) {
1317 at91_udp_write(udc
, AT91_UDP_FADDR
,
1318 AT91_UDP_FEN
| udc
->addr
);
1319 tmp
= at91_udp_read(udc
, AT91_UDP_GLB_STAT
);
1320 tmp
&= ~AT91_UDP_FADDEN
;
1322 tmp
|= AT91_UDP_FADDEN
;
1323 at91_udp_write(udc
, AT91_UDP_GLB_STAT
, tmp
);
1325 udc
->wait_for_addr_ack
= 0;
1326 VDBG("address %d\n", udc
->addr
);
1331 /* OUT packet arrived ... */
1332 else if (csr
& AT91_UDP_RX_DATA_BK0
) {
1334 csr
&= ~(SET_FX
| AT91_UDP_RX_DATA_BK0
);
1336 /* OUT DATA stage */
1339 if (handle_ep(ep0
)) {
1340 /* send IN/STATUS */
1341 PACKET("ep0 in/status\n");
1342 csr
= __raw_readl(creg
);
1344 csr
|= CLR_FX
| AT91_UDP_TXPKTRDY
;
1345 __raw_writel(csr
, creg
);
1346 udc
->req_pending
= 0;
1348 } else if (udc
->req_pending
) {
1350 * AT91 hardware has a hard time with this
1351 * "deferred response" mode for control-OUT
1352 * transfers. (For control-IN it's fine.)
1354 * The normal solution leaves OUT data in the
1355 * fifo until the gadget driver is ready.
1356 * We couldn't do that here without disabling
1357 * the IRQ that tells about SETUP packets,
1358 * e.g. when the host gets impatient...
1360 * Working around it by copying into a buffer
1361 * would almost be a non-deferred response,
1362 * except that it wouldn't permit reliable
1363 * stalling of the request. Instead, demand
1364 * that gadget drivers not use this mode.
1366 DBG("no control-OUT deferred responses!\n");
1367 __raw_writel(csr
| AT91_UDP_FORCESTALL
, creg
);
1368 udc
->req_pending
= 0;
1371 /* STATUS stage for control-IN; ack. */
1373 PACKET("ep0 out/status ACK\n");
1374 __raw_writel(csr
, creg
);
1376 /* "early" status stage */
1383 static irqreturn_t
at91_udc_irq (int irq
, void *_udc
)
1385 struct at91_udc
*udc
= _udc
;
1387 int disable_clock
= 0;
1388 unsigned long flags
;
1390 spin_lock_irqsave(&udc
->lock
, flags
);
1392 if (!udc
->clocked
) {
1400 status
= at91_udp_read(udc
, AT91_UDP_ISR
)
1401 & at91_udp_read(udc
, AT91_UDP_IMR
);
1405 /* USB reset irq: not maskable */
1406 if (status
& AT91_UDP_ENDBUSRES
) {
1407 at91_udp_write(udc
, AT91_UDP_IDR
, ~MINIMUS_INTERRUPTUS
);
1408 at91_udp_write(udc
, AT91_UDP_IER
, MINIMUS_INTERRUPTUS
);
1409 /* Atmel code clears this irq twice */
1410 at91_udp_write(udc
, AT91_UDP_ICR
, AT91_UDP_ENDBUSRES
);
1411 at91_udp_write(udc
, AT91_UDP_ICR
, AT91_UDP_ENDBUSRES
);
1412 VDBG("end bus reset\n");
1417 at91_udp_write(udc
, AT91_UDP_CSR(0),
1418 AT91_UDP_EPEDS
| AT91_UDP_EPTYPE_CTRL
);
1419 udc
->gadget
.speed
= USB_SPEED_FULL
;
1421 at91_udp_write(udc
, AT91_UDP_IER
, AT91_UDP_EP(0));
1424 * NOTE: this driver keeps clocks off unless the
1425 * USB host is present. That saves power, but for
1426 * boards that don't support VBUS detection, both
1427 * clocks need to be active most of the time.
1430 /* host initiated suspend (3+ms bus idle) */
1431 } else if (status
& AT91_UDP_RXSUSP
) {
1432 at91_udp_write(udc
, AT91_UDP_IDR
, AT91_UDP_RXSUSP
);
1433 at91_udp_write(udc
, AT91_UDP_IER
, AT91_UDP_RXRSM
);
1434 at91_udp_write(udc
, AT91_UDP_ICR
, AT91_UDP_RXSUSP
);
1435 /* VDBG("bus suspend\n"); */
1441 * NOTE: when suspending a VBUS-powered device, the
1442 * gadget driver should switch into slow clock mode
1443 * and then into standby to avoid drawing more than
1444 * 500uA power (2500uA for some high-power configs).
1446 if (udc
->driver
&& udc
->driver
->suspend
) {
1447 spin_unlock(&udc
->lock
);
1448 udc
->driver
->suspend(&udc
->gadget
);
1449 spin_lock(&udc
->lock
);
1452 /* host initiated resume */
1453 } else if (status
& AT91_UDP_RXRSM
) {
1454 at91_udp_write(udc
, AT91_UDP_IDR
, AT91_UDP_RXRSM
);
1455 at91_udp_write(udc
, AT91_UDP_IER
, AT91_UDP_RXSUSP
);
1456 at91_udp_write(udc
, AT91_UDP_ICR
, AT91_UDP_RXRSM
);
1457 /* VDBG("bus resume\n"); */
1458 if (!udc
->suspended
)
1463 * NOTE: for a VBUS-powered device, the gadget driver
1464 * would normally want to switch out of slow clock
1465 * mode into normal mode.
1467 if (udc
->driver
&& udc
->driver
->resume
) {
1468 spin_unlock(&udc
->lock
);
1469 udc
->driver
->resume(&udc
->gadget
);
1470 spin_lock(&udc
->lock
);
1473 /* endpoint IRQs are cleared by handling them */
1477 struct at91_ep
*ep
= &udc
->ep
[1];
1481 for (i
= 1; i
< NUM_ENDPOINTS
; i
++) {
1493 spin_unlock_irqrestore(&udc
->lock
, flags
);
1498 /*-------------------------------------------------------------------------*/
1500 static struct at91_udc controller
= {
1502 .ops
= &at91_udc_ops
,
1503 .ep0
= &controller
.ep
[0].ep
,
1504 .name
= driver_name
,
1509 .ops
= &at91_ep_ops
,
1518 .ops
= &at91_ep_ops
,
1528 .ops
= &at91_ep_ops
,
1537 /* could actually do bulk too */
1539 .ops
= &at91_ep_ops
,
1548 .ops
= &at91_ep_ops
,
1558 .ops
= &at91_ep_ops
,
1565 /* ep6 and ep7 are also reserved (custom silicon might use them) */
1568 static void at91_vbus_update(struct at91_udc
*udc
, unsigned value
)
1570 value
^= udc
->board
.vbus_active_low
;
1571 if (value
!= udc
->vbus
)
1572 at91_vbus_session(&udc
->gadget
, value
);
1575 static irqreturn_t
at91_vbus_irq(int irq
, void *_udc
)
1577 struct at91_udc
*udc
= _udc
;
1579 /* vbus needs at least brief debouncing */
1581 at91_vbus_update(udc
, gpio_get_value(udc
->board
.vbus_pin
));
1586 static void at91_vbus_timer_work(struct work_struct
*work
)
1588 struct at91_udc
*udc
= container_of(work
, struct at91_udc
,
1591 at91_vbus_update(udc
, gpio_get_value_cansleep(udc
->board
.vbus_pin
));
1593 if (!timer_pending(&udc
->vbus_timer
))
1594 mod_timer(&udc
->vbus_timer
, jiffies
+ VBUS_POLL_TIMEOUT
);
1597 static void at91_vbus_timer(unsigned long data
)
1599 struct at91_udc
*udc
= (struct at91_udc
*)data
;
1602 * If we are polling vbus it is likely that the gpio is on an
1603 * bus such as i2c or spi which may sleep, so schedule some work
1604 * to read the vbus gpio
1606 schedule_work(&udc
->vbus_timer_work
);
1609 static int at91_start(struct usb_gadget
*gadget
,
1610 struct usb_gadget_driver
*driver
)
1612 struct at91_udc
*udc
;
1614 udc
= container_of(gadget
, struct at91_udc
, gadget
);
1615 udc
->driver
= driver
;
1616 udc
->gadget
.dev
.of_node
= udc
->pdev
->dev
.of_node
;
1618 udc
->selfpowered
= 1;
1623 static int at91_stop(struct usb_gadget
*gadget
)
1625 struct at91_udc
*udc
;
1626 unsigned long flags
;
1628 udc
= container_of(gadget
, struct at91_udc
, gadget
);
1629 spin_lock_irqsave(&udc
->lock
, flags
);
1631 at91_udp_write(udc
, AT91_UDP_IDR
, ~0);
1632 spin_unlock_irqrestore(&udc
->lock
, flags
);
1639 /*-------------------------------------------------------------------------*/
1641 static void at91udc_shutdown(struct platform_device
*dev
)
1643 struct at91_udc
*udc
= platform_get_drvdata(dev
);
1644 unsigned long flags
;
1646 /* force disconnect on reboot */
1647 spin_lock_irqsave(&udc
->lock
, flags
);
1648 pullup(platform_get_drvdata(dev
), 0);
1649 spin_unlock_irqrestore(&udc
->lock
, flags
);
1652 static int at91rm9200_udc_init(struct at91_udc
*udc
)
1658 for (i
= 0; i
< NUM_ENDPOINTS
; i
++) {
1670 ep
->maxpacket
= 256;
1675 if (!gpio_is_valid(udc
->board
.pullup_pin
)) {
1676 DBG("no D+ pullup?\n");
1680 ret
= devm_gpio_request(&udc
->pdev
->dev
, udc
->board
.pullup_pin
,
1683 DBG("D+ pullup is busy\n");
1687 gpio_direction_output(udc
->board
.pullup_pin
,
1688 udc
->board
.pullup_active_low
);
1693 static void at91rm9200_udc_pullup(struct at91_udc
*udc
, int is_on
)
1695 int active
= !udc
->board
.pullup_active_low
;
1698 gpio_set_value(udc
->board
.pullup_pin
, active
);
1700 gpio_set_value(udc
->board
.pullup_pin
, !active
);
1703 static const struct at91_udc_caps at91rm9200_udc_caps
= {
1704 .init
= at91rm9200_udc_init
,
1705 .pullup
= at91rm9200_udc_pullup
,
1708 static int at91sam9260_udc_init(struct at91_udc
*udc
)
1713 for (i
= 0; i
< NUM_ENDPOINTS
; i
++) {
1721 ep
->maxpacket
= 512;
1729 static void at91sam9260_udc_pullup(struct at91_udc
*udc
, int is_on
)
1731 u32 txvc
= at91_udp_read(udc
, AT91_UDP_TXVC
);
1734 txvc
|= AT91_UDP_TXVC_PUON
;
1736 txvc
&= ~AT91_UDP_TXVC_PUON
;
1738 at91_udp_write(udc
, AT91_UDP_TXVC
, txvc
);
1741 static const struct at91_udc_caps at91sam9260_udc_caps
= {
1742 .init
= at91sam9260_udc_init
,
1743 .pullup
= at91sam9260_udc_pullup
,
1746 static int at91sam9261_udc_init(struct at91_udc
*udc
)
1751 for (i
= 0; i
< NUM_ENDPOINTS
; i
++) {
1762 ep
->maxpacket
= 256;
1767 udc
->matrix
= syscon_regmap_lookup_by_phandle(udc
->pdev
->dev
.of_node
,
1769 if (IS_ERR(udc
->matrix
))
1770 return PTR_ERR(udc
->matrix
);
1775 static void at91sam9261_udc_pullup(struct at91_udc
*udc
, int is_on
)
1780 usbpucr
= AT91_MATRIX_USBPUCR_PUON
;
1782 regmap_update_bits(udc
->matrix
, AT91SAM9261_MATRIX_USBPUCR
,
1783 AT91_MATRIX_USBPUCR_PUON
, usbpucr
);
1786 static const struct at91_udc_caps at91sam9261_udc_caps
= {
1787 .init
= at91sam9261_udc_init
,
1788 .pullup
= at91sam9261_udc_pullup
,
1791 static int at91sam9263_udc_init(struct at91_udc
*udc
)
1796 for (i
= 0; i
< NUM_ENDPOINTS
; i
++) {
1808 ep
->maxpacket
= 256;
1816 static const struct at91_udc_caps at91sam9263_udc_caps
= {
1817 .init
= at91sam9263_udc_init
,
1818 .pullup
= at91sam9260_udc_pullup
,
1821 static const struct of_device_id at91_udc_dt_ids
[] = {
1823 .compatible
= "atmel,at91rm9200-udc",
1824 .data
= &at91rm9200_udc_caps
,
1827 .compatible
= "atmel,at91sam9260-udc",
1828 .data
= &at91sam9260_udc_caps
,
1831 .compatible
= "atmel,at91sam9261-udc",
1832 .data
= &at91sam9261_udc_caps
,
1835 .compatible
= "atmel,at91sam9263-udc",
1836 .data
= &at91sam9263_udc_caps
,
1840 MODULE_DEVICE_TABLE(of
, at91_udc_dt_ids
);
1842 static void at91udc_of_init(struct at91_udc
*udc
, struct device_node
*np
)
1844 struct at91_udc_data
*board
= &udc
->board
;
1845 const struct of_device_id
*match
;
1846 enum of_gpio_flags flags
;
1849 if (of_property_read_u32(np
, "atmel,vbus-polled", &val
) == 0)
1850 board
->vbus_polled
= 1;
1852 board
->vbus_pin
= of_get_named_gpio_flags(np
, "atmel,vbus-gpio", 0,
1854 board
->vbus_active_low
= (flags
& OF_GPIO_ACTIVE_LOW
) ? 1 : 0;
1856 board
->pullup_pin
= of_get_named_gpio_flags(np
, "atmel,pullup-gpio", 0,
1859 board
->pullup_active_low
= (flags
& OF_GPIO_ACTIVE_LOW
) ? 1 : 0;
1861 match
= of_match_node(at91_udc_dt_ids
, np
);
1863 udc
->caps
= match
->data
;
1866 static int at91udc_probe(struct platform_device
*pdev
)
1868 struct device
*dev
= &pdev
->dev
;
1869 struct at91_udc
*udc
;
1871 struct resource
*res
;
1875 /* init software state */
1877 udc
->gadget
.dev
.parent
= dev
;
1878 at91udc_of_init(udc
, pdev
->dev
.of_node
);
1881 spin_lock_init(&udc
->lock
);
1885 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
1886 udc
->udp_baseaddr
= devm_ioremap_resource(dev
, res
);
1887 if (IS_ERR(udc
->udp_baseaddr
))
1888 return PTR_ERR(udc
->udp_baseaddr
);
1890 if (udc
->caps
&& udc
->caps
->init
) {
1891 retval
= udc
->caps
->init(udc
);
1898 /* get interface and function clocks */
1899 udc
->iclk
= devm_clk_get(dev
, "pclk");
1900 if (IS_ERR(udc
->iclk
))
1901 return PTR_ERR(udc
->iclk
);
1903 udc
->fclk
= devm_clk_get(dev
, "hclk");
1904 if (IS_ERR(udc
->fclk
))
1905 return PTR_ERR(udc
->fclk
);
1907 /* don't do anything until we have both gadget driver and VBUS */
1908 clk_set_rate(udc
->fclk
, 48000000);
1909 retval
= clk_prepare(udc
->fclk
);
1913 retval
= clk_prepare_enable(udc
->iclk
);
1915 goto err_unprepare_fclk
;
1917 at91_udp_write(udc
, AT91_UDP_TXVC
, AT91_UDP_TXVC_TXVDIS
);
1918 at91_udp_write(udc
, AT91_UDP_IDR
, 0xffffffff);
1919 /* Clear all pending interrupts - UDP may be used by bootloader. */
1920 at91_udp_write(udc
, AT91_UDP_ICR
, 0xffffffff);
1921 clk_disable(udc
->iclk
);
1923 /* request UDC and maybe VBUS irqs */
1924 udc
->udp_irq
= platform_get_irq(pdev
, 0);
1925 retval
= devm_request_irq(dev
, udc
->udp_irq
, at91_udc_irq
, 0,
1928 DBG("request irq %d failed\n", udc
->udp_irq
);
1929 goto err_unprepare_iclk
;
1932 if (gpio_is_valid(udc
->board
.vbus_pin
)) {
1933 retval
= devm_gpio_request(dev
, udc
->board
.vbus_pin
,
1936 DBG("request vbus pin failed\n");
1937 goto err_unprepare_iclk
;
1940 gpio_direction_input(udc
->board
.vbus_pin
);
1943 * Get the initial state of VBUS - we cannot expect
1944 * a pending interrupt.
1946 udc
->vbus
= gpio_get_value_cansleep(udc
->board
.vbus_pin
) ^
1947 udc
->board
.vbus_active_low
;
1949 if (udc
->board
.vbus_polled
) {
1950 INIT_WORK(&udc
->vbus_timer_work
, at91_vbus_timer_work
);
1951 setup_timer(&udc
->vbus_timer
, at91_vbus_timer
,
1952 (unsigned long)udc
);
1953 mod_timer(&udc
->vbus_timer
,
1954 jiffies
+ VBUS_POLL_TIMEOUT
);
1956 retval
= devm_request_irq(dev
,
1957 gpio_to_irq(udc
->board
.vbus_pin
),
1958 at91_vbus_irq
, 0, driver_name
, udc
);
1960 DBG("request vbus irq %d failed\n",
1961 udc
->board
.vbus_pin
);
1962 goto err_unprepare_iclk
;
1966 DBG("no VBUS detection, assuming always-on\n");
1969 retval
= usb_add_gadget_udc(dev
, &udc
->gadget
);
1971 goto err_unprepare_iclk
;
1972 dev_set_drvdata(dev
, udc
);
1973 device_init_wakeup(dev
, 1);
1974 create_debug_file(udc
);
1976 INFO("%s version %s\n", driver_name
, DRIVER_VERSION
);
1980 clk_unprepare(udc
->iclk
);
1982 clk_unprepare(udc
->fclk
);
1984 DBG("%s probe failed, %d\n", driver_name
, retval
);
1989 static int __exit
at91udc_remove(struct platform_device
*pdev
)
1991 struct at91_udc
*udc
= platform_get_drvdata(pdev
);
1992 unsigned long flags
;
1996 usb_del_gadget_udc(&udc
->gadget
);
2000 spin_lock_irqsave(&udc
->lock
, flags
);
2002 spin_unlock_irqrestore(&udc
->lock
, flags
);
2004 device_init_wakeup(&pdev
->dev
, 0);
2005 remove_debug_file(udc
);
2006 clk_unprepare(udc
->fclk
);
2007 clk_unprepare(udc
->iclk
);
2013 static int at91udc_suspend(struct platform_device
*pdev
, pm_message_t mesg
)
2015 struct at91_udc
*udc
= platform_get_drvdata(pdev
);
2016 int wake
= udc
->driver
&& device_may_wakeup(&pdev
->dev
);
2017 unsigned long flags
;
2019 /* Unless we can act normally to the host (letting it wake us up
2020 * whenever it has work for us) force disconnect. Wakeup requires
2021 * PLLB for USB events (signaling for reset, wakeup, or incoming
2022 * tokens) and VBUS irqs (on systems which support them).
2024 if ((!udc
->suspended
&& udc
->addr
)
2026 || at91_suspend_entering_slow_clock()) {
2027 spin_lock_irqsave(&udc
->lock
, flags
);
2030 spin_unlock_irqrestore(&udc
->lock
, flags
);
2032 enable_irq_wake(udc
->udp_irq
);
2034 udc
->active_suspend
= wake
;
2035 if (gpio_is_valid(udc
->board
.vbus_pin
) && !udc
->board
.vbus_polled
&& wake
)
2036 enable_irq_wake(udc
->board
.vbus_pin
);
2040 static int at91udc_resume(struct platform_device
*pdev
)
2042 struct at91_udc
*udc
= platform_get_drvdata(pdev
);
2043 unsigned long flags
;
2045 if (gpio_is_valid(udc
->board
.vbus_pin
) && !udc
->board
.vbus_polled
&&
2046 udc
->active_suspend
)
2047 disable_irq_wake(udc
->board
.vbus_pin
);
2049 /* maybe reconnect to host; if so, clocks on */
2050 if (udc
->active_suspend
)
2051 disable_irq_wake(udc
->udp_irq
);
2053 spin_lock_irqsave(&udc
->lock
, flags
);
2055 spin_unlock_irqrestore(&udc
->lock
, flags
);
2060 #define at91udc_suspend NULL
2061 #define at91udc_resume NULL
2064 static struct platform_driver at91_udc_driver
= {
2065 .remove
= __exit_p(at91udc_remove
),
2066 .shutdown
= at91udc_shutdown
,
2067 .suspend
= at91udc_suspend
,
2068 .resume
= at91udc_resume
,
2070 .name
= (char *) driver_name
,
2071 .of_match_table
= at91_udc_dt_ids
,
2075 module_platform_driver_probe(at91_udc_driver
, at91udc_probe
);
2077 MODULE_DESCRIPTION("AT91 udc driver");
2078 MODULE_AUTHOR("Thomas Rathbone, David Brownell");
2079 MODULE_LICENSE("GPL");
2080 MODULE_ALIAS("platform:at91_udc");