2 * OHCI HCD (Host Controller Driver) for USB.
4 * (C) Copyright 1999 Roman Weissgaerber <weissg@vienna.at>
5 * (C) Copyright 2000-2002 David Brownell <dbrownell@users.sourceforge.net>
7 * This file is licenced under the GPL.
10 /*-------------------------------------------------------------------------*/
14 #define edstring(ed_type) ({ char *temp; \
16 case PIPE_CONTROL: temp = "ctrl"; break; \
17 case PIPE_BULK: temp = "bulk"; break; \
18 case PIPE_INTERRUPT: temp = "intr"; break; \
19 default: temp = "isoc"; break; \
21 #define pipestring(pipe) edstring(usb_pipetype(pipe))
23 /* debug| print the main components of an URB
24 * small: 0) header + data packets 1) just header
26 static void __attribute__((unused))
27 urb_print (struct urb * urb, char * str, int small)
29 unsigned int pipe= urb->pipe;
31 if (!urb->dev || !urb->dev->bus) {
32 dbg("%s URB: no dev", str);
36 #ifndef OHCI_VERBOSE_DEBUG
39 dbg("%s %p dev=%d ep=%d%s-%s flags=%x len=%d/%d stat=%d",
42 usb_pipedevice (pipe),
43 usb_pipeendpoint (pipe),
44 usb_pipeout (pipe)? "out" : "in",
48 urb->transfer_buffer_length,
51 #ifdef OHCI_VERBOSE_DEBUG
55 if (usb_pipecontrol (pipe)) {
56 printk (KERN_DEBUG __FILE__ ": setup(8):");
57 for (i = 0; i < 8 ; i++)
58 printk (" %02x", ((__u8 *) urb->setup_packet) [i]);
61 if (urb->transfer_buffer_length > 0 && urb->transfer_buffer) {
62 printk (KERN_DEBUG __FILE__ ": data(%d/%d):",
64 urb->transfer_buffer_length);
65 len = usb_pipeout (pipe)?
66 urb->transfer_buffer_length: urb->actual_length;
67 for (i = 0; i < 16 && i < len; i++)
68 printk (" %02x", ((__u8 *) urb->transfer_buffer) [i]);
69 printk ("%s stat:%d\n", i < len? "...": "", urb->status);
75 #define ohci_dbg_sw(ohci, next, size, format, arg...) \
79 s_len = scnprintf (*next, *size, format, ## arg ); \
80 *size -= s_len; *next += s_len; \
82 ohci_dbg(ohci,format, ## arg ); \
86 static void ohci_dump_intr_mask (
87 struct ohci_hcd *ohci,
93 ohci_dbg_sw (ohci, next, size, "%s 0x%08x%s%s%s%s%s%s%s%s%s\n",
96 (mask & OHCI_INTR_MIE) ? " MIE" : "",
97 (mask & OHCI_INTR_OC) ? " OC" : "",
98 (mask & OHCI_INTR_RHSC) ? " RHSC" : "",
99 (mask & OHCI_INTR_FNO) ? " FNO" : "",
100 (mask & OHCI_INTR_UE) ? " UE" : "",
101 (mask & OHCI_INTR_RD) ? " RD" : "",
102 (mask & OHCI_INTR_SF) ? " SF" : "",
103 (mask & OHCI_INTR_WDH) ? " WDH" : "",
104 (mask & OHCI_INTR_SO) ? " SO" : ""
108 static void maybe_print_eds (
109 struct ohci_hcd *ohci,
116 ohci_dbg_sw (ohci, next, size, "%s %08x\n", label, value);
119 static char *hcfs2string (int state)
122 case OHCI_USB_RESET: return "reset";
123 case OHCI_USB_RESUME: return "resume";
124 case OHCI_USB_OPER: return "operational";
125 case OHCI_USB_SUSPEND: return "suspend";
130 // dump control and status registers
132 ohci_dump_status (struct ohci_hcd *controller, char **next, unsigned *size)
134 struct ohci_regs __iomem *regs = controller->regs;
137 temp = ohci_readl (controller, ®s->revision) & 0xff;
138 ohci_dbg_sw (controller, next, size,
139 "OHCI %d.%d, %s legacy support registers\n",
140 0x03 & (temp >> 4), (temp & 0x0f),
141 (temp & 0x0100) ? "with" : "NO");
143 temp = ohci_readl (controller, ®s->control);
144 ohci_dbg_sw (controller, next, size,
145 "control 0x%03x%s%s%s HCFS=%s%s%s%s%s CBSR=%d\n",
147 (temp & OHCI_CTRL_RWE) ? " RWE" : "",
148 (temp & OHCI_CTRL_RWC) ? " RWC" : "",
149 (temp & OHCI_CTRL_IR) ? " IR" : "",
150 hcfs2string (temp & OHCI_CTRL_HCFS),
151 (temp & OHCI_CTRL_BLE) ? " BLE" : "",
152 (temp & OHCI_CTRL_CLE) ? " CLE" : "",
153 (temp & OHCI_CTRL_IE) ? " IE" : "",
154 (temp & OHCI_CTRL_PLE) ? " PLE" : "",
155 temp & OHCI_CTRL_CBSR
158 temp = ohci_readl (controller, ®s->cmdstatus);
159 ohci_dbg_sw (controller, next, size,
160 "cmdstatus 0x%05x SOC=%d%s%s%s%s\n", temp,
161 (temp & OHCI_SOC) >> 16,
162 (temp & OHCI_OCR) ? " OCR" : "",
163 (temp & OHCI_BLF) ? " BLF" : "",
164 (temp & OHCI_CLF) ? " CLF" : "",
165 (temp & OHCI_HCR) ? " HCR" : ""
168 ohci_dump_intr_mask (controller, "intrstatus",
169 ohci_readl (controller, ®s->intrstatus),
171 ohci_dump_intr_mask (controller, "intrenable",
172 ohci_readl (controller, ®s->intrenable),
174 // intrdisable always same as intrenable
176 maybe_print_eds (controller, "ed_periodcurrent",
177 ohci_readl (controller, ®s->ed_periodcurrent),
180 maybe_print_eds (controller, "ed_controlhead",
181 ohci_readl (controller, ®s->ed_controlhead),
183 maybe_print_eds (controller, "ed_controlcurrent",
184 ohci_readl (controller, ®s->ed_controlcurrent),
187 maybe_print_eds (controller, "ed_bulkhead",
188 ohci_readl (controller, ®s->ed_bulkhead),
190 maybe_print_eds (controller, "ed_bulkcurrent",
191 ohci_readl (controller, ®s->ed_bulkcurrent),
194 maybe_print_eds (controller, "donehead",
195 ohci_readl (controller, ®s->donehead), next, size);
197 /* broken fminterval means traffic won't flow! */
198 ohci_dbg (controller, "fminterval %08x\n",
199 ohci_readl (controller, ®s->fminterval));
202 #define dbg_port_sw(hc,num,value,next,size) \
203 ohci_dbg_sw (hc, next, size, \
204 "roothub.portstatus [%d] " \
205 "0x%08x%s%s%s%s%s%s%s%s%s%s%s%s\n", \
207 (temp & RH_PS_PRSC) ? " PRSC" : "", \
208 (temp & RH_PS_OCIC) ? " OCIC" : "", \
209 (temp & RH_PS_PSSC) ? " PSSC" : "", \
210 (temp & RH_PS_PESC) ? " PESC" : "", \
211 (temp & RH_PS_CSC) ? " CSC" : "", \
213 (temp & RH_PS_LSDA) ? " LSDA" : "", \
214 (temp & RH_PS_PPS) ? " PPS" : "", \
215 (temp & RH_PS_PRS) ? " PRS" : "", \
216 (temp & RH_PS_POCI) ? " POCI" : "", \
217 (temp & RH_PS_PSS) ? " PSS" : "", \
219 (temp & RH_PS_PES) ? " PES" : "", \
220 (temp & RH_PS_CCS) ? " CCS" : "" \
226 struct ohci_hcd *controller,
233 temp = roothub_a (controller);
236 ndp = (temp & RH_A_NDP);
239 ohci_dbg_sw (controller, next, size,
240 "roothub.a %08x POTPGT=%d%s%s%s%s%s NDP=%d\n", temp,
241 ((temp & RH_A_POTPGT) >> 24) & 0xff,
242 (temp & RH_A_NOCP) ? " NOCP" : "",
243 (temp & RH_A_OCPM) ? " OCPM" : "",
244 (temp & RH_A_DT) ? " DT" : "",
245 (temp & RH_A_NPS) ? " NPS" : "",
246 (temp & RH_A_PSM) ? " PSM" : "",
249 temp = roothub_b (controller);
250 ohci_dbg_sw (controller, next, size,
251 "roothub.b %08x PPCM=%04x DR=%04x\n",
253 (temp & RH_B_PPCM) >> 16,
256 temp = roothub_status (controller);
257 ohci_dbg_sw (controller, next, size,
258 "roothub.status %08x%s%s%s%s%s%s\n",
260 (temp & RH_HS_CRWE) ? " CRWE" : "",
261 (temp & RH_HS_OCIC) ? " OCIC" : "",
262 (temp & RH_HS_LPSC) ? " LPSC" : "",
263 (temp & RH_HS_DRWE) ? " DRWE" : "",
264 (temp & RH_HS_OCI) ? " OCI" : "",
265 (temp & RH_HS_LPS) ? " LPS" : ""
269 for (i = 0; i < ndp; i++) {
270 temp = roothub_portstatus (controller, i);
271 dbg_port_sw (controller, i, temp, next, size);
275 static void ohci_dump (struct ohci_hcd *controller, int verbose)
277 ohci_dbg (controller, "OHCI controller state\n");
279 // dumps some of the state we know about
280 ohci_dump_status (controller, NULL, NULL);
281 if (controller->hcca)
282 ohci_dbg (controller,
283 "hcca frame #%04x\n", ohci_frame_no(controller));
284 ohci_dump_roothub (controller, 1, NULL, NULL);
287 static const char data0 [] = "DATA0";
288 static const char data1 [] = "DATA1";
290 static void ohci_dump_td (const struct ohci_hcd *ohci, const char *label,
293 u32 tmp = hc32_to_cpup (ohci, &td->hwINFO);
295 ohci_dbg (ohci, "%s td %p%s; urb %p index %d; hw next td %08x\n",
297 (tmp & TD_DONE) ? " (DONE)" : "",
299 hc32_to_cpup (ohci, &td->hwNextTD));
300 if ((tmp & TD_ISO) == 0) {
301 const char *toggle, *pid;
304 switch (tmp & TD_T) {
305 case TD_T_DATA0: toggle = data0; break;
306 case TD_T_DATA1: toggle = data1; break;
307 case TD_T_TOGGLE: toggle = "(CARRY)"; break;
308 default: toggle = "(?)"; break;
310 switch (tmp & TD_DP) {
311 case TD_DP_SETUP: pid = "SETUP"; break;
312 case TD_DP_IN: pid = "IN"; break;
313 case TD_DP_OUT: pid = "OUT"; break;
314 default: pid = "(bad pid)"; break;
316 ohci_dbg (ohci, " info %08x CC=%x %s DI=%d %s %s\n", tmp,
317 TD_CC_GET(tmp), /* EC, */ toggle,
318 (tmp & TD_DI) >> 21, pid,
319 (tmp & TD_R) ? "R" : "");
320 cbp = hc32_to_cpup (ohci, &td->hwCBP);
321 be = hc32_to_cpup (ohci, &td->hwBE);
322 ohci_dbg (ohci, " cbp %08x be %08x (len %d)\n", cbp, be,
323 cbp ? (be + 1 - cbp) : 0);
326 ohci_dbg (ohci, " info %08x CC=%x FC=%d DI=%d SF=%04x\n", tmp,
331 ohci_dbg (ohci, " bp0 %08x be %08x\n",
332 hc32_to_cpup (ohci, &td->hwCBP) & ~0x0fff,
333 hc32_to_cpup (ohci, &td->hwBE));
334 for (i = 0; i < MAXPSW; i++) {
335 u16 psw = ohci_hwPSW (ohci, td, i);
336 int cc = (psw >> 12) & 0x0f;
337 ohci_dbg (ohci, " psw [%d] = %2x, CC=%x %s=%d\n", i,
339 (cc >= 0x0e) ? "OFFSET" : "SIZE",
345 /* caller MUST own hcd spinlock if verbose is set! */
346 static void __attribute__((unused))
347 ohci_dump_ed (const struct ohci_hcd *ohci, const char *label,
348 const struct ed *ed, int verbose)
350 u32 tmp = hc32_to_cpu (ohci, ed->hwINFO);
353 ohci_dbg (ohci, "%s, ed %p state 0x%x type %s; next ed %08x\n",
355 ed, ed->state, edstring (ed->type),
356 hc32_to_cpup (ohci, &ed->hwNextED));
357 switch (tmp & (ED_IN|ED_OUT)) {
358 case ED_OUT: type = "-OUT"; break;
359 case ED_IN: type = "-IN"; break;
360 /* else from TDs ... control */
363 " info %08x MAX=%d%s%s%s%s EP=%d%s DEV=%d\n", tmp,
364 0x03ff & (tmp >> 16),
365 (tmp & ED_DEQUEUE) ? " DQ" : "",
366 (tmp & ED_ISO) ? " ISO" : "",
367 (tmp & ED_SKIP) ? " SKIP" : "",
368 (tmp & ED_LOWSPEED) ? " LOW" : "",
372 tmp = hc32_to_cpup (ohci, &ed->hwHeadP);
373 ohci_dbg (ohci, " tds: head %08x %s%s tail %08x%s\n",
375 (tmp & ED_C) ? data1 : data0,
376 (tmp & ED_H) ? " HALT" : "",
377 hc32_to_cpup (ohci, &ed->hwTailP),
378 verbose ? "" : " (not listing)");
380 struct list_head *tmp;
382 /* use ed->td_list because HC concurrently modifies
383 * hwNextTD as it accumulates ed_donelist.
385 list_for_each (tmp, &ed->td_list) {
387 td = list_entry (tmp, struct td, td_list);
388 ohci_dump_td (ohci, " ->", td);
394 static inline void ohci_dump (struct ohci_hcd *controller, int verbose) {}
396 #undef OHCI_VERBOSE_DEBUG
400 /*-------------------------------------------------------------------------*/
402 #ifdef STUB_DEBUG_FILES
404 static inline void create_debug_files (struct ohci_hcd *bus) { }
405 static inline void remove_debug_files (struct ohci_hcd *bus) { }
410 show_list (struct ohci_hcd *ohci, char *buf, size_t count, struct ed *ed)
412 unsigned temp, size = count;
417 /* print first --> last */
421 /* dump a snapshot of the bulk or control schedule */
423 u32 info = hc32_to_cpu (ohci, ed->hwINFO);
424 u32 headp = hc32_to_cpu (ohci, ed->hwHeadP);
425 struct list_head *entry;
428 temp = scnprintf (buf, size,
429 "ed/%p %cs dev%d ep%d%s max %d %08x%s%s %s",
431 (info & ED_LOWSPEED) ? 'l' : 'f',
434 (info & ED_IN) ? "in" : "out",
435 0x03ff & (info >> 16),
437 (info & ED_SKIP) ? " s" : "",
438 (headp & ED_H) ? " H" : "",
439 (headp & ED_C) ? data1 : data0);
443 list_for_each (entry, &ed->td_list) {
446 td = list_entry (entry, struct td, td_list);
447 info = hc32_to_cpup (ohci, &td->hwINFO);
448 cbp = hc32_to_cpup (ohci, &td->hwCBP);
449 be = hc32_to_cpup (ohci, &td->hwBE);
450 temp = scnprintf (buf, size,
451 "\n\ttd %p %s %d cc=%x urb %p (%08x)",
454 switch (info & TD_DP) {
455 case TD_DP_SETUP: pid = "setup"; break;
456 case TD_DP_IN: pid = "in"; break;
457 case TD_DP_OUT: pid = "out"; break;
458 default: pid = "(?)"; break;
460 cbp ? (be + 1 - cbp) : 0,
461 TD_CC_GET (info), td->urb, info);
466 temp = scnprintf (buf, size, "\n");
476 show_async (struct class_device *class_dev, char *buf)
480 struct ohci_hcd *ohci;
484 bus = class_get_devdata(class_dev);
486 ohci = hcd_to_ohci(hcd);
488 /* display control and bulk lists together, for simplicity */
489 spin_lock_irqsave (&ohci->lock, flags);
490 temp = show_list (ohci, buf, PAGE_SIZE, ohci->ed_controltail);
491 temp += show_list (ohci, buf + temp, PAGE_SIZE - temp, ohci->ed_bulktail);
492 spin_unlock_irqrestore (&ohci->lock, flags);
496 static CLASS_DEVICE_ATTR (async, S_IRUGO, show_async, NULL);
499 #define DBG_SCHED_LIMIT 64
502 show_periodic (struct class_device *class_dev, char *buf)
506 struct ohci_hcd *ohci;
507 struct ed **seen, *ed;
509 unsigned temp, size, seen_count;
513 if (!(seen = kmalloc (DBG_SCHED_LIMIT * sizeof *seen, SLAB_ATOMIC)))
517 bus = class_get_devdata(class_dev);
519 ohci = hcd_to_ohci(hcd);
523 temp = scnprintf (next, size, "size = %d\n", NUM_INTS);
527 /* dump a snapshot of the periodic schedule (and load) */
528 spin_lock_irqsave (&ohci->lock, flags);
529 for (i = 0; i < NUM_INTS; i++) {
530 if (!(ed = ohci->periodic [i]))
533 temp = scnprintf (next, size, "%2d [%3d]:", i, ohci->load [i]);
538 temp = scnprintf (next, size, " ed%d/%p",
542 for (temp = 0; temp < seen_count; temp++) {
543 if (seen [temp] == ed)
547 /* show more info the first time around */
548 if (temp == seen_count) {
549 u32 info = hc32_to_cpu (ohci, ed->hwINFO);
550 struct list_head *entry;
553 /* qlen measured here in TDs, not urbs */
554 list_for_each (entry, &ed->td_list)
557 temp = scnprintf (next, size,
558 " (%cs dev%d ep%d%s-%s qlen %u"
560 (info & ED_LOWSPEED) ? 'l' : 'f',
563 (info & ED_IN) ? "in" : "out",
564 (info & ED_ISO) ? "iso" : "int",
566 0x03ff & (info >> 16),
568 (info & ED_SKIP) ? " K" : "",
570 cpu_to_hc32(ohci, ED_H)) ?
575 if (seen_count < DBG_SCHED_LIMIT)
576 seen [seen_count++] = ed;
581 /* we've seen it and what's after */
588 temp = scnprintf (next, size, "\n");
592 spin_unlock_irqrestore (&ohci->lock, flags);
595 return PAGE_SIZE - size;
597 static CLASS_DEVICE_ATTR (periodic, S_IRUGO, show_periodic, NULL);
600 #undef DBG_SCHED_LIMIT
603 show_registers (struct class_device *class_dev, char *buf)
607 struct ohci_hcd *ohci;
608 struct ohci_regs __iomem *regs;
614 bus = class_get_devdata(class_dev);
616 ohci = hcd_to_ohci(hcd);
621 spin_lock_irqsave (&ohci->lock, flags);
623 /* dump driver info, then registers in spec order */
625 ohci_dbg_sw (ohci, &next, &size,
626 "bus %s, device %s\n"
628 "%s version " DRIVER_VERSION "\n",
629 hcd->self.controller->bus->name,
630 hcd->self.controller->bus_id,
634 if (bus->controller->power.power_state) {
635 size -= scnprintf (next, size,
636 "SUSPENDED (no register access)\n");
640 ohci_dump_status(ohci, &next, &size);
644 ohci_dbg_sw (ohci, &next, &size,
645 "hcca frame 0x%04x\n", ohci_frame_no(ohci));
647 /* other registers mostly affect frame timings */
648 rdata = ohci_readl (ohci, ®s->fminterval);
649 temp = scnprintf (next, size,
650 "fmintvl 0x%08x %sFSMPS=0x%04x FI=0x%04x\n",
651 rdata, (rdata >> 31) ? "FIT " : "",
652 (rdata >> 16) & 0xefff, rdata & 0xffff);
656 rdata = ohci_readl (ohci, ®s->fmremaining);
657 temp = scnprintf (next, size, "fmremaining 0x%08x %sFR=0x%04x\n",
658 rdata, (rdata >> 31) ? "FRT " : "",
663 rdata = ohci_readl (ohci, ®s->periodicstart);
664 temp = scnprintf (next, size, "periodicstart 0x%04x\n",
669 rdata = ohci_readl (ohci, ®s->lsthresh);
670 temp = scnprintf (next, size, "lsthresh 0x%04x\n",
676 ohci_dump_roothub (ohci, 1, &next, &size);
679 spin_unlock_irqrestore (&ohci->lock, flags);
680 return PAGE_SIZE - size;
682 static CLASS_DEVICE_ATTR (registers, S_IRUGO, show_registers, NULL);
685 static inline void create_debug_files (struct ohci_hcd *ohci)
687 struct class_device *cldev = ohci_to_hcd(ohci)->self.class_dev;
689 class_device_create_file(cldev, &class_device_attr_async);
690 class_device_create_file(cldev, &class_device_attr_periodic);
691 class_device_create_file(cldev, &class_device_attr_registers);
692 ohci_dbg (ohci, "created debug files\n");
695 static inline void remove_debug_files (struct ohci_hcd *ohci)
697 struct class_device *cldev = ohci_to_hcd(ohci)->self.class_dev;
699 class_device_remove_file(cldev, &class_device_attr_async);
700 class_device_remove_file(cldev, &class_device_attr_periodic);
701 class_device_remove_file(cldev, &class_device_attr_registers);
706 /*-------------------------------------------------------------------------*/