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.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
26 /* #define VERBOSE_DEBUG */
28 #include <linux/device.h>
29 #include <linux/module.h>
30 #include <linux/kernel.h>
31 #include <linux/ioport.h>
32 #include <linux/types.h>
33 #include <linux/errno.h>
34 #include <linux/delay.h>
35 #include <linux/slab.h>
36 #include <linux/init.h>
37 #include <linux/timer.h>
38 #include <linux/list.h>
39 #include <linux/interrupt.h>
41 #include <linux/platform_device.h>
42 #include <linux/dma-mapping.h>
43 #include <linux/irq.h>
44 #include <linux/clk.h>
45 #include <linux/err.h>
46 #include <linux/seq_file.h>
47 #include <linux/debugfs.h>
49 #include <linux/prefetch.h>
51 #include <asm/byteorder.h>
54 #include <asm/system.h>
55 #include <asm/mach-types.h>
56 #include <asm/unaligned.h>
58 #include <linux/usb/ch9.h>
59 #include <linux/usb/gadget.h>
60 #include <linux/usb/otg.h>
63 * This driver is PXA25x only. Grab the right register definitions.
65 #ifdef CONFIG_ARCH_PXA
66 #include <mach/pxa25x-udc.h>
69 #ifdef CONFIG_ARCH_LUBBOCK
70 #include <mach/lubbock.h>
73 #include <asm/mach/udc_pxa2xx.h>
77 * This driver handles the USB Device Controller (UDC) in Intel's PXA 25x
78 * series processors. The UDC for the IXP 4xx series is very similar.
79 * There are fifteen endpoints, in addition to ep0.
81 * Such controller drivers work with a gadget driver. The gadget driver
82 * returns descriptors, implements configuration and data protocols used
83 * by the host to interact with this device, and allocates endpoints to
84 * the different protocol interfaces. The controller driver virtualizes
85 * usb hardware so that the gadget drivers will be more portable.
87 * This UDC hardware wants to implement a bit too much USB protocol, so
88 * it constrains the sorts of USB configuration change events that work.
89 * The errata for these chips are misleading; some "fixed" bugs from
90 * pxa250 a0/a1 b0/b1/b2 sure act like they're still there.
92 * Note that the UDC hardware supports DMA (except on IXP) but that's
93 * not used here. IN-DMA (to host) is simple enough, when the data is
94 * suitably aligned (16 bytes) ... the network stack doesn't do that,
95 * other software can. OUT-DMA is buggy in most chip versions, as well
96 * as poorly designed (data toggle not automatic). So this driver won't
97 * bother using DMA. (Mostly-working IN-DMA support was available in
98 * kernels before 2.6.23, but was never enabled or well tested.)
101 #define DRIVER_VERSION "30-June-2007"
102 #define DRIVER_DESC "PXA 25x USB Device Controller driver"
105 static const char driver_name
[] = "pxa25x_udc";
107 static const char ep0name
[] = "ep0";
110 #ifdef CONFIG_ARCH_IXP4XX
112 /* cpu-specific register addresses are compiled in to this code */
113 #ifdef CONFIG_ARCH_PXA
114 #error "Can't configure both IXP and PXA"
117 /* IXP doesn't yet support <linux/clk.h> */
118 #define clk_get(dev,name) NULL
119 #define clk_enable(clk) do { } while (0)
120 #define clk_disable(clk) do { } while (0)
121 #define clk_put(clk) do { } while (0)
125 #include "pxa25x_udc.h"
128 #ifdef CONFIG_USB_PXA25X_SMALL
129 #define SIZE_STR " (small)"
134 /* ---------------------------------------------------------------------------
135 * endpoint related parts of the api to the usb controller hardware,
136 * used by gadget driver; and the inner talker-to-hardware core.
137 * ---------------------------------------------------------------------------
140 static void pxa25x_ep_fifo_flush (struct usb_ep
*ep
);
141 static void nuke (struct pxa25x_ep
*, int status
);
143 /* one GPIO should control a D+ pullup, so host sees this device (or not) */
144 static void pullup_off(void)
146 struct pxa2xx_udc_mach_info
*mach
= the_controller
->mach
;
147 int off_level
= mach
->gpio_pullup_inverted
;
149 if (gpio_is_valid(mach
->gpio_pullup
))
150 gpio_set_value(mach
->gpio_pullup
, off_level
);
151 else if (mach
->udc_command
)
152 mach
->udc_command(PXA2XX_UDC_CMD_DISCONNECT
);
155 static void pullup_on(void)
157 struct pxa2xx_udc_mach_info
*mach
= the_controller
->mach
;
158 int on_level
= !mach
->gpio_pullup_inverted
;
160 if (gpio_is_valid(mach
->gpio_pullup
))
161 gpio_set_value(mach
->gpio_pullup
, on_level
);
162 else if (mach
->udc_command
)
163 mach
->udc_command(PXA2XX_UDC_CMD_CONNECT
);
166 static void pio_irq_enable(int bEndpointAddress
)
168 bEndpointAddress
&= 0xf;
169 if (bEndpointAddress
< 8)
170 UICR0
&= ~(1 << bEndpointAddress
);
172 bEndpointAddress
-= 8;
173 UICR1
&= ~(1 << bEndpointAddress
);
177 static void pio_irq_disable(int bEndpointAddress
)
179 bEndpointAddress
&= 0xf;
180 if (bEndpointAddress
< 8)
181 UICR0
|= 1 << bEndpointAddress
;
183 bEndpointAddress
-= 8;
184 UICR1
|= 1 << bEndpointAddress
;
188 /* The UDCCR reg contains mask and interrupt status bits,
189 * so using '|=' isn't safe as it may ack an interrupt.
191 #define UDCCR_MASK_BITS (UDCCR_REM | UDCCR_SRM | UDCCR_UDE)
193 static inline void udc_set_mask_UDCCR(int mask
)
195 UDCCR
= (UDCCR
& UDCCR_MASK_BITS
) | (mask
& UDCCR_MASK_BITS
);
198 static inline void udc_clear_mask_UDCCR(int mask
)
200 UDCCR
= (UDCCR
& UDCCR_MASK_BITS
) & ~(mask
& UDCCR_MASK_BITS
);
203 static inline void udc_ack_int_UDCCR(int mask
)
205 /* udccr contains the bits we dont want to change */
206 __u32 udccr
= UDCCR
& UDCCR_MASK_BITS
;
208 UDCCR
= udccr
| (mask
& ~UDCCR_MASK_BITS
);
212 * endpoint enable/disable
214 * we need to verify the descriptors used to enable endpoints. since pxa25x
215 * endpoint configurations are fixed, and are pretty much always enabled,
216 * there's not a lot to manage here.
218 * because pxa25x can't selectively initialize bulk (or interrupt) endpoints,
219 * (resetting endpoint halt and toggle), SET_INTERFACE is unusable except
220 * for a single interface (with only the default altsetting) and for gadget
221 * drivers that don't halt endpoints (not reset by set_interface). that also
222 * means that if you use ISO, you must violate the USB spec rule that all
223 * iso endpoints must be in non-default altsettings.
225 static int pxa25x_ep_enable (struct usb_ep
*_ep
,
226 const struct usb_endpoint_descriptor
*desc
)
228 struct pxa25x_ep
*ep
;
229 struct pxa25x_udc
*dev
;
231 ep
= container_of (_ep
, struct pxa25x_ep
, ep
);
232 if (!_ep
|| !desc
|| ep
->desc
|| _ep
->name
== ep0name
233 || desc
->bDescriptorType
!= USB_DT_ENDPOINT
234 || ep
->bEndpointAddress
!= desc
->bEndpointAddress
235 || ep
->fifo_size
< le16_to_cpu
236 (desc
->wMaxPacketSize
)) {
237 DMSG("%s, bad ep or descriptor\n", __func__
);
241 /* xfer types must match, except that interrupt ~= bulk */
242 if (ep
->bmAttributes
!= desc
->bmAttributes
243 && ep
->bmAttributes
!= USB_ENDPOINT_XFER_BULK
244 && desc
->bmAttributes
!= USB_ENDPOINT_XFER_INT
) {
245 DMSG("%s, %s type mismatch\n", __func__
, _ep
->name
);
249 /* hardware _could_ do smaller, but driver doesn't */
250 if ((desc
->bmAttributes
== USB_ENDPOINT_XFER_BULK
251 && le16_to_cpu (desc
->wMaxPacketSize
)
253 || !desc
->wMaxPacketSize
) {
254 DMSG("%s, bad %s maxpacket\n", __func__
, _ep
->name
);
259 if (!dev
->driver
|| dev
->gadget
.speed
== USB_SPEED_UNKNOWN
) {
260 DMSG("%s, bogus device state\n", __func__
);
267 ep
->ep
.maxpacket
= le16_to_cpu (desc
->wMaxPacketSize
);
269 /* flush fifo (mostly for OUT buffers) */
270 pxa25x_ep_fifo_flush (_ep
);
272 /* ... reset halt state too, if we could ... */
274 DBG(DBG_VERBOSE
, "enabled %s\n", _ep
->name
);
278 static int pxa25x_ep_disable (struct usb_ep
*_ep
)
280 struct pxa25x_ep
*ep
;
283 ep
= container_of (_ep
, struct pxa25x_ep
, ep
);
284 if (!_ep
|| !ep
->desc
) {
285 DMSG("%s, %s not enabled\n", __func__
,
286 _ep
? ep
->ep
.name
: NULL
);
289 local_irq_save(flags
);
291 nuke (ep
, -ESHUTDOWN
);
293 /* flush fifo (mostly for IN buffers) */
294 pxa25x_ep_fifo_flush (_ep
);
299 local_irq_restore(flags
);
300 DBG(DBG_VERBOSE
, "%s disabled\n", _ep
->name
);
304 /*-------------------------------------------------------------------------*/
306 /* for the pxa25x, these can just wrap kmalloc/kfree. gadget drivers
307 * must still pass correctly initialized endpoints, since other controller
308 * drivers may care about how it's currently set up (dma issues etc).
312 * pxa25x_ep_alloc_request - allocate a request data structure
314 static struct usb_request
*
315 pxa25x_ep_alloc_request (struct usb_ep
*_ep
, gfp_t gfp_flags
)
317 struct pxa25x_request
*req
;
319 req
= kzalloc(sizeof(*req
), gfp_flags
);
323 INIT_LIST_HEAD (&req
->queue
);
329 * pxa25x_ep_free_request - deallocate a request data structure
332 pxa25x_ep_free_request (struct usb_ep
*_ep
, struct usb_request
*_req
)
334 struct pxa25x_request
*req
;
336 req
= container_of (_req
, struct pxa25x_request
, req
);
337 WARN_ON(!list_empty (&req
->queue
));
341 /*-------------------------------------------------------------------------*/
344 * done - retire a request; caller blocked irqs
346 static void done(struct pxa25x_ep
*ep
, struct pxa25x_request
*req
, int status
)
348 unsigned stopped
= ep
->stopped
;
350 list_del_init(&req
->queue
);
352 if (likely (req
->req
.status
== -EINPROGRESS
))
353 req
->req
.status
= status
;
355 status
= req
->req
.status
;
357 if (status
&& status
!= -ESHUTDOWN
)
358 DBG(DBG_VERBOSE
, "complete %s req %p stat %d len %u/%u\n",
359 ep
->ep
.name
, &req
->req
, status
,
360 req
->req
.actual
, req
->req
.length
);
362 /* don't modify queue heads during completion callback */
364 req
->req
.complete(&ep
->ep
, &req
->req
);
365 ep
->stopped
= stopped
;
369 static inline void ep0_idle (struct pxa25x_udc
*dev
)
371 dev
->ep0state
= EP0_IDLE
;
375 write_packet(volatile u32
*uddr
, struct pxa25x_request
*req
, unsigned max
)
378 unsigned length
, count
;
380 buf
= req
->req
.buf
+ req
->req
.actual
;
383 /* how big will this packet be? */
384 length
= min(req
->req
.length
- req
->req
.actual
, max
);
385 req
->req
.actual
+= length
;
388 while (likely(count
--))
395 * write to an IN endpoint fifo, as many packets as possible.
396 * irqs will use this to write the rest later.
397 * caller guarantees at least one packet buffer is ready (or a zlp).
400 write_fifo (struct pxa25x_ep
*ep
, struct pxa25x_request
*req
)
404 max
= le16_to_cpu(ep
->desc
->wMaxPacketSize
);
407 int is_last
, is_short
;
409 count
= write_packet(ep
->reg_uddr
, req
, max
);
411 /* last packet is usually short (or a zlp) */
412 if (unlikely (count
!= max
))
413 is_last
= is_short
= 1;
415 if (likely(req
->req
.length
!= req
->req
.actual
)
420 /* interrupt/iso maxpacket may not fill the fifo */
421 is_short
= unlikely (max
< ep
->fifo_size
);
424 DBG(DBG_VERY_NOISY
, "wrote %s %d bytes%s%s %d left %p\n",
426 is_last
? "/L" : "", is_short
? "/S" : "",
427 req
->req
.length
- req
->req
.actual
, req
);
429 /* let loose that packet. maybe try writing another one,
430 * double buffering might work. TSP, TPC, and TFS
431 * bit values are the same for all normal IN endpoints.
433 *ep
->reg_udccs
= UDCCS_BI_TPC
;
435 *ep
->reg_udccs
= UDCCS_BI_TSP
;
437 /* requests complete when all IN data is in the FIFO */
440 if (list_empty(&ep
->queue
))
441 pio_irq_disable (ep
->bEndpointAddress
);
445 // TODO experiment: how robust can fifo mode tweaking be?
446 // double buffering is off in the default fifo mode, which
447 // prevents TFS from being set here.
449 } while (*ep
->reg_udccs
& UDCCS_BI_TFS
);
453 /* caller asserts req->pending (ep0 irq status nyet cleared); starts
454 * ep0 data stage. these chips want very simple state transitions.
457 void ep0start(struct pxa25x_udc
*dev
, u32 flags
, const char *tag
)
459 UDCCS0
= flags
|UDCCS0_SA
|UDCCS0_OPR
;
461 dev
->req_pending
= 0;
462 DBG(DBG_VERY_NOISY
, "%s %s, %02x/%02x\n",
463 __func__
, tag
, UDCCS0
, flags
);
467 write_ep0_fifo (struct pxa25x_ep
*ep
, struct pxa25x_request
*req
)
472 count
= write_packet(&UDDR0
, req
, EP0_FIFO_SIZE
);
473 ep
->dev
->stats
.write
.bytes
+= count
;
475 /* last packet "must be" short (or a zlp) */
476 is_short
= (count
!= EP0_FIFO_SIZE
);
478 DBG(DBG_VERY_NOISY
, "ep0in %d bytes %d left %p\n", count
,
479 req
->req
.length
- req
->req
.actual
, req
);
481 if (unlikely (is_short
)) {
482 if (ep
->dev
->req_pending
)
483 ep0start(ep
->dev
, UDCCS0_IPR
, "short IN");
487 count
= req
->req
.length
;
490 #ifndef CONFIG_ARCH_IXP4XX
492 /* This seems to get rid of lost status irqs in some cases:
493 * host responds quickly, or next request involves config
494 * change automagic, or should have been hidden, or ...
496 * FIXME get rid of all udelays possible...
498 if (count
>= EP0_FIFO_SIZE
) {
501 if ((UDCCS0
& UDCCS0_OPR
) != 0) {
502 /* clear OPR, generate ack */
512 } else if (ep
->dev
->req_pending
)
513 ep0start(ep
->dev
, 0, "IN");
519 * read_fifo - unload packet(s) from the fifo we use for usb OUT
520 * transfers and put them into the request. caller should have made
521 * sure there's at least one packet ready.
523 * returns true if the request completed because of short packet or the
524 * request buffer having filled (and maybe overran till end-of-packet).
527 read_fifo (struct pxa25x_ep
*ep
, struct pxa25x_request
*req
)
532 unsigned bufferspace
, count
, is_short
;
534 /* make sure there's a packet in the FIFO.
535 * UDCCS_{BO,IO}_RPC are all the same bit value.
536 * UDCCS_{BO,IO}_RNE are all the same bit value.
538 udccs
= *ep
->reg_udccs
;
539 if (unlikely ((udccs
& UDCCS_BO_RPC
) == 0))
541 buf
= req
->req
.buf
+ req
->req
.actual
;
543 bufferspace
= req
->req
.length
- req
->req
.actual
;
545 /* read all bytes from this packet */
546 if (likely (udccs
& UDCCS_BO_RNE
)) {
547 count
= 1 + (0x0ff & *ep
->reg_ubcr
);
548 req
->req
.actual
+= min (count
, bufferspace
);
551 is_short
= (count
< ep
->ep
.maxpacket
);
552 DBG(DBG_VERY_NOISY
, "read %s %02x, %d bytes%s req %p %d/%d\n",
553 ep
->ep
.name
, udccs
, count
,
554 is_short
? "/S" : "",
555 req
, req
->req
.actual
, req
->req
.length
);
556 while (likely (count
-- != 0)) {
557 u8 byte
= (u8
) *ep
->reg_uddr
;
559 if (unlikely (bufferspace
== 0)) {
560 /* this happens when the driver's buffer
561 * is smaller than what the host sent.
562 * discard the extra data.
564 if (req
->req
.status
!= -EOVERFLOW
)
565 DMSG("%s overflow %d\n",
567 req
->req
.status
= -EOVERFLOW
;
573 *ep
->reg_udccs
= UDCCS_BO_RPC
;
574 /* RPC/RSP/RNE could now reflect the other packet buffer */
576 /* iso is one request per packet */
577 if (ep
->bmAttributes
== USB_ENDPOINT_XFER_ISOC
) {
578 if (udccs
& UDCCS_IO_ROF
)
579 req
->req
.status
= -EHOSTUNREACH
;
580 /* more like "is_done" */
585 if (is_short
|| req
->req
.actual
== req
->req
.length
) {
587 if (list_empty(&ep
->queue
))
588 pio_irq_disable (ep
->bEndpointAddress
);
592 /* finished that packet. the next one may be waiting... */
598 * special ep0 version of the above. no UBCR0 or double buffering; status
599 * handshaking is magic. most device protocols don't need control-OUT.
600 * CDC vendor commands (and RNDIS), mass storage CB/CBI, and some other
601 * protocols do use them.
604 read_ep0_fifo (struct pxa25x_ep
*ep
, struct pxa25x_request
*req
)
607 unsigned bufferspace
;
609 buf
= req
->req
.buf
+ req
->req
.actual
;
610 bufferspace
= req
->req
.length
- req
->req
.actual
;
612 while (UDCCS0
& UDCCS0_RNE
) {
615 if (unlikely (bufferspace
== 0)) {
616 /* this happens when the driver's buffer
617 * is smaller than what the host sent.
618 * discard the extra data.
620 if (req
->req
.status
!= -EOVERFLOW
)
621 DMSG("%s overflow\n", ep
->ep
.name
);
622 req
->req
.status
= -EOVERFLOW
;
630 UDCCS0
= UDCCS0_OPR
| UDCCS0_IPR
;
633 if (req
->req
.actual
>= req
->req
.length
)
636 /* finished that packet. the next one may be waiting... */
640 /*-------------------------------------------------------------------------*/
643 pxa25x_ep_queue(struct usb_ep
*_ep
, struct usb_request
*_req
, gfp_t gfp_flags
)
645 struct pxa25x_request
*req
;
646 struct pxa25x_ep
*ep
;
647 struct pxa25x_udc
*dev
;
650 req
= container_of(_req
, struct pxa25x_request
, req
);
651 if (unlikely (!_req
|| !_req
->complete
|| !_req
->buf
652 || !list_empty(&req
->queue
))) {
653 DMSG("%s, bad params\n", __func__
);
657 ep
= container_of(_ep
, struct pxa25x_ep
, ep
);
658 if (unlikely (!_ep
|| (!ep
->desc
&& ep
->ep
.name
!= ep0name
))) {
659 DMSG("%s, bad ep\n", __func__
);
664 if (unlikely (!dev
->driver
665 || dev
->gadget
.speed
== USB_SPEED_UNKNOWN
)) {
666 DMSG("%s, bogus device state\n", __func__
);
670 /* iso is always one packet per request, that's the only way
671 * we can report per-packet status. that also helps with dma.
673 if (unlikely (ep
->bmAttributes
== USB_ENDPOINT_XFER_ISOC
674 && req
->req
.length
> le16_to_cpu
675 (ep
->desc
->wMaxPacketSize
)))
678 DBG(DBG_NOISY
, "%s queue req %p, len %d buf %p\n",
679 _ep
->name
, _req
, _req
->length
, _req
->buf
);
681 local_irq_save(flags
);
683 _req
->status
= -EINPROGRESS
;
686 /* kickstart this i/o queue? */
687 if (list_empty(&ep
->queue
) && !ep
->stopped
) {
688 if (ep
->desc
== NULL
/* ep0 */) {
689 unsigned length
= _req
->length
;
691 switch (dev
->ep0state
) {
692 case EP0_IN_DATA_PHASE
:
693 dev
->stats
.write
.ops
++;
694 if (write_ep0_fifo(ep
, req
))
698 case EP0_OUT_DATA_PHASE
:
699 dev
->stats
.read
.ops
++;
701 if (dev
->req_config
) {
702 DBG(DBG_VERBOSE
, "ep0 config ack%s\n",
703 dev
->has_cfr
? "" : " raced");
705 UDCCFR
= UDCCFR_AREN
|UDCCFR_ACM
708 dev
->ep0state
= EP0_END_XFER
;
709 local_irq_restore (flags
);
712 if (dev
->req_pending
)
713 ep0start(dev
, UDCCS0_IPR
, "OUT");
714 if (length
== 0 || ((UDCCS0
& UDCCS0_RNE
) != 0
715 && read_ep0_fifo(ep
, req
))) {
723 DMSG("ep0 i/o, odd state %d\n", dev
->ep0state
);
724 local_irq_restore (flags
);
727 /* can the FIFO can satisfy the request immediately? */
728 } else if ((ep
->bEndpointAddress
& USB_DIR_IN
) != 0) {
729 if ((*ep
->reg_udccs
& UDCCS_BI_TFS
) != 0
730 && write_fifo(ep
, req
))
732 } else if ((*ep
->reg_udccs
& UDCCS_BO_RFS
) != 0
733 && read_fifo(ep
, req
)) {
737 if (likely (req
&& ep
->desc
))
738 pio_irq_enable(ep
->bEndpointAddress
);
741 /* pio or dma irq handler advances the queue. */
742 if (likely(req
!= NULL
))
743 list_add_tail(&req
->queue
, &ep
->queue
);
744 local_irq_restore(flags
);
751 * nuke - dequeue ALL requests
753 static void nuke(struct pxa25x_ep
*ep
, int status
)
755 struct pxa25x_request
*req
;
757 /* called with irqs blocked */
758 while (!list_empty(&ep
->queue
)) {
759 req
= list_entry(ep
->queue
.next
,
760 struct pxa25x_request
,
762 done(ep
, req
, status
);
765 pio_irq_disable (ep
->bEndpointAddress
);
769 /* dequeue JUST ONE request */
770 static int pxa25x_ep_dequeue(struct usb_ep
*_ep
, struct usb_request
*_req
)
772 struct pxa25x_ep
*ep
;
773 struct pxa25x_request
*req
;
776 ep
= container_of(_ep
, struct pxa25x_ep
, ep
);
777 if (!_ep
|| ep
->ep
.name
== ep0name
)
780 local_irq_save(flags
);
782 /* make sure it's actually queued on this endpoint */
783 list_for_each_entry (req
, &ep
->queue
, queue
) {
784 if (&req
->req
== _req
)
787 if (&req
->req
!= _req
) {
788 local_irq_restore(flags
);
792 done(ep
, req
, -ECONNRESET
);
794 local_irq_restore(flags
);
798 /*-------------------------------------------------------------------------*/
800 static int pxa25x_ep_set_halt(struct usb_ep
*_ep
, int value
)
802 struct pxa25x_ep
*ep
;
805 ep
= container_of(_ep
, struct pxa25x_ep
, ep
);
807 || (!ep
->desc
&& ep
->ep
.name
!= ep0name
))
808 || ep
->bmAttributes
== USB_ENDPOINT_XFER_ISOC
) {
809 DMSG("%s, bad ep\n", __func__
);
813 /* this path (reset toggle+halt) is needed to implement
814 * SET_INTERFACE on normal hardware. but it can't be
815 * done from software on the PXA UDC, and the hardware
816 * forgets to do it as part of SET_INTERFACE automagic.
818 DMSG("only host can clear %s halt\n", _ep
->name
);
822 local_irq_save(flags
);
824 if ((ep
->bEndpointAddress
& USB_DIR_IN
) != 0
825 && ((*ep
->reg_udccs
& UDCCS_BI_TFS
) == 0
826 || !list_empty(&ep
->queue
))) {
827 local_irq_restore(flags
);
831 /* FST bit is the same for control, bulk in, bulk out, interrupt in */
832 *ep
->reg_udccs
= UDCCS_BI_FST
|UDCCS_BI_FTF
;
834 /* ep0 needs special care */
836 start_watchdog(ep
->dev
);
837 ep
->dev
->req_pending
= 0;
838 ep
->dev
->ep0state
= EP0_STALL
;
840 /* and bulk/intr endpoints like dropping stalls too */
843 for (i
= 0; i
< 1000; i
+= 20) {
844 if (*ep
->reg_udccs
& UDCCS_BI_SST
)
849 local_irq_restore(flags
);
851 DBG(DBG_VERBOSE
, "%s halt\n", _ep
->name
);
855 static int pxa25x_ep_fifo_status(struct usb_ep
*_ep
)
857 struct pxa25x_ep
*ep
;
859 ep
= container_of(_ep
, struct pxa25x_ep
, ep
);
861 DMSG("%s, bad ep\n", __func__
);
864 /* pxa can't report unclaimed bytes from IN fifos */
865 if ((ep
->bEndpointAddress
& USB_DIR_IN
) != 0)
867 if (ep
->dev
->gadget
.speed
== USB_SPEED_UNKNOWN
868 || (*ep
->reg_udccs
& UDCCS_BO_RFS
) == 0)
871 return (*ep
->reg_ubcr
& 0xfff) + 1;
874 static void pxa25x_ep_fifo_flush(struct usb_ep
*_ep
)
876 struct pxa25x_ep
*ep
;
878 ep
= container_of(_ep
, struct pxa25x_ep
, ep
);
879 if (!_ep
|| ep
->ep
.name
== ep0name
|| !list_empty(&ep
->queue
)) {
880 DMSG("%s, bad ep\n", __func__
);
884 /* toggle and halt bits stay unchanged */
886 /* for OUT, just read and discard the FIFO contents. */
887 if ((ep
->bEndpointAddress
& USB_DIR_IN
) == 0) {
888 while (((*ep
->reg_udccs
) & UDCCS_BO_RNE
) != 0)
889 (void) *ep
->reg_uddr
;
893 /* most IN status is the same, but ISO can't stall */
894 *ep
->reg_udccs
= UDCCS_BI_TPC
|UDCCS_BI_FTF
|UDCCS_BI_TUR
895 | (ep
->bmAttributes
== USB_ENDPOINT_XFER_ISOC
900 static struct usb_ep_ops pxa25x_ep_ops
= {
901 .enable
= pxa25x_ep_enable
,
902 .disable
= pxa25x_ep_disable
,
904 .alloc_request
= pxa25x_ep_alloc_request
,
905 .free_request
= pxa25x_ep_free_request
,
907 .queue
= pxa25x_ep_queue
,
908 .dequeue
= pxa25x_ep_dequeue
,
910 .set_halt
= pxa25x_ep_set_halt
,
911 .fifo_status
= pxa25x_ep_fifo_status
,
912 .fifo_flush
= pxa25x_ep_fifo_flush
,
916 /* ---------------------------------------------------------------------------
917 * device-scoped parts of the api to the usb controller hardware
918 * ---------------------------------------------------------------------------
921 static int pxa25x_udc_get_frame(struct usb_gadget
*_gadget
)
923 return ((UFNRH
& 0x07) << 8) | (UFNRL
& 0xff);
926 static int pxa25x_udc_wakeup(struct usb_gadget
*_gadget
)
928 /* host may not have enabled remote wakeup */
929 if ((UDCCS0
& UDCCS0_DRWF
) == 0)
930 return -EHOSTUNREACH
;
931 udc_set_mask_UDCCR(UDCCR_RSM
);
935 static void stop_activity(struct pxa25x_udc
*, struct usb_gadget_driver
*);
936 static void udc_enable (struct pxa25x_udc
*);
937 static void udc_disable(struct pxa25x_udc
*);
939 /* We disable the UDC -- and its 48 MHz clock -- whenever it's not
942 static int pullup(struct pxa25x_udc
*udc
)
944 int is_active
= udc
->vbus
&& udc
->pullup
&& !udc
->suspended
;
945 DMSG("%s\n", is_active
? "active" : "inactive");
949 /* Enable clock for USB device */
950 clk_enable(udc
->clk
);
955 if (udc
->gadget
.speed
!= USB_SPEED_UNKNOWN
) {
956 DMSG("disconnect %s\n", udc
->driver
957 ? udc
->driver
->driver
.name
959 stop_activity(udc
, udc
->driver
);
962 /* Disable clock for USB device */
963 clk_disable(udc
->clk
);
971 /* VBUS reporting logically comes from a transceiver */
972 static int pxa25x_udc_vbus_session(struct usb_gadget
*_gadget
, int is_active
)
974 struct pxa25x_udc
*udc
;
976 udc
= container_of(_gadget
, struct pxa25x_udc
, gadget
);
977 udc
->vbus
= is_active
;
978 DMSG("vbus %s\n", is_active
? "supplied" : "inactive");
983 /* drivers may have software control over D+ pullup */
984 static int pxa25x_udc_pullup(struct usb_gadget
*_gadget
, int is_active
)
986 struct pxa25x_udc
*udc
;
988 udc
= container_of(_gadget
, struct pxa25x_udc
, gadget
);
990 /* not all boards support pullup control */
991 if (!gpio_is_valid(udc
->mach
->gpio_pullup
) && !udc
->mach
->udc_command
)
994 udc
->pullup
= (is_active
!= 0);
999 /* boards may consume current from VBUS, up to 100-500mA based on config.
1000 * the 500uA suspend ceiling means that exclusively vbus-powered PXA designs
1001 * violate USB specs.
1003 static int pxa25x_udc_vbus_draw(struct usb_gadget
*_gadget
, unsigned mA
)
1005 struct pxa25x_udc
*udc
;
1007 udc
= container_of(_gadget
, struct pxa25x_udc
, gadget
);
1009 if (udc
->transceiver
)
1010 return otg_set_power(udc
->transceiver
, mA
);
1014 static int pxa25x_start(struct usb_gadget_driver
*driver
,
1015 int (*bind
)(struct usb_gadget
*));
1016 static int pxa25x_stop(struct usb_gadget_driver
*driver
);
1018 static const struct usb_gadget_ops pxa25x_udc_ops
= {
1019 .get_frame
= pxa25x_udc_get_frame
,
1020 .wakeup
= pxa25x_udc_wakeup
,
1021 .vbus_session
= pxa25x_udc_vbus_session
,
1022 .pullup
= pxa25x_udc_pullup
,
1023 .vbus_draw
= pxa25x_udc_vbus_draw
,
1024 .start
= pxa25x_start
,
1025 .stop
= pxa25x_stop
,
1028 /*-------------------------------------------------------------------------*/
1030 #ifdef CONFIG_USB_GADGET_DEBUG_FS
1033 udc_seq_show(struct seq_file
*m
, void *_d
)
1035 struct pxa25x_udc
*dev
= m
->private;
1036 unsigned long flags
;
1040 local_irq_save(flags
);
1042 /* basic device status */
1043 seq_printf(m
, DRIVER_DESC
"\n"
1044 "%s version: %s\nGadget driver: %s\nHost %s\n\n",
1045 driver_name
, DRIVER_VERSION SIZE_STR
"(pio)",
1046 dev
->driver
? dev
->driver
->driver
.name
: "(none)",
1047 dev
->gadget
.speed
== USB_SPEED_FULL
? "full speed" : "disconnected");
1049 /* registers for device and ep0 */
1051 "uicr %02X.%02X, usir %02X.%02x, ufnr %02X.%02X\n",
1052 UICR1
, UICR0
, USIR1
, USIR0
, UFNRH
, UFNRL
);
1056 "udccr %02X =%s%s%s%s%s%s%s%s\n", tmp
,
1057 (tmp
& UDCCR_REM
) ? " rem" : "",
1058 (tmp
& UDCCR_RSTIR
) ? " rstir" : "",
1059 (tmp
& UDCCR_SRM
) ? " srm" : "",
1060 (tmp
& UDCCR_SUSIR
) ? " susir" : "",
1061 (tmp
& UDCCR_RESIR
) ? " resir" : "",
1062 (tmp
& UDCCR_RSM
) ? " rsm" : "",
1063 (tmp
& UDCCR_UDA
) ? " uda" : "",
1064 (tmp
& UDCCR_UDE
) ? " ude" : "");
1068 "udccs0 %02X =%s%s%s%s%s%s%s%s\n", tmp
,
1069 (tmp
& UDCCS0_SA
) ? " sa" : "",
1070 (tmp
& UDCCS0_RNE
) ? " rne" : "",
1071 (tmp
& UDCCS0_FST
) ? " fst" : "",
1072 (tmp
& UDCCS0_SST
) ? " sst" : "",
1073 (tmp
& UDCCS0_DRWF
) ? " dwrf" : "",
1074 (tmp
& UDCCS0_FTF
) ? " ftf" : "",
1075 (tmp
& UDCCS0_IPR
) ? " ipr" : "",
1076 (tmp
& UDCCS0_OPR
) ? " opr" : "");
1081 "udccfr %02X =%s%s\n", tmp
,
1082 (tmp
& UDCCFR_AREN
) ? " aren" : "",
1083 (tmp
& UDCCFR_ACM
) ? " acm" : "");
1086 if (dev
->gadget
.speed
!= USB_SPEED_FULL
|| !dev
->driver
)
1089 seq_printf(m
, "ep0 IN %lu/%lu, OUT %lu/%lu\nirqs %lu\n\n",
1090 dev
->stats
.write
.bytes
, dev
->stats
.write
.ops
,
1091 dev
->stats
.read
.bytes
, dev
->stats
.read
.ops
,
1094 /* dump endpoint queues */
1095 for (i
= 0; i
< PXA_UDC_NUM_ENDPOINTS
; i
++) {
1096 struct pxa25x_ep
*ep
= &dev
->ep
[i
];
1097 struct pxa25x_request
*req
;
1100 const struct usb_endpoint_descriptor
*desc
;
1105 tmp
= *dev
->ep
[i
].reg_udccs
;
1107 "%s max %d %s udccs %02x irqs %lu\n",
1108 ep
->ep
.name
, le16_to_cpu(desc
->wMaxPacketSize
),
1109 "pio", tmp
, ep
->pio_irqs
);
1110 /* TODO translate all five groups of udccs bits! */
1112 } else /* ep0 should only have one transfer queued */
1113 seq_printf(m
, "ep0 max 16 pio irqs %lu\n",
1116 if (list_empty(&ep
->queue
)) {
1117 seq_printf(m
, "\t(nothing queued)\n");
1120 list_for_each_entry(req
, &ep
->queue
, queue
) {
1122 "\treq %p len %d/%d buf %p\n",
1123 &req
->req
, req
->req
.actual
,
1124 req
->req
.length
, req
->req
.buf
);
1129 local_irq_restore(flags
);
1134 udc_debugfs_open(struct inode
*inode
, struct file
*file
)
1136 return single_open(file
, udc_seq_show
, inode
->i_private
);
1139 static const struct file_operations debug_fops
= {
1140 .open
= udc_debugfs_open
,
1142 .llseek
= seq_lseek
,
1143 .release
= single_release
,
1144 .owner
= THIS_MODULE
,
1147 #define create_debug_files(dev) \
1149 dev->debugfs_udc = debugfs_create_file(dev->gadget.name, \
1150 S_IRUGO, NULL, dev, &debug_fops); \
1152 #define remove_debug_files(dev) \
1154 if (dev->debugfs_udc) \
1155 debugfs_remove(dev->debugfs_udc); \
1158 #else /* !CONFIG_USB_GADGET_DEBUG_FILES */
1160 #define create_debug_files(dev) do {} while (0)
1161 #define remove_debug_files(dev) do {} while (0)
1163 #endif /* CONFIG_USB_GADGET_DEBUG_FILES */
1165 /*-------------------------------------------------------------------------*/
1168 * udc_disable - disable USB device controller
1170 static void udc_disable(struct pxa25x_udc
*dev
)
1172 /* block all irqs */
1173 udc_set_mask_UDCCR(UDCCR_SRM
|UDCCR_REM
);
1174 UICR0
= UICR1
= 0xff;
1177 /* if hardware supports it, disconnect from usb */
1180 udc_clear_mask_UDCCR(UDCCR_UDE
);
1183 dev
->gadget
.speed
= USB_SPEED_UNKNOWN
;
1188 * udc_reinit - initialize software state
1190 static void udc_reinit(struct pxa25x_udc
*dev
)
1194 /* device/ep0 records init */
1195 INIT_LIST_HEAD (&dev
->gadget
.ep_list
);
1196 INIT_LIST_HEAD (&dev
->gadget
.ep0
->ep_list
);
1197 dev
->ep0state
= EP0_IDLE
;
1199 /* basic endpoint records init */
1200 for (i
= 0; i
< PXA_UDC_NUM_ENDPOINTS
; i
++) {
1201 struct pxa25x_ep
*ep
= &dev
->ep
[i
];
1204 list_add_tail (&ep
->ep
.ep_list
, &dev
->gadget
.ep_list
);
1208 INIT_LIST_HEAD (&ep
->queue
);
1212 /* the rest was statically initialized, and is read-only */
1215 /* until it's enabled, this UDC should be completely invisible
1218 static void udc_enable (struct pxa25x_udc
*dev
)
1220 udc_clear_mask_UDCCR(UDCCR_UDE
);
1222 /* try to clear these bits before we enable the udc */
1223 udc_ack_int_UDCCR(UDCCR_SUSIR
|/*UDCCR_RSTIR|*/UDCCR_RESIR
);
1226 dev
->gadget
.speed
= USB_SPEED_UNKNOWN
;
1227 dev
->stats
.irqs
= 0;
1230 * sequence taken from chapter 12.5.10, PXA250 AppProcDevManual:
1232 * - if RESET is already in progress, ack interrupt
1233 * - unmask reset interrupt
1235 udc_set_mask_UDCCR(UDCCR_UDE
);
1236 if (!(UDCCR
& UDCCR_UDA
))
1237 udc_ack_int_UDCCR(UDCCR_RSTIR
);
1239 if (dev
->has_cfr
/* UDC_RES2 is defined */) {
1240 /* pxa255 (a0+) can avoid a set_config race that could
1241 * prevent gadget drivers from configuring correctly
1243 UDCCFR
= UDCCFR_ACM
| UDCCFR_MB1
;
1245 /* "USB test mode" for pxa250 errata 40-42 (stepping a0, a1)
1246 * which could result in missing packets and interrupts.
1247 * supposedly one bit per endpoint, controlling whether it
1248 * double buffers or not; ACM/AREN bits fit into the holes.
1249 * zero bits (like USIR0_IRx) disable double buffering.
1255 /* enable suspend/resume and reset irqs */
1256 udc_clear_mask_UDCCR(UDCCR_SRM
| UDCCR_REM
);
1258 /* enable ep0 irqs */
1259 UICR0
&= ~UICR0_IM0
;
1261 /* if hardware supports it, pullup D+ and wait for reset */
1266 /* when a driver is successfully registered, it will receive
1267 * control requests including set_configuration(), which enables
1268 * non-control requests. then usb traffic follows until a
1269 * disconnect is reported. then a host may connect again, or
1270 * the driver might get unbound.
1272 static int pxa25x_start(struct usb_gadget_driver
*driver
,
1273 int (*bind
)(struct usb_gadget
*))
1275 struct pxa25x_udc
*dev
= the_controller
;
1279 || driver
->speed
< USB_SPEED_FULL
1281 || !driver
->disconnect
1289 /* first hook up the driver ... */
1290 dev
->driver
= driver
;
1291 dev
->gadget
.dev
.driver
= &driver
->driver
;
1294 retval
= device_add (&dev
->gadget
.dev
);
1298 dev
->gadget
.dev
.driver
= NULL
;
1301 retval
= bind(&dev
->gadget
);
1303 DMSG("bind to driver %s --> error %d\n",
1304 driver
->driver
.name
, retval
);
1305 device_del (&dev
->gadget
.dev
);
1309 /* ... then enable host detection and ep0; and we're ready
1310 * for set_configuration as well as eventual disconnect.
1312 DMSG("registered gadget driver '%s'\n", driver
->driver
.name
);
1314 /* connect to bus through transceiver */
1315 if (dev
->transceiver
) {
1316 retval
= otg_set_peripheral(dev
->transceiver
, &dev
->gadget
);
1318 DMSG("can't bind to transceiver\n");
1320 driver
->unbind(&dev
->gadget
);
1333 stop_activity(struct pxa25x_udc
*dev
, struct usb_gadget_driver
*driver
)
1337 /* don't disconnect drivers more than once */
1338 if (dev
->gadget
.speed
== USB_SPEED_UNKNOWN
)
1340 dev
->gadget
.speed
= USB_SPEED_UNKNOWN
;
1342 /* prevent new request submissions, kill any outstanding requests */
1343 for (i
= 0; i
< PXA_UDC_NUM_ENDPOINTS
; i
++) {
1344 struct pxa25x_ep
*ep
= &dev
->ep
[i
];
1347 nuke(ep
, -ESHUTDOWN
);
1349 del_timer_sync(&dev
->timer
);
1351 /* report disconnect; the driver is already quiesced */
1353 driver
->disconnect(&dev
->gadget
);
1355 /* re-init driver-visible data structures */
1359 static int pxa25x_stop(struct usb_gadget_driver
*driver
)
1361 struct pxa25x_udc
*dev
= the_controller
;
1365 if (!driver
|| driver
!= dev
->driver
|| !driver
->unbind
)
1368 local_irq_disable();
1371 stop_activity(dev
, driver
);
1374 if (dev
->transceiver
)
1375 (void) otg_set_peripheral(dev
->transceiver
, NULL
);
1377 driver
->unbind(&dev
->gadget
);
1378 dev
->gadget
.dev
.driver
= NULL
;
1381 device_del (&dev
->gadget
.dev
);
1383 DMSG("unregistered gadget driver '%s'\n", driver
->driver
.name
);
1388 /*-------------------------------------------------------------------------*/
1390 #ifdef CONFIG_ARCH_LUBBOCK
1392 /* Lubbock has separate connect and disconnect irqs. More typical designs
1393 * use one GPIO as the VBUS IRQ, and another to control the D+ pullup.
1397 lubbock_vbus_irq(int irq
, void *_dev
)
1399 struct pxa25x_udc
*dev
= _dev
;
1404 case LUBBOCK_USB_IRQ
:
1406 disable_irq(LUBBOCK_USB_IRQ
);
1407 enable_irq(LUBBOCK_USB_DISC_IRQ
);
1409 case LUBBOCK_USB_DISC_IRQ
:
1411 disable_irq(LUBBOCK_USB_DISC_IRQ
);
1412 enable_irq(LUBBOCK_USB_IRQ
);
1418 pxa25x_udc_vbus_session(&dev
->gadget
, vbus
);
1425 /*-------------------------------------------------------------------------*/
1427 static inline void clear_ep_state (struct pxa25x_udc
*dev
)
1431 /* hardware SET_{CONFIGURATION,INTERFACE} automagic resets endpoint
1432 * fifos, and pending transactions mustn't be continued in any case.
1434 for (i
= 1; i
< PXA_UDC_NUM_ENDPOINTS
; i
++)
1435 nuke(&dev
->ep
[i
], -ECONNABORTED
);
1438 static void udc_watchdog(unsigned long _dev
)
1440 struct pxa25x_udc
*dev
= (void *)_dev
;
1442 local_irq_disable();
1443 if (dev
->ep0state
== EP0_STALL
1444 && (UDCCS0
& UDCCS0_FST
) == 0
1445 && (UDCCS0
& UDCCS0_SST
) == 0) {
1446 UDCCS0
= UDCCS0_FST
|UDCCS0_FTF
;
1447 DBG(DBG_VERBOSE
, "ep0 re-stall\n");
1448 start_watchdog(dev
);
1453 static void handle_ep0 (struct pxa25x_udc
*dev
)
1455 u32 udccs0
= UDCCS0
;
1456 struct pxa25x_ep
*ep
= &dev
->ep
[0];
1457 struct pxa25x_request
*req
;
1459 struct usb_ctrlrequest r
;
1464 if (list_empty(&ep
->queue
))
1467 req
= list_entry(ep
->queue
.next
, struct pxa25x_request
, queue
);
1469 /* clear stall status */
1470 if (udccs0
& UDCCS0_SST
) {
1472 UDCCS0
= UDCCS0_SST
;
1473 del_timer(&dev
->timer
);
1477 /* previous request unfinished? non-error iff back-to-back ... */
1478 if ((udccs0
& UDCCS0_SA
) != 0 && dev
->ep0state
!= EP0_IDLE
) {
1480 del_timer(&dev
->timer
);
1484 switch (dev
->ep0state
) {
1486 /* late-breaking status? */
1489 /* start control request? */
1490 if (likely((udccs0
& (UDCCS0_OPR
|UDCCS0_SA
|UDCCS0_RNE
))
1491 == (UDCCS0_OPR
|UDCCS0_SA
|UDCCS0_RNE
))) {
1496 /* read SETUP packet */
1497 for (i
= 0; i
< 8; i
++) {
1498 if (unlikely(!(UDCCS0
& UDCCS0_RNE
))) {
1500 DMSG("SETUP %d!\n", i
);
1503 u
.raw
[i
] = (u8
) UDDR0
;
1505 if (unlikely((UDCCS0
& UDCCS0_RNE
) != 0))
1509 DBG(DBG_VERBOSE
, "SETUP %02x.%02x v%04x i%04x l%04x\n",
1510 u
.r
.bRequestType
, u
.r
.bRequest
,
1511 le16_to_cpu(u
.r
.wValue
),
1512 le16_to_cpu(u
.r
.wIndex
),
1513 le16_to_cpu(u
.r
.wLength
));
1515 /* cope with automagic for some standard requests. */
1516 dev
->req_std
= (u
.r
.bRequestType
& USB_TYPE_MASK
)
1517 == USB_TYPE_STANDARD
;
1518 dev
->req_config
= 0;
1519 dev
->req_pending
= 1;
1520 switch (u
.r
.bRequest
) {
1521 /* hardware restricts gadget drivers here! */
1522 case USB_REQ_SET_CONFIGURATION
:
1523 if (u
.r
.bRequestType
== USB_RECIP_DEVICE
) {
1524 /* reflect hardware's automagic
1525 * up to the gadget driver.
1528 dev
->req_config
= 1;
1529 clear_ep_state(dev
);
1530 /* if !has_cfr, there's no synch
1531 * else use AREN (later) not SA|OPR
1532 * USIR0_IR0 acts edge sensitive
1536 /* ... and here, even more ... */
1537 case USB_REQ_SET_INTERFACE
:
1538 if (u
.r
.bRequestType
== USB_RECIP_INTERFACE
) {
1539 /* udc hardware is broken by design:
1540 * - altsetting may only be zero;
1541 * - hw resets all interfaces' eps;
1542 * - ep reset doesn't include halt(?).
1544 DMSG("broken set_interface (%d/%d)\n",
1545 le16_to_cpu(u
.r
.wIndex
),
1546 le16_to_cpu(u
.r
.wValue
));
1550 /* hardware was supposed to hide this */
1551 case USB_REQ_SET_ADDRESS
:
1552 if (u
.r
.bRequestType
== USB_RECIP_DEVICE
) {
1553 ep0start(dev
, 0, "address");
1559 if (u
.r
.bRequestType
& USB_DIR_IN
)
1560 dev
->ep0state
= EP0_IN_DATA_PHASE
;
1562 dev
->ep0state
= EP0_OUT_DATA_PHASE
;
1564 i
= dev
->driver
->setup(&dev
->gadget
, &u
.r
);
1566 /* hardware automagic preventing STALL... */
1567 if (dev
->req_config
) {
1568 /* hardware sometimes neglects to tell
1569 * tell us about config change events,
1570 * so later ones may fail...
1572 WARNING("config change %02x fail %d?\n",
1575 /* TODO experiment: if has_cfr,
1576 * hardware didn't ACK; maybe we
1577 * could actually STALL!
1580 DBG(DBG_VERBOSE
, "protocol STALL, "
1581 "%02x err %d\n", UDCCS0
, i
);
1583 /* the watchdog timer helps deal with cases
1584 * where udc seems to clear FST wrongly, and
1585 * then NAKs instead of STALLing.
1587 ep0start(dev
, UDCCS0_FST
|UDCCS0_FTF
, "stall");
1588 start_watchdog(dev
);
1589 dev
->ep0state
= EP0_STALL
;
1591 /* deferred i/o == no response yet */
1592 } else if (dev
->req_pending
) {
1593 if (likely(dev
->ep0state
== EP0_IN_DATA_PHASE
1594 || dev
->req_std
|| u
.r
.wLength
))
1595 ep0start(dev
, 0, "defer");
1597 ep0start(dev
, UDCCS0_IPR
, "defer/IPR");
1600 /* expect at least one data or status stage irq */
1603 } else if (likely((udccs0
& (UDCCS0_OPR
|UDCCS0_SA
))
1604 == (UDCCS0_OPR
|UDCCS0_SA
))) {
1607 /* pxa210/250 erratum 131 for B0/B1 says RNE lies.
1608 * still observed on a pxa255 a0.
1610 DBG(DBG_VERBOSE
, "e131\n");
1613 /* read SETUP data, but don't trust it too much */
1614 for (i
= 0; i
< 8; i
++)
1615 u
.raw
[i
] = (u8
) UDDR0
;
1616 if ((u
.r
.bRequestType
& USB_RECIP_MASK
)
1619 if (u
.word
[0] == 0 && u
.word
[1] == 0)
1623 /* some random early IRQ:
1626 * - OPR got set, without SA (likely status stage)
1628 UDCCS0
= udccs0
& (UDCCS0_SA
|UDCCS0_OPR
);
1631 case EP0_IN_DATA_PHASE
: /* GET_DESCRIPTOR etc */
1632 if (udccs0
& UDCCS0_OPR
) {
1633 UDCCS0
= UDCCS0_OPR
|UDCCS0_FTF
;
1634 DBG(DBG_VERBOSE
, "ep0in premature status\n");
1638 } else /* irq was IPR clearing */ {
1640 /* this IN packet might finish the request */
1641 (void) write_ep0_fifo(ep
, req
);
1642 } /* else IN token before response was written */
1645 case EP0_OUT_DATA_PHASE
: /* SET_DESCRIPTOR etc */
1646 if (udccs0
& UDCCS0_OPR
) {
1648 /* this OUT packet might finish the request */
1649 if (read_ep0_fifo(ep
, req
))
1651 /* else more OUT packets expected */
1652 } /* else OUT token before read was issued */
1653 } else /* irq was IPR clearing */ {
1654 DBG(DBG_VERBOSE
, "ep0out premature status\n");
1663 /* ack control-IN status (maybe in-zlp was skipped)
1664 * also appears after some config change events.
1666 if (udccs0
& UDCCS0_OPR
)
1667 UDCCS0
= UDCCS0_OPR
;
1671 UDCCS0
= UDCCS0_FST
;
1677 static void handle_ep(struct pxa25x_ep
*ep
)
1679 struct pxa25x_request
*req
;
1680 int is_in
= ep
->bEndpointAddress
& USB_DIR_IN
;
1686 if (likely (!list_empty(&ep
->queue
)))
1687 req
= list_entry(ep
->queue
.next
,
1688 struct pxa25x_request
, queue
);
1692 // TODO check FST handling
1694 udccs
= *ep
->reg_udccs
;
1695 if (unlikely(is_in
)) { /* irq from TPC, SST, or (ISO) TUR */
1697 if (likely(ep
->bmAttributes
== USB_ENDPOINT_XFER_BULK
))
1698 tmp
|= UDCCS_BI_SST
;
1701 *ep
->reg_udccs
= tmp
;
1702 if (req
&& likely ((udccs
& UDCCS_BI_TFS
) != 0))
1703 completed
= write_fifo(ep
, req
);
1705 } else { /* irq from RPC (or for ISO, ROF) */
1706 if (likely(ep
->bmAttributes
== USB_ENDPOINT_XFER_BULK
))
1707 tmp
= UDCCS_BO_SST
| UDCCS_BO_DME
;
1709 tmp
= UDCCS_IO_ROF
| UDCCS_IO_DME
;
1712 *ep
->reg_udccs
= tmp
;
1714 /* fifos can hold packets, ready for reading... */
1716 completed
= read_fifo(ep
, req
);
1718 pio_irq_disable (ep
->bEndpointAddress
);
1721 } while (completed
);
1725 * pxa25x_udc_irq - interrupt handler
1727 * avoid delays in ep0 processing. the control handshaking isn't always
1728 * under software control (pxa250c0 and the pxa255 are better), and delays
1729 * could cause usb protocol errors.
1732 pxa25x_udc_irq(int irq
, void *_dev
)
1734 struct pxa25x_udc
*dev
= _dev
;
1743 /* SUSpend Interrupt Request */
1744 if (unlikely(udccr
& UDCCR_SUSIR
)) {
1745 udc_ack_int_UDCCR(UDCCR_SUSIR
);
1747 DBG(DBG_VERBOSE
, "USB suspend\n");
1749 if (dev
->gadget
.speed
!= USB_SPEED_UNKNOWN
1751 && dev
->driver
->suspend
)
1752 dev
->driver
->suspend(&dev
->gadget
);
1756 /* RESume Interrupt Request */
1757 if (unlikely(udccr
& UDCCR_RESIR
)) {
1758 udc_ack_int_UDCCR(UDCCR_RESIR
);
1760 DBG(DBG_VERBOSE
, "USB resume\n");
1762 if (dev
->gadget
.speed
!= USB_SPEED_UNKNOWN
1764 && dev
->driver
->resume
)
1765 dev
->driver
->resume(&dev
->gadget
);
1768 /* ReSeT Interrupt Request - USB reset */
1769 if (unlikely(udccr
& UDCCR_RSTIR
)) {
1770 udc_ack_int_UDCCR(UDCCR_RSTIR
);
1773 if ((UDCCR
& UDCCR_UDA
) == 0) {
1774 DBG(DBG_VERBOSE
, "USB reset start\n");
1776 /* reset driver and endpoints,
1777 * in case that's not yet done
1779 stop_activity (dev
, dev
->driver
);
1782 DBG(DBG_VERBOSE
, "USB reset end\n");
1783 dev
->gadget
.speed
= USB_SPEED_FULL
;
1784 memset(&dev
->stats
, 0, sizeof dev
->stats
);
1785 /* driver and endpoints are still reset */
1789 u32 usir0
= USIR0
& ~UICR0
;
1790 u32 usir1
= USIR1
& ~UICR1
;
1793 if (unlikely (!usir0
&& !usir1
))
1796 DBG(DBG_VERY_NOISY
, "irq %02x.%02x\n", usir1
, usir0
);
1798 /* control traffic */
1799 if (usir0
& USIR0_IR0
) {
1800 dev
->ep
[0].pio_irqs
++;
1805 /* endpoint data transfers */
1806 for (i
= 0; i
< 8; i
++) {
1809 if (i
&& (usir0
& tmp
)) {
1810 handle_ep(&dev
->ep
[i
]);
1814 #ifndef CONFIG_USB_PXA25X_SMALL
1816 handle_ep(&dev
->ep
[i
+8]);
1824 /* we could also ask for 1 msec SOF (SIR) interrupts */
1830 /*-------------------------------------------------------------------------*/
1832 static void nop_release (struct device
*dev
)
1834 DMSG("%s %s\n", __func__
, dev_name(dev
));
1837 /* this uses load-time allocation and initialization (instead of
1838 * doing it at run-time) to save code, eliminate fault paths, and
1839 * be more obviously correct.
1841 static struct pxa25x_udc memory
= {
1843 .ops
= &pxa25x_udc_ops
,
1844 .ep0
= &memory
.ep
[0].ep
,
1845 .name
= driver_name
,
1847 .init_name
= "gadget",
1848 .release
= nop_release
,
1852 /* control endpoint */
1856 .ops
= &pxa25x_ep_ops
,
1857 .maxpacket
= EP0_FIFO_SIZE
,
1860 .reg_udccs
= &UDCCS0
,
1864 /* first group of endpoints */
1867 .name
= "ep1in-bulk",
1868 .ops
= &pxa25x_ep_ops
,
1869 .maxpacket
= BULK_FIFO_SIZE
,
1872 .fifo_size
= BULK_FIFO_SIZE
,
1873 .bEndpointAddress
= USB_DIR_IN
| 1,
1874 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
1875 .reg_udccs
= &UDCCS1
,
1880 .name
= "ep2out-bulk",
1881 .ops
= &pxa25x_ep_ops
,
1882 .maxpacket
= BULK_FIFO_SIZE
,
1885 .fifo_size
= BULK_FIFO_SIZE
,
1886 .bEndpointAddress
= 2,
1887 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
1888 .reg_udccs
= &UDCCS2
,
1892 #ifndef CONFIG_USB_PXA25X_SMALL
1895 .name
= "ep3in-iso",
1896 .ops
= &pxa25x_ep_ops
,
1897 .maxpacket
= ISO_FIFO_SIZE
,
1900 .fifo_size
= ISO_FIFO_SIZE
,
1901 .bEndpointAddress
= USB_DIR_IN
| 3,
1902 .bmAttributes
= USB_ENDPOINT_XFER_ISOC
,
1903 .reg_udccs
= &UDCCS3
,
1908 .name
= "ep4out-iso",
1909 .ops
= &pxa25x_ep_ops
,
1910 .maxpacket
= ISO_FIFO_SIZE
,
1913 .fifo_size
= ISO_FIFO_SIZE
,
1914 .bEndpointAddress
= 4,
1915 .bmAttributes
= USB_ENDPOINT_XFER_ISOC
,
1916 .reg_udccs
= &UDCCS4
,
1922 .name
= "ep5in-int",
1923 .ops
= &pxa25x_ep_ops
,
1924 .maxpacket
= INT_FIFO_SIZE
,
1927 .fifo_size
= INT_FIFO_SIZE
,
1928 .bEndpointAddress
= USB_DIR_IN
| 5,
1929 .bmAttributes
= USB_ENDPOINT_XFER_INT
,
1930 .reg_udccs
= &UDCCS5
,
1934 /* second group of endpoints */
1937 .name
= "ep6in-bulk",
1938 .ops
= &pxa25x_ep_ops
,
1939 .maxpacket
= BULK_FIFO_SIZE
,
1942 .fifo_size
= BULK_FIFO_SIZE
,
1943 .bEndpointAddress
= USB_DIR_IN
| 6,
1944 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
1945 .reg_udccs
= &UDCCS6
,
1950 .name
= "ep7out-bulk",
1951 .ops
= &pxa25x_ep_ops
,
1952 .maxpacket
= BULK_FIFO_SIZE
,
1955 .fifo_size
= BULK_FIFO_SIZE
,
1956 .bEndpointAddress
= 7,
1957 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
1958 .reg_udccs
= &UDCCS7
,
1964 .name
= "ep8in-iso",
1965 .ops
= &pxa25x_ep_ops
,
1966 .maxpacket
= ISO_FIFO_SIZE
,
1969 .fifo_size
= ISO_FIFO_SIZE
,
1970 .bEndpointAddress
= USB_DIR_IN
| 8,
1971 .bmAttributes
= USB_ENDPOINT_XFER_ISOC
,
1972 .reg_udccs
= &UDCCS8
,
1977 .name
= "ep9out-iso",
1978 .ops
= &pxa25x_ep_ops
,
1979 .maxpacket
= ISO_FIFO_SIZE
,
1982 .fifo_size
= ISO_FIFO_SIZE
,
1983 .bEndpointAddress
= 9,
1984 .bmAttributes
= USB_ENDPOINT_XFER_ISOC
,
1985 .reg_udccs
= &UDCCS9
,
1991 .name
= "ep10in-int",
1992 .ops
= &pxa25x_ep_ops
,
1993 .maxpacket
= INT_FIFO_SIZE
,
1996 .fifo_size
= INT_FIFO_SIZE
,
1997 .bEndpointAddress
= USB_DIR_IN
| 10,
1998 .bmAttributes
= USB_ENDPOINT_XFER_INT
,
1999 .reg_udccs
= &UDCCS10
,
2000 .reg_uddr
= &UDDR10
,
2003 /* third group of endpoints */
2006 .name
= "ep11in-bulk",
2007 .ops
= &pxa25x_ep_ops
,
2008 .maxpacket
= BULK_FIFO_SIZE
,
2011 .fifo_size
= BULK_FIFO_SIZE
,
2012 .bEndpointAddress
= USB_DIR_IN
| 11,
2013 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
2014 .reg_udccs
= &UDCCS11
,
2015 .reg_uddr
= &UDDR11
,
2019 .name
= "ep12out-bulk",
2020 .ops
= &pxa25x_ep_ops
,
2021 .maxpacket
= BULK_FIFO_SIZE
,
2024 .fifo_size
= BULK_FIFO_SIZE
,
2025 .bEndpointAddress
= 12,
2026 .bmAttributes
= USB_ENDPOINT_XFER_BULK
,
2027 .reg_udccs
= &UDCCS12
,
2028 .reg_ubcr
= &UBCR12
,
2029 .reg_uddr
= &UDDR12
,
2033 .name
= "ep13in-iso",
2034 .ops
= &pxa25x_ep_ops
,
2035 .maxpacket
= ISO_FIFO_SIZE
,
2038 .fifo_size
= ISO_FIFO_SIZE
,
2039 .bEndpointAddress
= USB_DIR_IN
| 13,
2040 .bmAttributes
= USB_ENDPOINT_XFER_ISOC
,
2041 .reg_udccs
= &UDCCS13
,
2042 .reg_uddr
= &UDDR13
,
2046 .name
= "ep14out-iso",
2047 .ops
= &pxa25x_ep_ops
,
2048 .maxpacket
= ISO_FIFO_SIZE
,
2051 .fifo_size
= ISO_FIFO_SIZE
,
2052 .bEndpointAddress
= 14,
2053 .bmAttributes
= USB_ENDPOINT_XFER_ISOC
,
2054 .reg_udccs
= &UDCCS14
,
2055 .reg_ubcr
= &UBCR14
,
2056 .reg_uddr
= &UDDR14
,
2060 .name
= "ep15in-int",
2061 .ops
= &pxa25x_ep_ops
,
2062 .maxpacket
= INT_FIFO_SIZE
,
2065 .fifo_size
= INT_FIFO_SIZE
,
2066 .bEndpointAddress
= USB_DIR_IN
| 15,
2067 .bmAttributes
= USB_ENDPOINT_XFER_INT
,
2068 .reg_udccs
= &UDCCS15
,
2069 .reg_uddr
= &UDDR15
,
2071 #endif /* !CONFIG_USB_PXA25X_SMALL */
2074 #define CP15R0_VENDOR_MASK 0xffffe000
2076 #if defined(CONFIG_ARCH_PXA)
2077 #define CP15R0_XSCALE_VALUE 0x69052000 /* intel/arm/xscale */
2079 #elif defined(CONFIG_ARCH_IXP4XX)
2080 #define CP15R0_XSCALE_VALUE 0x69054000 /* intel/arm/ixp4xx */
2084 #define CP15R0_PROD_MASK 0x000003f0
2085 #define PXA25x 0x00000100 /* and PXA26x */
2086 #define PXA210 0x00000120
2088 #define CP15R0_REV_MASK 0x0000000f
2090 #define CP15R0_PRODREV_MASK (CP15R0_PROD_MASK | CP15R0_REV_MASK)
2092 #define PXA255_A0 0x00000106 /* or PXA260_B1 */
2093 #define PXA250_C0 0x00000105 /* or PXA26x_B0 */
2094 #define PXA250_B2 0x00000104
2095 #define PXA250_B1 0x00000103 /* or PXA260_A0 */
2096 #define PXA250_B0 0x00000102
2097 #define PXA250_A1 0x00000101
2098 #define PXA250_A0 0x00000100
2100 #define PXA210_C0 0x00000125
2101 #define PXA210_B2 0x00000124
2102 #define PXA210_B1 0x00000123
2103 #define PXA210_B0 0x00000122
2104 #define IXP425_A0 0x000001c1
2105 #define IXP425_B0 0x000001f1
2106 #define IXP465_AD 0x00000200
2109 * probe - binds to the platform device
2111 static int __init
pxa25x_udc_probe(struct platform_device
*pdev
)
2113 struct pxa25x_udc
*dev
= &memory
;
2117 /* insist on Intel/ARM/XScale */
2118 asm("mrc%? p15, 0, %0, c0, c0" : "=r" (chiprev
));
2119 if ((chiprev
& CP15R0_VENDOR_MASK
) != CP15R0_XSCALE_VALUE
) {
2120 pr_err("%s: not XScale!\n", driver_name
);
2124 /* trigger chiprev-specific logic */
2125 switch (chiprev
& CP15R0_PRODREV_MASK
) {
2126 #if defined(CONFIG_ARCH_PXA)
2132 /* A0/A1 "not released"; ep 13, 15 unusable */
2134 case PXA250_B2
: case PXA210_B2
:
2135 case PXA250_B1
: case PXA210_B1
:
2136 case PXA250_B0
: case PXA210_B0
:
2137 /* OUT-DMA is broken ... */
2139 case PXA250_C0
: case PXA210_C0
:
2141 #elif defined(CONFIG_ARCH_IXP4XX)
2149 pr_err("%s: unrecognized processor: %08x\n",
2150 driver_name
, chiprev
);
2151 /* iop3xx, ixp4xx, ... */
2155 irq
= platform_get_irq(pdev
, 0);
2159 dev
->clk
= clk_get(&pdev
->dev
, NULL
);
2160 if (IS_ERR(dev
->clk
)) {
2161 retval
= PTR_ERR(dev
->clk
);
2165 pr_debug("%s: IRQ %d%s%s\n", driver_name
, irq
,
2166 dev
->has_cfr
? "" : " (!cfr)",
2170 /* other non-static parts of init */
2171 dev
->dev
= &pdev
->dev
;
2172 dev
->mach
= pdev
->dev
.platform_data
;
2174 dev
->transceiver
= otg_get_transceiver();
2176 if (gpio_is_valid(dev
->mach
->gpio_pullup
)) {
2177 if ((retval
= gpio_request(dev
->mach
->gpio_pullup
,
2178 "pca25x_udc GPIO PULLUP"))) {
2180 "can't get pullup gpio %d, err: %d\n",
2181 dev
->mach
->gpio_pullup
, retval
);
2182 goto err_gpio_pullup
;
2184 gpio_direction_output(dev
->mach
->gpio_pullup
, 0);
2187 init_timer(&dev
->timer
);
2188 dev
->timer
.function
= udc_watchdog
;
2189 dev
->timer
.data
= (unsigned long) dev
;
2191 device_initialize(&dev
->gadget
.dev
);
2192 dev
->gadget
.dev
.parent
= &pdev
->dev
;
2193 dev
->gadget
.dev
.dma_mask
= pdev
->dev
.dma_mask
;
2195 the_controller
= dev
;
2196 platform_set_drvdata(pdev
, dev
);
2203 /* irq setup after old hardware state is cleaned up */
2204 retval
= request_irq(irq
, pxa25x_udc_irq
,
2205 IRQF_DISABLED
, driver_name
, dev
);
2207 pr_err("%s: can't get irq %d, err %d\n",
2208 driver_name
, irq
, retval
);
2213 #ifdef CONFIG_ARCH_LUBBOCK
2214 if (machine_is_lubbock()) {
2215 retval
= request_irq(LUBBOCK_USB_DISC_IRQ
,
2217 IRQF_DISABLED
| IRQF_SAMPLE_RANDOM
,
2220 pr_err("%s: can't get irq %i, err %d\n",
2221 driver_name
, LUBBOCK_USB_DISC_IRQ
, retval
);
2224 retval
= request_irq(LUBBOCK_USB_IRQ
,
2226 IRQF_DISABLED
| IRQF_SAMPLE_RANDOM
,
2229 pr_err("%s: can't get irq %i, err %d\n",
2230 driver_name
, LUBBOCK_USB_IRQ
, retval
);
2235 create_debug_files(dev
);
2237 retval
= usb_add_gadget_udc(&pdev
->dev
, &dev
->gadget
);
2241 remove_debug_files(dev
);
2242 #ifdef CONFIG_ARCH_LUBBOCK
2244 free_irq(LUBBOCK_USB_DISC_IRQ
, dev
);
2249 if (gpio_is_valid(dev
->mach
->gpio_pullup
))
2250 gpio_free(dev
->mach
->gpio_pullup
);
2252 if (dev
->transceiver
) {
2253 otg_put_transceiver(dev
->transceiver
);
2254 dev
->transceiver
= NULL
;
2261 static void pxa25x_udc_shutdown(struct platform_device
*_dev
)
2266 static int __exit
pxa25x_udc_remove(struct platform_device
*pdev
)
2268 struct pxa25x_udc
*dev
= platform_get_drvdata(pdev
);
2270 usb_del_gadget_udc(&dev
->gadget
);
2277 remove_debug_files(dev
);
2280 free_irq(platform_get_irq(pdev
, 0), dev
);
2283 #ifdef CONFIG_ARCH_LUBBOCK
2284 if (machine_is_lubbock()) {
2285 free_irq(LUBBOCK_USB_DISC_IRQ
, dev
);
2286 free_irq(LUBBOCK_USB_IRQ
, dev
);
2289 if (gpio_is_valid(dev
->mach
->gpio_pullup
))
2290 gpio_free(dev
->mach
->gpio_pullup
);
2294 if (dev
->transceiver
) {
2295 otg_put_transceiver(dev
->transceiver
);
2296 dev
->transceiver
= NULL
;
2299 platform_set_drvdata(pdev
, NULL
);
2300 the_controller
= NULL
;
2304 /*-------------------------------------------------------------------------*/
2308 /* USB suspend (controlled by the host) and system suspend (controlled
2309 * by the PXA) don't necessarily work well together. If USB is active,
2310 * the 48 MHz clock is required; so the system can't enter 33 MHz idle
2311 * mode, or any deeper PM saving state.
2313 * For now, we punt and forcibly disconnect from the USB host when PXA
2314 * enters any suspend state. While we're disconnected, we always disable
2315 * the 48MHz USB clock ... allowing PXA sleep and/or 33 MHz idle states.
2316 * Boards without software pullup control shouldn't use those states.
2317 * VBUS IRQs should probably be ignored so that the PXA device just acts
2318 * "dead" to USB hosts until system resume.
2320 static int pxa25x_udc_suspend(struct platform_device
*dev
, pm_message_t state
)
2322 struct pxa25x_udc
*udc
= platform_get_drvdata(dev
);
2323 unsigned long flags
;
2325 if (!gpio_is_valid(udc
->mach
->gpio_pullup
) && !udc
->mach
->udc_command
)
2326 WARNING("USB host won't detect disconnect!\n");
2329 local_irq_save(flags
);
2331 local_irq_restore(flags
);
2336 static int pxa25x_udc_resume(struct platform_device
*dev
)
2338 struct pxa25x_udc
*udc
= platform_get_drvdata(dev
);
2339 unsigned long flags
;
2342 local_irq_save(flags
);
2344 local_irq_restore(flags
);
2350 #define pxa25x_udc_suspend NULL
2351 #define pxa25x_udc_resume NULL
2354 /*-------------------------------------------------------------------------*/
2356 static struct platform_driver udc_driver
= {
2357 .shutdown
= pxa25x_udc_shutdown
,
2358 .remove
= __exit_p(pxa25x_udc_remove
),
2359 .suspend
= pxa25x_udc_suspend
,
2360 .resume
= pxa25x_udc_resume
,
2362 .owner
= THIS_MODULE
,
2363 .name
= "pxa25x-udc",
2367 static int __init
udc_init(void)
2369 pr_info("%s: version %s\n", driver_name
, DRIVER_VERSION
);
2370 return platform_driver_probe(&udc_driver
, pxa25x_udc_probe
);
2372 module_init(udc_init
);
2374 static void __exit
udc_exit(void)
2376 platform_driver_unregister(&udc_driver
);
2378 module_exit(udc_exit
);
2380 MODULE_DESCRIPTION(DRIVER_DESC
);
2381 MODULE_AUTHOR("Frank Becker, Robert Schwebel, David Brownell");
2382 MODULE_LICENSE("GPL");
2383 MODULE_ALIAS("platform:pxa25x-udc");