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