drivers/usb/host/uhci-debug.c

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