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