2 * PXA27x USB device driver for u-boot.
4 * Copyright (C) 2007 Rodolfo Giometti <giometti@linux.it>
5 * Copyright (C) 2007 Eurotech S.p.A. <info@eurotech.it>
6 * Copyright (C) 2008 Vivek Kutal <vivek.kutal@azingo.com>
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License as
10 * published by the Free Software Foundation; either version 2 of
11 * the License, or (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
28 #include <asm/byteorder.h>
29 #include <usbdevice.h>
30 #include <asm/arch/hardware.h>
32 #include <usb/pxa27x_udc.h>
36 /* number of endpoints on this UDC */
37 #define UDC_MAX_ENDPOINTS 24
39 static struct urb
*ep0_urb
;
40 static struct usb_device_instance
*udc_device
;
41 static int ep0state
= EP0_IDLE
;
44 static void udc_dump_buffer(char *name
, u8
*buf
, int len
)
46 usbdbg("%s - buf %p, len %d", name
, buf
, len
);
47 print_buffer(0, buf
, 1, len
, 0);
50 #define udc_dump_buffer(name, buf, len) /* void */
53 static inline void udc_ack_int_UDCCR(int mask
)
55 writel(readl(USIR1
) | mask
, USIR1
);
59 * If the endpoint has an active tx_urb, then the next packet of data from the
60 * URB is written to the tx FIFO.
61 * The total amount of data in the urb is given by urb->actual_length.
62 * The maximum amount of data that can be sent in any one packet is given by
63 * endpoint->tx_packetSize.
64 * The number of data bytes from this URB that have already been transmitted
65 * is given by endpoint->sent.
66 * endpoint->last is updated by this routine with the number of data bytes
67 * transmitted in this packet.
69 static int udc_write_urb(struct usb_endpoint_instance
*endpoint
)
71 struct urb
*urb
= endpoint
->tx_urb
;
72 int ep_num
= endpoint
->endpoint_address
& USB_ENDPOINT_NUMBER_MASK
;
73 u32
*data32
= (u32
*) urb
->buffer
;
74 u8
*data8
= (u8
*) urb
->buffer
;
75 unsigned int i
, n
, w
, b
, is_short
;
76 int timeout
= 2000; /* 2ms */
78 if (!urb
|| !urb
->actual_length
)
81 n
= MIN(urb
->actual_length
- endpoint
->sent
, endpoint
->tx_packetSize
);
85 usbdbg("write urb on ep %d", ep_num
);
86 #if defined(USBDDBG) && defined(USBDPARANOIA)
87 usbdbg("urb: buf %p, buf_len %d, actual_len %d",
88 urb
->buffer
, urb
->buffer_length
, urb
->actual_length
);
89 usbdbg("endpoint: sent %d, tx_packetSize %d, last %d",
90 endpoint
->sent
, endpoint
->tx_packetSize
, endpoint
->last
);
93 is_short
= n
!= endpoint
->tx_packetSize
;
96 usbdbg("n %d%s w %d b %d", n
, is_short
? "-s" : "", w
, b
);
97 udc_dump_buffer("urb write", data8
+ endpoint
->sent
, n
);
99 /* Prepare for data send */
101 writel(UDCCSR_PC
,UDCCSN(ep_num
));
103 for (i
= 0; i
< w
; i
++)
104 writel(data32
[endpoint
->sent
/ 4 + i
], UDCDN(ep_num
));
106 for (i
= 0; i
< b
; i
++)
107 writeb(data8
[endpoint
->sent
+ w
* 4 + i
], UDCDN(ep_num
));
109 /* Set "Packet Complete" if less data then tx_packetSize */
111 writel(ep_num
? UDCCSR_SP
: UDCCSR0_IPR
, UDCCSN(ep_num
));
113 /* Wait for data sent */
115 while (!(readl(UDCCSN(ep_num
)) & UDCCSR_PC
)) {
126 usbd_tx_complete(endpoint
);
132 if (endpoint
->sent
>= urb
->actual_length
) {
133 urb
->actual_length
= 0;
138 if ((endpoint
->sent
>= urb
->actual_length
) && (!ep_num
)) {
139 usbdbg("ep0 IN stage done");
143 ep0state
= EP0_XFER_COMPLETE
;
149 static int udc_read_urb(struct usb_endpoint_instance
*endpoint
)
151 struct urb
*urb
= endpoint
->rcv_urb
;
152 int ep_num
= endpoint
->endpoint_address
& USB_ENDPOINT_NUMBER_MASK
;
153 u32
*data32
= (u32
*) urb
->buffer
;
156 usbdbg("read urb on ep %d", ep_num
);
157 #if defined(USBDDBG) && defined(USBDPARANOIA)
158 usbdbg("urb: buf %p, buf_len %d, actual_len %d",
159 urb
->buffer
, urb
->buffer_length
, urb
->actual_length
);
160 usbdbg("endpoint: rcv_packetSize %d",
161 endpoint
->rcv_packetSize
);
164 if (readl(UDCCSN(ep_num
)) & UDCCSR_BNE
)
165 n
= readl(UDCBCN(ep_num
)) & 0x3ff;
169 usbdbg("n %d%s", n
, n
!= endpoint
->rcv_packetSize
? "-s" : "");
170 for (i
= 0; i
< n
; i
+= 4)
171 data32
[urb
->actual_length
/ 4 + i
/ 4] = readl(UDCDN(ep_num
));
173 udc_dump_buffer("urb read", (u8
*) data32
, urb
->actual_length
+ n
);
174 usbd_rcv_complete(endpoint
, n
, 0);
179 static int udc_read_urb_ep0(void)
181 u32
*data32
= (u32
*) ep0_urb
->buffer
;
182 u8
*data8
= (u8
*) ep0_urb
->buffer
;
183 unsigned int i
, n
, w
, b
;
185 usbdbg("read urb on ep 0");
186 #if defined(USBDDBG) && defined(USBDPARANOIA)
187 usbdbg("urb: buf %p, buf_len %d, actual_len %d",
188 ep0_urb
->buffer
, ep0_urb
->buffer_length
, ep0_urb
->actual_length
);
195 for (i
= 0; i
< w
; i
++) {
196 data32
[ep0_urb
->actual_length
/ 4 + i
] = readl(UDCDN(0));
197 /* ep0_urb->actual_length += 4; */
200 for (i
= 0; i
< b
; i
++) {
201 data8
[ep0_urb
->actual_length
+ w
* 4 + i
] = readb(UDCDN(0));
202 /* ep0_urb->actual_length++; */
205 ep0_urb
->actual_length
+= n
;
207 udc_dump_buffer("urb read", (u8
*) data32
, ep0_urb
->actual_length
);
209 writel(UDCCSR0_OPC
| UDCCSR0_IPR
, UDCCSR0
);
210 if (ep0_urb
->actual_length
== ep0_urb
->device_request
.wLength
)
216 static void udc_handle_ep0(struct usb_endpoint_instance
*endpoint
)
218 u32 udccsr0
= readl(UDCCSR0
);
219 u32
*data
= (u32
*) &ep0_urb
->device_request
;
222 usbdbg("udccsr0 %x", udccsr0
);
224 /* Clear stall status */
225 if (udccsr0
& UDCCSR0_SST
) {
226 usberr("clear stall status");
227 writel(UDCCSR0_SST
, UDCCSR0
);
231 /* previous request unfinished? non-error iff back-to-back ... */
232 if ((udccsr0
& UDCCSR0_SA
) != 0 && ep0state
!= EP0_IDLE
)
238 udccsr0
= readl(UDCCSR0
);
239 /* Start control request? */
240 if ((udccsr0
& (UDCCSR0_OPC
| UDCCSR0_SA
| UDCCSR0_RNE
))
241 == (UDCCSR0_OPC
| UDCCSR0_SA
| UDCCSR0_RNE
)) {
243 /* Read SETUP packet.
244 * SETUP packet size is 8 bytes (aka 2 words)
246 usbdbg("try reading SETUP packet");
247 for (i
= 0; i
< 2; i
++) {
248 if ((readl(UDCCSR0
) & UDCCSR0_RNE
) == 0) {
249 usberr("setup packet too short:%d", i
);
252 data
[i
] = readl(UDCDR0
);
255 writel(readl(UDCCSR0
) | UDCCSR0_OPC
| UDCCSR0_SA
, UDCCSR0
);
256 if ((readl(UDCCSR0
) & UDCCSR0_RNE
) != 0) {
257 usberr("setup packet too long");
261 udc_dump_buffer("ep0 setup read", (u8
*) data
, 8);
263 if (ep0_urb
->device_request
.wLength
== 0) {
264 usbdbg("Zero Data control Packet\n");
265 if (ep0_recv_setup(ep0_urb
)) {
266 usberr("Invalid Setup Packet\n");
267 udc_dump_buffer("ep0 setup read",
271 writel(UDCCSR0_IPR
, UDCCSR0
);
274 /* Check direction */
275 if ((ep0_urb
->device_request
.bmRequestType
&
276 USB_REQ_DIRECTION_MASK
)
277 == USB_REQ_HOST2DEVICE
) {
278 ep0state
= EP0_OUT_DATA
;
280 (u8
*)ep0_urb
->buffer_data
;
281 ep0_urb
->buffer_length
=
282 sizeof(ep0_urb
->buffer_data
);
283 ep0_urb
->actual_length
= 0;
284 writel(UDCCSR0_IPR
, UDCCSR0
);
286 /* The ep0_recv_setup function has
287 * already placed our response packet
288 * data in ep0_urb->buffer and the
290 * ep0_urb->actual_length.
292 if (ep0_recv_setup(ep0_urb
)) {
294 usberr("Invalid setup packet");
295 udc_dump_buffer("ep0 setup read"
300 UDCCSR0_OPC
| UDCCSR0_FST
|
301 UDCCS0_FTF
, UDCCSR0
);
306 endpoint
->tx_urb
= ep0_urb
;
308 usbdbg("EP0_IN_DATA");
309 ep0state
= EP0_IN_DATA
;
310 if (udc_write_urb(endpoint
) < 0)
316 } else if ((udccsr0
& (UDCCSR0_OPC
| UDCCSR0_SA
))
317 == (UDCCSR0_OPC
|UDCCSR0_SA
)) {
318 usberr("Setup Active but no data. Stalling ....\n");
321 usbdbg("random early IRQs");
322 /* Some random early IRQs:
325 * - OPC got set, without SA (likely status stage)
327 writel(udccsr0
& (UDCCSR0_SA
| UDCCSR0_OPC
), UDCCSR0
);
333 if ((udccsr0
& UDCCSR0_OPC
) && !(udccsr0
& UDCCSR0_SA
)) {
334 if (udc_read_urb_ep0()) {
337 if (ep0_recv_setup(ep0_urb
)) {
338 /* Not a setup packet, stall next
341 udc_dump_buffer("ep0 setup read",
343 usberr("can't parse setup packet\n");
347 } else if (!(udccsr0
& UDCCSR0_OPC
) &&
348 !(udccsr0
& UDCCSR0_IPR
)) {
349 if (ep0_urb
->device_request
.wLength
==
350 ep0_urb
->actual_length
)
353 usberr("Premature Status\n");
359 /* GET_DESCRIPTOR etc */
360 if (udccsr0
& UDCCSR0_OPC
) {
361 writel(UDCCSR0_OPC
| UDCCSR0_FTF
, UDCCSR0
);
362 usberr("ep0in premature status");
365 /* irq was IPR clearing */
366 if (udc_write_urb(endpoint
) < 0) {
367 usberr("ep0_write_error\n");
373 case EP0_XFER_COMPLETE
:
374 writel(UDCCSR0_IPR
, UDCCSR0
);
381 writel(USIR0_IR0
, USIR0
);
384 static void udc_handle_ep(struct usb_endpoint_instance
*endpoint
)
386 int ep_addr
= endpoint
->endpoint_address
;
387 int ep_num
= ep_addr
& USB_ENDPOINT_NUMBER_MASK
;
388 int ep_isout
= (ep_addr
& USB_ENDPOINT_DIR_MASK
) == USB_DIR_OUT
;
390 u32 flags
= readl(UDCCSN(ep_num
)) & (UDCCSR_SST
| UDCCSR_TRN
);
392 writel(flags
, UDCCSN(ep_num
));
395 udc_read_urb(endpoint
);
397 udc_write_urb(endpoint
);
399 writel(UDCCSR_PC
, UDCCSN(ep_num
));
402 static void udc_state_changed(void)
405 writel(readl(UDCCR
) | UDCCR_SMAC
, UDCCR
);
407 usbdbg("New UDC settings are: conf %d - inter %d - alter %d",
408 (readl(UDCCR
) & UDCCR_ACN
) >> UDCCR_ACN_S
,
409 (readl(UDCCR
) & UDCCR_AIN
) >> UDCCR_AIN_S
,
410 (readl(UDCCR
) & UDCCR_AAISN
) >> UDCCR_AAISN_S
);
412 usbd_device_event_irq(udc_device
, DEVICE_CONFIGURED
, 0);
413 writel(UDCISR1_IRCC
, UDCISR1
);
419 struct usb_endpoint_instance
*endpoint
;
425 /* Suspend Interrupt Request */
426 if (readl(USIR1
) & UDCCR_SUSIR
) {
428 udc_ack_int_UDCCR(UDCCR_SUSIR
);
433 /* Resume Interrupt Request */
434 if (readl(USIR1
) & UDCCR_RESIR
) {
435 udc_ack_int_UDCCR(UDCCR_RESIR
);
437 usbdbg("USB resume\n");
440 if (readl(USIR1
) & (1<<31)) {
445 /* Reset Interrupt Request */
446 if (readl(USIR1
) & UDCCR_RSTIR
) {
447 udc_ack_int_UDCCR(UDCCR_RSTIR
);
450 usbd_device_event_irq(udc_device
, DEVICE_RESET
, 0);
453 usbdbg("UISR0: %x \n", readl(USIR0
));
455 if (readl(USIR0
) & 0x2)
458 /* Control traffic */
459 if (readl(USIR0
) & USIR0_IR0
) {
461 writel(USIR0_IR0
, USIR0
);
462 udc_handle_ep0(udc_device
->bus
->endpoint_array
);
465 endpoint
= udc_device
->bus
->endpoint_array
;
466 for (i
= 0; i
< udc_device
->bus
->max_endpoints
; i
++) {
467 ep_num
= (endpoint
[i
].endpoint_address
) &
468 USB_ENDPOINT_NUMBER_MASK
;
471 udcisr0
= readl(UDCISR0
);
473 UDCISR_INT(ep_num
, UDC_INT_PACKETCMP
)) {
474 writel(UDCISR_INT(ep_num
, UDC_INT_PACKETCMP
),
476 udc_handle_ep(&endpoint
[i
]);
484 /* The UDCCR reg contains mask and interrupt status bits,
485 * so using '|=' isn't safe as it may ack an interrupt.
487 #define UDCCR_OEN (1 << 31) /* On-the-Go Enable */
488 #define UDCCR_MASK_BITS (UDCCR_OEN | UDCCR_UDE)
490 static inline void udc_set_mask_UDCCR(int mask
)
492 writel((readl(UDCCR
) & UDCCR_MASK_BITS
) | (mask
& UDCCR_MASK_BITS
), UDCCR
);
495 static inline void udc_clear_mask_UDCCR(int mask
)
497 writel((readl(UDCCR
) & UDCCR_MASK_BITS
) & ~(mask
& UDCCR_MASK_BITS
), UDCCR
);
500 static void pio_irq_enable(int ep_num
)
503 writel(readl(UDCICR0
) | 3 << (ep_num
* 2), UDCICR0
);
506 writel(readl(UDCICR1
) | 3 << (ep_num
* 2), UDCICR1
);
513 * Allow upper layers to signal lower layers should not accept more RX data
515 void udc_set_nak(int ep_num
)
523 * Suspend sending of NAK tokens for DATA OUT tokens on a given endpoint.
524 * Switch off NAKing on this endpoint to accept more data output from host.
526 void udc_unset_nak(int ep_num
)
531 int udc_endpoint_write(struct usb_endpoint_instance
*endpoint
)
533 return udc_write_urb(endpoint
);
536 /* Associate a physical endpoint with endpoint instance */
537 void udc_setup_ep(struct usb_device_instance
*device
, unsigned int id
,
538 struct usb_endpoint_instance
*endpoint
)
540 int ep_num
, ep_addr
, ep_isout
, ep_type
, ep_size
;
541 int config
, interface
, alternate
;
544 usbdbg("setting up endpoint id %d", id
);
547 usberr("endpoint void!");
551 ep_num
= endpoint
->endpoint_address
& USB_ENDPOINT_NUMBER_MASK
;
552 if (ep_num
>= UDC_MAX_ENDPOINTS
) {
553 usberr("unable to setup ep %d!", ep_num
);
557 pio_irq_enable(ep_num
);
567 usbdbg("config %d - interface %d - alternate %d",
568 config
, interface
, alternate
);
570 ep_addr
= endpoint
->endpoint_address
;
571 ep_num
= ep_addr
& USB_ENDPOINT_NUMBER_MASK
;
572 ep_isout
= (ep_addr
& USB_ENDPOINT_DIR_MASK
) == USB_DIR_OUT
;
573 ep_type
= ep_isout
? endpoint
->rcv_attributes
: endpoint
->tx_attributes
;
574 ep_size
= ep_isout
? endpoint
->rcv_packetSize
: endpoint
->tx_packetSize
;
576 usbdbg("addr %x, num %d, dir %s, type %s, packet size %d",
578 ep_isout
? "out" : "in",
579 ep_type
== USB_ENDPOINT_XFER_ISOC
? "isoc" :
580 ep_type
== USB_ENDPOINT_XFER_BULK
? "bulk" :
581 ep_type
== USB_ENDPOINT_XFER_INT
? "int" : "???",
585 /* Configure UDCCRx */
587 tmp
|= (config
<< UDCCONR_CN_S
) & UDCCONR_CN
;
588 tmp
|= (interface
<< UDCCONR_IN_S
) & UDCCONR_IN
;
589 tmp
|= (alternate
<< UDCCONR_AISN_S
) & UDCCONR_AISN
;
590 tmp
|= (ep_num
<< UDCCONR_EN_S
) & UDCCONR_EN
;
591 tmp
|= (ep_type
<< UDCCONR_ET_S
) & UDCCONR_ET
;
592 tmp
|= ep_isout
? 0 : UDCCONR_ED
;
593 tmp
|= (ep_size
<< UDCCONR_MPS_S
) & UDCCONR_MPS
;
596 writel(tmp
, UDCCN(ep_num
));
598 usbdbg("UDCCR%c = %x", 'A' + ep_num
-1, readl(UDCCN(ep_num
)));
599 usbdbg("UDCCSR%c = %x", 'A' + ep_num
-1, readl(UDCCSN(ep_num
)));
602 /* Connect the USB device to the bus */
603 void udc_connect(void)
605 usbdbg("UDC connect");
607 #ifdef CONFIG_USB_DEV_PULLUP_GPIO
608 /* Turn on the USB connection by enabling the pullup resistor */
609 writel(readl(GPDR(CONFIG_USB_DEV_PULLUP_GPIO
))
610 | GPIO_bit(CONFIG_USB_DEV_PULLUP_GPIO
),
611 GPDR(CONFIG_USB_DEV_PULLUP_GPIO
));
612 writel(GPIO_bit(CONFIG_USB_DEV_PULLUP_GPIO
), GPSR(CONFIG_USB_DEV_PULLUP_GPIO
));
614 /* Host port 2 transceiver D+ pull up enable */
615 writel(readl(UP2OCR
) | UP2OCR_DPPUE
, UP2OCR
);
619 /* Disconnect the USB device to the bus */
620 void udc_disconnect(void)
622 usbdbg("UDC disconnect");
624 #ifdef CONFIG_USB_DEV_PULLUP_GPIO
625 /* Turn off the USB connection by disabling the pullup resistor */
626 writel(GPIO_bit(CONFIG_USB_DEV_PULLUP_GPIO
), GPCR(CONFIG_USB_DEV_PULLUP_GPIO
));
628 /* Host port 2 transceiver D+ pull up disable */
629 writel(readl(UP2OCR
) & ~UP2OCR_DPPUE
, UP2OCR
);
633 /* Switch on the UDC */
634 void udc_enable(struct usb_device_instance
*device
)
639 /* enable endpoint 0, A, B's Packet Complete Interrupt. */
640 writel(0xffffffff, UDCICR0
);
641 writel(0xa8000000, UDCICR1
);
643 /* clear the interrupt status/control registers */
644 writel(0xffffffff, UDCISR0
);
645 writel(0xffffffff, UDCISR1
);
648 udc_set_mask_UDCCR(UDCCR_UDE
);
652 ep0_urb
= usbd_alloc_urb(udc_device
,
653 udc_device
->bus
->endpoint_array
);
655 usbinfo("ep0_urb %p already allocated", ep0_urb
);
657 usbdbg("UDC Enabled\n");
660 /* Need to check this again */
661 void udc_disable(void)
663 usbdbg("disable UDC");
665 udc_clear_mask_UDCCR(UDCCR_UDE
);
667 /* Disable clock for USB device */
668 writel(readl(CKEN
) & ~CKEN11_USB
, CKEN
);
672 usbd_dealloc_urb(ep0_urb
);
676 /* Reset device pointer */
680 /* Allow udc code to do any additional startup */
681 void udc_startup_events(struct usb_device_instance
*device
)
683 /* The DEVICE_INIT event puts the USB device in the state STATE_INIT */
684 usbd_device_event_irq(device
, DEVICE_INIT
, 0);
686 /* The DEVICE_CREATE event puts the USB device in the state
688 usbd_device_event_irq(device
, DEVICE_CREATE
, 0);
690 /* Some USB controller driver implementations signal
691 * DEVICE_HUB_CONFIGURED and DEVICE_RESET events here.
692 * DEVICE_HUB_CONFIGURED causes a transition to the state
693 * STATE_POWERED, and DEVICE_RESET causes a transition to
694 * the state STATE_DEFAULT.
699 /* Initialize h/w stuff */
703 usbdbg("PXA27x usbd start");
705 /* Enable clock for USB device */
706 writel(readl(CKEN
) | CKEN11_USB
, CKEN
);
708 /* Disable the UDC */
709 udc_clear_mask_UDCCR(UDCCR_UDE
);
711 /* Disable IRQs: we don't use them */