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