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 #define uhci_debug_operations (* (struct file_operations *) NULL)
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_td *td, char *buf, int len, int space)
48 /* Try to make sure there's enough memory */
52 status = td_status(td);
53 out += sprintf(out, "%*s[%p] link (%08x) ", space, "", td, le32_to_cpu(td->link));
54 out += sprintf(out, "e%d %s%s%s%s%s%s%s%s%s%sLength=%x ",
56 (status & TD_CTRL_SPD) ? "SPD " : "",
57 (status & TD_CTRL_LS) ? "LS " : "",
58 (status & TD_CTRL_IOC) ? "IOC " : "",
59 (status & TD_CTRL_ACTIVE) ? "Active " : "",
60 (status & TD_CTRL_STALLED) ? "Stalled " : "",
61 (status & TD_CTRL_DBUFERR) ? "DataBufErr " : "",
62 (status & TD_CTRL_BABBLE) ? "Babble " : "",
63 (status & TD_CTRL_NAK) ? "NAK " : "",
64 (status & TD_CTRL_CRCTIMEO) ? "CRC/Timeo " : "",
65 (status & TD_CTRL_BITSTUFF) ? "BitStuff " : "",
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", le32_to_cpu(td->buffer));
96 static int uhci_show_urbp(struct urb_priv *urbp, char *buf, int len, int space)
100 int i, nactive, ninactive;
106 out += sprintf(out, "urb_priv [%p] ", urbp);
107 out += sprintf(out, "urb [%p] ", urbp->urb);
108 out += sprintf(out, "qh [%p] ", urbp->qh);
109 out += sprintf(out, "Dev=%d ", usb_pipedevice(urbp->urb->pipe));
110 out += sprintf(out, "EP=%x(%s) ", usb_pipeendpoint(urbp->urb->pipe),
111 (usb_pipein(urbp->urb->pipe) ? "IN" : "OUT"));
113 switch (usb_pipetype(urbp->urb->pipe)) {
114 case PIPE_ISOCHRONOUS: ptype = "ISO"; break;
115 case PIPE_INTERRUPT: ptype = "INT"; break;
116 case PIPE_BULK: ptype = "BLK"; break;
118 case PIPE_CONTROL: ptype = "CTL"; break;
121 out += sprintf(out, "%s%s", ptype, (urbp->fsbr ? " FSBR" : ""));
122 out += sprintf(out, " Actlen=%d", urbp->urb->actual_length);
124 if (urbp->urb->status != -EINPROGRESS)
125 out += sprintf(out, " Status=%d", urbp->urb->status);
126 out += sprintf(out, "\n");
128 i = nactive = ninactive = 0;
129 list_for_each_entry(td, &urbp->td_list, list) {
130 if (++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\n",
172 space, "", qh->period);
174 if (element & UHCI_PTR_QH)
175 out += sprintf(out, "%*s Element points to QH (bug?)\n", space, "");
177 if (element & UHCI_PTR_DEPTH)
178 out += sprintf(out, "%*s Depth traverse\n", space, "");
180 if (element & cpu_to_le32(8))
181 out += sprintf(out, "%*s Bit 3 set (bug?)\n", space, "");
183 if (!(element & ~(UHCI_PTR_QH | UHCI_PTR_DEPTH)))
184 out += sprintf(out, "%*s Element is NULL (bug?)\n", space, "");
186 if (list_empty(&qh->queue)) {
187 out += sprintf(out, "%*s queue is empty\n", space, "");
189 struct urb_priv *urbp = list_entry(qh->queue.next,
190 struct urb_priv, node);
191 struct uhci_td *td = list_entry(urbp->td_list.next,
192 struct uhci_td, list);
194 if (cpu_to_le32(td->dma_handle) != (element & ~UHCI_PTR_BITS))
195 out += sprintf(out, "%*s Element != First TD\n",
198 list_for_each_entry(urbp, &qh->queue, node) {
200 out += uhci_show_urbp(urbp, out,
201 len - (out - buf), space + 2);
206 out += sprintf(out, "%*s Skipped %d URBs\n",
211 out += sprintf(out, "%*s Dummy TD\n", space, "");
212 out += uhci_show_td(qh->dummy_td, out, len - (out - buf), 0);
218 static const char * const qh_names[] = {
219 "skel_unlink_qh", "skel_iso_qh",
220 "skel_int128_qh", "skel_int64_qh",
221 "skel_int32_qh", "skel_int16_qh",
222 "skel_int8_qh", "skel_int4_qh",
223 "skel_int2_qh", "skel_int1_qh",
224 "skel_ls_control_qh", "skel_fs_control_qh",
225 "skel_bulk_qh", "skel_term_qh"
228 static int uhci_show_sc(int port, unsigned short status, char *buf, int len)
232 /* Try to make sure there's enough memory */
236 out += sprintf(out, " stat%d = %04x %s%s%s%s%s%s%s%s%s%s\n",
239 (status & USBPORTSC_SUSP) ? " Suspend" : "",
240 (status & USBPORTSC_OCC) ? " OverCurrentChange" : "",
241 (status & USBPORTSC_OC) ? " OverCurrent" : "",
242 (status & USBPORTSC_PR) ? " Reset" : "",
243 (status & USBPORTSC_LSDA) ? " LowSpeed" : "",
244 (status & USBPORTSC_RD) ? " ResumeDetect" : "",
245 (status & USBPORTSC_PEC) ? " EnableChange" : "",
246 (status & USBPORTSC_PE) ? " Enabled" : "",
247 (status & USBPORTSC_CSC) ? " ConnectChange" : "",
248 (status & USBPORTSC_CCS) ? " Connected" : "");
253 static int uhci_show_root_hub_state(struct uhci_hcd *uhci, char *buf, int len)
258 /* Try to make sure there's enough memory */
262 switch (uhci->rh_state) {
264 rh_state = "reset"; break;
265 case UHCI_RH_SUSPENDED:
266 rh_state = "suspended"; break;
267 case UHCI_RH_AUTO_STOPPED:
268 rh_state = "auto-stopped"; break;
269 case UHCI_RH_RESUMING:
270 rh_state = "resuming"; break;
271 case UHCI_RH_SUSPENDING:
272 rh_state = "suspending"; break;
273 case UHCI_RH_RUNNING:
274 rh_state = "running"; break;
275 case UHCI_RH_RUNNING_NODEVS:
276 rh_state = "running, no devs"; break;
278 rh_state = "?"; break;
280 out += sprintf(out, "Root-hub state: %s FSBR: %d\n",
281 rh_state, uhci->fsbr_is_on);
285 static int uhci_show_status(struct uhci_hcd *uhci, char *buf, int len)
288 unsigned long io_addr = uhci->io_addr;
289 unsigned short usbcmd, usbstat, usbint, usbfrnum;
290 unsigned int flbaseadd;
292 unsigned short portsc1, portsc2;
294 /* Try to make sure there's enough memory */
298 usbcmd = inw(io_addr + 0);
299 usbstat = inw(io_addr + 2);
300 usbint = inw(io_addr + 4);
301 usbfrnum = inw(io_addr + 6);
302 flbaseadd = inl(io_addr + 8);
303 sof = inb(io_addr + 12);
304 portsc1 = inw(io_addr + 16);
305 portsc2 = inw(io_addr + 18);
307 out += sprintf(out, " usbcmd = %04x %s%s%s%s%s%s%s%s\n",
309 (usbcmd & USBCMD_MAXP) ? "Maxp64 " : "Maxp32 ",
310 (usbcmd & USBCMD_CF) ? "CF " : "",
311 (usbcmd & USBCMD_SWDBG) ? "SWDBG " : "",
312 (usbcmd & USBCMD_FGR) ? "FGR " : "",
313 (usbcmd & USBCMD_EGSM) ? "EGSM " : "",
314 (usbcmd & USBCMD_GRESET) ? "GRESET " : "",
315 (usbcmd & USBCMD_HCRESET) ? "HCRESET " : "",
316 (usbcmd & USBCMD_RS) ? "RS " : "");
318 out += sprintf(out, " usbstat = %04x %s%s%s%s%s%s\n",
320 (usbstat & USBSTS_HCH) ? "HCHalted " : "",
321 (usbstat & USBSTS_HCPE) ? "HostControllerProcessError " : "",
322 (usbstat & USBSTS_HSE) ? "HostSystemError " : "",
323 (usbstat & USBSTS_RD) ? "ResumeDetect " : "",
324 (usbstat & USBSTS_ERROR) ? "USBError " : "",
325 (usbstat & USBSTS_USBINT) ? "USBINT " : "");
327 out += sprintf(out, " usbint = %04x\n", usbint);
328 out += sprintf(out, " usbfrnum = (%d)%03x\n", (usbfrnum >> 10) & 1,
329 0xfff & (4*(unsigned int)usbfrnum));
330 out += sprintf(out, " flbaseadd = %08x\n", flbaseadd);
331 out += sprintf(out, " sof = %02x\n", sof);
332 out += uhci_show_sc(1, portsc1, out, len - (out - buf));
333 out += uhci_show_sc(2, portsc2, out, len - (out - buf));
334 out += sprintf(out, "Most recent frame: %x\n",
340 static int uhci_sprint_schedule(struct uhci_hcd *uhci, char *buf, int len)
346 struct list_head *tmp, *head;
348 out += uhci_show_root_hub_state(uhci, out, len - (out - buf));
349 out += sprintf(out, "HC status\n");
350 out += uhci_show_status(uhci, out, len - (out - buf));
354 out += sprintf(out, "Frame List\n");
355 for (i = 0; i < UHCI_NUMFRAMES; ++i) {
356 td = uhci->frame_cpu[i];
360 out += sprintf(out, "- Frame %d\n", i); \
361 if (td->dma_handle != (dma_addr_t)uhci->frame[i])
362 out += sprintf(out, " frame list does not match td->dma_handle!\n");
367 td = list_entry(tmp, struct uhci_td, fl_list);
369 out += uhci_show_td(td, out, len - (out - buf), 4);
370 } while (tmp != head);
373 out += sprintf(out, "Skeleton QHs\n");
375 for (i = 0; i < UHCI_NUM_SKELQH; ++i) {
378 qh = uhci->skelqh[i];
379 out += sprintf(out, "- %s\n", qh_names[i]); \
380 out += uhci_show_qh(qh, out, len - (out - buf), 4);
382 /* Last QH is the Terminating QH, it's different */
383 if (i == UHCI_NUM_SKELQH - 1) {
384 if (qh->link != UHCI_PTR_TERM)
385 out += sprintf(out, " bandwidth reclamation on!\n");
387 if (qh_element(qh) != cpu_to_le32(uhci->term_td->dma_handle))
388 out += sprintf(out, " skel_term_qh element is not set to term_td!\n");
393 j = (i < 9) ? 9 : i+1; /* Next skeleton */
397 while (tmp != head) {
398 qh = list_entry(tmp, struct uhci_qh, node);
401 out += uhci_show_qh(qh, out,
402 len - (out - buf), 4);
405 out += sprintf(out, " Skipped %d QHs\n", cnt);
407 if (i > 1 && i < UHCI_NUM_SKELQH - 1) {
409 (cpu_to_le32(uhci->skelqh[j]->dma_handle) | UHCI_PTR_QH))
410 out += sprintf(out, " last QH not linked to next skeleton!\n");
417 #ifdef CONFIG_DEBUG_FS
419 #define MAX_OUTPUT (64 * 1024)
426 static int uhci_debug_open(struct inode *inode, struct file *file)
428 struct uhci_hcd *uhci = inode->u.generic_ip;
429 struct uhci_debug *up;
434 up = kmalloc(sizeof(*up), GFP_KERNEL);
438 up->data = kmalloc(MAX_OUTPUT, GFP_KERNEL);
445 spin_lock_irqsave(&uhci->lock, flags);
446 if (uhci->is_initialized)
447 up->size = uhci_sprint_schedule(uhci, up->data, MAX_OUTPUT);
448 spin_unlock_irqrestore(&uhci->lock, flags);
450 file->private_data = up;
458 static loff_t uhci_debug_lseek(struct file *file, loff_t off, int whence)
460 struct uhci_debug *up;
464 up = file->private_data;
471 new = file->f_pos + off;
474 if (new < 0 || new > up->size) {
479 return (file->f_pos = new);
482 static ssize_t uhci_debug_read(struct file *file, char __user *buf,
483 size_t nbytes, loff_t *ppos)
485 struct uhci_debug *up = file->private_data;
486 return simple_read_from_buffer(buf, nbytes, ppos, up->data, up->size);
489 static int uhci_debug_release(struct inode *inode, struct file *file)
491 struct uhci_debug *up = file->private_data;
499 #undef uhci_debug_operations
500 static struct file_operations uhci_debug_operations = {
501 .owner = THIS_MODULE,
502 .open = uhci_debug_open,
503 .llseek = uhci_debug_lseek,
504 .read = uhci_debug_read,
505 .release = uhci_debug_release,
508 #endif /* CONFIG_DEBUG_FS */
512 static inline void lprintk(char *buf)
515 static inline int uhci_show_qh(struct uhci_qh *qh, char *buf,
521 static inline int uhci_sprint_schedule(struct uhci_hcd *uhci,