linux/drivers/usb/host/ehci-dbg.c
<<
>>
Prefs
   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 */
  27static 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
  61static 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 * */
  71static 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
 100static inline void dbg_hcc_params (struct ehci_hcd *ehci, char *label) {}
 101
 102#endif
 103
 104#ifdef  DEBUG
 105
 106static void __maybe_unused
 107dbg_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
 122static void __maybe_unused
 123dbg_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
 132static void __maybe_unused
 133dbg_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
 163static void __maybe_unused
 164dbg_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
 178static int __maybe_unused
 179dbg_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
 198static int __maybe_unused
 199dbg_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
 214static const char *const fls_strings [] =
 215    { "1024", "512", "256", "??" };
 216
 217static int
 218dbg_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
 242static int
 243dbg_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
 284static inline void __maybe_unused
 285dbg_qh (char *label, struct ehci_hcd *ehci, struct ehci_qh *qh)
 286{}
 287
 288static inline int __maybe_unused
 289dbg_status_buf (char *buf, unsigned len, const char *label, u32 status)
 290{ return 0; }
 291
 292static inline int __maybe_unused
 293dbg_command_buf (char *buf, unsigned len, const char *label, u32 command)
 294{ return 0; }
 295
 296static inline int __maybe_unused
 297dbg_intr_buf (char *buf, unsigned len, const char *label, u32 enable)
 298{ return 0; }
 299
 300static inline int __maybe_unused
 301dbg_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
 329static inline void create_debug_files (struct ehci_hcd *bus) { }
 330static inline void remove_debug_files (struct ehci_hcd *bus) { }
 331
 332#else
 333
 334/* troubleshooting help: expose state in debugfs */
 335
 336static int debug_async_open(struct inode *, struct file *);
 337static int debug_periodic_open(struct inode *, struct file *);
 338static int debug_registers_open(struct inode *, struct file *);
 339static int debug_async_open(struct inode *, struct file *);
 340
 341static ssize_t debug_output(struct file*, char __user*, size_t, loff_t*);
 342static int debug_close(struct inode *, struct file *);
 343
 344static 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};
 351static 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};
 358static 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
 366static struct dentry *ehci_debug_root;
 367
 368struct 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
 385static 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
 399static 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
 485done:
 486        *sizep = size;
 487        *nextp = next;
 488}
 489
 490static 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 (ehci->async_unlink && size > 0) {
 514                temp = scnprintf(next, size, "\nunlink =\n");
 515                size -= temp;
 516                next += temp;
 517
 518                for (qh = ehci->async_unlink; size > 0 && qh;
 519                                qh = qh->unlink_next)
 520                        qh_lines (ehci, qh, &next, &size);
 521        }
 522        spin_unlock_irqrestore (&ehci->lock, flags);
 523
 524        return strlen(buf->output_buf);
 525}
 526
 527#define DBG_SCHED_LIMIT 64
 528static ssize_t fill_periodic_buffer(struct debug_buffer *buf)
 529{
 530        struct usb_hcd          *hcd;
 531        struct ehci_hcd         *ehci;
 532        unsigned long           flags;
 533        union ehci_shadow       p, *seen;
 534        unsigned                temp, size, seen_count;
 535        char                    *next;
 536        unsigned                i;
 537        __hc32                  tag;
 538
 539        if (!(seen = kmalloc (DBG_SCHED_LIMIT * sizeof *seen, GFP_ATOMIC)))
 540                return 0;
 541        seen_count = 0;
 542
 543        hcd = bus_to_hcd(buf->bus);
 544        ehci = hcd_to_ehci (hcd);
 545        next = buf->output_buf;
 546        size = buf->alloc_size;
 547
 548        temp = scnprintf (next, size, "size = %d\n", ehci->periodic_size);
 549        size -= temp;
 550        next += temp;
 551
 552        /* dump a snapshot of the periodic schedule.
 553         * iso changes, interrupt usually doesn't.
 554         */
 555        spin_lock_irqsave (&ehci->lock, flags);
 556        for (i = 0; i < ehci->periodic_size; i++) {
 557                p = ehci->pshadow [i];
 558                if (likely (!p.ptr))
 559                        continue;
 560                tag = Q_NEXT_TYPE(ehci, ehci->periodic [i]);
 561
 562                temp = scnprintf (next, size, "%4d: ", i);
 563                size -= temp;
 564                next += temp;
 565
 566                do {
 567                        struct ehci_qh_hw *hw;
 568
 569                        switch (hc32_to_cpu(ehci, tag)) {
 570                        case Q_TYPE_QH:
 571                                hw = p.qh->hw;
 572                                temp = scnprintf (next, size, " qh%d-%04x/%p",
 573                                                p.qh->period,
 574                                                hc32_to_cpup(ehci,
 575                                                        &hw->hw_info2)
 576                                                        /* uframe masks */
 577                                                        & (QH_CMASK | QH_SMASK),
 578                                                p.qh);
 579                                size -= temp;
 580                                next += temp;
 581                                /* don't repeat what follows this qh */
 582                                for (temp = 0; temp < seen_count; temp++) {
 583                                        if (seen [temp].ptr != p.ptr)
 584                                                continue;
 585                                        if (p.qh->qh_next.ptr) {
 586                                                temp = scnprintf (next, size,
 587                                                        " ...");
 588                                                size -= temp;
 589                                                next += temp;
 590                                        }
 591                                        break;
 592                                }
 593                                /* show more info the first time around */
 594                                if (temp == seen_count) {
 595                                        u32     scratch = hc32_to_cpup(ehci,
 596                                                        &hw->hw_info1);
 597                                        struct ehci_qtd *qtd;
 598                                        char            *type = "";
 599
 600                                        /* count tds, get ep direction */
 601                                        temp = 0;
 602                                        list_for_each_entry (qtd,
 603                                                        &p.qh->qtd_list,
 604                                                        qtd_list) {
 605                                                temp++;
 606                                                switch (0x03 & (hc32_to_cpu(
 607                                                        ehci,
 608                                                        qtd->hw_token) >> 8)) {
 609                                                case 0: type = "out"; continue;
 610                                                case 1: type = "in"; continue;
 611                                                }
 612                                        }
 613
 614                                        temp = scnprintf (next, size,
 615                                                " (%c%d ep%d%s "
 616                                                "[%d/%d] q%d p%d)",
 617                                                speed_char (scratch),
 618                                                scratch & 0x007f,
 619                                                (scratch >> 8) & 0x000f, type,
 620                                                p.qh->usecs, p.qh->c_usecs,
 621                                                temp,
 622                                                0x7ff & (scratch >> 16));
 623
 624                                        if (seen_count < DBG_SCHED_LIMIT)
 625                                                seen [seen_count++].qh = p.qh;
 626                                } else
 627                                        temp = 0;
 628                                tag = Q_NEXT_TYPE(ehci, hw->hw_next);
 629                                p = p.qh->qh_next;
 630                                break;
 631                        case Q_TYPE_FSTN:
 632                                temp = scnprintf (next, size,
 633                                        " fstn-%8x/%p", p.fstn->hw_prev,
 634                                        p.fstn);
 635                                tag = Q_NEXT_TYPE(ehci, p.fstn->hw_next);
 636                                p = p.fstn->fstn_next;
 637                                break;
 638                        case Q_TYPE_ITD:
 639                                temp = scnprintf (next, size,
 640                                        " itd/%p", p.itd);
 641                                tag = Q_NEXT_TYPE(ehci, p.itd->hw_next);
 642                                p = p.itd->itd_next;
 643                                break;
 644                        case Q_TYPE_SITD:
 645                                temp = scnprintf (next, size,
 646                                        " sitd%d-%04x/%p",
 647                                        p.sitd->stream->interval,
 648                                        hc32_to_cpup(ehci, &p.sitd->hw_uframe)
 649                                                & 0x0000ffff,
 650                                        p.sitd);
 651                                tag = Q_NEXT_TYPE(ehci, p.sitd->hw_next);
 652                                p = p.sitd->sitd_next;
 653                                break;
 654                        }
 655                        size -= temp;
 656                        next += temp;
 657                } while (p.ptr);
 658
 659                temp = scnprintf (next, size, "\n");
 660                size -= temp;
 661                next += temp;
 662        }
 663        spin_unlock_irqrestore (&ehci->lock, flags);
 664        kfree (seen);
 665
 666        return buf->alloc_size - size;
 667}
 668#undef DBG_SCHED_LIMIT
 669
 670static const char *rh_state_string(struct ehci_hcd *ehci)
 671{
 672        switch (ehci->rh_state) {
 673        case EHCI_RH_HALTED:
 674                return "halted";
 675        case EHCI_RH_SUSPENDED:
 676                return "suspended";
 677        case EHCI_RH_RUNNING:
 678                return "running";
 679        case EHCI_RH_STOPPING:
 680                return "stopping";
 681        }
 682        return "?";
 683}
 684
 685static ssize_t fill_registers_buffer(struct debug_buffer *buf)
 686{
 687        struct usb_hcd          *hcd;
 688        struct ehci_hcd         *ehci;
 689        unsigned long           flags;
 690        unsigned                temp, size, i;
 691        char                    *next, scratch [80];
 692        static char             fmt [] = "%*s\n";
 693        static char             label [] = "";
 694
 695        hcd = bus_to_hcd(buf->bus);
 696        ehci = hcd_to_ehci (hcd);
 697        next = buf->output_buf;
 698        size = buf->alloc_size;
 699
 700        spin_lock_irqsave (&ehci->lock, flags);
 701
 702        if (!HCD_HW_ACCESSIBLE(hcd)) {
 703                size = scnprintf (next, size,
 704                        "bus %s, device %s\n"
 705                        "%s\n"
 706                        "SUSPENDED (no register access)\n",
 707                        hcd->self.controller->bus->name,
 708                        dev_name(hcd->self.controller),
 709                        hcd->product_desc);
 710                goto done;
 711        }
 712
 713        /* Capability Registers */
 714        i = HC_VERSION(ehci, ehci_readl(ehci, &ehci->caps->hc_capbase));
 715        temp = scnprintf (next, size,
 716                "bus %s, device %s\n"
 717                "%s\n"
 718                "EHCI %x.%02x, rh state %s\n",
 719                hcd->self.controller->bus->name,
 720                dev_name(hcd->self.controller),
 721                hcd->product_desc,
 722                i >> 8, i & 0x0ff, rh_state_string(ehci));
 723        size -= temp;
 724        next += temp;
 725
 726#ifdef  CONFIG_PCI
 727        /* EHCI 0.96 and later may have "extended capabilities" */
 728        if (hcd->self.controller->bus == &pci_bus_type) {
 729                struct pci_dev  *pdev;
 730                u32             offset, cap, cap2;
 731                unsigned        count = 256/4;
 732
 733                pdev = to_pci_dev(ehci_to_hcd(ehci)->self.controller);
 734                offset = HCC_EXT_CAPS(ehci_readl(ehci,
 735                                &ehci->caps->hcc_params));
 736                while (offset && count--) {
 737                        pci_read_config_dword (pdev, offset, &cap);
 738                        switch (cap & 0xff) {
 739                        case 1:
 740                                temp = scnprintf (next, size,
 741                                        "ownership %08x%s%s\n", cap,
 742                                        (cap & (1 << 24)) ? " linux" : "",
 743                                        (cap & (1 << 16)) ? " firmware" : "");
 744                                size -= temp;
 745                                next += temp;
 746
 747                                offset += 4;
 748                                pci_read_config_dword (pdev, offset, &cap2);
 749                                temp = scnprintf (next, size,
 750                                        "SMI sts/enable 0x%08x\n", cap2);
 751                                size -= temp;
 752                                next += temp;
 753                                break;
 754                        case 0:         /* illegal reserved capability */
 755                                cap = 0;
 756                                /* FALLTHROUGH */
 757                        default:                /* unknown */
 758                                break;
 759                        }
 760                        temp = (cap >> 8) & 0xff;
 761                }
 762        }
 763#endif
 764
 765        // FIXME interpret both types of params
 766        i = ehci_readl(ehci, &ehci->caps->hcs_params);
 767        temp = scnprintf (next, size, "structural params 0x%08x\n", i);
 768        size -= temp;
 769        next += temp;
 770
 771        i = ehci_readl(ehci, &ehci->caps->hcc_params);
 772        temp = scnprintf (next, size, "capability params 0x%08x\n", i);
 773        size -= temp;
 774        next += temp;
 775
 776        /* Operational Registers */
 777        temp = dbg_status_buf (scratch, sizeof scratch, label,
 778                        ehci_readl(ehci, &ehci->regs->status));
 779        temp = scnprintf (next, size, fmt, temp, scratch);
 780        size -= temp;
 781        next += temp;
 782
 783        temp = dbg_command_buf (scratch, sizeof scratch, label,
 784                        ehci_readl(ehci, &ehci->regs->command));
 785        temp = scnprintf (next, size, fmt, temp, scratch);
 786        size -= temp;
 787        next += temp;
 788
 789        temp = dbg_intr_buf (scratch, sizeof scratch, label,
 790                        ehci_readl(ehci, &ehci->regs->intr_enable));
 791        temp = scnprintf (next, size, fmt, temp, scratch);
 792        size -= temp;
 793        next += temp;
 794
 795        temp = scnprintf (next, size, "uframe %04x\n",
 796                        ehci_read_frame_index(ehci));
 797        size -= temp;
 798        next += temp;
 799
 800        for (i = 1; i <= HCS_N_PORTS (ehci->hcs_params); i++) {
 801                temp = dbg_port_buf (scratch, sizeof scratch, label, i,
 802                                ehci_readl(ehci,
 803                                        &ehci->regs->port_status[i - 1]));
 804                temp = scnprintf (next, size, fmt, temp, scratch);
 805                size -= temp;
 806                next += temp;
 807                if (i == HCS_DEBUG_PORT(ehci->hcs_params) && ehci->debug) {
 808                        temp = scnprintf (next, size,
 809                                        "    debug control %08x\n",
 810                                        ehci_readl(ehci,
 811                                                &ehci->debug->control));
 812                        size -= temp;
 813                        next += temp;
 814                }
 815        }
 816
 817        if (ehci->async_unlink) {
 818                temp = scnprintf(next, size, "async unlink qh %p\n",
 819                                ehci->async_unlink);
 820                size -= temp;
 821                next += temp;
 822        }
 823
 824#ifdef EHCI_STATS
 825        temp = scnprintf (next, size,
 826                "irq normal %ld err %ld iaa %ld (lost %ld)\n",
 827                ehci->stats.normal, ehci->stats.error, ehci->stats.iaa,
 828                ehci->stats.lost_iaa);
 829        size -= temp;
 830        next += temp;
 831
 832        temp = scnprintf (next, size, "complete %ld unlink %ld\n",
 833                ehci->stats.complete, ehci->stats.unlink);
 834        size -= temp;
 835        next += temp;
 836#endif
 837
 838done:
 839        spin_unlock_irqrestore (&ehci->lock, flags);
 840
 841        return buf->alloc_size - size;
 842}
 843
 844static struct debug_buffer *alloc_buffer(struct usb_bus *bus,
 845                                ssize_t (*fill_func)(struct debug_buffer *))
 846{
 847        struct debug_buffer *buf;
 848
 849        buf = kzalloc(sizeof(struct debug_buffer), GFP_KERNEL);
 850
 851        if (buf) {
 852                buf->bus = bus;
 853                buf->fill_func = fill_func;
 854                mutex_init(&buf->mutex);
 855                buf->alloc_size = PAGE_SIZE;
 856        }
 857
 858        return buf;
 859}
 860
 861static int fill_buffer(struct debug_buffer *buf)
 862{
 863        int ret = 0;
 864
 865        if (!buf->output_buf)
 866                buf->output_buf = vmalloc(buf->alloc_size);
 867
 868        if (!buf->output_buf) {
 869                ret = -ENOMEM;
 870                goto out;
 871        }
 872
 873        ret = buf->fill_func(buf);
 874
 875        if (ret >= 0) {
 876                buf->count = ret;
 877                ret = 0;
 878        }
 879
 880out:
 881        return ret;
 882}
 883
 884static ssize_t debug_output(struct file *file, char __user *user_buf,
 885                            size_t len, loff_t *offset)
 886{
 887        struct debug_buffer *buf = file->private_data;
 888        int ret = 0;
 889
 890        mutex_lock(&buf->mutex);
 891        if (buf->count == 0) {
 892                ret = fill_buffer(buf);
 893                if (ret != 0) {
 894                        mutex_unlock(&buf->mutex);
 895                        goto out;
 896                }
 897        }
 898        mutex_unlock(&buf->mutex);
 899
 900        ret = simple_read_from_buffer(user_buf, len, offset,
 901                                      buf->output_buf, buf->count);
 902
 903out:
 904        return ret;
 905
 906}
 907
 908static int debug_close(struct inode *inode, struct file *file)
 909{
 910        struct debug_buffer *buf = file->private_data;
 911
 912        if (buf) {
 913                vfree(buf->output_buf);
 914                kfree(buf);
 915        }
 916
 917        return 0;
 918}
 919static int debug_async_open(struct inode *inode, struct file *file)
 920{
 921        file->private_data = alloc_buffer(inode->i_private, fill_async_buffer);
 922
 923        return file->private_data ? 0 : -ENOMEM;
 924}
 925
 926static int debug_periodic_open(struct inode *inode, struct file *file)
 927{
 928        struct debug_buffer *buf;
 929        buf = alloc_buffer(inode->i_private, fill_periodic_buffer);
 930        if (!buf)
 931                return -ENOMEM;
 932
 933        buf->alloc_size = (sizeof(void *) == 4 ? 6 : 8)*PAGE_SIZE;
 934        file->private_data = buf;
 935        return 0;
 936}
 937
 938static int debug_registers_open(struct inode *inode, struct file *file)
 939{
 940        file->private_data = alloc_buffer(inode->i_private,
 941                                          fill_registers_buffer);
 942
 943        return file->private_data ? 0 : -ENOMEM;
 944}
 945
 946static inline void create_debug_files (struct ehci_hcd *ehci)
 947{
 948        struct usb_bus *bus = &ehci_to_hcd(ehci)->self;
 949
 950        ehci->debug_dir = debugfs_create_dir(bus->bus_name, ehci_debug_root);
 951        if (!ehci->debug_dir)
 952                return;
 953
 954        if (!debugfs_create_file("async", S_IRUGO, ehci->debug_dir, bus,
 955                                                &debug_async_fops))
 956                goto file_error;
 957
 958        if (!debugfs_create_file("periodic", S_IRUGO, ehci->debug_dir, bus,
 959                                                &debug_periodic_fops))
 960                goto file_error;
 961
 962        if (!debugfs_create_file("registers", S_IRUGO, ehci->debug_dir, bus,
 963                                                    &debug_registers_fops))
 964                goto file_error;
 965
 966        return;
 967
 968file_error:
 969        debugfs_remove_recursive(ehci->debug_dir);
 970}
 971
 972static inline void remove_debug_files (struct ehci_hcd *ehci)
 973{
 974        debugfs_remove_recursive(ehci->debug_dir);
 975}
 976
 977#endif /* STUB_DEBUG_FILES */
 978