1 // SPDX-License-Identifier: GPL-2.0+
3 * URB OHCI HCD (Host Controller Driver) for USB on the AT91RM9200 and PCI bus.
5 * Interrupt support is added. Now, it has been tested
6 * on ULI1575 chip and works well with USB keyboard.
9 * Zhang Wei, Freescale Semiconductor, Inc. <wei.zhang@freescale.com>
12 * Gary Jennejohn, DENX Software Engineering <garyj@denx.de>
14 * Note: Much of this code has been derived from Linux 2.4
15 * (C) Copyright 1999 Roman Weissgaerber <weissg@vienna.at>
16 * (C) Copyright 2000-2002 David Brownell
18 * Modified for the MP2USB by (C) Copyright 2005 Eric Benard
19 * ebenard@eukrea.com - based on s3c24x0's driver
23 * 1 - Read doc/README.generic_usb_ohci
24 * 2 - this driver is intended for use with USB Mass Storage Devices
25 * (BBB) and USB keyboard. There is NO support for Isochronous pipes!
26 * 2 - when running on a PQFP208 AT91RM9200, define CONFIG_AT91C_PQFP_UHPBUG
27 * to activate workaround for bug #41 or this driver will NOT work!
31 #include <asm/byteorder.h>
35 #if defined(CONFIG_PCI_OHCI)
37 #if !defined(CONFIG_PCI_OHCI_DEVNO)
38 #define CONFIG_PCI_OHCI_DEVNO 0
48 #ifdef CONFIG_AT91RM9200
49 #include <asm/arch/hardware.h> /* needed for AT91_USB_HOST_BASE */
52 #if defined(CONFIG_CPU_ARM920T) || \
53 defined(CONFIG_PCI_OHCI) || \
54 defined(CONFIG_SYS_OHCI_USE_NPS)
55 # define OHCI_USE_NPS /* force NoPowerSwitching mode */
58 #undef OHCI_VERBOSE_DEBUG /* not always helpful */
61 #undef OHCI_FILL_TRACE
63 /* For initializing controller (mask in an HCFS mode too) */
64 #define OHCI_CONTROL_INIT \
65 (OHCI_CTRL_CBSR & 0x3) | OHCI_CTRL_IE | OHCI_CTRL_PLE
67 #if !CONFIG_IS_ENABLED(DM_USB)
68 #ifdef CONFIG_PCI_OHCI
69 static struct pci_device_id ohci_pci_ids[] = {
70 {0x10b9, 0x5237}, /* ULI1575 PCI OHCI module ids */
71 {0x1033, 0x0035}, /* NEC PCI OHCI module ids */
72 {0x1131, 0x1561}, /* Philips 1561 PCI OHCI module ids */
73 /* Please add supported PCI OHCI controller ids here */
79 #ifdef CONFIG_PCI_EHCI_DEVNO
80 static struct pci_device_id ehci_pci_ids[] = {
81 {0x1131, 0x1562}, /* Philips 1562 PCI EHCI module ids */
82 /* Please add supported PCI EHCI controller ids here */
88 #define dbg(format, arg...) printf("DEBUG: " format "\n", ## arg)
90 #define dbg(format, arg...) do {} while (0)
92 #define err(format, arg...) printf("ERROR: " format "\n", ## arg)
94 #define info(format, arg...) printf("INFO: " format "\n", ## arg)
96 #define info(format, arg...) do {} while (0)
99 #ifdef CONFIG_SYS_OHCI_BE_CONTROLLER
100 # define m16_swap(x) cpu_to_be16(x)
101 # define m32_swap(x) cpu_to_be32(x)
103 # define m16_swap(x) cpu_to_le16(x)
104 # define m32_swap(x) cpu_to_le32(x)
105 #endif /* CONFIG_SYS_OHCI_BE_CONTROLLER */
107 /* We really should do proper cache flushing everywhere */
108 #define flush_dcache_buffer(addr, size) \
109 flush_dcache_range((unsigned long)(addr), \
110 ALIGN((unsigned long)(addr) + size, ARCH_DMA_MINALIGN))
111 #define invalidate_dcache_buffer(addr, size) \
112 invalidate_dcache_range((unsigned long)(addr), \
113 ALIGN((unsigned long)(addr) + size, ARCH_DMA_MINALIGN))
115 /* Do not use sizeof(ed / td) as our ed / td structs contain extra members */
116 #define flush_dcache_ed(addr) flush_dcache_buffer(addr, 16)
117 #define flush_dcache_td(addr) flush_dcache_buffer(addr, 16)
118 #define flush_dcache_iso_td(addr) flush_dcache_buffer(addr, 32)
119 #define flush_dcache_hcca(addr) flush_dcache_buffer(addr, 256)
120 #define invalidate_dcache_ed(addr) invalidate_dcache_buffer(addr, 16)
121 #define invalidate_dcache_td(addr) invalidate_dcache_buffer(addr, 16)
122 #define invalidate_dcache_iso_td(addr) invalidate_dcache_buffer(addr, 32)
123 #define invalidate_dcache_hcca(addr) invalidate_dcache_buffer(addr, 256)
125 #if CONFIG_IS_ENABLED(DM_USB)
127 * The various ohci_mdelay(1) calls in the code seem unnecessary. We keep
128 * them around when building for older boards not yet converted to the dm
129 * just in case (to avoid regressions), for dm this turns them into nops.
131 #define ohci_mdelay(x)
133 #define ohci_mdelay(x) mdelay(x)
136 #if !CONFIG_IS_ENABLED(DM_USB)
139 /* this must be aligned to a 256 byte boundary */
140 struct ohci_hcca ghcca[1];
143 /* mapping of the OHCI CC status to error codes */
144 static int cc_to_error[16] = {
146 /* CRC Error */ USB_ST_CRC_ERR,
147 /* Bit Stuff */ USB_ST_BIT_ERR,
148 /* Data Togg */ USB_ST_CRC_ERR,
149 /* Stall */ USB_ST_STALLED,
151 /* PIDCheck */ USB_ST_BIT_ERR,
152 /* UnExpPID */ USB_ST_BIT_ERR,
153 /* DataOver */ USB_ST_BUF_ERR,
154 /* DataUnder */ USB_ST_BUF_ERR,
157 /* BufferOver */ USB_ST_BUF_ERR,
158 /* BuffUnder */ USB_ST_BUF_ERR,
163 static const char *cc_to_string[16] = {
165 "CRC: Last data packet from endpoint contained a CRC error.",
166 "BITSTUFFING: Last data packet from endpoint contained a bit " \
167 "stuffing violation",
168 "DATATOGGLEMISMATCH: Last packet from endpoint had data toggle PID\n" \
169 "that did not match the expected value.",
170 "STALL: TD was moved to the Done Queue because the endpoint returned" \
172 "DEVICENOTRESPONDING: Device did not respond to token (IN) or did\n" \
173 "not provide a handshake (OUT)",
174 "PIDCHECKFAILURE: Check bits on PID from endpoint failed on data PID\n"\
175 "(IN) or handshake (OUT)",
176 "UNEXPECTEDPID: Receive PID was not valid when encountered or PID\n" \
177 "value is not defined.",
178 "DATAOVERRUN: The amount of data returned by the endpoint exceeded\n" \
179 "either the size of the maximum data packet allowed\n" \
180 "from the endpoint (found in MaximumPacketSize field\n" \
181 "of ED) or the remaining buffer size.",
182 "DATAUNDERRUN: The endpoint returned less than MaximumPacketSize\n" \
183 "and that amount was not sufficient to fill the\n" \
187 "BUFFEROVERRUN: During an IN, HC received data from endpoint faster\n" \
188 "than it could be written to system memory",
189 "BUFFERUNDERRUN: During an OUT, HC could not retrieve data from\n" \
190 "system memory fast enough to keep up with data USB " \
192 "NOT ACCESSED: This code is set by software before the TD is placed" \
193 "on a list to be processed by the HC.(1)",
194 "NOT ACCESSED: This code is set by software before the TD is placed" \
195 "on a list to be processed by the HC.(2)",
198 static inline u32 roothub_a(struct ohci *hc)
199 { return ohci_readl(&hc->regs->roothub.a); }
200 static inline u32 roothub_b(struct ohci *hc)
201 { return ohci_readl(&hc->regs->roothub.b); }
202 static inline u32 roothub_status(struct ohci *hc)
203 { return ohci_readl(&hc->regs->roothub.status); }
204 static inline u32 roothub_portstatus(struct ohci *hc, int i)
205 { return ohci_readl(&hc->regs->roothub.portstatus[i]); }
207 /* forward declaration */
208 static int hc_interrupt(ohci_t *ohci);
209 static void td_submit_job(ohci_t *ohci, struct usb_device *dev,
210 unsigned long pipe, void *buffer, int transfer_len,
211 struct devrequest *setup, urb_priv_t *urb,
213 static int ep_link(ohci_t * ohci, ed_t * ed);
214 static int ep_unlink(ohci_t * ohci, ed_t * ed);
215 static ed_t *ep_add_ed(ohci_dev_t *ohci_dev, struct usb_device *usb_dev,
216 unsigned long pipe, int interval, int load);
218 /*-------------------------------------------------------------------------*/
221 static struct td *td_alloc(ohci_dev_t *ohci_dev, struct usb_device *usb_dev)
227 for (i = 0; i < NUM_TD; i++)
229 if (ohci_dev->tds[i].usb_dev == NULL)
231 td = &ohci_dev->tds[i];
232 td->usb_dev = usb_dev;
240 static inline void ed_free(struct ed *ed)
245 /*-------------------------------------------------------------------------*
246 * URB support functions
247 *-------------------------------------------------------------------------*/
249 /* free HCD-private data associated with this URB */
251 static void urb_free_priv(urb_priv_t *urb)
257 last = urb->length - 1;
259 for (i = 0; i <= last; i++) {
270 /*-------------------------------------------------------------------------*/
273 static int sohci_get_current_frame_number(ohci_t *ohci);
275 /* debug| print the main components of an URB
276 * small: 0) header + data packets 1) just header */
278 static void pkt_print(ohci_t *ohci, urb_priv_t *purb, struct usb_device *dev,
279 unsigned long pipe, void *buffer, int transfer_len,
280 struct devrequest *setup, char *str, int small)
282 dbg("%s URB:[%4x] dev:%2lu,ep:%2lu-%c,type:%s,len:%d/%d stat:%#lx",
284 sohci_get_current_frame_number(ohci),
285 usb_pipedevice(pipe),
286 usb_pipeendpoint(pipe),
287 usb_pipeout(pipe)? 'O': 'I',
288 usb_pipetype(pipe) < 2 ? \
289 (usb_pipeint(pipe)? "INTR": "ISOC"): \
290 (usb_pipecontrol(pipe)? "CTRL": "BULK"),
291 (purb ? purb->actual_length : 0),
292 transfer_len, dev->status);
293 #ifdef OHCI_VERBOSE_DEBUG
297 if (usb_pipecontrol(pipe)) {
298 printf(__FILE__ ": cmd(8):");
299 for (i = 0; i < 8 ; i++)
300 printf(" %02x", ((__u8 *) setup) [i]);
303 if (transfer_len > 0 && buffer) {
304 printf(__FILE__ ": data(%d/%d):",
305 (purb ? purb->actual_length : 0),
307 len = usb_pipeout(pipe)? transfer_len:
308 (purb ? purb->actual_length : 0);
309 for (i = 0; i < 16 && i < len; i++)
310 printf(" %02x", ((__u8 *) buffer) [i]);
311 printf("%s\n", i < len? "...": "");
317 /* just for debugging; prints non-empty branches of the int ed tree
318 * inclusive iso eds */
319 void ep_print_int_eds(ohci_t *ohci, char *str)
323 for (i = 0; i < 32; i++) {
325 ed_p = &(ohci->hcca->int_table [i]);
328 invalidate_dcache_ed(ed_p);
329 printf(__FILE__ ": %s branch int %2d(%2x):", str, i, i);
330 while (*ed_p != 0 && j--) {
331 ed_t *ed = (ed_t *)m32_swap(ed_p);
332 invalidate_dcache_ed(ed);
333 printf(" ed: %4x;", ed->hwINFO);
334 ed_p = &ed->hwNextED;
340 static void ohci_dump_intr_mask(char *label, __u32 mask)
342 dbg("%s: 0x%08x%s%s%s%s%s%s%s%s%s",
345 (mask & OHCI_INTR_MIE) ? " MIE" : "",
346 (mask & OHCI_INTR_OC) ? " OC" : "",
347 (mask & OHCI_INTR_RHSC) ? " RHSC" : "",
348 (mask & OHCI_INTR_FNO) ? " FNO" : "",
349 (mask & OHCI_INTR_UE) ? " UE" : "",
350 (mask & OHCI_INTR_RD) ? " RD" : "",
351 (mask & OHCI_INTR_SF) ? " SF" : "",
352 (mask & OHCI_INTR_WDH) ? " WDH" : "",
353 (mask & OHCI_INTR_SO) ? " SO" : ""
357 static void maybe_print_eds(char *label, __u32 value)
359 ed_t *edp = (ed_t *)value;
362 dbg("%s %08x", label, value);
363 invalidate_dcache_ed(edp);
364 dbg("%08x", edp->hwINFO);
365 dbg("%08x", edp->hwTailP);
366 dbg("%08x", edp->hwHeadP);
367 dbg("%08x", edp->hwNextED);
371 static char *hcfs2string(int state)
374 case OHCI_USB_RESET: return "reset";
375 case OHCI_USB_RESUME: return "resume";
376 case OHCI_USB_OPER: return "operational";
377 case OHCI_USB_SUSPEND: return "suspend";
382 /* dump control and status registers */
383 static void ohci_dump_status(ohci_t *controller)
385 struct ohci_regs *regs = controller->regs;
388 temp = ohci_readl(®s->revision) & 0xff;
390 dbg("spec %d.%d", (temp >> 4), (temp & 0x0f));
392 temp = ohci_readl(®s->control);
393 dbg("control: 0x%08x%s%s%s HCFS=%s%s%s%s%s CBSR=%d", temp,
394 (temp & OHCI_CTRL_RWE) ? " RWE" : "",
395 (temp & OHCI_CTRL_RWC) ? " RWC" : "",
396 (temp & OHCI_CTRL_IR) ? " IR" : "",
397 hcfs2string(temp & OHCI_CTRL_HCFS),
398 (temp & OHCI_CTRL_BLE) ? " BLE" : "",
399 (temp & OHCI_CTRL_CLE) ? " CLE" : "",
400 (temp & OHCI_CTRL_IE) ? " IE" : "",
401 (temp & OHCI_CTRL_PLE) ? " PLE" : "",
402 temp & OHCI_CTRL_CBSR
405 temp = ohci_readl(®s->cmdstatus);
406 dbg("cmdstatus: 0x%08x SOC=%d%s%s%s%s", temp,
407 (temp & OHCI_SOC) >> 16,
408 (temp & OHCI_OCR) ? " OCR" : "",
409 (temp & OHCI_BLF) ? " BLF" : "",
410 (temp & OHCI_CLF) ? " CLF" : "",
411 (temp & OHCI_HCR) ? " HCR" : ""
414 ohci_dump_intr_mask("intrstatus", ohci_readl(®s->intrstatus));
415 ohci_dump_intr_mask("intrenable", ohci_readl(®s->intrenable));
417 maybe_print_eds("ed_periodcurrent",
418 ohci_readl(®s->ed_periodcurrent));
420 maybe_print_eds("ed_controlhead", ohci_readl(®s->ed_controlhead));
421 maybe_print_eds("ed_controlcurrent",
422 ohci_readl(®s->ed_controlcurrent));
424 maybe_print_eds("ed_bulkhead", ohci_readl(®s->ed_bulkhead));
425 maybe_print_eds("ed_bulkcurrent", ohci_readl(®s->ed_bulkcurrent));
427 maybe_print_eds("donehead", ohci_readl(®s->donehead));
430 static void ohci_dump_roothub(ohci_t *controller, int verbose)
434 temp = roothub_a(controller);
435 ndp = (temp & RH_A_NDP);
436 #ifdef CONFIG_AT91C_PQFP_UHPBUG
437 ndp = (ndp == 2) ? 1:0;
440 dbg("roothub.a: %08x POTPGT=%d%s%s%s%s%s NDP=%d", temp,
441 ((temp & RH_A_POTPGT) >> 24) & 0xff,
442 (temp & RH_A_NOCP) ? " NOCP" : "",
443 (temp & RH_A_OCPM) ? " OCPM" : "",
444 (temp & RH_A_DT) ? " DT" : "",
445 (temp & RH_A_NPS) ? " NPS" : "",
446 (temp & RH_A_PSM) ? " PSM" : "",
449 temp = roothub_b(controller);
450 dbg("roothub.b: %08x PPCM=%04x DR=%04x",
452 (temp & RH_B_PPCM) >> 16,
455 temp = roothub_status(controller);
456 dbg("roothub.status: %08x%s%s%s%s%s%s",
458 (temp & RH_HS_CRWE) ? " CRWE" : "",
459 (temp & RH_HS_OCIC) ? " OCIC" : "",
460 (temp & RH_HS_LPSC) ? " LPSC" : "",
461 (temp & RH_HS_DRWE) ? " DRWE" : "",
462 (temp & RH_HS_OCI) ? " OCI" : "",
463 (temp & RH_HS_LPS) ? " LPS" : ""
467 for (i = 0; i < ndp; i++) {
468 temp = roothub_portstatus(controller, i);
469 dbg("roothub.portstatus [%d] = 0x%08x%s%s%s%s%s%s%s%s%s%s%s%s",
472 (temp & RH_PS_PRSC) ? " PRSC" : "",
473 (temp & RH_PS_OCIC) ? " OCIC" : "",
474 (temp & RH_PS_PSSC) ? " PSSC" : "",
475 (temp & RH_PS_PESC) ? " PESC" : "",
476 (temp & RH_PS_CSC) ? " CSC" : "",
478 (temp & RH_PS_LSDA) ? " LSDA" : "",
479 (temp & RH_PS_PPS) ? " PPS" : "",
480 (temp & RH_PS_PRS) ? " PRS" : "",
481 (temp & RH_PS_POCI) ? " POCI" : "",
482 (temp & RH_PS_PSS) ? " PSS" : "",
484 (temp & RH_PS_PES) ? " PES" : "",
485 (temp & RH_PS_CCS) ? " CCS" : ""
490 static void ohci_dump(ohci_t *controller, int verbose)
492 dbg("OHCI controller usb-%s state", controller->slot_name);
494 /* dumps some of the state we know about */
495 ohci_dump_status(controller);
497 ep_print_int_eds(controller, "hcca");
498 invalidate_dcache_hcca(controller->hcca);
499 dbg("hcca frame #%04x", controller->hcca->frame_no);
500 ohci_dump_roothub(controller, 1);
504 /*-------------------------------------------------------------------------*
505 * Interface functions (URB)
506 *-------------------------------------------------------------------------*/
508 /* get a transfer request */
510 int sohci_submit_job(ohci_t *ohci, ohci_dev_t *ohci_dev, urb_priv_t *urb,
511 struct devrequest *setup)
514 urb_priv_t *purb_priv = urb;
516 struct usb_device *dev = urb->dev;
517 unsigned long pipe = urb->pipe;
518 void *buffer = urb->transfer_buffer;
519 int transfer_len = urb->transfer_buffer_length;
520 int interval = urb->interval;
522 /* when controller's hung, permit only roothub cleanup attempts
523 * such as powering down ports */
524 if (ohci->disabled) {
525 err("sohci_submit_job: EPIPE");
529 /* we're about to begin a new transaction here so mark the
533 /* every endpoint has a ed, locate and fill it */
534 ed = ep_add_ed(ohci_dev, dev, pipe, interval, 1);
536 err("sohci_submit_job: ENOMEM");
540 /* for the private part of the URB we need the number of TDs (size) */
541 switch (usb_pipetype(pipe)) {
542 case PIPE_BULK: /* one TD for every 4096 Byte */
543 size = (transfer_len - 1) / 4096 + 1;
545 case PIPE_CONTROL:/* 1 TD for setup, 1 for ACK and 1 for every 4096 B */
546 size = (transfer_len == 0)? 2:
547 (transfer_len - 1) / 4096 + 3;
549 case PIPE_INTERRUPT: /* 1 TD */
556 if (size >= (N_URB_TD - 1)) {
557 err("need %d TDs, only have %d", size, N_URB_TD);
560 purb_priv->pipe = pipe;
562 /* fill the private part of the URB */
563 purb_priv->length = size;
565 purb_priv->actual_length = 0;
567 /* allocate the TDs */
568 /* note that td[0] was allocated in ep_add_ed */
569 for (i = 0; i < size; i++) {
570 purb_priv->td[i] = td_alloc(ohci_dev, dev);
571 if (!purb_priv->td[i]) {
572 purb_priv->length = i;
573 urb_free_priv(purb_priv);
574 err("sohci_submit_job: ENOMEM");
579 if (ed->state == ED_NEW || (ed->state & ED_DEL)) {
580 urb_free_priv(purb_priv);
581 err("sohci_submit_job: EINVAL");
585 /* link the ed into a chain if is not already */
586 if (ed->state != ED_OPER)
589 /* fill the TDs and link it to the ed */
590 td_submit_job(ohci, dev, pipe, buffer, transfer_len,
591 setup, purb_priv, interval);
596 /*-------------------------------------------------------------------------*/
599 /* tell us the current USB frame number */
600 static int sohci_get_current_frame_number(ohci_t *ohci)
602 invalidate_dcache_hcca(ohci->hcca);
603 return m16_swap(ohci->hcca->frame_no);
607 /*-------------------------------------------------------------------------*
608 * ED handling functions
609 *-------------------------------------------------------------------------*/
611 /* search for the right branch to insert an interrupt ed into the int tree
612 * do some load ballancing;
613 * returns the branch and
614 * sets the interval to interval = 2^integer (ld (interval)) */
616 static int ep_int_ballance(ohci_t *ohci, int interval, int load)
620 /* search for the least loaded interrupt endpoint
621 * branch of all 32 branches
623 for (i = 0; i < 32; i++)
624 if (ohci->ohci_int_load [branch] > ohci->ohci_int_load [i])
627 branch = branch % interval;
628 for (i = branch; i < 32; i += interval)
629 ohci->ohci_int_load [i] += load;
634 /*-------------------------------------------------------------------------*/
636 /* 2^int( ld (inter)) */
638 static int ep_2_n_interval(int inter)
641 for (i = 0; ((inter >> i) > 1) && (i < 5); i++);
645 /*-------------------------------------------------------------------------*/
647 /* the int tree is a binary tree
648 * in order to process it sequentially the indexes of the branches have to
649 * be mapped the mapping reverses the bits of a word of num_bits length */
650 static int ep_rev(int num_bits, int word)
654 for (i = 0; i < num_bits; i++)
655 wout |= (((word >> i) & 1) << (num_bits - i - 1));
659 /*-------------------------------------------------------------------------*
660 * ED handling functions
661 *-------------------------------------------------------------------------*/
663 /* link an ed into one of the HC chains */
665 static int ep_link(ohci_t *ohci, ed_t *edi)
667 volatile ed_t *ed = edi;
676 ed->int_interval = 0;
682 if (ohci->ed_controltail == NULL)
683 ohci_writel((uintptr_t)ed, &ohci->regs->ed_controlhead);
685 ohci->ed_controltail->hwNextED =
686 m32_swap((unsigned long)ed);
688 ed->ed_prev = ohci->ed_controltail;
689 if (!ohci->ed_controltail && !ohci->ed_rm_list[0] &&
690 !ohci->ed_rm_list[1] && !ohci->sleeping) {
691 ohci->hc_control |= OHCI_CTRL_CLE;
692 ohci_writel(ohci->hc_control, &ohci->regs->control);
694 ohci->ed_controltail = edi;
700 if (ohci->ed_bulktail == NULL)
701 ohci_writel((uintptr_t)ed, &ohci->regs->ed_bulkhead);
703 ohci->ed_bulktail->hwNextED =
704 m32_swap((unsigned long)ed);
706 ed->ed_prev = ohci->ed_bulktail;
707 if (!ohci->ed_bulktail && !ohci->ed_rm_list[0] &&
708 !ohci->ed_rm_list[1] && !ohci->sleeping) {
709 ohci->hc_control |= OHCI_CTRL_BLE;
710 ohci_writel(ohci->hc_control, &ohci->regs->control);
712 ohci->ed_bulktail = edi;
717 interval = ep_2_n_interval(ed->int_period);
718 ed->int_interval = interval;
719 int_branch = ep_int_ballance(ohci, interval, load);
720 ed->int_branch = int_branch;
722 for (i = 0; i < ep_rev(6, interval); i += inter) {
724 for (ed_p = &(ohci->hcca->int_table[\
725 ep_rev(5, i) + int_branch]);
727 (((ed_t *)ed_p)->int_interval >= interval);
728 ed_p = &(((ed_t *)ed_p)->hwNextED))
730 ((ed_t *)ed_p)->int_interval);
731 ed->hwNextED = *ed_p;
733 *ed_p = m32_swap((unsigned long)ed);
734 flush_dcache_hcca(ohci->hcca);
741 /*-------------------------------------------------------------------------*/
743 /* scan the periodic table to find and unlink this ED */
744 static void periodic_unlink(struct ohci *ohci, volatile struct ed *ed,
745 unsigned index, unsigned period)
747 __maybe_unused unsigned long aligned_ed_p;
749 for (; index < NUM_INTS; index += period) {
750 __u32 *ed_p = &ohci->hcca->int_table [index];
752 /* ED might have been unlinked through another path */
754 if (((struct ed *)(uintptr_t)
755 m32_swap((unsigned long)ed_p)) == ed) {
756 *ed_p = ed->hwNextED;
757 aligned_ed_p = (unsigned long)ed_p;
758 aligned_ed_p &= ~(ARCH_DMA_MINALIGN - 1);
759 flush_dcache_range(aligned_ed_p,
760 aligned_ed_p + ARCH_DMA_MINALIGN);
763 ed_p = &(((struct ed *)(uintptr_t)
764 m32_swap((unsigned long)ed_p))->hwNextED);
769 /* unlink an ed from one of the HC chains.
770 * just the link to the ed is unlinked.
771 * the link from the ed still points to another operational ed or 0
772 * so the HC can eventually finish the processing of the unlinked ed */
774 static int ep_unlink(ohci_t *ohci, ed_t *edi)
776 volatile ed_t *ed = edi;
779 ed->hwINFO |= m32_swap(OHCI_ED_SKIP);
784 if (ed->ed_prev == NULL) {
786 ohci->hc_control &= ~OHCI_CTRL_CLE;
787 ohci_writel(ohci->hc_control,
788 &ohci->regs->control);
790 ohci_writel(m32_swap(*((__u32 *)&ed->hwNextED)),
791 &ohci->regs->ed_controlhead);
793 ed->ed_prev->hwNextED = ed->hwNextED;
794 flush_dcache_ed(ed->ed_prev);
796 if (ohci->ed_controltail == ed) {
797 ohci->ed_controltail = ed->ed_prev;
799 ((ed_t *)(uintptr_t)m32_swap(
800 *((__u32 *)&ed->hwNextED)))->ed_prev = ed->ed_prev;
805 if (ed->ed_prev == NULL) {
807 ohci->hc_control &= ~OHCI_CTRL_BLE;
808 ohci_writel(ohci->hc_control,
809 &ohci->regs->control);
811 ohci_writel(m32_swap(*((__u32 *)&ed->hwNextED)),
812 &ohci->regs->ed_bulkhead);
814 ed->ed_prev->hwNextED = ed->hwNextED;
815 flush_dcache_ed(ed->ed_prev);
817 if (ohci->ed_bulktail == ed) {
818 ohci->ed_bulktail = ed->ed_prev;
820 ((ed_t *)(uintptr_t)m32_swap(
821 *((__u32 *)&ed->hwNextED)))->ed_prev = ed->ed_prev;
826 periodic_unlink(ohci, ed, 0, 1);
827 for (i = ed->int_branch; i < 32; i += ed->int_interval)
828 ohci->ohci_int_load[i] -= ed->int_load;
831 ed->state = ED_UNLINK;
835 /*-------------------------------------------------------------------------*/
837 /* add/reinit an endpoint; this should be done once at the
838 * usb_set_configuration command, but the USB stack is a little bit
839 * stateless so we do it at every transaction if the state of the ed
840 * is ED_NEW then a dummy td is added and the state is changed to
841 * ED_UNLINK in all other cases the state is left unchanged the ed
842 * info fields are setted anyway even though most of them should not
845 static ed_t *ep_add_ed(ohci_dev_t *ohci_dev, struct usb_device *usb_dev,
846 unsigned long pipe, int interval, int load)
852 ed = ed_ret = &ohci_dev->ed[(usb_pipeendpoint(pipe) << 1) |
853 (usb_pipecontrol(pipe)? 0: usb_pipeout(pipe))];
855 if ((ed->state & ED_DEL) || (ed->state & ED_URB_DEL)) {
856 err("ep_add_ed: pending delete");
857 /* pending delete request */
861 if (ed->state == ED_NEW) {
862 /* dummy td; end of td list for ed */
863 td = td_alloc(ohci_dev, usb_dev);
864 ed->hwTailP = m32_swap((unsigned long)td);
865 ed->hwHeadP = ed->hwTailP;
866 ed->state = ED_UNLINK;
867 ed->type = usb_pipetype(pipe);
871 ed->hwINFO = m32_swap(usb_pipedevice(pipe)
872 | usb_pipeendpoint(pipe) << 7
873 | (usb_pipeisoc(pipe)? 0x8000: 0)
874 | (usb_pipecontrol(pipe)? 0: \
875 (usb_pipeout(pipe)? 0x800: 0x1000))
876 | (usb_dev->speed == USB_SPEED_LOW) << 13
877 | usb_maxpacket(usb_dev, pipe) << 16);
879 if (ed->type == PIPE_INTERRUPT && ed->state == ED_UNLINK) {
880 ed->int_period = interval;
889 /*-------------------------------------------------------------------------*
890 * TD handling functions
891 *-------------------------------------------------------------------------*/
893 /* enqueue next TD for this URB (OHCI spec 5.2.8.2) */
895 static void td_fill(ohci_t *ohci, unsigned int info,
897 struct usb_device *dev, int index, urb_priv_t *urb_priv)
899 volatile td_t *td, *td_pt;
900 #ifdef OHCI_FILL_TRACE
904 if (index > urb_priv->length) {
905 err("index > length");
908 /* use this td as the next dummy */
909 td_pt = urb_priv->td [index];
911 flush_dcache_td(td_pt);
913 /* fill the old dummy TD */
914 td = urb_priv->td [index] =
916 (m32_swap(urb_priv->ed->hwTailP) & ~0xf);
918 td->ed = urb_priv->ed;
919 td->next_dl_td = NULL;
921 td->data = (uintptr_t)data;
922 #ifdef OHCI_FILL_TRACE
923 if (usb_pipebulk(urb_priv->pipe) && usb_pipeout(urb_priv->pipe)) {
924 for (i = 0; i < len; i++)
925 printf("td->data[%d] %#2x ", i, ((unsigned char *)td->data)[i]);
932 td->hwINFO = m32_swap(info);
933 td->hwCBP = m32_swap((unsigned long)data);
935 td->hwBE = m32_swap((unsigned long)(data + len - 1));
939 td->hwNextTD = m32_swap((unsigned long)td_pt);
942 /* append to queue */
943 td->ed->hwTailP = td->hwNextTD;
944 flush_dcache_ed(td->ed);
947 /*-------------------------------------------------------------------------*/
949 /* prepare all TDs of a transfer */
951 static void td_submit_job(ohci_t *ohci, struct usb_device *dev,
952 unsigned long pipe, void *buffer, int transfer_len,
953 struct devrequest *setup, urb_priv_t *urb,
956 int data_len = transfer_len;
960 unsigned int toggle = 0;
962 flush_dcache_buffer(buffer, data_len);
964 /* OHCI handles the DATA-toggles itself, we just use the USB-toggle
965 * bits for resetting */
966 if (usb_gettoggle(dev, usb_pipeendpoint(pipe), usb_pipeout(pipe))) {
967 toggle = TD_T_TOGGLE;
970 usb_settoggle(dev, usb_pipeendpoint(pipe),
971 usb_pipeout(pipe), 1);
979 switch (usb_pipetype(pipe)) {
981 info = usb_pipeout(pipe)?
982 TD_CC | TD_DP_OUT : TD_CC | TD_DP_IN ;
983 while (data_len > 4096) {
984 td_fill(ohci, info | (cnt? TD_T_TOGGLE:toggle),
985 data, 4096, dev, cnt, urb);
986 data += 4096; data_len -= 4096; cnt++;
988 info = usb_pipeout(pipe)?
989 TD_CC | TD_DP_OUT : TD_CC | TD_R | TD_DP_IN ;
990 td_fill(ohci, info | (cnt? TD_T_TOGGLE:toggle), data,
991 data_len, dev, cnt, urb);
994 if (!ohci->sleeping) {
995 /* start bulk list */
996 ohci_writel(OHCI_BLF, &ohci->regs->cmdstatus);
1002 info = TD_CC | TD_DP_SETUP | TD_T_DATA0;
1003 flush_dcache_buffer(setup, 8);
1004 td_fill(ohci, info, setup, 8, dev, cnt++, urb);
1006 /* Optional Data phase */
1008 info = usb_pipeout(pipe)?
1009 TD_CC | TD_R | TD_DP_OUT | TD_T_DATA1 :
1010 TD_CC | TD_R | TD_DP_IN | TD_T_DATA1;
1011 /* NOTE: mishandles transfers >8K, some >4K */
1012 td_fill(ohci, info, data, data_len, dev, cnt++, urb);
1016 info = (usb_pipeout(pipe) || data_len == 0) ?
1017 TD_CC | TD_DP_IN | TD_T_DATA1:
1018 TD_CC | TD_DP_OUT | TD_T_DATA1;
1019 td_fill(ohci, info, data, 0, dev, cnt++, urb);
1021 if (!ohci->sleeping) {
1022 /* start Control list */
1023 ohci_writel(OHCI_CLF, &ohci->regs->cmdstatus);
1027 case PIPE_INTERRUPT:
1028 info = usb_pipeout(urb->pipe)?
1029 TD_CC | TD_DP_OUT | toggle:
1030 TD_CC | TD_R | TD_DP_IN | toggle;
1031 td_fill(ohci, info, data, data_len, dev, cnt++, urb);
1034 if (urb->length != cnt)
1035 dbg("TD LENGTH %d != CNT %d", urb->length, cnt);
1038 /*-------------------------------------------------------------------------*
1039 * Done List handling functions
1040 *-------------------------------------------------------------------------*/
1042 /* calculate the transfer length and update the urb */
1044 static void dl_transfer_length(td_t *td)
1047 urb_priv_t *lurb_priv = td->ed->purb;
1049 tdBE = m32_swap(td->hwBE);
1050 tdCBP = m32_swap(td->hwCBP);
1052 if (!(usb_pipecontrol(lurb_priv->pipe) &&
1053 ((td->index == 0) || (td->index == lurb_priv->length - 1)))) {
1056 lurb_priv->actual_length += tdBE - td->data + 1;
1058 lurb_priv->actual_length += tdCBP - td->data;
1063 /*-------------------------------------------------------------------------*/
1064 static void check_status(td_t *td_list)
1066 urb_priv_t *lurb_priv = td_list->ed->purb;
1067 int urb_len = lurb_priv->length;
1068 __u32 *phwHeadP = &td_list->ed->hwHeadP;
1071 cc = TD_CC_GET(m32_swap(td_list->hwINFO));
1073 err(" USB-error: %s (%x)", cc_to_string[cc], cc);
1075 invalidate_dcache_ed(td_list->ed);
1076 if (*phwHeadP & m32_swap(0x1)) {
1078 ((td_list->index + 1) < urb_len)) {
1080 (lurb_priv->td[urb_len - 1]->hwNextTD &\
1081 m32_swap(0xfffffff0)) |
1082 (*phwHeadP & m32_swap(0x2));
1084 lurb_priv->td_cnt += urb_len -
1087 *phwHeadP &= m32_swap(0xfffffff2);
1088 flush_dcache_ed(td_list->ed);
1093 /* replies to the request have to be on a FIFO basis so
1094 * we reverse the reversed done-list */
1095 static td_t *dl_reverse_done_list(ohci_t *ohci)
1097 uintptr_t td_list_hc;
1098 td_t *td_rev = NULL;
1099 td_t *td_list = NULL;
1101 invalidate_dcache_hcca(ohci->hcca);
1102 td_list_hc = m32_swap(ohci->hcca->done_head) & 0xfffffff0;
1103 ohci->hcca->done_head = 0;
1104 flush_dcache_hcca(ohci->hcca);
1106 while (td_list_hc) {
1107 td_list = (td_t *)td_list_hc;
1108 invalidate_dcache_td(td_list);
1109 check_status(td_list);
1110 td_list->next_dl_td = td_rev;
1112 td_list_hc = m32_swap(td_list->hwNextTD) & 0xfffffff0;
1117 /*-------------------------------------------------------------------------*/
1118 /*-------------------------------------------------------------------------*/
1120 static void finish_urb(ohci_t *ohci, urb_priv_t *urb, int status)
1122 if ((status & (ED_OPER | ED_UNLINK)) && (urb->state != URB_DEL))
1125 dbg("finish_urb: strange.., ED state %x, \n", status);
1129 * Used to take back a TD from the host controller. This would normally be
1130 * called from within dl_done_list, however it may be called directly if the
1131 * HC no longer sees the TD and it has not appeared on the donelist (after
1132 * two frames). This bug has been observed on ZF Micro systems.
1134 static int takeback_td(ohci_t *ohci, td_t *td_list)
1140 urb_priv_t *lurb_priv;
1141 __u32 tdINFO, edHeadP, edTailP;
1143 invalidate_dcache_td(td_list);
1144 tdINFO = m32_swap(td_list->hwINFO);
1147 lurb_priv = ed->purb;
1149 dl_transfer_length(td_list);
1151 lurb_priv->td_cnt++;
1153 /* error code of transfer */
1154 cc = TD_CC_GET(tdINFO);
1156 err("USB-error: %s (%x)", cc_to_string[cc], cc);
1157 stat = cc_to_error[cc];
1160 /* see if this done list makes for all TD's of current URB,
1161 * and mark the URB finished if so */
1162 if (lurb_priv->td_cnt == lurb_priv->length)
1163 finish_urb(ohci, lurb_priv, ed->state);
1165 dbg("dl_done_list: processing TD %x, len %x\n",
1166 lurb_priv->td_cnt, lurb_priv->length);
1168 if (ed->state != ED_NEW && (!usb_pipeint(lurb_priv->pipe))) {
1169 invalidate_dcache_ed(ed);
1170 edHeadP = m32_swap(ed->hwHeadP) & 0xfffffff0;
1171 edTailP = m32_swap(ed->hwTailP);
1173 /* unlink eds if they are not busy */
1174 if ((edHeadP == edTailP) && (ed->state == ED_OPER))
1175 ep_unlink(ohci, ed);
1180 static int dl_done_list(ohci_t *ohci)
1183 td_t *td_list = dl_reverse_done_list(ohci);
1186 td_t *td_next = td_list->next_dl_td;
1187 stat = takeback_td(ohci, td_list);
1193 /*-------------------------------------------------------------------------*
1195 *-------------------------------------------------------------------------*/
1197 #include <usbroothubdes.h>
1199 /* Hub class-specific descriptor is constructed dynamically */
1201 /*-------------------------------------------------------------------------*/
1203 #define OK(x) len = (x); break
1205 #define WR_RH_STAT(x) {info("WR:status %#8x", (x)); ohci_writel((x), \
1206 &ohci->regs->roothub.status); }
1207 #define WR_RH_PORTSTAT(x) {info("WR:portstatus[%d] %#8x", wIndex-1, \
1208 (x)); ohci_writel((x), &ohci->regs->roothub.portstatus[wIndex-1]); }
1210 #define WR_RH_STAT(x) ohci_writel((x), &ohci->regs->roothub.status)
1211 #define WR_RH_PORTSTAT(x) ohci_writel((x), \
1212 &ohci->regs->roothub.portstatus[wIndex-1])
1214 #define RD_RH_STAT roothub_status(ohci)
1215 #define RD_RH_PORTSTAT roothub_portstatus(ohci, wIndex-1)
1217 /* request to virtual root hub */
1219 int rh_check_port_status(ohci_t *controller)
1225 temp = roothub_a(controller);
1226 ndp = (temp & RH_A_NDP);
1227 #ifdef CONFIG_AT91C_PQFP_UHPBUG
1228 ndp = (ndp == 2) ? 1:0;
1230 for (i = 0; i < ndp; i++) {
1231 temp = roothub_portstatus(controller, i);
1232 /* check for a device disconnect */
1233 if (((temp & (RH_PS_PESC | RH_PS_CSC)) ==
1234 (RH_PS_PESC | RH_PS_CSC)) &&
1235 ((temp & RH_PS_CCS) == 0)) {
1243 static int ohci_submit_rh_msg(ohci_t *ohci, struct usb_device *dev,
1244 unsigned long pipe, void *buffer, int transfer_len,
1245 struct devrequest *cmd)
1247 void *data = buffer;
1248 int leni = transfer_len;
1255 ALLOC_ALIGN_BUFFER(__u8, databuf, 16, sizeof(u32));
1258 pkt_print(ohci, NULL, dev, pipe, buffer, transfer_len,
1259 cmd, "SUB(rh)", usb_pipein(pipe));
1263 if (usb_pipeint(pipe)) {
1264 info("Root-Hub submit IRQ: NOT implemented");
1268 bmRType_bReq = cmd->requesttype | (cmd->request << 8);
1269 wValue = le16_to_cpu(cmd->value);
1270 wIndex = le16_to_cpu(cmd->index);
1271 wLength = le16_to_cpu(cmd->length);
1273 info("Root-Hub: adr: %2x cmd(%1x): %08x %04x %04x %04x",
1274 dev->devnum, 8, bmRType_bReq, wValue, wIndex, wLength);
1276 switch (bmRType_bReq) {
1277 /* Request Destination:
1278 without flags: Device,
1279 RH_INTERFACE: interface,
1280 RH_ENDPOINT: endpoint,
1281 RH_CLASS means HUB here,
1282 RH_OTHER | RH_CLASS almost ever means HUB_PORT here
1286 *(u16 *)databuf = cpu_to_le16(1);
1288 case RH_GET_STATUS | RH_INTERFACE:
1289 *(u16 *)databuf = cpu_to_le16(0);
1291 case RH_GET_STATUS | RH_ENDPOINT:
1292 *(u16 *)databuf = cpu_to_le16(0);
1294 case RH_GET_STATUS | RH_CLASS:
1295 *(u32 *)databuf = cpu_to_le32(
1296 RD_RH_STAT & ~(RH_HS_CRWE | RH_HS_DRWE));
1298 case RH_GET_STATUS | RH_OTHER | RH_CLASS:
1299 *(u32 *)databuf = cpu_to_le32(RD_RH_PORTSTAT);
1302 case RH_CLEAR_FEATURE | RH_ENDPOINT:
1304 case (RH_ENDPOINT_STALL):
1309 case RH_CLEAR_FEATURE | RH_CLASS:
1311 case RH_C_HUB_LOCAL_POWER:
1313 case (RH_C_HUB_OVER_CURRENT):
1314 WR_RH_STAT(RH_HS_OCIC);
1319 case RH_CLEAR_FEATURE | RH_OTHER | RH_CLASS:
1321 case (RH_PORT_ENABLE): WR_RH_PORTSTAT(RH_PS_CCS); OK(0);
1322 case (RH_PORT_SUSPEND): WR_RH_PORTSTAT(RH_PS_POCI); OK(0);
1323 case (RH_PORT_POWER): WR_RH_PORTSTAT(RH_PS_LSDA); OK(0);
1324 case (RH_C_PORT_CONNECTION): WR_RH_PORTSTAT(RH_PS_CSC); OK(0);
1325 case (RH_C_PORT_ENABLE): WR_RH_PORTSTAT(RH_PS_PESC); OK(0);
1326 case (RH_C_PORT_SUSPEND): WR_RH_PORTSTAT(RH_PS_PSSC); OK(0);
1327 case (RH_C_PORT_OVER_CURRENT):WR_RH_PORTSTAT(RH_PS_OCIC); OK(0);
1328 case (RH_C_PORT_RESET): WR_RH_PORTSTAT(RH_PS_PRSC); OK(0);
1332 case RH_SET_FEATURE | RH_OTHER | RH_CLASS:
1334 case (RH_PORT_SUSPEND):
1335 WR_RH_PORTSTAT(RH_PS_PSS); OK(0);
1336 case (RH_PORT_RESET): /* BUG IN HUP CODE *********/
1337 if (RD_RH_PORTSTAT & RH_PS_CCS)
1338 WR_RH_PORTSTAT(RH_PS_PRS);
1340 case (RH_PORT_POWER):
1341 WR_RH_PORTSTAT(RH_PS_PPS);
1343 case (RH_PORT_ENABLE): /* BUG IN HUP CODE *********/
1344 if (RD_RH_PORTSTAT & RH_PS_CCS)
1345 WR_RH_PORTSTAT(RH_PS_PES);
1350 case RH_SET_ADDRESS:
1351 ohci->rh.devnum = wValue;
1354 case RH_GET_DESCRIPTOR:
1355 switch ((wValue & 0xff00) >> 8) {
1356 case (0x01): /* device descriptor */
1357 len = min_t(unsigned int,
1360 sizeof(root_hub_dev_des),
1362 databuf = root_hub_dev_des; OK(len);
1363 case (0x02): /* configuration descriptor */
1364 len = min_t(unsigned int,
1367 sizeof(root_hub_config_des),
1369 databuf = root_hub_config_des; OK(len);
1370 case (0x03): /* string descriptors */
1371 if (wValue == 0x0300) {
1372 len = min_t(unsigned int,
1375 sizeof(root_hub_str_index0),
1377 databuf = root_hub_str_index0;
1380 if (wValue == 0x0301) {
1381 len = min_t(unsigned int,
1384 sizeof(root_hub_str_index1),
1386 databuf = root_hub_str_index1;
1390 stat = USB_ST_STALLED;
1394 case RH_GET_DESCRIPTOR | RH_CLASS:
1396 __u32 temp = roothub_a(ohci);
1398 databuf[0] = 9; /* min length; */
1400 databuf[2] = temp & RH_A_NDP;
1401 #ifdef CONFIG_AT91C_PQFP_UHPBUG
1402 databuf[2] = (databuf[2] == 2) ? 1 : 0;
1405 if (temp & RH_A_PSM) /* per-port power switching? */
1407 if (temp & RH_A_NOCP) /* no overcurrent reporting? */
1409 else if (temp & RH_A_OCPM)/* per-port overcurrent reporting? */
1413 databuf[5] = (temp & RH_A_POTPGT) >> 24;
1415 temp = roothub_b(ohci);
1416 databuf[7] = temp & RH_B_DR;
1417 if (databuf[2] < 7) {
1421 databuf[8] = (temp & RH_B_DR) >> 8;
1422 databuf[10] = databuf[9] = 0xff;
1425 len = min_t(unsigned int, leni,
1426 min_t(unsigned int, databuf[0], wLength));
1430 case RH_GET_CONFIGURATION:
1434 case RH_SET_CONFIGURATION:
1435 WR_RH_STAT(0x10000);
1439 dbg("unsupported root hub command");
1440 stat = USB_ST_STALLED;
1444 ohci_dump_roothub(ohci, 1);
1449 len = min_t(int, len, leni);
1450 if (data != databuf)
1451 memcpy(data, databuf, len);
1456 pkt_print(ohci, NULL, dev, pipe, buffer,
1457 transfer_len, cmd, "RET(rh)", 0/*usb_pipein(pipe)*/);
1465 /*-------------------------------------------------------------------------*/
1467 static ohci_dev_t *ohci_get_ohci_dev(ohci_t *ohci, int devnum, int intr)
1472 return &ohci->ohci_dev;
1474 /* First see if we already have an ohci_dev for this dev. */
1475 for (i = 0; i < NUM_INT_DEVS; i++) {
1476 if (ohci->int_dev[i].devnum == devnum)
1477 return &ohci->int_dev[i];
1480 /* If not then find a free one. */
1481 for (i = 0; i < NUM_INT_DEVS; i++) {
1482 if (ohci->int_dev[i].devnum == -1) {
1483 ohci->int_dev[i].devnum = devnum;
1484 return &ohci->int_dev[i];
1488 printf("ohci: Error out of ohci_devs for interrupt endpoints\n");
1492 /* common code for handling submit messages - used for all but root hub */
1494 static urb_priv_t *ohci_alloc_urb(struct usb_device *dev, unsigned long pipe,
1495 void *buffer, int transfer_len, int interval)
1499 urb = calloc(1, sizeof(urb_priv_t));
1501 printf("ohci: Error out of memory allocating urb\n");
1507 urb->transfer_buffer = buffer;
1508 urb->transfer_buffer_length = transfer_len;
1509 urb->interval = interval;
1514 static int submit_common_msg(ohci_t *ohci, struct usb_device *dev,
1515 unsigned long pipe, void *buffer, int transfer_len,
1516 struct devrequest *setup, int interval)
1519 int maxsize = usb_maxpacket(dev, pipe);
1522 ohci_dev_t *ohci_dev;
1524 urb = ohci_alloc_urb(dev, pipe, buffer, transfer_len, interval);
1529 urb->actual_length = 0;
1530 pkt_print(ohci, urb, dev, pipe, buffer, transfer_len,
1531 setup, "SUB", usb_pipein(pipe));
1536 err("submit_common_message: pipesize for pipe %lx is zero",
1541 ohci_dev = ohci_get_ohci_dev(ohci, dev->devnum, usb_pipeint(pipe));
1545 if (sohci_submit_job(ohci, ohci_dev, urb, setup) < 0) {
1546 err("sohci_submit_job failed");
1551 /* ohci_dump_status(ohci); */
1553 timeout = USB_TIMEOUT_MS(pipe);
1555 /* wait for it to complete */
1557 /* check whether the controller is done */
1558 stat = hc_interrupt(ohci);
1560 stat = USB_ST_CRC_ERR;
1564 /* NOTE: since we are not interrupt driven in U-Boot and always
1565 * handle only one URB at a time, we cannot assume the
1566 * transaction finished on the first successful return from
1567 * hc_interrupt().. unless the flag for current URB is set,
1568 * meaning that all TD's to/from device got actually
1569 * transferred and processed. If the current URB is not
1570 * finished we need to re-iterate this loop so as
1571 * hc_interrupt() gets called again as there needs to be some
1572 * more TD's to process still */
1573 if ((stat >= 0) && (stat != 0xff) && (urb->finished)) {
1574 /* 0xff is returned for an SF-interrupt */
1584 if (!usb_pipeint(pipe))
1585 err("CTL:TIMEOUT ");
1586 dbg("submit_common_msg: TO status %x\n", stat);
1588 stat = USB_ST_CRC_ERR;
1594 dev->act_len = urb->actual_length;
1596 if (usb_pipein(pipe) && dev->status == 0 && dev->act_len)
1597 invalidate_dcache_buffer(buffer, dev->act_len);
1600 pkt_print(ohci, urb, dev, pipe, buffer, transfer_len,
1601 setup, "RET(ctlr)", usb_pipein(pipe));
1609 #define MAX_INT_QUEUESIZE 8
1614 urb_priv_t *urb[MAX_INT_QUEUESIZE];
1617 static struct int_queue *_ohci_create_int_queue(ohci_t *ohci,
1618 struct usb_device *udev, unsigned long pipe, int queuesize,
1619 int elementsize, void *buffer, int interval)
1621 struct int_queue *queue;
1622 ohci_dev_t *ohci_dev;
1625 if (queuesize > MAX_INT_QUEUESIZE)
1628 ohci_dev = ohci_get_ohci_dev(ohci, udev->devnum, 1);
1632 queue = malloc(sizeof(*queue));
1634 printf("ohci: Error out of memory allocating int queue\n");
1638 for (i = 0; i < queuesize; i++) {
1639 queue->urb[i] = ohci_alloc_urb(udev, pipe,
1640 buffer + i * elementsize,
1641 elementsize, interval);
1645 if (sohci_submit_job(ohci, ohci_dev, queue->urb[i], NULL)) {
1646 printf("ohci: Error submitting int queue job\n");
1647 urb_free_priv(queue->urb[i]);
1652 /* We did not succeed in submitting even 1 urb */
1657 queue->queuesize = i;
1658 queue->curr_urb = 0;
1663 static void *_ohci_poll_int_queue(ohci_t *ohci, struct usb_device *udev,
1664 struct int_queue *queue)
1666 if (queue->curr_urb == queue->queuesize)
1667 return NULL; /* Queue depleted */
1669 if (hc_interrupt(ohci) < 0)
1672 if (queue->urb[queue->curr_urb]->finished) {
1673 void *ret = queue->urb[queue->curr_urb]->transfer_buffer;
1681 static int _ohci_destroy_int_queue(ohci_t *ohci, struct usb_device *dev,
1682 struct int_queue *queue)
1686 for (i = 0; i < queue->queuesize; i++)
1687 urb_free_priv(queue->urb[i]);
1694 #if !CONFIG_IS_ENABLED(DM_USB)
1695 /* submit routines called from usb.c */
1696 int submit_bulk_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
1699 info("submit_bulk_msg");
1700 return submit_common_msg(&gohci, dev, pipe, buffer, transfer_len,
1704 int submit_int_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
1705 int transfer_len, int interval)
1707 info("submit_int_msg");
1708 return submit_common_msg(&gohci, dev, pipe, buffer, transfer_len, NULL,
1712 struct int_queue *create_int_queue(struct usb_device *dev,
1713 unsigned long pipe, int queuesize, int elementsize,
1714 void *buffer, int interval)
1716 return _ohci_create_int_queue(&gohci, dev, pipe, queuesize,
1717 elementsize, buffer, interval);
1720 void *poll_int_queue(struct usb_device *dev, struct int_queue *queue)
1722 return _ohci_poll_int_queue(&gohci, dev, queue);
1725 int destroy_int_queue(struct usb_device *dev, struct int_queue *queue)
1727 return _ohci_destroy_int_queue(&gohci, dev, queue);
1731 static int _ohci_submit_control_msg(ohci_t *ohci, struct usb_device *dev,
1732 unsigned long pipe, void *buffer, int transfer_len,
1733 struct devrequest *setup)
1735 int maxsize = usb_maxpacket(dev, pipe);
1737 info("submit_control_msg");
1739 pkt_print(ohci, NULL, dev, pipe, buffer, transfer_len,
1740 setup, "SUB", usb_pipein(pipe));
1745 err("submit_control_message: pipesize for pipe %lx is zero",
1749 if (((pipe >> 8) & 0x7f) == ohci->rh.devnum) {
1751 /* root hub - redirect */
1752 return ohci_submit_rh_msg(ohci, dev, pipe, buffer,
1753 transfer_len, setup);
1756 return submit_common_msg(ohci, dev, pipe, buffer, transfer_len,
1760 /*-------------------------------------------------------------------------*
1762 *-------------------------------------------------------------------------*/
1764 /* reset the HC and BUS */
1766 static int hc_reset(ohci_t *ohci)
1768 #ifdef CONFIG_PCI_EHCI_DEVNO
1772 int smm_timeout = 50; /* 0,5 sec */
1774 dbg("%s\n", __FUNCTION__);
1776 #ifdef CONFIG_PCI_EHCI_DEVNO
1778 * Some multi-function controllers (e.g. ISP1562) allow root hub
1779 * resetting via EHCI registers only.
1781 pdev = pci_find_devices(ehci_pci_ids, CONFIG_PCI_EHCI_DEVNO);
1786 pci_read_config_dword(pdev, PCI_BASE_ADDRESS_0, &base);
1787 base += EHCI_USBCMD_OFF;
1788 ohci_writel(ohci_readl(base) | EHCI_USBCMD_HCRESET, base);
1790 while (ohci_readl(base) & EHCI_USBCMD_HCRESET) {
1791 if (timeout-- <= 0) {
1792 printf("USB RootHub reset timed out!");
1798 printf("No EHCI func at %d index!\n", CONFIG_PCI_EHCI_DEVNO);
1800 if (ohci_readl(&ohci->regs->control) & OHCI_CTRL_IR) {
1801 /* SMM owns the HC, request ownership */
1802 ohci_writel(OHCI_OCR, &ohci->regs->cmdstatus);
1803 info("USB HC TakeOver from SMM");
1804 while (ohci_readl(&ohci->regs->control) & OHCI_CTRL_IR) {
1806 if (--smm_timeout == 0) {
1807 err("USB HC TakeOver failed!");
1813 /* Disable HC interrupts */
1814 ohci_writel(OHCI_INTR_MIE, &ohci->regs->intrdisable);
1816 dbg("USB HC reset_hc usb-%s: ctrl = 0x%X ;\n",
1818 ohci_readl(&ohci->regs->control));
1820 /* Reset USB (needed by some controllers) */
1821 ohci->hc_control = 0;
1822 ohci_writel(ohci->hc_control, &ohci->regs->control);
1824 /* HC Reset requires max 10 us delay */
1825 ohci_writel(OHCI_HCR, &ohci->regs->cmdstatus);
1826 while ((ohci_readl(&ohci->regs->cmdstatus) & OHCI_HCR) != 0) {
1827 if (--timeout == 0) {
1828 err("USB HC reset timed out!");
1836 /*-------------------------------------------------------------------------*/
1838 /* Start an OHCI controller, set the BUS operational
1840 * connect the virtual root hub */
1842 static int hc_start(ohci_t *ohci)
1845 unsigned int fminterval;
1849 for (i = 0; i < NUM_INT_DEVS; i++)
1850 ohci->int_dev[i].devnum = -1;
1852 /* Tell the controller where the control and bulk lists are
1853 * The lists are empty now. */
1855 ohci_writel(0, &ohci->regs->ed_controlhead);
1856 ohci_writel(0, &ohci->regs->ed_bulkhead);
1858 ohci_writel((uintptr_t)ohci->hcca,
1859 &ohci->regs->hcca); /* reset clears this */
1861 fminterval = 0x2edf;
1862 ohci_writel((fminterval * 9) / 10, &ohci->regs->periodicstart);
1863 fminterval |= ((((fminterval - 210) * 6) / 7) << 16);
1864 ohci_writel(fminterval, &ohci->regs->fminterval);
1865 ohci_writel(0x628, &ohci->regs->lsthresh);
1867 /* start controller operations */
1868 ohci->hc_control = OHCI_CONTROL_INIT | OHCI_USB_OPER;
1870 ohci_writel(ohci->hc_control, &ohci->regs->control);
1872 /* disable all interrupts */
1873 mask = (OHCI_INTR_SO | OHCI_INTR_WDH | OHCI_INTR_SF | OHCI_INTR_RD |
1874 OHCI_INTR_UE | OHCI_INTR_FNO | OHCI_INTR_RHSC |
1875 OHCI_INTR_OC | OHCI_INTR_MIE);
1876 ohci_writel(mask, &ohci->regs->intrdisable);
1877 /* clear all interrupts */
1878 mask &= ~OHCI_INTR_MIE;
1879 ohci_writel(mask, &ohci->regs->intrstatus);
1880 /* Choose the interrupts we care about now - but w/o MIE */
1881 mask = OHCI_INTR_RHSC | OHCI_INTR_UE | OHCI_INTR_WDH | OHCI_INTR_SO;
1882 ohci_writel(mask, &ohci->regs->intrenable);
1885 /* required for AMD-756 and some Mac platforms */
1886 ohci_writel((roothub_a(ohci) | RH_A_NPS) & ~RH_A_PSM,
1887 &ohci->regs->roothub.a);
1888 ohci_writel(RH_HS_LPSC, &ohci->regs->roothub.status);
1889 #endif /* OHCI_USE_NPS */
1891 /* connect the virtual root hub */
1892 ohci->rh.devnum = 0;
1897 /*-------------------------------------------------------------------------*/
1899 /* an interrupt happens */
1901 static int hc_interrupt(ohci_t *ohci)
1903 struct ohci_regs *regs = ohci->regs;
1907 invalidate_dcache_hcca(ohci->hcca);
1909 if ((ohci->hcca->done_head != 0) &&
1910 !(m32_swap(ohci->hcca->done_head) & 0x01)) {
1911 ints = OHCI_INTR_WDH;
1913 ints = ohci_readl(®s->intrstatus);
1914 if (ints == ~(u32)0) {
1916 err("%s device removed!", ohci->slot_name);
1919 ints &= ohci_readl(®s->intrenable);
1921 dbg("hc_interrupt: returning..\n");
1927 /* dbg("Interrupt: %x frame: %x", ints,
1928 le16_to_cpu(ohci->hcca->frame_no)); */
1930 if (ints & OHCI_INTR_RHSC)
1933 if (ints & OHCI_INTR_UE) {
1935 err("OHCI Unrecoverable Error, controller usb-%s disabled",
1937 /* e.g. due to PCI Master/Target Abort */
1944 /* FIXME: be optimistic, hope that bug won't repeat often. */
1945 /* Make some non-interrupt context restart the controller. */
1946 /* Count and limit the retries though; either hardware or */
1947 /* software errors can go forever... */
1952 if (ints & OHCI_INTR_WDH) {
1954 ohci_writel(OHCI_INTR_WDH, ®s->intrdisable);
1955 (void)ohci_readl(®s->intrdisable); /* flush */
1956 stat = dl_done_list(ohci);
1957 ohci_writel(OHCI_INTR_WDH, ®s->intrenable);
1958 (void)ohci_readl(®s->intrdisable); /* flush */
1961 if (ints & OHCI_INTR_SO) {
1962 dbg("USB Schedule overrun\n");
1963 ohci_writel(OHCI_INTR_SO, ®s->intrenable);
1967 /* FIXME: this assumes SOF (1/ms) interrupts don't get lost... */
1968 if (ints & OHCI_INTR_SF) {
1969 unsigned int frame = m16_swap(ohci->hcca->frame_no) & 1;
1971 ohci_writel(OHCI_INTR_SF, ®s->intrdisable);
1972 if (ohci->ed_rm_list[frame] != NULL)
1973 ohci_writel(OHCI_INTR_SF, ®s->intrenable);
1977 ohci_writel(ints, ®s->intrstatus);
1981 /*-------------------------------------------------------------------------*/
1983 #if !CONFIG_IS_ENABLED(DM_USB)
1985 /*-------------------------------------------------------------------------*/
1987 /* De-allocate all resources.. */
1989 static void hc_release_ohci(ohci_t *ohci)
1991 dbg("USB HC release ohci usb-%s", ohci->slot_name);
1993 if (!ohci->disabled)
1997 /*-------------------------------------------------------------------------*/
2000 * low level initalisation routine, called from usb.c
2002 static char ohci_inited = 0;
2004 int usb_lowlevel_init(int index, enum usb_init_type init, void **controller)
2006 #ifdef CONFIG_PCI_OHCI
2010 #ifdef CONFIG_SYS_USB_OHCI_CPU_INIT
2011 /* cpu dependant init */
2016 #ifdef CONFIG_SYS_USB_OHCI_BOARD_INIT
2017 /* board dependant init */
2018 if (board_usb_init(index, USB_INIT_HOST))
2021 memset(&gohci, 0, sizeof(ohci_t));
2023 /* align the storage */
2024 if ((__u32)&ghcca[0] & 0xff) {
2025 err("HCCA not aligned!!");
2028 gohci.hcca = &ghcca[0];
2029 info("aligned ghcca %p", gohci.hcca);
2030 memset(gohci.hcca, 0, sizeof(struct ohci_hcca));
2035 #ifdef CONFIG_PCI_OHCI
2036 pdev = pci_find_devices(ohci_pci_ids, CONFIG_PCI_OHCI_DEVNO);
2041 pci_read_config_word(pdev, PCI_VENDOR_ID, &vid);
2042 pci_read_config_word(pdev, PCI_DEVICE_ID, &did);
2043 printf("OHCI pci controller (%04x, %04x) found @(%d:%d:%d)\n",
2044 vid, did, (pdev >> 16) & 0xff,
2045 (pdev >> 11) & 0x1f, (pdev >> 8) & 0x7);
2046 pci_read_config_dword(pdev, PCI_BASE_ADDRESS_0, &base);
2047 printf("OHCI regs address 0x%08x\n", base);
2048 gohci.regs = (struct ohci_regs *)base;
2052 gohci.regs = (struct ohci_regs *)CONFIG_SYS_USB_OHCI_REGS_BASE;
2056 gohci.slot_name = CONFIG_SYS_USB_OHCI_SLOT_NAME;
2058 if (hc_reset (&gohci) < 0) {
2059 hc_release_ohci (&gohci);
2060 err ("can't reset usb-%s", gohci.slot_name);
2061 #ifdef CONFIG_SYS_USB_OHCI_BOARD_INIT
2062 /* board dependant cleanup */
2063 board_usb_cleanup(index, USB_INIT_HOST);
2066 #ifdef CONFIG_SYS_USB_OHCI_CPU_INIT
2067 /* cpu dependant cleanup */
2068 usb_cpu_init_fail();
2073 if (hc_start(&gohci) < 0) {
2074 err("can't start usb-%s", gohci.slot_name);
2075 hc_release_ohci(&gohci);
2076 /* Initialization failed */
2077 #ifdef CONFIG_SYS_USB_OHCI_BOARD_INIT
2078 /* board dependant cleanup */
2082 #ifdef CONFIG_SYS_USB_OHCI_CPU_INIT
2083 /* cpu dependant cleanup */
2090 ohci_dump(&gohci, 1);
2098 int usb_lowlevel_stop(int index)
2100 /* this gets called really early - before the controller has */
2101 /* even been initialized! */
2104 /* TODO release any interrupts, etc. */
2105 /* call hc_release_ohci() here ? */
2108 #ifdef CONFIG_SYS_USB_OHCI_BOARD_INIT
2109 /* board dependant cleanup */
2110 if (usb_board_stop())
2114 #ifdef CONFIG_SYS_USB_OHCI_CPU_INIT
2115 /* cpu dependant cleanup */
2119 /* This driver is no longer initialised. It needs a new low-level
2120 * init (board/cpu) before it can be used again. */
2125 int submit_control_msg(struct usb_device *dev, unsigned long pipe,
2126 void *buffer, int transfer_len, struct devrequest *setup)
2128 return _ohci_submit_control_msg(&gohci, dev, pipe, buffer,
2129 transfer_len, setup);
2133 #if CONFIG_IS_ENABLED(DM_USB)
2134 static int ohci_submit_control_msg(struct udevice *dev, struct usb_device *udev,
2135 unsigned long pipe, void *buffer, int length,
2136 struct devrequest *setup)
2138 ohci_t *ohci = dev_get_priv(usb_get_bus(dev));
2140 return _ohci_submit_control_msg(ohci, udev, pipe, buffer,
2144 static int ohci_submit_bulk_msg(struct udevice *dev, struct usb_device *udev,
2145 unsigned long pipe, void *buffer, int length)
2147 ohci_t *ohci = dev_get_priv(usb_get_bus(dev));
2149 return submit_common_msg(ohci, udev, pipe, buffer, length, NULL, 0);
2152 static int ohci_submit_int_msg(struct udevice *dev, struct usb_device *udev,
2153 unsigned long pipe, void *buffer, int length,
2156 ohci_t *ohci = dev_get_priv(usb_get_bus(dev));
2158 return submit_common_msg(ohci, udev, pipe, buffer, length,
2162 static struct int_queue *ohci_create_int_queue(struct udevice *dev,
2163 struct usb_device *udev, unsigned long pipe, int queuesize,
2164 int elementsize, void *buffer, int interval)
2166 ohci_t *ohci = dev_get_priv(usb_get_bus(dev));
2168 return _ohci_create_int_queue(ohci, udev, pipe, queuesize, elementsize,
2172 static void *ohci_poll_int_queue(struct udevice *dev, struct usb_device *udev,
2173 struct int_queue *queue)
2175 ohci_t *ohci = dev_get_priv(usb_get_bus(dev));
2177 return _ohci_poll_int_queue(ohci, udev, queue);
2180 static int ohci_destroy_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_destroy_int_queue(ohci, udev, queue);
2188 int ohci_register(struct udevice *dev, struct ohci_regs *regs)
2190 struct usb_bus_priv *priv = dev_get_uclass_priv(dev);
2191 ohci_t *ohci = dev_get_priv(dev);
2194 priv->desc_before_addr = true;
2197 ohci->hcca = memalign(256, sizeof(struct ohci_hcca));
2200 memset(ohci->hcca, 0, sizeof(struct ohci_hcca));
2201 flush_dcache_hcca(ohci->hcca);
2203 if (hc_reset(ohci) < 0)
2206 if (hc_start(ohci) < 0)
2209 reg = ohci_readl(®s->revision);
2210 printf("USB OHCI %x.%x\n", (reg >> 4) & 0xf, reg & 0xf);
2215 int ohci_deregister(struct udevice *dev)
2217 ohci_t *ohci = dev_get_priv(dev);
2219 if (hc_reset(ohci) < 0)
2227 struct dm_usb_ops ohci_usb_ops = {
2228 .control = ohci_submit_control_msg,
2229 .bulk = ohci_submit_bulk_msg,
2230 .interrupt = ohci_submit_int_msg,
2231 .create_int_queue = ohci_create_int_queue,
2232 .poll_int_queue = ohci_poll_int_queue,
2233 .destroy_int_queue = ohci_destroy_int_queue,