Merge branch 'for-jeff' of git://electric-eye.fr.zoreil.com/home/romieu/linux-2.6
[linux-2.6] / drivers / usb / host / uhci-debug.c
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
20 static struct dentry *uhci_debugfs_root = NULL;
21
22 /* Handle REALLY large printks so we don't overflow buffers */
23 static 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
39 static 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
93 static 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 TDs]\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 QHs:\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
189 out:
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
200 static const char * const 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
215 static 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
240 static int uhci_show_root_hub_state(struct uhci_hcd *uhci, char *buf, int len)
241 {
242         char *out = buf;
243         char *rh_state;
244
245         /* Try to make sure there's enough memory */
246         if (len < 60)
247                 return 0;
248
249         switch (uhci->rh_state) {
250             case UHCI_RH_RESET:
251                 rh_state = "reset";             break;
252             case UHCI_RH_SUSPENDED:
253                 rh_state = "suspended";         break;
254             case UHCI_RH_AUTO_STOPPED:
255                 rh_state = "auto-stopped";      break;
256             case UHCI_RH_RESUMING:
257                 rh_state = "resuming";          break;
258             case UHCI_RH_SUSPENDING:
259                 rh_state = "suspending";        break;
260             case UHCI_RH_RUNNING:
261                 rh_state = "running";           break;
262             case UHCI_RH_RUNNING_NODEVS:
263                 rh_state = "running, no devs";  break;
264             default:
265                 rh_state = "?";                 break;
266         }
267         out += sprintf(out, "Root-hub state: %s\n", rh_state);
268         return out - buf;
269 }
270
271 static int uhci_show_status(struct uhci_hcd *uhci, char *buf, int len)
272 {
273         char *out = buf;
274         unsigned long io_addr = uhci->io_addr;
275         unsigned short usbcmd, usbstat, usbint, usbfrnum;
276         unsigned int flbaseadd;
277         unsigned char sof;
278         unsigned short portsc1, portsc2;
279
280         /* Try to make sure there's enough memory */
281         if (len < 80 * 6)
282                 return 0;
283
284         usbcmd    = inw(io_addr + 0);
285         usbstat   = inw(io_addr + 2);
286         usbint    = inw(io_addr + 4);
287         usbfrnum  = inw(io_addr + 6);
288         flbaseadd = inl(io_addr + 8);
289         sof       = inb(io_addr + 12);
290         portsc1   = inw(io_addr + 16);
291         portsc2   = inw(io_addr + 18);
292
293         out += sprintf(out, "  usbcmd    =     %04x   %s%s%s%s%s%s%s%s\n",
294                 usbcmd,
295                 (usbcmd & USBCMD_MAXP) ?    "Maxp64 " : "Maxp32 ",
296                 (usbcmd & USBCMD_CF) ?      "CF " : "",
297                 (usbcmd & USBCMD_SWDBG) ?   "SWDBG " : "",
298                 (usbcmd & USBCMD_FGR) ?     "FGR " : "",
299                 (usbcmd & USBCMD_EGSM) ?    "EGSM " : "",
300                 (usbcmd & USBCMD_GRESET) ?  "GRESET " : "",
301                 (usbcmd & USBCMD_HCRESET) ? "HCRESET " : "",
302                 (usbcmd & USBCMD_RS) ?      "RS " : "");
303
304         out += sprintf(out, "  usbstat   =     %04x   %s%s%s%s%s%s\n",
305                 usbstat,
306                 (usbstat & USBSTS_HCH) ?    "HCHalted " : "",
307                 (usbstat & USBSTS_HCPE) ?   "HostControllerProcessError " : "",
308                 (usbstat & USBSTS_HSE) ?    "HostSystemError " : "",
309                 (usbstat & USBSTS_RD) ?     "ResumeDetect " : "",
310                 (usbstat & USBSTS_ERROR) ?  "USBError " : "",
311                 (usbstat & USBSTS_USBINT) ? "USBINT " : "");
312
313         out += sprintf(out, "  usbint    =     %04x\n", usbint);
314         out += sprintf(out, "  usbfrnum  =   (%d)%03x\n", (usbfrnum >> 10) & 1,
315                 0xfff & (4*(unsigned int)usbfrnum));
316         out += sprintf(out, "  flbaseadd = %08x\n", flbaseadd);
317         out += sprintf(out, "  sof       =       %02x\n", sof);
318         out += uhci_show_sc(1, portsc1, out, len - (out - buf));
319         out += uhci_show_sc(2, portsc2, out, len - (out - buf));
320
321         return out - buf;
322 }
323
324 static int uhci_show_urbp(struct uhci_hcd *uhci, struct urb_priv *urbp, char *buf, int len)
325 {
326         struct list_head *tmp;
327         char *out = buf;
328         int count = 0;
329
330         if (len < 200)
331                 return 0;
332
333         out += sprintf(out, "urb_priv [%p] ", urbp);
334         out += sprintf(out, "urb [%p] ", urbp->urb);
335         out += sprintf(out, "qh [%p] ", urbp->qh);
336         out += sprintf(out, "Dev=%d ", usb_pipedevice(urbp->urb->pipe));
337         out += sprintf(out, "EP=%x(%s) ", usb_pipeendpoint(urbp->urb->pipe), (usb_pipein(urbp->urb->pipe) ? "IN" : "OUT"));
338
339         switch (usb_pipetype(urbp->urb->pipe)) {
340         case PIPE_ISOCHRONOUS: out += sprintf(out, "ISO "); break;
341         case PIPE_INTERRUPT: out += sprintf(out, "INT "); break;
342         case PIPE_BULK: out += sprintf(out, "BLK "); break;
343         case PIPE_CONTROL: out += sprintf(out, "CTL "); break;
344         }
345
346         out += sprintf(out, "%s", (urbp->fsbr ? "FSBR " : ""));
347         out += sprintf(out, "%s", (urbp->fsbr_timeout ? "FSBR_TO " : ""));
348
349         if (urbp->urb->status != -EINPROGRESS)
350                 out += sprintf(out, "Status=%d ", urbp->urb->status);
351         //out += sprintf(out, "FSBRtime=%lx ",urbp->fsbrtime);
352
353         count = 0;
354         list_for_each(tmp, &urbp->td_list)
355                 count++;
356         out += sprintf(out, "TDs=%d ",count);
357
358         if (urbp->queued)
359                 out += sprintf(out, "queued\n");
360         else {
361                 count = 0;
362                 list_for_each(tmp, &urbp->queue_list)
363                         count++;
364                 out += sprintf(out, "queued URBs=%d\n", count);
365         }
366
367         return out - buf;
368 }
369
370 static int uhci_show_lists(struct uhci_hcd *uhci, char *buf, int len)
371 {
372         char *out = buf;
373         struct list_head *head, *tmp;
374         int count;
375
376         out += sprintf(out, "Main list URBs:");
377         if (list_empty(&uhci->urb_list))
378                 out += sprintf(out, " Empty\n");
379         else {
380                 out += sprintf(out, "\n");
381                 count = 0;
382                 head = &uhci->urb_list;
383                 tmp = head->next;
384                 while (tmp != head) {
385                         struct urb_priv *urbp = list_entry(tmp, struct urb_priv, urb_list);
386
387                         out += sprintf(out, "  %d: ", ++count);
388                         out += uhci_show_urbp(uhci, urbp, out, len - (out - buf));
389                         tmp = tmp->next;
390                 }
391         }
392
393         out += sprintf(out, "Remove list URBs:");
394         if (list_empty(&uhci->urb_remove_list))
395                 out += sprintf(out, " Empty\n");
396         else {
397                 out += sprintf(out, "\n");
398                 count = 0;
399                 head = &uhci->urb_remove_list;
400                 tmp = head->next;
401                 while (tmp != head) {
402                         struct urb_priv *urbp = list_entry(tmp, struct urb_priv, urb_list);
403
404                         out += sprintf(out, "  %d: ", ++count);
405                         out += uhci_show_urbp(uhci, urbp, out, len - (out - buf));
406                         tmp = tmp->next;
407                 }
408         }
409
410         out += sprintf(out, "Complete list URBs:");
411         if (list_empty(&uhci->complete_list))
412                 out += sprintf(out, " Empty\n");
413         else {
414                 out += sprintf(out, "\n");
415                 count = 0;
416                 head = &uhci->complete_list;
417                 tmp = head->next;
418                 while (tmp != head) {
419                         struct urb_priv *urbp = list_entry(tmp, struct urb_priv, urb_list);
420
421                         out += sprintf(out, "  %d: ", ++count);
422                         out += uhci_show_urbp(uhci, urbp, out, len - (out - buf));
423                         tmp = tmp->next;
424                 }
425         }
426
427         return out - buf;
428 }
429
430 static int uhci_sprint_schedule(struct uhci_hcd *uhci, char *buf, int len)
431 {
432         unsigned long flags;
433         char *out = buf;
434         int i, j;
435         struct uhci_qh *qh;
436         struct uhci_td *td;
437         struct list_head *tmp, *head;
438
439         spin_lock_irqsave(&uhci->lock, flags);
440
441         out += uhci_show_root_hub_state(uhci, out, len - (out - buf));
442         out += sprintf(out, "HC status\n");
443         out += uhci_show_status(uhci, out, len - (out - buf));
444
445         out += sprintf(out, "Frame List\n");
446         for (i = 0; i < UHCI_NUMFRAMES; ++i) {
447                 int shown = 0;
448                 td = uhci->frame_cpu[i];
449                 if (!td)
450                         continue;
451
452                 if (td->dma_handle != (dma_addr_t)uhci->frame[i]) {
453                         show_frame_num();
454                         out += sprintf(out, "    frame list does not match td->dma_handle!\n");
455                 }
456                 show_frame_num();
457
458                 head = &td->fl_list;
459                 tmp = head;
460                 do {
461                         td = list_entry(tmp, struct uhci_td, fl_list);
462                         tmp = tmp->next;
463                         out += uhci_show_td(td, out, len - (out - buf), 4);
464                 } while (tmp != head);
465         }
466
467         out += sprintf(out, "Skeleton QHs\n");
468
469         for (i = 0; i < UHCI_NUM_SKELQH; ++i) {
470                 int shown = 0;
471
472                 qh = uhci->skelqh[i];
473
474                 if (debug > 1) {
475                         show_qh_name();
476                         out += uhci_show_qh(qh, out, len - (out - buf), 4);
477                 }
478
479                 /* Last QH is the Terminating QH, it's different */
480                 if (i == UHCI_NUM_SKELQH - 1) {
481                         if (qh->link != UHCI_PTR_TERM)
482                                 out += sprintf(out, "    bandwidth reclamation on!\n");
483
484                         if (qh_element(qh) != cpu_to_le32(uhci->term_td->dma_handle))
485                                 out += sprintf(out, "    skel_term_qh element is not set to term_td!\n");
486
487                         continue;
488                 }
489
490                 j = (i < 7) ? 7 : i+1;          /* Next skeleton */
491                 if (list_empty(&qh->list)) {
492                         if (i < UHCI_NUM_SKELQH - 1) {
493                                 if (qh->link !=
494                                     (cpu_to_le32(uhci->skelqh[j]->dma_handle) | UHCI_PTR_QH)) {
495                                         show_qh_name();
496                                         out += sprintf(out, "    skeleton QH not linked to next skeleton QH!\n");
497                                 }
498                         }
499
500                         continue;
501                 }
502
503                 show_qh_name();
504
505                 head = &qh->list;
506                 tmp = head->next;
507
508                 while (tmp != head) {
509                         qh = list_entry(tmp, struct uhci_qh, list);
510
511                         tmp = tmp->next;
512
513                         out += uhci_show_qh(qh, out, len - (out - buf), 4);
514                 }
515
516                 if (i < UHCI_NUM_SKELQH - 1) {
517                         if (qh->link !=
518                             (cpu_to_le32(uhci->skelqh[j]->dma_handle) | UHCI_PTR_QH))
519                                 out += sprintf(out, "    last QH not linked to next skeleton!\n");
520                 }
521         }
522
523         if (debug > 2)
524                 out += uhci_show_lists(uhci, out, len - (out - buf));
525
526         spin_unlock_irqrestore(&uhci->lock, flags);
527
528         return out - buf;
529 }
530
531 #define MAX_OUTPUT      (64 * 1024)
532
533 struct uhci_debug {
534         int size;
535         char *data;
536         struct uhci_hcd *uhci;
537 };
538
539 static int uhci_debug_open(struct inode *inode, struct file *file)
540 {
541         struct uhci_hcd *uhci = inode->u.generic_ip;
542         struct uhci_debug *up;
543         int ret = -ENOMEM;
544
545         lock_kernel();
546         up = kmalloc(sizeof(*up), GFP_KERNEL);
547         if (!up)
548                 goto out;
549
550         up->data = kmalloc(MAX_OUTPUT, GFP_KERNEL);
551         if (!up->data) {
552                 kfree(up);
553                 goto out;
554         }
555
556         up->size = uhci_sprint_schedule(uhci, up->data, MAX_OUTPUT);
557
558         file->private_data = up;
559
560         ret = 0;
561 out:
562         unlock_kernel();
563         return ret;
564 }
565
566 static loff_t uhci_debug_lseek(struct file *file, loff_t off, int whence)
567 {
568         struct uhci_debug *up;
569         loff_t new = -1;
570
571         lock_kernel();
572         up = file->private_data;
573
574         switch (whence) {
575         case 0:
576                 new = off;
577                 break;
578         case 1:
579                 new = file->f_pos + off;
580                 break;
581         }
582         if (new < 0 || new > up->size) {
583                 unlock_kernel();
584                 return -EINVAL;
585         }
586         unlock_kernel();
587         return (file->f_pos = new);
588 }
589
590 static ssize_t uhci_debug_read(struct file *file, char __user *buf,
591                                 size_t nbytes, loff_t *ppos)
592 {
593         struct uhci_debug *up = file->private_data;
594         return simple_read_from_buffer(buf, nbytes, ppos, up->data, up->size);
595 }
596
597 static int uhci_debug_release(struct inode *inode, struct file *file)
598 {
599         struct uhci_debug *up = file->private_data;
600
601         kfree(up->data);
602         kfree(up);
603
604         return 0;
605 }
606
607 static struct file_operations uhci_debug_operations = {
608         .open =         uhci_debug_open,
609         .llseek =       uhci_debug_lseek,
610         .read =         uhci_debug_read,
611         .release =      uhci_debug_release,
612 };
613
614 #else   /* CONFIG_DEBUG_FS */
615
616 #define uhci_debug_operations (* (struct file_operations *) NULL)
617
618 #endif