Merge branch 'x86-64'
[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 #define uhci_debug_operations (* (struct file_operations *) NULL)
21 static struct dentry *uhci_debugfs_root;
22
23 #ifdef DEBUG
24
25 /* Handle REALLY large printks so we don't overflow buffers */
26 static void lprintk(char *buf)
27 {
28         char *p;
29
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++;
39         }
40 }
41
42 static int uhci_show_td(struct uhci_td *td, char *buf, int len, int space)
43 {
44         char *out = buf;
45         char *spid;
46         u32 status, token;
47
48         /* Try to make sure there's enough memory */
49         if (len < 160)
50                 return 0;
51
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);
67
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;
82         }
83
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));
92
93         return out - buf;
94 }
95
96 static int uhci_show_urbp(struct urb_priv *urbp, char *buf, int len, int space)
97 {
98         char *out = buf;
99         struct uhci_td *td;
100         int i, nactive, ninactive;
101         char *ptype;
102
103         if (len < 200)
104                 return 0;
105
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"));
112
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;
119         }
120
121         out += sprintf(out, "%s%s", ptype, (urbp->fsbr ? " FSBR" : ""));
122         out += sprintf(out, " Actlen=%d", urbp->urb->actual_length);
123
124         if (urbp->urb->status != -EINPROGRESS)
125                 out += sprintf(out, " Status=%d", urbp->urb->status);
126         out += sprintf(out, "\n");
127
128         i = nactive = ninactive = 0;
129         list_for_each_entry(td, &urbp->td_list, list) {
130                 if (urbp->qh->type != USB_ENDPOINT_XFER_ISOC &&
131                                 (++i <= 10 || debug > 2)) {
132                         out += sprintf(out, "%*s%d: ", space + 2, "", i);
133                         out += uhci_show_td(td, out, len - (out - buf), 0);
134                 } else {
135                         if (td_status(td) & TD_CTRL_ACTIVE)
136                                 ++nactive;
137                         else
138                                 ++ninactive;
139                 }
140         }
141         if (nactive + ninactive > 0)
142                 out += sprintf(out, "%*s[skipped %d inactive and %d active "
143                                 "TDs]\n",
144                                 space, "", ninactive, nactive);
145
146         return out - buf;
147 }
148
149 static int uhci_show_qh(struct uhci_qh *qh, char *buf, int len, int space)
150 {
151         char *out = buf;
152         int i, nurbs;
153         __le32 element = qh_element(qh);
154         char *qtype;
155
156         /* Try to make sure there's enough memory */
157         if (len < 80 * 7)
158                 return 0;
159
160         switch (qh->type) {
161         case USB_ENDPOINT_XFER_ISOC: qtype = "ISO"; break;
162         case USB_ENDPOINT_XFER_INT: qtype = "INT"; break;
163         case USB_ENDPOINT_XFER_BULK: qtype = "BLK"; break;
164         case USB_ENDPOINT_XFER_CONTROL: qtype = "CTL"; break;
165         default: qtype = "Skel" ; break;
166         }
167
168         out += sprintf(out, "%*s[%p] %s QH link (%08x) element (%08x)\n",
169                         space, "", qh, qtype,
170                         le32_to_cpu(qh->link), le32_to_cpu(element));
171         if (qh->type == USB_ENDPOINT_XFER_ISOC)
172                 out += sprintf(out, "%*s    period %d frame %x desc [%p]\n",
173                                 space, "", qh->period, qh->iso_frame,
174                                 qh->iso_packet_desc);
175
176         if (element & UHCI_PTR_QH)
177                 out += sprintf(out, "%*s  Element points to QH (bug?)\n", space, "");
178
179         if (element & UHCI_PTR_DEPTH)
180                 out += sprintf(out, "%*s  Depth traverse\n", space, "");
181
182         if (element & cpu_to_le32(8))
183                 out += sprintf(out, "%*s  Bit 3 set (bug?)\n", space, "");
184
185         if (!(element & ~(UHCI_PTR_QH | UHCI_PTR_DEPTH)))
186                 out += sprintf(out, "%*s  Element is NULL (bug?)\n", space, "");
187
188         if (list_empty(&qh->queue)) {
189                 out += sprintf(out, "%*s  queue is empty\n", space, "");
190         } else {
191                 struct urb_priv *urbp = list_entry(qh->queue.next,
192                                 struct urb_priv, node);
193                 struct uhci_td *td = list_entry(urbp->td_list.next,
194                                 struct uhci_td, list);
195
196                 if (cpu_to_le32(td->dma_handle) != (element & ~UHCI_PTR_BITS))
197                         out += sprintf(out, "%*s Element != First TD\n",
198                                         space, "");
199                 i = nurbs = 0;
200                 list_for_each_entry(urbp, &qh->queue, node) {
201                         if (++i <= 10)
202                                 out += uhci_show_urbp(urbp, out,
203                                                 len - (out - buf), space + 2);
204                         else
205                                 ++nurbs;
206                 }
207                 if (nurbs > 0)
208                         out += sprintf(out, "%*s Skipped %d URBs\n",
209                                         space, "", nurbs);
210         }
211
212         if (qh->udev) {
213                 out += sprintf(out, "%*s  Dummy TD\n", space, "");
214                 out += uhci_show_td(qh->dummy_td, out, len - (out - buf), 0);
215         }
216
217         return out - buf;
218 }
219
220 static const char * const qh_names[] = {
221   "skel_unlink_qh", "skel_iso_qh",
222   "skel_int128_qh", "skel_int64_qh",
223   "skel_int32_qh", "skel_int16_qh",
224   "skel_int8_qh", "skel_int4_qh",
225   "skel_int2_qh", "skel_int1_qh",
226   "skel_ls_control_qh", "skel_fs_control_qh",
227   "skel_bulk_qh", "skel_term_qh"
228 };
229
230 static int uhci_show_sc(int port, unsigned short status, char *buf, int len)
231 {
232         char *out = buf;
233
234         /* Try to make sure there's enough memory */
235         if (len < 160)
236                 return 0;
237
238         out += sprintf(out, "  stat%d     =     %04x  %s%s%s%s%s%s%s%s%s%s\n",
239                 port,
240                 status,
241                 (status & USBPORTSC_SUSP) ?     " Suspend" : "",
242                 (status & USBPORTSC_OCC) ?      " OverCurrentChange" : "",
243                 (status & USBPORTSC_OC) ?       " OverCurrent" : "",
244                 (status & USBPORTSC_PR) ?       " Reset" : "",
245                 (status & USBPORTSC_LSDA) ?     " LowSpeed" : "",
246                 (status & USBPORTSC_RD) ?       " ResumeDetect" : "",
247                 (status & USBPORTSC_PEC) ?      " EnableChange" : "",
248                 (status & USBPORTSC_PE) ?       " Enabled" : "",
249                 (status & USBPORTSC_CSC) ?      " ConnectChange" : "",
250                 (status & USBPORTSC_CCS) ?      " Connected" : "");
251
252         return out - buf;
253 }
254
255 static int uhci_show_root_hub_state(struct uhci_hcd *uhci, char *buf, int len)
256 {
257         char *out = buf;
258         char *rh_state;
259
260         /* Try to make sure there's enough memory */
261         if (len < 60)
262                 return 0;
263
264         switch (uhci->rh_state) {
265             case UHCI_RH_RESET:
266                 rh_state = "reset";             break;
267             case UHCI_RH_SUSPENDED:
268                 rh_state = "suspended";         break;
269             case UHCI_RH_AUTO_STOPPED:
270                 rh_state = "auto-stopped";      break;
271             case UHCI_RH_RESUMING:
272                 rh_state = "resuming";          break;
273             case UHCI_RH_SUSPENDING:
274                 rh_state = "suspending";        break;
275             case UHCI_RH_RUNNING:
276                 rh_state = "running";           break;
277             case UHCI_RH_RUNNING_NODEVS:
278                 rh_state = "running, no devs";  break;
279             default:
280                 rh_state = "?";                 break;
281         }
282         out += sprintf(out, "Root-hub state: %s   FSBR: %d\n",
283                         rh_state, uhci->fsbr_is_on);
284         return out - buf;
285 }
286
287 static int uhci_show_status(struct uhci_hcd *uhci, char *buf, int len)
288 {
289         char *out = buf;
290         unsigned long io_addr = uhci->io_addr;
291         unsigned short usbcmd, usbstat, usbint, usbfrnum;
292         unsigned int flbaseadd;
293         unsigned char sof;
294         unsigned short portsc1, portsc2;
295
296         /* Try to make sure there's enough memory */
297         if (len < 80 * 9)
298                 return 0;
299
300         usbcmd    = inw(io_addr + 0);
301         usbstat   = inw(io_addr + 2);
302         usbint    = inw(io_addr + 4);
303         usbfrnum  = inw(io_addr + 6);
304         flbaseadd = inl(io_addr + 8);
305         sof       = inb(io_addr + 12);
306         portsc1   = inw(io_addr + 16);
307         portsc2   = inw(io_addr + 18);
308
309         out += sprintf(out, "  usbcmd    =     %04x   %s%s%s%s%s%s%s%s\n",
310                 usbcmd,
311                 (usbcmd & USBCMD_MAXP) ?    "Maxp64 " : "Maxp32 ",
312                 (usbcmd & USBCMD_CF) ?      "CF " : "",
313                 (usbcmd & USBCMD_SWDBG) ?   "SWDBG " : "",
314                 (usbcmd & USBCMD_FGR) ?     "FGR " : "",
315                 (usbcmd & USBCMD_EGSM) ?    "EGSM " : "",
316                 (usbcmd & USBCMD_GRESET) ?  "GRESET " : "",
317                 (usbcmd & USBCMD_HCRESET) ? "HCRESET " : "",
318                 (usbcmd & USBCMD_RS) ?      "RS " : "");
319
320         out += sprintf(out, "  usbstat   =     %04x   %s%s%s%s%s%s\n",
321                 usbstat,
322                 (usbstat & USBSTS_HCH) ?    "HCHalted " : "",
323                 (usbstat & USBSTS_HCPE) ?   "HostControllerProcessError " : "",
324                 (usbstat & USBSTS_HSE) ?    "HostSystemError " : "",
325                 (usbstat & USBSTS_RD) ?     "ResumeDetect " : "",
326                 (usbstat & USBSTS_ERROR) ?  "USBError " : "",
327                 (usbstat & USBSTS_USBINT) ? "USBINT " : "");
328
329         out += sprintf(out, "  usbint    =     %04x\n", usbint);
330         out += sprintf(out, "  usbfrnum  =   (%d)%03x\n", (usbfrnum >> 10) & 1,
331                 0xfff & (4*(unsigned int)usbfrnum));
332         out += sprintf(out, "  flbaseadd = %08x\n", flbaseadd);
333         out += sprintf(out, "  sof       =       %02x\n", sof);
334         out += uhci_show_sc(1, portsc1, out, len - (out - buf));
335         out += uhci_show_sc(2, portsc2, out, len - (out - buf));
336         out += sprintf(out, "Most recent frame: %x (%d)   "
337                         "Last ISO frame: %x (%d)\n",
338                         uhci->frame_number, uhci->frame_number & 1023,
339                         uhci->last_iso_frame, uhci->last_iso_frame & 1023);
340
341         return out - buf;
342 }
343
344 static int uhci_sprint_schedule(struct uhci_hcd *uhci, char *buf, int len)
345 {
346         char *out = buf;
347         int i, j;
348         struct uhci_qh *qh;
349         struct uhci_td *td;
350         struct list_head *tmp, *head;
351
352         out += uhci_show_root_hub_state(uhci, out, len - (out - buf));
353         out += sprintf(out, "HC status\n");
354         out += uhci_show_status(uhci, out, len - (out - buf));
355         if (debug <= 1)
356                 return out - buf;
357
358         out += sprintf(out, "Frame List\n");
359         for (i = 0; i < UHCI_NUMFRAMES; ++i) {
360                 td = uhci->frame_cpu[i];
361                 if (!td)
362                         continue;
363
364                 out += sprintf(out, "- Frame %d\n", i); \
365                 if (td->dma_handle != (dma_addr_t)uhci->frame[i])
366                         out += sprintf(out, "    frame list does not match td->dma_handle!\n");
367
368                 head = &td->fl_list;
369                 tmp = head;
370                 do {
371                         td = list_entry(tmp, struct uhci_td, fl_list);
372                         tmp = tmp->next;
373                         out += uhci_show_td(td, out, len - (out - buf), 4);
374                 } while (tmp != head);
375         }
376
377         out += sprintf(out, "Skeleton QHs\n");
378
379         for (i = 0; i < UHCI_NUM_SKELQH; ++i) {
380                 int cnt = 0;
381
382                 qh = uhci->skelqh[i];
383                 out += sprintf(out, "- %s\n", qh_names[i]); \
384                 out += uhci_show_qh(qh, out, len - (out - buf), 4);
385
386                 /* Last QH is the Terminating QH, it's different */
387                 if (i == UHCI_NUM_SKELQH - 1) {
388                         if (qh->link != UHCI_PTR_TERM)
389                                 out += sprintf(out, "    bandwidth reclamation on!\n");
390
391                         if (qh_element(qh) != cpu_to_le32(uhci->term_td->dma_handle))
392                                 out += sprintf(out, "    skel_term_qh element is not set to term_td!\n");
393
394                         continue;
395                 }
396
397                 j = (i < 9) ? 9 : i+1;          /* Next skeleton */
398                 head = &qh->node;
399                 tmp = head->next;
400
401                 while (tmp != head) {
402                         qh = list_entry(tmp, struct uhci_qh, node);
403                         tmp = tmp->next;
404                         if (++cnt <= 10)
405                                 out += uhci_show_qh(qh, out,
406                                                 len - (out - buf), 4);
407                 }
408                 if ((cnt -= 10) > 0)
409                         out += sprintf(out, "    Skipped %d QHs\n", cnt);
410
411                 if (i > 1 && i < UHCI_NUM_SKELQH - 1) {
412                         if (qh->link !=
413                             (cpu_to_le32(uhci->skelqh[j]->dma_handle) | UHCI_PTR_QH))
414                                 out += sprintf(out, "    last QH not linked to next skeleton!\n");
415                 }
416         }
417
418         return out - buf;
419 }
420
421 #ifdef CONFIG_DEBUG_FS
422
423 #define MAX_OUTPUT      (64 * 1024)
424
425 struct uhci_debug {
426         int size;
427         char *data;
428 };
429
430 static int uhci_debug_open(struct inode *inode, struct file *file)
431 {
432         struct uhci_hcd *uhci = inode->u.generic_ip;
433         struct uhci_debug *up;
434         int ret = -ENOMEM;
435         unsigned long flags;
436
437         lock_kernel();
438         up = kmalloc(sizeof(*up), GFP_KERNEL);
439         if (!up)
440                 goto out;
441
442         up->data = kmalloc(MAX_OUTPUT, GFP_KERNEL);
443         if (!up->data) {
444                 kfree(up);
445                 goto out;
446         }
447
448         up->size = 0;
449         spin_lock_irqsave(&uhci->lock, flags);
450         if (uhci->is_initialized)
451                 up->size = uhci_sprint_schedule(uhci, up->data, MAX_OUTPUT);
452         spin_unlock_irqrestore(&uhci->lock, flags);
453
454         file->private_data = up;
455
456         ret = 0;
457 out:
458         unlock_kernel();
459         return ret;
460 }
461
462 static loff_t uhci_debug_lseek(struct file *file, loff_t off, int whence)
463 {
464         struct uhci_debug *up;
465         loff_t new = -1;
466
467         lock_kernel();
468         up = file->private_data;
469
470         switch (whence) {
471         case 0:
472                 new = off;
473                 break;
474         case 1:
475                 new = file->f_pos + off;
476                 break;
477         }
478         if (new < 0 || new > up->size) {
479                 unlock_kernel();
480                 return -EINVAL;
481         }
482         unlock_kernel();
483         return (file->f_pos = new);
484 }
485
486 static ssize_t uhci_debug_read(struct file *file, char __user *buf,
487                                 size_t nbytes, loff_t *ppos)
488 {
489         struct uhci_debug *up = file->private_data;
490         return simple_read_from_buffer(buf, nbytes, ppos, up->data, up->size);
491 }
492
493 static int uhci_debug_release(struct inode *inode, struct file *file)
494 {
495         struct uhci_debug *up = file->private_data;
496
497         kfree(up->data);
498         kfree(up);
499
500         return 0;
501 }
502
503 #undef uhci_debug_operations
504 static struct file_operations uhci_debug_operations = {
505         .owner =        THIS_MODULE,
506         .open =         uhci_debug_open,
507         .llseek =       uhci_debug_lseek,
508         .read =         uhci_debug_read,
509         .release =      uhci_debug_release,
510 };
511
512 #endif  /* CONFIG_DEBUG_FS */
513
514 #else   /* DEBUG */
515
516 static inline void lprintk(char *buf)
517 {}
518
519 static inline int uhci_show_qh(struct uhci_qh *qh, char *buf,
520                 int len, int space)
521 {
522         return 0;
523 }
524
525 static inline int uhci_sprint_schedule(struct uhci_hcd *uhci,
526                 char *buf, int len)
527 {
528         return 0;
529 }
530
531 #endif