2 * Intel PXA25x and IXP4xx on-chip full speed USB device controllers
4 * Copyright (C) 2002 Intrinsyc, Inc. (Frank Becker)
5 * Copyright (C) 2003 Robert Schwebel, Pengutronix
6 * Copyright (C) 2003 Benedikt Spranger, Pengutronix
7 * Copyright (C) 2003 David Brownell
8 * Copyright (C) 2003 Joshua Wise
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
16 /* #define VERBOSE_DEBUG */
18 #include <linux/device.h>
19 #include <linux/module.h>
20 #include <linux/kernel.h>
21 #include <linux/ioport.h>
22 #include <linux/types.h>
23 #include <linux/errno.h>
24 #include <linux/err.h>
25 #include <linux/delay.h>
26 #include <linux/slab.h>
27 #include <linux/init.h>
28 #include <linux/timer.h>
29 #include <linux/list.h>
30 #include <linux/interrupt.h>
32 #include <linux/platform_data/pxa2xx_udc.h>
33 #include <linux/platform_device.h>
34 #include <linux/dma-mapping.h>
35 #include <linux/irq.h>
36 #include <linux/clk.h>
37 #include <linux/seq_file.h>
38 #include <linux/debugfs.h>
40 #include <linux/prefetch.h>
42 #include <asm/byteorder.h>
45 #include <asm/mach-types.h>
46 #include <asm/unaligned.h>
48 #include <linux/usb/ch9.h>
49 #include <linux/usb/gadget.h>
50 #include <linux/usb/otg.h>
53 * This driver is PXA25x only. Grab the right register definitions.
55 #ifdef CONFIG_ARCH_PXA
56 #include <mach/pxa25x-udc.h>
59 #ifdef CONFIG_ARCH_LUBBOCK
60 #include <mach/lubbock.h>
64 * This driver handles the USB Device Controller (UDC) in Intel's PXA 25x
65 * series processors. The UDC for the IXP 4xx series is very similar.
66 * There are fifteen endpoints, in addition to ep0.
68 * Such controller drivers work with a gadget driver. The gadget driver
69 * returns descriptors, implements configuration and data protocols used
70 * by the host to interact with this device, and allocates endpoints to
71 * the different protocol interfaces. The controller driver virtualizes
72 * usb hardware so that the gadget drivers will be more portable.
74 * This UDC hardware wants to implement a bit too much USB protocol, so
75 * it constrains the sorts of USB configuration change events that work.
76 * The errata for these chips are misleading; some "fixed" bugs from
77 * pxa250 a0/a1 b0/b1/b2 sure act like they're still there.
79 * Note that the UDC hardware supports DMA (except on IXP) but that's
80 * not used here. IN-DMA (to host) is simple enough, when the data is
81 * suitably aligned (16 bytes) ... the network stack doesn't do that,
82 * other software can. OUT-DMA is buggy in most chip versions, as well
83 * as poorly designed (data toggle not automatic). So this driver won't
84 * bother using DMA. (Mostly-working IN-DMA support was available in
85 * kernels before 2.6.23, but was never enabled or well tested.)
88 #define DRIVER_VERSION "30-June-2007"
89 #define DRIVER_DESC "PXA 25x USB Device Controller driver"
92 static const char driver_name
[] = "pxa25x_udc";
94 static const char ep0name
[] = "ep0";
97 #ifdef CONFIG_ARCH_IXP4XX
99 /* cpu-specific register addresses are compiled in to this code */
100 #ifdef CONFIG_ARCH_PXA
101 #error "Can't configure both IXP and PXA"
104 /* IXP doesn't yet support <linux/clk.h> */
105 #define clk_get(dev,name) NULL
106 #define clk_enable(clk) do { } while (0)
107 #define clk_disable(clk) do { } while (0)
108 #define clk_put(clk) do { } while (0)
112 #include "pxa25x_udc.h"
115 #ifdef CONFIG_USB_PXA25X_SMALL
116 #define SIZE_STR " (small)"
121 /* ---------------------------------------------------------------------------
122 * endpoint related parts of the api to the usb controller hardware,
123 * used by gadget driver; and the inner talker-to-hardware core.
124 * ---------------------------------------------------------------------------
127 static void pxa25x_ep_fifo_flush (struct usb_ep
*ep
);
128 static void nuke (struct pxa25x_ep
*, int status
);
130 /* one GPIO should control a D+ pullup, so host sees this device (or not) */
131 static void pullup_off(void)
133 struct pxa2xx_udc_mach_info
*mach
= the_controller
->mach
;
134 int off_level
= mach
->gpio_pullup_inverted
;
136 if (gpio_is_valid(mach
->gpio_pullup
))
137 gpio_set_value(mach
->gpio_pullup
, off_level
);
138 else if (mach
->udc_command
)
139 mach
->udc_command(PXA2XX_UDC_CMD_DISCONNECT
);
142 static void pullup_on(void)
144 struct pxa2xx_udc_mach_info
*mach
= the_controller
->mach
;
145 int on_level
= !mach
->gpio_pullup_inverted
;
147 if (gpio_is_valid(mach
->gpio_pullup
))
148 gpio_set_value(mach
->gpio_pullup
, on_level
);
149 else if (mach
->udc_command
)
150 mach
->udc_command(PXA2XX_UDC_CMD_CONNECT
);
153 static void pio_irq_enable(int bEndpointAddress
)
155 bEndpointAddress
&= 0xf;
156 if (bEndpointAddress
< 8)
157 UICR0
&= ~(1 << bEndpointAddress
);
159 bEndpointAddress
-= 8;
160 UICR1
&= ~(1 << bEndpointAddress
);
164 static void pio_irq_disable(int bEndpointAddress
)
166 bEndpointAddress
&= 0xf;
167 if (bEndpointAddress
< 8)
168 UICR0
|= 1 << bEndpointAddress
;
170 bEndpointAddress
-= 8;
171 UICR1
|= 1 << bEndpointAddress
;
175 /* The UDCCR reg contains mask and interrupt status bits,
176 * so using '|=' isn't safe as it may ack an interrupt.
178 #define UDCCR_MASK_BITS (UDCCR_REM | UDCCR_SRM | UDCCR_UDE)
180 static inline void udc_set_mask_UDCCR(int mask
)
182 UDCCR
= (UDCCR
& UDCCR_MASK_BITS
) | (mask
& UDCCR_MASK_BITS
);
185 static inline void udc_clear_mask_UDCCR(int mask
)
187 UDCCR
= (UDCCR
& UDCCR_MASK_BITS
) & ~(mask
& UDCCR_MASK_BITS
);
190 static inline void udc_ack_int_UDCCR(int mask
)
192 /* udccr contains the bits we dont want to change */
193 __u32 udccr
= UDCCR
& UDCCR_MASK_BITS
;
195 UDCCR
= udccr
| (mask
& ~UDCCR_MASK_BITS
);
199 * endpoint enable/disable
201 * we need to verify the descriptors used to enable endpoints. since pxa25x
202 * endpoint configurations are fixed, and are pretty much always enabled,
203 * there's not a lot to manage here.
205 * because pxa25x can't selectively initialize bulk (or interrupt) endpoints,
206 * (resetting endpoint halt and toggle), SET_INTERFACE is unusable except
207 * for a single interface (with only the default altsetting) and for gadget
208 * drivers that don't halt endpoints (not reset by set_interface). that also
209 * means that if you use ISO, you must violate the USB spec rule that all
210 * iso endpoints must be in non-default altsettings.
212 static int pxa25x_ep_enable (struct usb_ep
*_ep
,
213 const struct usb_endpoint_descriptor
*desc
)
215 struct pxa25x_ep
*ep
;
216 struct pxa25x_udc
*dev
;
218 ep
= container_of (_ep
, struct pxa25x_ep
, ep
);
219 if (!_ep
|| !desc
|| _ep
->name
== ep0name
220 || desc
->bDescriptorType
!= USB_DT_ENDPOINT
221 || ep
->bEndpointAddress
!= desc
->bEndpointAddress
222 || ep
->fifo_size
< usb_endpoint_maxp (desc
)) {
223 DMSG("%s, bad ep or descriptor\n", __func__
);
227 /* xfer types must match, except that interrupt ~= bulk */
228 if (ep
->bmAttributes
!= desc
->bmAttributes
229 && ep
->bmAttributes
!= USB_ENDPOINT_XFER_BULK
230 && desc
->bmAttributes
!= USB_ENDPOINT_XFER_INT
) {
231 DMSG("%s, %s type mismatch\n", __func__
, _ep
->name
);
235 /* hardware _could_ do smaller, but driver doesn't */
236 if ((desc
->bmAttributes
== USB_ENDPOINT_XFER_BULK
237 && usb_endpoint_maxp (desc
)
239 || !desc
->wMaxPacketSize
) {
240 DMSG("%s, bad %s maxpacket\n", __func__
, _ep
->name
);
245 if (!dev
->driver
|| dev
->gadget
.speed
== USB_SPEED_UNKNOWN
) {
246 DMSG("%s, bogus device state\n", __func__
);
253 ep
->ep
.maxpacket
= usb_endpoint_maxp (desc
);
255 /* flush fifo (mostly for OUT buffers) */
256 pxa25x_ep_fifo_flush (_ep
);
258 /* ... reset halt state too, if we could ... */
260 DBG(DBG_VERBOSE
, "enabled %s\n", _ep
->name
);
264 static int pxa25x_ep_disable (struct usb_ep
*_ep
)
266 struct pxa25x_ep
*ep
;
269 ep
= container_of (_ep
, struct pxa25x_ep
, ep
);
270 if (!_ep
|| !ep
->ep
.desc
) {
271 DMSG("%s, %s not enabled\n", __func__
,
272 _ep
? ep
->ep
.name
: NULL
);
275 local_irq_save(flags
);
277 nuke (ep
, -ESHUTDOWN
);
279 /* flush fifo (mostly for IN buffers) */
280 pxa25x_ep_fifo_flush (_ep
);
285 local_irq_restore(flags
);
286 DBG(DBG_VERBOSE
, "%s disabled\n", _ep
->name
);
290 /*-------------------------------------------------------------------------*/
292 /* for the pxa25x, these can just wrap kmalloc/kfree. gadget drivers
293 * must still pass correctly initialized endpoints, since other controller
294 * drivers may care about how it's currently set up (dma issues etc).
298 * pxa25x_ep_alloc_request - allocate a request data structure
300 static struct usb_request
*
301 pxa25x_ep_alloc_request (struct usb_ep
*_ep
, gfp_t gfp_flags
)
303 struct pxa25x_request
*req
;
305 req
= kzalloc(sizeof(*req
), gfp_flags
);
309 INIT_LIST_HEAD (&req
->queue
);
315 * pxa25x_ep_free_request - deallocate a request data structure
318 pxa25x_ep_free_request (struct usb_ep
*_ep
, struct usb_request
*_req
)
320 struct pxa25x_request
*req
;
322 req
= container_of (_req
, struct pxa25x_request
, req
);
323 WARN_ON(!list_empty (&req
->queue
));
327 /*-------------------------------------------------------------------------*/
330 * done - retire a request; caller blocked irqs
332 static void done(struct pxa25x_ep
*ep
, struct pxa25x_request
*req
, int status
)
334 unsigned stopped
= ep
->stopped
;
336 list_del_init(&req
->queue
);
338 if (likely (req
->req
.status
== -EINPROGRESS
))
339 req
->req
.status
= status
;
341 status
= req
->req
.status
;
343 if (status
&& status
!= -ESHUTDOWN
)
344 DBG(DBG_VERBOSE
, "complete %s req %p stat %d len %u/%u\n",
345 ep
->ep
.name
, &req
->req
, status
,
346 req
->req
.actual
, req
->req
.length
);
348 /* don't modify queue heads during completion callback */
350 req
->req
.complete(&ep
->ep
, &req
->req
);
351 ep
->stopped
= stopped
;
355 static inline void ep0_idle (struct pxa25x_udc
*dev
)
357 dev
->ep0state
= EP0_IDLE
;
361 write_packet(volatile u32
*uddr
, struct pxa25x_request
*req
, unsigned max
)
364 unsigned length
, count
;
366 buf
= req
->req
.buf
+ req
->req
.actual
;
369 /* how big will this packet be? */
370 length
= min(req
->req
.length
- req
->req
.actual
, max
);
371 req
->req
.actual
+= length
;
374 while (likely(count
--))
381 * write to an IN endpoint fifo, as many packets as possible.
382 * irqs will use this to write the rest later.
383 * caller guarantees at least one packet buffer is ready (or a zlp).
386 write_fifo (struct pxa25x_ep
*ep
, struct pxa25x_request
*req
)
390 max
= usb_endpoint_maxp(ep
->ep
.desc
);
393 int is_last
, is_short
;
395 count
= write_packet(ep
->reg_uddr
, req
, max
);
397 /* last packet is usually short (or a zlp) */
398 if (unlikely (count
!= max
))
399 is_last
= is_short
= 1;
401 if (likely(req
->req
.length
!= req
->req
.actual
)
406 /* interrupt/iso maxpacket may not fill the fifo */
407 is_short
= unlikely (max
< ep
->fifo_size
);
410 DBG(DBG_VERY_NOISY
, "wrote %s %d bytes%s%s %d left %p\n",
412 is_last
? "/L" : "", is_short
? "/S" : "",
413 req
->req
.length
- req
->req
.actual
, req
);
415 /* let loose that packet. maybe try writing another one,
416 * double buffering might work. TSP, TPC, and TFS
417 * bit values are the same for all normal IN endpoints.
419 *ep
->reg_udccs
= UDCCS_BI_TPC
;
421 *ep
->reg_udccs
= UDCCS_BI_TSP
;
423 /* requests complete when all IN data is in the FIFO */
426 if (list_empty(&ep
->queue
))
427 pio_irq_disable (ep
->bEndpointAddress
);
431 // TODO experiment: how robust can fifo mode tweaking be?
432 // double buffering is off in the default fifo mode, which
433 // prevents TFS from being set here.
435 } while (*ep
->reg_udccs
& UDCCS_BI_TFS
);
439 /* caller asserts req->pending (ep0 irq status nyet cleared); starts
440 * ep0 data stage. these chips want very simple state transitions.
443 void ep0start(struct pxa25x_udc
*dev
, u32 flags
, const char *tag
)
445 UDCCS0
= flags
|UDCCS0_SA
|UDCCS0_OPR
;
447 dev
->req_pending
= 0;
448 DBG(DBG_VERY_NOISY
, "%s %s, %02x/%02x\n",
449 __func__
, tag
, UDCCS0
, flags
);
453 write_ep0_fifo (struct pxa25x_ep
*ep
, struct pxa25x_request
*req
)
458 count
= write_packet(&UDDR0
, req
, EP0_FIFO_SIZE
);
459 ep
->dev
->stats
.write
.bytes
+= count
;
461 /* last packet "must be" short (or a zlp) */
462 is_short
= (count
!= EP0_FIFO_SIZE
);
464 DBG(DBG_VERY_NOISY
, "ep0in %d bytes %d left %p\n", count
,
465 req
->req
.length
- req
->req
.actual
, req
);
467 if (unlikely (is_short
)) {
468 if (ep
->dev
->req_pending
)
469 ep0start(ep
->dev
, UDCCS0_IPR
, "short IN");
473 count
= req
->req
.length
;
476 #ifndef CONFIG_ARCH_IXP4XX
478 /* This seems to get rid of lost status irqs in some cases:
479 * host responds quickly, or next request involves config
480 * change automagic, or should have been hidden, or ...
482 * FIXME get rid of all udelays possible...
484 if (count
>= EP0_FIFO_SIZE
) {
487 if ((UDCCS0
& UDCCS0_OPR
) != 0) {
488 /* clear OPR, generate ack */
498 } else if (ep
->dev
->req_pending
)
499 ep0start(ep
->dev
, 0, "IN");
505 * read_fifo - unload packet(s) from the fifo we use for usb OUT
506 * transfers and put them into the request. caller should have made
507 * sure there's at least one packet ready.
509 * returns true if the request completed because of short packet or the
510 * request buffer having filled (and maybe overran till end-of-packet).
513 read_fifo (struct pxa25x_ep
*ep
, struct pxa25x_request
*req
)
518 unsigned bufferspace
, count
, is_short
;
520 /* make sure there's a packet in the FIFO.
521 * UDCCS_{BO,IO}_RPC are all the same bit value.
522 * UDCCS_{BO,IO}_RNE are all the same bit value.
524 udccs
= *ep
->reg_udccs
;
525 if (unlikely ((udccs
& UDCCS_BO_RPC
) == 0))
527 buf
= req
->req
.buf
+ req
->req
.actual
;
529 bufferspace
= req
->req
.length
- req
->req
.actual
;
531 /* read all bytes from this packet */
532 if (likely (udccs
& UDCCS_BO_RNE
)) {
533 count
= 1 + (0x0ff & *ep
->reg_ubcr
);
534 req
->req
.actual
+= min (count
, bufferspace
);
537 is_short
= (count
< ep
->ep
.maxpacket
);
538 DBG(DBG_VERY_NOISY
, "read %s %02x, %d bytes%s req %p %d/%d\n",
539 ep
->ep
.name
, udccs
, count
,
540 is_short
? "/S" : "",
541 req
, req
->req
.actual
, req
->req
.length
);
542 while (likely (count
-- != 0)) {
543 u8 byte
= (u8
) *ep
->reg_uddr
;
545 if (unlikely (bufferspace
== 0)) {
546 /* this happens when the driver's buffer
547 * is smaller than what the host sent.
548 * discard the extra data.
550 if (req
->req
.status
!= -EOVERFLOW
)
551 DMSG("%s overflow %d\n",
553 req
->req
.status
= -EOVERFLOW
;
559 *ep
->reg_udccs
= UDCCS_BO_RPC
;
560 /* RPC/RSP/RNE could now reflect the other packet buffer */
562 /* iso is one request per packet */
563 if (ep
->bmAttributes
== USB_ENDPOINT_XFER_ISOC
) {
564 if (udccs
& UDCCS_IO_ROF
)
565 req
->req
.status
= -EHOSTUNREACH
;
566 /* more like "is_done" */
571 if (is_short
|| req
->req
.actual
== req
->req
.length
) {
573 if (list_empty(&ep
->queue
))
574 pio_irq_disable (ep
->bEndpointAddress
);
578 /* finished that packet. the next one may be waiting... */
584 * special ep0 version of the above. no UBCR0 or double buffering; status
585 * handshaking is magic. most device protocols don't need control-OUT.
586 * CDC vendor commands (and RNDIS), mass storage CB/CBI, and some other
587 * protocols do use them.
590 read_ep0_fifo (struct pxa25x_ep
*ep
, struct pxa25x_request
*req
)
593 unsigned bufferspace
;
595 buf
= req
->req
.buf
+ req
->req
.actual
;
596 bufferspace
= req
->req
.length
- req
->req
.actual
;
598 while (UDCCS0
& UDCCS0_RNE
) {
601 if (unlikely (bufferspace
== 0)) {
602 /* this happens when the driver's buffer
603 * is smaller than what the host sent.
604 * discard the extra data.
606 if (req
->req
.status
!= -EOVERFLOW
)
607 DMSG("%s overflow\n", ep
->ep
.name
);
608 req
->req
.status
= -EOVERFLOW
;
616 UDCCS0
= UDCCS0_OPR
| UDCCS0_IPR
;
619 if (req
->req
.actual
>= req
->req
.length
)
622 /* finished that packet. the next one may be waiting... */
626 /*-------------------------------------------------------------------------*/
629 pxa25x_ep_queue(struct usb_ep
*_ep
, struct usb_request
*_req
, gfp_t gfp_flags
)
631 struct pxa25x_request
*req
;
632 struct pxa25x_ep
*ep
;
633 struct pxa25x_udc
*dev
;
636 req
= container_of(_req
, struct pxa25x_request
, req
);
637 if (unlikely (!_req
|| !_req
->complete
|| !_req
->buf
638 || !list_empty(&req
->queue
))) {
639 DMSG("%s, bad params\n", __func__
);
643 ep
= container_of(_ep
, struct pxa25x_ep
, ep
);
644 if (unlikely(!_ep
|| (!ep
->ep
.desc
&& ep
->ep
.name
!= ep0name
))) {
645 DMSG("%s, bad ep\n", __func__
);
650 if (unlikely (!dev
->driver
651 || dev
->gadget
.speed
== USB_SPEED_UNKNOWN
)) {
652 DMSG("%s, bogus device state\n", __func__
);
656 /* iso is always one packet per request, that's the only way
657 * we can report per-packet status. that also helps with dma.
659 if (unlikely (ep
->bmAttributes
== USB_ENDPOINT_XFER_ISOC
660 && req
->req
.length
> usb_endpoint_maxp(ep
->ep
.desc
)))
663 DBG(DBG_NOISY
, "%s queue req %p, len %d buf %p\n",
664 _ep
->name
, _req
, _req
->length
, _req
->buf
);
666 local_irq_save(flags
);
668 _req
->status
= -EINPROGRESS
;
671 /* kickstart this i/o queue? */
672 if (list_empty(&ep
->queue
) && !ep
->stopped
) {
673 if (ep
->ep
.desc
== NULL
/* ep0 */) {
674 unsigned length
= _req
->length
;
676 switch (dev
->ep0state
) {
677 case EP0_IN_DATA_PHASE
:
678 dev
->stats
.write
.ops
++;
679 if (write_ep0_fifo(ep
, req
))
683 case EP0_OUT_DATA_PHASE
:
684 dev
->stats
.read
.ops
++;
686 if (dev
->req_config
) {
687 DBG(DBG_VERBOSE
, "ep0 config ack%s\n",
688 dev
->has_cfr
? "" : " raced");
690 UDCCFR
= UDCCFR_AREN
|UDCCFR_ACM
693 dev
->ep0state
= EP0_END_XFER
;
694 local_irq_restore (flags
);
697 if (dev
->req_pending
)
698 ep0start(dev
, UDCCS0_IPR
, "OUT");
699 if (length
== 0 || ((UDCCS0
& UDCCS0_RNE
) != 0
700 && read_ep0_fifo(ep
, req
))) {
708 DMSG("ep0 i/o, odd state %d\n", dev
->ep0state
);
709 local_irq_restore (flags
);
712 /* can the FIFO can satisfy the request immediately? */
713 } else if ((ep
->bEndpointAddress
& USB_DIR_IN
) != 0) {
714 if ((*ep
->reg_udccs
& UDCCS_BI_TFS
) != 0
715 && write_fifo(ep
, req
))
717 } else if ((*ep
->reg_udccs
& UDCCS_BO_RFS
) != 0
718 && read_fifo(ep
, req
)) {
722 if (likely(req
&& ep
->ep
.desc
))
723 pio_irq_enable(ep
->bEndpointAddress
);
726 /* pio or dma irq handler advances the queue. */
727 if (likely(req
!= NULL
))
728 list_add_tail(&req
->queue
, &ep
->queue
);
729 local_irq_restore(flags
);
736 * nuke - dequeue ALL requests
738 static void nuke(struct pxa25x_ep
*ep
, int status
)
740 struct pxa25x_request
*req
;
742 /* called with irqs blocked */
743 while (!list_empty(&ep
->queue
)) {
744 req
= list_entry(ep
->queue
.next
,
745 struct pxa25x_request
,
747 done(ep
, req
, status
);
750 pio_irq_disable (ep
->bEndpointAddress
);
754 /* dequeue JUST ONE request */
755 static int pxa25x_ep_dequeue(struct usb_ep
*_ep
, struct usb_request
*_req
)
757 struct pxa25x_ep
*ep
;
758 struct pxa25x_request
*req
;
761 ep
= container_of(_ep
, struct pxa25x_ep
, ep
);
762 if (!_ep
|| ep
->ep
.name
== ep0name
)
765 local_irq_save(flags
);
767 /* make sure it's actually queued on this endpoint */
768 list_for_each_entry (req
, &ep
->queue
, queue
) {
769 if (&req
->req
== _req
)
772 if (&req
->req
!= _req
) {
773 local_irq_restore(flags
);
777 done(ep
, req
, -ECONNRESET
);
779 local_irq_restore(flags
);
783 /*-------------------------------------------------------------------------*/
785 static int pxa25x_ep_set_halt(struct usb_ep
*_ep
, int value
)
787 struct pxa25x_ep
*ep
;
790 ep
= container_of(_ep
, struct pxa25x_ep
, ep
);
792 || (!ep
->ep
.desc
&& ep
->ep
.name
!= ep0name
))
793 || ep
->bmAttributes
== USB_ENDPOINT_XFER_ISOC
) {
794 DMSG("%s, bad ep\n", __func__
);
798 /* this path (reset toggle+halt) is needed to implement
799 * SET_INTERFACE on normal hardware. but it can't be
800 * done from software on the PXA UDC, and the hardware
801 * forgets to do it as part of SET_INTERFACE automagic.
803 DMSG("only host can clear %s halt\n", _ep
->name
);
807 local_irq_save(flags
);
809 if ((ep
->bEndpointAddress
& USB_DIR_IN
) != 0
810 && ((*ep
->reg_udccs
& UDCCS_BI_TFS
) == 0
811 || !list_empty(&ep
->queue
))) {
812 local_irq_restore(flags
);
816 /* FST bit is the same for control, bulk in, bulk out, interrupt in */
817 *ep
->reg_udccs
= UDCCS_BI_FST
|UDCCS_BI_FTF
;
819 /* ep0 needs special care */
821 start_watchdog(ep
->dev
);
822 ep
->dev
->req_pending
= 0;
823 ep
->dev
->ep0state
= EP0_STALL
;
825 /* and bulk/intr endpoints like dropping stalls too */
828 for (i
= 0; i
< 1000; i
+= 20) {
829 if (*ep
->reg_udccs
& UDCCS_BI_SST
)
834 local_irq_restore(flags
);
836 DBG(DBG_VERBOSE
, "%s halt\n", _ep
->name
);
840 static int pxa25x_ep_fifo_status(struct usb_ep
*_ep
)
842 struct pxa25x_ep
*ep
;
844 ep
= container_of(_ep
, struct pxa25x_ep
, ep
);
846 DMSG("%s, bad ep\n", __func__
);
849 /* pxa can't report unclaimed bytes from IN fifos */
850 if ((ep
->bEndpointAddress
& USB_DIR_IN
) != 0)
852 if (ep
->dev
->gadget
.speed
== USB_SPEED_UNKNOWN
853 || (*ep
->reg_udccs
& UDCCS_BO_RFS
) == 0)
856 return (*ep
->reg_ubcr
& 0xfff) + 1;
859 static void pxa25x_ep_fifo_flush(struct usb_ep
*_ep
)
861 struct pxa25x_ep
*ep
;
863 ep
= container_of(_ep
, struct pxa25x_ep
, ep
);
864 if (!_ep
|| ep
->ep
.name
== ep0name
|| !list_empty(&ep
->queue
)) {
865 DMSG("%s, bad ep\n", __func__
);
869 /* toggle and halt bits stay unchanged */
871 /* for OUT, just read and discard the FIFO contents. */
872 if ((ep
->bEndpointAddress
& USB_DIR_IN
) == 0) {
873 while (((*ep
->reg_udccs
) & UDCCS_BO_RNE
) != 0)
874 (void) *ep
->reg_uddr
;
878 /* most IN status is the same, but ISO can't stall */
879 *ep
->reg_udccs
= UDCCS_BI_TPC
|UDCCS_BI_FTF
|UDCCS_BI_TUR
880 | (ep
->bmAttributes
== USB_ENDPOINT_XFER_ISOC
885 static struct usb_ep_ops pxa25x_ep_ops
= {
886 .enable
= pxa25x_ep_enable
,
887 .disable
= pxa25x_ep_disable
,
889 .alloc_request
= pxa25x_ep_alloc_request
,
890 .free_request
= pxa25x_ep_free_request
,
892 .queue
= pxa25x_ep_queue
,
893 .dequeue
= pxa25x_ep_dequeue
,
895 .set_halt
= pxa25x_ep_set_halt
,
896 .fifo_status
= pxa25x_ep_fifo_status
,
897 .fifo_flush
= pxa25x_ep_fifo_flush
,
901 /* ---------------------------------------------------------------------------
902 * device-scoped parts of the api to the usb controller hardware
903 * ---------------------------------------------------------------------------
906 static int pxa25x_udc_get_frame(struct usb_gadget
*_gadget
)
908 return ((UFNRH
& 0x07) << 8) | (UFNRL
& 0xff);
911 static int pxa25x_udc_wakeup(struct usb_gadget
*_gadget
)
913 /* host may not have enabled remote wakeup */
914 if ((UDCCS0
& UDCCS0_DRWF
) == 0)
915 return -EHOSTUNREACH
;
916 udc_set_mask_UDCCR(UDCCR_RSM
);
920 static void stop_activity(struct pxa25x_udc
*, struct usb_gadget_driver
*);
921 static void udc_enable (struct pxa25x_udc
*);
922 static void udc_disable(struct pxa25x_udc
*);
924 /* We disable the UDC -- and its 48 MHz clock -- whenever it's not
927 static int pullup(struct pxa25x_udc
*udc
)
929 int is_active
= udc
->vbus
&& udc
->pullup
&& !udc
->suspended
;
930 DMSG("%s\n", is_active
? "active" : "inactive");
934 /* Enable clock for USB device */
935 clk_enable(udc
->clk
);
940 if (udc
->gadget
.speed
!= USB_SPEED_UNKNOWN
) {
941 DMSG("disconnect %s\n", udc
->driver
942 ? udc
->driver
->driver
.name
944 stop_activity(udc
, udc
->driver
);
947 /* Disable clock for USB device */
948 clk_disable(udc
->clk
);
956 /* VBUS reporting logically comes from a transceiver */
957 static int pxa25x_udc_vbus_session(struct usb_gadget
*_gadget
, int is_active
)
959 struct pxa25x_udc
*udc
;
961 udc
= container_of(_gadget
, struct pxa25x_udc
, gadget
);
962 udc
->vbus
= is_active
;
963 DMSG("vbus %s\n", is_active
? "supplied" : "inactive");
968 /* drivers may have software control over D+ pullup */
969 static int pxa25x_udc_pullup(struct usb_gadget
*_gadget
, int is_active
)
971 struct pxa25x_udc
*udc
;
973 udc
= container_of(_gadget
, struct pxa25x_udc
, gadget
);
975 /* not all boards support pullup control */
976 if (!gpio_is_valid(udc
->mach
->gpio_pullup
) && !udc
->mach
->udc_command
)
979 udc
->pullup
= (is_active
!= 0);
984 /* boards may consume current from VBUS, up to 100-500mA based on config.
985 * the 500uA suspend ceiling means that exclusively vbus-powered PXA designs
988 static int pxa25x_udc_vbus_draw(struct usb_gadget
*_gadget
, unsigned mA
)
990 struct pxa25x_udc
*udc
;
992 udc
= container_of(_gadget
, struct pxa25x_udc
, gadget
);
994 if (!IS_ERR_OR_NULL(udc
->transceiver
))
995 return usb_phy_set_power(udc
->transceiver
, mA
);
999 static int pxa25x_udc_start(struct usb_gadget
*g
,
1000 struct usb_gadget_driver
*driver
);
1001 static int pxa25x_udc_stop(struct usb_gadget
*g
,
1002 struct usb_gadget_driver
*driver
);
1004 static const struct usb_gadget_ops pxa25x_udc_ops
= {
1005 .get_frame
= pxa25x_udc_get_frame
,
1006 .wakeup
= pxa25x_udc_wakeup
,
1007 .vbus_session
= pxa25x_udc_vbus_session
,
1008 .pullup
= pxa25x_udc_pullup
,
1009 .vbus_draw
= pxa25x_udc_vbus_draw
,
1010 .udc_start
= pxa25x_udc_start
,
1011 .udc_stop
= pxa25x_udc_stop
,
1014 /*-------------------------------------------------------------------------*/
1016 #ifdef CONFIG_USB_GADGET_DEBUG_FS
1019 udc_seq_show(struct seq_file
*m
, void *_d
)
1021 struct pxa25x_udc
*dev
= m
->private;
1022 unsigned long flags
;
1026 local_irq_save(flags
);
1028 /* basic device status */
1029 seq_printf(m
, DRIVER_DESC
"\n"
1030 "%s version: %s\nGadget driver: %s\nHost %s\n\n",
1031 driver_name
, DRIVER_VERSION SIZE_STR
"(pio)",
1032 dev
->driver
? dev
->driver
->driver
.name
: "(none)",
1033 dev
->gadget
.speed
== USB_SPEED_FULL
? "full speed" : "disconnected");
1035 /* registers for device and ep0 */
1037 "uicr %02X.%02X, usir %02X.%02x, ufnr %02X.%02X\n",
1038 UICR1
, UICR0
, USIR1
, USIR0
, UFNRH
, UFNRL
);
1042 "udccr %02X =%s%s%s%s%s%s%s%s\n", tmp
,
1043 (tmp
& UDCCR_REM
) ? " rem" : "",
1044 (tmp
& UDCCR_RSTIR
) ? " rstir" : "",
1045 (tmp
& UDCCR_SRM
) ? " srm" : "",
1046 (tmp
& UDCCR_SUSIR
) ? " susir" : "",
1047 (tmp
& UDCCR_RESIR
) ? " resir" : "",
1048 (tmp
& UDCCR_RSM
) ? " rsm" : "",
1049 (tmp
& UDCCR_UDA
) ? " uda" : "",
1050 (tmp
& UDCCR_UDE
) ? " ude" : "");
1054 "udccs0 %02X =%s%s%s%s%s%s%s%s\n", tmp
,
1055 (tmp
& UDCCS0_SA
) ? " sa" : "",
1056 (tmp
& UDCCS0_RNE
) ? " rne" : "",
1057 (tmp
& UDCCS0_FST
) ? " fst" : "",
1058 (tmp
& UDCCS0_SST
) ? " sst" : "",
1059 (tmp
& UDCCS0_DRWF
) ? " dwrf" : "",
1060 (tmp
& UDCCS0_FTF
) ? " ftf" : "",
1061 (tmp
& UDCCS0_IPR
) ? " ipr" : "",
1062 (tmp
& UDCCS0_OPR
) ? " opr" : "");
1067 "udccfr %02X =%s%s\n", tmp
,
1068 (tmp
& UDCCFR_AREN
) ? " aren" : "",
1069 (tmp
& UDCCFR_ACM
) ? " acm" : "");
1072 if (dev
->gadget
.speed
!= USB_SPEED_FULL
|| !dev
->driver
)
1075 seq_printf(m
, "ep0 IN %lu/%lu, OUT %lu/%lu\nirqs %lu\n\n",
1076 dev
->stats
.write
.bytes
, dev
->stats
.write
.ops
,
1077 dev
->stats
.read
.bytes
, dev
->stats
.read
.ops
,
1080 /* dump endpoint queues */
1081 for (i
= 0; i
< PXA_UDC_NUM_ENDPOINTS
; i
++) {
1082 struct pxa25x_ep
*ep
= &dev
->ep
[i
];
1083 struct pxa25x_request
*req
;
1086 const struct usb_endpoint_descriptor
*desc
;
1091 tmp
= *dev
->ep
[i
].reg_udccs
;
1093 "%s max %d %s udccs %02x irqs %lu\n",
1094 ep
->ep
.name
, usb_endpoint_maxp(desc
),
1095 "pio", tmp
, ep
->pio_irqs
);
1096 /* TODO translate all five groups of udccs bits! */
1098 } else /* ep0 should only have one transfer queued */
1099 seq_printf(m
, "ep0 max 16 pio irqs %lu\n",
1102 if (list_empty(&ep
->queue
)) {
1103 seq_printf(m
, "\t(nothing queued)\n");
1106 list_for_each_entry(req
, &ep
->queue
, queue
) {
1108 "\treq %p len %d/%d buf %p\n",
1109 &req
->req
, req
->req
.actual
,
1110 req
->req
.length
, req
->req
.buf
);
1115 local_irq_restore(flags
);
1120 udc_debugfs_open(struct inode
*inode
, struct file
*file
)
1122 return single_open(file
, udc_seq_show
, inode
->i_private
);
1125 static const struct file_operations debug_fops
= {
1126 .open
= udc_debugfs_open
,
1128 .llseek
= seq_lseek
,
1129 .release
= single_release
,
1130 .owner
= THIS_MODULE
,
1133 #define create_debug_files(dev) \
1135 dev->debugfs_udc = debugfs_create_file(dev->gadget.name, \
1136 S_IRUGO, NULL, dev, &debug_fops); \
1138 #define remove_debug_files(dev) \
1140 if (dev->debugfs_udc) \
1141 debugfs_remove(dev->debugfs_udc); \
1144 #else /* !CONFIG_USB_GADGET_DEBUG_FILES */
1146 #define create_debug_files(dev) do {} while (0)
1147 #define remove_debug_files(dev) do {} while (0)
1149 #endif /* CONFIG_USB_GADGET_DEBUG_FILES */
1151 /*-------------------------------------------------------------------------*/
1154 * udc_disable - disable USB device controller
1156 static void udc_disable(struct pxa25x_udc
*dev
)
1158 /* block all irqs */
1159 udc_set_mask_UDCCR(UDCCR_SRM
|UDCCR_REM
);
1160 UICR0
= UICR1
= 0xff;
1163 /* if hardware supports it, disconnect from usb */
1166 udc_clear_mask_UDCCR(UDCCR_UDE
);
1169 dev
->gadget
.speed
= USB_SPEED_UNKNOWN
;
1174 * udc_reinit - initialize software state
1176 static void udc_reinit(struct pxa25x_udc
*dev
)
1180 /* device/ep0 records init */
1181 INIT_LIST_HEAD (&dev
->gadget
.ep_list
);
1182 INIT_LIST_HEAD (&dev
->gadget
.ep0
->ep_list
);
1183 dev
->ep0state
= EP0_IDLE
;
1185 /* basic endpoint records init */
1186 for (i
= 0; i
< PXA_UDC_NUM_ENDPOINTS
; i
++) {
1187 struct pxa25x_ep
*ep
= &dev
->ep
[i
];
1190 list_add_tail (&ep
->ep
.ep_list
, &dev
->gadget
.ep_list
);
1194 INIT_LIST_HEAD (&ep
->queue
);
1198 /* the rest was statically initialized, and is read-only */
1201 /* until it's enabled, this UDC should be completely invisible
1204 static void udc_enable (struct pxa25x_udc
*dev
)
1206 udc_clear_mask_UDCCR(UDCCR_UDE
);
1208 /* try to clear these bits before we enable the udc */
1209 udc_ack_int_UDCCR(UDCCR_SUSIR
|/*UDCCR_RSTIR|*/UDCCR_RESIR
);
1212 dev
->gadget
.speed
= USB_SPEED_UNKNOWN
;
1213 dev
->stats
.irqs
= 0;
1216 * sequence taken from chapter 12.5.10, PXA250 AppProcDevManual:
1218 * - if RESET is already in progress, ack interrupt
1219 * - unmask reset interrupt
1221 udc_set_mask_UDCCR(UDCCR_UDE
);
1222 if (!(UDCCR
& UDCCR_UDA
))
1223 udc_ack_int_UDCCR(UDCCR_RSTIR
);
1225 if (dev
->has_cfr
/* UDC_RES2 is defined */) {
1226 /* pxa255 (a0+) can avoid a set_config race that could
1227 * prevent gadget drivers from configuring correctly
1229 UDCCFR
= UDCCFR_ACM
| UDCCFR_MB1
;
1231 /* "USB test mode" for pxa250 errata 40-42 (stepping a0, a1)
1232 * which could result in missing packets and interrupts.
1233 * supposedly one bit per endpoint, controlling whether it
1234 * double buffers or not; ACM/AREN bits fit into the holes.
1235 * zero bits (like USIR0_IRx) disable double buffering.
1241 /* enable suspend/resume and reset irqs */
1242 udc_clear_mask_UDCCR(UDCCR_SRM
| UDCCR_REM
);
1244 /* enable ep0 irqs */
1245 UICR0
&= ~UICR0_IM0
;
1247 /* if hardware supports it, pullup D+ and wait for reset */
1252 /* when a driver is successfully registered, it will receive
1253 * control requests including set_configuration(), which enables
1254 * non-control requests. then usb traffic follows until a
1255 * disconnect is reported. then a host may connect again, or
1256 * the driver might get unbound.
1258 static int pxa25x_udc_start(struct usb_gadget
*g
,
1259 struct usb_gadget_driver
*driver
)
1261 struct pxa25x_udc
*dev
= to_pxa25x(g
);
1264 /* first hook up the driver ... */
1265 dev
->driver
= driver
;
1266 dev
->gadget
.dev
.driver
= &driver
->driver
;
1269 /* ... then enable host detection and ep0; and we're ready
1270 * for set_configuration as well as eventual disconnect.
1272 /* connect to bus through transceiver */
1273 if (!IS_ERR_OR_NULL(dev
->transceiver
)) {
1274 retval
= otg_set_peripheral(dev
->transceiver
->otg
,
1288 stop_activity(struct pxa25x_udc
*dev
, struct usb_gadget_driver
*driver
)
1292 /* don't disconnect drivers more than once */
1293 if (dev
->gadget
.speed
== USB_SPEED_UNKNOWN
)
1295 dev
->gadget
.speed
= USB_SPEED_UNKNOWN
;
1297 /* prevent new request submissions, kill any outstanding requests */
1298 for (i
= 0; i
< PXA_UDC_NUM_ENDPOINTS
; i
++) {
1299 struct pxa25x_ep
*ep
= &dev
->ep
[i
];
1302 nuke(ep
, -ESHUTDOWN
);
1304 del_timer_sync(&dev
->timer
);
1306 /* report disconnect; the driver is already quiesced */
1308 driver
->disconnect(&dev
->gadget
);
1310 /* re-init driver-visible data structures */
1314 static int pxa25x_udc_stop(struct usb_gadget
*g
,
1315 struct usb_gadget_driver
*driver
)
1317 struct pxa25x_udc
*dev
= to_pxa25x(g
);
1319 local_irq_disable();
1322 stop_activity(dev
, driver
);
1325 if (!IS_ERR_OR_NULL(dev
->transceiver
))
1326 (void) otg_set_peripheral(dev
->transceiver
->otg
, NULL
);
1328 dev
->gadget
.dev
.driver
= NULL
;
1336 /*-------------------------------------------------------------------------*/
1338 #ifdef CONFIG_ARCH_LUBBOCK
1340 /* Lubbock has separate connect and disconnect irqs. More typical designs
1341 * use one GPIO as the VBUS IRQ, and another to control the D+ pullup.
1345 lubbock_vbus_irq(int irq
, void *_dev
)
1347 struct pxa25x_udc
*dev
= _dev
;
1352 case LUBBOCK_USB_IRQ
:
1354 disable_irq(LUBBOCK_USB_IRQ
);
1355 enable_irq(LUBBOCK_USB_DISC_IRQ
);
1357 case LUBBOCK_USB_DISC_IRQ
:
1359 disable_irq(LUBBOCK_USB_DISC_IRQ
);
1360 enable_irq(LUBBOCK_USB_IRQ
);
1366 pxa25x_udc_vbus_session(&dev
->gadget
, vbus
);
1373 /*-------------------------------------------------------------------------*/
1375 static inline void clear_ep_state (struct pxa25x_udc
*dev
)
1379 /* hardware SET_{CONFIGURATION,INTERFACE} automagic resets endpoint
1380 * fifos, and pending transactions mustn't be continued in any case.
1382 for (i
= 1; i
< PXA_UDC_NUM_ENDPOINTS
; i
++)
1383 nuke(&dev
->ep
[i
], -ECONNABORTED
);
1386 static void udc_watchdog(unsigned long _dev
)
1388 struct pxa25x_udc
*dev
= (void *)_dev
;
1390 local_irq_disable();
1391 if (dev
->ep0state
== EP0_STALL
1392 && (UDCCS0
& UDCCS0_FST
) == 0
1393 && (UDCCS0
& UDCCS0_SST
) == 0) {
1394 UDCCS0
= UDCCS0_FST
|UDCCS0_FTF
;
1395 DBG(DBG_VERBOSE
, "ep0 re-stall\n");
1396 start_watchdog(dev
);
1401 static void handle_ep0 (struct pxa25x_udc
*dev
)
1403 u32 udccs0
= UDCCS0
;
1404 struct pxa25x_ep
*ep
= &dev
->ep
[0];
1405 struct pxa25x_request
*req
;
1407 struct usb_ctrlrequest r
;
1412 if (list_empty(&ep
->queue
))
1415 req
= list_entry(ep
->queue
.next
, struct pxa25x_request
, queue
);
1417 /* clear stall status */
1418 if (udccs0
& UDCCS0_SST
) {
1420 UDCCS0
= UDCCS0_SST
;
1421 del_timer(&dev
->timer
);
1425 /* previous request unfinished? non-error iff back-to-back ... */
1426 if ((udccs0
& UDCCS0_SA
) != 0 && dev
->ep0state
!= EP0_IDLE
) {
1428 del_timer(&dev
->timer
);
1432 switch (dev
->ep0state
) {
1434 /* late-breaking status? */
1437 /* start control request? */
1438 if (likely((udccs0
& (UDCCS0_OPR
|UDCCS0_SA
|UDCCS0_RNE
))
1439 == (UDCCS0_OPR
|UDCCS0_SA
|UDCCS0_RNE
))) {
1444 /* read SETUP packet */
1445 for (i
= 0; i
< 8; i
++) {
1446 if (unlikely(!(UDCCS0
& UDCCS0_RNE
))) {
1448 DMSG("SETUP %d!\n", i
);
1451 u
.raw
[i
] = (u8
) UDDR0
;
1453 if (unlikely((UDCCS0
& UDCCS0_RNE
) != 0))
1457 DBG(DBG_VERBOSE
, "SETUP %02x.%02x v%04x i%04x l%04x\n",
1458 u
.r
.bRequestType
, u
.r
.bRequest
,
1459 le16_to_cpu(u
.r
.wValue
),
1460 le16_to_cpu(u
.r
.wIndex
),
1461 le16_to_cpu(u
.r
.wLength
));
1463 /* cope with automagic for some standard requests. */
1464 dev
->req_std
= (u
.r
.bRequestType
& USB_TYPE_MASK
)
1465 == USB_TYPE_STANDARD
;
1466 dev
->req_config
= 0;
1467 dev
->req_pending
= 1;
1468 switch (u
.r
.bRequest
) {
1469 /* hardware restricts gadget drivers here! */
1470 case USB_REQ_SET_CONFIGURATION
:
1471 if (u
.r
.bRequestType
== USB_RECIP_DEVICE
) {
1472 /* reflect hardware's automagic
1473 * up to the gadget driver.
1476 dev
->req_config
= 1;
1477 clear_ep_state(dev
);
1478 /* if !has_cfr, there's no synch
1479 * else use AREN (later) not SA|OPR
1480 * USIR0_IR0 acts edge sensitive
1484 /* ... and here, even more ... */
1485 case USB_REQ_SET_INTERFACE
:
1486 if (u
.r
.bRequestType
== USB_RECIP_INTERFACE
) {
1487 /* udc hardware is broken by design:
1488 * - altsetting may only be zero;
1489 * - hw resets all interfaces' eps;
1490 * - ep reset doesn't include halt(?).
1492 DMSG("broken set_interface (%d/%d)\n",
1493 le16_to_cpu(u
.r
.wIndex
),
1494 le16_to_cpu(u
.r
.wValue
));
1498 /* hardware was supposed to hide this */
1499 case USB_REQ_SET_ADDRESS
:
1500 if (u
.r
.bRequestType
== USB_RECIP_DEVICE
) {
1501 ep0start(dev
, 0, "address");
1507 if (u
.r
.bRequestType
& USB_DIR_IN
)
1508 dev
->ep0state
= EP0_IN_DATA_PHASE
;
1510 dev
->ep0state
= EP0_OUT_DATA_PHASE
;
1512 i
= dev
->driver
->setup(&dev
->gadget
, &u
.r
);
1514 /* hardware automagic preventing STALL... */
1515 if (dev
->req_config
) {
1516 /* hardware sometimes neglects to tell
1517 * tell us about config change events,
1518 * so later ones may fail...
1520 WARNING("config change %02x fail %d?\n",
1523 /* TODO experiment: if has_cfr,
1524 * hardware didn't ACK; maybe we
1525 * could actually STALL!
1528 DBG(DBG_VERBOSE
, "protocol STALL, "
1529 "%02x err %d\n", UDCCS0
, i
);
1531 /* the watchdog timer helps deal with cases
1532 * where udc seems to clear FST wrongly, and
1533 * then NAKs instead of STALLing.
1535 ep0start(dev
, UDCCS0_FST
|UDCCS0_FTF
, "stall");
1536 start_watchdog(dev
);
1537 dev
->ep0state
= EP0_STALL
;
1539 /* deferred i/o == no response yet */
1540 } else if (dev
->req_pending
) {
1541 if (likely(dev
->ep0state
== EP0_IN_DATA_PHASE
1542 || dev
->req_std
|| u
.r
.wLength
))
1543 ep0start(dev
, 0, "defer");
1545 ep0start(dev
, UDCCS0_IPR
, "defer/IPR");
1548 /* expect at least one data or status stage irq */
1551 } else if (likely((udccs0
& (UDCCS0_OPR
|UDCCS0_SA
))
1552 == (UDCCS0_OPR
|UDCCS0_SA
))) {
1555 /* pxa210/250 erratum 131 for B0/B1 says RNE lies.
1556 * still observed on a pxa255 a0.
1558 DBG(DBG_VERBOSE
, "e131\n");
1561 /* read SETUP data, but don't trust it too much */
1562 for (i
= 0; i
< 8; i
++)
1563 u
.raw
[i
] = (u8
) UDDR0
;
1564 if ((u
.r
.bRequestType
& USB_RECIP_MASK
)
1567 if (u
.word
[0] == 0 && u
.word
[1] == 0)
1571 /* some random early IRQ:
1574 * - OPR got set, without SA (likely status stage)
1576 UDCCS0
= udccs0
& (UDCCS0_SA
|UDCCS0_OPR
);
1579 case EP0_IN_DATA_PHASE
: /* GET_DESCRIPTOR etc */
1580 if (udccs0
& UDCCS0_OPR
) {
1581 UDCCS0
= UDCCS0_OPR
|UDCCS0_FTF
;
1582 DBG(DBG_VERBOSE
, "ep0in premature status\n");
1586 } else /* irq was IPR clearing */ {
1588 /* this IN packet might finish the request */
1589 (void) write_ep0_fifo(ep
, req
);
1590 } /* else IN token before response was written */
1593 case EP0_OUT_DATA_PHASE
: /* SET_DESCRIPTOR etc */
1594 if (udccs0
& UDCCS0_OPR
) {
1596 /* this OUT packet might finish the request */
1597 if (read_ep0_fifo(ep
, req
))
1599 /* else more OUT packets expected */
1600 } /* else OUT token before read was issued */
1601 } else /* irq was IPR clearing */ {
1602 DBG(DBG_VERBOSE
, "ep0out premature status\n");
1611 /* ack control-IN status (maybe in-zlp was skipped)
1612 * also appears after some config change events.
1614 if (udccs0
& UDCCS0_OPR
)
1615 UDCCS0
= UDCCS0_OPR
;
1619 UDCCS0
= UDCCS0_FST
;
1625 static void handle_ep(struct pxa25x_ep
*ep
)
1627 struct pxa25x_request
*req
;
1628 int is_in
= ep
->bEndpointAddress
& USB_DIR_IN
;
1634 if (likely (!list_empty(&ep
->queue
)))
1635 req
= list_entry(ep
->queue
.next
,
1636 struct pxa25x_request
, queue
);
1640 // TODO check FST handling
1642 udccs
= *ep
->reg_udccs
;
1643 if (unlikely(is_in
)) { /* irq from TPC, SST, or (ISO) TUR */
1645 if (likely(ep
->bmAttributes
== USB_ENDPOINT_XFER_BULK
))
1646 tmp
|= UDCCS_BI_SST
;
1649 *ep
->reg_udccs
= tmp
;
1650 if (req
&& likely ((udccs
& UDCCS_BI_TFS
) != 0))
1651 completed
= write_fifo(ep
, req
);
1653 } else { /* irq from RPC (or for ISO, ROF) */
1654 if (likely(ep
->bmAttributes
== USB_ENDPOINT_XFER_BULK
))
1655 tmp
= UDCCS_BO_SST
| UDCCS_BO_DME
;
1657 tmp
= UDCCS_IO_ROF
| UDCCS_IO_DME
;
1660 *ep
->reg_udccs
= tmp
;
1662 /* fifos can hold packets, ready for reading... */
1664 completed
= read_fifo(ep
, req
);
1666 pio_irq_disable (ep
->bEndpointAddress
);
1669 } while (completed
);
1673 * pxa25x_udc_irq - interrupt handler
1675 * avoid delays in ep0 processing. the control handshaking isn't always
1676 * under software control (pxa250c0 and the pxa255 are better), and delays
1677 * could cause usb protocol errors.
1680 pxa25x_udc_irq(int irq
, void *_dev
)
1682 struct pxa25x_udc
*dev
= _dev
;
1691 /* SUSpend Interrupt Request */
1692 if (unlikely(udccr
& UDCCR_SUSIR
)) {
1693 udc_ack_int_UDCCR(UDCCR_SUSIR
);
1695 DBG(DBG_VERBOSE
, "USB suspend\n");
1697 if (dev
->gadget
.speed
!= USB_SPEED_UNKNOWN
1699 && dev
->driver
->suspend
)
1700 dev
->driver
->suspend(&dev
->gadget
);
1704 /* RESume Interrupt Request */
1705 if (unlikely(udccr
& UDCCR_RESIR
)) {
1706 udc_ack_int_UDCCR(UDCCR_RESIR
);
1708 DBG(DBG_VERBOSE
, "USB resume\n");
1710 if (dev
->gadget
.speed
!= USB_SPEED_UNKNOWN
1712 && dev
->driver
->resume
)
1713 dev
->driver
->resume(&dev
->gadget
);
1716 /* ReSeT Interrupt Request - USB reset */
1717 if (unlikely(udccr
& UDCCR_RSTIR
)) {
1718 udc_ack_int_UDCCR(UDCCR_RSTIR
);
1721 if ((UDCCR
& UDCCR_UDA
) == 0) {
1722 DBG(DBG_VERBOSE
, "USB reset start\n");
1724 /* reset driver and endpoints,
1725 * in case that's not yet done
1727 stop_activity (dev
, dev
->driver
);
1730 DBG(DBG_VERBOSE
, "USB reset end\n");
1731 dev
->gadget
.speed
= USB_SPEED_FULL
;
1732 memset(&dev
->stats
, 0, sizeof dev
->stats
);
1733 /* driver and endpoints are still reset */
1737 u32 usir0
= USIR0
& ~UICR0
;
1738 u32 usir1
= USIR1
& ~UICR1
;
1741 if (unlikely (!usir0
&& !usir1
))
1744 DBG(DBG_VERY_NOISY
, "irq %02x.%02x\n", usir1
, usir0
);
1746 /* control traffic */
1747 if (usir0
& USIR0_IR0
) {
1748 dev
->ep
[0].pio_irqs
++;
1753 /* endpoint data transfers */
1754 for (i
= 0; i
< 8; i
++) {
1757 if (i
&& (usir0
& tmp
)) {
1758 handle_ep(&dev
->ep
[i
]);
1762 #ifndef CONFIG_USB_PXA25X_SMALL
1764 handle_ep(&dev
->ep
[i
+8]);
1772 /* we could also ask for 1 msec SOF (SIR) interrupts */
1778 /*-------------------------------------------------------------------------*/
1780 static void nop_release (struct device
*dev
)
1782 DMSG("%s %s\n", __func__
, dev_name(dev
));
1785 /* this uses load-time allocation and initialization (instead of
1786 * doing it at run-time) to save code, eliminate fault paths, and
1787 * be more obviously correct.
1789 static struct pxa25x_udc memory
= {
1791 .ops
= &pxa25x_udc_ops
,
1792 .ep0
= &memory
.ep
[0].ep
,
1793 .name
= driver_name
,
1795 .init_name
= "gadget",
1796 .release
= nop_release
,
1800 /* control endpoint */
1804 .ops
= &pxa25x_ep_ops
,
1805 .maxpacket
= EP0_FIFO_SIZE
,
1808 .reg_udccs
= &UDCCS0
,
1812 /* first group of endpoints */
1815 .name
= "ep1in-bulk",
1816 .ops
= &pxa25x_ep_ops
,
1817 .maxpacket
= BULK_FIFO_SIZE
,
1820 .fifo_size
= BULK_FIFO_SIZE
,
1821 .bEndpointAddress
= USB_DIR_IN
| 1,
1822 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
1823 .reg_udccs
= &UDCCS1
,
1828 .name
= "ep2out-bulk",
1829 .ops
= &pxa25x_ep_ops
,
1830 .maxpacket
= BULK_FIFO_SIZE
,
1833 .fifo_size
= BULK_FIFO_SIZE
,
1834 .bEndpointAddress
= 2,
1835 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
1836 .reg_udccs
= &UDCCS2
,
1840 #ifndef CONFIG_USB_PXA25X_SMALL
1843 .name
= "ep3in-iso",
1844 .ops
= &pxa25x_ep_ops
,
1845 .maxpacket
= ISO_FIFO_SIZE
,
1848 .fifo_size
= ISO_FIFO_SIZE
,
1849 .bEndpointAddress
= USB_DIR_IN
| 3,
1850 .bmAttributes
= USB_ENDPOINT_XFER_ISOC
,
1851 .reg_udccs
= &UDCCS3
,
1856 .name
= "ep4out-iso",
1857 .ops
= &pxa25x_ep_ops
,
1858 .maxpacket
= ISO_FIFO_SIZE
,
1861 .fifo_size
= ISO_FIFO_SIZE
,
1862 .bEndpointAddress
= 4,
1863 .bmAttributes
= USB_ENDPOINT_XFER_ISOC
,
1864 .reg_udccs
= &UDCCS4
,
1870 .name
= "ep5in-int",
1871 .ops
= &pxa25x_ep_ops
,
1872 .maxpacket
= INT_FIFO_SIZE
,
1875 .fifo_size
= INT_FIFO_SIZE
,
1876 .bEndpointAddress
= USB_DIR_IN
| 5,
1877 .bmAttributes
= USB_ENDPOINT_XFER_INT
,
1878 .reg_udccs
= &UDCCS5
,
1882 /* second group of endpoints */
1885 .name
= "ep6in-bulk",
1886 .ops
= &pxa25x_ep_ops
,
1887 .maxpacket
= BULK_FIFO_SIZE
,
1890 .fifo_size
= BULK_FIFO_SIZE
,
1891 .bEndpointAddress
= USB_DIR_IN
| 6,
1892 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
1893 .reg_udccs
= &UDCCS6
,
1898 .name
= "ep7out-bulk",
1899 .ops
= &pxa25x_ep_ops
,
1900 .maxpacket
= BULK_FIFO_SIZE
,
1903 .fifo_size
= BULK_FIFO_SIZE
,
1904 .bEndpointAddress
= 7,
1905 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
1906 .reg_udccs
= &UDCCS7
,
1912 .name
= "ep8in-iso",
1913 .ops
= &pxa25x_ep_ops
,
1914 .maxpacket
= ISO_FIFO_SIZE
,
1917 .fifo_size
= ISO_FIFO_SIZE
,
1918 .bEndpointAddress
= USB_DIR_IN
| 8,
1919 .bmAttributes
= USB_ENDPOINT_XFER_ISOC
,
1920 .reg_udccs
= &UDCCS8
,
1925 .name
= "ep9out-iso",
1926 .ops
= &pxa25x_ep_ops
,
1927 .maxpacket
= ISO_FIFO_SIZE
,
1930 .fifo_size
= ISO_FIFO_SIZE
,
1931 .bEndpointAddress
= 9,
1932 .bmAttributes
= USB_ENDPOINT_XFER_ISOC
,
1933 .reg_udccs
= &UDCCS9
,
1939 .name
= "ep10in-int",
1940 .ops
= &pxa25x_ep_ops
,
1941 .maxpacket
= INT_FIFO_SIZE
,
1944 .fifo_size
= INT_FIFO_SIZE
,
1945 .bEndpointAddress
= USB_DIR_IN
| 10,
1946 .bmAttributes
= USB_ENDPOINT_XFER_INT
,
1947 .reg_udccs
= &UDCCS10
,
1948 .reg_uddr
= &UDDR10
,
1951 /* third group of endpoints */
1954 .name
= "ep11in-bulk",
1955 .ops
= &pxa25x_ep_ops
,
1956 .maxpacket
= BULK_FIFO_SIZE
,
1959 .fifo_size
= BULK_FIFO_SIZE
,
1960 .bEndpointAddress
= USB_DIR_IN
| 11,
1961 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
1962 .reg_udccs
= &UDCCS11
,
1963 .reg_uddr
= &UDDR11
,
1967 .name
= "ep12out-bulk",
1968 .ops
= &pxa25x_ep_ops
,
1969 .maxpacket
= BULK_FIFO_SIZE
,
1972 .fifo_size
= BULK_FIFO_SIZE
,
1973 .bEndpointAddress
= 12,
1974 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
1975 .reg_udccs
= &UDCCS12
,
1976 .reg_ubcr
= &UBCR12
,
1977 .reg_uddr
= &UDDR12
,
1981 .name
= "ep13in-iso",
1982 .ops
= &pxa25x_ep_ops
,
1983 .maxpacket
= ISO_FIFO_SIZE
,
1986 .fifo_size
= ISO_FIFO_SIZE
,
1987 .bEndpointAddress
= USB_DIR_IN
| 13,
1988 .bmAttributes
= USB_ENDPOINT_XFER_ISOC
,
1989 .reg_udccs
= &UDCCS13
,
1990 .reg_uddr
= &UDDR13
,
1994 .name
= "ep14out-iso",
1995 .ops
= &pxa25x_ep_ops
,
1996 .maxpacket
= ISO_FIFO_SIZE
,
1999 .fifo_size
= ISO_FIFO_SIZE
,
2000 .bEndpointAddress
= 14,
2001 .bmAttributes
= USB_ENDPOINT_XFER_ISOC
,
2002 .reg_udccs
= &UDCCS14
,
2003 .reg_ubcr
= &UBCR14
,
2004 .reg_uddr
= &UDDR14
,
2008 .name
= "ep15in-int",
2009 .ops
= &pxa25x_ep_ops
,
2010 .maxpacket
= INT_FIFO_SIZE
,
2013 .fifo_size
= INT_FIFO_SIZE
,
2014 .bEndpointAddress
= USB_DIR_IN
| 15,
2015 .bmAttributes
= USB_ENDPOINT_XFER_INT
,
2016 .reg_udccs
= &UDCCS15
,
2017 .reg_uddr
= &UDDR15
,
2019 #endif /* !CONFIG_USB_PXA25X_SMALL */
2022 #define CP15R0_VENDOR_MASK 0xffffe000
2024 #if defined(CONFIG_ARCH_PXA)
2025 #define CP15R0_XSCALE_VALUE 0x69052000 /* intel/arm/xscale */
2027 #elif defined(CONFIG_ARCH_IXP4XX)
2028 #define CP15R0_XSCALE_VALUE 0x69054000 /* intel/arm/ixp4xx */
2032 #define CP15R0_PROD_MASK 0x000003f0
2033 #define PXA25x 0x00000100 /* and PXA26x */
2034 #define PXA210 0x00000120
2036 #define CP15R0_REV_MASK 0x0000000f
2038 #define CP15R0_PRODREV_MASK (CP15R0_PROD_MASK | CP15R0_REV_MASK)
2040 #define PXA255_A0 0x00000106 /* or PXA260_B1 */
2041 #define PXA250_C0 0x00000105 /* or PXA26x_B0 */
2042 #define PXA250_B2 0x00000104
2043 #define PXA250_B1 0x00000103 /* or PXA260_A0 */
2044 #define PXA250_B0 0x00000102
2045 #define PXA250_A1 0x00000101
2046 #define PXA250_A0 0x00000100
2048 #define PXA210_C0 0x00000125
2049 #define PXA210_B2 0x00000124
2050 #define PXA210_B1 0x00000123
2051 #define PXA210_B0 0x00000122
2052 #define IXP425_A0 0x000001c1
2053 #define IXP425_B0 0x000001f1
2054 #define IXP465_AD 0x00000200
2057 * probe - binds to the platform device
2059 static int __init
pxa25x_udc_probe(struct platform_device
*pdev
)
2061 struct pxa25x_udc
*dev
= &memory
;
2065 pr_info("%s: version %s\n", driver_name
, DRIVER_VERSION
);
2067 /* insist on Intel/ARM/XScale */
2068 asm("mrc%? p15, 0, %0, c0, c0" : "=r" (chiprev
));
2069 if ((chiprev
& CP15R0_VENDOR_MASK
) != CP15R0_XSCALE_VALUE
) {
2070 pr_err("%s: not XScale!\n", driver_name
);
2074 /* trigger chiprev-specific logic */
2075 switch (chiprev
& CP15R0_PRODREV_MASK
) {
2076 #if defined(CONFIG_ARCH_PXA)
2082 /* A0/A1 "not released"; ep 13, 15 unusable */
2084 case PXA250_B2
: case PXA210_B2
:
2085 case PXA250_B1
: case PXA210_B1
:
2086 case PXA250_B0
: case PXA210_B0
:
2087 /* OUT-DMA is broken ... */
2089 case PXA250_C0
: case PXA210_C0
:
2091 #elif defined(CONFIG_ARCH_IXP4XX)
2099 pr_err("%s: unrecognized processor: %08x\n",
2100 driver_name
, chiprev
);
2101 /* iop3xx, ixp4xx, ... */
2105 irq
= platform_get_irq(pdev
, 0);
2109 dev
->clk
= clk_get(&pdev
->dev
, NULL
);
2110 if (IS_ERR(dev
->clk
)) {
2111 retval
= PTR_ERR(dev
->clk
);
2115 pr_debug("%s: IRQ %d%s%s\n", driver_name
, irq
,
2116 dev
->has_cfr
? "" : " (!cfr)",
2120 /* other non-static parts of init */
2121 dev
->dev
= &pdev
->dev
;
2122 dev
->mach
= pdev
->dev
.platform_data
;
2124 dev
->transceiver
= usb_get_phy(USB_PHY_TYPE_USB2
);
2126 if (gpio_is_valid(dev
->mach
->gpio_pullup
)) {
2127 if ((retval
= gpio_request(dev
->mach
->gpio_pullup
,
2128 "pca25x_udc GPIO PULLUP"))) {
2130 "can't get pullup gpio %d, err: %d\n",
2131 dev
->mach
->gpio_pullup
, retval
);
2132 goto err_gpio_pullup
;
2134 gpio_direction_output(dev
->mach
->gpio_pullup
, 0);
2137 init_timer(&dev
->timer
);
2138 dev
->timer
.function
= udc_watchdog
;
2139 dev
->timer
.data
= (unsigned long) dev
;
2141 device_initialize(&dev
->gadget
.dev
);
2142 dev
->gadget
.dev
.parent
= &pdev
->dev
;
2143 dev
->gadget
.dev
.dma_mask
= pdev
->dev
.dma_mask
;
2145 retval
= device_add(&dev
->gadget
.dev
);
2148 dev
->gadget
.dev
.driver
= NULL
;
2149 goto err_device_add
;
2152 the_controller
= dev
;
2153 platform_set_drvdata(pdev
, dev
);
2160 /* irq setup after old hardware state is cleaned up */
2161 retval
= request_irq(irq
, pxa25x_udc_irq
,
2162 0, driver_name
, dev
);
2164 pr_err("%s: can't get irq %d, err %d\n",
2165 driver_name
, irq
, retval
);
2170 #ifdef CONFIG_ARCH_LUBBOCK
2171 if (machine_is_lubbock()) {
2172 retval
= request_irq(LUBBOCK_USB_DISC_IRQ
, lubbock_vbus_irq
,
2173 0, driver_name
, dev
);
2175 pr_err("%s: can't get irq %i, err %d\n",
2176 driver_name
, LUBBOCK_USB_DISC_IRQ
, retval
);
2179 retval
= request_irq(LUBBOCK_USB_IRQ
, lubbock_vbus_irq
,
2180 0, driver_name
, dev
);
2182 pr_err("%s: can't get irq %i, err %d\n",
2183 driver_name
, LUBBOCK_USB_IRQ
, retval
);
2188 create_debug_files(dev
);
2190 retval
= usb_add_gadget_udc(&pdev
->dev
, &dev
->gadget
);
2194 remove_debug_files(dev
);
2195 #ifdef CONFIG_ARCH_LUBBOCK
2197 free_irq(LUBBOCK_USB_DISC_IRQ
, dev
);
2202 device_unregister(&dev
->gadget
.dev
);
2204 if (gpio_is_valid(dev
->mach
->gpio_pullup
))
2205 gpio_free(dev
->mach
->gpio_pullup
);
2207 if (!IS_ERR_OR_NULL(dev
->transceiver
)) {
2208 usb_put_phy(dev
->transceiver
);
2209 dev
->transceiver
= NULL
;
2216 static void pxa25x_udc_shutdown(struct platform_device
*_dev
)
2221 static int __exit
pxa25x_udc_remove(struct platform_device
*pdev
)
2223 struct pxa25x_udc
*dev
= platform_get_drvdata(pdev
);
2228 usb_del_gadget_udc(&dev
->gadget
);
2229 device_unregister(&dev
->gadget
.dev
);
2233 remove_debug_files(dev
);
2236 free_irq(platform_get_irq(pdev
, 0), dev
);
2239 #ifdef CONFIG_ARCH_LUBBOCK
2240 if (machine_is_lubbock()) {
2241 free_irq(LUBBOCK_USB_DISC_IRQ
, dev
);
2242 free_irq(LUBBOCK_USB_IRQ
, dev
);
2245 if (gpio_is_valid(dev
->mach
->gpio_pullup
))
2246 gpio_free(dev
->mach
->gpio_pullup
);
2250 if (!IS_ERR_OR_NULL(dev
->transceiver
)) {
2251 usb_put_phy(dev
->transceiver
);
2252 dev
->transceiver
= NULL
;
2255 platform_set_drvdata(pdev
, NULL
);
2256 the_controller
= NULL
;
2260 /*-------------------------------------------------------------------------*/
2264 /* USB suspend (controlled by the host) and system suspend (controlled
2265 * by the PXA) don't necessarily work well together. If USB is active,
2266 * the 48 MHz clock is required; so the system can't enter 33 MHz idle
2267 * mode, or any deeper PM saving state.
2269 * For now, we punt and forcibly disconnect from the USB host when PXA
2270 * enters any suspend state. While we're disconnected, we always disable
2271 * the 48MHz USB clock ... allowing PXA sleep and/or 33 MHz idle states.
2272 * Boards without software pullup control shouldn't use those states.
2273 * VBUS IRQs should probably be ignored so that the PXA device just acts
2274 * "dead" to USB hosts until system resume.
2276 static int pxa25x_udc_suspend(struct platform_device
*dev
, pm_message_t state
)
2278 struct pxa25x_udc
*udc
= platform_get_drvdata(dev
);
2279 unsigned long flags
;
2281 if (!gpio_is_valid(udc
->mach
->gpio_pullup
) && !udc
->mach
->udc_command
)
2282 WARNING("USB host won't detect disconnect!\n");
2285 local_irq_save(flags
);
2287 local_irq_restore(flags
);
2292 static int pxa25x_udc_resume(struct platform_device
*dev
)
2294 struct pxa25x_udc
*udc
= platform_get_drvdata(dev
);
2295 unsigned long flags
;
2298 local_irq_save(flags
);
2300 local_irq_restore(flags
);
2306 #define pxa25x_udc_suspend NULL
2307 #define pxa25x_udc_resume NULL
2310 /*-------------------------------------------------------------------------*/
2312 static struct platform_driver udc_driver
= {
2313 .shutdown
= pxa25x_udc_shutdown
,
2314 .remove
= __exit_p(pxa25x_udc_remove
),
2315 .suspend
= pxa25x_udc_suspend
,
2316 .resume
= pxa25x_udc_resume
,
2318 .owner
= THIS_MODULE
,
2319 .name
= "pxa25x-udc",
2323 module_platform_driver_probe(udc_driver
, pxa25x_udc_probe
);
2325 MODULE_DESCRIPTION(DRIVER_DESC
);
2326 MODULE_AUTHOR("Frank Becker, Robert Schwebel, David Brownell");
2327 MODULE_LICENSE("GPL");
2328 MODULE_ALIAS("platform:pxa25x-udc");