2 * URB OHCI HCD (Host Controller Driver) for USB on the AT91RM9200 and PCI bus.
4 * Interrupt support is added. Now, it has been tested
5 * on ULI1575 chip and works well with USB keyboard.
8 * Zhang Wei, Freescale Semiconductor, Inc. <wei.zhang@freescale.com>
11 * Gary Jennejohn, DENX Software Engineering <garyj@denx.de>
13 * Note: Much of this code has been derived from Linux 2.4
14 * (C) Copyright 1999 Roman Weissgaerber <weissg@vienna.at>
15 * (C) Copyright 2000-2002 David Brownell
17 * Modified for the MP2USB by (C) Copyright 2005 Eric Benard
18 * ebenard@eukrea.com - based on s3c24x0's driver
20 * SPDX-License-Identifier: GPL-2.0+
24 * 1 - Read doc/README.generic_usb_ohci
25 * 2 - this driver is intended for use with USB Mass Storage Devices
26 * (BBB) and USB keyboard. There is NO support for Isochronous pipes!
27 * 2 - when running on a PQFP208 AT91RM9200, define CONFIG_AT91C_PQFP_UHPBUG
28 * to activate workaround for bug #41 or this driver will NOT work!
32 #include <asm/byteorder.h>
36 #if defined(CONFIG_PCI_OHCI)
38 #if !defined(CONFIG_PCI_OHCI_DEVNO)
39 #define CONFIG_PCI_OHCI_DEVNO 0
49 #ifdef CONFIG_AT91RM9200
50 #include <asm/arch/hardware.h> /* needed for AT91_USB_HOST_BASE */
53 #if defined(CONFIG_CPU_ARM920T) || \
54 defined(CONFIG_S3C24X0) || \
55 defined(CONFIG_440EP) || \
56 defined(CONFIG_PCI_OHCI) || \
57 defined(CONFIG_MPC5200) || \
58 defined(CONFIG_SYS_OHCI_USE_NPS)
59 # define OHCI_USE_NPS /* force NoPowerSwitching mode */
62 #undef OHCI_VERBOSE_DEBUG /* not always helpful */
65 #undef OHCI_FILL_TRACE
67 /* For initializing controller (mask in an HCFS mode too) */
68 #define OHCI_CONTROL_INIT \
69 (OHCI_CTRL_CBSR & 0x3) | OHCI_CTRL_IE | OHCI_CTRL_PLE
71 #ifdef CONFIG_PCI_OHCI
72 static struct pci_device_id ohci_pci_ids[] = {
73 {0x10b9, 0x5237}, /* ULI1575 PCI OHCI module ids */
74 {0x1033, 0x0035}, /* NEC PCI OHCI module ids */
75 {0x1131, 0x1561}, /* Philips 1561 PCI OHCI module ids */
76 /* Please add supported PCI OHCI controller ids here */
81 #ifdef CONFIG_PCI_EHCI_DEVNO
82 static struct pci_device_id ehci_pci_ids[] = {
83 {0x1131, 0x1562}, /* Philips 1562 PCI EHCI module ids */
84 /* Please add supported PCI EHCI controller ids here */
90 #define dbg(format, arg...) printf("DEBUG: " format "\n", ## arg)
92 #define dbg(format, arg...) do {} while (0)
94 #define err(format, arg...) printf("ERROR: " format "\n", ## arg)
96 #define info(format, arg...) printf("INFO: " format "\n", ## arg)
98 #define info(format, arg...) do {} while (0)
101 #ifdef CONFIG_SYS_OHCI_BE_CONTROLLER
102 # define m16_swap(x) cpu_to_be16(x)
103 # define m32_swap(x) cpu_to_be32(x)
105 # define m16_swap(x) cpu_to_le16(x)
106 # define m32_swap(x) cpu_to_le32(x)
107 #endif /* CONFIG_SYS_OHCI_BE_CONTROLLER */
109 /* We really should do proper cache flushing everywhere */
110 #define flush_dcache_buffer(addr, size) \
111 flush_dcache_range((unsigned long)(addr), \
112 ALIGN((unsigned long)(addr) + size, ARCH_DMA_MINALIGN))
113 #define invalidate_dcache_buffer(addr, size) \
114 invalidate_dcache_range((unsigned long)(addr), \
115 ALIGN((unsigned long)(addr) + size, ARCH_DMA_MINALIGN))
117 /* Do not use sizeof(ed / td) as our ed / td structs contain extra members */
118 #define flush_dcache_ed(addr) flush_dcache_buffer(addr, 16)
119 #define flush_dcache_td(addr) flush_dcache_buffer(addr, 16)
120 #define flush_dcache_iso_td(addr) flush_dcache_buffer(addr, 32)
121 #define flush_dcache_hcca(addr) flush_dcache_buffer(addr, 256)
122 #define invalidate_dcache_ed(addr) invalidate_dcache_buffer(addr, 16)
123 #define invalidate_dcache_td(addr) invalidate_dcache_buffer(addr, 16)
124 #define invalidate_dcache_iso_td(addr) invalidate_dcache_buffer(addr, 32)
125 #define invalidate_dcache_hcca(addr) invalidate_dcache_buffer(addr, 256)
129 * The various ohci_mdelay(1) calls in the code seem unnecessary. We keep
130 * them around when building for older boards not yet converted to the dm
131 * just in case (to avoid regressions), for dm this turns them into nops.
133 #define ohci_mdelay(x)
135 #define ohci_mdelay(x) mdelay(x)
138 #ifndef CONFIG_DM_USB
141 /* this must be aligned to a 256 byte boundary */
142 struct ohci_hcca ghcca[1];
145 /* mapping of the OHCI CC status to error codes */
146 static int cc_to_error[16] = {
148 /* CRC Error */ USB_ST_CRC_ERR,
149 /* Bit Stuff */ USB_ST_BIT_ERR,
150 /* Data Togg */ USB_ST_CRC_ERR,
151 /* Stall */ USB_ST_STALLED,
153 /* PIDCheck */ USB_ST_BIT_ERR,
154 /* UnExpPID */ USB_ST_BIT_ERR,
155 /* DataOver */ USB_ST_BUF_ERR,
156 /* DataUnder */ USB_ST_BUF_ERR,
159 /* BufferOver */ USB_ST_BUF_ERR,
160 /* BuffUnder */ USB_ST_BUF_ERR,
165 static const char *cc_to_string[16] = {
167 "CRC: Last data packet from endpoint contained a CRC error.",
168 "BITSTUFFING: Last data packet from endpoint contained a bit " \
169 "stuffing violation",
170 "DATATOGGLEMISMATCH: Last packet from endpoint had data toggle PID\n" \
171 "that did not match the expected value.",
172 "STALL: TD was moved to the Done Queue because the endpoint returned" \
174 "DEVICENOTRESPONDING: Device did not respond to token (IN) or did\n" \
175 "not provide a handshake (OUT)",
176 "PIDCHECKFAILURE: Check bits on PID from endpoint failed on data PID\n"\
177 "(IN) or handshake (OUT)",
178 "UNEXPECTEDPID: Receive PID was not valid when encountered or PID\n" \
179 "value is not defined.",
180 "DATAOVERRUN: The amount of data returned by the endpoint exceeded\n" \
181 "either the size of the maximum data packet allowed\n" \
182 "from the endpoint (found in MaximumPacketSize field\n" \
183 "of ED) or the remaining buffer size.",
184 "DATAUNDERRUN: The endpoint returned less than MaximumPacketSize\n" \
185 "and that amount was not sufficient to fill the\n" \
189 "BUFFEROVERRUN: During an IN, HC received data from endpoint faster\n" \
190 "than it could be written to system memory",
191 "BUFFERUNDERRUN: During an OUT, HC could not retrieve data from\n" \
192 "system memory fast enough to keep up with data USB " \
194 "NOT ACCESSED: This code is set by software before the TD is placed" \
195 "on a list to be processed by the HC.(1)",
196 "NOT ACCESSED: This code is set by software before the TD is placed" \
197 "on a list to be processed by the HC.(2)",
200 static inline u32 roothub_a(struct ohci *hc)
201 { return ohci_readl(&hc->regs->roothub.a); }
202 static inline u32 roothub_b(struct ohci *hc)
203 { return ohci_readl(&hc->regs->roothub.b); }
204 static inline u32 roothub_status(struct ohci *hc)
205 { return ohci_readl(&hc->regs->roothub.status); }
206 static inline u32 roothub_portstatus(struct ohci *hc, int i)
207 { return ohci_readl(&hc->regs->roothub.portstatus[i]); }
209 /* forward declaration */
210 static int hc_interrupt(ohci_t *ohci);
211 static void td_submit_job(ohci_t *ohci, struct usb_device *dev,
212 unsigned long pipe, void *buffer, int transfer_len,
213 struct devrequest *setup, urb_priv_t *urb,
215 static int ep_link(ohci_t * ohci, ed_t * ed);
216 static int ep_unlink(ohci_t * ohci, ed_t * ed);
217 static ed_t *ep_add_ed(ohci_dev_t *ohci_dev, struct usb_device *usb_dev,
218 unsigned long pipe, int interval, int load);
220 /*-------------------------------------------------------------------------*/
223 static struct td *td_alloc(ohci_dev_t *ohci_dev, struct usb_device *usb_dev)
229 for (i = 0; i < NUM_TD; i++)
231 if (ohci_dev->tds[i].usb_dev == NULL)
233 td = &ohci_dev->tds[i];
234 td->usb_dev = usb_dev;
242 static inline void ed_free(struct ed *ed)
247 /*-------------------------------------------------------------------------*
248 * URB support functions
249 *-------------------------------------------------------------------------*/
251 /* free HCD-private data associated with this URB */
253 static void urb_free_priv(urb_priv_t *urb)
259 last = urb->length - 1;
261 for (i = 0; i <= last; i++) {
272 /*-------------------------------------------------------------------------*/
275 static int sohci_get_current_frame_number(ohci_t *ohci);
277 /* debug| print the main components of an URB
278 * small: 0) header + data packets 1) just header */
280 static void pkt_print(ohci_t *ohci, urb_priv_t *purb, struct usb_device *dev,
281 unsigned long pipe, void *buffer, int transfer_len,
282 struct devrequest *setup, char *str, int small)
284 dbg("%s URB:[%4x] dev:%2lu,ep:%2lu-%c,type:%s,len:%d/%d stat:%#lx",
286 sohci_get_current_frame_number(ohci),
287 usb_pipedevice(pipe),
288 usb_pipeendpoint(pipe),
289 usb_pipeout(pipe)? 'O': 'I',
290 usb_pipetype(pipe) < 2 ? \
291 (usb_pipeint(pipe)? "INTR": "ISOC"): \
292 (usb_pipecontrol(pipe)? "CTRL": "BULK"),
293 (purb ? purb->actual_length : 0),
294 transfer_len, dev->status);
295 #ifdef OHCI_VERBOSE_DEBUG
299 if (usb_pipecontrol(pipe)) {
300 printf(__FILE__ ": cmd(8):");
301 for (i = 0; i < 8 ; i++)
302 printf(" %02x", ((__u8 *) setup) [i]);
305 if (transfer_len > 0 && buffer) {
306 printf(__FILE__ ": data(%d/%d):",
307 (purb ? purb->actual_length : 0),
309 len = usb_pipeout(pipe)? transfer_len:
310 (purb ? purb->actual_length : 0);
311 for (i = 0; i < 16 && i < len; i++)
312 printf(" %02x", ((__u8 *) buffer) [i]);
313 printf("%s\n", i < len? "...": "");
319 /* just for debugging; prints non-empty branches of the int ed tree
320 * inclusive iso eds */
321 void ep_print_int_eds(ohci_t *ohci, char *str)
325 for (i = 0; i < 32; i++) {
327 ed_p = &(ohci->hcca->int_table [i]);
330 invalidate_dcache_ed(ed_p);
331 printf(__FILE__ ": %s branch int %2d(%2x):", str, i, i);
332 while (*ed_p != 0 && j--) {
333 ed_t *ed = (ed_t *)m32_swap(ed_p);
334 invalidate_dcache_ed(ed);
335 printf(" ed: %4x;", ed->hwINFO);
336 ed_p = &ed->hwNextED;
342 static void ohci_dump_intr_mask(char *label, __u32 mask)
344 dbg("%s: 0x%08x%s%s%s%s%s%s%s%s%s",
347 (mask & OHCI_INTR_MIE) ? " MIE" : "",
348 (mask & OHCI_INTR_OC) ? " OC" : "",
349 (mask & OHCI_INTR_RHSC) ? " RHSC" : "",
350 (mask & OHCI_INTR_FNO) ? " FNO" : "",
351 (mask & OHCI_INTR_UE) ? " UE" : "",
352 (mask & OHCI_INTR_RD) ? " RD" : "",
353 (mask & OHCI_INTR_SF) ? " SF" : "",
354 (mask & OHCI_INTR_WDH) ? " WDH" : "",
355 (mask & OHCI_INTR_SO) ? " SO" : ""
359 static void maybe_print_eds(char *label, __u32 value)
361 ed_t *edp = (ed_t *)value;
364 dbg("%s %08x", label, value);
365 invalidate_dcache_ed(edp);
366 dbg("%08x", edp->hwINFO);
367 dbg("%08x", edp->hwTailP);
368 dbg("%08x", edp->hwHeadP);
369 dbg("%08x", edp->hwNextED);
373 static char *hcfs2string(int state)
376 case OHCI_USB_RESET: return "reset";
377 case OHCI_USB_RESUME: return "resume";
378 case OHCI_USB_OPER: return "operational";
379 case OHCI_USB_SUSPEND: return "suspend";
384 /* dump control and status registers */
385 static void ohci_dump_status(ohci_t *controller)
387 struct ohci_regs *regs = controller->regs;
390 temp = ohci_readl(®s->revision) & 0xff;
392 dbg("spec %d.%d", (temp >> 4), (temp & 0x0f));
394 temp = ohci_readl(®s->control);
395 dbg("control: 0x%08x%s%s%s HCFS=%s%s%s%s%s CBSR=%d", temp,
396 (temp & OHCI_CTRL_RWE) ? " RWE" : "",
397 (temp & OHCI_CTRL_RWC) ? " RWC" : "",
398 (temp & OHCI_CTRL_IR) ? " IR" : "",
399 hcfs2string(temp & OHCI_CTRL_HCFS),
400 (temp & OHCI_CTRL_BLE) ? " BLE" : "",
401 (temp & OHCI_CTRL_CLE) ? " CLE" : "",
402 (temp & OHCI_CTRL_IE) ? " IE" : "",
403 (temp & OHCI_CTRL_PLE) ? " PLE" : "",
404 temp & OHCI_CTRL_CBSR
407 temp = ohci_readl(®s->cmdstatus);
408 dbg("cmdstatus: 0x%08x SOC=%d%s%s%s%s", temp,
409 (temp & OHCI_SOC) >> 16,
410 (temp & OHCI_OCR) ? " OCR" : "",
411 (temp & OHCI_BLF) ? " BLF" : "",
412 (temp & OHCI_CLF) ? " CLF" : "",
413 (temp & OHCI_HCR) ? " HCR" : ""
416 ohci_dump_intr_mask("intrstatus", ohci_readl(®s->intrstatus));
417 ohci_dump_intr_mask("intrenable", ohci_readl(®s->intrenable));
419 maybe_print_eds("ed_periodcurrent",
420 ohci_readl(®s->ed_periodcurrent));
422 maybe_print_eds("ed_controlhead", ohci_readl(®s->ed_controlhead));
423 maybe_print_eds("ed_controlcurrent",
424 ohci_readl(®s->ed_controlcurrent));
426 maybe_print_eds("ed_bulkhead", ohci_readl(®s->ed_bulkhead));
427 maybe_print_eds("ed_bulkcurrent", ohci_readl(®s->ed_bulkcurrent));
429 maybe_print_eds("donehead", ohci_readl(®s->donehead));
432 static void ohci_dump_roothub(ohci_t *controller, int verbose)
436 temp = roothub_a(controller);
437 ndp = (temp & RH_A_NDP);
438 #ifdef CONFIG_AT91C_PQFP_UHPBUG
439 ndp = (ndp == 2) ? 1:0;
442 dbg("roothub.a: %08x POTPGT=%d%s%s%s%s%s NDP=%d", temp,
443 ((temp & RH_A_POTPGT) >> 24) & 0xff,
444 (temp & RH_A_NOCP) ? " NOCP" : "",
445 (temp & RH_A_OCPM) ? " OCPM" : "",
446 (temp & RH_A_DT) ? " DT" : "",
447 (temp & RH_A_NPS) ? " NPS" : "",
448 (temp & RH_A_PSM) ? " PSM" : "",
451 temp = roothub_b(controller);
452 dbg("roothub.b: %08x PPCM=%04x DR=%04x",
454 (temp & RH_B_PPCM) >> 16,
457 temp = roothub_status(controller);
458 dbg("roothub.status: %08x%s%s%s%s%s%s",
460 (temp & RH_HS_CRWE) ? " CRWE" : "",
461 (temp & RH_HS_OCIC) ? " OCIC" : "",
462 (temp & RH_HS_LPSC) ? " LPSC" : "",
463 (temp & RH_HS_DRWE) ? " DRWE" : "",
464 (temp & RH_HS_OCI) ? " OCI" : "",
465 (temp & RH_HS_LPS) ? " LPS" : ""
469 for (i = 0; i < ndp; i++) {
470 temp = roothub_portstatus(controller, i);
471 dbg("roothub.portstatus [%d] = 0x%08x%s%s%s%s%s%s%s%s%s%s%s%s",
474 (temp & RH_PS_PRSC) ? " PRSC" : "",
475 (temp & RH_PS_OCIC) ? " OCIC" : "",
476 (temp & RH_PS_PSSC) ? " PSSC" : "",
477 (temp & RH_PS_PESC) ? " PESC" : "",
478 (temp & RH_PS_CSC) ? " CSC" : "",
480 (temp & RH_PS_LSDA) ? " LSDA" : "",
481 (temp & RH_PS_PPS) ? " PPS" : "",
482 (temp & RH_PS_PRS) ? " PRS" : "",
483 (temp & RH_PS_POCI) ? " POCI" : "",
484 (temp & RH_PS_PSS) ? " PSS" : "",
486 (temp & RH_PS_PES) ? " PES" : "",
487 (temp & RH_PS_CCS) ? " CCS" : ""
492 static void ohci_dump(ohci_t *controller, int verbose)
494 dbg("OHCI controller usb-%s state", controller->slot_name);
496 /* dumps some of the state we know about */
497 ohci_dump_status(controller);
499 ep_print_int_eds(controller, "hcca");
500 invalidate_dcache_hcca(controller->hcca);
501 dbg("hcca frame #%04x", controller->hcca->frame_no);
502 ohci_dump_roothub(controller, 1);
506 /*-------------------------------------------------------------------------*
507 * Interface functions (URB)
508 *-------------------------------------------------------------------------*/
510 /* get a transfer request */
512 int sohci_submit_job(ohci_t *ohci, ohci_dev_t *ohci_dev, urb_priv_t *urb,
513 struct devrequest *setup)
516 urb_priv_t *purb_priv = urb;
518 struct usb_device *dev = urb->dev;
519 unsigned long pipe = urb->pipe;
520 void *buffer = urb->transfer_buffer;
521 int transfer_len = urb->transfer_buffer_length;
522 int interval = urb->interval;
524 /* when controller's hung, permit only roothub cleanup attempts
525 * such as powering down ports */
526 if (ohci->disabled) {
527 err("sohci_submit_job: EPIPE");
531 /* we're about to begin a new transaction here so mark the
535 /* every endpoint has a ed, locate and fill it */
536 ed = ep_add_ed(ohci_dev, dev, pipe, interval, 1);
538 err("sohci_submit_job: ENOMEM");
542 /* for the private part of the URB we need the number of TDs (size) */
543 switch (usb_pipetype(pipe)) {
544 case PIPE_BULK: /* one TD for every 4096 Byte */
545 size = (transfer_len - 1) / 4096 + 1;
547 case PIPE_CONTROL:/* 1 TD for setup, 1 for ACK and 1 for every 4096 B */
548 size = (transfer_len == 0)? 2:
549 (transfer_len - 1) / 4096 + 3;
551 case PIPE_INTERRUPT: /* 1 TD */
558 if (size >= (N_URB_TD - 1)) {
559 err("need %d TDs, only have %d", size, N_URB_TD);
562 purb_priv->pipe = pipe;
564 /* fill the private part of the URB */
565 purb_priv->length = size;
567 purb_priv->actual_length = 0;
569 /* allocate the TDs */
570 /* note that td[0] was allocated in ep_add_ed */
571 for (i = 0; i < size; i++) {
572 purb_priv->td[i] = td_alloc(ohci_dev, dev);
573 if (!purb_priv->td[i]) {
574 purb_priv->length = i;
575 urb_free_priv(purb_priv);
576 err("sohci_submit_job: ENOMEM");
581 if (ed->state == ED_NEW || (ed->state & ED_DEL)) {
582 urb_free_priv(purb_priv);
583 err("sohci_submit_job: EINVAL");
587 /* link the ed into a chain if is not already */
588 if (ed->state != ED_OPER)
591 /* fill the TDs and link it to the ed */
592 td_submit_job(ohci, dev, pipe, buffer, transfer_len,
593 setup, purb_priv, interval);
598 /*-------------------------------------------------------------------------*/
601 /* tell us the current USB frame number */
602 static int sohci_get_current_frame_number(ohci_t *ohci)
604 invalidate_dcache_hcca(ohci->hcca);
605 return m16_swap(ohci->hcca->frame_no);
609 /*-------------------------------------------------------------------------*
610 * ED handling functions
611 *-------------------------------------------------------------------------*/
613 /* search for the right branch to insert an interrupt ed into the int tree
614 * do some load ballancing;
615 * returns the branch and
616 * sets the interval to interval = 2^integer (ld (interval)) */
618 static int ep_int_ballance(ohci_t *ohci, int interval, int load)
622 /* search for the least loaded interrupt endpoint
623 * branch of all 32 branches
625 for (i = 0; i < 32; i++)
626 if (ohci->ohci_int_load [branch] > ohci->ohci_int_load [i])
629 branch = branch % interval;
630 for (i = branch; i < 32; i += interval)
631 ohci->ohci_int_load [i] += load;
636 /*-------------------------------------------------------------------------*/
638 /* 2^int( ld (inter)) */
640 static int ep_2_n_interval(int inter)
643 for (i = 0; ((inter >> i) > 1) && (i < 5); i++);
647 /*-------------------------------------------------------------------------*/
649 /* the int tree is a binary tree
650 * in order to process it sequentially the indexes of the branches have to
651 * be mapped the mapping reverses the bits of a word of num_bits length */
652 static int ep_rev(int num_bits, int word)
656 for (i = 0; i < num_bits; i++)
657 wout |= (((word >> i) & 1) << (num_bits - i - 1));
661 /*-------------------------------------------------------------------------*
662 * ED handling functions
663 *-------------------------------------------------------------------------*/
665 /* link an ed into one of the HC chains */
667 static int ep_link(ohci_t *ohci, ed_t *edi)
669 volatile ed_t *ed = edi;
678 ed->int_interval = 0;
684 if (ohci->ed_controltail == NULL)
685 ohci_writel((uintptr_t)ed, &ohci->regs->ed_controlhead);
687 ohci->ed_controltail->hwNextED =
688 m32_swap((unsigned long)ed);
690 ed->ed_prev = ohci->ed_controltail;
691 if (!ohci->ed_controltail && !ohci->ed_rm_list[0] &&
692 !ohci->ed_rm_list[1] && !ohci->sleeping) {
693 ohci->hc_control |= OHCI_CTRL_CLE;
694 ohci_writel(ohci->hc_control, &ohci->regs->control);
696 ohci->ed_controltail = edi;
702 if (ohci->ed_bulktail == NULL)
703 ohci_writel((uintptr_t)ed, &ohci->regs->ed_bulkhead);
705 ohci->ed_bulktail->hwNextED =
706 m32_swap((unsigned long)ed);
708 ed->ed_prev = ohci->ed_bulktail;
709 if (!ohci->ed_bulktail && !ohci->ed_rm_list[0] &&
710 !ohci->ed_rm_list[1] && !ohci->sleeping) {
711 ohci->hc_control |= OHCI_CTRL_BLE;
712 ohci_writel(ohci->hc_control, &ohci->regs->control);
714 ohci->ed_bulktail = edi;
719 interval = ep_2_n_interval(ed->int_period);
720 ed->int_interval = interval;
721 int_branch = ep_int_ballance(ohci, interval, load);
722 ed->int_branch = int_branch;
724 for (i = 0; i < ep_rev(6, interval); i += inter) {
726 for (ed_p = &(ohci->hcca->int_table[\
727 ep_rev(5, i) + int_branch]);
729 (((ed_t *)ed_p)->int_interval >= interval);
730 ed_p = &(((ed_t *)ed_p)->hwNextED))
732 ((ed_t *)ed_p)->int_interval);
733 ed->hwNextED = *ed_p;
735 *ed_p = m32_swap((unsigned long)ed);
736 flush_dcache_hcca(ohci->hcca);
743 /*-------------------------------------------------------------------------*/
745 /* scan the periodic table to find and unlink this ED */
746 static void periodic_unlink(struct ohci *ohci, volatile struct ed *ed,
747 unsigned index, unsigned period)
749 __maybe_unused unsigned long aligned_ed_p;
751 for (; index < NUM_INTS; index += period) {
752 __u32 *ed_p = &ohci->hcca->int_table [index];
754 /* ED might have been unlinked through another path */
756 if (((struct ed *)(uintptr_t)
757 m32_swap((unsigned long)ed_p)) == ed) {
758 *ed_p = ed->hwNextED;
759 aligned_ed_p = (unsigned long)ed_p;
760 aligned_ed_p &= ~(ARCH_DMA_MINALIGN - 1);
761 flush_dcache_range(aligned_ed_p,
762 aligned_ed_p + ARCH_DMA_MINALIGN);
765 ed_p = &(((struct ed *)(uintptr_t)
766 m32_swap((unsigned long)ed_p))->hwNextED);
771 /* unlink an ed from one of the HC chains.
772 * just the link to the ed is unlinked.
773 * the link from the ed still points to another operational ed or 0
774 * so the HC can eventually finish the processing of the unlinked ed */
776 static int ep_unlink(ohci_t *ohci, ed_t *edi)
778 volatile ed_t *ed = edi;
781 ed->hwINFO |= m32_swap(OHCI_ED_SKIP);
786 if (ed->ed_prev == NULL) {
788 ohci->hc_control &= ~OHCI_CTRL_CLE;
789 ohci_writel(ohci->hc_control,
790 &ohci->regs->control);
792 ohci_writel(m32_swap(*((__u32 *)&ed->hwNextED)),
793 &ohci->regs->ed_controlhead);
795 ed->ed_prev->hwNextED = ed->hwNextED;
796 flush_dcache_ed(ed->ed_prev);
798 if (ohci->ed_controltail == ed) {
799 ohci->ed_controltail = ed->ed_prev;
801 ((ed_t *)(uintptr_t)m32_swap(
802 *((__u32 *)&ed->hwNextED)))->ed_prev = ed->ed_prev;
807 if (ed->ed_prev == NULL) {
809 ohci->hc_control &= ~OHCI_CTRL_BLE;
810 ohci_writel(ohci->hc_control,
811 &ohci->regs->control);
813 ohci_writel(m32_swap(*((__u32 *)&ed->hwNextED)),
814 &ohci->regs->ed_bulkhead);
816 ed->ed_prev->hwNextED = ed->hwNextED;
817 flush_dcache_ed(ed->ed_prev);
819 if (ohci->ed_bulktail == ed) {
820 ohci->ed_bulktail = ed->ed_prev;
822 ((ed_t *)(uintptr_t)m32_swap(
823 *((__u32 *)&ed->hwNextED)))->ed_prev = ed->ed_prev;
828 periodic_unlink(ohci, ed, 0, 1);
829 for (i = ed->int_branch; i < 32; i += ed->int_interval)
830 ohci->ohci_int_load[i] -= ed->int_load;
833 ed->state = ED_UNLINK;
837 /*-------------------------------------------------------------------------*/
839 /* add/reinit an endpoint; this should be done once at the
840 * usb_set_configuration command, but the USB stack is a little bit
841 * stateless so we do it at every transaction if the state of the ed
842 * is ED_NEW then a dummy td is added and the state is changed to
843 * ED_UNLINK in all other cases the state is left unchanged the ed
844 * info fields are setted anyway even though most of them should not
847 static ed_t *ep_add_ed(ohci_dev_t *ohci_dev, struct usb_device *usb_dev,
848 unsigned long pipe, int interval, int load)
854 ed = ed_ret = &ohci_dev->ed[(usb_pipeendpoint(pipe) << 1) |
855 (usb_pipecontrol(pipe)? 0: usb_pipeout(pipe))];
857 if ((ed->state & ED_DEL) || (ed->state & ED_URB_DEL)) {
858 err("ep_add_ed: pending delete");
859 /* pending delete request */
863 if (ed->state == ED_NEW) {
864 /* dummy td; end of td list for ed */
865 td = td_alloc(ohci_dev, usb_dev);
866 ed->hwTailP = m32_swap((unsigned long)td);
867 ed->hwHeadP = ed->hwTailP;
868 ed->state = ED_UNLINK;
869 ed->type = usb_pipetype(pipe);
873 ed->hwINFO = m32_swap(usb_pipedevice(pipe)
874 | usb_pipeendpoint(pipe) << 7
875 | (usb_pipeisoc(pipe)? 0x8000: 0)
876 | (usb_pipecontrol(pipe)? 0: \
877 (usb_pipeout(pipe)? 0x800: 0x1000))
878 | (usb_dev->speed == USB_SPEED_LOW) << 13
879 | usb_maxpacket(usb_dev, pipe) << 16);
881 if (ed->type == PIPE_INTERRUPT && ed->state == ED_UNLINK) {
882 ed->int_period = interval;
891 /*-------------------------------------------------------------------------*
892 * TD handling functions
893 *-------------------------------------------------------------------------*/
895 /* enqueue next TD for this URB (OHCI spec 5.2.8.2) */
897 static void td_fill(ohci_t *ohci, unsigned int info,
899 struct usb_device *dev, int index, urb_priv_t *urb_priv)
901 volatile td_t *td, *td_pt;
902 #ifdef OHCI_FILL_TRACE
906 if (index > urb_priv->length) {
907 err("index > length");
910 /* use this td as the next dummy */
911 td_pt = urb_priv->td [index];
913 flush_dcache_td(td_pt);
915 /* fill the old dummy TD */
916 td = urb_priv->td [index] =
918 (m32_swap(urb_priv->ed->hwTailP) & ~0xf);
920 td->ed = urb_priv->ed;
921 td->next_dl_td = NULL;
923 td->data = (uintptr_t)data;
924 #ifdef OHCI_FILL_TRACE
925 if (usb_pipebulk(urb_priv->pipe) && usb_pipeout(urb_priv->pipe)) {
926 for (i = 0; i < len; i++)
927 printf("td->data[%d] %#2x ", i, ((unsigned char *)td->data)[i]);
934 td->hwINFO = m32_swap(info);
935 td->hwCBP = m32_swap((unsigned long)data);
937 td->hwBE = m32_swap((unsigned long)(data + len - 1));
941 td->hwNextTD = m32_swap((unsigned long)td_pt);
944 /* append to queue */
945 td->ed->hwTailP = td->hwNextTD;
946 flush_dcache_ed(td->ed);
949 /*-------------------------------------------------------------------------*/
951 /* prepare all TDs of a transfer */
953 static void td_submit_job(ohci_t *ohci, struct usb_device *dev,
954 unsigned long pipe, void *buffer, int transfer_len,
955 struct devrequest *setup, urb_priv_t *urb,
958 int data_len = transfer_len;
962 unsigned int toggle = 0;
964 flush_dcache_buffer(buffer, data_len);
966 /* OHCI handles the DATA-toggles itself, we just use the USB-toggle
967 * bits for resetting */
968 if (usb_gettoggle(dev, usb_pipeendpoint(pipe), usb_pipeout(pipe))) {
969 toggle = TD_T_TOGGLE;
972 usb_settoggle(dev, usb_pipeendpoint(pipe),
973 usb_pipeout(pipe), 1);
981 switch (usb_pipetype(pipe)) {
983 info = usb_pipeout(pipe)?
984 TD_CC | TD_DP_OUT : TD_CC | TD_DP_IN ;
985 while (data_len > 4096) {
986 td_fill(ohci, info | (cnt? TD_T_TOGGLE:toggle),
987 data, 4096, dev, cnt, urb);
988 data += 4096; data_len -= 4096; cnt++;
990 info = usb_pipeout(pipe)?
991 TD_CC | TD_DP_OUT : TD_CC | TD_R | TD_DP_IN ;
992 td_fill(ohci, info | (cnt? TD_T_TOGGLE:toggle), data,
993 data_len, dev, cnt, urb);
996 if (!ohci->sleeping) {
997 /* start bulk list */
998 ohci_writel(OHCI_BLF, &ohci->regs->cmdstatus);
1004 info = TD_CC | TD_DP_SETUP | TD_T_DATA0;
1005 flush_dcache_buffer(setup, 8);
1006 td_fill(ohci, info, setup, 8, dev, cnt++, urb);
1008 /* Optional Data phase */
1010 info = usb_pipeout(pipe)?
1011 TD_CC | TD_R | TD_DP_OUT | TD_T_DATA1 :
1012 TD_CC | TD_R | TD_DP_IN | TD_T_DATA1;
1013 /* NOTE: mishandles transfers >8K, some >4K */
1014 td_fill(ohci, info, data, data_len, dev, cnt++, urb);
1018 info = (usb_pipeout(pipe) || data_len == 0) ?
1019 TD_CC | TD_DP_IN | TD_T_DATA1:
1020 TD_CC | TD_DP_OUT | TD_T_DATA1;
1021 td_fill(ohci, info, data, 0, dev, cnt++, urb);
1023 if (!ohci->sleeping) {
1024 /* start Control list */
1025 ohci_writel(OHCI_CLF, &ohci->regs->cmdstatus);
1029 case PIPE_INTERRUPT:
1030 info = usb_pipeout(urb->pipe)?
1031 TD_CC | TD_DP_OUT | toggle:
1032 TD_CC | TD_R | TD_DP_IN | toggle;
1033 td_fill(ohci, info, data, data_len, dev, cnt++, urb);
1036 if (urb->length != cnt)
1037 dbg("TD LENGTH %d != CNT %d", urb->length, cnt);
1040 /*-------------------------------------------------------------------------*
1041 * Done List handling functions
1042 *-------------------------------------------------------------------------*/
1044 /* calculate the transfer length and update the urb */
1046 static void dl_transfer_length(td_t *td)
1049 urb_priv_t *lurb_priv = td->ed->purb;
1051 tdBE = m32_swap(td->hwBE);
1052 tdCBP = m32_swap(td->hwCBP);
1054 if (!(usb_pipecontrol(lurb_priv->pipe) &&
1055 ((td->index == 0) || (td->index == lurb_priv->length - 1)))) {
1058 lurb_priv->actual_length += tdBE - td->data + 1;
1060 lurb_priv->actual_length += tdCBP - td->data;
1065 /*-------------------------------------------------------------------------*/
1066 static void check_status(td_t *td_list)
1068 urb_priv_t *lurb_priv = td_list->ed->purb;
1069 int urb_len = lurb_priv->length;
1070 __u32 *phwHeadP = &td_list->ed->hwHeadP;
1073 cc = TD_CC_GET(m32_swap(td_list->hwINFO));
1075 err(" USB-error: %s (%x)", cc_to_string[cc], cc);
1077 invalidate_dcache_ed(td_list->ed);
1078 if (*phwHeadP & m32_swap(0x1)) {
1080 ((td_list->index + 1) < urb_len)) {
1082 (lurb_priv->td[urb_len - 1]->hwNextTD &\
1083 m32_swap(0xfffffff0)) |
1084 (*phwHeadP & m32_swap(0x2));
1086 lurb_priv->td_cnt += urb_len -
1089 *phwHeadP &= m32_swap(0xfffffff2);
1090 flush_dcache_ed(td_list->ed);
1092 #ifdef CONFIG_MPC5200
1093 td_list->hwNextTD = 0;
1094 flush_dcache_td(td_list);
1099 /* replies to the request have to be on a FIFO basis so
1100 * we reverse the reversed done-list */
1101 static td_t *dl_reverse_done_list(ohci_t *ohci)
1103 uintptr_t td_list_hc;
1104 td_t *td_rev = NULL;
1105 td_t *td_list = NULL;
1107 invalidate_dcache_hcca(ohci->hcca);
1108 td_list_hc = m32_swap(ohci->hcca->done_head) & 0xfffffff0;
1109 ohci->hcca->done_head = 0;
1110 flush_dcache_hcca(ohci->hcca);
1112 while (td_list_hc) {
1113 td_list = (td_t *)td_list_hc;
1114 invalidate_dcache_td(td_list);
1115 check_status(td_list);
1116 td_list->next_dl_td = td_rev;
1118 td_list_hc = m32_swap(td_list->hwNextTD) & 0xfffffff0;
1123 /*-------------------------------------------------------------------------*/
1124 /*-------------------------------------------------------------------------*/
1126 static void finish_urb(ohci_t *ohci, urb_priv_t *urb, int status)
1128 if ((status & (ED_OPER | ED_UNLINK)) && (urb->state != URB_DEL))
1131 dbg("finish_urb: strange.., ED state %x, \n", status);
1135 * Used to take back a TD from the host controller. This would normally be
1136 * called from within dl_done_list, however it may be called directly if the
1137 * HC no longer sees the TD and it has not appeared on the donelist (after
1138 * two frames). This bug has been observed on ZF Micro systems.
1140 static int takeback_td(ohci_t *ohci, td_t *td_list)
1146 urb_priv_t *lurb_priv;
1147 __u32 tdINFO, edHeadP, edTailP;
1149 invalidate_dcache_td(td_list);
1150 tdINFO = m32_swap(td_list->hwINFO);
1153 lurb_priv = ed->purb;
1155 dl_transfer_length(td_list);
1157 lurb_priv->td_cnt++;
1159 /* error code of transfer */
1160 cc = TD_CC_GET(tdINFO);
1162 err("USB-error: %s (%x)", cc_to_string[cc], cc);
1163 stat = cc_to_error[cc];
1166 /* see if this done list makes for all TD's of current URB,
1167 * and mark the URB finished if so */
1168 if (lurb_priv->td_cnt == lurb_priv->length)
1169 finish_urb(ohci, lurb_priv, ed->state);
1171 dbg("dl_done_list: processing TD %x, len %x\n",
1172 lurb_priv->td_cnt, lurb_priv->length);
1174 if (ed->state != ED_NEW && (!usb_pipeint(lurb_priv->pipe))) {
1175 invalidate_dcache_ed(ed);
1176 edHeadP = m32_swap(ed->hwHeadP) & 0xfffffff0;
1177 edTailP = m32_swap(ed->hwTailP);
1179 /* unlink eds if they are not busy */
1180 if ((edHeadP == edTailP) && (ed->state == ED_OPER))
1181 ep_unlink(ohci, ed);
1186 static int dl_done_list(ohci_t *ohci)
1189 td_t *td_list = dl_reverse_done_list(ohci);
1192 td_t *td_next = td_list->next_dl_td;
1193 stat = takeback_td(ohci, td_list);
1199 /*-------------------------------------------------------------------------*
1201 *-------------------------------------------------------------------------*/
1203 #include <usbroothubdes.h>
1205 /* Hub class-specific descriptor is constructed dynamically */
1207 /*-------------------------------------------------------------------------*/
1209 #define OK(x) len = (x); break
1211 #define WR_RH_STAT(x) {info("WR:status %#8x", (x)); ohci_writel((x), \
1212 &ohci->regs->roothub.status); }
1213 #define WR_RH_PORTSTAT(x) {info("WR:portstatus[%d] %#8x", wIndex-1, \
1214 (x)); ohci_writel((x), &ohci->regs->roothub.portstatus[wIndex-1]); }
1216 #define WR_RH_STAT(x) ohci_writel((x), &ohci->regs->roothub.status)
1217 #define WR_RH_PORTSTAT(x) ohci_writel((x), \
1218 &ohci->regs->roothub.portstatus[wIndex-1])
1220 #define RD_RH_STAT roothub_status(ohci)
1221 #define RD_RH_PORTSTAT roothub_portstatus(ohci, wIndex-1)
1223 /* request to virtual root hub */
1225 int rh_check_port_status(ohci_t *controller)
1231 temp = roothub_a(controller);
1232 ndp = (temp & RH_A_NDP);
1233 #ifdef CONFIG_AT91C_PQFP_UHPBUG
1234 ndp = (ndp == 2) ? 1:0;
1236 for (i = 0; i < ndp; i++) {
1237 temp = roothub_portstatus(controller, i);
1238 /* check for a device disconnect */
1239 if (((temp & (RH_PS_PESC | RH_PS_CSC)) ==
1240 (RH_PS_PESC | RH_PS_CSC)) &&
1241 ((temp & RH_PS_CCS) == 0)) {
1249 static int ohci_submit_rh_msg(ohci_t *ohci, struct usb_device *dev,
1250 unsigned long pipe, void *buffer, int transfer_len,
1251 struct devrequest *cmd)
1253 void *data = buffer;
1254 int leni = transfer_len;
1261 ALLOC_ALIGN_BUFFER(__u8, databuf, 16, sizeof(u32));
1264 pkt_print(ohci, NULL, dev, pipe, buffer, transfer_len,
1265 cmd, "SUB(rh)", usb_pipein(pipe));
1269 if (usb_pipeint(pipe)) {
1270 info("Root-Hub submit IRQ: NOT implemented");
1274 bmRType_bReq = cmd->requesttype | (cmd->request << 8);
1275 wValue = le16_to_cpu(cmd->value);
1276 wIndex = le16_to_cpu(cmd->index);
1277 wLength = le16_to_cpu(cmd->length);
1279 info("Root-Hub: adr: %2x cmd(%1x): %08x %04x %04x %04x",
1280 dev->devnum, 8, bmRType_bReq, wValue, wIndex, wLength);
1282 switch (bmRType_bReq) {
1283 /* Request Destination:
1284 without flags: Device,
1285 RH_INTERFACE: interface,
1286 RH_ENDPOINT: endpoint,
1287 RH_CLASS means HUB here,
1288 RH_OTHER | RH_CLASS almost ever means HUB_PORT here
1292 *(u16 *)databuf = cpu_to_le16(1);
1294 case RH_GET_STATUS | RH_INTERFACE:
1295 *(u16 *)databuf = cpu_to_le16(0);
1297 case RH_GET_STATUS | RH_ENDPOINT:
1298 *(u16 *)databuf = cpu_to_le16(0);
1300 case RH_GET_STATUS | RH_CLASS:
1301 *(u32 *)databuf = cpu_to_le32(
1302 RD_RH_STAT & ~(RH_HS_CRWE | RH_HS_DRWE));
1304 case RH_GET_STATUS | RH_OTHER | RH_CLASS:
1305 *(u32 *)databuf = cpu_to_le32(RD_RH_PORTSTAT);
1308 case RH_CLEAR_FEATURE | RH_ENDPOINT:
1310 case (RH_ENDPOINT_STALL):
1315 case RH_CLEAR_FEATURE | RH_CLASS:
1317 case RH_C_HUB_LOCAL_POWER:
1319 case (RH_C_HUB_OVER_CURRENT):
1320 WR_RH_STAT(RH_HS_OCIC);
1325 case RH_CLEAR_FEATURE | RH_OTHER | RH_CLASS:
1327 case (RH_PORT_ENABLE): WR_RH_PORTSTAT(RH_PS_CCS); OK(0);
1328 case (RH_PORT_SUSPEND): WR_RH_PORTSTAT(RH_PS_POCI); OK(0);
1329 case (RH_PORT_POWER): WR_RH_PORTSTAT(RH_PS_LSDA); OK(0);
1330 case (RH_C_PORT_CONNECTION): WR_RH_PORTSTAT(RH_PS_CSC); OK(0);
1331 case (RH_C_PORT_ENABLE): WR_RH_PORTSTAT(RH_PS_PESC); OK(0);
1332 case (RH_C_PORT_SUSPEND): WR_RH_PORTSTAT(RH_PS_PSSC); OK(0);
1333 case (RH_C_PORT_OVER_CURRENT):WR_RH_PORTSTAT(RH_PS_OCIC); OK(0);
1334 case (RH_C_PORT_RESET): WR_RH_PORTSTAT(RH_PS_PRSC); OK(0);
1338 case RH_SET_FEATURE | RH_OTHER | RH_CLASS:
1340 case (RH_PORT_SUSPEND):
1341 WR_RH_PORTSTAT(RH_PS_PSS); OK(0);
1342 case (RH_PORT_RESET): /* BUG IN HUP CODE *********/
1343 if (RD_RH_PORTSTAT & RH_PS_CCS)
1344 WR_RH_PORTSTAT(RH_PS_PRS);
1346 case (RH_PORT_POWER):
1347 WR_RH_PORTSTAT(RH_PS_PPS);
1349 case (RH_PORT_ENABLE): /* BUG IN HUP CODE *********/
1350 if (RD_RH_PORTSTAT & RH_PS_CCS)
1351 WR_RH_PORTSTAT(RH_PS_PES);
1356 case RH_SET_ADDRESS:
1357 ohci->rh.devnum = wValue;
1360 case RH_GET_DESCRIPTOR:
1361 switch ((wValue & 0xff00) >> 8) {
1362 case (0x01): /* device descriptor */
1363 len = min_t(unsigned int,
1366 sizeof(root_hub_dev_des),
1368 databuf = root_hub_dev_des; OK(len);
1369 case (0x02): /* configuration descriptor */
1370 len = min_t(unsigned int,
1373 sizeof(root_hub_config_des),
1375 databuf = root_hub_config_des; OK(len);
1376 case (0x03): /* string descriptors */
1377 if (wValue == 0x0300) {
1378 len = min_t(unsigned int,
1381 sizeof(root_hub_str_index0),
1383 databuf = root_hub_str_index0;
1386 if (wValue == 0x0301) {
1387 len = min_t(unsigned int,
1390 sizeof(root_hub_str_index1),
1392 databuf = root_hub_str_index1;
1396 stat = USB_ST_STALLED;
1400 case RH_GET_DESCRIPTOR | RH_CLASS:
1402 __u32 temp = roothub_a(ohci);
1404 databuf[0] = 9; /* min length; */
1406 databuf[2] = temp & RH_A_NDP;
1407 #ifdef CONFIG_AT91C_PQFP_UHPBUG
1408 databuf[2] = (databuf[2] == 2) ? 1 : 0;
1411 if (temp & RH_A_PSM) /* per-port power switching? */
1413 if (temp & RH_A_NOCP) /* no overcurrent reporting? */
1415 else if (temp & RH_A_OCPM)/* per-port overcurrent reporting? */
1419 databuf[5] = (temp & RH_A_POTPGT) >> 24;
1421 temp = roothub_b(ohci);
1422 databuf[7] = temp & RH_B_DR;
1423 if (databuf[2] < 7) {
1427 databuf[8] = (temp & RH_B_DR) >> 8;
1428 databuf[10] = databuf[9] = 0xff;
1431 len = min_t(unsigned int, leni,
1432 min_t(unsigned int, databuf[0], wLength));
1436 case RH_GET_CONFIGURATION:
1440 case RH_SET_CONFIGURATION:
1441 WR_RH_STAT(0x10000);
1445 dbg("unsupported root hub command");
1446 stat = USB_ST_STALLED;
1450 ohci_dump_roothub(ohci, 1);
1455 len = min_t(int, len, leni);
1456 if (data != databuf)
1457 memcpy(data, databuf, len);
1462 pkt_print(ohci, NULL, dev, pipe, buffer,
1463 transfer_len, cmd, "RET(rh)", 0/*usb_pipein(pipe)*/);
1471 /*-------------------------------------------------------------------------*/
1473 static ohci_dev_t *ohci_get_ohci_dev(ohci_t *ohci, int devnum, int intr)
1478 return &ohci->ohci_dev;
1480 /* First see if we already have an ohci_dev for this dev. */
1481 for (i = 0; i < NUM_INT_DEVS; i++) {
1482 if (ohci->int_dev[i].devnum == devnum)
1483 return &ohci->int_dev[i];
1486 /* If not then find a free one. */
1487 for (i = 0; i < NUM_INT_DEVS; i++) {
1488 if (ohci->int_dev[i].devnum == -1) {
1489 ohci->int_dev[i].devnum = devnum;
1490 return &ohci->int_dev[i];
1494 printf("ohci: Error out of ohci_devs for interrupt endpoints\n");
1498 /* common code for handling submit messages - used for all but root hub */
1500 static urb_priv_t *ohci_alloc_urb(struct usb_device *dev, unsigned long pipe,
1501 void *buffer, int transfer_len, int interval)
1505 urb = calloc(1, sizeof(urb_priv_t));
1507 printf("ohci: Error out of memory allocating urb\n");
1513 urb->transfer_buffer = buffer;
1514 urb->transfer_buffer_length = transfer_len;
1515 urb->interval = interval;
1520 static int submit_common_msg(ohci_t *ohci, struct usb_device *dev,
1521 unsigned long pipe, void *buffer, int transfer_len,
1522 struct devrequest *setup, int interval)
1525 int maxsize = usb_maxpacket(dev, pipe);
1528 ohci_dev_t *ohci_dev;
1530 urb = ohci_alloc_urb(dev, pipe, buffer, transfer_len, interval);
1535 urb->actual_length = 0;
1536 pkt_print(ohci, urb, dev, pipe, buffer, transfer_len,
1537 setup, "SUB", usb_pipein(pipe));
1542 err("submit_common_message: pipesize for pipe %lx is zero",
1547 ohci_dev = ohci_get_ohci_dev(ohci, dev->devnum, usb_pipeint(pipe));
1551 if (sohci_submit_job(ohci, ohci_dev, urb, setup) < 0) {
1552 err("sohci_submit_job failed");
1558 /* ohci_dump_status(ohci); */
1561 timeout = USB_TIMEOUT_MS(pipe);
1563 /* wait for it to complete */
1565 /* check whether the controller is done */
1566 stat = hc_interrupt(ohci);
1568 stat = USB_ST_CRC_ERR;
1572 /* NOTE: since we are not interrupt driven in U-Boot and always
1573 * handle only one URB at a time, we cannot assume the
1574 * transaction finished on the first successful return from
1575 * hc_interrupt().. unless the flag for current URB is set,
1576 * meaning that all TD's to/from device got actually
1577 * transferred and processed. If the current URB is not
1578 * finished we need to re-iterate this loop so as
1579 * hc_interrupt() gets called again as there needs to be some
1580 * more TD's to process still */
1581 if ((stat >= 0) && (stat != 0xff) && (urb->finished)) {
1582 /* 0xff is returned for an SF-interrupt */
1592 if (!usb_pipeint(pipe))
1593 err("CTL:TIMEOUT ");
1594 dbg("submit_common_msg: TO status %x\n", stat);
1596 stat = USB_ST_CRC_ERR;
1602 dev->act_len = urb->actual_length;
1604 if (usb_pipein(pipe) && dev->status == 0 && dev->act_len)
1605 invalidate_dcache_buffer(buffer, dev->act_len);
1608 pkt_print(ohci, urb, dev, pipe, buffer, transfer_len,
1609 setup, "RET(ctlr)", usb_pipein(pipe));
1617 #define MAX_INT_QUEUESIZE 8
1622 urb_priv_t *urb[MAX_INT_QUEUESIZE];
1625 static struct int_queue *_ohci_create_int_queue(ohci_t *ohci,
1626 struct usb_device *udev, unsigned long pipe, int queuesize,
1627 int elementsize, void *buffer, int interval)
1629 struct int_queue *queue;
1630 ohci_dev_t *ohci_dev;
1633 if (queuesize > MAX_INT_QUEUESIZE)
1636 ohci_dev = ohci_get_ohci_dev(ohci, udev->devnum, 1);
1640 queue = malloc(sizeof(*queue));
1642 printf("ohci: Error out of memory allocating int queue\n");
1646 for (i = 0; i < queuesize; i++) {
1647 queue->urb[i] = ohci_alloc_urb(udev, pipe,
1648 buffer + i * elementsize,
1649 elementsize, interval);
1653 if (sohci_submit_job(ohci, ohci_dev, queue->urb[i], NULL)) {
1654 printf("ohci: Error submitting int queue job\n");
1655 urb_free_priv(queue->urb[i]);
1660 /* We did not succeed in submitting even 1 urb */
1665 queue->queuesize = i;
1666 queue->curr_urb = 0;
1671 static void *_ohci_poll_int_queue(ohci_t *ohci, struct usb_device *udev,
1672 struct int_queue *queue)
1674 if (queue->curr_urb == queue->queuesize)
1675 return NULL; /* Queue depleted */
1677 if (hc_interrupt(ohci) < 0)
1680 if (queue->urb[queue->curr_urb]->finished) {
1681 void *ret = queue->urb[queue->curr_urb]->transfer_buffer;
1689 static int _ohci_destroy_int_queue(ohci_t *ohci, struct usb_device *dev,
1690 struct int_queue *queue)
1694 for (i = 0; i < queue->queuesize; i++)
1695 urb_free_priv(queue->urb[i]);
1702 #ifndef CONFIG_DM_USB
1703 /* submit routines called from usb.c */
1704 int submit_bulk_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
1707 info("submit_bulk_msg");
1708 return submit_common_msg(&gohci, dev, pipe, buffer, transfer_len,
1712 int submit_int_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
1713 int transfer_len, int interval)
1715 info("submit_int_msg");
1716 return submit_common_msg(&gohci, dev, pipe, buffer, transfer_len, NULL,
1720 struct int_queue *create_int_queue(struct usb_device *dev,
1721 unsigned long pipe, int queuesize, int elementsize,
1722 void *buffer, int interval)
1724 return _ohci_create_int_queue(&gohci, dev, pipe, queuesize,
1725 elementsize, buffer, interval);
1728 void *poll_int_queue(struct usb_device *dev, struct int_queue *queue)
1730 return _ohci_poll_int_queue(&gohci, dev, queue);
1733 int destroy_int_queue(struct usb_device *dev, struct int_queue *queue)
1735 return _ohci_destroy_int_queue(&gohci, dev, queue);
1739 static int _ohci_submit_control_msg(ohci_t *ohci, struct usb_device *dev,
1740 unsigned long pipe, void *buffer, int transfer_len,
1741 struct devrequest *setup)
1743 int maxsize = usb_maxpacket(dev, pipe);
1745 info("submit_control_msg");
1747 pkt_print(ohci, NULL, dev, pipe, buffer, transfer_len,
1748 setup, "SUB", usb_pipein(pipe));
1753 err("submit_control_message: pipesize for pipe %lx is zero",
1757 if (((pipe >> 8) & 0x7f) == ohci->rh.devnum) {
1759 /* root hub - redirect */
1760 return ohci_submit_rh_msg(ohci, dev, pipe, buffer,
1761 transfer_len, setup);
1764 return submit_common_msg(ohci, dev, pipe, buffer, transfer_len,
1768 /*-------------------------------------------------------------------------*
1770 *-------------------------------------------------------------------------*/
1772 /* reset the HC and BUS */
1774 static int hc_reset(ohci_t *ohci)
1776 #ifdef CONFIG_PCI_EHCI_DEVNO
1780 int smm_timeout = 50; /* 0,5 sec */
1782 dbg("%s\n", __FUNCTION__);
1784 #ifdef CONFIG_PCI_EHCI_DEVNO
1786 * Some multi-function controllers (e.g. ISP1562) allow root hub
1787 * resetting via EHCI registers only.
1789 pdev = pci_find_devices(ehci_pci_ids, CONFIG_PCI_EHCI_DEVNO);
1794 pci_read_config_dword(pdev, PCI_BASE_ADDRESS_0, &base);
1795 base += EHCI_USBCMD_OFF;
1796 ohci_writel(ohci_readl(base) | EHCI_USBCMD_HCRESET, base);
1798 while (ohci_readl(base) & EHCI_USBCMD_HCRESET) {
1799 if (timeout-- <= 0) {
1800 printf("USB RootHub reset timed out!");
1806 printf("No EHCI func at %d index!\n", CONFIG_PCI_EHCI_DEVNO);
1808 if (ohci_readl(&ohci->regs->control) & OHCI_CTRL_IR) {
1809 /* SMM owns the HC, request ownership */
1810 ohci_writel(OHCI_OCR, &ohci->regs->cmdstatus);
1811 info("USB HC TakeOver from SMM");
1812 while (ohci_readl(&ohci->regs->control) & OHCI_CTRL_IR) {
1814 if (--smm_timeout == 0) {
1815 err("USB HC TakeOver failed!");
1821 /* Disable HC interrupts */
1822 ohci_writel(OHCI_INTR_MIE, &ohci->regs->intrdisable);
1824 dbg("USB HC reset_hc usb-%s: ctrl = 0x%X ;\n",
1826 ohci_readl(&ohci->regs->control));
1828 /* Reset USB (needed by some controllers) */
1829 ohci->hc_control = 0;
1830 ohci_writel(ohci->hc_control, &ohci->regs->control);
1832 /* HC Reset requires max 10 us delay */
1833 ohci_writel(OHCI_HCR, &ohci->regs->cmdstatus);
1834 while ((ohci_readl(&ohci->regs->cmdstatus) & OHCI_HCR) != 0) {
1835 if (--timeout == 0) {
1836 err("USB HC reset timed out!");
1844 /*-------------------------------------------------------------------------*/
1846 /* Start an OHCI controller, set the BUS operational
1848 * connect the virtual root hub */
1850 static int hc_start(ohci_t *ohci)
1853 unsigned int fminterval;
1857 for (i = 0; i < NUM_INT_DEVS; i++)
1858 ohci->int_dev[i].devnum = -1;
1860 /* Tell the controller where the control and bulk lists are
1861 * The lists are empty now. */
1863 ohci_writel(0, &ohci->regs->ed_controlhead);
1864 ohci_writel(0, &ohci->regs->ed_bulkhead);
1866 ohci_writel((uintptr_t)ohci->hcca,
1867 &ohci->regs->hcca); /* reset clears this */
1869 fminterval = 0x2edf;
1870 ohci_writel((fminterval * 9) / 10, &ohci->regs->periodicstart);
1871 fminterval |= ((((fminterval - 210) * 6) / 7) << 16);
1872 ohci_writel(fminterval, &ohci->regs->fminterval);
1873 ohci_writel(0x628, &ohci->regs->lsthresh);
1875 /* start controller operations */
1876 ohci->hc_control = OHCI_CONTROL_INIT | OHCI_USB_OPER;
1878 ohci_writel(ohci->hc_control, &ohci->regs->control);
1880 /* disable all interrupts */
1881 mask = (OHCI_INTR_SO | OHCI_INTR_WDH | OHCI_INTR_SF | OHCI_INTR_RD |
1882 OHCI_INTR_UE | OHCI_INTR_FNO | OHCI_INTR_RHSC |
1883 OHCI_INTR_OC | OHCI_INTR_MIE);
1884 ohci_writel(mask, &ohci->regs->intrdisable);
1885 /* clear all interrupts */
1886 mask &= ~OHCI_INTR_MIE;
1887 ohci_writel(mask, &ohci->regs->intrstatus);
1888 /* Choose the interrupts we care about now - but w/o MIE */
1889 mask = OHCI_INTR_RHSC | OHCI_INTR_UE | OHCI_INTR_WDH | OHCI_INTR_SO;
1890 ohci_writel(mask, &ohci->regs->intrenable);
1893 /* required for AMD-756 and some Mac platforms */
1894 ohci_writel((roothub_a(ohci) | RH_A_NPS) & ~RH_A_PSM,
1895 &ohci->regs->roothub.a);
1896 ohci_writel(RH_HS_LPSC, &ohci->regs->roothub.status);
1897 #endif /* OHCI_USE_NPS */
1899 /* connect the virtual root hub */
1900 ohci->rh.devnum = 0;
1905 /*-------------------------------------------------------------------------*/
1907 /* an interrupt happens */
1909 static int hc_interrupt(ohci_t *ohci)
1911 struct ohci_regs *regs = ohci->regs;
1915 invalidate_dcache_hcca(ohci->hcca);
1917 if ((ohci->hcca->done_head != 0) &&
1918 !(m32_swap(ohci->hcca->done_head) & 0x01)) {
1919 ints = OHCI_INTR_WDH;
1921 ints = ohci_readl(®s->intrstatus);
1922 if (ints == ~(u32)0) {
1924 err("%s device removed!", ohci->slot_name);
1927 ints &= ohci_readl(®s->intrenable);
1929 dbg("hc_interrupt: returning..\n");
1935 /* dbg("Interrupt: %x frame: %x", ints,
1936 le16_to_cpu(ohci->hcca->frame_no)); */
1938 if (ints & OHCI_INTR_RHSC)
1941 if (ints & OHCI_INTR_UE) {
1943 err("OHCI Unrecoverable Error, controller usb-%s disabled",
1945 /* e.g. due to PCI Master/Target Abort */
1952 /* FIXME: be optimistic, hope that bug won't repeat often. */
1953 /* Make some non-interrupt context restart the controller. */
1954 /* Count and limit the retries though; either hardware or */
1955 /* software errors can go forever... */
1960 if (ints & OHCI_INTR_WDH) {
1962 ohci_writel(OHCI_INTR_WDH, ®s->intrdisable);
1963 (void)ohci_readl(®s->intrdisable); /* flush */
1964 stat = dl_done_list(ohci);
1965 ohci_writel(OHCI_INTR_WDH, ®s->intrenable);
1966 (void)ohci_readl(®s->intrdisable); /* flush */
1969 if (ints & OHCI_INTR_SO) {
1970 dbg("USB Schedule overrun\n");
1971 ohci_writel(OHCI_INTR_SO, ®s->intrenable);
1975 /* FIXME: this assumes SOF (1/ms) interrupts don't get lost... */
1976 if (ints & OHCI_INTR_SF) {
1977 unsigned int frame = m16_swap(ohci->hcca->frame_no) & 1;
1979 ohci_writel(OHCI_INTR_SF, ®s->intrdisable);
1980 if (ohci->ed_rm_list[frame] != NULL)
1981 ohci_writel(OHCI_INTR_SF, ®s->intrenable);
1985 ohci_writel(ints, ®s->intrstatus);
1989 /*-------------------------------------------------------------------------*/
1991 #ifndef CONFIG_DM_USB
1993 /*-------------------------------------------------------------------------*/
1995 /* De-allocate all resources.. */
1997 static void hc_release_ohci(ohci_t *ohci)
1999 dbg("USB HC release ohci usb-%s", ohci->slot_name);
2001 if (!ohci->disabled)
2005 /*-------------------------------------------------------------------------*/
2008 * low level initalisation routine, called from usb.c
2010 static char ohci_inited = 0;
2012 int usb_lowlevel_init(int index, enum usb_init_type init, void **controller)
2014 #ifdef CONFIG_PCI_OHCI
2018 #ifdef CONFIG_SYS_USB_OHCI_CPU_INIT
2019 /* cpu dependant init */
2024 #ifdef CONFIG_SYS_USB_OHCI_BOARD_INIT
2025 /* board dependant init */
2026 if (board_usb_init(index, USB_INIT_HOST))
2029 memset(&gohci, 0, sizeof(ohci_t));
2031 /* align the storage */
2032 if ((__u32)&ghcca[0] & 0xff) {
2033 err("HCCA not aligned!!");
2036 gohci.hcca = &ghcca[0];
2037 info("aligned ghcca %p", gohci.hcca);
2038 memset(gohci.hcca, 0, sizeof(struct ohci_hcca));
2043 #ifdef CONFIG_PCI_OHCI
2044 pdev = pci_find_devices(ohci_pci_ids, CONFIG_PCI_OHCI_DEVNO);
2049 pci_read_config_word(pdev, PCI_VENDOR_ID, &vid);
2050 pci_read_config_word(pdev, PCI_DEVICE_ID, &did);
2051 printf("OHCI pci controller (%04x, %04x) found @(%d:%d:%d)\n",
2052 vid, did, (pdev >> 16) & 0xff,
2053 (pdev >> 11) & 0x1f, (pdev >> 8) & 0x7);
2054 pci_read_config_dword(pdev, PCI_BASE_ADDRESS_0, &base);
2055 printf("OHCI regs address 0x%08x\n", base);
2056 gohci.regs = (struct ohci_regs *)base;
2060 gohci.regs = (struct ohci_regs *)CONFIG_SYS_USB_OHCI_REGS_BASE;
2064 gohci.slot_name = CONFIG_SYS_USB_OHCI_SLOT_NAME;
2066 if (hc_reset (&gohci) < 0) {
2067 hc_release_ohci (&gohci);
2068 err ("can't reset usb-%s", gohci.slot_name);
2069 #ifdef CONFIG_SYS_USB_OHCI_BOARD_INIT
2070 /* board dependant cleanup */
2071 board_usb_cleanup(index, USB_INIT_HOST);
2074 #ifdef CONFIG_SYS_USB_OHCI_CPU_INIT
2075 /* cpu dependant cleanup */
2076 usb_cpu_init_fail();
2081 if (hc_start(&gohci) < 0) {
2082 err("can't start usb-%s", gohci.slot_name);
2083 hc_release_ohci(&gohci);
2084 /* Initialization failed */
2085 #ifdef CONFIG_SYS_USB_OHCI_BOARD_INIT
2086 /* board dependant cleanup */
2090 #ifdef CONFIG_SYS_USB_OHCI_CPU_INIT
2091 /* cpu dependant cleanup */
2098 ohci_dump(&gohci, 1);
2106 int usb_lowlevel_stop(int index)
2108 /* this gets called really early - before the controller has */
2109 /* even been initialized! */
2112 /* TODO release any interrupts, etc. */
2113 /* call hc_release_ohci() here ? */
2116 #ifdef CONFIG_SYS_USB_OHCI_BOARD_INIT
2117 /* board dependant cleanup */
2118 if (usb_board_stop())
2122 #ifdef CONFIG_SYS_USB_OHCI_CPU_INIT
2123 /* cpu dependant cleanup */
2127 /* This driver is no longer initialised. It needs a new low-level
2128 * init (board/cpu) before it can be used again. */
2133 int submit_control_msg(struct usb_device *dev, unsigned long pipe,
2134 void *buffer, int transfer_len, struct devrequest *setup)
2136 return _ohci_submit_control_msg(&gohci, dev, pipe, buffer,
2137 transfer_len, setup);
2141 #ifdef CONFIG_DM_USB
2142 static int ohci_submit_control_msg(struct udevice *dev, struct usb_device *udev,
2143 unsigned long pipe, void *buffer, int length,
2144 struct devrequest *setup)
2146 ohci_t *ohci = dev_get_priv(usb_get_bus(dev));
2148 return _ohci_submit_control_msg(ohci, udev, pipe, buffer,
2152 static int ohci_submit_bulk_msg(struct udevice *dev, struct usb_device *udev,
2153 unsigned long pipe, void *buffer, int length)
2155 ohci_t *ohci = dev_get_priv(usb_get_bus(dev));
2157 return submit_common_msg(ohci, udev, pipe, buffer, length, NULL, 0);
2160 static int ohci_submit_int_msg(struct udevice *dev, struct usb_device *udev,
2161 unsigned long pipe, void *buffer, int length,
2164 ohci_t *ohci = dev_get_priv(usb_get_bus(dev));
2166 return submit_common_msg(ohci, udev, pipe, buffer, length,
2170 static struct int_queue *ohci_create_int_queue(struct udevice *dev,
2171 struct usb_device *udev, unsigned long pipe, int queuesize,
2172 int elementsize, void *buffer, int interval)
2174 ohci_t *ohci = dev_get_priv(usb_get_bus(dev));
2176 return _ohci_create_int_queue(ohci, udev, pipe, queuesize, elementsize,
2180 static void *ohci_poll_int_queue(struct udevice *dev, struct usb_device *udev,
2181 struct int_queue *queue)
2183 ohci_t *ohci = dev_get_priv(usb_get_bus(dev));
2185 return _ohci_poll_int_queue(ohci, udev, queue);
2188 static int ohci_destroy_int_queue(struct udevice *dev, struct usb_device *udev,
2189 struct int_queue *queue)
2191 ohci_t *ohci = dev_get_priv(usb_get_bus(dev));
2193 return _ohci_destroy_int_queue(ohci, udev, queue);
2196 int ohci_register(struct udevice *dev, struct ohci_regs *regs)
2198 struct usb_bus_priv *priv = dev_get_uclass_priv(dev);
2199 ohci_t *ohci = dev_get_priv(dev);
2202 priv->desc_before_addr = true;
2205 ohci->hcca = memalign(256, sizeof(struct ohci_hcca));
2208 memset(ohci->hcca, 0, sizeof(struct ohci_hcca));
2209 flush_dcache_hcca(ohci->hcca);
2211 if (hc_reset(ohci) < 0)
2214 if (hc_start(ohci) < 0)
2217 reg = ohci_readl(®s->revision);
2218 printf("USB OHCI %x.%x\n", (reg >> 4) & 0xf, reg & 0xf);
2223 int ohci_deregister(struct udevice *dev)
2225 ohci_t *ohci = dev_get_priv(dev);
2227 if (hc_reset(ohci) < 0)
2235 struct dm_usb_ops ohci_usb_ops = {
2236 .control = ohci_submit_control_msg,
2237 .bulk = ohci_submit_bulk_msg,
2238 .interrupt = ohci_submit_int_msg,
2239 .create_int_queue = ohci_create_int_queue,
2240 .poll_int_queue = ohci_poll_int_queue,
2241 .destroy_int_queue = ohci_destroy_int_queue,