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/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)
  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", urbp->urb->actual_length);
 122
 123         if (urbp->urb->status != -EINPROGRESS)
 124                 out += sprintf(out, " Status=%d", urbp->urb->status);
 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
 148 static int uhci_show_qh(struct uhci_qh *qh, char *buf, int len, int space)
 149 {
 150         char *out = buf;
 151         int i, nurbs;
 152         __le32 element = qh_element(qh);
 153         char *qtype;
 154
 155         /* Try to make sure there's enough memory */
 156         if (len < 80 * 7)
 157                 return 0;
 158
 159         switch (qh->type) {
 160         case USB_ENDPOINT_XFER_ISOC: qtype = "ISO"; break;
 161         case USB_ENDPOINT_XFER_INT: qtype = "INT"; break;
 162         case USB_ENDPOINT_XFER_BULK: qtype = "BLK"; break;
 163         case USB_ENDPOINT_XFER_CONTROL: qtype = "CTL"; break;
 164         default: qtype = "Skel" ; break;
 165         }
 166
 167         out += sprintf(out, "%*s[%p] %s QH link (%08x) element (%08x)\n",
 168                         space, "", qh, qtype,
 169                         le32_to_cpu(qh->link), le32_to_cpu(element));
 170         if (qh->type == USB_ENDPOINT_XFER_ISOC)
 171                 out += sprintf(out, "%*s    period %d phase %d load %d us, "
 172                                 "frame %x desc [%p]\n",
 173                                 space, "", qh->period, qh->phase, qh->load,
 174                                 qh->iso_frame, qh->iso_packet_desc);
 175         else if (qh->type == USB_ENDPOINT_XFER_INT)
 176                 out += sprintf(out, "%*s    period %d phase %d load %d us\n",
 177                                 space, "", qh->period, qh->phase, qh->load);
 178
 179         if (element & UHCI_PTR_QH)
 180                 out += sprintf(out, "%*s  Element points to QH (bug?)\n", space, "");
 181
 182         if (element & UHCI_PTR_DEPTH)
 183                 out += sprintf(out, "%*s  Depth traverse\n", space, "");
 184
 185         if (element & cpu_to_le32(8))
 186                 out += sprintf(out, "%*s  Bit 3 set (bug?)\n", space, "");
 187
 188         if (!(element & ~(UHCI_PTR_QH | UHCI_PTR_DEPTH)))
 189                 out += sprintf(out, "%*s  Element is NULL (bug?)\n", space, "");
 190
 191         if (list_empty(&qh->queue)) {
 192                 out += sprintf(out, "%*s  queue is empty\n", space, "");
 193         } else {
 194                 struct urb_priv *urbp = list_entry(qh->queue.next,
 195                                 struct urb_priv, node);
 196                 struct uhci_td *td = list_entry(urbp->td_list.next,
 197                                 struct uhci_td, list);
 198
 199                 if (element != LINK_TO_TD(td))
 200                         out += sprintf(out, "%*s Element != First TD\n",
 201                                         space, "");
 202                 i = nurbs = 0;
 203                 list_for_each_entry(urbp, &qh->queue, node) {
 204                         if (++i <= 10)
 205                                 out += uhci_show_urbp(urbp, out,
 206                                                 len - (out - buf), space + 2);
 207                         else
 208                                 ++nurbs;
 209                 }
 210                 if (nurbs > 0)
 211                         out += sprintf(out, "%*s Skipped %d URBs\n",
 212                                         space, "", nurbs);
 213         }
 214
 215         if (qh->dummy_td) {
 216                 out += sprintf(out, "%*s  Dummy TD\n", space, "");
 217                 out += uhci_show_td(qh->dummy_td, out, len - (out - buf), 0);
 218         }
 219
 220         return out - buf;
 221 }
 222
 223 static int uhci_show_sc(int port, unsigned short status, char *buf, int len)
 224 {
 225         char *out = buf;
 226
 227         /* Try to make sure there's enough memory */
 228         if (len < 160)
 229                 return 0;
 230
 231         out += sprintf(out, "  stat%d     =     %04x  %s%s%s%s%s%s%s%s%s%s\n",
 232                 port,
 233                 status,
 234                 (status & USBPORTSC_SUSP) ?     " Suspend" : "",
 235                 (status & USBPORTSC_OCC) ?      " OverCurrentChange" : "",
 236                 (status & USBPORTSC_OC) ?       " OverCurrent" : "",
 237                 (status & USBPORTSC_PR) ?       " Reset" : "",
 238                 (status & USBPORTSC_LSDA) ?     " LowSpeed" : "",
 239                 (status & USBPORTSC_RD) ?       " ResumeDetect" : "",
 240                 (status & USBPORTSC_PEC) ?      " EnableChange" : "",
 241                 (status & USBPORTSC_PE) ?       " Enabled" : "",
 242                 (status & USBPORTSC_CSC) ?      " ConnectChange" : "",
 243                 (status & USBPORTSC_CCS) ?      " Connected" : "");
 244
 245         return out - buf;
 246 }
 247
 248 static int uhci_show_root_hub_state(struct uhci_hcd *uhci, char *buf, int len)
 249 {
 250         char *out = buf;
 251         char *rh_state;
 252
 253         /* Try to make sure there's enough memory */
 254         if (len < 60)
 255                 return 0;
 256
 257         switch (uhci->rh_state) {
 258             case UHCI_RH_RESET:
 259                 rh_state = "reset";             break;
 260             case UHCI_RH_SUSPENDED:
 261                 rh_state = "suspended";         break;
 262             case UHCI_RH_AUTO_STOPPED:
 263                 rh_state = "auto-stopped";      break;
 264             case UHCI_RH_RESUMING:
 265                 rh_state = "resuming";          break;
 266             case UHCI_RH_SUSPENDING:
 267                 rh_state = "suspending";        break;
 268             case UHCI_RH_RUNNING:
 269                 rh_state = "running";           break;
 270             case UHCI_RH_RUNNING_NODEVS:
 271                 rh_state = "running, no devs";  break;
 272             default:
 273                 rh_state = "?";                 break;
 274         }
 275         out += sprintf(out, "Root-hub state: %s   FSBR: %d\n",
 276                         rh_state, uhci->fsbr_is_on);
 277         return out - buf;
 278 }
 279
 280 static int uhci_show_status(struct uhci_hcd *uhci, char *buf, int len)
 281 {
 282         char *out = buf;
 283         unsigned long io_addr = uhci->io_addr;
 284         unsigned short usbcmd, usbstat, usbint, usbfrnum;
 285         unsigned int flbaseadd;
 286         unsigned char sof;
 287         unsigned short portsc1, portsc2;
 288
 289         /* Try to make sure there's enough memory */
 290         if (len < 80 * 9)
 291                 return 0;
 292
 293         usbcmd    = inw(io_addr + 0);
 294         usbstat   = inw(io_addr + 2);
 295         usbint    = inw(io_addr + 4);
 296         usbfrnum  = inw(io_addr + 6);
 297         flbaseadd = inl(io_addr + 8);
 298         sof       = inb(io_addr + 12);
 299         portsc1   = inw(io_addr + 16);
 300         portsc2   = inw(io_addr + 18);
 301
 302         out += sprintf(out, "  usbcmd    =     %04x   %s%s%s%s%s%s%s%s\n",
 303                 usbcmd,
 304                 (usbcmd & USBCMD_MAXP) ?    "Maxp64 " : "Maxp32 ",
 305                 (usbcmd & USBCMD_CF) ?      "CF " : "",
 306                 (usbcmd & USBCMD_SWDBG) ?   "SWDBG " : "",
 307                 (usbcmd & USBCMD_FGR) ?     "FGR " : "",
 308                 (usbcmd & USBCMD_EGSM) ?    "EGSM " : "",
 309                 (usbcmd & USBCMD_GRESET) ?  "GRESET " : "",
 310                 (usbcmd & USBCMD_HCRESET) ? "HCRESET " : "",
 311                 (usbcmd & USBCMD_RS) ?      "RS " : "");
 312
 313         out += sprintf(out, "  usbstat   =     %04x   %s%s%s%s%s%s\n",
 314                 usbstat,
 315                 (usbstat & USBSTS_HCH) ?    "HCHalted " : "",
 316                 (usbstat & USBSTS_HCPE) ?   "HostControllerProcessError " : "",
 317                 (usbstat & USBSTS_HSE) ?    "HostSystemError " : "",
 318                 (usbstat & USBSTS_RD) ?     "ResumeDetect " : "",
 319                 (usbstat & USBSTS_ERROR) ?  "USBError " : "",
 320                 (usbstat & USBSTS_USBINT) ? "USBINT " : "");
 321
 322         out += sprintf(out, "  usbint    =     %04x\n", usbint);
 323         out += sprintf(out, "  usbfrnum  =   (%d)%03x\n", (usbfrnum >> 10) & 1,
 324                 0xfff & (4*(unsigned int)usbfrnum));
 325         out += sprintf(out, "  flbaseadd = %08x\n", flbaseadd);
 326         out += sprintf(out, "  sof       =       %02x\n", sof);
 327         out += uhci_show_sc(1, portsc1, out, len - (out - buf));
 328         out += uhci_show_sc(2, portsc2, out, len - (out - buf));
 329         out += sprintf(out, "Most recent frame: %x (%d)   "
 330                         "Last ISO frame: %x (%d)\n",
 331                         uhci->frame_number, uhci->frame_number & 1023,
 332                         uhci->last_iso_frame, uhci->last_iso_frame & 1023);
 333
 334         return out - buf;
 335 }
 336
 337 static int uhci_sprint_schedule(struct uhci_hcd *uhci, char *buf, int len)
 338 {
 339         char *out = buf;
 340         int i, j;
 341         struct uhci_qh *qh;
 342         struct uhci_td *td;
 343         struct list_head *tmp, *head;
 344         int nframes, nerrs;
 345         __le32 link;
 346
 347         static const char * const qh_names[] = {
 348                 "unlink", "iso", "int128", "int64", "int32", "int16",
 349                 "int8", "int4", "int2", "async", "term"
 350         };
 351
 352         out += uhci_show_root_hub_state(uhci, out, len - (out - buf));
 353         out += sprintf(out, "HC status\n");
 354         out += uhci_show_status(uhci, out, len - (out - buf));
 355
 356         out += sprintf(out, "Periodic load table\n");
 357         for (i = 0; i < MAX_PHASE; ++i) {
 358                 out += sprintf(out, "\t%d", uhci->load[i]);
 359                 if (i % 8 == 7)
 360                         *out++ = '\n';
 361         }
 362         out += sprintf(out, "Total: %d, #INT: %d, #ISO: %d\n",
 363                         uhci->total_load,
 364                         uhci_to_hcd(uhci)->self.bandwidth_int_reqs,
 365                         uhci_to_hcd(uhci)->self.bandwidth_isoc_reqs);
 366         if (debug <= 1)
 367                 return out - buf;
 368
 369         out += sprintf(out, "Frame List\n");
 370         nframes = 10;
 371         nerrs = 0;
 372         for (i = 0; i < UHCI_NUMFRAMES; ++i) {
 373                 __le32 qh_dma;
 374
 375                 j = 0;
 376                 td = uhci->frame_cpu[i];
 377                 link = uhci->frame[i];
 378                 if (!td)
 379                         goto check_link;
 380
 381                 if (nframes > 0) {
 382                         out += sprintf(out, "- Frame %d -> (%08x)\n",
 383                                         i, le32_to_cpu(link));
 384                         j = 1;
 385                 }
 386
 387                 head = &td->fl_list;
 388                 tmp = head;
 389                 do {
 390                         td = list_entry(tmp, struct uhci_td, fl_list);
 391                         tmp = tmp->next;
 392                         if (link != LINK_TO_TD(td)) {
 393                                 if (nframes > 0)
 394                                         out += sprintf(out, "    link does "
 395                                                 "not match list entry!\n");
 396                                 else
 397                                         ++nerrs;
 398                         }
 399                         if (nframes > 0)
 400                                 out += uhci_show_td(td, out,
 401                                                 len - (out - buf), 4);
 402                         link = td->link;
 403                 } while (tmp != head);
 404
 405 check_link:
 406                 qh_dma = uhci_frame_skel_link(uhci, i);
 407                 if (link != qh_dma) {
 408                         if (nframes > 0) {
 409                                 if (!j) {
 410                                         out += sprintf(out,
 411                                                 "- Frame %d -> (%08x)\n",
 412                                                 i, le32_to_cpu(link));
 413                                         j = 1;
 414                                 }
 415                                 out += sprintf(out, "   link does not match "
 416                                         "QH (%08x)!\n", le32_to_cpu(qh_dma));
 417                         } else
 418                                 ++nerrs;
 419                 }
 420                 nframes -= j;
 421         }
 422         if (nerrs > 0)
 423                 out += sprintf(out, "Skipped %d bad links\n", nerrs);
 424
 425         out += sprintf(out, "Skeleton QHs\n");
 426
 427         for (i = 0; i < UHCI_NUM_SKELQH; ++i) {
 428                 int cnt = 0;
 429                 __le32 fsbr_link = 0;
 430
 431                 qh = uhci->skelqh[i];
 432                 out += sprintf(out, "- skel_%s_qh\n", qh_names[i]); \
 433                 out += uhci_show_qh(qh, out, len - (out - buf), 4);
 434
 435                 /* Last QH is the Terminating QH, it's different */
 436                 if (i == SKEL_TERM) {
 437                         if (qh_element(qh) != LINK_TO_TD(uhci->term_td))
 438                                 out += sprintf(out, "    skel_term_qh element is not set to term_td!\n");
 439                         if (link == LINK_TO_QH(uhci->skel_term_qh))
 440                                 goto check_qh_link;
 441                         continue;
 442                 }
 443
 444                 head = &qh->node;
 445                 tmp = head->next;
 446
 447                 while (tmp != head) {
 448                         qh = list_entry(tmp, struct uhci_qh, node);
 449                         tmp = tmp->next;
 450                         if (++cnt <= 10)
 451                                 out += uhci_show_qh(qh, out,
 452                                                 len - (out - buf), 4);
 453                         if (!fsbr_link && qh->skel >= SKEL_FSBR)
 454                                 fsbr_link = LINK_TO_QH(qh);
 455                 }
 456                 if ((cnt -= 10) > 0)
 457                         out += sprintf(out, "    Skipped %d QHs\n", cnt);
 458
 459                 link = UHCI_PTR_TERM;
 460                 if (i <= SKEL_ISO)
 461                         ;
 462                 else if (i < SKEL_ASYNC)
 463                         link = LINK_TO_QH(uhci->skel_async_qh);
 464                 else if (!uhci->fsbr_is_on)
 465                         ;
 466                 else if (fsbr_link)
 467                         link = fsbr_link;
 468                 else
 469                         link = LINK_TO_QH(uhci->skel_term_qh);
 470 check_qh_link:
 471                 if (qh->link != link)
 472                         out += sprintf(out, "    last QH not linked to next skeleton!\n");
 473         }
 474
 475         return out - buf;
 476 }
 477
 478 #ifdef CONFIG_DEBUG_FS
 479
 480 #define MAX_OUTPUT      (64 * 1024)
 481
 482 struct uhci_debug {
 483         int size;
 484         char *data;
 485 };
 486
 487 static int uhci_debug_open(struct inode *inode, struct file *file)
 488 {
 489         struct uhci_hcd *uhci = inode->i_private;
 490         struct uhci_debug *up;
 491         int ret = -ENOMEM;
 492         unsigned long flags;
 493
 494         lock_kernel();
 495         up = kmalloc(sizeof(*up), GFP_KERNEL);
 496         if (!up)
 497                 goto out;
 498
 499         up->data = kmalloc(MAX_OUTPUT, GFP_KERNEL);
 500         if (!up->data) {
 501                 kfree(up);
 502                 goto out;
 503         }
 504
 505         up->size = 0;
 506         spin_lock_irqsave(&uhci->lock, flags);
 507         if (uhci->is_initialized)
 508                 up->size = uhci_sprint_schedule(uhci, up->data, MAX_OUTPUT);
 509         spin_unlock_irqrestore(&uhci->lock, flags);
 510
 511         file->private_data = up;
 512
 513         ret = 0;
 514 out:
 515         unlock_kernel();
 516         return ret;
 517 }
 518
 519 static loff_t uhci_debug_lseek(struct file *file, loff_t off, int whence)
 520 {
 521         struct uhci_debug *up;
 522         loff_t new = -1;
 523
 524         lock_kernel();
 525         up = file->private_data;
 526
 527         switch (whence) {
 528         case 0:
 529                 new = off;
 530                 break;
 531         case 1:
 532                 new = file->f_pos + off;
 533                 break;
 534         }
 535         if (new < 0 || new > up->size) {
 536                 unlock_kernel();
 537                 return -EINVAL;
 538         }
 539         unlock_kernel();
 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 #undef uhci_debug_operations
 561 static const struct file_operations uhci_debug_operations = {
 562         .owner =        THIS_MODULE,
 563         .open =         uhci_debug_open,
 564         .llseek =       uhci_debug_lseek,
 565         .read =         uhci_debug_read,
 566         .release =      uhci_debug_release,
 567 };
 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_qh *qh, char *buf,
 577                 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