BKL: remove extraneous #include <smp_lock.h>
[linux-3.10.git] / 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/slab.h>
13 #include <linux/kernel.h>
14 #include <linux/debugfs.h>
15 #include <asm/io.h>
16
17 #include "uhci-hcd.h"
18
19 static struct dentry *uhci_debugfs_root;
20
21 #ifdef DEBUG
22
23 /* Handle REALLY large printks so we don't overflow buffers */
24 static void lprintk(char *buf)
25 {
26         char *p;
27
28         /* Just write one line at a time */
29         while (buf) {
30                 p = strchr(buf, '\n');
31                 if (p)
32                         *p = 0;
33                 printk(KERN_DEBUG "%s\n", buf);
34                 buf = p;
35                 if (buf)
36                         buf++;
37         }
38 }
39
40 static int uhci_show_td(struct uhci_td *td, char *buf, int len, int space)
41 {
42         char *out = buf;
43         char *spid;
44         u32 status, token;
45
46         /* Try to make sure there's enough memory */
47         if (len < 160)
48                 return 0;
49
50         status = td_status(td);
51         out += sprintf(out, "%*s[%p] link (%08x) ", space, "", td, le32_to_cpu(td->link));
52         out += sprintf(out, "e%d %s%s%s%s%s%s%s%s%s%sLength=%x ",
53                 ((status >> 27) & 3),
54                 (status & TD_CTRL_SPD) ?      "SPD " : "",
55                 (status & TD_CTRL_LS) ?       "LS " : "",
56                 (status & TD_CTRL_IOC) ?      "IOC " : "",
57                 (status & TD_CTRL_ACTIVE) ?   "Active " : "",
58                 (status & TD_CTRL_STALLED) ?  "Stalled " : "",
59                 (status & TD_CTRL_DBUFERR) ?  "DataBufErr " : "",
60                 (status & TD_CTRL_BABBLE) ?   "Babble " : "",
61                 (status & TD_CTRL_NAK) ?      "NAK " : "",
62                 (status & TD_CTRL_CRCTIMEO) ? "CRC/Timeo " : "",
63                 (status & TD_CTRL_BITSTUFF) ? "BitStuff " : "",
64                 status & 0x7ff);
65
66         token = td_token(td);
67         switch (uhci_packetid(token)) {
68                 case USB_PID_SETUP:
69                         spid = "SETUP";
70                         break;
71                 case USB_PID_OUT:
72                         spid = "OUT";
73                         break;
74                 case USB_PID_IN:
75                         spid = "IN";
76                         break;
77                 default:
78                         spid = "?";
79                         break;
80         }
81
82         out += sprintf(out, "MaxLen=%x DT%d EndPt=%x Dev=%x, PID=%x(%s) ",
83                 token >> 21,
84                 ((token >> 19) & 1),
85                 (token >> 15) & 15,
86                 (token >> 8) & 127,
87                 (token & 0xff),
88                 spid);
89         out += sprintf(out, "(buf=%08x)\n", le32_to_cpu(td->buffer));
90
91         return out - buf;
92 }
93
94 static int uhci_show_urbp(struct urb_priv *urbp, char *buf, int len, int space)
95 {
96         char *out = buf;
97         struct uhci_td *td;
98         int i, nactive, ninactive;
99         char *ptype;
100
101         if (len < 200)
102                 return 0;
103
104         out += sprintf(out, "urb_priv [%p] ", urbp);
105         out += sprintf(out, "urb [%p] ", urbp->urb);
106         out += sprintf(out, "qh [%p] ", urbp->qh);
107         out += sprintf(out, "Dev=%d ", usb_pipedevice(urbp->urb->pipe));
108         out += sprintf(out, "EP=%x(%s) ", usb_pipeendpoint(urbp->urb->pipe),
109                         (usb_pipein(urbp->urb->pipe) ? "IN" : "OUT"));
110
111         switch (usb_pipetype(urbp->urb->pipe)) {
112         case PIPE_ISOCHRONOUS: ptype = "ISO"; break;
113         case PIPE_INTERRUPT: ptype = "INT"; break;
114         case PIPE_BULK: ptype = "BLK"; break;
115         default:
116         case PIPE_CONTROL: ptype = "CTL"; break;
117         }
118
119         out += sprintf(out, "%s%s", ptype, (urbp->fsbr ? " FSBR" : ""));
120         out += sprintf(out, " Actlen=%d%s", urbp->urb->actual_length,
121                         (urbp->qh->type == USB_ENDPOINT_XFER_CONTROL ?
122                                 "-8" : ""));
123
124         if (urbp->urb->unlinked)
125                 out += sprintf(out, " Unlinked=%d", urbp->urb->unlinked);
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_hcd *uhci,
150                 struct uhci_qh *qh, char *buf, int len, int space)
151 {
152         char *out = buf;
153         int i, nurbs;
154         __le32 element = qh_element(qh);
155         char *qtype;
156
157         /* Try to make sure there's enough memory */
158         if (len < 80 * 7)
159                 return 0;
160
161         switch (qh->type) {
162         case USB_ENDPOINT_XFER_ISOC: qtype = "ISO"; break;
163         case USB_ENDPOINT_XFER_INT: qtype = "INT"; break;
164         case USB_ENDPOINT_XFER_BULK: qtype = "BLK"; break;
165         case USB_ENDPOINT_XFER_CONTROL: qtype = "CTL"; break;
166         default: qtype = "Skel" ; break;
167         }
168
169         out += sprintf(out, "%*s[%p] %s QH link (%08x) element (%08x)\n",
170                         space, "", qh, qtype,
171                         le32_to_cpu(qh->link), le32_to_cpu(element));
172         if (qh->type == USB_ENDPOINT_XFER_ISOC)
173                 out += sprintf(out, "%*s    period %d phase %d load %d us, "
174                                 "frame %x desc [%p]\n",
175                                 space, "", qh->period, qh->phase, qh->load,
176                                 qh->iso_frame, qh->iso_packet_desc);
177         else if (qh->type == USB_ENDPOINT_XFER_INT)
178                 out += sprintf(out, "%*s    period %d phase %d load %d us\n",
179                                 space, "", qh->period, qh->phase, qh->load);
180
181         if (element & UHCI_PTR_QH)
182                 out += sprintf(out, "%*s  Element points to QH (bug?)\n", space, "");
183
184         if (element & UHCI_PTR_DEPTH)
185                 out += sprintf(out, "%*s  Depth traverse\n", space, "");
186
187         if (element & cpu_to_le32(8))
188                 out += sprintf(out, "%*s  Bit 3 set (bug?)\n", space, "");
189
190         if (!(element & ~(UHCI_PTR_QH | UHCI_PTR_DEPTH)))
191                 out += sprintf(out, "%*s  Element is NULL (bug?)\n", space, "");
192
193         if (list_empty(&qh->queue)) {
194                 out += sprintf(out, "%*s  queue is empty\n", space, "");
195                 if (qh == uhci->skel_async_qh)
196                         out += uhci_show_td(uhci->term_td, out,
197                                         len - (out - buf), 0);
198         } else {
199                 struct urb_priv *urbp = list_entry(qh->queue.next,
200                                 struct urb_priv, node);
201                 struct uhci_td *td = list_entry(urbp->td_list.next,
202                                 struct uhci_td, list);
203
204                 if (element != LINK_TO_TD(td))
205                         out += sprintf(out, "%*s Element != First TD\n",
206                                         space, "");
207                 i = nurbs = 0;
208                 list_for_each_entry(urbp, &qh->queue, node) {
209                         if (++i <= 10)
210                                 out += uhci_show_urbp(urbp, out,
211                                                 len - (out - buf), space + 2);
212                         else
213                                 ++nurbs;
214                 }
215                 if (nurbs > 0)
216                         out += sprintf(out, "%*s Skipped %d URBs\n",
217                                         space, "", nurbs);
218         }
219
220         if (qh->dummy_td) {
221                 out += sprintf(out, "%*s  Dummy TD\n", space, "");
222                 out += uhci_show_td(qh->dummy_td, out, len - (out - buf), 0);
223         }
224
225         return out - buf;
226 }
227
228 static int uhci_show_sc(int port, unsigned short status, char *buf, int len)
229 {
230         char *out = buf;
231
232         /* Try to make sure there's enough memory */
233         if (len < 160)
234                 return 0;
235
236         out += sprintf(out, "  stat%d     =     %04x  %s%s%s%s%s%s%s%s%s%s\n",
237                 port,
238                 status,
239                 (status & USBPORTSC_SUSP) ?     " Suspend" : "",
240                 (status & USBPORTSC_OCC) ?      " OverCurrentChange" : "",
241                 (status & USBPORTSC_OC) ?       " OverCurrent" : "",
242                 (status & USBPORTSC_PR) ?       " Reset" : "",
243                 (status & USBPORTSC_LSDA) ?     " LowSpeed" : "",
244                 (status & USBPORTSC_RD) ?       " ResumeDetect" : "",
245                 (status & USBPORTSC_PEC) ?      " EnableChange" : "",
246                 (status & USBPORTSC_PE) ?       " Enabled" : "",
247                 (status & USBPORTSC_CSC) ?      " ConnectChange" : "",
248                 (status & USBPORTSC_CCS) ?      " Connected" : "");
249
250         return out - buf;
251 }
252
253 static int uhci_show_root_hub_state(struct uhci_hcd *uhci, char *buf, int len)
254 {
255         char *out = buf;
256         char *rh_state;
257
258         /* Try to make sure there's enough memory */
259         if (len < 60)
260                 return 0;
261
262         switch (uhci->rh_state) {
263             case UHCI_RH_RESET:
264                 rh_state = "reset";             break;
265             case UHCI_RH_SUSPENDED:
266                 rh_state = "suspended";         break;
267             case UHCI_RH_AUTO_STOPPED:
268                 rh_state = "auto-stopped";      break;
269             case UHCI_RH_RESUMING:
270                 rh_state = "resuming";          break;
271             case UHCI_RH_SUSPENDING:
272                 rh_state = "suspending";        break;
273             case UHCI_RH_RUNNING:
274                 rh_state = "running";           break;
275             case UHCI_RH_RUNNING_NODEVS:
276                 rh_state = "running, no devs";  break;
277             default:
278                 rh_state = "?";                 break;
279         }
280         out += sprintf(out, "Root-hub state: %s   FSBR: %d\n",
281                         rh_state, uhci->fsbr_is_on);
282         return out - buf;
283 }
284
285 static int uhci_show_status(struct uhci_hcd *uhci, char *buf, int len)
286 {
287         char *out = buf;
288         unsigned long io_addr = uhci->io_addr;
289         unsigned short usbcmd, usbstat, usbint, usbfrnum;
290         unsigned int flbaseadd;
291         unsigned char sof;
292         unsigned short portsc1, portsc2;
293
294         /* Try to make sure there's enough memory */
295         if (len < 80 * 9)
296                 return 0;
297
298         usbcmd    = inw(io_addr + 0);
299         usbstat   = inw(io_addr + 2);
300         usbint    = inw(io_addr + 4);
301         usbfrnum  = inw(io_addr + 6);
302         flbaseadd = inl(io_addr + 8);
303         sof       = inb(io_addr + 12);
304         portsc1   = inw(io_addr + 16);
305         portsc2   = inw(io_addr + 18);
306
307         out += sprintf(out, "  usbcmd    =     %04x   %s%s%s%s%s%s%s%s\n",
308                 usbcmd,
309                 (usbcmd & USBCMD_MAXP) ?    "Maxp64 " : "Maxp32 ",
310                 (usbcmd & USBCMD_CF) ?      "CF " : "",
311                 (usbcmd & USBCMD_SWDBG) ?   "SWDBG " : "",
312                 (usbcmd & USBCMD_FGR) ?     "FGR " : "",
313                 (usbcmd & USBCMD_EGSM) ?    "EGSM " : "",
314                 (usbcmd & USBCMD_GRESET) ?  "GRESET " : "",
315                 (usbcmd & USBCMD_HCRESET) ? "HCRESET " : "",
316                 (usbcmd & USBCMD_RS) ?      "RS " : "");
317
318         out += sprintf(out, "  usbstat   =     %04x   %s%s%s%s%s%s\n",
319                 usbstat,
320                 (usbstat & USBSTS_HCH) ?    "HCHalted " : "",
321                 (usbstat & USBSTS_HCPE) ?   "HostControllerProcessError " : "",
322                 (usbstat & USBSTS_HSE) ?    "HostSystemError " : "",
323                 (usbstat & USBSTS_RD) ?     "ResumeDetect " : "",
324                 (usbstat & USBSTS_ERROR) ?  "USBError " : "",
325                 (usbstat & USBSTS_USBINT) ? "USBINT " : "");
326
327         out += sprintf(out, "  usbint    =     %04x\n", usbint);
328         out += sprintf(out, "  usbfrnum  =   (%d)%03x\n", (usbfrnum >> 10) & 1,
329                 0xfff & (4*(unsigned int)usbfrnum));
330         out += sprintf(out, "  flbaseadd = %08x\n", flbaseadd);
331         out += sprintf(out, "  sof       =       %02x\n", sof);
332         out += uhci_show_sc(1, portsc1, out, len - (out - buf));
333         out += uhci_show_sc(2, portsc2, out, len - (out - buf));
334         out += sprintf(out, "Most recent frame: %x (%d)   "
335                         "Last ISO frame: %x (%d)\n",
336                         uhci->frame_number, uhci->frame_number & 1023,
337                         uhci->last_iso_frame, uhci->last_iso_frame & 1023);
338
339         return out - buf;
340 }
341
342 static int uhci_sprint_schedule(struct uhci_hcd *uhci, char *buf, int len)
343 {
344         char *out = buf;
345         int i, j;
346         struct uhci_qh *qh;
347         struct uhci_td *td;
348         struct list_head *tmp, *head;
349         int nframes, nerrs;
350         __le32 link;
351         __le32 fsbr_link;
352
353         static const char * const qh_names[] = {
354                 "unlink", "iso", "int128", "int64", "int32", "int16",
355                 "int8", "int4", "int2", "async", "term"
356         };
357
358         out += uhci_show_root_hub_state(uhci, out, len - (out - buf));
359         out += sprintf(out, "HC status\n");
360         out += uhci_show_status(uhci, out, len - (out - buf));
361
362         out += sprintf(out, "Periodic load table\n");
363         for (i = 0; i < MAX_PHASE; ++i) {
364                 out += sprintf(out, "\t%d", uhci->load[i]);
365                 if (i % 8 == 7)
366                         *out++ = '\n';
367         }
368         out += sprintf(out, "Total: %d, #INT: %d, #ISO: %d\n",
369                         uhci->total_load,
370                         uhci_to_hcd(uhci)->self.bandwidth_int_reqs,
371                         uhci_to_hcd(uhci)->self.bandwidth_isoc_reqs);
372         if (debug <= 1)
373                 return out - buf;
374
375         out += sprintf(out, "Frame List\n");
376         nframes = 10;
377         nerrs = 0;
378         for (i = 0; i < UHCI_NUMFRAMES; ++i) {
379                 __le32 qh_dma;
380
381                 j = 0;
382                 td = uhci->frame_cpu[i];
383                 link = uhci->frame[i];
384                 if (!td)
385                         goto check_link;
386
387                 if (nframes > 0) {
388                         out += sprintf(out, "- Frame %d -> (%08x)\n",
389                                         i, le32_to_cpu(link));
390                         j = 1;
391                 }
392
393                 head = &td->fl_list;
394                 tmp = head;
395                 do {
396                         td = list_entry(tmp, struct uhci_td, fl_list);
397                         tmp = tmp->next;
398                         if (link != LINK_TO_TD(td)) {
399                                 if (nframes > 0)
400                                         out += sprintf(out, "    link does "
401                                                 "not match list entry!\n");
402                                 else
403                                         ++nerrs;
404                         }
405                         if (nframes > 0)
406                                 out += uhci_show_td(td, out,
407                                                 len - (out - buf), 4);
408                         link = td->link;
409                 } while (tmp != head);
410
411 check_link:
412                 qh_dma = uhci_frame_skel_link(uhci, i);
413                 if (link != qh_dma) {
414                         if (nframes > 0) {
415                                 if (!j) {
416                                         out += sprintf(out,
417                                                 "- Frame %d -> (%08x)\n",
418                                                 i, le32_to_cpu(link));
419                                         j = 1;
420                                 }
421                                 out += sprintf(out, "   link does not match "
422                                         "QH (%08x)!\n", le32_to_cpu(qh_dma));
423                         } else
424                                 ++nerrs;
425                 }
426                 nframes -= j;
427         }
428         if (nerrs > 0)
429                 out += sprintf(out, "Skipped %d bad links\n", nerrs);
430
431         out += sprintf(out, "Skeleton QHs\n");
432
433         fsbr_link = 0;
434         for (i = 0; i < UHCI_NUM_SKELQH; ++i) {
435                 int cnt = 0;
436
437                 qh = uhci->skelqh[i];
438                 out += sprintf(out, "- skel_%s_qh\n", qh_names[i]); \
439                 out += uhci_show_qh(uhci, qh, out, len - (out - buf), 4);
440
441                 /* Last QH is the Terminating QH, it's different */
442                 if (i == SKEL_TERM) {
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");
445                         link = fsbr_link;
446                         if (!link)
447                                 link = LINK_TO_QH(uhci->skel_term_qh);
448                         goto check_qh_link;
449                 }
450
451                 head = &qh->node;
452                 tmp = head->next;
453
454                 while (tmp != head) {
455                         qh = list_entry(tmp, struct uhci_qh, node);
456                         tmp = tmp->next;
457                         if (++cnt <= 10)
458                                 out += uhci_show_qh(uhci, qh, out,
459                                                 len - (out - buf), 4);
460                         if (!fsbr_link && qh->skel >= SKEL_FSBR)
461                                 fsbr_link = LINK_TO_QH(qh);
462                 }
463                 if ((cnt -= 10) > 0)
464                         out += sprintf(out, "    Skipped %d QHs\n", cnt);
465
466                 link = UHCI_PTR_TERM;
467                 if (i <= SKEL_ISO)
468                         ;
469                 else if (i < SKEL_ASYNC)
470                         link = LINK_TO_QH(uhci->skel_async_qh);
471                 else if (!uhci->fsbr_is_on)
472                         ;
473                 else
474                         link = LINK_TO_QH(uhci->skel_term_qh);
475 check_qh_link:
476                 if (qh->link != link)
477                         out += sprintf(out, "    last QH not linked to next skeleton!\n");
478         }
479
480         return out - buf;
481 }
482
483 #ifdef CONFIG_DEBUG_FS
484
485 #define MAX_OUTPUT      (64 * 1024)
486
487 struct uhci_debug {
488         int size;
489         char *data;
490 };
491
492 static int uhci_debug_open(struct inode *inode, struct file *file)
493 {
494         struct uhci_hcd *uhci = inode->i_private;
495         struct uhci_debug *up;
496         unsigned long flags;
497
498         up = kmalloc(sizeof(*up), GFP_KERNEL);
499         if (!up)
500                 return -ENOMEM;
501
502         up->data = kmalloc(MAX_OUTPUT, GFP_KERNEL);
503         if (!up->data) {
504                 kfree(up);
505                 return -ENOMEM;
506         }
507
508         up->size = 0;
509         spin_lock_irqsave(&uhci->lock, flags);
510         if (uhci->is_initialized)
511                 up->size = uhci_sprint_schedule(uhci, up->data, MAX_OUTPUT);
512         spin_unlock_irqrestore(&uhci->lock, flags);
513
514         file->private_data = up;
515
516         return 0;
517 }
518
519 static loff_t uhci_debug_lseek(struct file *file, loff_t off, int whence)
520 {
521         struct uhci_debug *up;
522         loff_t new = -1;
523
524         up = file->private_data;
525
526         /* XXX: atomic 64bit seek access, but that needs to be fixed in the VFS */
527         switch (whence) {
528         case 0:
529                 new = off;
530                 break;
531         case 1:
532                 new = file->f_pos + off;
533                 break;
534         }
535
536         if (new < 0 || new > up->size)
537                 return -EINVAL;
538
539         return (file->f_pos = new);
540 }
541
542 static ssize_t uhci_debug_read(struct file *file, char __user *buf,
543                                 size_t nbytes, loff_t *ppos)
544 {
545         struct uhci_debug *up = file->private_data;
546         return simple_read_from_buffer(buf, nbytes, ppos, up->data, up->size);
547 }
548
549 static int uhci_debug_release(struct inode *inode, struct file *file)
550 {
551         struct uhci_debug *up = file->private_data;
552
553         kfree(up->data);
554         kfree(up);
555
556         return 0;
557 }
558
559 static const struct file_operations uhci_debug_operations = {
560         .owner =        THIS_MODULE,
561         .open =         uhci_debug_open,
562         .llseek =       uhci_debug_lseek,
563         .read =         uhci_debug_read,
564         .release =      uhci_debug_release,
565 };
566 #define UHCI_DEBUG_OPS
567
568 #endif  /* CONFIG_DEBUG_FS */
569
570 #else   /* DEBUG */
571
572 static inline void lprintk(char *buf)
573 {}
574
575 static inline int uhci_show_qh(struct uhci_hcd *uhci,
576                 struct uhci_qh *qh, char *buf, int len, int space)
577 {
578         return 0;
579 }
580
581 static inline int uhci_sprint_schedule(struct uhci_hcd *uhci,
582                 char *buf, int len)
583 {
584         return 0;
585 }
586
587 #endif