2 * UHCI-specific debugging code. Invaluable when something
3 * goes wrong, but don't get in my face.
5 * Kernel visible pointers are surrounded in []s and bus
6 * visible pointers are surrounded in ()s
8 * (C) Copyright 1999 Linus Torvalds
9 * (C) Copyright 1999-2001 Johannes Erdfelt
12 #include <linux/slab.h>
13 #include <linux/kernel.h>
14 #include <linux/debugfs.h>
19 #define EXTRA_SPACE 1024
21 static struct dentry
*uhci_debugfs_root
;
25 /* Handle REALLY large printks so we don't overflow buffers */
26 static void lprintk(char *buf
)
30 /* Just write one line at a time */
32 p
= strchr(buf
, '\n');
35 printk(KERN_DEBUG
"%s\n", buf
);
42 static int uhci_show_td(struct uhci_hcd
*uhci
, struct uhci_td
*td
, char *buf
,
49 status
= td_status(uhci
, td
);
50 out
+= sprintf(out
, "%*s[%p] link (%08x) ", space
, "", td
,
51 hc32_to_cpu(uhci
, td
->link
));
52 out
+= sprintf(out
, "e%d %s%s%s%s%s%s%s%s%s%sLength=%x ",
54 (status
& TD_CTRL_SPD
) ? "SPD " : "",
55 (status
& TD_CTRL_LS
) ? "LS " : "",
56 (status
& TD_CTRL_IOC
) ? "IOC " : "",
57 (status
& TD_CTRL_ACTIVE
) ? "Active " : "",
58 (status
& TD_CTRL_STALLED
) ? "Stalled " : "",
59 (status
& TD_CTRL_DBUFERR
) ? "DataBufErr " : "",
60 (status
& TD_CTRL_BABBLE
) ? "Babble " : "",
61 (status
& TD_CTRL_NAK
) ? "NAK " : "",
62 (status
& TD_CTRL_CRCTIMEO
) ? "CRC/Timeo " : "",
63 (status
& TD_CTRL_BITSTUFF
) ? "BitStuff " : "",
68 token
= td_token(uhci
, td
);
69 switch (uhci_packetid(token
)) {
84 out
+= sprintf(out
, "MaxLen=%x DT%d EndPt=%x Dev=%x, PID=%x(%s) ",
91 out
+= sprintf(out
, "(buf=%08x)\n", hc32_to_cpu(uhci
, td
->buffer
));
95 out
+= sprintf(out
, " ...\n");
99 static int uhci_show_urbp(struct uhci_hcd
*uhci
, struct urb_priv
*urbp
,
100 char *buf
, int len
, int space
)
104 int i
, nactive
, ninactive
;
108 out
+= sprintf(out
, "urb_priv [%p] ", urbp
);
109 out
+= sprintf(out
, "urb [%p] ", urbp
->urb
);
110 out
+= sprintf(out
, "qh [%p] ", urbp
->qh
);
111 out
+= sprintf(out
, "Dev=%d ", usb_pipedevice(urbp
->urb
->pipe
));
112 out
+= sprintf(out
, "EP=%x(%s) ", usb_pipeendpoint(urbp
->urb
->pipe
),
113 (usb_pipein(urbp
->urb
->pipe
) ? "IN" : "OUT"));
117 switch (usb_pipetype(urbp
->urb
->pipe
)) {
118 case PIPE_ISOCHRONOUS
: ptype
= "ISO"; break;
119 case PIPE_INTERRUPT
: ptype
= "INT"; break;
120 case PIPE_BULK
: ptype
= "BLK"; break;
122 case PIPE_CONTROL
: ptype
= "CTL"; break;
125 out
+= sprintf(out
, "%s%s", ptype
, (urbp
->fsbr
? " FSBR" : ""));
126 out
+= sprintf(out
, " Actlen=%d%s", urbp
->urb
->actual_length
,
127 (urbp
->qh
->type
== USB_ENDPOINT_XFER_CONTROL
?
130 if (urbp
->urb
->unlinked
)
131 out
+= sprintf(out
, " Unlinked=%d", urbp
->urb
->unlinked
);
132 out
+= sprintf(out
, "\n");
137 i
= nactive
= ninactive
= 0;
138 list_for_each_entry(td
, &urbp
->td_list
, list
) {
139 if (urbp
->qh
->type
!= USB_ENDPOINT_XFER_ISOC
&&
140 (++i
<= 10 || debug
> 2)) {
141 out
+= sprintf(out
, "%*s%d: ", space
+ 2, "", i
);
142 out
+= uhci_show_td(uhci
, td
, out
,
143 len
- (out
- buf
), 0);
147 if (td_status(uhci
, td
) & TD_CTRL_ACTIVE
)
153 if (nactive
+ ninactive
> 0)
155 "%*s[skipped %d inactive and %d active TDs]\n",
156 space
, "", ninactive
, nactive
);
159 out
+= sprintf(out
, " ...\n");
164 static int uhci_show_qh(struct uhci_hcd
*uhci
,
165 struct uhci_qh
*qh
, char *buf
, int len
, int space
)
169 __hc32 element
= qh_element(qh
);
173 case USB_ENDPOINT_XFER_ISOC
: qtype
= "ISO"; break;
174 case USB_ENDPOINT_XFER_INT
: qtype
= "INT"; break;
175 case USB_ENDPOINT_XFER_BULK
: qtype
= "BLK"; break;
176 case USB_ENDPOINT_XFER_CONTROL
: qtype
= "CTL"; break;
177 default: qtype
= "Skel" ; break;
180 out
+= sprintf(out
, "%*s[%p] %s QH link (%08x) element (%08x)\n",
181 space
, "", qh
, qtype
,
182 hc32_to_cpu(uhci
, qh
->link
),
183 hc32_to_cpu(uhci
, element
));
184 if (qh
->type
== USB_ENDPOINT_XFER_ISOC
)
186 "%*s period %d phase %d load %d us, frame %x desc [%p]\n",
187 space
, "", qh
->period
, qh
->phase
, qh
->load
,
188 qh
->iso_frame
, qh
->iso_packet_desc
);
189 else if (qh
->type
== USB_ENDPOINT_XFER_INT
)
190 out
+= sprintf(out
, "%*s period %d phase %d load %d us\n",
191 space
, "", qh
->period
, qh
->phase
, qh
->load
);
195 if (element
& UHCI_PTR_QH(uhci
))
196 out
+= sprintf(out
, "%*s Element points to QH (bug?)\n", space
, "");
198 if (element
& UHCI_PTR_DEPTH(uhci
))
199 out
+= sprintf(out
, "%*s Depth traverse\n", space
, "");
201 if (element
& cpu_to_hc32(uhci
, 8))
202 out
+= sprintf(out
, "%*s Bit 3 set (bug?)\n", space
, "");
204 if (!(element
& ~(UHCI_PTR_QH(uhci
) | UHCI_PTR_DEPTH(uhci
))))
205 out
+= sprintf(out
, "%*s Element is NULL (bug?)\n", space
, "");
210 if (list_empty(&qh
->queue
)) {
211 out
+= sprintf(out
, "%*s queue is empty\n", space
, "");
212 if (qh
== uhci
->skel_async_qh
) {
213 out
+= uhci_show_td(uhci
, uhci
->term_td
, out
,
214 len
- (out
- buf
), 0);
219 struct urb_priv
*urbp
= list_entry(qh
->queue
.next
,
220 struct urb_priv
, node
);
221 struct uhci_td
*td
= list_entry(urbp
->td_list
.next
,
222 struct uhci_td
, list
);
224 if (element
!= LINK_TO_TD(uhci
, td
))
225 out
+= sprintf(out
, "%*s Element != First TD\n",
228 list_for_each_entry(urbp
, &qh
->queue
, node
) {
230 out
+= uhci_show_urbp(uhci
, urbp
, out
,
231 len
- (out
- buf
), space
+ 2);
239 out
+= sprintf(out
, "%*s Skipped %d URBs\n",
247 out
+= sprintf(out
, "%*s Dummy TD\n", space
, "");
248 out
+= uhci_show_td(uhci
, qh
->dummy_td
, out
,
249 len
- (out
- buf
), 0);
256 out
+= sprintf(out
, " ...\n");
261 static int uhci_show_sc(int port
, unsigned short status
, char *buf
)
263 return sprintf(buf
, " stat%d = %04x %s%s%s%s%s%s%s%s%s%s\n",
266 (status
& USBPORTSC_SUSP
) ? " Suspend" : "",
267 (status
& USBPORTSC_OCC
) ? " OverCurrentChange" : "",
268 (status
& USBPORTSC_OC
) ? " OverCurrent" : "",
269 (status
& USBPORTSC_PR
) ? " Reset" : "",
270 (status
& USBPORTSC_LSDA
) ? " LowSpeed" : "",
271 (status
& USBPORTSC_RD
) ? " ResumeDetect" : "",
272 (status
& USBPORTSC_PEC
) ? " EnableChange" : "",
273 (status
& USBPORTSC_PE
) ? " Enabled" : "",
274 (status
& USBPORTSC_CSC
) ? " ConnectChange" : "",
275 (status
& USBPORTSC_CCS
) ? " Connected" : "");
278 static int uhci_show_root_hub_state(struct uhci_hcd
*uhci
, char *buf
)
282 switch (uhci
->rh_state
) {
284 rh_state
= "reset"; break;
285 case UHCI_RH_SUSPENDED
:
286 rh_state
= "suspended"; break;
287 case UHCI_RH_AUTO_STOPPED
:
288 rh_state
= "auto-stopped"; break;
289 case UHCI_RH_RESUMING
:
290 rh_state
= "resuming"; break;
291 case UHCI_RH_SUSPENDING
:
292 rh_state
= "suspending"; break;
293 case UHCI_RH_RUNNING
:
294 rh_state
= "running"; break;
295 case UHCI_RH_RUNNING_NODEVS
:
296 rh_state
= "running, no devs"; break;
298 rh_state
= "?"; break;
300 return sprintf(buf
, "Root-hub state: %s FSBR: %d\n",
301 rh_state
, uhci
->fsbr_is_on
);
304 static int uhci_show_status(struct uhci_hcd
*uhci
, char *buf
, int len
)
307 unsigned short usbcmd
, usbstat
, usbint
, usbfrnum
;
308 unsigned int flbaseadd
;
310 unsigned short portsc1
, portsc2
;
313 usbcmd
= uhci_readw(uhci
, 0);
314 usbstat
= uhci_readw(uhci
, 2);
315 usbint
= uhci_readw(uhci
, 4);
316 usbfrnum
= uhci_readw(uhci
, 6);
317 flbaseadd
= uhci_readl(uhci
, 8);
318 sof
= uhci_readb(uhci
, 12);
319 portsc1
= uhci_readw(uhci
, 16);
320 portsc2
= uhci_readw(uhci
, 18);
322 out
+= sprintf(out
, " usbcmd = %04x %s%s%s%s%s%s%s%s\n",
324 (usbcmd
& USBCMD_MAXP
) ? "Maxp64 " : "Maxp32 ",
325 (usbcmd
& USBCMD_CF
) ? "CF " : "",
326 (usbcmd
& USBCMD_SWDBG
) ? "SWDBG " : "",
327 (usbcmd
& USBCMD_FGR
) ? "FGR " : "",
328 (usbcmd
& USBCMD_EGSM
) ? "EGSM " : "",
329 (usbcmd
& USBCMD_GRESET
) ? "GRESET " : "",
330 (usbcmd
& USBCMD_HCRESET
) ? "HCRESET " : "",
331 (usbcmd
& USBCMD_RS
) ? "RS " : "");
335 out
+= sprintf(out
, " usbstat = %04x %s%s%s%s%s%s\n",
337 (usbstat
& USBSTS_HCH
) ? "HCHalted " : "",
338 (usbstat
& USBSTS_HCPE
) ? "HostControllerProcessError " : "",
339 (usbstat
& USBSTS_HSE
) ? "HostSystemError " : "",
340 (usbstat
& USBSTS_RD
) ? "ResumeDetect " : "",
341 (usbstat
& USBSTS_ERROR
) ? "USBError " : "",
342 (usbstat
& USBSTS_USBINT
) ? "USBINT " : "");
346 out
+= sprintf(out
, " usbint = %04x\n", usbint
);
347 out
+= sprintf(out
, " usbfrnum = (%d)%03x\n", (usbfrnum
>> 10) & 1,
348 0xfff & (4*(unsigned int)usbfrnum
));
349 out
+= sprintf(out
, " flbaseadd = %08x\n", flbaseadd
);
350 out
+= sprintf(out
, " sof = %02x\n", sof
);
354 out
+= uhci_show_sc(1, portsc1
, out
);
358 out
+= uhci_show_sc(2, portsc2
, out
);
363 "Most recent frame: %x (%d) Last ISO frame: %x (%d)\n",
364 uhci
->frame_number
, uhci
->frame_number
& 1023,
365 uhci
->last_iso_frame
, uhci
->last_iso_frame
& 1023);
369 out
+= sprintf(out
, " ...\n");
373 static int uhci_sprint_schedule(struct uhci_hcd
*uhci
, char *buf
, int len
)
379 struct list_head
*tmp
, *head
;
384 static const char * const qh_names
[] = {
385 "unlink", "iso", "int128", "int64", "int32", "int16",
386 "int8", "int4", "int2", "async", "term"
389 out
+= uhci_show_root_hub_state(uhci
, out
);
392 out
+= sprintf(out
, "HC status\n");
393 out
+= uhci_show_status(uhci
, out
, len
- (out
- buf
));
397 out
+= sprintf(out
, "Periodic load table\n");
398 for (i
= 0; i
< MAX_PHASE
; ++i
) {
399 out
+= sprintf(out
, "\t%d", uhci
->load
[i
]);
403 out
+= sprintf(out
, "Total: %d, #INT: %d, #ISO: %d\n",
405 uhci_to_hcd(uhci
)->self
.bandwidth_int_reqs
,
406 uhci_to_hcd(uhci
)->self
.bandwidth_isoc_reqs
);
410 out
+= sprintf(out
, "Frame List\n");
413 for (i
= 0; i
< UHCI_NUMFRAMES
; ++i
) {
419 td
= uhci
->frame_cpu
[i
];
420 link
= uhci
->frame
[i
];
425 out
+= sprintf(out
, "- Frame %d -> (%08x)\n",
426 i
, hc32_to_cpu(uhci
, link
));
433 td
= list_entry(tmp
, struct uhci_td
, fl_list
);
435 if (link
!= LINK_TO_TD(uhci
, td
)) {
438 " link does not match list entry!\n");
445 out
+= uhci_show_td(uhci
, td
, out
,
446 len
- (out
- buf
), 4);
451 } while (tmp
!= head
);
454 qh_dma
= uhci_frame_skel_link(uhci
, i
);
455 if (link
!= qh_dma
) {
459 "- Frame %d -> (%08x)\n",
460 i
, hc32_to_cpu(uhci
, link
));
464 " link does not match QH (%08x)!\n",
465 hc32_to_cpu(uhci
, qh_dma
));
474 out
+= sprintf(out
, "Skipped %d bad links\n", nerrs
);
476 out
+= sprintf(out
, "Skeleton QHs\n");
482 for (i
= 0; i
< UHCI_NUM_SKELQH
; ++i
) {
485 qh
= uhci
->skelqh
[i
];
486 out
+= sprintf(out
, "- skel_%s_qh\n", qh_names
[i
]);
487 out
+= uhci_show_qh(uhci
, qh
, out
, len
- (out
- buf
), 4);
491 /* Last QH is the Terminating QH, it's different */
492 if (i
== SKEL_TERM
) {
493 if (qh_element(qh
) != LINK_TO_TD(uhci
, uhci
->term_td
)) {
495 " skel_term_qh element is not set to term_td!\n");
501 link
= LINK_TO_QH(uhci
, uhci
->skel_term_qh
);
508 while (tmp
!= head
) {
509 qh
= list_entry(tmp
, struct uhci_qh
, node
);
512 out
+= uhci_show_qh(uhci
, qh
, out
,
513 len
- (out
- buf
), 4);
517 if (!fsbr_link
&& qh
->skel
>= SKEL_FSBR
)
518 fsbr_link
= LINK_TO_QH(uhci
, qh
);
521 out
+= sprintf(out
, " Skipped %d QHs\n", cnt
);
523 link
= UHCI_PTR_TERM(uhci
);
526 else if (i
< SKEL_ASYNC
)
527 link
= LINK_TO_QH(uhci
, uhci
->skel_async_qh
);
528 else if (!uhci
->fsbr_is_on
)
531 link
= LINK_TO_QH(uhci
, uhci
->skel_term_qh
);
533 if (qh
->link
!= link
)
535 " last QH not linked to next skeleton!\n");
543 out
+= sprintf(out
, " ...\n");
548 #ifdef CONFIG_DEBUG_FS
550 #define MAX_OUTPUT (64 * 1024)
557 static int uhci_debug_open(struct inode
*inode
, struct file
*file
)
559 struct uhci_hcd
*uhci
= inode
->i_private
;
560 struct uhci_debug
*up
;
563 up
= kmalloc(sizeof(*up
), GFP_KERNEL
);
567 up
->data
= kmalloc(MAX_OUTPUT
, GFP_KERNEL
);
574 spin_lock_irqsave(&uhci
->lock
, flags
);
575 if (uhci
->is_initialized
)
576 up
->size
= uhci_sprint_schedule(uhci
, up
->data
,
577 MAX_OUTPUT
- EXTRA_SPACE
);
578 spin_unlock_irqrestore(&uhci
->lock
, flags
);
580 file
->private_data
= up
;
585 static loff_t
uhci_debug_lseek(struct file
*file
, loff_t off
, int whence
)
587 struct uhci_debug
*up
;
590 up
= file
->private_data
;
593 * XXX: atomic 64bit seek access, but that needs to be fixed in the VFS
600 new = file
->f_pos
+ off
;
604 if (new < 0 || new > up
->size
)
607 return (file
->f_pos
= new);
610 static ssize_t
uhci_debug_read(struct file
*file
, char __user
*buf
,
611 size_t nbytes
, loff_t
*ppos
)
613 struct uhci_debug
*up
= file
->private_data
;
614 return simple_read_from_buffer(buf
, nbytes
, ppos
, up
->data
, up
->size
);
617 static int uhci_debug_release(struct inode
*inode
, struct file
*file
)
619 struct uhci_debug
*up
= file
->private_data
;
627 static const struct file_operations uhci_debug_operations
= {
628 .owner
= THIS_MODULE
,
629 .open
= uhci_debug_open
,
630 .llseek
= uhci_debug_lseek
,
631 .read
= uhci_debug_read
,
632 .release
= uhci_debug_release
,
634 #define UHCI_DEBUG_OPS
636 #endif /* CONFIG_DEBUG_FS */
640 static inline void lprintk(char *buf
)
643 static inline int uhci_show_qh(struct uhci_hcd
*uhci
,
644 struct uhci_qh
*qh
, char *buf
, int len
, int space
)
649 static inline int uhci_sprint_schedule(struct uhci_hcd
*uhci
,