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/kernel.h>
13 #include <linux/debugfs.h>
14 #include <linux/smp_lock.h>
19 #define uhci_debug_operations (* (const struct file_operations *) NULL)
20 static struct dentry
*uhci_debugfs_root
;
24 /* Handle REALLY large printks so we don't overflow buffers */
25 static void lprintk(char *buf
)
29 /* Just write one line at a time */
31 p
= strchr(buf
, '\n');
34 printk(KERN_DEBUG
"%s\n", buf
);
41 static int uhci_show_td(struct uhci_td
*td
, char *buf
, int len
, int space
)
47 /* Try to make sure there's enough memory */
51 status
= td_status(td
);
52 out
+= sprintf(out
, "%*s[%p] link (%08x) ", space
, "", td
, le32_to_cpu(td
->link
));
53 out
+= sprintf(out
, "e%d %s%s%s%s%s%s%s%s%s%sLength=%x ",
55 (status
& TD_CTRL_SPD
) ? "SPD " : "",
56 (status
& TD_CTRL_LS
) ? "LS " : "",
57 (status
& TD_CTRL_IOC
) ? "IOC " : "",
58 (status
& TD_CTRL_ACTIVE
) ? "Active " : "",
59 (status
& TD_CTRL_STALLED
) ? "Stalled " : "",
60 (status
& TD_CTRL_DBUFERR
) ? "DataBufErr " : "",
61 (status
& TD_CTRL_BABBLE
) ? "Babble " : "",
62 (status
& TD_CTRL_NAK
) ? "NAK " : "",
63 (status
& TD_CTRL_CRCTIMEO
) ? "CRC/Timeo " : "",
64 (status
& TD_CTRL_BITSTUFF
) ? "BitStuff " : "",
68 switch (uhci_packetid(token
)) {
83 out
+= sprintf(out
, "MaxLen=%x DT%d EndPt=%x Dev=%x, PID=%x(%s) ",
90 out
+= sprintf(out
, "(buf=%08x)\n", le32_to_cpu(td
->buffer
));
95 static int uhci_show_urbp(struct urb_priv
*urbp
, char *buf
, int len
, int space
)
99 int i
, nactive
, ninactive
;
105 out
+= sprintf(out
, "urb_priv [%p] ", urbp
);
106 out
+= sprintf(out
, "urb [%p] ", urbp
->urb
);
107 out
+= sprintf(out
, "qh [%p] ", urbp
->qh
);
108 out
+= sprintf(out
, "Dev=%d ", usb_pipedevice(urbp
->urb
->pipe
));
109 out
+= sprintf(out
, "EP=%x(%s) ", usb_pipeendpoint(urbp
->urb
->pipe
),
110 (usb_pipein(urbp
->urb
->pipe
) ? "IN" : "OUT"));
112 switch (usb_pipetype(urbp
->urb
->pipe
)) {
113 case PIPE_ISOCHRONOUS
: ptype
= "ISO"; break;
114 case PIPE_INTERRUPT
: ptype
= "INT"; break;
115 case PIPE_BULK
: ptype
= "BLK"; break;
117 case PIPE_CONTROL
: ptype
= "CTL"; break;
120 out
+= sprintf(out
, "%s%s", ptype
, (urbp
->fsbr
? " FSBR" : ""));
121 out
+= sprintf(out
, " Actlen=%d", urbp
->urb
->actual_length
);
123 if (urbp
->urb
->status
!= -EINPROGRESS
)
124 out
+= sprintf(out
, " Status=%d", urbp
->urb
->status
);
125 out
+= sprintf(out
, "\n");
127 i
= nactive
= ninactive
= 0;
128 list_for_each_entry(td
, &urbp
->td_list
, list
) {
129 if (urbp
->qh
->type
!= USB_ENDPOINT_XFER_ISOC
&&
130 (++i
<= 10 || debug
> 2)) {
131 out
+= sprintf(out
, "%*s%d: ", space
+ 2, "", i
);
132 out
+= uhci_show_td(td
, out
, len
- (out
- buf
), 0);
134 if (td_status(td
) & TD_CTRL_ACTIVE
)
140 if (nactive
+ ninactive
> 0)
141 out
+= sprintf(out
, "%*s[skipped %d inactive and %d active "
143 space
, "", ninactive
, nactive
);
148 static int uhci_show_qh(struct uhci_qh
*qh
, char *buf
, int len
, int space
)
152 __le32 element
= qh_element(qh
);
155 /* Try to make sure there's enough memory */
160 case USB_ENDPOINT_XFER_ISOC
: qtype
= "ISO"; break;
161 case USB_ENDPOINT_XFER_INT
: qtype
= "INT"; break;
162 case USB_ENDPOINT_XFER_BULK
: qtype
= "BLK"; break;
163 case USB_ENDPOINT_XFER_CONTROL
: qtype
= "CTL"; break;
164 default: qtype
= "Skel" ; break;
167 out
+= sprintf(out
, "%*s[%p] %s QH link (%08x) element (%08x)\n",
168 space
, "", qh
, qtype
,
169 le32_to_cpu(qh
->link
), le32_to_cpu(element
));
170 if (qh
->type
== USB_ENDPOINT_XFER_ISOC
)
171 out
+= sprintf(out
, "%*s period %d phase %d load %d us, "
172 "frame %x desc [%p]\n",
173 space
, "", qh
->period
, qh
->phase
, qh
->load
,
174 qh
->iso_frame
, qh
->iso_packet_desc
);
175 else if (qh
->type
== USB_ENDPOINT_XFER_INT
)
176 out
+= sprintf(out
, "%*s period %d phase %d load %d us\n",
177 space
, "", qh
->period
, qh
->phase
, qh
->load
);
179 if (element
& UHCI_PTR_QH
)
180 out
+= sprintf(out
, "%*s Element points to QH (bug?)\n", space
, "");
182 if (element
& UHCI_PTR_DEPTH
)
183 out
+= sprintf(out
, "%*s Depth traverse\n", space
, "");
185 if (element
& cpu_to_le32(8))
186 out
+= sprintf(out
, "%*s Bit 3 set (bug?)\n", space
, "");
188 if (!(element
& ~(UHCI_PTR_QH
| UHCI_PTR_DEPTH
)))
189 out
+= sprintf(out
, "%*s Element is NULL (bug?)\n", space
, "");
191 if (list_empty(&qh
->queue
)) {
192 out
+= sprintf(out
, "%*s queue is empty\n", space
, "");
194 struct urb_priv
*urbp
= list_entry(qh
->queue
.next
,
195 struct urb_priv
, node
);
196 struct uhci_td
*td
= list_entry(urbp
->td_list
.next
,
197 struct uhci_td
, list
);
199 if (element
!= LINK_TO_TD(td
))
200 out
+= sprintf(out
, "%*s Element != First TD\n",
203 list_for_each_entry(urbp
, &qh
->queue
, node
) {
205 out
+= uhci_show_urbp(urbp
, out
,
206 len
- (out
- buf
), space
+ 2);
211 out
+= sprintf(out
, "%*s Skipped %d URBs\n",
216 out
+= sprintf(out
, "%*s Dummy TD\n", space
, "");
217 out
+= uhci_show_td(qh
->dummy_td
, out
, len
- (out
- buf
), 0);
223 static const char * const qh_names
[] = {
224 "skel_unlink_qh", "skel_iso_qh",
225 "skel_int128_qh", "skel_int64_qh",
226 "skel_int32_qh", "skel_int16_qh",
227 "skel_int8_qh", "skel_int4_qh",
228 "skel_int2_qh", "skel_int1_qh",
229 "skel_ls_control_qh", "skel_fs_control_qh",
230 "skel_bulk_qh", "skel_term_qh"
233 static int uhci_show_sc(int port
, unsigned short status
, char *buf
, int len
)
237 /* Try to make sure there's enough memory */
241 out
+= sprintf(out
, " stat%d = %04x %s%s%s%s%s%s%s%s%s%s\n",
244 (status
& USBPORTSC_SUSP
) ? " Suspend" : "",
245 (status
& USBPORTSC_OCC
) ? " OverCurrentChange" : "",
246 (status
& USBPORTSC_OC
) ? " OverCurrent" : "",
247 (status
& USBPORTSC_PR
) ? " Reset" : "",
248 (status
& USBPORTSC_LSDA
) ? " LowSpeed" : "",
249 (status
& USBPORTSC_RD
) ? " ResumeDetect" : "",
250 (status
& USBPORTSC_PEC
) ? " EnableChange" : "",
251 (status
& USBPORTSC_PE
) ? " Enabled" : "",
252 (status
& USBPORTSC_CSC
) ? " ConnectChange" : "",
253 (status
& USBPORTSC_CCS
) ? " Connected" : "");
258 static int uhci_show_root_hub_state(struct uhci_hcd
*uhci
, char *buf
, int len
)
263 /* Try to make sure there's enough memory */
267 switch (uhci
->rh_state
) {
269 rh_state
= "reset"; break;
270 case UHCI_RH_SUSPENDED
:
271 rh_state
= "suspended"; break;
272 case UHCI_RH_AUTO_STOPPED
:
273 rh_state
= "auto-stopped"; break;
274 case UHCI_RH_RESUMING
:
275 rh_state
= "resuming"; break;
276 case UHCI_RH_SUSPENDING
:
277 rh_state
= "suspending"; break;
278 case UHCI_RH_RUNNING
:
279 rh_state
= "running"; break;
280 case UHCI_RH_RUNNING_NODEVS
:
281 rh_state
= "running, no devs"; break;
283 rh_state
= "?"; break;
285 out
+= sprintf(out
, "Root-hub state: %s FSBR: %d\n",
286 rh_state
, uhci
->fsbr_is_on
);
290 static int uhci_show_status(struct uhci_hcd
*uhci
, char *buf
, int len
)
293 unsigned long io_addr
= uhci
->io_addr
;
294 unsigned short usbcmd
, usbstat
, usbint
, usbfrnum
;
295 unsigned int flbaseadd
;
297 unsigned short portsc1
, portsc2
;
299 /* Try to make sure there's enough memory */
303 usbcmd
= inw(io_addr
+ 0);
304 usbstat
= inw(io_addr
+ 2);
305 usbint
= inw(io_addr
+ 4);
306 usbfrnum
= inw(io_addr
+ 6);
307 flbaseadd
= inl(io_addr
+ 8);
308 sof
= inb(io_addr
+ 12);
309 portsc1
= inw(io_addr
+ 16);
310 portsc2
= inw(io_addr
+ 18);
312 out
+= sprintf(out
, " usbcmd = %04x %s%s%s%s%s%s%s%s\n",
314 (usbcmd
& USBCMD_MAXP
) ? "Maxp64 " : "Maxp32 ",
315 (usbcmd
& USBCMD_CF
) ? "CF " : "",
316 (usbcmd
& USBCMD_SWDBG
) ? "SWDBG " : "",
317 (usbcmd
& USBCMD_FGR
) ? "FGR " : "",
318 (usbcmd
& USBCMD_EGSM
) ? "EGSM " : "",
319 (usbcmd
& USBCMD_GRESET
) ? "GRESET " : "",
320 (usbcmd
& USBCMD_HCRESET
) ? "HCRESET " : "",
321 (usbcmd
& USBCMD_RS
) ? "RS " : "");
323 out
+= sprintf(out
, " usbstat = %04x %s%s%s%s%s%s\n",
325 (usbstat
& USBSTS_HCH
) ? "HCHalted " : "",
326 (usbstat
& USBSTS_HCPE
) ? "HostControllerProcessError " : "",
327 (usbstat
& USBSTS_HSE
) ? "HostSystemError " : "",
328 (usbstat
& USBSTS_RD
) ? "ResumeDetect " : "",
329 (usbstat
& USBSTS_ERROR
) ? "USBError " : "",
330 (usbstat
& USBSTS_USBINT
) ? "USBINT " : "");
332 out
+= sprintf(out
, " usbint = %04x\n", usbint
);
333 out
+= sprintf(out
, " usbfrnum = (%d)%03x\n", (usbfrnum
>> 10) & 1,
334 0xfff & (4*(unsigned int)usbfrnum
));
335 out
+= sprintf(out
, " flbaseadd = %08x\n", flbaseadd
);
336 out
+= sprintf(out
, " sof = %02x\n", sof
);
337 out
+= uhci_show_sc(1, portsc1
, out
, len
- (out
- buf
));
338 out
+= uhci_show_sc(2, portsc2
, out
, len
- (out
- buf
));
339 out
+= sprintf(out
, "Most recent frame: %x (%d) "
340 "Last ISO frame: %x (%d)\n",
341 uhci
->frame_number
, uhci
->frame_number
& 1023,
342 uhci
->last_iso_frame
, uhci
->last_iso_frame
& 1023);
347 static int uhci_sprint_schedule(struct uhci_hcd
*uhci
, char *buf
, int len
)
353 struct list_head
*tmp
, *head
;
356 out
+= uhci_show_root_hub_state(uhci
, out
, len
- (out
- buf
));
357 out
+= sprintf(out
, "HC status\n");
358 out
+= uhci_show_status(uhci
, out
, len
- (out
- buf
));
360 out
+= sprintf(out
, "Periodic load table\n");
361 for (i
= 0; i
< MAX_PHASE
; ++i
) {
362 out
+= sprintf(out
, "\t%d", uhci
->load
[i
]);
366 out
+= sprintf(out
, "Total: %d, #INT: %d, #ISO: %d\n",
368 uhci_to_hcd(uhci
)->self
.bandwidth_int_reqs
,
369 uhci_to_hcd(uhci
)->self
.bandwidth_isoc_reqs
);
373 out
+= sprintf(out
, "Frame List\n");
376 for (i
= 0; i
< UHCI_NUMFRAMES
; ++i
) {
380 td
= uhci
->frame_cpu
[i
];
381 link
= uhci
->frame
[i
];
386 out
+= sprintf(out
, "- Frame %d -> (%08x)\n",
387 i
, le32_to_cpu(link
));
394 td
= list_entry(tmp
, struct uhci_td
, fl_list
);
396 if (link
!= LINK_TO_TD(td
)) {
398 out
+= sprintf(out
, " link does "
399 "not match list entry!\n");
404 out
+= uhci_show_td(td
, out
,
405 len
- (out
- buf
), 4);
407 } while (tmp
!= head
);
410 qh_dma
= uhci_frame_skel_link(uhci
, i
);
411 if (link
!= qh_dma
) {
415 "- Frame %d -> (%08x)\n",
416 i
, le32_to_cpu(link
));
419 out
+= sprintf(out
, " link does not match "
420 "QH (%08x)!\n", le32_to_cpu(qh_dma
));
427 out
+= sprintf(out
, "Skipped %d bad links\n", nerrs
);
429 out
+= sprintf(out
, "Skeleton QHs\n");
431 for (i
= 0; i
< UHCI_NUM_SKELQH
; ++i
) {
434 qh
= uhci
->skelqh
[i
];
435 out
+= sprintf(out
, "- %s\n", qh_names
[i
]); \
436 out
+= uhci_show_qh(qh
, out
, len
- (out
- buf
), 4);
438 /* Last QH is the Terminating QH, it's different */
439 if (i
== UHCI_NUM_SKELQH
- 1) {
440 if (qh
->link
!= UHCI_PTR_TERM
)
441 out
+= sprintf(out
, " bandwidth reclamation on!\n");
443 if (qh_element(qh
) != LINK_TO_TD(uhci
->term_td
))
444 out
+= sprintf(out
, " skel_term_qh element is not set to term_td!\n");
449 j
= (i
< 9) ? 9 : i
+1; /* Next skeleton */
453 while (tmp
!= head
) {
454 qh
= list_entry(tmp
, struct uhci_qh
, node
);
457 out
+= uhci_show_qh(qh
, out
,
458 len
- (out
- buf
), 4);
461 out
+= sprintf(out
, " Skipped %d QHs\n", cnt
);
463 if (i
> 1 && i
< UHCI_NUM_SKELQH
- 1) {
464 if (qh
->link
!= LINK_TO_QH(uhci
->skelqh
[j
]))
465 out
+= sprintf(out
, " last QH not linked to next skeleton!\n");
472 #ifdef CONFIG_DEBUG_FS
474 #define MAX_OUTPUT (64 * 1024)
481 static int uhci_debug_open(struct inode
*inode
, struct file
*file
)
483 struct uhci_hcd
*uhci
= inode
->i_private
;
484 struct uhci_debug
*up
;
489 up
= kmalloc(sizeof(*up
), GFP_KERNEL
);
493 up
->data
= kmalloc(MAX_OUTPUT
, GFP_KERNEL
);
500 spin_lock_irqsave(&uhci
->lock
, flags
);
501 if (uhci
->is_initialized
)
502 up
->size
= uhci_sprint_schedule(uhci
, up
->data
, MAX_OUTPUT
);
503 spin_unlock_irqrestore(&uhci
->lock
, flags
);
505 file
->private_data
= up
;
513 static loff_t
uhci_debug_lseek(struct file
*file
, loff_t off
, int whence
)
515 struct uhci_debug
*up
;
519 up
= file
->private_data
;
526 new = file
->f_pos
+ off
;
529 if (new < 0 || new > up
->size
) {
534 return (file
->f_pos
= new);
537 static ssize_t
uhci_debug_read(struct file
*file
, char __user
*buf
,
538 size_t nbytes
, loff_t
*ppos
)
540 struct uhci_debug
*up
= file
->private_data
;
541 return simple_read_from_buffer(buf
, nbytes
, ppos
, up
->data
, up
->size
);
544 static int uhci_debug_release(struct inode
*inode
, struct file
*file
)
546 struct uhci_debug
*up
= file
->private_data
;
554 #undef uhci_debug_operations
555 static const struct file_operations uhci_debug_operations
= {
556 .owner
= THIS_MODULE
,
557 .open
= uhci_debug_open
,
558 .llseek
= uhci_debug_lseek
,
559 .read
= uhci_debug_read
,
560 .release
= uhci_debug_release
,
563 #endif /* CONFIG_DEBUG_FS */
567 static inline void lprintk(char *buf
)
570 static inline int uhci_show_qh(struct uhci_qh
*qh
, char *buf
,
576 static inline int uhci_sprint_schedule(struct uhci_hcd
*uhci
,