Linux-libre 3.10.48-gnu
[librecmc/linux-libre.git] / drivers / usb / host / ehci-dbg.c
1 /*
2  * Copyright (c) 2001-2002 by David Brownell
3  *
4  * This program is free software; you can redistribute it and/or modify it
5  * under the terms of the GNU General Public License as published by the
6  * Free Software Foundation; either version 2 of the License, or (at your
7  * option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
11  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
12  * for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17  */
18
19 /* this file is part of ehci-hcd.c */
20
21 #ifdef  DEBUG
22
23 /* check the values in the HCSPARAMS register
24  * (host controller _Structural_ parameters)
25  * see EHCI spec, Table 2-4 for each value
26  */
27 static void dbg_hcs_params (struct ehci_hcd *ehci, char *label)
28 {
29         u32     params = ehci_readl(ehci, &ehci->caps->hcs_params);
30
31         ehci_dbg (ehci,
32                 "%s hcs_params 0x%x dbg=%d%s cc=%d pcc=%d%s%s ports=%d\n",
33                 label, params,
34                 HCS_DEBUG_PORT (params),
35                 HCS_INDICATOR (params) ? " ind" : "",
36                 HCS_N_CC (params),
37                 HCS_N_PCC (params),
38                 HCS_PORTROUTED (params) ? "" : " ordered",
39                 HCS_PPC (params) ? "" : " !ppc",
40                 HCS_N_PORTS (params)
41                 );
42         /* Port routing, per EHCI 0.95 Spec, Section 2.2.5 */
43         if (HCS_PORTROUTED (params)) {
44                 int i;
45                 char buf [46], tmp [7], byte;
46
47                 buf[0] = 0;
48                 for (i = 0; i < HCS_N_PORTS (params); i++) {
49                         // FIXME MIPS won't readb() ...
50                         byte = readb (&ehci->caps->portroute[(i>>1)]);
51                         sprintf(tmp, "%d ",
52                                 ((i & 0x1) ? ((byte)&0xf) : ((byte>>4)&0xf)));
53                         strcat(buf, tmp);
54                 }
55                 ehci_dbg (ehci, "%s portroute %s\n",
56                                 label, buf);
57         }
58 }
59 #else
60
61 static inline void dbg_hcs_params (struct ehci_hcd *ehci, char *label) {}
62
63 #endif
64
65 #ifdef  DEBUG
66
67 /* check the values in the HCCPARAMS register
68  * (host controller _Capability_ parameters)
69  * see EHCI Spec, Table 2-5 for each value
70  * */
71 static void dbg_hcc_params (struct ehci_hcd *ehci, char *label)
72 {
73         u32     params = ehci_readl(ehci, &ehci->caps->hcc_params);
74
75         if (HCC_ISOC_CACHE (params)) {
76                 ehci_dbg (ehci,
77                         "%s hcc_params %04x caching frame %s%s%s\n",
78                         label, params,
79                         HCC_PGM_FRAMELISTLEN(params) ? "256/512/1024" : "1024",
80                         HCC_CANPARK(params) ? " park" : "",
81                         HCC_64BIT_ADDR(params) ? " 64 bit addr" : "");
82         } else {
83                 ehci_dbg (ehci,
84                         "%s hcc_params %04x thresh %d uframes %s%s%s%s%s%s%s\n",
85                         label,
86                         params,
87                         HCC_ISOC_THRES(params),
88                         HCC_PGM_FRAMELISTLEN(params) ? "256/512/1024" : "1024",
89                         HCC_CANPARK(params) ? " park" : "",
90                         HCC_64BIT_ADDR(params) ? " 64 bit addr" : "",
91                         HCC_LPM(params) ? " LPM" : "",
92                         HCC_PER_PORT_CHANGE_EVENT(params) ? " ppce" : "",
93                         HCC_HW_PREFETCH(params) ? " hw prefetch" : "",
94                         HCC_32FRAME_PERIODIC_LIST(params) ?
95                                 " 32 periodic list" : "");
96         }
97 }
98 #else
99
100 static inline void dbg_hcc_params (struct ehci_hcd *ehci, char *label) {}
101
102 #endif
103
104 #ifdef  DEBUG
105
106 static void __maybe_unused
107 dbg_qtd (const char *label, struct ehci_hcd *ehci, struct ehci_qtd *qtd)
108 {
109         ehci_dbg(ehci, "%s td %p n%08x %08x t%08x p0=%08x\n", label, qtd,
110                 hc32_to_cpup(ehci, &qtd->hw_next),
111                 hc32_to_cpup(ehci, &qtd->hw_alt_next),
112                 hc32_to_cpup(ehci, &qtd->hw_token),
113                 hc32_to_cpup(ehci, &qtd->hw_buf [0]));
114         if (qtd->hw_buf [1])
115                 ehci_dbg(ehci, "  p1=%08x p2=%08x p3=%08x p4=%08x\n",
116                         hc32_to_cpup(ehci, &qtd->hw_buf[1]),
117                         hc32_to_cpup(ehci, &qtd->hw_buf[2]),
118                         hc32_to_cpup(ehci, &qtd->hw_buf[3]),
119                         hc32_to_cpup(ehci, &qtd->hw_buf[4]));
120 }
121
122 static void __maybe_unused
123 dbg_qh (const char *label, struct ehci_hcd *ehci, struct ehci_qh *qh)
124 {
125         struct ehci_qh_hw *hw = qh->hw;
126
127         ehci_dbg (ehci, "%s qh %p n%08x info %x %x qtd %x\n", label,
128                 qh, hw->hw_next, hw->hw_info1, hw->hw_info2, hw->hw_current);
129         dbg_qtd("overlay", ehci, (struct ehci_qtd *) &hw->hw_qtd_next);
130 }
131
132 static void __maybe_unused
133 dbg_itd (const char *label, struct ehci_hcd *ehci, struct ehci_itd *itd)
134 {
135         ehci_dbg (ehci, "%s [%d] itd %p, next %08x, urb %p\n",
136                 label, itd->frame, itd, hc32_to_cpu(ehci, itd->hw_next),
137                 itd->urb);
138         ehci_dbg (ehci,
139                 "  trans: %08x %08x %08x %08x %08x %08x %08x %08x\n",
140                 hc32_to_cpu(ehci, itd->hw_transaction[0]),
141                 hc32_to_cpu(ehci, itd->hw_transaction[1]),
142                 hc32_to_cpu(ehci, itd->hw_transaction[2]),
143                 hc32_to_cpu(ehci, itd->hw_transaction[3]),
144                 hc32_to_cpu(ehci, itd->hw_transaction[4]),
145                 hc32_to_cpu(ehci, itd->hw_transaction[5]),
146                 hc32_to_cpu(ehci, itd->hw_transaction[6]),
147                 hc32_to_cpu(ehci, itd->hw_transaction[7]));
148         ehci_dbg (ehci,
149                 "  buf:   %08x %08x %08x %08x %08x %08x %08x\n",
150                 hc32_to_cpu(ehci, itd->hw_bufp[0]),
151                 hc32_to_cpu(ehci, itd->hw_bufp[1]),
152                 hc32_to_cpu(ehci, itd->hw_bufp[2]),
153                 hc32_to_cpu(ehci, itd->hw_bufp[3]),
154                 hc32_to_cpu(ehci, itd->hw_bufp[4]),
155                 hc32_to_cpu(ehci, itd->hw_bufp[5]),
156                 hc32_to_cpu(ehci, itd->hw_bufp[6]));
157         ehci_dbg (ehci, "  index: %d %d %d %d %d %d %d %d\n",
158                 itd->index[0], itd->index[1], itd->index[2],
159                 itd->index[3], itd->index[4], itd->index[5],
160                 itd->index[6], itd->index[7]);
161 }
162
163 static void __maybe_unused
164 dbg_sitd (const char *label, struct ehci_hcd *ehci, struct ehci_sitd *sitd)
165 {
166         ehci_dbg (ehci, "%s [%d] sitd %p, next %08x, urb %p\n",
167                 label, sitd->frame, sitd, hc32_to_cpu(ehci, sitd->hw_next),
168                 sitd->urb);
169         ehci_dbg (ehci,
170                 "  addr %08x sched %04x result %08x buf %08x %08x\n",
171                 hc32_to_cpu(ehci, sitd->hw_fullspeed_ep),
172                 hc32_to_cpu(ehci, sitd->hw_uframe),
173                 hc32_to_cpu(ehci, sitd->hw_results),
174                 hc32_to_cpu(ehci, sitd->hw_buf[0]),
175                 hc32_to_cpu(ehci, sitd->hw_buf[1]));
176 }
177
178 static int __maybe_unused
179 dbg_status_buf (char *buf, unsigned len, const char *label, u32 status)
180 {
181         return scnprintf (buf, len,
182                 "%s%sstatus %04x%s%s%s%s%s%s%s%s%s%s%s",
183                 label, label [0] ? " " : "", status,
184                 (status & STS_PPCE_MASK) ? " PPCE" : "",
185                 (status & STS_ASS) ? " Async" : "",
186                 (status & STS_PSS) ? " Periodic" : "",
187                 (status & STS_RECL) ? " Recl" : "",
188                 (status & STS_HALT) ? " Halt" : "",
189                 (status & STS_IAA) ? " IAA" : "",
190                 (status & STS_FATAL) ? " FATAL" : "",
191                 (status & STS_FLR) ? " FLR" : "",
192                 (status & STS_PCD) ? " PCD" : "",
193                 (status & STS_ERR) ? " ERR" : "",
194                 (status & STS_INT) ? " INT" : ""
195                 );
196 }
197
198 static int __maybe_unused
199 dbg_intr_buf (char *buf, unsigned len, const char *label, u32 enable)
200 {
201         return scnprintf (buf, len,
202                 "%s%sintrenable %02x%s%s%s%s%s%s%s",
203                 label, label [0] ? " " : "", enable,
204                 (enable & STS_PPCE_MASK) ? " PPCE" : "",
205                 (enable & STS_IAA) ? " IAA" : "",
206                 (enable & STS_FATAL) ? " FATAL" : "",
207                 (enable & STS_FLR) ? " FLR" : "",
208                 (enable & STS_PCD) ? " PCD" : "",
209                 (enable & STS_ERR) ? " ERR" : "",
210                 (enable & STS_INT) ? " INT" : ""
211                 );
212 }
213
214 static const char *const fls_strings [] =
215     { "1024", "512", "256", "??" };
216
217 static int
218 dbg_command_buf (char *buf, unsigned len, const char *label, u32 command)
219 {
220         return scnprintf (buf, len,
221                 "%s%scommand %07x %s%s%s%s%s%s=%d ithresh=%d%s%s%s%s "
222                 "period=%s%s %s",
223                 label, label [0] ? " " : "", command,
224                 (command & CMD_HIRD) ? " HIRD" : "",
225                 (command & CMD_PPCEE) ? " PPCEE" : "",
226                 (command & CMD_FSP) ? " FSP" : "",
227                 (command & CMD_ASPE) ? " ASPE" : "",
228                 (command & CMD_PSPE) ? " PSPE" : "",
229                 (command & CMD_PARK) ? " park" : "(park)",
230                 CMD_PARK_CNT (command),
231                 (command >> 16) & 0x3f,
232                 (command & CMD_LRESET) ? " LReset" : "",
233                 (command & CMD_IAAD) ? " IAAD" : "",
234                 (command & CMD_ASE) ? " Async" : "",
235                 (command & CMD_PSE) ? " Periodic" : "",
236                 fls_strings [(command >> 2) & 0x3],
237                 (command & CMD_RESET) ? " Reset" : "",
238                 (command & CMD_RUN) ? "RUN" : "HALT"
239                 );
240 }
241
242 static int
243 dbg_port_buf (char *buf, unsigned len, const char *label, int port, u32 status)
244 {
245         char    *sig;
246
247         /* signaling state */
248         switch (status & (3 << 10)) {
249         case 0 << 10: sig = "se0"; break;
250         case 1 << 10: sig = "k"; break;         /* low speed */
251         case 2 << 10: sig = "j"; break;
252         default: sig = "?"; break;
253         }
254
255         return scnprintf (buf, len,
256                 "%s%sport:%d status %06x %d %s%s%s%s%s%s "
257                 "sig=%s%s%s%s%s%s%s%s%s%s%s",
258                 label, label [0] ? " " : "", port, status,
259                 status>>25,/*device address */
260                 (status & PORT_SSTS)>>23 == PORTSC_SUSPEND_STS_ACK ?
261                                                 " ACK" : "",
262                 (status & PORT_SSTS)>>23 == PORTSC_SUSPEND_STS_NYET ?
263                                                 " NYET" : "",
264                 (status & PORT_SSTS)>>23 == PORTSC_SUSPEND_STS_STALL ?
265                                                 " STALL" : "",
266                 (status & PORT_SSTS)>>23 == PORTSC_SUSPEND_STS_ERR ?
267                                                 " ERR" : "",
268                 (status & PORT_POWER) ? " POWER" : "",
269                 (status & PORT_OWNER) ? " OWNER" : "",
270                 sig,
271                 (status & PORT_LPM) ? " LPM" : "",
272                 (status & PORT_RESET) ? " RESET" : "",
273                 (status & PORT_SUSPEND) ? " SUSPEND" : "",
274                 (status & PORT_RESUME) ? " RESUME" : "",
275                 (status & PORT_OCC) ? " OCC" : "",
276                 (status & PORT_OC) ? " OC" : "",
277                 (status & PORT_PEC) ? " PEC" : "",
278                 (status & PORT_PE) ? " PE" : "",
279                 (status & PORT_CSC) ? " CSC" : "",
280                 (status & PORT_CONNECT) ? " CONNECT" : "");
281 }
282
283 #else
284 static inline void __maybe_unused
285 dbg_qh (char *label, struct ehci_hcd *ehci, struct ehci_qh *qh)
286 {}
287
288 static inline int __maybe_unused
289 dbg_status_buf (char *buf, unsigned len, const char *label, u32 status)
290 { return 0; }
291
292 static inline int __maybe_unused
293 dbg_command_buf (char *buf, unsigned len, const char *label, u32 command)
294 { return 0; }
295
296 static inline int __maybe_unused
297 dbg_intr_buf (char *buf, unsigned len, const char *label, u32 enable)
298 { return 0; }
299
300 static inline int __maybe_unused
301 dbg_port_buf (char *buf, unsigned len, const char *label, int port, u32 status)
302 { return 0; }
303
304 #endif  /* DEBUG */
305
306 /* functions have the "wrong" filename when they're output... */
307 #define dbg_status(ehci, label, status) { \
308         char _buf [80]; \
309         dbg_status_buf (_buf, sizeof _buf, label, status); \
310         ehci_dbg (ehci, "%s\n", _buf); \
311 }
312
313 #define dbg_cmd(ehci, label, command) { \
314         char _buf [80]; \
315         dbg_command_buf (_buf, sizeof _buf, label, command); \
316         ehci_dbg (ehci, "%s\n", _buf); \
317 }
318
319 #define dbg_port(ehci, label, port, status) { \
320         char _buf [80]; \
321         dbg_port_buf (_buf, sizeof _buf, label, port, status); \
322         ehci_dbg (ehci, "%s\n", _buf); \
323 }
324
325 /*-------------------------------------------------------------------------*/
326
327 #ifdef STUB_DEBUG_FILES
328
329 static inline void create_debug_files (struct ehci_hcd *bus) { }
330 static inline void remove_debug_files (struct ehci_hcd *bus) { }
331
332 #else
333
334 /* troubleshooting help: expose state in debugfs */
335
336 static int debug_async_open(struct inode *, struct file *);
337 static int debug_periodic_open(struct inode *, struct file *);
338 static int debug_registers_open(struct inode *, struct file *);
339 static int debug_async_open(struct inode *, struct file *);
340
341 static ssize_t debug_output(struct file*, char __user*, size_t, loff_t*);
342 static int debug_close(struct inode *, struct file *);
343
344 static const struct file_operations debug_async_fops = {
345         .owner          = THIS_MODULE,
346         .open           = debug_async_open,
347         .read           = debug_output,
348         .release        = debug_close,
349         .llseek         = default_llseek,
350 };
351 static const struct file_operations debug_periodic_fops = {
352         .owner          = THIS_MODULE,
353         .open           = debug_periodic_open,
354         .read           = debug_output,
355         .release        = debug_close,
356         .llseek         = default_llseek,
357 };
358 static const struct file_operations debug_registers_fops = {
359         .owner          = THIS_MODULE,
360         .open           = debug_registers_open,
361         .read           = debug_output,
362         .release        = debug_close,
363         .llseek         = default_llseek,
364 };
365
366 static struct dentry *ehci_debug_root;
367
368 struct debug_buffer {
369         ssize_t (*fill_func)(struct debug_buffer *);    /* fill method */
370         struct usb_bus *bus;
371         struct mutex mutex;     /* protect filling of buffer */
372         size_t count;           /* number of characters filled into buffer */
373         char *output_buf;
374         size_t alloc_size;
375 };
376
377 #define speed_char(info1) ({ char tmp; \
378                 switch (info1 & (3 << 12)) { \
379                 case QH_FULL_SPEED: tmp = 'f'; break; \
380                 case QH_LOW_SPEED:  tmp = 'l'; break; \
381                 case QH_HIGH_SPEED: tmp = 'h'; break; \
382                 default: tmp = '?'; break; \
383                 }; tmp; })
384
385 static inline char token_mark(struct ehci_hcd *ehci, __hc32 token)
386 {
387         __u32 v = hc32_to_cpu(ehci, token);
388
389         if (v & QTD_STS_ACTIVE)
390                 return '*';
391         if (v & QTD_STS_HALT)
392                 return '-';
393         if (!IS_SHORT_READ (v))
394                 return ' ';
395         /* tries to advance through hw_alt_next */
396         return '/';
397 }
398
399 static void qh_lines (
400         struct ehci_hcd *ehci,
401         struct ehci_qh *qh,
402         char **nextp,
403         unsigned *sizep
404 )
405 {
406         u32                     scratch;
407         u32                     hw_curr;
408         struct list_head        *entry;
409         struct ehci_qtd         *td;
410         unsigned                temp;
411         unsigned                size = *sizep;
412         char                    *next = *nextp;
413         char                    mark;
414         __le32                  list_end = EHCI_LIST_END(ehci);
415         struct ehci_qh_hw       *hw = qh->hw;
416
417         if (hw->hw_qtd_next == list_end)        /* NEC does this */
418                 mark = '@';
419         else
420                 mark = token_mark(ehci, hw->hw_token);
421         if (mark == '/') {      /* qh_alt_next controls qh advance? */
422                 if ((hw->hw_alt_next & QTD_MASK(ehci))
423                                 == ehci->async->hw->hw_alt_next)
424                         mark = '#';     /* blocked */
425                 else if (hw->hw_alt_next == list_end)
426                         mark = '.';     /* use hw_qtd_next */
427                 /* else alt_next points to some other qtd */
428         }
429         scratch = hc32_to_cpup(ehci, &hw->hw_info1);
430         hw_curr = (mark == '*') ? hc32_to_cpup(ehci, &hw->hw_current) : 0;
431         temp = scnprintf (next, size,
432                         "qh/%p dev%d %cs ep%d %08x %08x (%08x%c %s nak%d)",
433                         qh, scratch & 0x007f,
434                         speed_char (scratch),
435                         (scratch >> 8) & 0x000f,
436                         scratch, hc32_to_cpup(ehci, &hw->hw_info2),
437                         hc32_to_cpup(ehci, &hw->hw_token), mark,
438                         (cpu_to_hc32(ehci, QTD_TOGGLE) & hw->hw_token)
439                                 ? "data1" : "data0",
440                         (hc32_to_cpup(ehci, &hw->hw_alt_next) >> 1) & 0x0f);
441         size -= temp;
442         next += temp;
443
444         /* hc may be modifying the list as we read it ... */
445         list_for_each (entry, &qh->qtd_list) {
446                 td = list_entry (entry, struct ehci_qtd, qtd_list);
447                 scratch = hc32_to_cpup(ehci, &td->hw_token);
448                 mark = ' ';
449                 if (hw_curr == td->qtd_dma)
450                         mark = '*';
451                 else if (hw->hw_qtd_next == cpu_to_hc32(ehci, td->qtd_dma))
452                         mark = '+';
453                 else if (QTD_LENGTH (scratch)) {
454                         if (td->hw_alt_next == ehci->async->hw->hw_alt_next)
455                                 mark = '#';
456                         else if (td->hw_alt_next != list_end)
457                                 mark = '/';
458                 }
459                 temp = snprintf (next, size,
460                                 "\n\t%p%c%s len=%d %08x urb %p",
461                                 td, mark, ({ char *tmp;
462                                  switch ((scratch>>8)&0x03) {
463                                  case 0: tmp = "out"; break;
464                                  case 1: tmp = "in"; break;
465                                  case 2: tmp = "setup"; break;
466                                  default: tmp = "?"; break;
467                                  } tmp;}),
468                                 (scratch >> 16) & 0x7fff,
469                                 scratch,
470                                 td->urb);
471                 if (size < temp)
472                         temp = size;
473                 size -= temp;
474                 next += temp;
475                 if (temp == size)
476                         goto done;
477         }
478
479         temp = snprintf (next, size, "\n");
480         if (size < temp)
481                 temp = size;
482         size -= temp;
483         next += temp;
484
485 done:
486         *sizep = size;
487         *nextp = next;
488 }
489
490 static ssize_t fill_async_buffer(struct debug_buffer *buf)
491 {
492         struct usb_hcd          *hcd;
493         struct ehci_hcd         *ehci;
494         unsigned long           flags;
495         unsigned                temp, size;
496         char                    *next;
497         struct ehci_qh          *qh;
498
499         hcd = bus_to_hcd(buf->bus);
500         ehci = hcd_to_ehci (hcd);
501         next = buf->output_buf;
502         size = buf->alloc_size;
503
504         *next = 0;
505
506         /* dumps a snapshot of the async schedule.
507          * usually empty except for long-term bulk reads, or head.
508          * one QH per line, and TDs we know about
509          */
510         spin_lock_irqsave (&ehci->lock, flags);
511         for (qh = ehci->async->qh_next.qh; size > 0 && qh; qh = qh->qh_next.qh)
512                 qh_lines (ehci, qh, &next, &size);
513         if (!list_empty(&ehci->async_unlink) && size > 0) {
514                 temp = scnprintf(next, size, "\nunlink =\n");
515                 size -= temp;
516                 next += temp;
517
518                 list_for_each_entry(qh, &ehci->async_unlink, unlink_node) {
519                         if (size <= 0)
520                                 break;
521                         qh_lines(ehci, qh, &next, &size);
522                 }
523         }
524         spin_unlock_irqrestore (&ehci->lock, flags);
525
526         return strlen(buf->output_buf);
527 }
528
529 #define DBG_SCHED_LIMIT 64
530 static ssize_t fill_periodic_buffer(struct debug_buffer *buf)
531 {
532         struct usb_hcd          *hcd;
533         struct ehci_hcd         *ehci;
534         unsigned long           flags;
535         union ehci_shadow       p, *seen;
536         unsigned                temp, size, seen_count;
537         char                    *next;
538         unsigned                i;
539         __hc32                  tag;
540
541         if (!(seen = kmalloc (DBG_SCHED_LIMIT * sizeof *seen, GFP_ATOMIC)))
542                 return 0;
543         seen_count = 0;
544
545         hcd = bus_to_hcd(buf->bus);
546         ehci = hcd_to_ehci (hcd);
547         next = buf->output_buf;
548         size = buf->alloc_size;
549
550         temp = scnprintf (next, size, "size = %d\n", ehci->periodic_size);
551         size -= temp;
552         next += temp;
553
554         /* dump a snapshot of the periodic schedule.
555          * iso changes, interrupt usually doesn't.
556          */
557         spin_lock_irqsave (&ehci->lock, flags);
558         for (i = 0; i < ehci->periodic_size; i++) {
559                 p = ehci->pshadow [i];
560                 if (likely (!p.ptr))
561                         continue;
562                 tag = Q_NEXT_TYPE(ehci, ehci->periodic [i]);
563
564                 temp = scnprintf (next, size, "%4d: ", i);
565                 size -= temp;
566                 next += temp;
567
568                 do {
569                         struct ehci_qh_hw *hw;
570
571                         switch (hc32_to_cpu(ehci, tag)) {
572                         case Q_TYPE_QH:
573                                 hw = p.qh->hw;
574                                 temp = scnprintf (next, size, " qh%d-%04x/%p",
575                                                 p.qh->period,
576                                                 hc32_to_cpup(ehci,
577                                                         &hw->hw_info2)
578                                                         /* uframe masks */
579                                                         & (QH_CMASK | QH_SMASK),
580                                                 p.qh);
581                                 size -= temp;
582                                 next += temp;
583                                 /* don't repeat what follows this qh */
584                                 for (temp = 0; temp < seen_count; temp++) {
585                                         if (seen [temp].ptr != p.ptr)
586                                                 continue;
587                                         if (p.qh->qh_next.ptr) {
588                                                 temp = scnprintf (next, size,
589                                                         " ...");
590                                                 size -= temp;
591                                                 next += temp;
592                                         }
593                                         break;
594                                 }
595                                 /* show more info the first time around */
596                                 if (temp == seen_count) {
597                                         u32     scratch = hc32_to_cpup(ehci,
598                                                         &hw->hw_info1);
599                                         struct ehci_qtd *qtd;
600                                         char            *type = "";
601
602                                         /* count tds, get ep direction */
603                                         temp = 0;
604                                         list_for_each_entry (qtd,
605                                                         &p.qh->qtd_list,
606                                                         qtd_list) {
607                                                 temp++;
608                                                 switch (0x03 & (hc32_to_cpu(
609                                                         ehci,
610                                                         qtd->hw_token) >> 8)) {
611                                                 case 0: type = "out"; continue;
612                                                 case 1: type = "in"; continue;
613                                                 }
614                                         }
615
616                                         temp = scnprintf (next, size,
617                                                 " (%c%d ep%d%s "
618                                                 "[%d/%d] q%d p%d)",
619                                                 speed_char (scratch),
620                                                 scratch & 0x007f,
621                                                 (scratch >> 8) & 0x000f, type,
622                                                 p.qh->usecs, p.qh->c_usecs,
623                                                 temp,
624                                                 0x7ff & (scratch >> 16));
625
626                                         if (seen_count < DBG_SCHED_LIMIT)
627                                                 seen [seen_count++].qh = p.qh;
628                                 } else
629                                         temp = 0;
630                                 tag = Q_NEXT_TYPE(ehci, hw->hw_next);
631                                 p = p.qh->qh_next;
632                                 break;
633                         case Q_TYPE_FSTN:
634                                 temp = scnprintf (next, size,
635                                         " fstn-%8x/%p", p.fstn->hw_prev,
636                                         p.fstn);
637                                 tag = Q_NEXT_TYPE(ehci, p.fstn->hw_next);
638                                 p = p.fstn->fstn_next;
639                                 break;
640                         case Q_TYPE_ITD:
641                                 temp = scnprintf (next, size,
642                                         " itd/%p", p.itd);
643                                 tag = Q_NEXT_TYPE(ehci, p.itd->hw_next);
644                                 p = p.itd->itd_next;
645                                 break;
646                         case Q_TYPE_SITD:
647                                 temp = scnprintf (next, size,
648                                         " sitd%d-%04x/%p",
649                                         p.sitd->stream->interval,
650                                         hc32_to_cpup(ehci, &p.sitd->hw_uframe)
651                                                 & 0x0000ffff,
652                                         p.sitd);
653                                 tag = Q_NEXT_TYPE(ehci, p.sitd->hw_next);
654                                 p = p.sitd->sitd_next;
655                                 break;
656                         }
657                         size -= temp;
658                         next += temp;
659                 } while (p.ptr);
660
661                 temp = scnprintf (next, size, "\n");
662                 size -= temp;
663                 next += temp;
664         }
665         spin_unlock_irqrestore (&ehci->lock, flags);
666         kfree (seen);
667
668         return buf->alloc_size - size;
669 }
670 #undef DBG_SCHED_LIMIT
671
672 static const char *rh_state_string(struct ehci_hcd *ehci)
673 {
674         switch (ehci->rh_state) {
675         case EHCI_RH_HALTED:
676                 return "halted";
677         case EHCI_RH_SUSPENDED:
678                 return "suspended";
679         case EHCI_RH_RUNNING:
680                 return "running";
681         case EHCI_RH_STOPPING:
682                 return "stopping";
683         }
684         return "?";
685 }
686
687 static ssize_t fill_registers_buffer(struct debug_buffer *buf)
688 {
689         struct usb_hcd          *hcd;
690         struct ehci_hcd         *ehci;
691         unsigned long           flags;
692         unsigned                temp, size, i;
693         char                    *next, scratch [80];
694         static char             fmt [] = "%*s\n";
695         static char             label [] = "";
696
697         hcd = bus_to_hcd(buf->bus);
698         ehci = hcd_to_ehci (hcd);
699         next = buf->output_buf;
700         size = buf->alloc_size;
701
702         spin_lock_irqsave (&ehci->lock, flags);
703
704         if (!HCD_HW_ACCESSIBLE(hcd)) {
705                 size = scnprintf (next, size,
706                         "bus %s, device %s\n"
707                         "%s\n"
708                         "SUSPENDED (no register access)\n",
709                         hcd->self.controller->bus->name,
710                         dev_name(hcd->self.controller),
711                         hcd->product_desc);
712                 goto done;
713         }
714
715         /* Capability Registers */
716         i = HC_VERSION(ehci, ehci_readl(ehci, &ehci->caps->hc_capbase));
717         temp = scnprintf (next, size,
718                 "bus %s, device %s\n"
719                 "%s\n"
720                 "EHCI %x.%02x, rh state %s\n",
721                 hcd->self.controller->bus->name,
722                 dev_name(hcd->self.controller),
723                 hcd->product_desc,
724                 i >> 8, i & 0x0ff, rh_state_string(ehci));
725         size -= temp;
726         next += temp;
727
728 #ifdef  CONFIG_PCI
729         /* EHCI 0.96 and later may have "extended capabilities" */
730         if (hcd->self.controller->bus == &pci_bus_type) {
731                 struct pci_dev  *pdev;
732                 u32             offset, cap, cap2;
733                 unsigned        count = 256/4;
734
735                 pdev = to_pci_dev(ehci_to_hcd(ehci)->self.controller);
736                 offset = HCC_EXT_CAPS(ehci_readl(ehci,
737                                 &ehci->caps->hcc_params));
738                 while (offset && count--) {
739                         pci_read_config_dword (pdev, offset, &cap);
740                         switch (cap & 0xff) {
741                         case 1:
742                                 temp = scnprintf (next, size,
743                                         "ownership %08x%s%s\n", cap,
744                                         (cap & (1 << 24)) ? " linux" : "",
745                                         (cap & (1 << 16)) ? " firmware" : "");
746                                 size -= temp;
747                                 next += temp;
748
749                                 offset += 4;
750                                 pci_read_config_dword (pdev, offset, &cap2);
751                                 temp = scnprintf (next, size,
752                                         "SMI sts/enable 0x%08x\n", cap2);
753                                 size -= temp;
754                                 next += temp;
755                                 break;
756                         case 0:         /* illegal reserved capability */
757                                 cap = 0;
758                                 /* FALLTHROUGH */
759                         default:                /* unknown */
760                                 break;
761                         }
762                         temp = (cap >> 8) & 0xff;
763                 }
764         }
765 #endif
766
767         // FIXME interpret both types of params
768         i = ehci_readl(ehci, &ehci->caps->hcs_params);
769         temp = scnprintf (next, size, "structural params 0x%08x\n", i);
770         size -= temp;
771         next += temp;
772
773         i = ehci_readl(ehci, &ehci->caps->hcc_params);
774         temp = scnprintf (next, size, "capability params 0x%08x\n", i);
775         size -= temp;
776         next += temp;
777
778         /* Operational Registers */
779         temp = dbg_status_buf (scratch, sizeof scratch, label,
780                         ehci_readl(ehci, &ehci->regs->status));
781         temp = scnprintf (next, size, fmt, temp, scratch);
782         size -= temp;
783         next += temp;
784
785         temp = dbg_command_buf (scratch, sizeof scratch, label,
786                         ehci_readl(ehci, &ehci->regs->command));
787         temp = scnprintf (next, size, fmt, temp, scratch);
788         size -= temp;
789         next += temp;
790
791         temp = dbg_intr_buf (scratch, sizeof scratch, label,
792                         ehci_readl(ehci, &ehci->regs->intr_enable));
793         temp = scnprintf (next, size, fmt, temp, scratch);
794         size -= temp;
795         next += temp;
796
797         temp = scnprintf (next, size, "uframe %04x\n",
798                         ehci_read_frame_index(ehci));
799         size -= temp;
800         next += temp;
801
802         for (i = 1; i <= HCS_N_PORTS (ehci->hcs_params); i++) {
803                 temp = dbg_port_buf (scratch, sizeof scratch, label, i,
804                                 ehci_readl(ehci,
805                                         &ehci->regs->port_status[i - 1]));
806                 temp = scnprintf (next, size, fmt, temp, scratch);
807                 size -= temp;
808                 next += temp;
809                 if (i == HCS_DEBUG_PORT(ehci->hcs_params) && ehci->debug) {
810                         temp = scnprintf (next, size,
811                                         "    debug control %08x\n",
812                                         ehci_readl(ehci,
813                                                 &ehci->debug->control));
814                         size -= temp;
815                         next += temp;
816                 }
817         }
818
819         if (!list_empty(&ehci->async_unlink)) {
820                 temp = scnprintf(next, size, "async unlink qh %p\n",
821                                 list_first_entry(&ehci->async_unlink,
822                                                 struct ehci_qh, unlink_node));
823                 size -= temp;
824                 next += temp;
825         }
826
827 #ifdef EHCI_STATS
828         temp = scnprintf (next, size,
829                 "irq normal %ld err %ld iaa %ld (lost %ld)\n",
830                 ehci->stats.normal, ehci->stats.error, ehci->stats.iaa,
831                 ehci->stats.lost_iaa);
832         size -= temp;
833         next += temp;
834
835         temp = scnprintf (next, size, "complete %ld unlink %ld\n",
836                 ehci->stats.complete, ehci->stats.unlink);
837         size -= temp;
838         next += temp;
839 #endif
840
841 done:
842         spin_unlock_irqrestore (&ehci->lock, flags);
843
844         return buf->alloc_size - size;
845 }
846
847 static struct debug_buffer *alloc_buffer(struct usb_bus *bus,
848                                 ssize_t (*fill_func)(struct debug_buffer *))
849 {
850         struct debug_buffer *buf;
851
852         buf = kzalloc(sizeof(struct debug_buffer), GFP_KERNEL);
853
854         if (buf) {
855                 buf->bus = bus;
856                 buf->fill_func = fill_func;
857                 mutex_init(&buf->mutex);
858                 buf->alloc_size = PAGE_SIZE;
859         }
860
861         return buf;
862 }
863
864 static int fill_buffer(struct debug_buffer *buf)
865 {
866         int ret = 0;
867
868         if (!buf->output_buf)
869                 buf->output_buf = vmalloc(buf->alloc_size);
870
871         if (!buf->output_buf) {
872                 ret = -ENOMEM;
873                 goto out;
874         }
875
876         ret = buf->fill_func(buf);
877
878         if (ret >= 0) {
879                 buf->count = ret;
880                 ret = 0;
881         }
882
883 out:
884         return ret;
885 }
886
887 static ssize_t debug_output(struct file *file, char __user *user_buf,
888                             size_t len, loff_t *offset)
889 {
890         struct debug_buffer *buf = file->private_data;
891         int ret = 0;
892
893         mutex_lock(&buf->mutex);
894         if (buf->count == 0) {
895                 ret = fill_buffer(buf);
896                 if (ret != 0) {
897                         mutex_unlock(&buf->mutex);
898                         goto out;
899                 }
900         }
901         mutex_unlock(&buf->mutex);
902
903         ret = simple_read_from_buffer(user_buf, len, offset,
904                                       buf->output_buf, buf->count);
905
906 out:
907         return ret;
908
909 }
910
911 static int debug_close(struct inode *inode, struct file *file)
912 {
913         struct debug_buffer *buf = file->private_data;
914
915         if (buf) {
916                 vfree(buf->output_buf);
917                 kfree(buf);
918         }
919
920         return 0;
921 }
922 static int debug_async_open(struct inode *inode, struct file *file)
923 {
924         file->private_data = alloc_buffer(inode->i_private, fill_async_buffer);
925
926         return file->private_data ? 0 : -ENOMEM;
927 }
928
929 static int debug_periodic_open(struct inode *inode, struct file *file)
930 {
931         struct debug_buffer *buf;
932         buf = alloc_buffer(inode->i_private, fill_periodic_buffer);
933         if (!buf)
934                 return -ENOMEM;
935
936         buf->alloc_size = (sizeof(void *) == 4 ? 6 : 8)*PAGE_SIZE;
937         file->private_data = buf;
938         return 0;
939 }
940
941 static int debug_registers_open(struct inode *inode, struct file *file)
942 {
943         file->private_data = alloc_buffer(inode->i_private,
944                                           fill_registers_buffer);
945
946         return file->private_data ? 0 : -ENOMEM;
947 }
948
949 static inline void create_debug_files (struct ehci_hcd *ehci)
950 {
951         struct usb_bus *bus = &ehci_to_hcd(ehci)->self;
952
953         ehci->debug_dir = debugfs_create_dir(bus->bus_name, ehci_debug_root);
954         if (!ehci->debug_dir)
955                 return;
956
957         if (!debugfs_create_file("async", S_IRUGO, ehci->debug_dir, bus,
958                                                 &debug_async_fops))
959                 goto file_error;
960
961         if (!debugfs_create_file("periodic", S_IRUGO, ehci->debug_dir, bus,
962                                                 &debug_periodic_fops))
963                 goto file_error;
964
965         if (!debugfs_create_file("registers", S_IRUGO, ehci->debug_dir, bus,
966                                                     &debug_registers_fops))
967                 goto file_error;
968
969         return;
970
971 file_error:
972         debugfs_remove_recursive(ehci->debug_dir);
973 }
974
975 static inline void remove_debug_files (struct ehci_hcd *ehci)
976 {
977         debugfs_remove_recursive(ehci->debug_dir);
978 }
979
980 #endif /* STUB_DEBUG_FILES */