[PATCH] UHCI: use integer-sized frame numbers
[linux-2.6/zen-sources.git] / drivers / usb / host / uhci-debug.c
blobecef5880cfd9936199719c0f72db7132d07826bc
1 /*
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>
16 #include <asm/io.h>
18 #include "uhci-hcd.h"
20 #define uhci_debug_operations (* (struct file_operations *) NULL)
21 static struct dentry *uhci_debugfs_root;
23 #ifdef DEBUG
25 /* Handle REALLY large printks so we don't overflow buffers */
26 static void lprintk(char *buf)
28 char *p;
30 /* Just write one line at a time */
31 while (buf) {
32 p = strchr(buf, '\n');
33 if (p)
34 *p = 0;
35 printk(KERN_DEBUG "%s\n", buf);
36 buf = p;
37 if (buf)
38 buf++;
42 static int uhci_show_td(struct uhci_td *td, char *buf, int len, int space)
44 char *out = buf;
45 char *spid;
46 u32 status, token;
48 /* Try to make sure there's enough memory */
49 if (len < 160)
50 return 0;
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 ",
55 ((status >> 27) & 3),
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 " : "",
66 status & 0x7ff);
68 token = td_token(td);
69 switch (uhci_packetid(token)) {
70 case USB_PID_SETUP:
71 spid = "SETUP";
72 break;
73 case USB_PID_OUT:
74 spid = "OUT";
75 break;
76 case USB_PID_IN:
77 spid = "IN";
78 break;
79 default:
80 spid = "?";
81 break;
84 out += sprintf(out, "MaxLen=%x DT%d EndPt=%x Dev=%x, PID=%x(%s) ",
85 token >> 21,
86 ((token >> 19) & 1),
87 (token >> 15) & 15,
88 (token >> 8) & 127,
89 (token & 0xff),
90 spid);
91 out += sprintf(out, "(buf=%08x)\n", le32_to_cpu(td->buffer));
93 return out - buf;
96 static int uhci_show_urbp(struct urb_priv *urbp, char *buf, int len, int space)
98 char *out = buf;
99 struct uhci_td *td;
100 int i, nactive, ninactive;
101 char *ptype;
103 if (len < 200)
104 return 0;
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;
117 default:
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);
133 } else {
134 if (td_status(td) & TD_CTRL_ACTIVE)
135 ++nactive;
136 else
137 ++ninactive;
140 if (nactive + ninactive > 0)
141 out += sprintf(out, "%*s[skipped %d inactive and %d active "
142 "TDs]\n",
143 space, "", ninactive, nactive);
145 return out - buf;
148 static int uhci_show_qh(struct uhci_qh *qh, char *buf, int len, int space)
150 char *out = buf;
151 int i, nurbs;
152 __le32 element = qh_element(qh);
153 char *qtype;
155 /* Try to make sure there's enough memory */
156 if (len < 80 * 6)
157 return 0;
159 switch (qh->type) {
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));
171 if (element & UHCI_PTR_QH)
172 out += sprintf(out, "%*s Element points to QH (bug?)\n", space, "");
174 if (element & UHCI_PTR_DEPTH)
175 out += sprintf(out, "%*s Depth traverse\n", space, "");
177 if (element & cpu_to_le32(8))
178 out += sprintf(out, "%*s Bit 3 set (bug?)\n", space, "");
180 if (!(element & ~(UHCI_PTR_QH | UHCI_PTR_DEPTH)))
181 out += sprintf(out, "%*s Element is NULL (bug?)\n", space, "");
183 if (list_empty(&qh->queue)) {
184 out += sprintf(out, "%*s queue is empty\n", space, "");
185 } else {
186 struct urb_priv *urbp = list_entry(qh->queue.next,
187 struct urb_priv, node);
188 struct uhci_td *td = list_entry(urbp->td_list.next,
189 struct uhci_td, list);
191 if (cpu_to_le32(td->dma_handle) != (element & ~UHCI_PTR_BITS))
192 out += sprintf(out, "%*s Element != First TD\n",
193 space, "");
194 i = nurbs = 0;
195 list_for_each_entry(urbp, &qh->queue, node) {
196 if (++i <= 10)
197 out += uhci_show_urbp(urbp, out,
198 len - (out - buf), space + 2);
199 else
200 ++nurbs;
202 if (nurbs > 0)
203 out += sprintf(out, "%*s Skipped %d URBs\n",
204 space, "", nurbs);
207 if (qh->udev) {
208 out += sprintf(out, "%*s Dummy TD\n", space, "");
209 out += uhci_show_td(qh->dummy_td, out, len - (out - buf), 0);
212 return out - buf;
215 static const char * const qh_names[] = {
216 "skel_unlink_qh", "skel_iso_qh",
217 "skel_int128_qh", "skel_int64_qh",
218 "skel_int32_qh", "skel_int16_qh",
219 "skel_int8_qh", "skel_int4_qh",
220 "skel_int2_qh", "skel_int1_qh",
221 "skel_ls_control_qh", "skel_fs_control_qh",
222 "skel_bulk_qh", "skel_term_qh"
225 static int uhci_show_sc(int port, unsigned short status, char *buf, int len)
227 char *out = buf;
229 /* Try to make sure there's enough memory */
230 if (len < 160)
231 return 0;
233 out += sprintf(out, " stat%d = %04x %s%s%s%s%s%s%s%s%s%s\n",
234 port,
235 status,
236 (status & USBPORTSC_SUSP) ? " Suspend" : "",
237 (status & USBPORTSC_OCC) ? " OverCurrentChange" : "",
238 (status & USBPORTSC_OC) ? " OverCurrent" : "",
239 (status & USBPORTSC_PR) ? " Reset" : "",
240 (status & USBPORTSC_LSDA) ? " LowSpeed" : "",
241 (status & USBPORTSC_RD) ? " ResumeDetect" : "",
242 (status & USBPORTSC_PEC) ? " EnableChange" : "",
243 (status & USBPORTSC_PE) ? " Enabled" : "",
244 (status & USBPORTSC_CSC) ? " ConnectChange" : "",
245 (status & USBPORTSC_CCS) ? " Connected" : "");
247 return out - buf;
250 static int uhci_show_root_hub_state(struct uhci_hcd *uhci, char *buf, int len)
252 char *out = buf;
253 char *rh_state;
255 /* Try to make sure there's enough memory */
256 if (len < 60)
257 return 0;
259 switch (uhci->rh_state) {
260 case UHCI_RH_RESET:
261 rh_state = "reset"; break;
262 case UHCI_RH_SUSPENDED:
263 rh_state = "suspended"; break;
264 case UHCI_RH_AUTO_STOPPED:
265 rh_state = "auto-stopped"; break;
266 case UHCI_RH_RESUMING:
267 rh_state = "resuming"; break;
268 case UHCI_RH_SUSPENDING:
269 rh_state = "suspending"; break;
270 case UHCI_RH_RUNNING:
271 rh_state = "running"; break;
272 case UHCI_RH_RUNNING_NODEVS:
273 rh_state = "running, no devs"; break;
274 default:
275 rh_state = "?"; break;
277 out += sprintf(out, "Root-hub state: %s FSBR: %d\n",
278 rh_state, uhci->fsbr_is_on);
279 return out - buf;
282 static int uhci_show_status(struct uhci_hcd *uhci, char *buf, int len)
284 char *out = buf;
285 unsigned long io_addr = uhci->io_addr;
286 unsigned short usbcmd, usbstat, usbint, usbfrnum;
287 unsigned int flbaseadd;
288 unsigned char sof;
289 unsigned short portsc1, portsc2;
291 /* Try to make sure there's enough memory */
292 if (len < 80 * 9)
293 return 0;
295 usbcmd = inw(io_addr + 0);
296 usbstat = inw(io_addr + 2);
297 usbint = inw(io_addr + 4);
298 usbfrnum = inw(io_addr + 6);
299 flbaseadd = inl(io_addr + 8);
300 sof = inb(io_addr + 12);
301 portsc1 = inw(io_addr + 16);
302 portsc2 = inw(io_addr + 18);
304 out += sprintf(out, " usbcmd = %04x %s%s%s%s%s%s%s%s\n",
305 usbcmd,
306 (usbcmd & USBCMD_MAXP) ? "Maxp64 " : "Maxp32 ",
307 (usbcmd & USBCMD_CF) ? "CF " : "",
308 (usbcmd & USBCMD_SWDBG) ? "SWDBG " : "",
309 (usbcmd & USBCMD_FGR) ? "FGR " : "",
310 (usbcmd & USBCMD_EGSM) ? "EGSM " : "",
311 (usbcmd & USBCMD_GRESET) ? "GRESET " : "",
312 (usbcmd & USBCMD_HCRESET) ? "HCRESET " : "",
313 (usbcmd & USBCMD_RS) ? "RS " : "");
315 out += sprintf(out, " usbstat = %04x %s%s%s%s%s%s\n",
316 usbstat,
317 (usbstat & USBSTS_HCH) ? "HCHalted " : "",
318 (usbstat & USBSTS_HCPE) ? "HostControllerProcessError " : "",
319 (usbstat & USBSTS_HSE) ? "HostSystemError " : "",
320 (usbstat & USBSTS_RD) ? "ResumeDetect " : "",
321 (usbstat & USBSTS_ERROR) ? "USBError " : "",
322 (usbstat & USBSTS_USBINT) ? "USBINT " : "");
324 out += sprintf(out, " usbint = %04x\n", usbint);
325 out += sprintf(out, " usbfrnum = (%d)%03x\n", (usbfrnum >> 10) & 1,
326 0xfff & (4*(unsigned int)usbfrnum));
327 out += sprintf(out, " flbaseadd = %08x\n", flbaseadd);
328 out += sprintf(out, " sof = %02x\n", sof);
329 out += uhci_show_sc(1, portsc1, out, len - (out - buf));
330 out += uhci_show_sc(2, portsc2, out, len - (out - buf));
331 out += sprintf(out, "Most recent frame: %x\n",
332 uhci->frame_number);
334 return out - buf;
337 static int uhci_sprint_schedule(struct uhci_hcd *uhci, char *buf, int len)
339 char *out = buf;
340 int i, j;
341 struct uhci_qh *qh;
342 struct uhci_td *td;
343 struct list_head *tmp, *head;
345 out += uhci_show_root_hub_state(uhci, out, len - (out - buf));
346 out += sprintf(out, "HC status\n");
347 out += uhci_show_status(uhci, out, len - (out - buf));
348 if (debug <= 1)
349 return out - buf;
351 out += sprintf(out, "Frame List\n");
352 for (i = 0; i < UHCI_NUMFRAMES; ++i) {
353 td = uhci->frame_cpu[i];
354 if (!td)
355 continue;
357 out += sprintf(out, "- Frame %d\n", i); \
358 if (td->dma_handle != (dma_addr_t)uhci->frame[i])
359 out += sprintf(out, " frame list does not match td->dma_handle!\n");
361 head = &td->fl_list;
362 tmp = head;
363 do {
364 td = list_entry(tmp, struct uhci_td, fl_list);
365 tmp = tmp->next;
366 out += uhci_show_td(td, out, len - (out - buf), 4);
367 } while (tmp != head);
370 out += sprintf(out, "Skeleton QHs\n");
372 for (i = 0; i < UHCI_NUM_SKELQH; ++i) {
373 int cnt = 0;
375 qh = uhci->skelqh[i];
376 out += sprintf(out, "- %s\n", qh_names[i]); \
377 out += uhci_show_qh(qh, out, len - (out - buf), 4);
379 /* Last QH is the Terminating QH, it's different */
380 if (i == UHCI_NUM_SKELQH - 1) {
381 if (qh->link != UHCI_PTR_TERM)
382 out += sprintf(out, " bandwidth reclamation on!\n");
384 if (qh_element(qh) != cpu_to_le32(uhci->term_td->dma_handle))
385 out += sprintf(out, " skel_term_qh element is not set to term_td!\n");
387 continue;
390 j = (i < 9) ? 9 : i+1; /* Next skeleton */
391 head = &qh->node;
392 tmp = head->next;
394 while (tmp != head) {
395 qh = list_entry(tmp, struct uhci_qh, node);
396 tmp = tmp->next;
397 if (++cnt <= 10)
398 out += uhci_show_qh(qh, out,
399 len - (out - buf), 4);
401 if ((cnt -= 10) > 0)
402 out += sprintf(out, " Skipped %d QHs\n", cnt);
404 if (i > 1 && i < UHCI_NUM_SKELQH - 1) {
405 if (qh->link !=
406 (cpu_to_le32(uhci->skelqh[j]->dma_handle) | UHCI_PTR_QH))
407 out += sprintf(out, " last QH not linked to next skeleton!\n");
411 return out - buf;
414 #ifdef CONFIG_DEBUG_FS
416 #define MAX_OUTPUT (64 * 1024)
418 struct uhci_debug {
419 int size;
420 char *data;
423 static int uhci_debug_open(struct inode *inode, struct file *file)
425 struct uhci_hcd *uhci = inode->u.generic_ip;
426 struct uhci_debug *up;
427 int ret = -ENOMEM;
428 unsigned long flags;
430 lock_kernel();
431 up = kmalloc(sizeof(*up), GFP_KERNEL);
432 if (!up)
433 goto out;
435 up->data = kmalloc(MAX_OUTPUT, GFP_KERNEL);
436 if (!up->data) {
437 kfree(up);
438 goto out;
441 up->size = 0;
442 spin_lock_irqsave(&uhci->lock, flags);
443 if (uhci->is_initialized)
444 up->size = uhci_sprint_schedule(uhci, up->data, MAX_OUTPUT);
445 spin_unlock_irqrestore(&uhci->lock, flags);
447 file->private_data = up;
449 ret = 0;
450 out:
451 unlock_kernel();
452 return ret;
455 static loff_t uhci_debug_lseek(struct file *file, loff_t off, int whence)
457 struct uhci_debug *up;
458 loff_t new = -1;
460 lock_kernel();
461 up = file->private_data;
463 switch (whence) {
464 case 0:
465 new = off;
466 break;
467 case 1:
468 new = file->f_pos + off;
469 break;
471 if (new < 0 || new > up->size) {
472 unlock_kernel();
473 return -EINVAL;
475 unlock_kernel();
476 return (file->f_pos = new);
479 static ssize_t uhci_debug_read(struct file *file, char __user *buf,
480 size_t nbytes, loff_t *ppos)
482 struct uhci_debug *up = file->private_data;
483 return simple_read_from_buffer(buf, nbytes, ppos, up->data, up->size);
486 static int uhci_debug_release(struct inode *inode, struct file *file)
488 struct uhci_debug *up = file->private_data;
490 kfree(up->data);
491 kfree(up);
493 return 0;
496 #undef uhci_debug_operations
497 static struct file_operations uhci_debug_operations = {
498 .owner = THIS_MODULE,
499 .open = uhci_debug_open,
500 .llseek = uhci_debug_lseek,
501 .read = uhci_debug_read,
502 .release = uhci_debug_release,
505 #endif /* CONFIG_DEBUG_FS */
507 #else /* DEBUG */
509 static inline void lprintk(char *buf)
512 static inline int uhci_show_qh(struct uhci_qh *qh, char *buf,
513 int len, int space)
515 return 0;
518 static inline int uhci_sprint_schedule(struct uhci_hcd *uhci,
519 char *buf, int len)
521 return 0;
524 #endif