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 frame %x desc [%p]\n",
172 space, "", qh->period, qh->iso_frame,
173 qh->iso_packet_desc);
175 if (element & UHCI_PTR_QH)
176 out += sprintf(out, "%*s Element points to QH (bug?)\n", space, "");
178 if (element & UHCI_PTR_DEPTH)
179 out += sprintf(out, "%*s Depth traverse\n", space, "");
181 if (element & cpu_to_le32(8))
182 out += sprintf(out, "%*s Bit 3 set (bug?)\n", space, "");
184 if (!(element & ~(UHCI_PTR_QH | UHCI_PTR_DEPTH)))
185 out += sprintf(out, "%*s Element is NULL (bug?)\n", space, "");
187 if (list_empty(&qh->queue)) {
188 out += sprintf(out, "%*s queue is empty\n", space, "");
190 struct urb_priv *urbp = list_entry(qh->queue.next,
191 struct urb_priv, node);
192 struct uhci_td *td = list_entry(urbp->td_list.next,
193 struct uhci_td, list);
195 if (cpu_to_le32(td->dma_handle) != (element & ~UHCI_PTR_BITS))
196 out += sprintf(out, "%*s Element != First TD\n",
199 list_for_each_entry(urbp, &qh->queue, node) {
201 out += uhci_show_urbp(urbp, out,
202 len - (out - buf), space + 2);
207 out += sprintf(out, "%*s Skipped %d URBs\n",
212 out += sprintf(out, "%*s Dummy TD\n", space, "");
213 out += uhci_show_td(qh->dummy_td, out, len - (out - buf), 0);
219 static const char * const qh_names[] = {
220 "skel_unlink_qh", "skel_iso_qh",
221 "skel_int128_qh", "skel_int64_qh",
222 "skel_int32_qh", "skel_int16_qh",
223 "skel_int8_qh", "skel_int4_qh",
224 "skel_int2_qh", "skel_int1_qh",
225 "skel_ls_control_qh", "skel_fs_control_qh",
226 "skel_bulk_qh", "skel_term_qh"
229 static int uhci_show_sc(int port, unsigned short status, char *buf, int len)
233 /* Try to make sure there's enough memory */
237 out += sprintf(out, " stat%d = %04x %s%s%s%s%s%s%s%s%s%s\n",
240 (status & USBPORTSC_SUSP) ? " Suspend" : "",
241 (status & USBPORTSC_OCC) ? " OverCurrentChange" : "",
242 (status & USBPORTSC_OC) ? " OverCurrent" : "",
243 (status & USBPORTSC_PR) ? " Reset" : "",
244 (status & USBPORTSC_LSDA) ? " LowSpeed" : "",
245 (status & USBPORTSC_RD) ? " ResumeDetect" : "",
246 (status & USBPORTSC_PEC) ? " EnableChange" : "",
247 (status & USBPORTSC_PE) ? " Enabled" : "",
248 (status & USBPORTSC_CSC) ? " ConnectChange" : "",
249 (status & USBPORTSC_CCS) ? " Connected" : "");
254 static int uhci_show_root_hub_state(struct uhci_hcd *uhci, char *buf, int len)
259 /* Try to make sure there's enough memory */
263 switch (uhci->rh_state) {
265 rh_state = "reset"; break;
266 case UHCI_RH_SUSPENDED:
267 rh_state = "suspended"; break;
268 case UHCI_RH_AUTO_STOPPED:
269 rh_state = "auto-stopped"; break;
270 case UHCI_RH_RESUMING:
271 rh_state = "resuming"; break;
272 case UHCI_RH_SUSPENDING:
273 rh_state = "suspending"; break;
274 case UHCI_RH_RUNNING:
275 rh_state = "running"; break;
276 case UHCI_RH_RUNNING_NODEVS:
277 rh_state = "running, no devs"; break;
279 rh_state = "?"; break;
281 out += sprintf(out, "Root-hub state: %s FSBR: %d\n",
282 rh_state, uhci->fsbr_is_on);
286 static int uhci_show_status(struct uhci_hcd *uhci, char *buf, int len)
289 unsigned long io_addr = uhci->io_addr;
290 unsigned short usbcmd, usbstat, usbint, usbfrnum;
291 unsigned int flbaseadd;
293 unsigned short portsc1, portsc2;
295 /* Try to make sure there's enough memory */
299 usbcmd = inw(io_addr + 0);
300 usbstat = inw(io_addr + 2);
301 usbint = inw(io_addr + 4);
302 usbfrnum = inw(io_addr + 6);
303 flbaseadd = inl(io_addr + 8);
304 sof = inb(io_addr + 12);
305 portsc1 = inw(io_addr + 16);
306 portsc2 = inw(io_addr + 18);
308 out += sprintf(out, " usbcmd = %04x %s%s%s%s%s%s%s%s\n",
310 (usbcmd & USBCMD_MAXP) ? "Maxp64 " : "Maxp32 ",
311 (usbcmd & USBCMD_CF) ? "CF " : "",
312 (usbcmd & USBCMD_SWDBG) ? "SWDBG " : "",
313 (usbcmd & USBCMD_FGR) ? "FGR " : "",
314 (usbcmd & USBCMD_EGSM) ? "EGSM " : "",
315 (usbcmd & USBCMD_GRESET) ? "GRESET " : "",
316 (usbcmd & USBCMD_HCRESET) ? "HCRESET " : "",
317 (usbcmd & USBCMD_RS) ? "RS " : "");
319 out += sprintf(out, " usbstat = %04x %s%s%s%s%s%s\n",
321 (usbstat & USBSTS_HCH) ? "HCHalted " : "",
322 (usbstat & USBSTS_HCPE) ? "HostControllerProcessError " : "",
323 (usbstat & USBSTS_HSE) ? "HostSystemError " : "",
324 (usbstat & USBSTS_RD) ? "ResumeDetect " : "",
325 (usbstat & USBSTS_ERROR) ? "USBError " : "",
326 (usbstat & USBSTS_USBINT) ? "USBINT " : "");
328 out += sprintf(out, " usbint = %04x\n", usbint);
329 out += sprintf(out, " usbfrnum = (%d)%03x\n", (usbfrnum >> 10) & 1,
330 0xfff & (4*(unsigned int)usbfrnum));
331 out += sprintf(out, " flbaseadd = %08x\n", flbaseadd);
332 out += sprintf(out, " sof = %02x\n", sof);
333 out += uhci_show_sc(1, portsc1, out, len - (out - buf));
334 out += uhci_show_sc(2, portsc2, out, len - (out - buf));
335 out += sprintf(out, "Most recent frame: %x (%d) "
336 "Last ISO frame: %x (%d)\n",
337 uhci->frame_number, uhci->frame_number & 1023,
338 uhci->last_iso_frame, uhci->last_iso_frame & 1023);
343 static int uhci_sprint_schedule(struct uhci_hcd *uhci, char *buf, int len)
349 struct list_head *tmp, *head;
352 out += uhci_show_root_hub_state(uhci, out, len - (out - buf));
353 out += sprintf(out, "HC status\n");
354 out += uhci_show_status(uhci, out, len - (out - buf));
358 out += sprintf(out, "Frame List\n");
361 for (i = 0; i < UHCI_NUMFRAMES; ++i) {
365 td = uhci->frame_cpu[i];
366 link = uhci->frame[i];
371 out += sprintf(out, "- Frame %d -> (%08x)\n",
372 i, le32_to_cpu(link));
379 td = list_entry(tmp, struct uhci_td, fl_list);
381 if (cpu_to_le32(td->dma_handle) != link) {
383 out += sprintf(out, " link does "
384 "not match list entry!\n");
389 out += uhci_show_td(td, out,
390 len - (out - buf), 4);
392 } while (tmp != head);
395 qh_dma = uhci_frame_skel_link(uhci, i);
396 if (link != qh_dma) {
400 "- Frame %d -> (%08x)\n",
401 i, le32_to_cpu(link));
404 out += sprintf(out, " link does not match "
405 "QH (%08x)!\n", le32_to_cpu(qh_dma));
412 out += sprintf(out, "Skipped %d bad links\n", nerrs);
414 out += sprintf(out, "Skeleton QHs\n");
416 for (i = 0; i < UHCI_NUM_SKELQH; ++i) {
419 qh = uhci->skelqh[i];
420 out += sprintf(out, "- %s\n", qh_names[i]); \
421 out += uhci_show_qh(qh, out, len - (out - buf), 4);
423 /* Last QH is the Terminating QH, it's different */
424 if (i == UHCI_NUM_SKELQH - 1) {
425 if (qh->link != UHCI_PTR_TERM)
426 out += sprintf(out, " bandwidth reclamation on!\n");
428 if (qh_element(qh) != cpu_to_le32(uhci->term_td->dma_handle))
429 out += sprintf(out, " skel_term_qh element is not set to term_td!\n");
434 j = (i < 9) ? 9 : i+1; /* Next skeleton */
438 while (tmp != head) {
439 qh = list_entry(tmp, struct uhci_qh, node);
442 out += uhci_show_qh(qh, out,
443 len - (out - buf), 4);
446 out += sprintf(out, " Skipped %d QHs\n", cnt);
448 if (i > 1 && i < UHCI_NUM_SKELQH - 1) {
450 (cpu_to_le32(uhci->skelqh[j]->dma_handle) | UHCI_PTR_QH))
451 out += sprintf(out, " last QH not linked to next skeleton!\n");
458 #ifdef CONFIG_DEBUG_FS
460 #define MAX_OUTPUT (64 * 1024)
467 static int uhci_debug_open(struct inode *inode, struct file *file)
469 struct uhci_hcd *uhci = inode->i_private;
470 struct uhci_debug *up;
475 up = kmalloc(sizeof(*up), GFP_KERNEL);
479 up->data = kmalloc(MAX_OUTPUT, GFP_KERNEL);
486 spin_lock_irqsave(&uhci->lock, flags);
487 if (uhci->is_initialized)
488 up->size = uhci_sprint_schedule(uhci, up->data, MAX_OUTPUT);
489 spin_unlock_irqrestore(&uhci->lock, flags);
491 file->private_data = up;
499 static loff_t uhci_debug_lseek(struct file *file, loff_t off, int whence)
501 struct uhci_debug *up;
505 up = file->private_data;
512 new = file->f_pos + off;
515 if (new < 0 || new > up->size) {
520 return (file->f_pos = new);
523 static ssize_t uhci_debug_read(struct file *file, char __user *buf,
524 size_t nbytes, loff_t *ppos)
526 struct uhci_debug *up = file->private_data;
527 return simple_read_from_buffer(buf, nbytes, ppos, up->data, up->size);
530 static int uhci_debug_release(struct inode *inode, struct file *file)
532 struct uhci_debug *up = file->private_data;
540 #undef uhci_debug_operations
541 static const struct file_operations uhci_debug_operations = {
542 .owner = THIS_MODULE,
543 .open = uhci_debug_open,
544 .llseek = uhci_debug_lseek,
545 .read = uhci_debug_read,
546 .release = uhci_debug_release,
549 #endif /* CONFIG_DEBUG_FS */
553 static inline void lprintk(char *buf)
556 static inline int uhci_show_qh(struct uhci_qh *qh, char *buf,
562 static inline int uhci_sprint_schedule(struct uhci_hcd *uhci,