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" : ""));
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 (++i <= 10 || debug > 2) {
130 out += sprintf(out, "%*s%d: ", space + 2, "", i);
131 out += uhci_show_td(td, out, len - (out - buf), 0);
133 if (td_status(td) & TD_CTRL_ACTIVE)
139 if (nactive + ninactive > 0)
140 out += sprintf(out, "%*s[skipped %d inactive and %d active "
142 space, "", ninactive, nactive);
147 static int uhci_show_qh(struct uhci_qh *qh, char *buf, int len, int space)
151 __le32 element = qh_element(qh);
154 /* Try to make sure there's enough memory */
159 case USB_ENDPOINT_XFER_ISOC: qtype = "ISO"; break;
160 case USB_ENDPOINT_XFER_INT: qtype = "INT"; break;
161 case USB_ENDPOINT_XFER_BULK: qtype = "BLK"; break;
162 case USB_ENDPOINT_XFER_CONTROL: qtype = "CTL"; break;
163 default: qtype = "Skel" ; break;
166 out += sprintf(out, "%*s[%p] %s QH link (%08x) element (%08x)\n",
167 space, "", qh, qtype,
168 le32_to_cpu(qh->link), le32_to_cpu(element));
170 if (element & UHCI_PTR_QH)
171 out += sprintf(out, "%*s Element points to QH (bug?)\n", space, "");
173 if (element & UHCI_PTR_DEPTH)
174 out += sprintf(out, "%*s Depth traverse\n", space, "");
176 if (element & cpu_to_le32(8))
177 out += sprintf(out, "%*s Bit 3 set (bug?)\n", space, "");
179 if (!(element & ~(UHCI_PTR_QH | UHCI_PTR_DEPTH)))
180 out += sprintf(out, "%*s Element is NULL (bug?)\n", space, "");
182 if (list_empty(&qh->queue)) {
183 out += sprintf(out, "%*s queue is empty\n", space, "");
185 struct urb_priv *urbp = list_entry(qh->queue.next,
186 struct urb_priv, node);
187 struct uhci_td *td = list_entry(urbp->td_list.next,
188 struct uhci_td, list);
190 if (cpu_to_le32(td->dma_handle) != (element & ~UHCI_PTR_BITS))
191 out += sprintf(out, "%*s Element != First TD\n",
194 list_for_each_entry(urbp, &qh->queue, node) {
196 out += uhci_show_urbp(urbp, out,
197 len - (out - buf), space + 2);
202 out += sprintf(out, "%*s Skipped %d URBs\n",
207 out += sprintf(out, "%*s Dummy TD\n", space, "");
208 out += uhci_show_td(qh->dummy_td, out, len - (out - buf), 0);
214 static const char * const qh_names[] = {
215 "skel_unlink_qh", "skel_iso_qh",
216 "skel_int128_qh", "skel_int64_qh",
217 "skel_int32_qh", "skel_int16_qh",
218 "skel_int8_qh", "skel_int4_qh",
219 "skel_int2_qh", "skel_int1_qh",
220 "skel_ls_control_qh", "skel_fs_control_qh",
221 "skel_bulk_qh", "skel_term_qh"
224 static int uhci_show_sc(int port, unsigned short status, char *buf, int len)
228 /* Try to make sure there's enough memory */
232 out += sprintf(out, " stat%d = %04x %s%s%s%s%s%s%s%s%s%s\n",
235 (status & USBPORTSC_SUSP) ? " Suspend" : "",
236 (status & USBPORTSC_OCC) ? " OverCurrentChange" : "",
237 (status & USBPORTSC_OC) ? " OverCurrent" : "",
238 (status & USBPORTSC_PR) ? " Reset" : "",
239 (status & USBPORTSC_LSDA) ? " LowSpeed" : "",
240 (status & USBPORTSC_RD) ? " ResumeDetect" : "",
241 (status & USBPORTSC_PEC) ? " EnableChange" : "",
242 (status & USBPORTSC_PE) ? " Enabled" : "",
243 (status & USBPORTSC_CSC) ? " ConnectChange" : "",
244 (status & USBPORTSC_CCS) ? " Connected" : "");
249 static int uhci_show_root_hub_state(struct uhci_hcd *uhci, char *buf, int len)
254 /* Try to make sure there's enough memory */
258 switch (uhci->rh_state) {
260 rh_state = "reset"; break;
261 case UHCI_RH_SUSPENDED:
262 rh_state = "suspended"; break;
263 case UHCI_RH_AUTO_STOPPED:
264 rh_state = "auto-stopped"; break;
265 case UHCI_RH_RESUMING:
266 rh_state = "resuming"; break;
267 case UHCI_RH_SUSPENDING:
268 rh_state = "suspending"; break;
269 case UHCI_RH_RUNNING:
270 rh_state = "running"; break;
271 case UHCI_RH_RUNNING_NODEVS:
272 rh_state = "running, no devs"; break;
274 rh_state = "?"; break;
276 out += sprintf(out, "Root-hub state: %s\n", rh_state);
280 static int uhci_show_status(struct uhci_hcd *uhci, char *buf, int len)
283 unsigned long io_addr = uhci->io_addr;
284 unsigned short usbcmd, usbstat, usbint, usbfrnum;
285 unsigned int flbaseadd;
287 unsigned short portsc1, portsc2;
289 /* Try to make sure there's enough memory */
293 usbcmd = inw(io_addr + 0);
294 usbstat = inw(io_addr + 2);
295 usbint = inw(io_addr + 4);
296 usbfrnum = inw(io_addr + 6);
297 flbaseadd = inl(io_addr + 8);
298 sof = inb(io_addr + 12);
299 portsc1 = inw(io_addr + 16);
300 portsc2 = inw(io_addr + 18);
302 out += sprintf(out, " usbcmd = %04x %s%s%s%s%s%s%s%s\n",
304 (usbcmd & USBCMD_MAXP) ? "Maxp64 " : "Maxp32 ",
305 (usbcmd & USBCMD_CF) ? "CF " : "",
306 (usbcmd & USBCMD_SWDBG) ? "SWDBG " : "",
307 (usbcmd & USBCMD_FGR) ? "FGR " : "",
308 (usbcmd & USBCMD_EGSM) ? "EGSM " : "",
309 (usbcmd & USBCMD_GRESET) ? "GRESET " : "",
310 (usbcmd & USBCMD_HCRESET) ? "HCRESET " : "",
311 (usbcmd & USBCMD_RS) ? "RS " : "");
313 out += sprintf(out, " usbstat = %04x %s%s%s%s%s%s\n",
315 (usbstat & USBSTS_HCH) ? "HCHalted " : "",
316 (usbstat & USBSTS_HCPE) ? "HostControllerProcessError " : "",
317 (usbstat & USBSTS_HSE) ? "HostSystemError " : "",
318 (usbstat & USBSTS_RD) ? "ResumeDetect " : "",
319 (usbstat & USBSTS_ERROR) ? "USBError " : "",
320 (usbstat & USBSTS_USBINT) ? "USBINT " : "");
322 out += sprintf(out, " usbint = %04x\n", usbint);
323 out += sprintf(out, " usbfrnum = (%d)%03x\n", (usbfrnum >> 10) & 1,
324 0xfff & (4*(unsigned int)usbfrnum));
325 out += sprintf(out, " flbaseadd = %08x\n", flbaseadd);
326 out += sprintf(out, " sof = %02x\n", sof);
327 out += uhci_show_sc(1, portsc1, out, len - (out - buf));
328 out += uhci_show_sc(2, portsc2, out, len - (out - buf));
333 static int uhci_sprint_schedule(struct uhci_hcd *uhci, char *buf, int len)
339 struct list_head *tmp, *head;
341 out += uhci_show_root_hub_state(uhci, out, len - (out - buf));
342 out += sprintf(out, "HC status\n");
343 out += uhci_show_status(uhci, out, len - (out - buf));
347 out += sprintf(out, "Frame List\n");
348 for (i = 0; i < UHCI_NUMFRAMES; ++i) {
349 td = uhci->frame_cpu[i];
353 out += sprintf(out, "- Frame %d\n", i); \
354 if (td->dma_handle != (dma_addr_t)uhci->frame[i])
355 out += sprintf(out, " frame list does not match td->dma_handle!\n");
360 td = list_entry(tmp, struct uhci_td, fl_list);
362 out += uhci_show_td(td, out, len - (out - buf), 4);
363 } while (tmp != head);
366 out += sprintf(out, "Skeleton QHs\n");
368 for (i = 0; i < UHCI_NUM_SKELQH; ++i) {
371 qh = uhci->skelqh[i];
372 out += sprintf(out, "- %s\n", qh_names[i]); \
373 out += uhci_show_qh(qh, out, len - (out - buf), 4);
375 /* Last QH is the Terminating QH, it's different */
376 if (i == UHCI_NUM_SKELQH - 1) {
377 if (qh->link != UHCI_PTR_TERM)
378 out += sprintf(out, " bandwidth reclamation on!\n");
380 if (qh_element(qh) != cpu_to_le32(uhci->term_td->dma_handle))
381 out += sprintf(out, " skel_term_qh element is not set to term_td!\n");
386 j = (i < 9) ? 9 : i+1; /* Next skeleton */
390 while (tmp != head) {
391 qh = list_entry(tmp, struct uhci_qh, node);
394 out += uhci_show_qh(qh, out,
395 len - (out - buf), 4);
398 out += sprintf(out, " Skipped %d QHs\n", cnt);
400 if (i > 1 && i < UHCI_NUM_SKELQH - 1) {
402 (cpu_to_le32(uhci->skelqh[j]->dma_handle) | UHCI_PTR_QH))
403 out += sprintf(out, " last QH not linked to next skeleton!\n");
410 #ifdef CONFIG_DEBUG_FS
412 #define MAX_OUTPUT (64 * 1024)
419 static int uhci_debug_open(struct inode *inode, struct file *file)
421 struct uhci_hcd *uhci = inode->u.generic_ip;
422 struct uhci_debug *up;
427 up = kmalloc(sizeof(*up), GFP_KERNEL);
431 up->data = kmalloc(MAX_OUTPUT, GFP_KERNEL);
438 spin_lock_irqsave(&uhci->lock, flags);
439 if (uhci->is_initialized)
440 up->size = uhci_sprint_schedule(uhci, up->data, MAX_OUTPUT);
441 spin_unlock_irqrestore(&uhci->lock, flags);
443 file->private_data = up;
451 static loff_t uhci_debug_lseek(struct file *file, loff_t off, int whence)
453 struct uhci_debug *up;
457 up = file->private_data;
464 new = file->f_pos + off;
467 if (new < 0 || new > up->size) {
472 return (file->f_pos = new);
475 static ssize_t uhci_debug_read(struct file *file, char __user *buf,
476 size_t nbytes, loff_t *ppos)
478 struct uhci_debug *up = file->private_data;
479 return simple_read_from_buffer(buf, nbytes, ppos, up->data, up->size);
482 static int uhci_debug_release(struct inode *inode, struct file *file)
484 struct uhci_debug *up = file->private_data;
492 #undef uhci_debug_operations
493 static struct file_operations uhci_debug_operations = {
494 .owner = THIS_MODULE,
495 .open = uhci_debug_open,
496 .llseek = uhci_debug_lseek,
497 .read = uhci_debug_read,
498 .release = uhci_debug_release,
501 #endif /* CONFIG_DEBUG_FS */
505 static inline void lprintk(char *buf)
508 static inline int uhci_show_qh(struct uhci_qh *qh, char *buf,
514 static inline int uhci_sprint_schedule(struct uhci_hcd *uhci,