2
* UHCI-specific debugging code. Invaluable when something
3
* goes wrong, but don't get in my face.
5
* Kernel visible pointers are surrounded in []s and bus
6
* visible pointers are surrounded in ()s
8
* (C) Copyright 1999 Linus Torvalds
9
* (C) Copyright 1999-2001 Johannes Erdfelt
12
#include <linux/slab.h>
13
#include <linux/kernel.h>
14
#include <linux/debugfs.h>
19
static struct dentry *uhci_debugfs_root;
23
/* Handle REALLY large printks so we don't overflow buffers */
24
static void lprintk(char *buf)
28
/* Just write one line at a time */
30
p = strchr(buf, '\n');
33
printk(KERN_DEBUG "%s\n", buf);
40
static int uhci_show_td(struct uhci_hcd *uhci, struct uhci_td *td, char *buf,
47
/* Try to make sure there's enough memory */
51
status = td_status(uhci, td);
52
out += sprintf(out, "%*s[%p] link (%08x) ", space, "", td,
53
hc32_to_cpu(uhci, td->link));
54
out += sprintf(out, "e%d %s%s%s%s%s%s%s%s%s%sLength=%x ",
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 " : "",
68
token = td_token(uhci, td);
69
switch (uhci_packetid(token)) {
84
out += sprintf(out, "MaxLen=%x DT%d EndPt=%x Dev=%x, PID=%x(%s) ",
91
out += sprintf(out, "(buf=%08x)\n", hc32_to_cpu(uhci, td->buffer));
96
static int uhci_show_urbp(struct uhci_hcd *uhci, struct urb_priv *urbp,
97
char *buf, int len, int space)
101
int i, nactive, ninactive;
107
out += sprintf(out, "urb_priv [%p] ", urbp);
108
out += sprintf(out, "urb [%p] ", urbp->urb);
109
out += sprintf(out, "qh [%p] ", urbp->qh);
110
out += sprintf(out, "Dev=%d ", usb_pipedevice(urbp->urb->pipe));
111
out += sprintf(out, "EP=%x(%s) ", usb_pipeendpoint(urbp->urb->pipe),
112
(usb_pipein(urbp->urb->pipe) ? "IN" : "OUT"));
114
switch (usb_pipetype(urbp->urb->pipe)) {
115
case PIPE_ISOCHRONOUS: ptype = "ISO"; break;
116
case PIPE_INTERRUPT: ptype = "INT"; break;
117
case PIPE_BULK: ptype = "BLK"; break;
119
case PIPE_CONTROL: ptype = "CTL"; break;
122
out += sprintf(out, "%s%s", ptype, (urbp->fsbr ? " FSBR" : ""));
123
out += sprintf(out, " Actlen=%d%s", urbp->urb->actual_length,
124
(urbp->qh->type == USB_ENDPOINT_XFER_CONTROL ?
127
if (urbp->urb->unlinked)
128
out += sprintf(out, " Unlinked=%d", urbp->urb->unlinked);
129
out += sprintf(out, "\n");
131
i = nactive = ninactive = 0;
132
list_for_each_entry(td, &urbp->td_list, list) {
133
if (urbp->qh->type != USB_ENDPOINT_XFER_ISOC &&
134
(++i <= 10 || debug > 2)) {
135
out += sprintf(out, "%*s%d: ", space + 2, "", i);
136
out += uhci_show_td(uhci, td, out,
137
len - (out - buf), 0);
139
if (td_status(uhci, td) & TD_CTRL_ACTIVE)
145
if (nactive + ninactive > 0)
146
out += sprintf(out, "%*s[skipped %d inactive and %d active "
148
space, "", ninactive, nactive);
153
static int uhci_show_qh(struct uhci_hcd *uhci,
154
struct uhci_qh *qh, char *buf, int len, int space)
158
__hc32 element = qh_element(qh);
161
/* Try to make sure there's enough memory */
166
case USB_ENDPOINT_XFER_ISOC: qtype = "ISO"; break;
167
case USB_ENDPOINT_XFER_INT: qtype = "INT"; break;
168
case USB_ENDPOINT_XFER_BULK: qtype = "BLK"; break;
169
case USB_ENDPOINT_XFER_CONTROL: qtype = "CTL"; break;
170
default: qtype = "Skel" ; break;
173
out += sprintf(out, "%*s[%p] %s QH link (%08x) element (%08x)\n",
174
space, "", qh, qtype,
175
hc32_to_cpu(uhci, qh->link),
176
hc32_to_cpu(uhci, element));
177
if (qh->type == USB_ENDPOINT_XFER_ISOC)
178
out += sprintf(out, "%*s period %d phase %d load %d us, "
179
"frame %x desc [%p]\n",
180
space, "", qh->period, qh->phase, qh->load,
181
qh->iso_frame, qh->iso_packet_desc);
182
else if (qh->type == USB_ENDPOINT_XFER_INT)
183
out += sprintf(out, "%*s period %d phase %d load %d us\n",
184
space, "", qh->period, qh->phase, qh->load);
186
if (element & UHCI_PTR_QH(uhci))
187
out += sprintf(out, "%*s Element points to QH (bug?)\n", space, "");
189
if (element & UHCI_PTR_DEPTH(uhci))
190
out += sprintf(out, "%*s Depth traverse\n", space, "");
192
if (element & cpu_to_hc32(uhci, 8))
193
out += sprintf(out, "%*s Bit 3 set (bug?)\n", space, "");
195
if (!(element & ~(UHCI_PTR_QH(uhci) | UHCI_PTR_DEPTH(uhci))))
196
out += sprintf(out, "%*s Element is NULL (bug?)\n", space, "");
198
if (list_empty(&qh->queue)) {
199
out += sprintf(out, "%*s queue is empty\n", space, "");
200
if (qh == uhci->skel_async_qh)
201
out += uhci_show_td(uhci, uhci->term_td, out,
202
len - (out - buf), 0);
204
struct urb_priv *urbp = list_entry(qh->queue.next,
205
struct urb_priv, node);
206
struct uhci_td *td = list_entry(urbp->td_list.next,
207
struct uhci_td, list);
209
if (element != LINK_TO_TD(uhci, td))
210
out += sprintf(out, "%*s Element != First TD\n",
213
list_for_each_entry(urbp, &qh->queue, node) {
215
out += uhci_show_urbp(uhci, urbp, out,
216
len - (out - buf), space + 2);
221
out += sprintf(out, "%*s Skipped %d URBs\n",
226
out += sprintf(out, "%*s Dummy TD\n", space, "");
227
out += uhci_show_td(uhci, qh->dummy_td, out,
228
len - (out - buf), 0);
234
static int uhci_show_sc(int port, unsigned short status, char *buf, int len)
238
/* Try to make sure there's enough memory */
242
out += sprintf(out, " stat%d = %04x %s%s%s%s%s%s%s%s%s%s\n",
245
(status & USBPORTSC_SUSP) ? " Suspend" : "",
246
(status & USBPORTSC_OCC) ? " OverCurrentChange" : "",
247
(status & USBPORTSC_OC) ? " OverCurrent" : "",
248
(status & USBPORTSC_PR) ? " Reset" : "",
249
(status & USBPORTSC_LSDA) ? " LowSpeed" : "",
250
(status & USBPORTSC_RD) ? " ResumeDetect" : "",
251
(status & USBPORTSC_PEC) ? " EnableChange" : "",
252
(status & USBPORTSC_PE) ? " Enabled" : "",
253
(status & USBPORTSC_CSC) ? " ConnectChange" : "",
254
(status & USBPORTSC_CCS) ? " Connected" : "");
259
static int uhci_show_root_hub_state(struct uhci_hcd *uhci, char *buf, int len)
264
/* Try to make sure there's enough memory */
268
switch (uhci->rh_state) {
270
rh_state = "reset"; break;
271
case UHCI_RH_SUSPENDED:
272
rh_state = "suspended"; break;
273
case UHCI_RH_AUTO_STOPPED:
274
rh_state = "auto-stopped"; break;
275
case UHCI_RH_RESUMING:
276
rh_state = "resuming"; break;
277
case UHCI_RH_SUSPENDING:
278
rh_state = "suspending"; break;
279
case UHCI_RH_RUNNING:
280
rh_state = "running"; break;
281
case UHCI_RH_RUNNING_NODEVS:
282
rh_state = "running, no devs"; break;
284
rh_state = "?"; break;
286
out += sprintf(out, "Root-hub state: %s FSBR: %d\n",
287
rh_state, uhci->fsbr_is_on);
291
static int uhci_show_status(struct uhci_hcd *uhci, char *buf, int len)
294
unsigned short usbcmd, usbstat, usbint, usbfrnum;
295
unsigned int flbaseadd;
297
unsigned short portsc1, portsc2;
299
/* Try to make sure there's enough memory */
303
usbcmd = uhci_readw(uhci, 0);
304
usbstat = uhci_readw(uhci, 2);
305
usbint = uhci_readw(uhci, 4);
306
usbfrnum = uhci_readw(uhci, 6);
307
flbaseadd = uhci_readl(uhci, 8);
308
sof = uhci_readb(uhci, 12);
309
portsc1 = uhci_readw(uhci, 16);
310
portsc2 = uhci_readw(uhci, 18);
312
out += sprintf(out, " usbcmd = %04x %s%s%s%s%s%s%s%s\n",
314
(usbcmd & USBCMD_MAXP) ? "Maxp64 " : "Maxp32 ",
315
(usbcmd & USBCMD_CF) ? "CF " : "",
316
(usbcmd & USBCMD_SWDBG) ? "SWDBG " : "",
317
(usbcmd & USBCMD_FGR) ? "FGR " : "",
318
(usbcmd & USBCMD_EGSM) ? "EGSM " : "",
319
(usbcmd & USBCMD_GRESET) ? "GRESET " : "",
320
(usbcmd & USBCMD_HCRESET) ? "HCRESET " : "",
321
(usbcmd & USBCMD_RS) ? "RS " : "");
323
out += sprintf(out, " usbstat = %04x %s%s%s%s%s%s\n",
325
(usbstat & USBSTS_HCH) ? "HCHalted " : "",
326
(usbstat & USBSTS_HCPE) ? "HostControllerProcessError " : "",
327
(usbstat & USBSTS_HSE) ? "HostSystemError " : "",
328
(usbstat & USBSTS_RD) ? "ResumeDetect " : "",
329
(usbstat & USBSTS_ERROR) ? "USBError " : "",
330
(usbstat & USBSTS_USBINT) ? "USBINT " : "");
332
out += sprintf(out, " usbint = %04x\n", usbint);
333
out += sprintf(out, " usbfrnum = (%d)%03x\n", (usbfrnum >> 10) & 1,
334
0xfff & (4*(unsigned int)usbfrnum));
335
out += sprintf(out, " flbaseadd = %08x\n", flbaseadd);
336
out += sprintf(out, " sof = %02x\n", sof);
337
out += uhci_show_sc(1, portsc1, out, len - (out - buf));
338
out += uhci_show_sc(2, portsc2, out, len - (out - buf));
339
out += sprintf(out, "Most recent frame: %x (%d) "
340
"Last ISO frame: %x (%d)\n",
341
uhci->frame_number, uhci->frame_number & 1023,
342
uhci->last_iso_frame, uhci->last_iso_frame & 1023);
347
static int uhci_sprint_schedule(struct uhci_hcd *uhci, char *buf, int len)
353
struct list_head *tmp, *head;
358
static const char * const qh_names[] = {
359
"unlink", "iso", "int128", "int64", "int32", "int16",
360
"int8", "int4", "int2", "async", "term"
363
out += uhci_show_root_hub_state(uhci, out, len - (out - buf));
364
out += sprintf(out, "HC status\n");
365
out += uhci_show_status(uhci, out, len - (out - buf));
367
out += sprintf(out, "Periodic load table\n");
368
for (i = 0; i < MAX_PHASE; ++i) {
369
out += sprintf(out, "\t%d", uhci->load[i]);
373
out += sprintf(out, "Total: %d, #INT: %d, #ISO: %d\n",
375
uhci_to_hcd(uhci)->self.bandwidth_int_reqs,
376
uhci_to_hcd(uhci)->self.bandwidth_isoc_reqs);
380
out += sprintf(out, "Frame List\n");
383
for (i = 0; i < UHCI_NUMFRAMES; ++i) {
387
td = uhci->frame_cpu[i];
388
link = uhci->frame[i];
393
out += sprintf(out, "- Frame %d -> (%08x)\n",
394
i, hc32_to_cpu(uhci, link));
401
td = list_entry(tmp, struct uhci_td, fl_list);
403
if (link != LINK_TO_TD(uhci, td)) {
405
out += sprintf(out, " link does "
406
"not match list entry!\n");
411
out += uhci_show_td(uhci, td, out,
412
len - (out - buf), 4);
414
} while (tmp != head);
417
qh_dma = uhci_frame_skel_link(uhci, i);
418
if (link != qh_dma) {
422
"- Frame %d -> (%08x)\n",
423
i, hc32_to_cpu(uhci, link));
426
out += sprintf(out, " link does not match "
428
hc32_to_cpu(uhci, qh_dma));
435
out += sprintf(out, "Skipped %d bad links\n", nerrs);
437
out += sprintf(out, "Skeleton QHs\n");
440
for (i = 0; i < UHCI_NUM_SKELQH; ++i) {
443
qh = uhci->skelqh[i];
444
out += sprintf(out, "- skel_%s_qh\n", qh_names[i]); \
445
out += uhci_show_qh(uhci, qh, out, len - (out - buf), 4);
447
/* Last QH is the Terminating QH, it's different */
448
if (i == SKEL_TERM) {
449
if (qh_element(qh) != LINK_TO_TD(uhci, uhci->term_td))
450
out += sprintf(out, " skel_term_qh element is not set to term_td!\n");
453
link = LINK_TO_QH(uhci, uhci->skel_term_qh);
460
while (tmp != head) {
461
qh = list_entry(tmp, struct uhci_qh, node);
464
out += uhci_show_qh(uhci, qh, out,
465
len - (out - buf), 4);
466
if (!fsbr_link && qh->skel >= SKEL_FSBR)
467
fsbr_link = LINK_TO_QH(uhci, qh);
470
out += sprintf(out, " Skipped %d QHs\n", cnt);
472
link = UHCI_PTR_TERM(uhci);
475
else if (i < SKEL_ASYNC)
476
link = LINK_TO_QH(uhci, uhci->skel_async_qh);
477
else if (!uhci->fsbr_is_on)
480
link = LINK_TO_QH(uhci, uhci->skel_term_qh);
482
if (qh->link != link)
483
out += sprintf(out, " last QH not linked to next skeleton!\n");
489
#ifdef CONFIG_DEBUG_FS
491
#define MAX_OUTPUT (64 * 1024)
498
static int uhci_debug_open(struct inode *inode, struct file *file)
500
struct uhci_hcd *uhci = inode->i_private;
501
struct uhci_debug *up;
504
up = kmalloc(sizeof(*up), GFP_KERNEL);
508
up->data = kmalloc(MAX_OUTPUT, GFP_KERNEL);
515
spin_lock_irqsave(&uhci->lock, flags);
516
if (uhci->is_initialized)
517
up->size = uhci_sprint_schedule(uhci, up->data, MAX_OUTPUT);
518
spin_unlock_irqrestore(&uhci->lock, flags);
520
file->private_data = up;
525
static loff_t uhci_debug_lseek(struct file *file, loff_t off, int whence)
527
struct uhci_debug *up;
530
up = file->private_data;
532
/* XXX: atomic 64bit seek access, but that needs to be fixed in the VFS */
538
new = file->f_pos + off;
542
if (new < 0 || new > up->size)
545
return (file->f_pos = new);
548
static ssize_t uhci_debug_read(struct file *file, char __user *buf,
549
size_t nbytes, loff_t *ppos)
551
struct uhci_debug *up = file->private_data;
552
return simple_read_from_buffer(buf, nbytes, ppos, up->data, up->size);
555
static int uhci_debug_release(struct inode *inode, struct file *file)
557
struct uhci_debug *up = file->private_data;
565
static 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,
572
#define UHCI_DEBUG_OPS
574
#endif /* CONFIG_DEBUG_FS */
578
static inline void lprintk(char *buf)
581
static inline int uhci_show_qh(struct uhci_hcd *uhci,
582
struct uhci_qh *qh, char *buf, int len, int space)
587
static inline int uhci_sprint_schedule(struct uhci_hcd *uhci,