UHCI: Add macros for computing DMA values
[linux-2.6/linux-2.6-openrd.git] / drivers / usb / host / uhci-debug.c
bloba0677133577b82acafe73cfe110f377e52b687a6
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/kernel.h>
13 #include <linux/debugfs.h>
14 #include <linux/smp_lock.h>
15 #include <asm/io.h>
17 #include "uhci-hcd.h"
19 #define uhci_debug_operations (* (const struct file_operations *) NULL)
20 static struct dentry *uhci_debugfs_root;
22 #ifdef DEBUG
24 /* Handle REALLY large printks so we don't overflow buffers */
25 static void lprintk(char *buf)
27 char *p;
29 /* Just write one line at a time */
30 while (buf) {
31 p = strchr(buf, '\n');
32 if (p)
33 *p = 0;
34 printk(KERN_DEBUG "%s\n", buf);
35 buf = p;
36 if (buf)
37 buf++;
41 static int uhci_show_td(struct uhci_td *td, char *buf, int len, int space)
43 char *out = buf;
44 char *spid;
45 u32 status, token;
47 /* Try to make sure there's enough memory */
48 if (len < 160)
49 return 0;
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 ",
54 ((status >> 27) & 3),
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 " : "",
65 status & 0x7ff);
67 token = td_token(td);
68 switch (uhci_packetid(token)) {
69 case USB_PID_SETUP:
70 spid = "SETUP";
71 break;
72 case USB_PID_OUT:
73 spid = "OUT";
74 break;
75 case USB_PID_IN:
76 spid = "IN";
77 break;
78 default:
79 spid = "?";
80 break;
83 out += sprintf(out, "MaxLen=%x DT%d EndPt=%x Dev=%x, PID=%x(%s) ",
84 token >> 21,
85 ((token >> 19) & 1),
86 (token >> 15) & 15,
87 (token >> 8) & 127,
88 (token & 0xff),
89 spid);
90 out += sprintf(out, "(buf=%08x)\n", le32_to_cpu(td->buffer));
92 return out - buf;
95 static int uhci_show_urbp(struct urb_priv *urbp, char *buf, int len, int space)
97 char *out = buf;
98 struct uhci_td *td;
99 int i, nactive, ninactive;
100 char *ptype;
102 if (len < 200)
103 return 0;
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;
116 default:
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);
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 * 7)
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));
170 if (qh->type == USB_ENDPOINT_XFER_ISOC)
171 out += sprintf(out, "%*s period %d phase %d load %d us, "
172 "frame %x desc [%p]\n",
173 space, "", qh->period, qh->phase, qh->load,
174 qh->iso_frame, qh->iso_packet_desc);
175 else if (qh->type == USB_ENDPOINT_XFER_INT)
176 out += sprintf(out, "%*s period %d phase %d load %d us\n",
177 space, "", qh->period, qh->phase, qh->load);
179 if (element & UHCI_PTR_QH)
180 out += sprintf(out, "%*s Element points to QH (bug?)\n", space, "");
182 if (element & UHCI_PTR_DEPTH)
183 out += sprintf(out, "%*s Depth traverse\n", space, "");
185 if (element & cpu_to_le32(8))
186 out += sprintf(out, "%*s Bit 3 set (bug?)\n", space, "");
188 if (!(element & ~(UHCI_PTR_QH | UHCI_PTR_DEPTH)))
189 out += sprintf(out, "%*s Element is NULL (bug?)\n", space, "");
191 if (list_empty(&qh->queue)) {
192 out += sprintf(out, "%*s queue is empty\n", space, "");
193 } else {
194 struct urb_priv *urbp = list_entry(qh->queue.next,
195 struct urb_priv, node);
196 struct uhci_td *td = list_entry(urbp->td_list.next,
197 struct uhci_td, list);
199 if (element != LINK_TO_TD(td))
200 out += sprintf(out, "%*s Element != First TD\n",
201 space, "");
202 i = nurbs = 0;
203 list_for_each_entry(urbp, &qh->queue, node) {
204 if (++i <= 10)
205 out += uhci_show_urbp(urbp, out,
206 len - (out - buf), space + 2);
207 else
208 ++nurbs;
210 if (nurbs > 0)
211 out += sprintf(out, "%*s Skipped %d URBs\n",
212 space, "", nurbs);
215 if (qh->dummy_td) {
216 out += sprintf(out, "%*s Dummy TD\n", space, "");
217 out += uhci_show_td(qh->dummy_td, out, len - (out - buf), 0);
220 return out - buf;
223 static const char * const qh_names[] = {
224 "skel_unlink_qh", "skel_iso_qh",
225 "skel_int128_qh", "skel_int64_qh",
226 "skel_int32_qh", "skel_int16_qh",
227 "skel_int8_qh", "skel_int4_qh",
228 "skel_int2_qh", "skel_int1_qh",
229 "skel_ls_control_qh", "skel_fs_control_qh",
230 "skel_bulk_qh", "skel_term_qh"
233 static int uhci_show_sc(int port, unsigned short status, char *buf, int len)
235 char *out = buf;
237 /* Try to make sure there's enough memory */
238 if (len < 160)
239 return 0;
241 out += sprintf(out, " stat%d = %04x %s%s%s%s%s%s%s%s%s%s\n",
242 port,
243 status,
244 (status & USBPORTSC_SUSP) ? " Suspend" : "",
245 (status & USBPORTSC_OCC) ? " OverCurrentChange" : "",
246 (status & USBPORTSC_OC) ? " OverCurrent" : "",
247 (status & USBPORTSC_PR) ? " Reset" : "",
248 (status & USBPORTSC_LSDA) ? " LowSpeed" : "",
249 (status & USBPORTSC_RD) ? " ResumeDetect" : "",
250 (status & USBPORTSC_PEC) ? " EnableChange" : "",
251 (status & USBPORTSC_PE) ? " Enabled" : "",
252 (status & USBPORTSC_CSC) ? " ConnectChange" : "",
253 (status & USBPORTSC_CCS) ? " Connected" : "");
255 return out - buf;
258 static int uhci_show_root_hub_state(struct uhci_hcd *uhci, char *buf, int len)
260 char *out = buf;
261 char *rh_state;
263 /* Try to make sure there's enough memory */
264 if (len < 60)
265 return 0;
267 switch (uhci->rh_state) {
268 case UHCI_RH_RESET:
269 rh_state = "reset"; break;
270 case UHCI_RH_SUSPENDED:
271 rh_state = "suspended"; break;
272 case UHCI_RH_AUTO_STOPPED:
273 rh_state = "auto-stopped"; break;
274 case UHCI_RH_RESUMING:
275 rh_state = "resuming"; break;
276 case UHCI_RH_SUSPENDING:
277 rh_state = "suspending"; break;
278 case UHCI_RH_RUNNING:
279 rh_state = "running"; break;
280 case UHCI_RH_RUNNING_NODEVS:
281 rh_state = "running, no devs"; break;
282 default:
283 rh_state = "?"; break;
285 out += sprintf(out, "Root-hub state: %s FSBR: %d\n",
286 rh_state, uhci->fsbr_is_on);
287 return out - buf;
290 static int uhci_show_status(struct uhci_hcd *uhci, char *buf, int len)
292 char *out = buf;
293 unsigned long io_addr = uhci->io_addr;
294 unsigned short usbcmd, usbstat, usbint, usbfrnum;
295 unsigned int flbaseadd;
296 unsigned char sof;
297 unsigned short portsc1, portsc2;
299 /* Try to make sure there's enough memory */
300 if (len < 80 * 9)
301 return 0;
303 usbcmd = inw(io_addr + 0);
304 usbstat = inw(io_addr + 2);
305 usbint = inw(io_addr + 4);
306 usbfrnum = inw(io_addr + 6);
307 flbaseadd = inl(io_addr + 8);
308 sof = inb(io_addr + 12);
309 portsc1 = inw(io_addr + 16);
310 portsc2 = inw(io_addr + 18);
312 out += sprintf(out, " usbcmd = %04x %s%s%s%s%s%s%s%s\n",
313 usbcmd,
314 (usbcmd & USBCMD_MAXP) ? "Maxp64 " : "Maxp32 ",
315 (usbcmd & USBCMD_CF) ? "CF " : "",
316 (usbcmd & USBCMD_SWDBG) ? "SWDBG " : "",
317 (usbcmd & USBCMD_FGR) ? "FGR " : "",
318 (usbcmd & USBCMD_EGSM) ? "EGSM " : "",
319 (usbcmd & USBCMD_GRESET) ? "GRESET " : "",
320 (usbcmd & USBCMD_HCRESET) ? "HCRESET " : "",
321 (usbcmd & USBCMD_RS) ? "RS " : "");
323 out += sprintf(out, " usbstat = %04x %s%s%s%s%s%s\n",
324 usbstat,
325 (usbstat & USBSTS_HCH) ? "HCHalted " : "",
326 (usbstat & USBSTS_HCPE) ? "HostControllerProcessError " : "",
327 (usbstat & USBSTS_HSE) ? "HostSystemError " : "",
328 (usbstat & USBSTS_RD) ? "ResumeDetect " : "",
329 (usbstat & USBSTS_ERROR) ? "USBError " : "",
330 (usbstat & USBSTS_USBINT) ? "USBINT " : "");
332 out += sprintf(out, " usbint = %04x\n", usbint);
333 out += sprintf(out, " usbfrnum = (%d)%03x\n", (usbfrnum >> 10) & 1,
334 0xfff & (4*(unsigned int)usbfrnum));
335 out += sprintf(out, " flbaseadd = %08x\n", flbaseadd);
336 out += sprintf(out, " sof = %02x\n", sof);
337 out += uhci_show_sc(1, portsc1, out, len - (out - buf));
338 out += uhci_show_sc(2, portsc2, out, len - (out - buf));
339 out += sprintf(out, "Most recent frame: %x (%d) "
340 "Last ISO frame: %x (%d)\n",
341 uhci->frame_number, uhci->frame_number & 1023,
342 uhci->last_iso_frame, uhci->last_iso_frame & 1023);
344 return out - buf;
347 static int uhci_sprint_schedule(struct uhci_hcd *uhci, char *buf, int len)
349 char *out = buf;
350 int i, j;
351 struct uhci_qh *qh;
352 struct uhci_td *td;
353 struct list_head *tmp, *head;
354 int nframes, nerrs;
356 out += uhci_show_root_hub_state(uhci, out, len - (out - buf));
357 out += sprintf(out, "HC status\n");
358 out += uhci_show_status(uhci, out, len - (out - buf));
360 out += sprintf(out, "Periodic load table\n");
361 for (i = 0; i < MAX_PHASE; ++i) {
362 out += sprintf(out, "\t%d", uhci->load[i]);
363 if (i % 8 == 7)
364 *out++ = '\n';
366 out += sprintf(out, "Total: %d, #INT: %d, #ISO: %d\n",
367 uhci->total_load,
368 uhci_to_hcd(uhci)->self.bandwidth_int_reqs,
369 uhci_to_hcd(uhci)->self.bandwidth_isoc_reqs);
370 if (debug <= 1)
371 return out - buf;
373 out += sprintf(out, "Frame List\n");
374 nframes = 10;
375 nerrs = 0;
376 for (i = 0; i < UHCI_NUMFRAMES; ++i) {
377 __le32 link, qh_dma;
379 j = 0;
380 td = uhci->frame_cpu[i];
381 link = uhci->frame[i];
382 if (!td)
383 goto check_link;
385 if (nframes > 0) {
386 out += sprintf(out, "- Frame %d -> (%08x)\n",
387 i, le32_to_cpu(link));
388 j = 1;
391 head = &td->fl_list;
392 tmp = head;
393 do {
394 td = list_entry(tmp, struct uhci_td, fl_list);
395 tmp = tmp->next;
396 if (link != LINK_TO_TD(td)) {
397 if (nframes > 0)
398 out += sprintf(out, " link does "
399 "not match list entry!\n");
400 else
401 ++nerrs;
403 if (nframes > 0)
404 out += uhci_show_td(td, out,
405 len - (out - buf), 4);
406 link = td->link;
407 } while (tmp != head);
409 check_link:
410 qh_dma = uhci_frame_skel_link(uhci, i);
411 if (link != qh_dma) {
412 if (nframes > 0) {
413 if (!j) {
414 out += sprintf(out,
415 "- Frame %d -> (%08x)\n",
416 i, le32_to_cpu(link));
417 j = 1;
419 out += sprintf(out, " link does not match "
420 "QH (%08x)!\n", le32_to_cpu(qh_dma));
421 } else
422 ++nerrs;
424 nframes -= j;
426 if (nerrs > 0)
427 out += sprintf(out, "Skipped %d bad links\n", nerrs);
429 out += sprintf(out, "Skeleton QHs\n");
431 for (i = 0; i < UHCI_NUM_SKELQH; ++i) {
432 int cnt = 0;
434 qh = uhci->skelqh[i];
435 out += sprintf(out, "- %s\n", qh_names[i]); \
436 out += uhci_show_qh(qh, out, len - (out - buf), 4);
438 /* Last QH is the Terminating QH, it's different */
439 if (i == UHCI_NUM_SKELQH - 1) {
440 if (qh->link != UHCI_PTR_TERM)
441 out += sprintf(out, " bandwidth reclamation on!\n");
443 if (qh_element(qh) != LINK_TO_TD(uhci->term_td))
444 out += sprintf(out, " skel_term_qh element is not set to term_td!\n");
446 continue;
449 j = (i < 9) ? 9 : i+1; /* Next skeleton */
450 head = &qh->node;
451 tmp = head->next;
453 while (tmp != head) {
454 qh = list_entry(tmp, struct uhci_qh, node);
455 tmp = tmp->next;
456 if (++cnt <= 10)
457 out += uhci_show_qh(qh, out,
458 len - (out - buf), 4);
460 if ((cnt -= 10) > 0)
461 out += sprintf(out, " Skipped %d QHs\n", cnt);
463 if (i > 1 && i < UHCI_NUM_SKELQH - 1) {
464 if (qh->link != LINK_TO_QH(uhci->skelqh[j]))
465 out += sprintf(out, " last QH not linked to next skeleton!\n");
469 return out - buf;
472 #ifdef CONFIG_DEBUG_FS
474 #define MAX_OUTPUT (64 * 1024)
476 struct uhci_debug {
477 int size;
478 char *data;
481 static int uhci_debug_open(struct inode *inode, struct file *file)
483 struct uhci_hcd *uhci = inode->i_private;
484 struct uhci_debug *up;
485 int ret = -ENOMEM;
486 unsigned long flags;
488 lock_kernel();
489 up = kmalloc(sizeof(*up), GFP_KERNEL);
490 if (!up)
491 goto out;
493 up->data = kmalloc(MAX_OUTPUT, GFP_KERNEL);
494 if (!up->data) {
495 kfree(up);
496 goto out;
499 up->size = 0;
500 spin_lock_irqsave(&uhci->lock, flags);
501 if (uhci->is_initialized)
502 up->size = uhci_sprint_schedule(uhci, up->data, MAX_OUTPUT);
503 spin_unlock_irqrestore(&uhci->lock, flags);
505 file->private_data = up;
507 ret = 0;
508 out:
509 unlock_kernel();
510 return ret;
513 static loff_t uhci_debug_lseek(struct file *file, loff_t off, int whence)
515 struct uhci_debug *up;
516 loff_t new = -1;
518 lock_kernel();
519 up = file->private_data;
521 switch (whence) {
522 case 0:
523 new = off;
524 break;
525 case 1:
526 new = file->f_pos + off;
527 break;
529 if (new < 0 || new > up->size) {
530 unlock_kernel();
531 return -EINVAL;
533 unlock_kernel();
534 return (file->f_pos = new);
537 static ssize_t uhci_debug_read(struct file *file, char __user *buf,
538 size_t nbytes, loff_t *ppos)
540 struct uhci_debug *up = file->private_data;
541 return simple_read_from_buffer(buf, nbytes, ppos, up->data, up->size);
544 static int uhci_debug_release(struct inode *inode, struct file *file)
546 struct uhci_debug *up = file->private_data;
548 kfree(up->data);
549 kfree(up);
551 return 0;
554 #undef uhci_debug_operations
555 static const struct file_operations uhci_debug_operations = {
556 .owner = THIS_MODULE,
557 .open = uhci_debug_open,
558 .llseek = uhci_debug_lseek,
559 .read = uhci_debug_read,
560 .release = uhci_debug_release,
563 #endif /* CONFIG_DEBUG_FS */
565 #else /* DEBUG */
567 static inline void lprintk(char *buf)
570 static inline int uhci_show_qh(struct uhci_qh *qh, char *buf,
571 int len, int space)
573 return 0;
576 static inline int uhci_sprint_schedule(struct uhci_hcd *uhci,
577 char *buf, int len)
579 return 0;
582 #endif