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 static struct dentry *uhci_debugfs_root;
23 /* Handle REALLY large printks so we don't overflow buffers */
24 static void lprintk(char *buf)
28 /* Just write one line at a time */
30 p = strchr(buf, '\n');
33 printk(KERN_DEBUG "%s\n", buf);
40 static int uhci_show_td(struct uhci_td *td, char *buf, int len, int space)
46 /* Try to make sure there's enough memory */
50 status = td_status(td);
51 out += sprintf(out, "%*s[%p] link (%08x) ", space, "", td, le32_to_cpu(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 " : "",
67 switch (uhci_packetid(token)) {
82 out += sprintf(out, "MaxLen=%x DT%d EndPt=%x Dev=%x, PID=%x(%s) ",
89 out += sprintf(out, "(buf=%08x)\n", le32_to_cpu(td->buffer));
94 static int uhci_show_urbp(struct urb_priv *urbp, char *buf, int len, int space)
98 int i, nactive, ninactive;
104 out += sprintf(out, "urb_priv [%p] ", urbp);
105 out += sprintf(out, "urb [%p] ", urbp->urb);
106 out += sprintf(out, "qh [%p] ", urbp->qh);
107 out += sprintf(out, "Dev=%d ", usb_pipedevice(urbp->urb->pipe));
108 out += sprintf(out, "EP=%x(%s) ", usb_pipeendpoint(urbp->urb->pipe),
109 (usb_pipein(urbp->urb->pipe) ? "IN" : "OUT"));
111 switch (usb_pipetype(urbp->urb->pipe)) {
112 case PIPE_ISOCHRONOUS: ptype = "ISO"; break;
113 case PIPE_INTERRUPT: ptype = "INT"; break;
114 case PIPE_BULK: ptype = "BLK"; break;
116 case PIPE_CONTROL: ptype = "CTL"; break;
119 out += sprintf(out, "%s%s", ptype, (urbp->fsbr ? " FSBR" : ""));
120 out += sprintf(out, " Actlen=%d%s", urbp->urb->actual_length,
121 (urbp->qh->type == USB_ENDPOINT_XFER_CONTROL ?
124 if (urbp->urb->unlinked)
125 out += sprintf(out, " Unlinked=%d", urbp->urb->unlinked);
126 out += sprintf(out, "\n");
128 i = nactive = ninactive = 0;
129 list_for_each_entry(td, &urbp->td_list, list) {
130 if (urbp->qh->type != USB_ENDPOINT_XFER_ISOC &&
131 (++i <= 10 || debug > 2)) {
132 out += sprintf(out, "%*s%d: ", space + 2, "", i);
133 out += uhci_show_td(td, out, len - (out - buf), 0);
135 if (td_status(td) & TD_CTRL_ACTIVE)
141 if (nactive + ninactive > 0)
142 out += sprintf(out, "%*s[skipped %d inactive and %d active "
144 space, "", ninactive, nactive);
149 static int uhci_show_qh(struct uhci_hcd *uhci,
150 struct uhci_qh *qh, char *buf, int len, int space)
154 __le32 element = qh_element(qh);
157 /* Try to make sure there's enough memory */
162 case USB_ENDPOINT_XFER_ISOC: qtype = "ISO"; break;
163 case USB_ENDPOINT_XFER_INT: qtype = "INT"; break;
164 case USB_ENDPOINT_XFER_BULK: qtype = "BLK"; break;
165 case USB_ENDPOINT_XFER_CONTROL: qtype = "CTL"; break;
166 default: qtype = "Skel" ; break;
169 out += sprintf(out, "%*s[%p] %s QH link (%08x) element (%08x)\n",
170 space, "", qh, qtype,
171 le32_to_cpu(qh->link), le32_to_cpu(element));
172 if (qh->type == USB_ENDPOINT_XFER_ISOC)
173 out += sprintf(out, "%*s period %d phase %d load %d us, "
174 "frame %x desc [%p]\n",
175 space, "", qh->period, qh->phase, qh->load,
176 qh->iso_frame, qh->iso_packet_desc);
177 else if (qh->type == USB_ENDPOINT_XFER_INT)
178 out += sprintf(out, "%*s period %d phase %d load %d us\n",
179 space, "", qh->period, qh->phase, qh->load);
181 if (element & UHCI_PTR_QH)
182 out += sprintf(out, "%*s Element points to QH (bug?)\n", space, "");
184 if (element & UHCI_PTR_DEPTH)
185 out += sprintf(out, "%*s Depth traverse\n", space, "");
187 if (element & cpu_to_le32(8))
188 out += sprintf(out, "%*s Bit 3 set (bug?)\n", space, "");
190 if (!(element & ~(UHCI_PTR_QH | UHCI_PTR_DEPTH)))
191 out += sprintf(out, "%*s Element is NULL (bug?)\n", space, "");
193 if (list_empty(&qh->queue)) {
194 out += sprintf(out, "%*s queue is empty\n", space, "");
195 if (qh == uhci->skel_async_qh)
196 out += uhci_show_td(uhci->term_td, out,
197 len - (out - buf), 0);
199 struct urb_priv *urbp = list_entry(qh->queue.next,
200 struct urb_priv, node);
201 struct uhci_td *td = list_entry(urbp->td_list.next,
202 struct uhci_td, list);
204 if (element != LINK_TO_TD(td))
205 out += sprintf(out, "%*s Element != First TD\n",
208 list_for_each_entry(urbp, &qh->queue, node) {
210 out += uhci_show_urbp(urbp, out,
211 len - (out - buf), space + 2);
216 out += sprintf(out, "%*s Skipped %d URBs\n",
221 out += sprintf(out, "%*s Dummy TD\n", space, "");
222 out += uhci_show_td(qh->dummy_td, out, len - (out - buf), 0);
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 short usbcmd, usbstat, usbint, usbfrnum;
289 unsigned int flbaseadd;
291 unsigned short portsc1, portsc2;
293 /* Try to make sure there's enough memory */
297 usbcmd = uhci_readw(uhci, 0);
298 usbstat = uhci_readw(uhci, 2);
299 usbint = uhci_readw(uhci, 4);
300 usbfrnum = uhci_readw(uhci, 6);
301 flbaseadd = uhci_readl(uhci, 8);
302 sof = uhci_readb(uhci, 12);
303 portsc1 = uhci_readw(uhci, 16);
304 portsc2 = uhci_readw(uhci, 18);
306 out += sprintf(out, " usbcmd = %04x %s%s%s%s%s%s%s%s\n",
308 (usbcmd & USBCMD_MAXP) ? "Maxp64 " : "Maxp32 ",
309 (usbcmd & USBCMD_CF) ? "CF " : "",
310 (usbcmd & USBCMD_SWDBG) ? "SWDBG " : "",
311 (usbcmd & USBCMD_FGR) ? "FGR " : "",
312 (usbcmd & USBCMD_EGSM) ? "EGSM " : "",
313 (usbcmd & USBCMD_GRESET) ? "GRESET " : "",
314 (usbcmd & USBCMD_HCRESET) ? "HCRESET " : "",
315 (usbcmd & USBCMD_RS) ? "RS " : "");
317 out += sprintf(out, " usbstat = %04x %s%s%s%s%s%s\n",
319 (usbstat & USBSTS_HCH) ? "HCHalted " : "",
320 (usbstat & USBSTS_HCPE) ? "HostControllerProcessError " : "",
321 (usbstat & USBSTS_HSE) ? "HostSystemError " : "",
322 (usbstat & USBSTS_RD) ? "ResumeDetect " : "",
323 (usbstat & USBSTS_ERROR) ? "USBError " : "",
324 (usbstat & USBSTS_USBINT) ? "USBINT " : "");
326 out += sprintf(out, " usbint = %04x\n", usbint);
327 out += sprintf(out, " usbfrnum = (%d)%03x\n", (usbfrnum >> 10) & 1,
328 0xfff & (4*(unsigned int)usbfrnum));
329 out += sprintf(out, " flbaseadd = %08x\n", flbaseadd);
330 out += sprintf(out, " sof = %02x\n", sof);
331 out += uhci_show_sc(1, portsc1, out, len - (out - buf));
332 out += uhci_show_sc(2, portsc2, out, len - (out - buf));
333 out += sprintf(out, "Most recent frame: %x (%d) "
334 "Last ISO frame: %x (%d)\n",
335 uhci->frame_number, uhci->frame_number & 1023,
336 uhci->last_iso_frame, uhci->last_iso_frame & 1023);
341 static int uhci_sprint_schedule(struct uhci_hcd *uhci, char *buf, int len)
347 struct list_head *tmp, *head;
352 static const char * const qh_names[] = {
353 "unlink", "iso", "int128", "int64", "int32", "int16",
354 "int8", "int4", "int2", "async", "term"
357 out += uhci_show_root_hub_state(uhci, out, len - (out - buf));
358 out += sprintf(out, "HC status\n");
359 out += uhci_show_status(uhci, out, len - (out - buf));
361 out += sprintf(out, "Periodic load table\n");
362 for (i = 0; i < MAX_PHASE; ++i) {
363 out += sprintf(out, "\t%d", uhci->load[i]);
367 out += sprintf(out, "Total: %d, #INT: %d, #ISO: %d\n",
369 uhci_to_hcd(uhci)->self.bandwidth_int_reqs,
370 uhci_to_hcd(uhci)->self.bandwidth_isoc_reqs);
374 out += sprintf(out, "Frame List\n");
377 for (i = 0; i < UHCI_NUMFRAMES; ++i) {
381 td = uhci->frame_cpu[i];
382 link = uhci->frame[i];
387 out += sprintf(out, "- Frame %d -> (%08x)\n",
388 i, le32_to_cpu(link));
395 td = list_entry(tmp, struct uhci_td, fl_list);
397 if (link != LINK_TO_TD(td)) {
399 out += sprintf(out, " link does "
400 "not match list entry!\n");
405 out += uhci_show_td(td, out,
406 len - (out - buf), 4);
408 } while (tmp != head);
411 qh_dma = uhci_frame_skel_link(uhci, i);
412 if (link != qh_dma) {
416 "- Frame %d -> (%08x)\n",
417 i, le32_to_cpu(link));
420 out += sprintf(out, " link does not match "
421 "QH (%08x)!\n", le32_to_cpu(qh_dma));
428 out += sprintf(out, "Skipped %d bad links\n", nerrs);
430 out += sprintf(out, "Skeleton QHs\n");
433 for (i = 0; i < UHCI_NUM_SKELQH; ++i) {
436 qh = uhci->skelqh[i];
437 out += sprintf(out, "- skel_%s_qh\n", qh_names[i]); \
438 out += uhci_show_qh(uhci, qh, out, len - (out - buf), 4);
440 /* Last QH is the Terminating QH, it's different */
441 if (i == SKEL_TERM) {
442 if (qh_element(qh) != LINK_TO_TD(uhci->term_td))
443 out += sprintf(out, " skel_term_qh element is not set to term_td!\n");
446 link = LINK_TO_QH(uhci->skel_term_qh);
453 while (tmp != head) {
454 qh = list_entry(tmp, struct uhci_qh, node);
457 out += uhci_show_qh(uhci, qh, out,
458 len - (out - buf), 4);
459 if (!fsbr_link && qh->skel >= SKEL_FSBR)
460 fsbr_link = LINK_TO_QH(qh);
463 out += sprintf(out, " Skipped %d QHs\n", cnt);
465 link = UHCI_PTR_TERM;
468 else if (i < SKEL_ASYNC)
469 link = LINK_TO_QH(uhci->skel_async_qh);
470 else if (!uhci->fsbr_is_on)
473 link = LINK_TO_QH(uhci->skel_term_qh);
475 if (qh->link != link)
476 out += sprintf(out, " last QH not linked to next skeleton!\n");
482 #ifdef CONFIG_DEBUG_FS
484 #define MAX_OUTPUT (64 * 1024)
491 static int uhci_debug_open(struct inode *inode, struct file *file)
493 struct uhci_hcd *uhci = inode->i_private;
494 struct uhci_debug *up;
497 up = kmalloc(sizeof(*up), GFP_KERNEL);
501 up->data = kmalloc(MAX_OUTPUT, GFP_KERNEL);
508 spin_lock_irqsave(&uhci->lock, flags);
509 if (uhci->is_initialized)
510 up->size = uhci_sprint_schedule(uhci, up->data, MAX_OUTPUT);
511 spin_unlock_irqrestore(&uhci->lock, flags);
513 file->private_data = up;
518 static loff_t uhci_debug_lseek(struct file *file, loff_t off, int whence)
520 struct uhci_debug *up;
523 up = file->private_data;
525 /* XXX: atomic 64bit seek access, but that needs to be fixed in the VFS */
531 new = file->f_pos + off;
535 if (new < 0 || new > up->size)
538 return (file->f_pos = new);
541 static ssize_t uhci_debug_read(struct file *file, char __user *buf,
542 size_t nbytes, loff_t *ppos)
544 struct uhci_debug *up = file->private_data;
545 return simple_read_from_buffer(buf, nbytes, ppos, up->data, up->size);
548 static int uhci_debug_release(struct inode *inode, struct file *file)
550 struct uhci_debug *up = file->private_data;
558 static const struct file_operations uhci_debug_operations = {
559 .owner = THIS_MODULE,
560 .open = uhci_debug_open,
561 .llseek = uhci_debug_lseek,
562 .read = uhci_debug_read,
563 .release = uhci_debug_release,
565 #define UHCI_DEBUG_OPS
567 #endif /* CONFIG_DEBUG_FS */
571 static inline void lprintk(char *buf)
574 static inline int uhci_show_qh(struct uhci_hcd *uhci,
575 struct uhci_qh *qh, char *buf, int len, int space)
580 static inline int uhci_sprint_schedule(struct uhci_hcd *uhci,