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/config.h>
13 #include <linux/kernel.h>
14 #include <linux/debugfs.h>
15 #include <linux/smp_lock.h>
20 static struct dentry
*uhci_debugfs_root
= NULL
;
22 /* Handle REALLY large printks so we don't overflow buffers */
23 static inline void lprintk(char *buf
)
27 /* Just write one line at a time */
29 p
= strchr(buf
, '\n');
32 printk(KERN_DEBUG
"%s\n", buf
);
39 static int uhci_show_td(struct uhci_td
*td
, char *buf
, int len
, int space
)
45 /* Try to make sure there's enough memory */
49 status
= td_status(td
);
50 out
+= sprintf(out
, "%*s[%p] link (%08x) ", space
, "", td
, le32_to_cpu(td
->link
));
51 out
+= sprintf(out
, "e%d %s%s%s%s%s%s%s%s%s%sLength=%x ",
53 (status
& TD_CTRL_SPD
) ? "SPD " : "",
54 (status
& TD_CTRL_LS
) ? "LS " : "",
55 (status
& TD_CTRL_IOC
) ? "IOC " : "",
56 (status
& TD_CTRL_ACTIVE
) ? "Active " : "",
57 (status
& TD_CTRL_STALLED
) ? "Stalled " : "",
58 (status
& TD_CTRL_DBUFERR
) ? "DataBufErr " : "",
59 (status
& TD_CTRL_BABBLE
) ? "Babble " : "",
60 (status
& TD_CTRL_NAK
) ? "NAK " : "",
61 (status
& TD_CTRL_CRCTIMEO
) ? "CRC/Timeo " : "",
62 (status
& TD_CTRL_BITSTUFF
) ? "BitStuff " : "",
66 switch (uhci_packetid(token
)) {
81 out
+= sprintf(out
, "MaxLen=%x DT%d EndPt=%x Dev=%x, PID=%x(%s) ",
88 out
+= sprintf(out
, "(buf=%08x)\n", le32_to_cpu(td
->buffer
));
93 static int uhci_show_qh(struct uhci_qh
*qh
, char *buf
, int len
, int space
)
96 struct urb_priv
*urbp
;
97 struct list_head
*head
, *tmp
;
99 int i
= 0, checked
= 0, prevactive
= 0;
100 __le32 element
= qh_element(qh
);
102 /* Try to make sure there's enough memory */
106 out
+= sprintf(out
, "%*s[%p] link (%08x) element (%08x)\n", space
, "",
107 qh
, le32_to_cpu(qh
->link
), le32_to_cpu(element
));
109 if (element
& UHCI_PTR_QH
)
110 out
+= sprintf(out
, "%*s Element points to QH (bug?)\n", space
, "");
112 if (element
& UHCI_PTR_DEPTH
)
113 out
+= sprintf(out
, "%*s Depth traverse\n", space
, "");
115 if (element
& cpu_to_le32(8))
116 out
+= sprintf(out
, "%*s Bit 3 set (bug?)\n", space
, "");
118 if (!(element
& ~(UHCI_PTR_QH
| UHCI_PTR_DEPTH
)))
119 out
+= sprintf(out
, "%*s Element is NULL (bug?)\n", space
, "");
122 out
+= sprintf(out
, "%*s urbp == NULL\n", space
, "");
128 head
= &urbp
->td_list
;
131 td
= list_entry(tmp
, struct uhci_td
, list
);
133 if (cpu_to_le32(td
->dma_handle
) != (element
& ~UHCI_PTR_BITS
))
134 out
+= sprintf(out
, "%*s Element != First TD\n", space
, "");
136 while (tmp
!= head
) {
137 struct uhci_td
*td
= list_entry(tmp
, struct uhci_td
, list
);
141 out
+= sprintf(out
, "%*s%d: ", space
+ 2, "", i
++);
142 out
+= uhci_show_td(td
, out
, len
- (out
- buf
), 0);
144 if (i
> 10 && !checked
&& prevactive
&& tmp
!= head
&&
146 struct list_head
*ntmp
= tmp
;
147 struct uhci_td
*ntd
= td
;
148 int active
= 1, ni
= i
;
152 while (ntmp
!= head
&& ntmp
->next
!= head
&& active
) {
153 ntd
= list_entry(ntmp
, struct uhci_td
, list
);
157 active
= td_status(ntd
) & TD_CTRL_ACTIVE
;
162 if (active
&& ni
> i
) {
163 out
+= sprintf(out
, "%*s[skipped %d active TDs]\n", space
, "", ni
- i
);
170 prevactive
= td_status(td
) & TD_CTRL_ACTIVE
;
173 if (list_empty(&urbp
->queue_list
) || urbp
->queued
)
176 out
+= sprintf(out
, "%*sQueued QHs:\n", -space
, "--");
178 head
= &urbp
->queue_list
;
181 while (tmp
!= head
) {
182 struct urb_priv
*nurbp
= list_entry(tmp
, struct urb_priv
,
186 out
+= uhci_show_qh(nurbp
->qh
, out
, len
- (out
- buf
), space
);
193 #define show_frame_num() \
196 out += sprintf(out, "- Frame %d\n", i); \
199 #ifdef CONFIG_PROC_FS
200 static const char * const qh_names
[] = {
201 "skel_int128_qh", "skel_int64_qh",
202 "skel_int32_qh", "skel_int16_qh",
203 "skel_int8_qh", "skel_int4_qh",
204 "skel_int2_qh", "skel_int1_qh",
205 "skel_ls_control_qh", "skel_fs_control_qh",
206 "skel_bulk_qh", "skel_term_qh"
209 #define show_qh_name() \
212 out += sprintf(out, "- %s\n", qh_names[i]); \
215 static int uhci_show_sc(int port
, unsigned short status
, char *buf
, int len
)
219 /* Try to make sure there's enough memory */
223 out
+= sprintf(out
, " stat%d = %04x %s%s%s%s%s%s%s%s%s%s\n",
226 (status
& USBPORTSC_SUSP
) ? " Suspend" : "",
227 (status
& USBPORTSC_OCC
) ? " OverCurrentChange" : "",
228 (status
& USBPORTSC_OC
) ? " OverCurrent" : "",
229 (status
& USBPORTSC_PR
) ? " Reset" : "",
230 (status
& USBPORTSC_LSDA
) ? " LowSpeed" : "",
231 (status
& USBPORTSC_RD
) ? " ResumeDetect" : "",
232 (status
& USBPORTSC_PEC
) ? " EnableChange" : "",
233 (status
& USBPORTSC_PE
) ? " Enabled" : "",
234 (status
& USBPORTSC_CSC
) ? " ConnectChange" : "",
235 (status
& USBPORTSC_CCS
) ? " Connected" : "");
240 static int uhci_show_root_hub_state(struct uhci_hcd
*uhci
, char *buf
, int len
)
245 /* Try to make sure there's enough memory */
249 switch (uhci
->rh_state
) {
251 rh_state
= "reset"; break;
252 case UHCI_RH_SUSPENDED
:
253 rh_state
= "suspended"; break;
254 case UHCI_RH_AUTO_STOPPED
:
255 rh_state
= "auto-stopped"; break;
256 case UHCI_RH_RESUMING
:
257 rh_state
= "resuming"; break;
258 case UHCI_RH_SUSPENDING
:
259 rh_state
= "suspending"; break;
260 case UHCI_RH_RUNNING
:
261 rh_state
= "running"; break;
262 case UHCI_RH_RUNNING_NODEVS
:
263 rh_state
= "running, no devs"; break;
265 rh_state
= "?"; break;
267 out
+= sprintf(out
, "Root-hub state: %s\n", rh_state
);
271 static int uhci_show_status(struct uhci_hcd
*uhci
, char *buf
, int len
)
274 unsigned long io_addr
= uhci
->io_addr
;
275 unsigned short usbcmd
, usbstat
, usbint
, usbfrnum
;
276 unsigned int flbaseadd
;
278 unsigned short portsc1
, portsc2
;
280 /* Try to make sure there's enough memory */
284 usbcmd
= inw(io_addr
+ 0);
285 usbstat
= inw(io_addr
+ 2);
286 usbint
= inw(io_addr
+ 4);
287 usbfrnum
= inw(io_addr
+ 6);
288 flbaseadd
= inl(io_addr
+ 8);
289 sof
= inb(io_addr
+ 12);
290 portsc1
= inw(io_addr
+ 16);
291 portsc2
= inw(io_addr
+ 18);
293 out
+= sprintf(out
, " usbcmd = %04x %s%s%s%s%s%s%s%s\n",
295 (usbcmd
& USBCMD_MAXP
) ? "Maxp64 " : "Maxp32 ",
296 (usbcmd
& USBCMD_CF
) ? "CF " : "",
297 (usbcmd
& USBCMD_SWDBG
) ? "SWDBG " : "",
298 (usbcmd
& USBCMD_FGR
) ? "FGR " : "",
299 (usbcmd
& USBCMD_EGSM
) ? "EGSM " : "",
300 (usbcmd
& USBCMD_GRESET
) ? "GRESET " : "",
301 (usbcmd
& USBCMD_HCRESET
) ? "HCRESET " : "",
302 (usbcmd
& USBCMD_RS
) ? "RS " : "");
304 out
+= sprintf(out
, " usbstat = %04x %s%s%s%s%s%s\n",
306 (usbstat
& USBSTS_HCH
) ? "HCHalted " : "",
307 (usbstat
& USBSTS_HCPE
) ? "HostControllerProcessError " : "",
308 (usbstat
& USBSTS_HSE
) ? "HostSystemError " : "",
309 (usbstat
& USBSTS_RD
) ? "ResumeDetect " : "",
310 (usbstat
& USBSTS_ERROR
) ? "USBError " : "",
311 (usbstat
& USBSTS_USBINT
) ? "USBINT " : "");
313 out
+= sprintf(out
, " usbint = %04x\n", usbint
);
314 out
+= sprintf(out
, " usbfrnum = (%d)%03x\n", (usbfrnum
>> 10) & 1,
315 0xfff & (4*(unsigned int)usbfrnum
));
316 out
+= sprintf(out
, " flbaseadd = %08x\n", flbaseadd
);
317 out
+= sprintf(out
, " sof = %02x\n", sof
);
318 out
+= uhci_show_sc(1, portsc1
, out
, len
- (out
- buf
));
319 out
+= uhci_show_sc(2, portsc2
, out
, len
- (out
- buf
));
324 static int uhci_show_urbp(struct uhci_hcd
*uhci
, struct urb_priv
*urbp
, char *buf
, int len
)
326 struct list_head
*tmp
;
333 out
+= sprintf(out
, "urb_priv [%p] ", urbp
);
334 out
+= sprintf(out
, "urb [%p] ", urbp
->urb
);
335 out
+= sprintf(out
, "qh [%p] ", urbp
->qh
);
336 out
+= sprintf(out
, "Dev=%d ", usb_pipedevice(urbp
->urb
->pipe
));
337 out
+= sprintf(out
, "EP=%x(%s) ", usb_pipeendpoint(urbp
->urb
->pipe
), (usb_pipein(urbp
->urb
->pipe
) ? "IN" : "OUT"));
339 switch (usb_pipetype(urbp
->urb
->pipe
)) {
340 case PIPE_ISOCHRONOUS
: out
+= sprintf(out
, "ISO "); break;
341 case PIPE_INTERRUPT
: out
+= sprintf(out
, "INT "); break;
342 case PIPE_BULK
: out
+= sprintf(out
, "BLK "); break;
343 case PIPE_CONTROL
: out
+= sprintf(out
, "CTL "); break;
346 out
+= sprintf(out
, "%s", (urbp
->fsbr
? "FSBR " : ""));
347 out
+= sprintf(out
, "%s", (urbp
->fsbr_timeout
? "FSBR_TO " : ""));
349 if (urbp
->urb
->status
!= -EINPROGRESS
)
350 out
+= sprintf(out
, "Status=%d ", urbp
->urb
->status
);
351 //out += sprintf(out, "FSBRtime=%lx ",urbp->fsbrtime);
354 list_for_each(tmp
, &urbp
->td_list
)
356 out
+= sprintf(out
, "TDs=%d ",count
);
359 out
+= sprintf(out
, "queued\n");
362 list_for_each(tmp
, &urbp
->queue_list
)
364 out
+= sprintf(out
, "queued URBs=%d\n", count
);
370 static int uhci_show_lists(struct uhci_hcd
*uhci
, char *buf
, int len
)
373 struct list_head
*head
, *tmp
;
376 out
+= sprintf(out
, "Main list URBs:");
377 if (list_empty(&uhci
->urb_list
))
378 out
+= sprintf(out
, " Empty\n");
380 out
+= sprintf(out
, "\n");
382 head
= &uhci
->urb_list
;
384 while (tmp
!= head
) {
385 struct urb_priv
*urbp
= list_entry(tmp
, struct urb_priv
, urb_list
);
387 out
+= sprintf(out
, " %d: ", ++count
);
388 out
+= uhci_show_urbp(uhci
, urbp
, out
, len
- (out
- buf
));
393 out
+= sprintf(out
, "Remove list URBs:");
394 if (list_empty(&uhci
->urb_remove_list
))
395 out
+= sprintf(out
, " Empty\n");
397 out
+= sprintf(out
, "\n");
399 head
= &uhci
->urb_remove_list
;
401 while (tmp
!= head
) {
402 struct urb_priv
*urbp
= list_entry(tmp
, struct urb_priv
, urb_list
);
404 out
+= sprintf(out
, " %d: ", ++count
);
405 out
+= uhci_show_urbp(uhci
, urbp
, out
, len
- (out
- buf
));
410 out
+= sprintf(out
, "Complete list URBs:");
411 if (list_empty(&uhci
->complete_list
))
412 out
+= sprintf(out
, " Empty\n");
414 out
+= sprintf(out
, "\n");
416 head
= &uhci
->complete_list
;
418 while (tmp
!= head
) {
419 struct urb_priv
*urbp
= list_entry(tmp
, struct urb_priv
, urb_list
);
421 out
+= sprintf(out
, " %d: ", ++count
);
422 out
+= uhci_show_urbp(uhci
, urbp
, out
, len
- (out
- buf
));
430 static int uhci_sprint_schedule(struct uhci_hcd
*uhci
, char *buf
, int len
)
437 struct list_head
*tmp
, *head
;
439 spin_lock_irqsave(&uhci
->lock
, flags
);
441 out
+= uhci_show_root_hub_state(uhci
, out
, len
- (out
- buf
));
442 out
+= sprintf(out
, "HC status\n");
443 out
+= uhci_show_status(uhci
, out
, len
- (out
- buf
));
445 out
+= sprintf(out
, "Frame List\n");
446 for (i
= 0; i
< UHCI_NUMFRAMES
; ++i
) {
448 td
= uhci
->frame_cpu
[i
];
452 if (td
->dma_handle
!= (dma_addr_t
)uhci
->frame
[i
]) {
454 out
+= sprintf(out
, " frame list does not match td->dma_handle!\n");
461 td
= list_entry(tmp
, struct uhci_td
, fl_list
);
463 out
+= uhci_show_td(td
, out
, len
- (out
- buf
), 4);
464 } while (tmp
!= head
);
467 out
+= sprintf(out
, "Skeleton QHs\n");
469 for (i
= 0; i
< UHCI_NUM_SKELQH
; ++i
) {
472 qh
= uhci
->skelqh
[i
];
476 out
+= uhci_show_qh(qh
, out
, len
- (out
- buf
), 4);
479 /* Last QH is the Terminating QH, it's different */
480 if (i
== UHCI_NUM_SKELQH
- 1) {
481 if (qh
->link
!= UHCI_PTR_TERM
)
482 out
+= sprintf(out
, " bandwidth reclamation on!\n");
484 if (qh_element(qh
) != cpu_to_le32(uhci
->term_td
->dma_handle
))
485 out
+= sprintf(out
, " skel_term_qh element is not set to term_td!\n");
490 j
= (i
< 7) ? 7 : i
+1; /* Next skeleton */
491 if (list_empty(&qh
->list
)) {
492 if (i
< UHCI_NUM_SKELQH
- 1) {
494 (cpu_to_le32(uhci
->skelqh
[j
]->dma_handle
) | UHCI_PTR_QH
)) {
496 out
+= sprintf(out
, " skeleton QH not linked to next skeleton QH!\n");
508 while (tmp
!= head
) {
509 qh
= list_entry(tmp
, struct uhci_qh
, list
);
513 out
+= uhci_show_qh(qh
, out
, len
- (out
- buf
), 4);
516 if (i
< UHCI_NUM_SKELQH
- 1) {
518 (cpu_to_le32(uhci
->skelqh
[j
]->dma_handle
) | UHCI_PTR_QH
))
519 out
+= sprintf(out
, " last QH not linked to next skeleton!\n");
524 out
+= uhci_show_lists(uhci
, out
, len
- (out
- buf
));
526 spin_unlock_irqrestore(&uhci
->lock
, flags
);
531 #define MAX_OUTPUT (64 * 1024)
536 struct uhci_hcd
*uhci
;
539 static int uhci_debug_open(struct inode
*inode
, struct file
*file
)
541 struct uhci_hcd
*uhci
= inode
->u
.generic_ip
;
542 struct uhci_debug
*up
;
546 up
= kmalloc(sizeof(*up
), GFP_KERNEL
);
550 up
->data
= kmalloc(MAX_OUTPUT
, GFP_KERNEL
);
556 up
->size
= uhci_sprint_schedule(uhci
, up
->data
, MAX_OUTPUT
);
558 file
->private_data
= up
;
566 static loff_t
uhci_debug_lseek(struct file
*file
, loff_t off
, int whence
)
568 struct uhci_debug
*up
;
572 up
= file
->private_data
;
579 new = file
->f_pos
+ off
;
582 if (new < 0 || new > up
->size
) {
587 return (file
->f_pos
= new);
590 static ssize_t
uhci_debug_read(struct file
*file
, char __user
*buf
,
591 size_t nbytes
, loff_t
*ppos
)
593 struct uhci_debug
*up
= file
->private_data
;
594 return simple_read_from_buffer(buf
, nbytes
, ppos
, up
->data
, up
->size
);
597 static int uhci_debug_release(struct inode
*inode
, struct file
*file
)
599 struct uhci_debug
*up
= file
->private_data
;
607 static struct file_operations uhci_debug_operations
= {
608 .open
= uhci_debug_open
,
609 .llseek
= uhci_debug_lseek
,
610 .read
= uhci_debug_read
,
611 .release
= uhci_debug_release
,
614 #else /* CONFIG_DEBUG_FS */
616 #define uhci_debug_operations (* (struct file_operations *) NULL)