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>
34 #if defined(CONFIG_PCI_OHCI)
36 #if !defined(CONFIG_PCI_OHCI_DEVNO)
37 #define CONFIG_PCI_OHCI_DEVNO 0
46 #ifdef CONFIG_AT91RM9200
47 #include <asm/arch/hardware.h> /* needed for AT91_USB_HOST_BASE */
50 #if defined(CONFIG_CPU_ARM920T) || \
51 defined(CONFIG_S3C24X0) || \
52 defined(CONFIG_440EP) || \
53 defined(CONFIG_PCI_OHCI) || \
54 defined(CONFIG_MPC5200) || \
55 defined(CONFIG_SYS_OHCI_USE_NPS)
56 # define OHCI_USE_NPS /* force NoPowerSwitching mode */
59 #undef OHCI_VERBOSE_DEBUG /* not always helpful */
62 #undef OHCI_FILL_TRACE
64 /* For initializing controller (mask in an HCFS mode too) */
65 #define OHCI_CONTROL_INIT \
66 (OHCI_CTRL_CBSR & 0x3) | OHCI_CTRL_IE | OHCI_CTRL_PLE
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 */
78 #ifdef CONFIG_PCI_EHCI_DEVNO
79 static struct pci_device_id ehci_pci_ids[] = {
80 {0x1131, 0x1562}, /* Philips 1562 PCI EHCI module ids */
81 /* Please add supported PCI EHCI controller ids here */
87 #define dbg(format, arg...) printf("DEBUG: " format "\n", ## arg)
89 #define dbg(format, arg...) do {} while (0)
91 #define err(format, arg...) printf("ERROR: " format "\n", ## arg)
93 #define info(format, arg...) printf("INFO: " format "\n", ## arg)
95 #define info(format, arg...) do {} while (0)
98 #ifdef CONFIG_SYS_OHCI_BE_CONTROLLER
99 # define m16_swap(x) cpu_to_be16(x)
100 # define m32_swap(x) cpu_to_be32(x)
102 # define m16_swap(x) cpu_to_le16(x)
103 # define m32_swap(x) cpu_to_le32(x)
104 #endif /* CONFIG_SYS_OHCI_BE_CONTROLLER */
108 * We really should do proper cache flushing everywhere, but for now we only
109 * do it for new (driver-model) usb code to avoid regressions.
111 #define flush_dcache_buffer(addr, size) \
112 flush_dcache_range((unsigned long)(addr), \
113 ALIGN((unsigned long)(addr) + size, ARCH_DMA_MINALIGN))
114 #define invalidate_dcache_buffer(addr, size) \
115 invalidate_dcache_range((unsigned long)(addr), \
116 ALIGN((unsigned long)(addr) + size, ARCH_DMA_MINALIGN))
118 #define flush_dcache_buffer(addr, size)
119 #define invalidate_dcache_buffer(addr, size)
122 /* Do not use sizeof(ed / td) as our ed / td structs contain extra members */
123 #define flush_dcache_ed(addr) flush_dcache_buffer(addr, 16)
124 #define flush_dcache_td(addr) flush_dcache_buffer(addr, 16)
125 #define flush_dcache_iso_td(addr) flush_dcache_buffer(addr, 32)
126 #define flush_dcache_hcca(addr) flush_dcache_buffer(addr, 256)
127 #define invalidate_dcache_ed(addr) invalidate_dcache_buffer(addr, 16)
128 #define invalidate_dcache_td(addr) invalidate_dcache_buffer(addr, 16)
129 #define invalidate_dcache_iso_td(addr) invalidate_dcache_buffer(addr, 32)
130 #define invalidate_dcache_hcca(addr) invalidate_dcache_buffer(addr, 256)
134 /* this must be aligned to a 256 byte boundary */
135 struct ohci_hcca ghcca[1];
137 /* mapping of the OHCI CC status to error codes */
138 static int cc_to_error[16] = {
140 /* CRC Error */ USB_ST_CRC_ERR,
141 /* Bit Stuff */ USB_ST_BIT_ERR,
142 /* Data Togg */ USB_ST_CRC_ERR,
143 /* Stall */ USB_ST_STALLED,
145 /* PIDCheck */ USB_ST_BIT_ERR,
146 /* UnExpPID */ USB_ST_BIT_ERR,
147 /* DataOver */ USB_ST_BUF_ERR,
148 /* DataUnder */ USB_ST_BUF_ERR,
151 /* BufferOver */ USB_ST_BUF_ERR,
152 /* BuffUnder */ USB_ST_BUF_ERR,
157 static const char *cc_to_string[16] = {
159 "CRC: Last data packet from endpoint contained a CRC error.",
160 "BITSTUFFING: Last data packet from endpoint contained a bit " \
161 "stuffing violation",
162 "DATATOGGLEMISMATCH: Last packet from endpoint had data toggle PID\n" \
163 "that did not match the expected value.",
164 "STALL: TD was moved to the Done Queue because the endpoint returned" \
166 "DEVICENOTRESPONDING: Device did not respond to token (IN) or did\n" \
167 "not provide a handshake (OUT)",
168 "PIDCHECKFAILURE: Check bits on PID from endpoint failed on data PID\n"\
169 "(IN) or handshake (OUT)",
170 "UNEXPECTEDPID: Receive PID was not valid when encountered or PID\n" \
171 "value is not defined.",
172 "DATAOVERRUN: The amount of data returned by the endpoint exceeded\n" \
173 "either the size of the maximum data packet allowed\n" \
174 "from the endpoint (found in MaximumPacketSize field\n" \
175 "of ED) or the remaining buffer size.",
176 "DATAUNDERRUN: The endpoint returned less than MaximumPacketSize\n" \
177 "and that amount was not sufficient to fill the\n" \
181 "BUFFEROVERRUN: During an IN, HC received data from endpoint faster\n" \
182 "than it could be written to system memory",
183 "BUFFERUNDERRUN: During an OUT, HC could not retrieve data from\n" \
184 "system memory fast enough to keep up with data USB " \
186 "NOT ACCESSED: This code is set by software before the TD is placed" \
187 "on a list to be processed by the HC.(1)",
188 "NOT ACCESSED: This code is set by software before the TD is placed" \
189 "on a list to be processed by the HC.(2)",
192 static inline u32 roothub_a(struct ohci *hc)
193 { return ohci_readl(&hc->regs->roothub.a); }
194 static inline u32 roothub_b(struct ohci *hc)
195 { return ohci_readl(&hc->regs->roothub.b); }
196 static inline u32 roothub_status(struct ohci *hc)
197 { return ohci_readl(&hc->regs->roothub.status); }
198 static inline u32 roothub_portstatus(struct ohci *hc, int i)
199 { return ohci_readl(&hc->regs->roothub.portstatus[i]); }
201 /* forward declaration */
202 static int hc_interrupt(ohci_t *ohci);
203 static void td_submit_job(ohci_t *ohci, struct usb_device *dev,
204 unsigned long pipe, void *buffer, int transfer_len,
205 struct devrequest *setup, urb_priv_t *urb,
207 static int ep_link(ohci_t * ohci, ed_t * ed);
208 static int ep_unlink(ohci_t * ohci, ed_t * ed);
209 static ed_t *ep_add_ed(ohci_dev_t *ohci_dev, struct usb_device *usb_dev,
210 unsigned long pipe, int interval, int load);
212 /*-------------------------------------------------------------------------*/
215 static struct td *td_alloc(ohci_dev_t *ohci_dev, struct usb_device *usb_dev)
221 for (i = 0; i < NUM_TD; i++)
223 if (ohci_dev->tds[i].usb_dev == NULL)
225 td = &ohci_dev->tds[i];
226 td->usb_dev = usb_dev;
234 static inline void ed_free(struct ed *ed)
239 /*-------------------------------------------------------------------------*
240 * URB support functions
241 *-------------------------------------------------------------------------*/
243 /* free HCD-private data associated with this URB */
245 static void urb_free_priv(urb_priv_t *urb)
251 last = urb->length - 1;
253 for (i = 0; i <= last; i++) {
264 /*-------------------------------------------------------------------------*/
267 static int sohci_get_current_frame_number(ohci_t *ohci);
269 /* debug| print the main components of an URB
270 * small: 0) header + data packets 1) just header */
272 static void pkt_print(ohci_t *ohci, urb_priv_t *purb, struct usb_device *dev,
273 unsigned long pipe, void *buffer, int transfer_len,
274 struct devrequest *setup, char *str, int small)
276 dbg("%s URB:[%4x] dev:%2lu,ep:%2lu-%c,type:%s,len:%d/%d stat:%#lx",
278 sohci_get_current_frame_number(ohci),
279 usb_pipedevice(pipe),
280 usb_pipeendpoint(pipe),
281 usb_pipeout(pipe)? 'O': 'I',
282 usb_pipetype(pipe) < 2 ? \
283 (usb_pipeint(pipe)? "INTR": "ISOC"): \
284 (usb_pipecontrol(pipe)? "CTRL": "BULK"),
285 (purb ? purb->actual_length : 0),
286 transfer_len, dev->status);
287 #ifdef OHCI_VERBOSE_DEBUG
291 if (usb_pipecontrol(pipe)) {
292 printf(__FILE__ ": cmd(8):");
293 for (i = 0; i < 8 ; i++)
294 printf(" %02x", ((__u8 *) setup) [i]);
297 if (transfer_len > 0 && buffer) {
298 printf(__FILE__ ": data(%d/%d):",
299 (purb ? purb->actual_length : 0),
301 len = usb_pipeout(pipe)? transfer_len:
302 (purb ? purb->actual_length : 0);
303 for (i = 0; i < 16 && i < len; i++)
304 printf(" %02x", ((__u8 *) buffer) [i]);
305 printf("%s\n", i < len? "...": "");
311 /* just for debugging; prints non-empty branches of the int ed tree
312 * inclusive iso eds */
313 void ep_print_int_eds(ohci_t *ohci, char *str)
317 for (i = 0; i < 32; i++) {
319 ed_p = &(ohci->hcca->int_table [i]);
322 invalidate_dcache_ed(ed_p);
323 printf(__FILE__ ": %s branch int %2d(%2x):", str, i, i);
324 while (*ed_p != 0 && j--) {
325 ed_t *ed = (ed_t *)m32_swap(ed_p);
326 invalidate_dcache_ed(ed);
327 printf(" ed: %4x;", ed->hwINFO);
328 ed_p = &ed->hwNextED;
334 static void ohci_dump_intr_mask(char *label, __u32 mask)
336 dbg("%s: 0x%08x%s%s%s%s%s%s%s%s%s",
339 (mask & OHCI_INTR_MIE) ? " MIE" : "",
340 (mask & OHCI_INTR_OC) ? " OC" : "",
341 (mask & OHCI_INTR_RHSC) ? " RHSC" : "",
342 (mask & OHCI_INTR_FNO) ? " FNO" : "",
343 (mask & OHCI_INTR_UE) ? " UE" : "",
344 (mask & OHCI_INTR_RD) ? " RD" : "",
345 (mask & OHCI_INTR_SF) ? " SF" : "",
346 (mask & OHCI_INTR_WDH) ? " WDH" : "",
347 (mask & OHCI_INTR_SO) ? " SO" : ""
351 static void maybe_print_eds(char *label, __u32 value)
353 ed_t *edp = (ed_t *)value;
356 dbg("%s %08x", label, value);
357 invalidate_dcache_ed(edp);
358 dbg("%08x", edp->hwINFO);
359 dbg("%08x", edp->hwTailP);
360 dbg("%08x", edp->hwHeadP);
361 dbg("%08x", edp->hwNextED);
365 static char *hcfs2string(int state)
368 case OHCI_USB_RESET: return "reset";
369 case OHCI_USB_RESUME: return "resume";
370 case OHCI_USB_OPER: return "operational";
371 case OHCI_USB_SUSPEND: return "suspend";
376 /* dump control and status registers */
377 static void ohci_dump_status(ohci_t *controller)
379 struct ohci_regs *regs = controller->regs;
382 temp = ohci_readl(®s->revision) & 0xff;
384 dbg("spec %d.%d", (temp >> 4), (temp & 0x0f));
386 temp = ohci_readl(®s->control);
387 dbg("control: 0x%08x%s%s%s HCFS=%s%s%s%s%s CBSR=%d", temp,
388 (temp & OHCI_CTRL_RWE) ? " RWE" : "",
389 (temp & OHCI_CTRL_RWC) ? " RWC" : "",
390 (temp & OHCI_CTRL_IR) ? " IR" : "",
391 hcfs2string(temp & OHCI_CTRL_HCFS),
392 (temp & OHCI_CTRL_BLE) ? " BLE" : "",
393 (temp & OHCI_CTRL_CLE) ? " CLE" : "",
394 (temp & OHCI_CTRL_IE) ? " IE" : "",
395 (temp & OHCI_CTRL_PLE) ? " PLE" : "",
396 temp & OHCI_CTRL_CBSR
399 temp = ohci_readl(®s->cmdstatus);
400 dbg("cmdstatus: 0x%08x SOC=%d%s%s%s%s", temp,
401 (temp & OHCI_SOC) >> 16,
402 (temp & OHCI_OCR) ? " OCR" : "",
403 (temp & OHCI_BLF) ? " BLF" : "",
404 (temp & OHCI_CLF) ? " CLF" : "",
405 (temp & OHCI_HCR) ? " HCR" : ""
408 ohci_dump_intr_mask("intrstatus", ohci_readl(®s->intrstatus));
409 ohci_dump_intr_mask("intrenable", ohci_readl(®s->intrenable));
411 maybe_print_eds("ed_periodcurrent",
412 ohci_readl(®s->ed_periodcurrent));
414 maybe_print_eds("ed_controlhead", ohci_readl(®s->ed_controlhead));
415 maybe_print_eds("ed_controlcurrent",
416 ohci_readl(®s->ed_controlcurrent));
418 maybe_print_eds("ed_bulkhead", ohci_readl(®s->ed_bulkhead));
419 maybe_print_eds("ed_bulkcurrent", ohci_readl(®s->ed_bulkcurrent));
421 maybe_print_eds("donehead", ohci_readl(®s->donehead));
424 static void ohci_dump_roothub(ohci_t *controller, int verbose)
428 temp = roothub_a(controller);
429 ndp = (temp & RH_A_NDP);
430 #ifdef CONFIG_AT91C_PQFP_UHPBUG
431 ndp = (ndp == 2) ? 1:0;
434 dbg("roothub.a: %08x POTPGT=%d%s%s%s%s%s NDP=%d", temp,
435 ((temp & RH_A_POTPGT) >> 24) & 0xff,
436 (temp & RH_A_NOCP) ? " NOCP" : "",
437 (temp & RH_A_OCPM) ? " OCPM" : "",
438 (temp & RH_A_DT) ? " DT" : "",
439 (temp & RH_A_NPS) ? " NPS" : "",
440 (temp & RH_A_PSM) ? " PSM" : "",
443 temp = roothub_b(controller);
444 dbg("roothub.b: %08x PPCM=%04x DR=%04x",
446 (temp & RH_B_PPCM) >> 16,
449 temp = roothub_status(controller);
450 dbg("roothub.status: %08x%s%s%s%s%s%s",
452 (temp & RH_HS_CRWE) ? " CRWE" : "",
453 (temp & RH_HS_OCIC) ? " OCIC" : "",
454 (temp & RH_HS_LPSC) ? " LPSC" : "",
455 (temp & RH_HS_DRWE) ? " DRWE" : "",
456 (temp & RH_HS_OCI) ? " OCI" : "",
457 (temp & RH_HS_LPS) ? " LPS" : ""
461 for (i = 0; i < ndp; i++) {
462 temp = roothub_portstatus(controller, i);
463 dbg("roothub.portstatus [%d] = 0x%08x%s%s%s%s%s%s%s%s%s%s%s%s",
466 (temp & RH_PS_PRSC) ? " PRSC" : "",
467 (temp & RH_PS_OCIC) ? " OCIC" : "",
468 (temp & RH_PS_PSSC) ? " PSSC" : "",
469 (temp & RH_PS_PESC) ? " PESC" : "",
470 (temp & RH_PS_CSC) ? " CSC" : "",
472 (temp & RH_PS_LSDA) ? " LSDA" : "",
473 (temp & RH_PS_PPS) ? " PPS" : "",
474 (temp & RH_PS_PRS) ? " PRS" : "",
475 (temp & RH_PS_POCI) ? " POCI" : "",
476 (temp & RH_PS_PSS) ? " PSS" : "",
478 (temp & RH_PS_PES) ? " PES" : "",
479 (temp & RH_PS_CCS) ? " CCS" : ""
484 static void ohci_dump(ohci_t *controller, int verbose)
486 dbg("OHCI controller usb-%s state", controller->slot_name);
488 /* dumps some of the state we know about */
489 ohci_dump_status(controller);
491 ep_print_int_eds(controller, "hcca");
492 invalidate_dcache_hcca(controller->hcca);
493 dbg("hcca frame #%04x", controller->hcca->frame_no);
494 ohci_dump_roothub(controller, 1);
498 /*-------------------------------------------------------------------------*
499 * Interface functions (URB)
500 *-------------------------------------------------------------------------*/
502 /* get a transfer request */
504 int sohci_submit_job(ohci_t *ohci, ohci_dev_t *ohci_dev, urb_priv_t *urb,
505 struct devrequest *setup)
508 urb_priv_t *purb_priv = urb;
510 struct usb_device *dev = urb->dev;
511 unsigned long pipe = urb->pipe;
512 void *buffer = urb->transfer_buffer;
513 int transfer_len = urb->transfer_buffer_length;
514 int interval = urb->interval;
516 /* when controller's hung, permit only roothub cleanup attempts
517 * such as powering down ports */
518 if (ohci->disabled) {
519 err("sohci_submit_job: EPIPE");
523 /* we're about to begin a new transaction here so mark the
527 /* every endpoint has a ed, locate and fill it */
528 ed = ep_add_ed(ohci_dev, dev, pipe, interval, 1);
530 err("sohci_submit_job: ENOMEM");
534 /* for the private part of the URB we need the number of TDs (size) */
535 switch (usb_pipetype(pipe)) {
536 case PIPE_BULK: /* one TD for every 4096 Byte */
537 size = (transfer_len - 1) / 4096 + 1;
539 case PIPE_CONTROL:/* 1 TD for setup, 1 for ACK and 1 for every 4096 B */
540 size = (transfer_len == 0)? 2:
541 (transfer_len - 1) / 4096 + 3;
543 case PIPE_INTERRUPT: /* 1 TD */
550 if (size >= (N_URB_TD - 1)) {
551 err("need %d TDs, only have %d", size, N_URB_TD);
554 purb_priv->pipe = pipe;
556 /* fill the private part of the URB */
557 purb_priv->length = size;
559 purb_priv->actual_length = 0;
561 /* allocate the TDs */
562 /* note that td[0] was allocated in ep_add_ed */
563 for (i = 0; i < size; i++) {
564 purb_priv->td[i] = td_alloc(ohci_dev, dev);
565 if (!purb_priv->td[i]) {
566 purb_priv->length = i;
567 urb_free_priv(purb_priv);
568 err("sohci_submit_job: ENOMEM");
573 if (ed->state == ED_NEW || (ed->state & ED_DEL)) {
574 urb_free_priv(purb_priv);
575 err("sohci_submit_job: EINVAL");
579 /* link the ed into a chain if is not already */
580 if (ed->state != ED_OPER)
583 /* fill the TDs and link it to the ed */
584 td_submit_job(ohci, dev, pipe, buffer, transfer_len,
585 setup, purb_priv, interval);
590 static inline int sohci_return_job(struct ohci *hc, urb_priv_t *urb)
592 struct ohci_regs *regs = hc->regs;
594 switch (usb_pipetype(urb->pipe)) {
596 /* implicitly requeued */
597 if (urb->dev->irq_handle &&
598 (urb->dev->irq_act_len = urb->actual_length)) {
599 ohci_writel(OHCI_INTR_WDH, ®s->intrenable);
600 ohci_readl(®s->intrenable); /* PCI posting flush */
601 urb->dev->irq_handle(urb->dev);
602 ohci_writel(OHCI_INTR_WDH, ®s->intrdisable);
603 ohci_readl(®s->intrdisable); /* PCI posting flush */
605 urb->actual_length = 0;
609 urb->transfer_buffer,
610 urb->transfer_buffer_length,
624 /*-------------------------------------------------------------------------*/
627 /* tell us the current USB frame number */
628 static int sohci_get_current_frame_number(ohci_t *ohci)
630 invalidate_dcache_hcca(ohci->hcca);
631 return m16_swap(ohci->hcca->frame_no);
635 /*-------------------------------------------------------------------------*
636 * ED handling functions
637 *-------------------------------------------------------------------------*/
639 /* search for the right branch to insert an interrupt ed into the int tree
640 * do some load ballancing;
641 * returns the branch and
642 * sets the interval to interval = 2^integer (ld (interval)) */
644 static int ep_int_ballance(ohci_t *ohci, int interval, int load)
648 /* search for the least loaded interrupt endpoint
649 * branch of all 32 branches
651 for (i = 0; i < 32; i++)
652 if (ohci->ohci_int_load [branch] > ohci->ohci_int_load [i])
655 branch = branch % interval;
656 for (i = branch; i < 32; i += interval)
657 ohci->ohci_int_load [i] += load;
662 /*-------------------------------------------------------------------------*/
664 /* 2^int( ld (inter)) */
666 static int ep_2_n_interval(int inter)
669 for (i = 0; ((inter >> i) > 1) && (i < 5); i++);
673 /*-------------------------------------------------------------------------*/
675 /* the int tree is a binary tree
676 * in order to process it sequentially the indexes of the branches have to
677 * be mapped the mapping reverses the bits of a word of num_bits length */
678 static int ep_rev(int num_bits, int word)
682 for (i = 0; i < num_bits; i++)
683 wout |= (((word >> i) & 1) << (num_bits - i - 1));
687 /*-------------------------------------------------------------------------*
688 * ED handling functions
689 *-------------------------------------------------------------------------*/
691 /* link an ed into one of the HC chains */
693 static int ep_link(ohci_t *ohci, ed_t *edi)
695 volatile ed_t *ed = edi;
704 ed->int_interval = 0;
710 if (ohci->ed_controltail == NULL)
711 ohci_writel(ed, &ohci->regs->ed_controlhead);
713 ohci->ed_controltail->hwNextED =
714 m32_swap((unsigned long)ed);
716 ed->ed_prev = ohci->ed_controltail;
717 if (!ohci->ed_controltail && !ohci->ed_rm_list[0] &&
718 !ohci->ed_rm_list[1] && !ohci->sleeping) {
719 ohci->hc_control |= OHCI_CTRL_CLE;
720 ohci_writel(ohci->hc_control, &ohci->regs->control);
722 ohci->ed_controltail = edi;
728 if (ohci->ed_bulktail == NULL)
729 ohci_writel(ed, &ohci->regs->ed_bulkhead);
731 ohci->ed_bulktail->hwNextED =
732 m32_swap((unsigned long)ed);
734 ed->ed_prev = ohci->ed_bulktail;
735 if (!ohci->ed_bulktail && !ohci->ed_rm_list[0] &&
736 !ohci->ed_rm_list[1] && !ohci->sleeping) {
737 ohci->hc_control |= OHCI_CTRL_BLE;
738 ohci_writel(ohci->hc_control, &ohci->regs->control);
740 ohci->ed_bulktail = edi;
745 interval = ep_2_n_interval(ed->int_period);
746 ed->int_interval = interval;
747 int_branch = ep_int_ballance(ohci, interval, load);
748 ed->int_branch = int_branch;
750 for (i = 0; i < ep_rev(6, interval); i += inter) {
752 for (ed_p = &(ohci->hcca->int_table[\
753 ep_rev(5, i) + int_branch]);
755 (((ed_t *)ed_p)->int_interval >= interval);
756 ed_p = &(((ed_t *)ed_p)->hwNextED))
758 ((ed_t *)ed_p)->int_interval);
759 ed->hwNextED = *ed_p;
761 *ed_p = m32_swap((unsigned long)ed);
762 flush_dcache_hcca(ohci->hcca);
769 /*-------------------------------------------------------------------------*/
771 /* scan the periodic table to find and unlink this ED */
772 static void periodic_unlink(struct ohci *ohci, volatile struct ed *ed,
773 unsigned index, unsigned period)
775 __maybe_unused unsigned long aligned_ed_p;
777 for (; index < NUM_INTS; index += period) {
778 __u32 *ed_p = &ohci->hcca->int_table [index];
780 /* ED might have been unlinked through another path */
783 m32_swap((unsigned long)ed_p)) == ed) {
784 *ed_p = ed->hwNextED;
786 aligned_ed_p = (unsigned long)ed_p;
787 aligned_ed_p &= ~(ARCH_DMA_MINALIGN - 1);
788 flush_dcache_range(aligned_ed_p,
789 aligned_ed_p + ARCH_DMA_MINALIGN);
793 ed_p = &(((struct ed *)
794 m32_swap((unsigned long)ed_p))->hwNextED);
799 /* unlink an ed from one of the HC chains.
800 * just the link to the ed is unlinked.
801 * the link from the ed still points to another operational ed or 0
802 * so the HC can eventually finish the processing of the unlinked ed */
804 static int ep_unlink(ohci_t *ohci, ed_t *edi)
806 volatile ed_t *ed = edi;
809 ed->hwINFO |= m32_swap(OHCI_ED_SKIP);
814 if (ed->ed_prev == NULL) {
816 ohci->hc_control &= ~OHCI_CTRL_CLE;
817 ohci_writel(ohci->hc_control,
818 &ohci->regs->control);
820 ohci_writel(m32_swap(*((__u32 *)&ed->hwNextED)),
821 &ohci->regs->ed_controlhead);
823 ed->ed_prev->hwNextED = ed->hwNextED;
824 flush_dcache_ed(ed->ed_prev);
826 if (ohci->ed_controltail == ed) {
827 ohci->ed_controltail = ed->ed_prev;
830 *((__u32 *)&ed->hwNextED)))->ed_prev = ed->ed_prev;
835 if (ed->ed_prev == NULL) {
837 ohci->hc_control &= ~OHCI_CTRL_BLE;
838 ohci_writel(ohci->hc_control,
839 &ohci->regs->control);
841 ohci_writel(m32_swap(*((__u32 *)&ed->hwNextED)),
842 &ohci->regs->ed_bulkhead);
844 ed->ed_prev->hwNextED = ed->hwNextED;
845 flush_dcache_ed(ed->ed_prev);
847 if (ohci->ed_bulktail == ed) {
848 ohci->ed_bulktail = ed->ed_prev;
851 *((__u32 *)&ed->hwNextED)))->ed_prev = ed->ed_prev;
856 periodic_unlink(ohci, ed, 0, 1);
857 for (i = ed->int_branch; i < 32; i += ed->int_interval)
858 ohci->ohci_int_load[i] -= ed->int_load;
861 ed->state = ED_UNLINK;
865 /*-------------------------------------------------------------------------*/
867 /* add/reinit an endpoint; this should be done once at the
868 * usb_set_configuration command, but the USB stack is a little bit
869 * stateless so we do it at every transaction if the state of the ed
870 * is ED_NEW then a dummy td is added and the state is changed to
871 * ED_UNLINK in all other cases the state is left unchanged the ed
872 * info fields are setted anyway even though most of them should not
875 static ed_t *ep_add_ed(ohci_dev_t *ohci_dev, struct usb_device *usb_dev,
876 unsigned long pipe, int interval, int load)
882 ed = ed_ret = &ohci_dev->ed[(usb_pipeendpoint(pipe) << 1) |
883 (usb_pipecontrol(pipe)? 0: usb_pipeout(pipe))];
885 if ((ed->state & ED_DEL) || (ed->state & ED_URB_DEL)) {
886 err("ep_add_ed: pending delete");
887 /* pending delete request */
891 if (ed->state == ED_NEW) {
892 /* dummy td; end of td list for ed */
893 td = td_alloc(ohci_dev, usb_dev);
894 ed->hwTailP = m32_swap((unsigned long)td);
895 ed->hwHeadP = ed->hwTailP;
896 ed->state = ED_UNLINK;
897 ed->type = usb_pipetype(pipe);
901 ed->hwINFO = m32_swap(usb_pipedevice(pipe)
902 | usb_pipeendpoint(pipe) << 7
903 | (usb_pipeisoc(pipe)? 0x8000: 0)
904 | (usb_pipecontrol(pipe)? 0: \
905 (usb_pipeout(pipe)? 0x800: 0x1000))
906 | (usb_dev->speed == USB_SPEED_LOW) << 13
907 | usb_maxpacket(usb_dev, pipe) << 16);
909 if (ed->type == PIPE_INTERRUPT && ed->state == ED_UNLINK) {
910 ed->int_period = interval;
919 /*-------------------------------------------------------------------------*
920 * TD handling functions
921 *-------------------------------------------------------------------------*/
923 /* enqueue next TD for this URB (OHCI spec 5.2.8.2) */
925 static void td_fill(ohci_t *ohci, unsigned int info,
927 struct usb_device *dev, int index, urb_priv_t *urb_priv)
929 volatile td_t *td, *td_pt;
930 #ifdef OHCI_FILL_TRACE
934 if (index > urb_priv->length) {
935 err("index > length");
938 /* use this td as the next dummy */
939 td_pt = urb_priv->td [index];
941 flush_dcache_td(td_pt);
943 /* fill the old dummy TD */
944 td = urb_priv->td [index] =
945 (td_t *)(m32_swap(urb_priv->ed->hwTailP) & ~0xf);
947 td->ed = urb_priv->ed;
948 td->next_dl_td = NULL;
950 td->data = (__u32)data;
951 #ifdef OHCI_FILL_TRACE
952 if (usb_pipebulk(urb_priv->pipe) && usb_pipeout(urb_priv->pipe)) {
953 for (i = 0; i < len; i++)
954 printf("td->data[%d] %#2x ", i, ((unsigned char *)td->data)[i]);
961 td->hwINFO = m32_swap(info);
962 td->hwCBP = m32_swap((unsigned long)data);
964 td->hwBE = m32_swap((unsigned long)(data + len - 1));
968 td->hwNextTD = m32_swap((unsigned long)td_pt);
971 /* append to queue */
972 td->ed->hwTailP = td->hwNextTD;
973 flush_dcache_ed(td->ed);
976 /*-------------------------------------------------------------------------*/
978 /* prepare all TDs of a transfer */
980 static void td_submit_job(ohci_t *ohci, struct usb_device *dev,
981 unsigned long pipe, void *buffer, int transfer_len,
982 struct devrequest *setup, urb_priv_t *urb,
985 int data_len = transfer_len;
989 unsigned int toggle = 0;
991 flush_dcache_buffer(buffer, data_len);
993 /* OHCI handles the DATA-toggles itself, we just use the USB-toggle
994 * bits for reseting */
995 if (usb_gettoggle(dev, usb_pipeendpoint(pipe), usb_pipeout(pipe))) {
996 toggle = TD_T_TOGGLE;
999 usb_settoggle(dev, usb_pipeendpoint(pipe),
1000 usb_pipeout(pipe), 1);
1008 switch (usb_pipetype(pipe)) {
1010 info = usb_pipeout(pipe)?
1011 TD_CC | TD_DP_OUT : TD_CC | TD_DP_IN ;
1012 while (data_len > 4096) {
1013 td_fill(ohci, info | (cnt? TD_T_TOGGLE:toggle),
1014 data, 4096, dev, cnt, urb);
1015 data += 4096; data_len -= 4096; cnt++;
1017 info = usb_pipeout(pipe)?
1018 TD_CC | TD_DP_OUT : TD_CC | TD_R | TD_DP_IN ;
1019 td_fill(ohci, info | (cnt? TD_T_TOGGLE:toggle), data,
1020 data_len, dev, cnt, urb);
1023 if (!ohci->sleeping) {
1024 /* start bulk list */
1025 ohci_writel(OHCI_BLF, &ohci->regs->cmdstatus);
1031 info = TD_CC | TD_DP_SETUP | TD_T_DATA0;
1032 flush_dcache_buffer(setup, 8);
1033 td_fill(ohci, info, setup, 8, dev, cnt++, urb);
1035 /* Optional Data phase */
1037 info = usb_pipeout(pipe)?
1038 TD_CC | TD_R | TD_DP_OUT | TD_T_DATA1 :
1039 TD_CC | TD_R | TD_DP_IN | TD_T_DATA1;
1040 /* NOTE: mishandles transfers >8K, some >4K */
1041 td_fill(ohci, info, data, data_len, dev, cnt++, urb);
1045 info = (usb_pipeout(pipe) || data_len == 0) ?
1046 TD_CC | TD_DP_IN | TD_T_DATA1:
1047 TD_CC | TD_DP_OUT | TD_T_DATA1;
1048 td_fill(ohci, info, data, 0, dev, cnt++, urb);
1050 if (!ohci->sleeping) {
1051 /* start Control list */
1052 ohci_writel(OHCI_CLF, &ohci->regs->cmdstatus);
1056 case PIPE_INTERRUPT:
1057 info = usb_pipeout(urb->pipe)?
1058 TD_CC | TD_DP_OUT | toggle:
1059 TD_CC | TD_R | TD_DP_IN | toggle;
1060 td_fill(ohci, info, data, data_len, dev, cnt++, urb);
1063 if (urb->length != cnt)
1064 dbg("TD LENGTH %d != CNT %d", urb->length, cnt);
1067 /*-------------------------------------------------------------------------*
1068 * Done List handling functions
1069 *-------------------------------------------------------------------------*/
1071 /* calculate the transfer length and update the urb */
1073 static void dl_transfer_length(td_t *td)
1076 urb_priv_t *lurb_priv = td->ed->purb;
1078 tdBE = m32_swap(td->hwBE);
1079 tdCBP = m32_swap(td->hwCBP);
1081 if (!(usb_pipecontrol(lurb_priv->pipe) &&
1082 ((td->index == 0) || (td->index == lurb_priv->length - 1)))) {
1085 lurb_priv->actual_length += tdBE - td->data + 1;
1087 lurb_priv->actual_length += tdCBP - td->data;
1092 /*-------------------------------------------------------------------------*/
1093 static void check_status(td_t *td_list)
1095 urb_priv_t *lurb_priv = td_list->ed->purb;
1096 int urb_len = lurb_priv->length;
1097 __u32 *phwHeadP = &td_list->ed->hwHeadP;
1100 cc = TD_CC_GET(m32_swap(td_list->hwINFO));
1102 err(" USB-error: %s (%x)", cc_to_string[cc], cc);
1104 invalidate_dcache_ed(td_list->ed);
1105 if (*phwHeadP & m32_swap(0x1)) {
1107 ((td_list->index + 1) < urb_len)) {
1109 (lurb_priv->td[urb_len - 1]->hwNextTD &\
1110 m32_swap(0xfffffff0)) |
1111 (*phwHeadP & m32_swap(0x2));
1113 lurb_priv->td_cnt += urb_len -
1116 *phwHeadP &= m32_swap(0xfffffff2);
1117 flush_dcache_ed(td_list->ed);
1119 #ifdef CONFIG_MPC5200
1120 td_list->hwNextTD = 0;
1121 flush_dcache_td(td_list);
1126 /* replies to the request have to be on a FIFO basis so
1127 * we reverse the reversed done-list */
1128 static td_t *dl_reverse_done_list(ohci_t *ohci)
1131 td_t *td_rev = NULL;
1132 td_t *td_list = NULL;
1134 invalidate_dcache_hcca(ohci->hcca);
1135 td_list_hc = m32_swap(ohci->hcca->done_head) & 0xfffffff0;
1136 ohci->hcca->done_head = 0;
1137 flush_dcache_hcca(ohci->hcca);
1139 while (td_list_hc) {
1140 td_list = (td_t *)td_list_hc;
1141 invalidate_dcache_td(td_list);
1142 check_status(td_list);
1143 td_list->next_dl_td = td_rev;
1145 td_list_hc = m32_swap(td_list->hwNextTD) & 0xfffffff0;
1150 /*-------------------------------------------------------------------------*/
1151 /*-------------------------------------------------------------------------*/
1153 static void finish_urb(ohci_t *ohci, urb_priv_t *urb, int status)
1155 if ((status & (ED_OPER | ED_UNLINK)) && (urb->state != URB_DEL))
1156 urb->finished = sohci_return_job(ohci, urb);
1158 dbg("finish_urb: strange.., ED state %x, \n", status);
1162 * Used to take back a TD from the host controller. This would normally be
1163 * called from within dl_done_list, however it may be called directly if the
1164 * HC no longer sees the TD and it has not appeared on the donelist (after
1165 * two frames). This bug has been observed on ZF Micro systems.
1167 static int takeback_td(ohci_t *ohci, td_t *td_list)
1173 urb_priv_t *lurb_priv;
1174 __u32 tdINFO, edHeadP, edTailP;
1176 invalidate_dcache_td(td_list);
1177 tdINFO = m32_swap(td_list->hwINFO);
1180 lurb_priv = ed->purb;
1182 dl_transfer_length(td_list);
1184 lurb_priv->td_cnt++;
1186 /* error code of transfer */
1187 cc = TD_CC_GET(tdINFO);
1189 err("USB-error: %s (%x)", cc_to_string[cc], cc);
1190 stat = cc_to_error[cc];
1193 /* see if this done list makes for all TD's of current URB,
1194 * and mark the URB finished if so */
1195 if (lurb_priv->td_cnt == lurb_priv->length)
1196 finish_urb(ohci, lurb_priv, ed->state);
1198 dbg("dl_done_list: processing TD %x, len %x\n",
1199 lurb_priv->td_cnt, lurb_priv->length);
1201 if (ed->state != ED_NEW && (!usb_pipeint(lurb_priv->pipe))) {
1202 invalidate_dcache_ed(ed);
1203 edHeadP = m32_swap(ed->hwHeadP) & 0xfffffff0;
1204 edTailP = m32_swap(ed->hwTailP);
1206 /* unlink eds if they are not busy */
1207 if ((edHeadP == edTailP) && (ed->state == ED_OPER))
1208 ep_unlink(ohci, ed);
1213 static int dl_done_list(ohci_t *ohci)
1216 td_t *td_list = dl_reverse_done_list(ohci);
1219 td_t *td_next = td_list->next_dl_td;
1220 stat = takeback_td(ohci, td_list);
1226 /*-------------------------------------------------------------------------*
1228 *-------------------------------------------------------------------------*/
1230 #include <usbroothubdes.h>
1232 /* Hub class-specific descriptor is constructed dynamically */
1234 /*-------------------------------------------------------------------------*/
1236 #define OK(x) len = (x); break
1238 #define WR_RH_STAT(x) {info("WR:status %#8x", (x)); ohci_writel((x), \
1239 &ohci->regs->roothub.status); }
1240 #define WR_RH_PORTSTAT(x) {info("WR:portstatus[%d] %#8x", wIndex-1, \
1241 (x)); ohci_writel((x), &ohci->regs->roothub.portstatus[wIndex-1]); }
1243 #define WR_RH_STAT(x) ohci_writel((x), &ohci->regs->roothub.status)
1244 #define WR_RH_PORTSTAT(x) ohci_writel((x), \
1245 &ohci->regs->roothub.portstatus[wIndex-1])
1247 #define RD_RH_STAT roothub_status(ohci)
1248 #define RD_RH_PORTSTAT roothub_portstatus(ohci, wIndex-1)
1250 /* request to virtual root hub */
1252 int rh_check_port_status(ohci_t *controller)
1258 temp = roothub_a(controller);
1259 ndp = (temp & RH_A_NDP);
1260 #ifdef CONFIG_AT91C_PQFP_UHPBUG
1261 ndp = (ndp == 2) ? 1:0;
1263 for (i = 0; i < ndp; i++) {
1264 temp = roothub_portstatus(controller, i);
1265 /* check for a device disconnect */
1266 if (((temp & (RH_PS_PESC | RH_PS_CSC)) ==
1267 (RH_PS_PESC | RH_PS_CSC)) &&
1268 ((temp & RH_PS_CCS) == 0)) {
1276 static int ohci_submit_rh_msg(ohci_t *ohci, struct usb_device *dev,
1277 unsigned long pipe, void *buffer, int transfer_len,
1278 struct devrequest *cmd)
1280 void *data = buffer;
1281 int leni = transfer_len;
1288 ALLOC_ALIGN_BUFFER(__u8, databuf, 16, sizeof(u32));
1291 pkt_print(ohci, NULL, dev, pipe, buffer, transfer_len,
1292 cmd, "SUB(rh)", usb_pipein(pipe));
1296 if (usb_pipeint(pipe)) {
1297 info("Root-Hub submit IRQ: NOT implemented");
1301 bmRType_bReq = cmd->requesttype | (cmd->request << 8);
1302 wValue = le16_to_cpu(cmd->value);
1303 wIndex = le16_to_cpu(cmd->index);
1304 wLength = le16_to_cpu(cmd->length);
1306 info("Root-Hub: adr: %2x cmd(%1x): %08x %04x %04x %04x",
1307 dev->devnum, 8, bmRType_bReq, wValue, wIndex, wLength);
1309 switch (bmRType_bReq) {
1310 /* Request Destination:
1311 without flags: Device,
1312 RH_INTERFACE: interface,
1313 RH_ENDPOINT: endpoint,
1314 RH_CLASS means HUB here,
1315 RH_OTHER | RH_CLASS almost ever means HUB_PORT here
1319 *(u16 *)databuf = cpu_to_le16(1);
1321 case RH_GET_STATUS | RH_INTERFACE:
1322 *(u16 *)databuf = cpu_to_le16(0);
1324 case RH_GET_STATUS | RH_ENDPOINT:
1325 *(u16 *)databuf = cpu_to_le16(0);
1327 case RH_GET_STATUS | RH_CLASS:
1328 *(u32 *)databuf = cpu_to_le32(
1329 RD_RH_STAT & ~(RH_HS_CRWE | RH_HS_DRWE));
1331 case RH_GET_STATUS | RH_OTHER | RH_CLASS:
1332 *(u32 *)databuf = cpu_to_le32(RD_RH_PORTSTAT);
1335 case RH_CLEAR_FEATURE | RH_ENDPOINT:
1337 case (RH_ENDPOINT_STALL):
1342 case RH_CLEAR_FEATURE | RH_CLASS:
1344 case RH_C_HUB_LOCAL_POWER:
1346 case (RH_C_HUB_OVER_CURRENT):
1347 WR_RH_STAT(RH_HS_OCIC);
1352 case RH_CLEAR_FEATURE | RH_OTHER | RH_CLASS:
1354 case (RH_PORT_ENABLE): WR_RH_PORTSTAT(RH_PS_CCS); OK(0);
1355 case (RH_PORT_SUSPEND): WR_RH_PORTSTAT(RH_PS_POCI); OK(0);
1356 case (RH_PORT_POWER): WR_RH_PORTSTAT(RH_PS_LSDA); OK(0);
1357 case (RH_C_PORT_CONNECTION): WR_RH_PORTSTAT(RH_PS_CSC); OK(0);
1358 case (RH_C_PORT_ENABLE): WR_RH_PORTSTAT(RH_PS_PESC); OK(0);
1359 case (RH_C_PORT_SUSPEND): WR_RH_PORTSTAT(RH_PS_PSSC); OK(0);
1360 case (RH_C_PORT_OVER_CURRENT):WR_RH_PORTSTAT(RH_PS_OCIC); OK(0);
1361 case (RH_C_PORT_RESET): WR_RH_PORTSTAT(RH_PS_PRSC); OK(0);
1365 case RH_SET_FEATURE | RH_OTHER | RH_CLASS:
1367 case (RH_PORT_SUSPEND):
1368 WR_RH_PORTSTAT(RH_PS_PSS); OK(0);
1369 case (RH_PORT_RESET): /* BUG IN HUP CODE *********/
1370 if (RD_RH_PORTSTAT & RH_PS_CCS)
1371 WR_RH_PORTSTAT(RH_PS_PRS);
1373 case (RH_PORT_POWER):
1374 WR_RH_PORTSTAT(RH_PS_PPS);
1377 case (RH_PORT_ENABLE): /* BUG IN HUP CODE *********/
1378 if (RD_RH_PORTSTAT & RH_PS_CCS)
1379 WR_RH_PORTSTAT(RH_PS_PES);
1384 case RH_SET_ADDRESS:
1385 ohci->rh.devnum = wValue;
1388 case RH_GET_DESCRIPTOR:
1389 switch ((wValue & 0xff00) >> 8) {
1390 case (0x01): /* device descriptor */
1391 len = min_t(unsigned int,
1394 sizeof(root_hub_dev_des),
1396 databuf = root_hub_dev_des; OK(len);
1397 case (0x02): /* configuration descriptor */
1398 len = min_t(unsigned int,
1401 sizeof(root_hub_config_des),
1403 databuf = root_hub_config_des; OK(len);
1404 case (0x03): /* string descriptors */
1405 if (wValue == 0x0300) {
1406 len = min_t(unsigned int,
1409 sizeof(root_hub_str_index0),
1411 databuf = root_hub_str_index0;
1414 if (wValue == 0x0301) {
1415 len = min_t(unsigned int,
1418 sizeof(root_hub_str_index1),
1420 databuf = root_hub_str_index1;
1424 stat = USB_ST_STALLED;
1428 case RH_GET_DESCRIPTOR | RH_CLASS:
1430 __u32 temp = roothub_a(ohci);
1432 databuf[0] = 9; /* min length; */
1434 databuf[2] = temp & RH_A_NDP;
1435 #ifdef CONFIG_AT91C_PQFP_UHPBUG
1436 databuf[2] = (databuf[2] == 2) ? 1 : 0;
1439 if (temp & RH_A_PSM) /* per-port power switching? */
1441 if (temp & RH_A_NOCP) /* no overcurrent reporting? */
1443 else if (temp & RH_A_OCPM)/* per-port overcurrent reporting? */
1447 databuf[5] = (temp & RH_A_POTPGT) >> 24;
1449 temp = roothub_b(ohci);
1450 databuf[7] = temp & RH_B_DR;
1451 if (databuf[2] < 7) {
1455 databuf[8] = (temp & RH_B_DR) >> 8;
1456 databuf[10] = databuf[9] = 0xff;
1459 len = min_t(unsigned int, leni,
1460 min_t(unsigned int, databuf[0], wLength));
1464 case RH_GET_CONFIGURATION:
1468 case RH_SET_CONFIGURATION:
1469 WR_RH_STAT(0x10000);
1473 dbg("unsupported root hub command");
1474 stat = USB_ST_STALLED;
1478 ohci_dump_roothub(ohci, 1);
1483 len = min_t(int, len, leni);
1484 if (data != databuf)
1485 memcpy(data, databuf, len);
1490 pkt_print(ohci, NULL, dev, pipe, buffer,
1491 transfer_len, cmd, "RET(rh)", 0/*usb_pipein(pipe)*/);
1499 /*-------------------------------------------------------------------------*/
1501 /* common code for handling submit messages - used for all but root hub */
1503 static int submit_common_msg(ohci_t *ohci, struct usb_device *dev,
1504 unsigned long pipe, void *buffer, int transfer_len,
1505 struct devrequest *setup, int interval)
1508 int maxsize = usb_maxpacket(dev, pipe);
1512 urb = malloc(sizeof(urb_priv_t));
1513 memset(urb, 0, sizeof(urb_priv_t));
1517 urb->transfer_buffer = buffer;
1518 urb->transfer_buffer_length = transfer_len;
1519 urb->interval = interval;
1522 urb->actual_length = 0;
1523 pkt_print(ohci, urb, dev, pipe, buffer, transfer_len,
1524 setup, "SUB", usb_pipein(pipe));
1529 err("submit_common_message: pipesize for pipe %lx is zero",
1534 if (sohci_submit_job(ohci, &ohci->ohci_dev, urb, setup) < 0) {
1535 err("sohci_submit_job failed");
1541 /* ohci_dump_status(ohci); */
1544 timeout = USB_TIMEOUT_MS(pipe);
1546 /* wait for it to complete */
1548 /* check whether the controller is done */
1549 stat = hc_interrupt(ohci);
1551 stat = USB_ST_CRC_ERR;
1555 /* NOTE: since we are not interrupt driven in U-Boot and always
1556 * handle only one URB at a time, we cannot assume the
1557 * transaction finished on the first successful return from
1558 * hc_interrupt().. unless the flag for current URB is set,
1559 * meaning that all TD's to/from device got actually
1560 * transferred and processed. If the current URB is not
1561 * finished we need to re-iterate this loop so as
1562 * hc_interrupt() gets called again as there needs to be some
1563 * more TD's to process still */
1564 if ((stat >= 0) && (stat != 0xff) && (urb->finished)) {
1565 /* 0xff is returned for an SF-interrupt */
1575 if (!usb_pipeint(pipe))
1576 err("CTL:TIMEOUT ");
1577 dbg("submit_common_msg: TO status %x\n", stat);
1579 stat = USB_ST_CRC_ERR;
1585 dev->act_len = urb->actual_length;
1587 if (usb_pipein(pipe) && dev->status == 0 && dev->act_len)
1588 invalidate_dcache_buffer(buffer, dev->act_len);
1591 pkt_print(ohci, urb, dev, pipe, buffer, transfer_len,
1592 setup, "RET(ctlr)", usb_pipein(pipe));
1597 /* free TDs in urb_priv */
1598 if (!usb_pipeint(pipe))
1603 /* submit routines called from usb.c */
1604 int submit_bulk_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
1607 info("submit_bulk_msg");
1608 return submit_common_msg(&gohci, dev, pipe, buffer, transfer_len,
1612 int submit_int_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
1613 int transfer_len, int interval)
1615 info("submit_int_msg");
1616 return submit_common_msg(&gohci, dev, pipe, buffer, transfer_len, NULL,
1620 static int _ohci_submit_control_msg(ohci_t *ohci, struct usb_device *dev,
1621 unsigned long pipe, void *buffer, int transfer_len,
1622 struct devrequest *setup)
1624 int maxsize = usb_maxpacket(dev, pipe);
1626 info("submit_control_msg");
1628 pkt_print(ohci, NULL, dev, pipe, buffer, transfer_len,
1629 setup, "SUB", usb_pipein(pipe));
1634 err("submit_control_message: pipesize for pipe %lx is zero",
1638 if (((pipe >> 8) & 0x7f) == ohci->rh.devnum) {
1640 /* root hub - redirect */
1641 return ohci_submit_rh_msg(ohci, dev, pipe, buffer,
1642 transfer_len, setup);
1645 return submit_common_msg(ohci, dev, pipe, buffer, transfer_len,
1649 /*-------------------------------------------------------------------------*
1651 *-------------------------------------------------------------------------*/
1653 /* reset the HC and BUS */
1655 static int hc_reset(ohci_t *ohci)
1657 #ifdef CONFIG_PCI_EHCI_DEVNO
1661 int smm_timeout = 50; /* 0,5 sec */
1663 dbg("%s\n", __FUNCTION__);
1665 #ifdef CONFIG_PCI_EHCI_DEVNO
1667 * Some multi-function controllers (e.g. ISP1562) allow root hub
1668 * resetting via EHCI registers only.
1670 pdev = pci_find_devices(ehci_pci_ids, CONFIG_PCI_EHCI_DEVNO);
1675 pci_read_config_dword(pdev, PCI_BASE_ADDRESS_0, &base);
1676 base += EHCI_USBCMD_OFF;
1677 ohci_writel(ohci_readl(base) | EHCI_USBCMD_HCRESET, base);
1679 while (ohci_readl(base) & EHCI_USBCMD_HCRESET) {
1680 if (timeout-- <= 0) {
1681 printf("USB RootHub reset timed out!");
1687 printf("No EHCI func at %d index!\n", CONFIG_PCI_EHCI_DEVNO);
1689 if (ohci_readl(&ohci->regs->control) & OHCI_CTRL_IR) {
1690 /* SMM owns the HC, request ownership */
1691 ohci_writel(OHCI_OCR, &ohci->regs->cmdstatus);
1692 info("USB HC TakeOver from SMM");
1693 while (ohci_readl(&ohci->regs->control) & OHCI_CTRL_IR) {
1695 if (--smm_timeout == 0) {
1696 err("USB HC TakeOver failed!");
1702 /* Disable HC interrupts */
1703 ohci_writel(OHCI_INTR_MIE, &ohci->regs->intrdisable);
1705 dbg("USB HC reset_hc usb-%s: ctrl = 0x%X ;\n",
1707 ohci_readl(&ohci->regs->control));
1709 /* Reset USB (needed by some controllers) */
1710 ohci->hc_control = 0;
1711 ohci_writel(ohci->hc_control, &ohci->regs->control);
1713 /* HC Reset requires max 10 us delay */
1714 ohci_writel(OHCI_HCR, &ohci->regs->cmdstatus);
1715 while ((ohci_readl(&ohci->regs->cmdstatus) & OHCI_HCR) != 0) {
1716 if (--timeout == 0) {
1717 err("USB HC reset timed out!");
1725 /*-------------------------------------------------------------------------*/
1727 /* Start an OHCI controller, set the BUS operational
1729 * connect the virtual root hub */
1731 static int hc_start(ohci_t *ohci)
1734 unsigned int fminterval;
1738 /* Tell the controller where the control and bulk lists are
1739 * The lists are empty now. */
1741 ohci_writel(0, &ohci->regs->ed_controlhead);
1742 ohci_writel(0, &ohci->regs->ed_bulkhead);
1744 ohci_writel((__u32)ohci->hcca,
1745 &ohci->regs->hcca); /* reset clears this */
1747 fminterval = 0x2edf;
1748 ohci_writel((fminterval * 9) / 10, &ohci->regs->periodicstart);
1749 fminterval |= ((((fminterval - 210) * 6) / 7) << 16);
1750 ohci_writel(fminterval, &ohci->regs->fminterval);
1751 ohci_writel(0x628, &ohci->regs->lsthresh);
1753 /* start controller operations */
1754 ohci->hc_control = OHCI_CONTROL_INIT | OHCI_USB_OPER;
1756 ohci_writel(ohci->hc_control, &ohci->regs->control);
1758 /* disable all interrupts */
1759 mask = (OHCI_INTR_SO | OHCI_INTR_WDH | OHCI_INTR_SF | OHCI_INTR_RD |
1760 OHCI_INTR_UE | OHCI_INTR_FNO | OHCI_INTR_RHSC |
1761 OHCI_INTR_OC | OHCI_INTR_MIE);
1762 ohci_writel(mask, &ohci->regs->intrdisable);
1763 /* clear all interrupts */
1764 mask &= ~OHCI_INTR_MIE;
1765 ohci_writel(mask, &ohci->regs->intrstatus);
1766 /* Choose the interrupts we care about now - but w/o MIE */
1767 mask = OHCI_INTR_RHSC | OHCI_INTR_UE | OHCI_INTR_WDH | OHCI_INTR_SO;
1768 ohci_writel(mask, &ohci->regs->intrenable);
1771 /* required for AMD-756 and some Mac platforms */
1772 ohci_writel((roothub_a(ohci) | RH_A_NPS) & ~RH_A_PSM,
1773 &ohci->regs->roothub.a);
1774 ohci_writel(RH_HS_LPSC, &ohci->regs->roothub.status);
1775 #endif /* OHCI_USE_NPS */
1777 /* POTPGT delay is bits 24-31, in 2 ms units. */
1778 mdelay((roothub_a(ohci) >> 23) & 0x1fe);
1780 /* connect the virtual root hub */
1781 ohci->rh.devnum = 0;
1786 /*-------------------------------------------------------------------------*/
1788 /* an interrupt happens */
1790 static int hc_interrupt(ohci_t *ohci)
1792 struct ohci_regs *regs = ohci->regs;
1796 invalidate_dcache_hcca(ohci->hcca);
1798 if ((ohci->hcca->done_head != 0) &&
1799 !(m32_swap(ohci->hcca->done_head) & 0x01)) {
1800 ints = OHCI_INTR_WDH;
1802 ints = ohci_readl(®s->intrstatus);
1803 if (ints == ~(u32)0) {
1805 err("%s device removed!", ohci->slot_name);
1808 ints &= ohci_readl(®s->intrenable);
1810 dbg("hc_interrupt: returning..\n");
1816 /* dbg("Interrupt: %x frame: %x", ints,
1817 le16_to_cpu(ohci->hcca->frame_no)); */
1819 if (ints & OHCI_INTR_RHSC)
1822 if (ints & OHCI_INTR_UE) {
1824 err("OHCI Unrecoverable Error, controller usb-%s disabled",
1826 /* e.g. due to PCI Master/Target Abort */
1833 /* FIXME: be optimistic, hope that bug won't repeat often. */
1834 /* Make some non-interrupt context restart the controller. */
1835 /* Count and limit the retries though; either hardware or */
1836 /* software errors can go forever... */
1841 if (ints & OHCI_INTR_WDH) {
1843 ohci_writel(OHCI_INTR_WDH, ®s->intrdisable);
1844 (void)ohci_readl(®s->intrdisable); /* flush */
1845 stat = dl_done_list(ohci);
1846 ohci_writel(OHCI_INTR_WDH, ®s->intrenable);
1847 (void)ohci_readl(®s->intrdisable); /* flush */
1850 if (ints & OHCI_INTR_SO) {
1851 dbg("USB Schedule overrun\n");
1852 ohci_writel(OHCI_INTR_SO, ®s->intrenable);
1856 /* FIXME: this assumes SOF (1/ms) interrupts don't get lost... */
1857 if (ints & OHCI_INTR_SF) {
1858 unsigned int frame = m16_swap(ohci->hcca->frame_no) & 1;
1860 ohci_writel(OHCI_INTR_SF, ®s->intrdisable);
1861 if (ohci->ed_rm_list[frame] != NULL)
1862 ohci_writel(OHCI_INTR_SF, ®s->intrenable);
1866 ohci_writel(ints, ®s->intrstatus);
1870 /*-------------------------------------------------------------------------*/
1872 /*-------------------------------------------------------------------------*/
1874 /* De-allocate all resources.. */
1876 static void hc_release_ohci(ohci_t *ohci)
1878 dbg("USB HC release ohci usb-%s", ohci->slot_name);
1880 if (!ohci->disabled)
1884 /*-------------------------------------------------------------------------*/
1887 * low level initalisation routine, called from usb.c
1889 static char ohci_inited = 0;
1891 int usb_lowlevel_init(int index, enum usb_init_type init, void **controller)
1893 #ifdef CONFIG_PCI_OHCI
1897 #ifdef CONFIG_SYS_USB_OHCI_CPU_INIT
1898 /* cpu dependant init */
1903 #ifdef CONFIG_SYS_USB_OHCI_BOARD_INIT
1904 /* board dependant init */
1905 if (board_usb_init(index, USB_INIT_HOST))
1908 memset(&gohci, 0, sizeof(ohci_t));
1910 /* align the storage */
1911 if ((__u32)&ghcca[0] & 0xff) {
1912 err("HCCA not aligned!!");
1915 gohci.hcca = &ghcca[0];
1916 info("aligned ghcca %p", gohci.hcca);
1917 memset(gohci.hcca, 0, sizeof(struct ohci_hcca));
1922 #ifdef CONFIG_PCI_OHCI
1923 pdev = pci_find_devices(ohci_pci_ids, CONFIG_PCI_OHCI_DEVNO);
1928 pci_read_config_word(pdev, PCI_VENDOR_ID, &vid);
1929 pci_read_config_word(pdev, PCI_DEVICE_ID, &did);
1930 printf("OHCI pci controller (%04x, %04x) found @(%d:%d:%d)\n",
1931 vid, did, (pdev >> 16) & 0xff,
1932 (pdev >> 11) & 0x1f, (pdev >> 8) & 0x7);
1933 pci_read_config_dword(pdev, PCI_BASE_ADDRESS_0, &base);
1934 printf("OHCI regs address 0x%08x\n", base);
1935 gohci.regs = (struct ohci_regs *)base;
1939 gohci.regs = (struct ohci_regs *)CONFIG_SYS_USB_OHCI_REGS_BASE;
1943 gohci.slot_name = CONFIG_SYS_USB_OHCI_SLOT_NAME;
1945 if (hc_reset (&gohci) < 0) {
1946 hc_release_ohci (&gohci);
1947 err ("can't reset usb-%s", gohci.slot_name);
1948 #ifdef CONFIG_SYS_USB_OHCI_BOARD_INIT
1949 /* board dependant cleanup */
1950 board_usb_cleanup(index, USB_INIT_HOST);
1953 #ifdef CONFIG_SYS_USB_OHCI_CPU_INIT
1954 /* cpu dependant cleanup */
1955 usb_cpu_init_fail();
1960 if (hc_start(&gohci) < 0) {
1961 err("can't start usb-%s", gohci.slot_name);
1962 hc_release_ohci(&gohci);
1963 /* Initialization failed */
1964 #ifdef CONFIG_SYS_USB_OHCI_BOARD_INIT
1965 /* board dependant cleanup */
1969 #ifdef CONFIG_SYS_USB_OHCI_CPU_INIT
1970 /* cpu dependant cleanup */
1977 ohci_dump(&gohci, 1);
1985 int usb_lowlevel_stop(int index)
1987 /* this gets called really early - before the controller has */
1988 /* even been initialized! */
1991 /* TODO release any interrupts, etc. */
1992 /* call hc_release_ohci() here ? */
1995 #ifdef CONFIG_SYS_USB_OHCI_BOARD_INIT
1996 /* board dependant cleanup */
1997 if (usb_board_stop())
2001 #ifdef CONFIG_SYS_USB_OHCI_CPU_INIT
2002 /* cpu dependant cleanup */
2006 /* This driver is no longer initialised. It needs a new low-level
2007 * init (board/cpu) before it can be used again. */
2012 int submit_control_msg(struct usb_device *dev, unsigned long pipe,
2013 void *buffer, int transfer_len, struct devrequest *setup)
2015 return _ohci_submit_control_msg(&gohci, dev, pipe, buffer,
2016 transfer_len, setup);