[PATCH] USB UHCI: Minor improvements
[deliverable/linux.git] / drivers / usb / host / uhci-debug.c
CommitLineData
1da177e4
LT
1/*
2 * UHCI-specific debugging code. Invaluable when something
3 * goes wrong, but don't get in my face.
4 *
5 * Kernel visible pointers are surrounded in []'s and bus
6 * visible pointers are surrounded in ()'s
7 *
8 * (C) Copyright 1999 Linus Torvalds
9 * (C) Copyright 1999-2001 Johannes Erdfelt
10 */
11
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>
17
18#include "uhci-hcd.h"
19
20static struct dentry *uhci_debugfs_root = NULL;
21
22/* Handle REALLY large printk's so we don't overflow buffers */
23static inline void lprintk(char *buf)
24{
25 char *p;
26
27 /* Just write one line at a time */
28 while (buf) {
29 p = strchr(buf, '\n');
30 if (p)
31 *p = 0;
32 printk(KERN_DEBUG "%s\n", buf);
33 buf = p;
34 if (buf)
35 buf++;
36 }
37}
38
39static int uhci_show_td(struct uhci_td *td, char *buf, int len, int space)
40{
41 char *out = buf;
42 char *spid;
43 u32 status, token;
44
45 /* Try to make sure there's enough memory */
46 if (len < 160)
47 return 0;
48
49 status = td_status(td);
50 out += sprintf(out, "%*s[%p] link (%08x) ", space, "", td, le32_to_cpu(td->link));
51 out += sprintf(out, "e%d %s%s%s%s%s%s%s%s%s%sLength=%x ",
52 ((status >> 27) & 3),
53 (status & TD_CTRL_SPD) ? "SPD " : "",
54 (status & TD_CTRL_LS) ? "LS " : "",
55 (status & TD_CTRL_IOC) ? "IOC " : "",
56 (status & TD_CTRL_ACTIVE) ? "Active " : "",
57 (status & TD_CTRL_STALLED) ? "Stalled " : "",
58 (status & TD_CTRL_DBUFERR) ? "DataBufErr " : "",
59 (status & TD_CTRL_BABBLE) ? "Babble " : "",
60 (status & TD_CTRL_NAK) ? "NAK " : "",
61 (status & TD_CTRL_CRCTIMEO) ? "CRC/Timeo " : "",
62 (status & TD_CTRL_BITSTUFF) ? "BitStuff " : "",
63 status & 0x7ff);
64
65 token = td_token(td);
66 switch (uhci_packetid(token)) {
67 case USB_PID_SETUP:
68 spid = "SETUP";
69 break;
70 case USB_PID_OUT:
71 spid = "OUT";
72 break;
73 case USB_PID_IN:
74 spid = "IN";
75 break;
76 default:
77 spid = "?";
78 break;
79 }
80
81 out += sprintf(out, "MaxLen=%x DT%d EndPt=%x Dev=%x, PID=%x(%s) ",
82 token >> 21,
83 ((token >> 19) & 1),
84 (token >> 15) & 15,
85 (token >> 8) & 127,
86 (token & 0xff),
87 spid);
88 out += sprintf(out, "(buf=%08x)\n", le32_to_cpu(td->buffer));
89
90 return out - buf;
91}
92
93static int uhci_show_qh(struct uhci_qh *qh, char *buf, int len, int space)
94{
95 char *out = buf;
96 struct urb_priv *urbp;
97 struct list_head *head, *tmp;
98 struct uhci_td *td;
99 int i = 0, checked = 0, prevactive = 0;
100 __le32 element = qh_element(qh);
101
102 /* Try to make sure there's enough memory */
103 if (len < 80 * 6)
104 return 0;
105
106 out += sprintf(out, "%*s[%p] link (%08x) element (%08x)\n", space, "",
107 qh, le32_to_cpu(qh->link), le32_to_cpu(element));
108
109 if (element & UHCI_PTR_QH)
110 out += sprintf(out, "%*s Element points to QH (bug?)\n", space, "");
111
112 if (element & UHCI_PTR_DEPTH)
113 out += sprintf(out, "%*s Depth traverse\n", space, "");
114
115 if (element & cpu_to_le32(8))
116 out += sprintf(out, "%*s Bit 3 set (bug?)\n", space, "");
117
118 if (!(element & ~(UHCI_PTR_QH | UHCI_PTR_DEPTH)))
119 out += sprintf(out, "%*s Element is NULL (bug?)\n", space, "");
120
121 if (!qh->urbp) {
122 out += sprintf(out, "%*s urbp == NULL\n", space, "");
123 goto out;
124 }
125
126 urbp = qh->urbp;
127
128 head = &urbp->td_list;
129 tmp = head->next;
130
131 td = list_entry(tmp, struct uhci_td, list);
132
133 if (cpu_to_le32(td->dma_handle) != (element & ~UHCI_PTR_BITS))
134 out += sprintf(out, "%*s Element != First TD\n", space, "");
135
136 while (tmp != head) {
137 struct uhci_td *td = list_entry(tmp, struct uhci_td, list);
138
139 tmp = tmp->next;
140
141 out += sprintf(out, "%*s%d: ", space + 2, "", i++);
142 out += uhci_show_td(td, out, len - (out - buf), 0);
143
144 if (i > 10 && !checked && prevactive && tmp != head &&
145 debug <= 2) {
146 struct list_head *ntmp = tmp;
147 struct uhci_td *ntd = td;
148 int active = 1, ni = i;
149
150 checked = 1;
151
152 while (ntmp != head && ntmp->next != head && active) {
153 ntd = list_entry(ntmp, struct uhci_td, list);
154
155 ntmp = ntmp->next;
156
157 active = td_status(ntd) & TD_CTRL_ACTIVE;
158
159 ni++;
160 }
161
162 if (active && ni > i) {
163 out += sprintf(out, "%*s[skipped %d active TD's]\n", space, "", ni - i);
164 tmp = ntmp;
165 td = ntd;
166 i = ni;
167 }
168 }
169
170 prevactive = td_status(td) & TD_CTRL_ACTIVE;
171 }
172
173 if (list_empty(&urbp->queue_list) || urbp->queued)
174 goto out;
175
176 out += sprintf(out, "%*sQueued QH's:\n", -space, "--");
177
178 head = &urbp->queue_list;
179 tmp = head->next;
180
181 while (tmp != head) {
182 struct urb_priv *nurbp = list_entry(tmp, struct urb_priv,
183 queue_list);
184 tmp = tmp->next;
185
186 out += uhci_show_qh(nurbp->qh, out, len - (out - buf), space);
187 }
188
189out:
190 return out - buf;
191}
192
193#define show_frame_num() \
194 if (!shown) { \
195 shown = 1; \
196 out += sprintf(out, "- Frame %d\n", i); \
197 }
198
199#ifdef CONFIG_PROC_FS
200static const char *qh_names[] = {
201 "skel_int128_qh", "skel_int64_qh",
202 "skel_int32_qh", "skel_int16_qh",
203 "skel_int8_qh", "skel_int4_qh",
204 "skel_int2_qh", "skel_int1_qh",
205 "skel_ls_control_qh", "skel_fs_control_qh",
206 "skel_bulk_qh", "skel_term_qh"
207};
208
209#define show_qh_name() \
210 if (!shown) { \
211 shown = 1; \
212 out += sprintf(out, "- %s\n", qh_names[i]); \
213 }
214
215static int uhci_show_sc(int port, unsigned short status, char *buf, int len)
216{
217 char *out = buf;
218
219 /* Try to make sure there's enough memory */
220 if (len < 160)
221 return 0;
222
223 out += sprintf(out, " stat%d = %04x %s%s%s%s%s%s%s%s%s%s\n",
224 port,
225 status,
226 (status & USBPORTSC_SUSP) ? " Suspend" : "",
227 (status & USBPORTSC_OCC) ? " OverCurrentChange" : "",
228 (status & USBPORTSC_OC) ? " OverCurrent" : "",
229 (status & USBPORTSC_PR) ? " Reset" : "",
230 (status & USBPORTSC_LSDA) ? " LowSpeed" : "",
231 (status & USBPORTSC_RD) ? " ResumeDetect" : "",
232 (status & USBPORTSC_PEC) ? " EnableChange" : "",
233 (status & USBPORTSC_PE) ? " Enabled" : "",
234 (status & USBPORTSC_CSC) ? " ConnectChange" : "",
235 (status & USBPORTSC_CCS) ? " Connected" : "");
236
237 return out - buf;
238}
239
240static int uhci_show_status(struct uhci_hcd *uhci, char *buf, int len)
241{
242 char *out = buf;
243 unsigned long io_addr = uhci->io_addr;
244 unsigned short usbcmd, usbstat, usbint, usbfrnum;
245 unsigned int flbaseadd;
246 unsigned char sof;
247 unsigned short portsc1, portsc2;
248
249 /* Try to make sure there's enough memory */
250 if (len < 80 * 6)
251 return 0;
252
253 usbcmd = inw(io_addr + 0);
254 usbstat = inw(io_addr + 2);
255 usbint = inw(io_addr + 4);
256 usbfrnum = inw(io_addr + 6);
257 flbaseadd = inl(io_addr + 8);
258 sof = inb(io_addr + 12);
259 portsc1 = inw(io_addr + 16);
260 portsc2 = inw(io_addr + 18);
261
262 out += sprintf(out, " usbcmd = %04x %s%s%s%s%s%s%s%s\n",
263 usbcmd,
264 (usbcmd & USBCMD_MAXP) ? "Maxp64 " : "Maxp32 ",
265 (usbcmd & USBCMD_CF) ? "CF " : "",
266 (usbcmd & USBCMD_SWDBG) ? "SWDBG " : "",
267 (usbcmd & USBCMD_FGR) ? "FGR " : "",
268 (usbcmd & USBCMD_EGSM) ? "EGSM " : "",
269 (usbcmd & USBCMD_GRESET) ? "GRESET " : "",
270 (usbcmd & USBCMD_HCRESET) ? "HCRESET " : "",
271 (usbcmd & USBCMD_RS) ? "RS " : "");
272
273 out += sprintf(out, " usbstat = %04x %s%s%s%s%s%s\n",
274 usbstat,
275 (usbstat & USBSTS_HCH) ? "HCHalted " : "",
276 (usbstat & USBSTS_HCPE) ? "HostControllerProcessError " : "",
277 (usbstat & USBSTS_HSE) ? "HostSystemError " : "",
278 (usbstat & USBSTS_RD) ? "ResumeDetect " : "",
279 (usbstat & USBSTS_ERROR) ? "USBError " : "",
280 (usbstat & USBSTS_USBINT) ? "USBINT " : "");
281
282 out += sprintf(out, " usbint = %04x\n", usbint);
283 out += sprintf(out, " usbfrnum = (%d)%03x\n", (usbfrnum >> 10) & 1,
284 0xfff & (4*(unsigned int)usbfrnum));
285 out += sprintf(out, " flbaseadd = %08x\n", flbaseadd);
286 out += sprintf(out, " sof = %02x\n", sof);
287 out += uhci_show_sc(1, portsc1, out, len - (out - buf));
288 out += uhci_show_sc(2, portsc2, out, len - (out - buf));
289
290 return out - buf;
291}
292
293static int uhci_show_urbp(struct uhci_hcd *uhci, struct urb_priv *urbp, char *buf, int len)
294{
295 struct list_head *tmp;
296 char *out = buf;
297 int count = 0;
298
299 if (len < 200)
300 return 0;
301
302 out += sprintf(out, "urb_priv [%p] ", urbp);
303 out += sprintf(out, "urb [%p] ", urbp->urb);
304 out += sprintf(out, "qh [%p] ", urbp->qh);
305 out += sprintf(out, "Dev=%d ", usb_pipedevice(urbp->urb->pipe));
306 out += sprintf(out, "EP=%x(%s) ", usb_pipeendpoint(urbp->urb->pipe), (usb_pipein(urbp->urb->pipe) ? "IN" : "OUT"));
307
308 switch (usb_pipetype(urbp->urb->pipe)) {
309 case PIPE_ISOCHRONOUS: out += sprintf(out, "ISO "); break;
310 case PIPE_INTERRUPT: out += sprintf(out, "INT "); break;
311 case PIPE_BULK: out += sprintf(out, "BLK "); break;
312 case PIPE_CONTROL: out += sprintf(out, "CTL "); break;
313 }
314
315 out += sprintf(out, "%s", (urbp->fsbr ? "FSBR " : ""));
316 out += sprintf(out, "%s", (urbp->fsbr_timeout ? "FSBR_TO " : ""));
317
318 if (urbp->urb->status != -EINPROGRESS)
319 out += sprintf(out, "Status=%d ", urbp->urb->status);
320 //out += sprintf(out, "Inserttime=%lx ",urbp->inserttime);
321 //out += sprintf(out, "FSBRtime=%lx ",urbp->fsbrtime);
322
323 count = 0;
324 list_for_each(tmp, &urbp->td_list)
325 count++;
326 out += sprintf(out, "TDs=%d ",count);
327
328 if (urbp->queued)
329 out += sprintf(out, "queued\n");
330 else {
331 count = 0;
332 list_for_each(tmp, &urbp->queue_list)
333 count++;
334 out += sprintf(out, "queued URBs=%d\n", count);
335 }
336
337 return out - buf;
338}
339
340static int uhci_show_lists(struct uhci_hcd *uhci, char *buf, int len)
341{
342 char *out = buf;
343 struct list_head *head, *tmp;
344 int count;
345
346 out += sprintf(out, "Main list URBs:");
347 if (list_empty(&uhci->urb_list))
348 out += sprintf(out, " Empty\n");
349 else {
350 out += sprintf(out, "\n");
351 count = 0;
352 head = &uhci->urb_list;
353 tmp = head->next;
354 while (tmp != head) {
355 struct urb_priv *urbp = list_entry(tmp, struct urb_priv, urb_list);
356
357 out += sprintf(out, " %d: ", ++count);
358 out += uhci_show_urbp(uhci, urbp, out, len - (out - buf));
359 tmp = tmp->next;
360 }
361 }
362
363 out += sprintf(out, "Remove list URBs:");
364 if (list_empty(&uhci->urb_remove_list))
365 out += sprintf(out, " Empty\n");
366 else {
367 out += sprintf(out, "\n");
368 count = 0;
369 head = &uhci->urb_remove_list;
370 tmp = head->next;
371 while (tmp != head) {
372 struct urb_priv *urbp = list_entry(tmp, struct urb_priv, urb_list);
373
374 out += sprintf(out, " %d: ", ++count);
375 out += uhci_show_urbp(uhci, urbp, out, len - (out - buf));
376 tmp = tmp->next;
377 }
378 }
379
380 out += sprintf(out, "Complete list URBs:");
381 if (list_empty(&uhci->complete_list))
382 out += sprintf(out, " Empty\n");
383 else {
384 out += sprintf(out, "\n");
385 count = 0;
386 head = &uhci->complete_list;
387 tmp = head->next;
388 while (tmp != head) {
389 struct urb_priv *urbp = list_entry(tmp, struct urb_priv, urb_list);
390
391 out += sprintf(out, " %d: ", ++count);
392 out += uhci_show_urbp(uhci, urbp, out, len - (out - buf));
393 tmp = tmp->next;
394 }
395 }
396
397 return out - buf;
398}
399
400static int uhci_sprint_schedule(struct uhci_hcd *uhci, char *buf, int len)
401{
402 unsigned long flags;
403 char *out = buf;
404 int i, j;
405 struct uhci_qh *qh;
406 struct uhci_td *td;
407 struct list_head *tmp, *head;
408
409 spin_lock_irqsave(&uhci->lock, flags);
410
411 out += sprintf(out, "HC status\n");
412 out += uhci_show_status(uhci, out, len - (out - buf));
413
414 out += sprintf(out, "Frame List\n");
415 for (i = 0; i < UHCI_NUMFRAMES; ++i) {
416 int shown = 0;
417 td = uhci->fl->frame_cpu[i];
418 if (!td)
419 continue;
420
421 if (td->dma_handle != (dma_addr_t)uhci->fl->frame[i]) {
422 show_frame_num();
423 out += sprintf(out, " frame list does not match td->dma_handle!\n");
424 }
425 show_frame_num();
426
427 head = &td->fl_list;
428 tmp = head;
429 do {
430 td = list_entry(tmp, struct uhci_td, fl_list);
431 tmp = tmp->next;
432 out += uhci_show_td(td, out, len - (out - buf), 4);
433 } while (tmp != head);
434 }
435
436 out += sprintf(out, "Skeleton QH's\n");
437
438 for (i = 0; i < UHCI_NUM_SKELQH; ++i) {
439 int shown = 0;
440
441 qh = uhci->skelqh[i];
442
443 if (debug > 1) {
444 show_qh_name();
445 out += uhci_show_qh(qh, out, len - (out - buf), 4);
446 }
447
448 /* Last QH is the Terminating QH, it's different */
449 if (i == UHCI_NUM_SKELQH - 1) {
450 if (qh->link != UHCI_PTR_TERM)
451 out += sprintf(out, " bandwidth reclamation on!\n");
452
453 if (qh_element(qh) != cpu_to_le32(uhci->term_td->dma_handle))
454 out += sprintf(out, " skel_term_qh element is not set to term_td!\n");
455
456 continue;
457 }
458
459 j = (i < 7) ? 7 : i+1; /* Next skeleton */
460 if (list_empty(&qh->list)) {
461 if (i < UHCI_NUM_SKELQH - 1) {
462 if (qh->link !=
463 (cpu_to_le32(uhci->skelqh[j]->dma_handle) | UHCI_PTR_QH)) {
464 show_qh_name();
465 out += sprintf(out, " skeleton QH not linked to next skeleton QH!\n");
466 }
467 }
468
469 continue;
470 }
471
472 show_qh_name();
473
474 head = &qh->list;
475 tmp = head->next;
476
477 while (tmp != head) {
478 qh = list_entry(tmp, struct uhci_qh, list);
479
480 tmp = tmp->next;
481
482 out += uhci_show_qh(qh, out, len - (out - buf), 4);
483 }
484
485 if (i < UHCI_NUM_SKELQH - 1) {
486 if (qh->link !=
487 (cpu_to_le32(uhci->skelqh[j]->dma_handle) | UHCI_PTR_QH))
488 out += sprintf(out, " last QH not linked to next skeleton!\n");
489 }
490 }
491
492 if (debug > 2)
493 out += uhci_show_lists(uhci, out, len - (out - buf));
494
495 spin_unlock_irqrestore(&uhci->lock, flags);
496
497 return out - buf;
498}
499
500#define MAX_OUTPUT (64 * 1024)
501
502struct uhci_debug {
503 int size;
504 char *data;
505 struct uhci_hcd *uhci;
506};
507
508static int uhci_debug_open(struct inode *inode, struct file *file)
509{
510 struct uhci_hcd *uhci = inode->u.generic_ip;
511 struct uhci_debug *up;
512 int ret = -ENOMEM;
513
514 lock_kernel();
515 up = kmalloc(sizeof(*up), GFP_KERNEL);
516 if (!up)
517 goto out;
518
519 up->data = kmalloc(MAX_OUTPUT, GFP_KERNEL);
520 if (!up->data) {
521 kfree(up);
522 goto out;
523 }
524
525 up->size = uhci_sprint_schedule(uhci, up->data, MAX_OUTPUT);
526
527 file->private_data = up;
528
529 ret = 0;
530out:
531 unlock_kernel();
532 return ret;
533}
534
535static loff_t uhci_debug_lseek(struct file *file, loff_t off, int whence)
536{
537 struct uhci_debug *up;
538 loff_t new = -1;
539
540 lock_kernel();
541 up = file->private_data;
542
543 switch (whence) {
544 case 0:
545 new = off;
546 break;
547 case 1:
548 new = file->f_pos + off;
549 break;
550 }
551 if (new < 0 || new > up->size) {
552 unlock_kernel();
553 return -EINVAL;
554 }
555 unlock_kernel();
556 return (file->f_pos = new);
557}
558
559static ssize_t uhci_debug_read(struct file *file, char __user *buf,
560 size_t nbytes, loff_t *ppos)
561{
562 struct uhci_debug *up = file->private_data;
563 return simple_read_from_buffer(buf, nbytes, ppos, up->data, up->size);
564}
565
566static int uhci_debug_release(struct inode *inode, struct file *file)
567{
568 struct uhci_debug *up = file->private_data;
569
570 kfree(up->data);
571 kfree(up);
572
573 return 0;
574}
575
576static struct file_operations uhci_debug_operations = {
577 .open = uhci_debug_open,
578 .llseek = uhci_debug_lseek,
579 .read = uhci_debug_read,
580 .release = uhci_debug_release,
581};
582
583#else /* CONFIG_DEBUG_FS */
584
585#define uhci_debug_operations (* (struct file_operations *) NULL)
586
587#endif
This page took 0.054411 seconds and 5 git commands to generate.