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