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 (®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
& 0x10) ? "with" : "NO");
143 temp
= ohci_readl (®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 (®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 (®s
->intrstatus
), next
, size
);
170 ohci_dump_intr_mask (controller
, "intrenable",
171 ohci_readl (®s
->intrenable
), next
, size
);
172 // intrdisable always same as intrenable
174 maybe_print_eds (controller
, "ed_periodcurrent",
175 ohci_readl (®s
->ed_periodcurrent
), next
, size
);
177 maybe_print_eds (controller
, "ed_controlhead",
178 ohci_readl (®s
->ed_controlhead
), next
, size
);
179 maybe_print_eds (controller
, "ed_controlcurrent",
180 ohci_readl (®s
->ed_controlcurrent
), next
, size
);
182 maybe_print_eds (controller
, "ed_bulkhead",
183 ohci_readl (®s
->ed_bulkhead
), next
, size
);
184 maybe_print_eds (controller
, "ed_bulkcurrent",
185 ohci_readl (®s
->ed_bulkcurrent
), next
, size
);
187 maybe_print_eds (controller
, "donehead",
188 ohci_readl (®s
->donehead
), next
, size
);
191 #define dbg_port_sw(hc,num,value,next,size) \
192 ohci_dbg_sw (hc, next, size, \
193 "roothub.portstatus [%d] " \
194 "0x%08x%s%s%s%s%s%s%s%s%s%s%s%s\n", \
196 (temp & RH_PS_PRSC) ? " PRSC" : "", \
197 (temp & RH_PS_OCIC) ? " OCIC" : "", \
198 (temp & RH_PS_PSSC) ? " PSSC" : "", \
199 (temp & RH_PS_PESC) ? " PESC" : "", \
200 (temp & RH_PS_CSC) ? " CSC" : "", \
202 (temp & RH_PS_LSDA) ? " LSDA" : "", \
203 (temp & RH_PS_PPS) ? " PPS" : "", \
204 (temp & RH_PS_PRS) ? " PRS" : "", \
205 (temp & RH_PS_POCI) ? " POCI" : "", \
206 (temp & RH_PS_PSS) ? " PSS" : "", \
208 (temp & RH_PS_PES) ? " PES" : "", \
209 (temp & RH_PS_CCS) ? " CCS" : "" \
215 struct ohci_hcd
*controller
,
222 temp
= roothub_a (controller
);
225 ndp
= (temp
& RH_A_NDP
);
228 ohci_dbg_sw (controller
, next
, size
,
229 "roothub.a %08x POTPGT=%d%s%s%s%s%s NDP=%d\n", temp
,
230 ((temp
& RH_A_POTPGT
) >> 24) & 0xff,
231 (temp
& RH_A_NOCP
) ? " NOCP" : "",
232 (temp
& RH_A_OCPM
) ? " OCPM" : "",
233 (temp
& RH_A_DT
) ? " DT" : "",
234 (temp
& RH_A_NPS
) ? " NPS" : "",
235 (temp
& RH_A_PSM
) ? " PSM" : "",
238 temp
= roothub_b (controller
);
239 ohci_dbg_sw (controller
, next
, size
,
240 "roothub.b %08x PPCM=%04x DR=%04x\n",
242 (temp
& RH_B_PPCM
) >> 16,
245 temp
= roothub_status (controller
);
246 ohci_dbg_sw (controller
, next
, size
,
247 "roothub.status %08x%s%s%s%s%s%s\n",
249 (temp
& RH_HS_CRWE
) ? " CRWE" : "",
250 (temp
& RH_HS_OCIC
) ? " OCIC" : "",
251 (temp
& RH_HS_LPSC
) ? " LPSC" : "",
252 (temp
& RH_HS_DRWE
) ? " DRWE" : "",
253 (temp
& RH_HS_OCI
) ? " OCI" : "",
254 (temp
& RH_HS_LPS
) ? " LPS" : ""
258 for (i
= 0; i
< ndp
; i
++) {
259 temp
= roothub_portstatus (controller
, i
);
260 dbg_port_sw (controller
, i
, temp
, next
, size
);
264 static void ohci_dump (struct ohci_hcd
*controller
, int verbose
)
266 ohci_dbg (controller
, "OHCI controller state\n");
268 // dumps some of the state we know about
269 ohci_dump_status (controller
, NULL
, NULL
);
270 if (controller
->hcca
)
271 ohci_dbg (controller
,
272 "hcca frame #%04x\n", OHCI_FRAME_NO(controller
->hcca
));
273 ohci_dump_roothub (controller
, 1, NULL
, NULL
);
276 static const char data0
[] = "DATA0";
277 static const char data1
[] = "DATA1";
279 static void ohci_dump_td (const struct ohci_hcd
*ohci
, const char *label
,
282 u32 tmp
= le32_to_cpup (&td
->hwINFO
);
284 ohci_dbg (ohci
, "%s td %p%s; urb %p index %d; hw next td %08x\n",
286 (tmp
& TD_DONE
) ? " (DONE)" : "",
288 le32_to_cpup (&td
->hwNextTD
));
289 if ((tmp
& TD_ISO
) == 0) {
290 const char *toggle
, *pid
;
293 switch (tmp
& TD_T
) {
294 case TD_T_DATA0
: toggle
= data0
; break;
295 case TD_T_DATA1
: toggle
= data1
; break;
296 case TD_T_TOGGLE
: toggle
= "(CARRY)"; break;
297 default: toggle
= "(?)"; break;
299 switch (tmp
& TD_DP
) {
300 case TD_DP_SETUP
: pid
= "SETUP"; break;
301 case TD_DP_IN
: pid
= "IN"; break;
302 case TD_DP_OUT
: pid
= "OUT"; break;
303 default: pid
= "(bad pid)"; break;
305 ohci_dbg (ohci
, " info %08x CC=%x %s DI=%d %s %s\n", tmp
,
306 TD_CC_GET(tmp
), /* EC, */ toggle
,
307 (tmp
& TD_DI
) >> 21, pid
,
308 (tmp
& TD_R
) ? "R" : "");
309 cbp
= le32_to_cpup (&td
->hwCBP
);
310 be
= le32_to_cpup (&td
->hwBE
);
311 ohci_dbg (ohci
, " cbp %08x be %08x (len %d)\n", cbp
, be
,
312 cbp
? (be
+ 1 - cbp
) : 0);
315 ohci_dbg (ohci
, " info %08x CC=%x FC=%d DI=%d SF=%04x\n", tmp
,
320 ohci_dbg (ohci
, " bp0 %08x be %08x\n",
321 le32_to_cpup (&td
->hwCBP
) & ~0x0fff,
322 le32_to_cpup (&td
->hwBE
));
323 for (i
= 0; i
< MAXPSW
; i
++) {
324 u16 psw
= le16_to_cpup (&td
->hwPSW
[i
]);
325 int cc
= (psw
>> 12) & 0x0f;
326 ohci_dbg (ohci
, " psw [%d] = %2x, CC=%x %s=%d\n", i
,
328 (cc
>= 0x0e) ? "OFFSET" : "SIZE",
334 /* caller MUST own hcd spinlock if verbose is set! */
335 static void __attribute__((unused
))
336 ohci_dump_ed (const struct ohci_hcd
*ohci
, const char *label
,
337 const struct ed
*ed
, int verbose
)
339 __le32 tmp
= ed
->hwINFO
;
342 ohci_dbg (ohci
, "%s, ed %p state 0x%x type %s; next ed %08x\n",
344 ed
, ed
->state
, edstring (ed
->type
),
345 le32_to_cpup (&ed
->hwNextED
));
346 switch (tmp
& (ED_IN
|ED_OUT
)) {
347 case ED_OUT
: type
= "-OUT"; break;
348 case ED_IN
: type
= "-IN"; break;
349 /* else from TDs ... control */
352 " info %08x MAX=%d%s%s%s%s EP=%d%s DEV=%d\n", le32_to_cpu (tmp
),
353 0x03ff & (le32_to_cpu (tmp
) >> 16),
354 (tmp
& ED_DEQUEUE
) ? " DQ" : "",
355 (tmp
& ED_ISO
) ? " ISO" : "",
356 (tmp
& ED_SKIP
) ? " SKIP" : "",
357 (tmp
& ED_LOWSPEED
) ? " LOW" : "",
358 0x000f & (le32_to_cpu (tmp
) >> 7),
360 0x007f & le32_to_cpu (tmp
));
361 ohci_dbg (ohci
, " tds: head %08x %s%s tail %08x%s\n",
362 le32_to_cpup (&ed
->hwHeadP
),
363 (ed
->hwHeadP
& ED_C
) ? data1
: data0
,
364 (ed
->hwHeadP
& ED_H
) ? " HALT" : "",
365 le32_to_cpup (&ed
->hwTailP
),
366 verbose
? "" : " (not listing)");
368 struct list_head
*tmp
;
370 /* use ed->td_list because HC concurrently modifies
371 * hwNextTD as it accumulates ed_donelist.
373 list_for_each (tmp
, &ed
->td_list
) {
375 td
= list_entry (tmp
, struct td
, td_list
);
376 ohci_dump_td (ohci
, " ->", td
);
382 static inline void ohci_dump (struct ohci_hcd
*controller
, int verbose
) {}
384 #undef OHCI_VERBOSE_DEBUG
388 /*-------------------------------------------------------------------------*/
390 #ifdef STUB_DEBUG_FILES
392 static inline void create_debug_files (struct ohci_hcd
*bus
) { }
393 static inline void remove_debug_files (struct ohci_hcd
*bus
) { }
397 static inline struct ohci_hcd
*dev_to_ohci (struct device
*dev
)
399 struct usb_hcd
*hcd
= dev_get_drvdata (dev
);
401 return hcd_to_ohci (hcd
);
405 show_list (struct ohci_hcd
*ohci
, char *buf
, size_t count
, struct ed
*ed
)
407 unsigned temp
, size
= count
;
412 /* print first --> last */
416 /* dump a snapshot of the bulk or control schedule */
418 __le32 info
= ed
->hwINFO
;
419 u32 scratch
= le32_to_cpup (&ed
->hwINFO
);
420 struct list_head
*entry
;
423 temp
= scnprintf (buf
, size
,
424 "ed/%p %cs dev%d ep%d%s max %d %08x%s%s %s",
426 (info
& ED_LOWSPEED
) ? 'l' : 'f',
428 (scratch
>> 7) & 0xf,
429 (info
& ED_IN
) ? "in" : "out",
430 0x03ff & (scratch
>> 16),
432 (info
& ED_SKIP
) ? " s" : "",
433 (ed
->hwHeadP
& ED_H
) ? " H" : "",
434 (ed
->hwHeadP
& ED_C
) ? data1
: data0
);
438 list_for_each (entry
, &ed
->td_list
) {
441 td
= list_entry (entry
, struct td
, td_list
);
442 scratch
= le32_to_cpup (&td
->hwINFO
);
443 cbp
= le32_to_cpup (&td
->hwCBP
);
444 be
= le32_to_cpup (&td
->hwBE
);
445 temp
= scnprintf (buf
, size
,
446 "\n\ttd %p %s %d cc=%x urb %p (%08x)",
449 switch (scratch
& TD_DP
) {
450 case TD_DP_SETUP
: pid
= "setup"; break;
451 case TD_DP_IN
: pid
= "in"; break;
452 case TD_DP_OUT
: pid
= "out"; break;
453 default: pid
= "(?)"; break;
455 cbp
? (be
+ 1 - cbp
) : 0,
456 TD_CC_GET (scratch
), td
->urb
, scratch
);
461 temp
= scnprintf (buf
, size
, "\n");
471 show_async (struct class_device
*class_dev
, char *buf
)
475 struct ohci_hcd
*ohci
;
479 bus
= to_usb_bus(class_dev
);
481 ohci
= hcd_to_ohci(hcd
);
483 /* display control and bulk lists together, for simplicity */
484 spin_lock_irqsave (&ohci
->lock
, flags
);
485 temp
= show_list (ohci
, buf
, PAGE_SIZE
, ohci
->ed_controltail
);
486 temp
+= show_list (ohci
, buf
+ temp
, PAGE_SIZE
- temp
, ohci
->ed_bulktail
);
487 spin_unlock_irqrestore (&ohci
->lock
, flags
);
491 static CLASS_DEVICE_ATTR (async
, S_IRUGO
, show_async
, NULL
);
494 #define DBG_SCHED_LIMIT 64
497 show_periodic (struct class_device
*class_dev
, char *buf
)
501 struct ohci_hcd
*ohci
;
502 struct ed
**seen
, *ed
;
504 unsigned temp
, size
, seen_count
;
508 if (!(seen
= kmalloc (DBG_SCHED_LIMIT
* sizeof *seen
, SLAB_ATOMIC
)))
512 bus
= to_usb_bus(class_dev
);
514 ohci
= hcd_to_ohci(hcd
);
518 temp
= scnprintf (next
, size
, "size = %d\n", NUM_INTS
);
522 /* dump a snapshot of the periodic schedule (and load) */
523 spin_lock_irqsave (&ohci
->lock
, flags
);
524 for (i
= 0; i
< NUM_INTS
; i
++) {
525 if (!(ed
= ohci
->periodic
[i
]))
528 temp
= scnprintf (next
, size
, "%2d [%3d]:", i
, ohci
->load
[i
]);
533 temp
= scnprintf (next
, size
, " ed%d/%p",
537 for (temp
= 0; temp
< seen_count
; temp
++) {
538 if (seen
[temp
] == ed
)
542 /* show more info the first time around */
543 if (temp
== seen_count
) {
544 __le32 info
= ed
->hwINFO
;
545 u32 scratch
= le32_to_cpup (&ed
->hwINFO
);
546 struct list_head
*entry
;
549 /* qlen measured here in TDs, not urbs */
550 list_for_each (entry
, &ed
->td_list
)
553 temp
= scnprintf (next
, size
,
554 " (%cs dev%d ep%d%s-%s qlen %u"
556 (info
& ED_LOWSPEED
) ? 'l' : 'f',
558 (scratch
>> 7) & 0xf,
559 (info
& ED_IN
) ? "in" : "out",
560 (info
& ED_ISO
) ? "iso" : "int",
562 0x03ff & (scratch
>> 16),
564 (info
& ED_SKIP
) ? " K" : "",
565 (ed
->hwHeadP
& ED_H
) ? " H" : "");
569 if (seen_count
< DBG_SCHED_LIMIT
)
570 seen
[seen_count
++] = ed
;
575 /* we've seen it and what's after */
582 temp
= scnprintf (next
, size
, "\n");
586 spin_unlock_irqrestore (&ohci
->lock
, flags
);
589 return PAGE_SIZE
- size
;
591 static CLASS_DEVICE_ATTR (periodic
, S_IRUGO
, show_periodic
, NULL
);
594 #undef DBG_SCHED_LIMIT
597 show_registers (struct class_device
*class_dev
, char *buf
)
601 struct ohci_hcd
*ohci
;
602 struct ohci_regs __iomem
*regs
;
608 bus
= to_usb_bus(class_dev
);
610 ohci
= hcd_to_ohci(hcd
);
615 spin_lock_irqsave (&ohci
->lock
, flags
);
617 /* dump driver info, then registers in spec order */
619 ohci_dbg_sw (ohci
, &next
, &size
,
620 "bus %s, device %s\n"
621 "%s version " DRIVER_VERSION
"\n",
622 hcd
->self
.controller
->bus
->name
,
623 hcd
->self
.controller
->bus_id
,
626 if (bus
->controller
->power
.power_state
) {
627 size
-= scnprintf (next
, size
,
628 "SUSPENDED (no register access)\n");
632 ohci_dump_status(ohci
, &next
, &size
);
636 ohci_dbg_sw (ohci
, &next
, &size
,
637 "hcca frame 0x%04x\n", OHCI_FRAME_NO(ohci
->hcca
));
639 /* other registers mostly affect frame timings */
640 rdata
= ohci_readl (®s
->fminterval
);
641 temp
= scnprintf (next
, size
,
642 "fmintvl 0x%08x %sFSMPS=0x%04x FI=0x%04x\n",
643 rdata
, (rdata
>> 31) ? " FIT" : "",
644 (rdata
>> 16) & 0xefff, rdata
& 0xffff);
648 rdata
= ohci_readl (®s
->fmremaining
);
649 temp
= scnprintf (next
, size
, "fmremaining 0x%08x %sFR=0x%04x\n",
650 rdata
, (rdata
>> 31) ? " FRT" : "",
655 rdata
= ohci_readl (®s
->periodicstart
);
656 temp
= scnprintf (next
, size
, "periodicstart 0x%04x\n",
661 rdata
= ohci_readl (®s
->lsthresh
);
662 temp
= scnprintf (next
, size
, "lsthresh 0x%04x\n",
668 ohci_dump_roothub (ohci
, 1, &next
, &size
);
671 spin_unlock_irqrestore (&ohci
->lock
, flags
);
672 return PAGE_SIZE
- size
;
674 static CLASS_DEVICE_ATTR (registers
, S_IRUGO
, show_registers
, NULL
);
677 static inline void create_debug_files (struct ohci_hcd
*bus
)
679 class_device_create_file(&bus
->hcd
.self
.class_dev
, &class_device_attr_async
);
680 class_device_create_file(&bus
->hcd
.self
.class_dev
, &class_device_attr_periodic
);
681 class_device_create_file(&bus
->hcd
.self
.class_dev
, &class_device_attr_registers
);
682 ohci_dbg (bus
, "created debug files\n");
685 static inline void remove_debug_files (struct ohci_hcd
*bus
)
687 class_device_remove_file(&bus
->hcd
.self
.class_dev
, &class_device_attr_async
);
688 class_device_remove_file(&bus
->hcd
.self
.class_dev
, &class_device_attr_periodic
);
689 class_device_remove_file(&bus
->hcd
.self
.class_dev
, &class_device_attr_registers
);
694 /*-------------------------------------------------------------------------*/