1 // SPDX-License-Identifier: GPL-1.0+
3 * OHCI HCD (Host Controller Driver) for USB.
5 * (C) Copyright 1999 Roman Weissgaerber <weissg@vienna.at>
6 * (C) Copyright 2000-2002 David Brownell <dbrownell@users.sourceforge.net>
8 * This file is licenced under the GPL.
11 /*-------------------------------------------------------------------------*/
13 #define edstring(ed_type) ({ char *temp; \
15 case PIPE_CONTROL: temp = "ctrl"; break; \
16 case PIPE_BULK: temp = "bulk"; break; \
17 case PIPE_INTERRUPT: temp = "intr"; break; \
18 default: temp = "isoc"; break; \
20 #define pipestring(pipe) edstring(usb_pipetype(pipe))
23 #define ohci_dbg_sw(ohci, next, size, format, arg...) \
27 s_len = scnprintf (*next, *size, format, ## arg ); \
28 *size -= s_len; *next += s_len; \
30 ohci_dbg(ohci,format, ## arg ); \
33 /* Version for use where "next" is the address of a local variable */
34 #define ohci_dbg_nosw(ohci, next, size, format, arg...) \
37 s_len = scnprintf(*next, *size, format, ## arg); \
38 *size -= s_len; *next += s_len; \
42 static void ohci_dump_intr_mask (
43 struct ohci_hcd
*ohci
,
49 ohci_dbg_sw (ohci
, next
, size
, "%s 0x%08x%s%s%s%s%s%s%s%s%s\n",
52 (mask
& OHCI_INTR_MIE
) ? " MIE" : "",
53 (mask
& OHCI_INTR_OC
) ? " OC" : "",
54 (mask
& OHCI_INTR_RHSC
) ? " RHSC" : "",
55 (mask
& OHCI_INTR_FNO
) ? " FNO" : "",
56 (mask
& OHCI_INTR_UE
) ? " UE" : "",
57 (mask
& OHCI_INTR_RD
) ? " RD" : "",
58 (mask
& OHCI_INTR_SF
) ? " SF" : "",
59 (mask
& OHCI_INTR_WDH
) ? " WDH" : "",
60 (mask
& OHCI_INTR_SO
) ? " SO" : ""
64 static void maybe_print_eds (
65 struct ohci_hcd
*ohci
,
72 ohci_dbg_sw (ohci
, next
, size
, "%s %08x\n", label
, value
);
75 static char *hcfs2string (int state
)
78 case OHCI_USB_RESET
: return "reset";
79 case OHCI_USB_RESUME
: return "resume";
80 case OHCI_USB_OPER
: return "operational";
81 case OHCI_USB_SUSPEND
: return "suspend";
86 static const char *rh_state_string(struct ohci_hcd
*ohci
)
88 switch (ohci
->rh_state
) {
91 case OHCI_RH_SUSPENDED
:
99 // dump control and status registers
101 ohci_dump_status (struct ohci_hcd
*controller
, char **next
, unsigned *size
)
103 struct ohci_regs __iomem
*regs
= controller
->regs
;
106 temp
= ohci_readl (controller
, ®s
->revision
) & 0xff;
107 ohci_dbg_sw (controller
, next
, size
,
108 "OHCI %d.%d, %s legacy support registers, rh state %s\n",
109 0x03 & (temp
>> 4), (temp
& 0x0f),
110 (temp
& 0x0100) ? "with" : "NO",
111 rh_state_string(controller
));
113 temp
= ohci_readl (controller
, ®s
->control
);
114 ohci_dbg_sw (controller
, next
, size
,
115 "control 0x%03x%s%s%s HCFS=%s%s%s%s%s CBSR=%d\n",
117 (temp
& OHCI_CTRL_RWE
) ? " RWE" : "",
118 (temp
& OHCI_CTRL_RWC
) ? " RWC" : "",
119 (temp
& OHCI_CTRL_IR
) ? " IR" : "",
120 hcfs2string (temp
& OHCI_CTRL_HCFS
),
121 (temp
& OHCI_CTRL_BLE
) ? " BLE" : "",
122 (temp
& OHCI_CTRL_CLE
) ? " CLE" : "",
123 (temp
& OHCI_CTRL_IE
) ? " IE" : "",
124 (temp
& OHCI_CTRL_PLE
) ? " PLE" : "",
125 temp
& OHCI_CTRL_CBSR
128 temp
= ohci_readl (controller
, ®s
->cmdstatus
);
129 ohci_dbg_sw (controller
, next
, size
,
130 "cmdstatus 0x%05x SOC=%d%s%s%s%s\n", temp
,
131 (temp
& OHCI_SOC
) >> 16,
132 (temp
& OHCI_OCR
) ? " OCR" : "",
133 (temp
& OHCI_BLF
) ? " BLF" : "",
134 (temp
& OHCI_CLF
) ? " CLF" : "",
135 (temp
& OHCI_HCR
) ? " HCR" : ""
138 ohci_dump_intr_mask (controller
, "intrstatus",
139 ohci_readl (controller
, ®s
->intrstatus
),
141 ohci_dump_intr_mask (controller
, "intrenable",
142 ohci_readl (controller
, ®s
->intrenable
),
144 // intrdisable always same as intrenable
146 maybe_print_eds (controller
, "ed_periodcurrent",
147 ohci_readl (controller
, ®s
->ed_periodcurrent
),
150 maybe_print_eds (controller
, "ed_controlhead",
151 ohci_readl (controller
, ®s
->ed_controlhead
),
153 maybe_print_eds (controller
, "ed_controlcurrent",
154 ohci_readl (controller
, ®s
->ed_controlcurrent
),
157 maybe_print_eds (controller
, "ed_bulkhead",
158 ohci_readl (controller
, ®s
->ed_bulkhead
),
160 maybe_print_eds (controller
, "ed_bulkcurrent",
161 ohci_readl (controller
, ®s
->ed_bulkcurrent
),
164 maybe_print_eds (controller
, "donehead",
165 ohci_readl (controller
, ®s
->donehead
), next
, size
);
168 #define dbg_port_sw(hc,num,value,next,size) \
169 ohci_dbg_sw (hc, next, size, \
170 "roothub.portstatus [%d] " \
171 "0x%08x%s%s%s%s%s%s%s%s%s%s%s%s\n", \
173 (temp & RH_PS_PRSC) ? " PRSC" : "", \
174 (temp & RH_PS_OCIC) ? " OCIC" : "", \
175 (temp & RH_PS_PSSC) ? " PSSC" : "", \
176 (temp & RH_PS_PESC) ? " PESC" : "", \
177 (temp & RH_PS_CSC) ? " CSC" : "", \
179 (temp & RH_PS_LSDA) ? " LSDA" : "", \
180 (temp & RH_PS_PPS) ? " PPS" : "", \
181 (temp & RH_PS_PRS) ? " PRS" : "", \
182 (temp & RH_PS_POCI) ? " POCI" : "", \
183 (temp & RH_PS_PSS) ? " PSS" : "", \
185 (temp & RH_PS_PES) ? " PES" : "", \
186 (temp & RH_PS_CCS) ? " CCS" : "" \
192 struct ohci_hcd
*controller
,
199 temp
= roothub_a (controller
);
204 ohci_dbg_sw (controller
, next
, size
,
205 "roothub.a %08x POTPGT=%d%s%s%s%s%s NDP=%d(%d)\n", temp
,
206 ((temp
& RH_A_POTPGT
) >> 24) & 0xff,
207 (temp
& RH_A_NOCP
) ? " NOCP" : "",
208 (temp
& RH_A_OCPM
) ? " OCPM" : "",
209 (temp
& RH_A_DT
) ? " DT" : "",
210 (temp
& RH_A_NPS
) ? " NPS" : "",
211 (temp
& RH_A_PSM
) ? " PSM" : "",
212 (temp
& RH_A_NDP
), controller
->num_ports
214 temp
= roothub_b (controller
);
215 ohci_dbg_sw (controller
, next
, size
,
216 "roothub.b %08x PPCM=%04x DR=%04x\n",
218 (temp
& RH_B_PPCM
) >> 16,
221 temp
= roothub_status (controller
);
222 ohci_dbg_sw (controller
, next
, size
,
223 "roothub.status %08x%s%s%s%s%s%s\n",
225 (temp
& RH_HS_CRWE
) ? " CRWE" : "",
226 (temp
& RH_HS_OCIC
) ? " OCIC" : "",
227 (temp
& RH_HS_LPSC
) ? " LPSC" : "",
228 (temp
& RH_HS_DRWE
) ? " DRWE" : "",
229 (temp
& RH_HS_OCI
) ? " OCI" : "",
230 (temp
& RH_HS_LPS
) ? " LPS" : ""
234 for (i
= 0; i
< controller
->num_ports
; i
++) {
235 temp
= roothub_portstatus (controller
, i
);
236 dbg_port_sw (controller
, i
, temp
, next
, size
);
240 static void ohci_dump(struct ohci_hcd
*controller
)
242 ohci_dbg (controller
, "OHCI controller state\n");
244 // dumps some of the state we know about
245 ohci_dump_status (controller
, NULL
, NULL
);
246 if (controller
->hcca
)
247 ohci_dbg (controller
,
248 "hcca frame #%04x\n", ohci_frame_no(controller
));
249 ohci_dump_roothub (controller
, 1, NULL
, NULL
);
252 static const char data0
[] = "DATA0";
253 static const char data1
[] = "DATA1";
255 static void ohci_dump_td (const struct ohci_hcd
*ohci
, const char *label
,
258 u32 tmp
= hc32_to_cpup (ohci
, &td
->hwINFO
);
260 ohci_dbg (ohci
, "%s td %p%s; urb %p index %d; hw next td %08x\n",
262 (tmp
& TD_DONE
) ? " (DONE)" : "",
264 hc32_to_cpup (ohci
, &td
->hwNextTD
));
265 if ((tmp
& TD_ISO
) == 0) {
266 const char *toggle
, *pid
;
269 switch (tmp
& TD_T
) {
270 case TD_T_DATA0
: toggle
= data0
; break;
271 case TD_T_DATA1
: toggle
= data1
; break;
272 case TD_T_TOGGLE
: toggle
= "(CARRY)"; break;
273 default: toggle
= "(?)"; break;
275 switch (tmp
& TD_DP
) {
276 case TD_DP_SETUP
: pid
= "SETUP"; break;
277 case TD_DP_IN
: pid
= "IN"; break;
278 case TD_DP_OUT
: pid
= "OUT"; break;
279 default: pid
= "(bad pid)"; break;
281 ohci_dbg (ohci
, " info %08x CC=%x %s DI=%d %s %s\n", tmp
,
282 TD_CC_GET(tmp
), /* EC, */ toggle
,
283 (tmp
& TD_DI
) >> 21, pid
,
284 (tmp
& TD_R
) ? "R" : "");
285 cbp
= hc32_to_cpup (ohci
, &td
->hwCBP
);
286 be
= hc32_to_cpup (ohci
, &td
->hwBE
);
287 ohci_dbg (ohci
, " cbp %08x be %08x (len %d)\n", cbp
, be
,
288 cbp
? (be
+ 1 - cbp
) : 0);
291 ohci_dbg (ohci
, " info %08x CC=%x FC=%d DI=%d SF=%04x\n", tmp
,
296 ohci_dbg (ohci
, " bp0 %08x be %08x\n",
297 hc32_to_cpup (ohci
, &td
->hwCBP
) & ~0x0fff,
298 hc32_to_cpup (ohci
, &td
->hwBE
));
299 for (i
= 0; i
< MAXPSW
; i
++) {
300 u16 psw
= ohci_hwPSW (ohci
, td
, i
);
301 int cc
= (psw
>> 12) & 0x0f;
302 ohci_dbg (ohci
, " psw [%d] = %2x, CC=%x %s=%d\n", i
,
304 (cc
>= 0x0e) ? "OFFSET" : "SIZE",
310 /* caller MUST own hcd spinlock if verbose is set! */
311 static void __maybe_unused
312 ohci_dump_ed (const struct ohci_hcd
*ohci
, const char *label
,
313 const struct ed
*ed
, int verbose
)
315 u32 tmp
= hc32_to_cpu (ohci
, ed
->hwINFO
);
318 ohci_dbg (ohci
, "%s, ed %p state 0x%x type %s; next ed %08x\n",
320 ed
, ed
->state
, edstring (ed
->type
),
321 hc32_to_cpup (ohci
, &ed
->hwNextED
));
322 switch (tmp
& (ED_IN
|ED_OUT
)) {
323 case ED_OUT
: type
= "-OUT"; break;
324 case ED_IN
: type
= "-IN"; break;
325 /* else from TDs ... control */
328 " info %08x MAX=%d%s%s%s%s EP=%d%s DEV=%d\n", tmp
,
329 0x03ff & (tmp
>> 16),
330 (tmp
& ED_DEQUEUE
) ? " DQ" : "",
331 (tmp
& ED_ISO
) ? " ISO" : "",
332 (tmp
& ED_SKIP
) ? " SKIP" : "",
333 (tmp
& ED_LOWSPEED
) ? " LOW" : "",
337 tmp
= hc32_to_cpup (ohci
, &ed
->hwHeadP
);
338 ohci_dbg (ohci
, " tds: head %08x %s%s tail %08x%s\n",
340 (tmp
& ED_C
) ? data1
: data0
,
341 (tmp
& ED_H
) ? " HALT" : "",
342 hc32_to_cpup (ohci
, &ed
->hwTailP
),
343 verbose
? "" : " (not listing)");
345 struct list_head
*tmp
;
347 /* use ed->td_list because HC concurrently modifies
348 * hwNextTD as it accumulates ed_donelist.
350 list_for_each (tmp
, &ed
->td_list
) {
352 td
= list_entry (tmp
, struct td
, td_list
);
353 ohci_dump_td (ohci
, " ->", td
);
358 /*-------------------------------------------------------------------------*/
360 static int debug_async_open(struct inode
*, struct file
*);
361 static int debug_periodic_open(struct inode
*, struct file
*);
362 static int debug_registers_open(struct inode
*, struct file
*);
363 static int debug_async_open(struct inode
*, struct file
*);
364 static ssize_t
debug_output(struct file
*, char __user
*, size_t, loff_t
*);
365 static int debug_close(struct inode
*, struct file
*);
367 static const struct file_operations debug_async_fops
= {
368 .owner
= THIS_MODULE
,
369 .open
= debug_async_open
,
370 .read
= debug_output
,
371 .release
= debug_close
,
372 .llseek
= default_llseek
,
374 static const struct file_operations debug_periodic_fops
= {
375 .owner
= THIS_MODULE
,
376 .open
= debug_periodic_open
,
377 .read
= debug_output
,
378 .release
= debug_close
,
379 .llseek
= default_llseek
,
381 static const struct file_operations debug_registers_fops
= {
382 .owner
= THIS_MODULE
,
383 .open
= debug_registers_open
,
384 .read
= debug_output
,
385 .release
= debug_close
,
386 .llseek
= default_llseek
,
389 static struct dentry
*ohci_debug_root
;
391 struct debug_buffer
{
392 ssize_t (*fill_func
)(struct debug_buffer
*); /* fill method */
393 struct ohci_hcd
*ohci
;
394 struct mutex mutex
; /* protect filling of buffer */
395 size_t count
; /* number of characters filled into buffer */
400 show_list (struct ohci_hcd
*ohci
, char *buf
, size_t count
, struct ed
*ed
)
402 unsigned temp
, size
= count
;
407 /* print first --> last */
411 /* dump a snapshot of the bulk or control schedule */
413 u32 info
= hc32_to_cpu (ohci
, ed
->hwINFO
);
414 u32 headp
= hc32_to_cpu (ohci
, ed
->hwHeadP
);
415 struct list_head
*entry
;
418 temp
= scnprintf (buf
, size
,
419 "ed/%p %cs dev%d ep%d%s max %d %08x%s%s %s",
421 (info
& ED_LOWSPEED
) ? 'l' : 'f',
424 (info
& ED_IN
) ? "in" : "out",
425 0x03ff & (info
>> 16),
427 (info
& ED_SKIP
) ? " s" : "",
428 (headp
& ED_H
) ? " H" : "",
429 (headp
& ED_C
) ? data1
: data0
);
433 list_for_each (entry
, &ed
->td_list
) {
436 td
= list_entry (entry
, struct td
, td_list
);
437 info
= hc32_to_cpup (ohci
, &td
->hwINFO
);
438 cbp
= hc32_to_cpup (ohci
, &td
->hwCBP
);
439 be
= hc32_to_cpup (ohci
, &td
->hwBE
);
440 temp
= scnprintf (buf
, size
,
441 "\n\ttd %p %s %d cc=%x urb %p (%08x)",
444 switch (info
& TD_DP
) {
445 case TD_DP_SETUP
: pid
= "setup"; break;
446 case TD_DP_IN
: pid
= "in"; break;
447 case TD_DP_OUT
: pid
= "out"; break;
448 default: pid
= "(?)"; break;
450 cbp
? (be
+ 1 - cbp
) : 0,
451 TD_CC_GET (info
), td
->urb
, info
);
456 temp
= scnprintf (buf
, size
, "\n");
465 static ssize_t
fill_async_buffer(struct debug_buffer
*buf
)
467 struct ohci_hcd
*ohci
;
474 /* display control and bulk lists together, for simplicity */
475 spin_lock_irqsave (&ohci
->lock
, flags
);
476 temp
= show_list(ohci
, buf
->page
, size
, ohci
->ed_controltail
);
477 temp
+= show_list(ohci
, buf
->page
+ temp
, size
- temp
,
479 spin_unlock_irqrestore (&ohci
->lock
, flags
);
484 #define DBG_SCHED_LIMIT 64
486 static ssize_t
fill_periodic_buffer(struct debug_buffer
*buf
)
488 struct ohci_hcd
*ohci
;
489 struct ed
**seen
, *ed
;
491 unsigned temp
, size
, seen_count
;
495 seen
= kmalloc_array(DBG_SCHED_LIMIT
, sizeof(*seen
), GFP_ATOMIC
);
504 temp
= scnprintf (next
, size
, "size = %d\n", NUM_INTS
);
508 /* dump a snapshot of the periodic schedule (and load) */
509 spin_lock_irqsave (&ohci
->lock
, flags
);
510 for (i
= 0; i
< NUM_INTS
; i
++) {
511 ed
= ohci
->periodic
[i
];
515 temp
= scnprintf (next
, size
, "%2d [%3d]:", i
, ohci
->load
[i
]);
520 temp
= scnprintf (next
, size
, " ed%d/%p",
524 for (temp
= 0; temp
< seen_count
; temp
++) {
525 if (seen
[temp
] == ed
)
529 /* show more info the first time around */
530 if (temp
== seen_count
) {
531 u32 info
= hc32_to_cpu (ohci
, ed
->hwINFO
);
532 struct list_head
*entry
;
535 /* qlen measured here in TDs, not urbs */
536 list_for_each (entry
, &ed
->td_list
)
539 temp
= scnprintf (next
, size
,
540 " (%cs dev%d ep%d%s-%s qlen %u"
542 (info
& ED_LOWSPEED
) ? 'l' : 'f',
545 (info
& ED_IN
) ? "in" : "out",
546 (info
& ED_ISO
) ? "iso" : "int",
548 0x03ff & (info
>> 16),
550 (info
& ED_SKIP
) ? " K" : "",
552 cpu_to_hc32(ohci
, ED_H
)) ?
557 if (seen_count
< DBG_SCHED_LIMIT
)
558 seen
[seen_count
++] = ed
;
563 /* we've seen it and what's after */
570 temp
= scnprintf (next
, size
, "\n");
574 spin_unlock_irqrestore (&ohci
->lock
, flags
);
577 return PAGE_SIZE
- size
;
579 #undef DBG_SCHED_LIMIT
581 static ssize_t
fill_registers_buffer(struct debug_buffer
*buf
)
584 struct ohci_hcd
*ohci
;
585 struct ohci_regs __iomem
*regs
;
592 hcd
= ohci_to_hcd(ohci
);
597 spin_lock_irqsave (&ohci
->lock
, flags
);
599 /* dump driver info, then registers in spec order */
601 ohci_dbg_nosw(ohci
, &next
, &size
,
602 "bus %s, device %s\n"
605 hcd
->self
.controller
->bus
->name
,
606 dev_name(hcd
->self
.controller
),
610 if (!HCD_HW_ACCESSIBLE(hcd
)) {
611 size
-= scnprintf (next
, size
,
612 "SUSPENDED (no register access)\n");
616 ohci_dump_status(ohci
, &next
, &size
);
620 ohci_dbg_nosw(ohci
, &next
, &size
,
621 "hcca frame 0x%04x\n", ohci_frame_no(ohci
));
623 /* other registers mostly affect frame timings */
624 rdata
= ohci_readl (ohci
, ®s
->fminterval
);
625 temp
= scnprintf (next
, size
,
626 "fmintvl 0x%08x %sFSMPS=0x%04x FI=0x%04x\n",
627 rdata
, (rdata
>> 31) ? "FIT " : "",
628 (rdata
>> 16) & 0xefff, rdata
& 0xffff);
632 rdata
= ohci_readl (ohci
, ®s
->fmremaining
);
633 temp
= scnprintf (next
, size
, "fmremaining 0x%08x %sFR=0x%04x\n",
634 rdata
, (rdata
>> 31) ? "FRT " : "",
639 rdata
= ohci_readl (ohci
, ®s
->periodicstart
);
640 temp
= scnprintf (next
, size
, "periodicstart 0x%04x\n",
645 rdata
= ohci_readl (ohci
, ®s
->lsthresh
);
646 temp
= scnprintf (next
, size
, "lsthresh 0x%04x\n",
651 temp
= scnprintf (next
, size
, "hub poll timer %s\n",
652 HCD_POLL_RH(ohci_to_hcd(ohci
)) ? "ON" : "off");
657 ohci_dump_roothub (ohci
, 1, &next
, &size
);
660 spin_unlock_irqrestore (&ohci
->lock
, flags
);
662 return PAGE_SIZE
- size
;
665 static struct debug_buffer
*alloc_buffer(struct ohci_hcd
*ohci
,
666 ssize_t (*fill_func
)(struct debug_buffer
*))
668 struct debug_buffer
*buf
;
670 buf
= kzalloc(sizeof(struct debug_buffer
), GFP_KERNEL
);
674 buf
->fill_func
= fill_func
;
675 mutex_init(&buf
->mutex
);
681 static int fill_buffer(struct debug_buffer
*buf
)
686 buf
->page
= (char *)get_zeroed_page(GFP_KERNEL
);
693 ret
= buf
->fill_func(buf
);
704 static ssize_t
debug_output(struct file
*file
, char __user
*user_buf
,
705 size_t len
, loff_t
*offset
)
707 struct debug_buffer
*buf
= file
->private_data
;
710 mutex_lock(&buf
->mutex
);
711 if (buf
->count
== 0) {
712 ret
= fill_buffer(buf
);
714 mutex_unlock(&buf
->mutex
);
718 mutex_unlock(&buf
->mutex
);
720 ret
= simple_read_from_buffer(user_buf
, len
, offset
,
721 buf
->page
, buf
->count
);
728 static int debug_close(struct inode
*inode
, struct file
*file
)
730 struct debug_buffer
*buf
= file
->private_data
;
734 free_page((unsigned long)buf
->page
);
740 static int debug_async_open(struct inode
*inode
, struct file
*file
)
742 file
->private_data
= alloc_buffer(inode
->i_private
, fill_async_buffer
);
744 return file
->private_data
? 0 : -ENOMEM
;
747 static int debug_periodic_open(struct inode
*inode
, struct file
*file
)
749 file
->private_data
= alloc_buffer(inode
->i_private
,
750 fill_periodic_buffer
);
752 return file
->private_data
? 0 : -ENOMEM
;
755 static int debug_registers_open(struct inode
*inode
, struct file
*file
)
757 file
->private_data
= alloc_buffer(inode
->i_private
,
758 fill_registers_buffer
);
760 return file
->private_data
? 0 : -ENOMEM
;
762 static inline void create_debug_files (struct ohci_hcd
*ohci
)
764 struct usb_bus
*bus
= &ohci_to_hcd(ohci
)->self
;
767 root
= debugfs_create_dir(bus
->bus_name
, ohci_debug_root
);
768 ohci
->debug_dir
= root
;
770 debugfs_create_file("async", S_IRUGO
, root
, ohci
, &debug_async_fops
);
771 debugfs_create_file("periodic", S_IRUGO
, root
, ohci
,
772 &debug_periodic_fops
);
773 debugfs_create_file("registers", S_IRUGO
, root
, ohci
,
774 &debug_registers_fops
);
776 ohci_dbg (ohci
, "created debug files\n");
779 static inline void remove_debug_files (struct ohci_hcd
*ohci
)
781 debugfs_remove_recursive(ohci
->debug_dir
);
784 /*-------------------------------------------------------------------------*/