[deliverable/linux.git] / drivers / usb / host / uhci-debug.c

/*
 * UHCI-specific debugging code. Invaluable when something
 * goes wrong, but don't get in my face.
 *
 * Kernel visible pointers are surrounded in []s and bus
 * visible pointers are surrounded in ()s
 *
 * (C) Copyright 1999 Linus Torvalds
 * (C) Copyright 1999-2001 Johannes Erdfelt
 */

#include <linux/slab.h>
#include <linux/kernel.h>
#include <linux/debugfs.h>
#include <asm/io.h>

#include "uhci-hcd.h"

static struct dentry *uhci_debugfs_root;

#ifdef DEBUG

/* Handle REALLY large printks so we don't overflow buffers */
static void lprintk(char *buf)
{
	char *p;

	/* Just write one line at a time */
	while (buf) {
		p = strchr(buf, '\n');
		if (p)
			*p = 0;
		printk(KERN_DEBUG "%s\n", buf);
		buf = p;
		if (buf)
			buf++;
	}
}

static int uhci_show_td(struct uhci_hcd *uhci, struct uhci_td *td, char *buf,
			int len, int space)
{
	char *out = buf;
	char *spid;
	u32 status, token;

	/* Try to make sure there's enough memory */
	if (len < 160)
		return 0;

	status = td_status(uhci, td);
	out += sprintf(out, "%*s[%p] link (%08x) ", space, "", td,
		hc32_to_cpu(uhci, td->link));
	out += sprintf(out, "e%d %s%s%s%s%s%s%s%s%s%sLength=%x ",
		((status >> 27) & 3),
		(status & TD_CTRL_SPD) ?      "SPD " : "",
		(status & TD_CTRL_LS) ?       "LS " : "",
		(status & TD_CTRL_IOC) ?      "IOC " : "",
		(status & TD_CTRL_ACTIVE) ?   "Active " : "",
		(status & TD_CTRL_STALLED) ?  "Stalled " : "",
		(status & TD_CTRL_DBUFERR) ?  "DataBufErr " : "",
		(status & TD_CTRL_BABBLE) ?   "Babble " : "",
		(status & TD_CTRL_NAK) ?      "NAK " : "",
		(status & TD_CTRL_CRCTIMEO) ? "CRC/Timeo " : "",
		(status & TD_CTRL_BITSTUFF) ? "BitStuff " : "",
		status & 0x7ff);

	token = td_token(uhci, td);
	switch (uhci_packetid(token)) {
		case USB_PID_SETUP:
			spid = "SETUP";
			break;
		case USB_PID_OUT:
			spid = "OUT";
			break;
		case USB_PID_IN:
			spid = "IN";
			break;
		default:
			spid = "?";
			break;
	}

	out += sprintf(out, "MaxLen=%x DT%d EndPt=%x Dev=%x, PID=%x(%s) ",
		token >> 21,
		((token >> 19) & 1),
		(token >> 15) & 15,
		(token >> 8) & 127,
		(token & 0xff),
		spid);
	out += sprintf(out, "(buf=%08x)\n", hc32_to_cpu(uhci, td->buffer));

	return out - buf;
}

static int uhci_show_urbp(struct uhci_hcd *uhci, struct urb_priv *urbp,
			char *buf, int len, int space)
{
	char *out = buf;
	struct uhci_td *td;
	int i, nactive, ninactive;
	char *ptype;

	if (len < 200)
		return 0;

	out += sprintf(out, "urb_priv [%p] ", urbp);
	out += sprintf(out, "urb [%p] ", urbp->urb);
	out += sprintf(out, "qh [%p] ", urbp->qh);
	out += sprintf(out, "Dev=%d ", usb_pipedevice(urbp->urb->pipe));
	out += sprintf(out, "EP=%x(%s) ", usb_pipeendpoint(urbp->urb->pipe),
			(usb_pipein(urbp->urb->pipe) ? "IN" : "OUT"));

	switch (usb_pipetype(urbp->urb->pipe)) {
	case PIPE_ISOCHRONOUS: ptype = "ISO"; break;
	case PIPE_INTERRUPT: ptype = "INT"; break;
	case PIPE_BULK: ptype = "BLK"; break;
	default:
	case PIPE_CONTROL: ptype = "CTL"; break;
	}

	out += sprintf(out, "%s%s", ptype, (urbp->fsbr ? " FSBR" : ""));
	out += sprintf(out, " Actlen=%d%s", urbp->urb->actual_length,
			(urbp->qh->type == USB_ENDPOINT_XFER_CONTROL ?
				"-8" : ""));

	if (urbp->urb->unlinked)
		out += sprintf(out, " Unlinked=%d", urbp->urb->unlinked);
	out += sprintf(out, "\n");

	i = nactive = ninactive = 0;
	list_for_each_entry(td, &urbp->td_list, list) {
		if (urbp->qh->type != USB_ENDPOINT_XFER_ISOC &&
				(++i <= 10 || debug > 2)) {
			out += sprintf(out, "%*s%d: ", space + 2, "", i);
			out += uhci_show_td(uhci, td, out,
					len - (out - buf), 0);
		} else {
			if (td_status(uhci, td) & TD_CTRL_ACTIVE)
				++nactive;
			else
				++ninactive;
		}
	}
	if (nactive + ninactive > 0)
		out += sprintf(out, "%*s[skipped %d inactive and %d active "
				"TDs]\n",
				space, "", ninactive, nactive);

	return out - buf;
}

static int uhci_show_qh(struct uhci_hcd *uhci,
		struct uhci_qh *qh, char *buf, int len, int space)
{
	char *out = buf;
	int i, nurbs;
	__hc32 element = qh_element(qh);
	char *qtype;

	/* Try to make sure there's enough memory */
	if (len < 80 * 7)
		return 0;

	switch (qh->type) {
	case USB_ENDPOINT_XFER_ISOC: qtype = "ISO"; break;
	case USB_ENDPOINT_XFER_INT: qtype = "INT"; break;
	case USB_ENDPOINT_XFER_BULK: qtype = "BLK"; break;
	case USB_ENDPOINT_XFER_CONTROL: qtype = "CTL"; break;
	default: qtype = "Skel" ; break;
	}

	out += sprintf(out, "%*s[%p] %s QH link (%08x) element (%08x)\n",
			space, "", qh, qtype,
			hc32_to_cpu(uhci, qh->link),
			hc32_to_cpu(uhci, element));
	if (qh->type == USB_ENDPOINT_XFER_ISOC)
		out += sprintf(out, "%*s    period %d phase %d load %d us, "
				"frame %x desc [%p]\n",
				space, "", qh->period, qh->phase, qh->load,
				qh->iso_frame, qh->iso_packet_desc);
	else if (qh->type == USB_ENDPOINT_XFER_INT)
		out += sprintf(out, "%*s    period %d phase %d load %d us\n",
				space, "", qh->period, qh->phase, qh->load);

	if (element & UHCI_PTR_QH(uhci))
		out += sprintf(out, "%*s  Element points to QH (bug?)\n", space, "");

	if (element & UHCI_PTR_DEPTH(uhci))
		out += sprintf(out, "%*s  Depth traverse\n", space, "");

	if (element & cpu_to_hc32(uhci, 8))
		out += sprintf(out, "%*s  Bit 3 set (bug?)\n", space, "");

	if (!(element & ~(UHCI_PTR_QH(uhci) | UHCI_PTR_DEPTH(uhci))))
		out += sprintf(out, "%*s  Element is NULL (bug?)\n", space, "");

	if (list_empty(&qh->queue)) {
		out += sprintf(out, "%*s  queue is empty\n", space, "");
		if (qh == uhci->skel_async_qh)
			out += uhci_show_td(uhci, uhci->term_td, out,
					len - (out - buf), 0);
	} else {
		struct urb_priv *urbp = list_entry(qh->queue.next,
				struct urb_priv, node);
		struct uhci_td *td = list_entry(urbp->td_list.next,
				struct uhci_td, list);

		if (element != LINK_TO_TD(uhci, td))
			out += sprintf(out, "%*s Element != First TD\n",
					space, "");
		i = nurbs = 0;
		list_for_each_entry(urbp, &qh->queue, node) {
			if (++i <= 10)
				out += uhci_show_urbp(uhci, urbp, out,
						len - (out - buf), space + 2);
			else
				++nurbs;
		}
		if (nurbs > 0)
			out += sprintf(out, "%*s Skipped %d URBs\n",
					space, "", nurbs);
	}

	if (qh->dummy_td) {
		out += sprintf(out, "%*s  Dummy TD\n", space, "");
		out += uhci_show_td(uhci, qh->dummy_td, out,
				len - (out - buf), 0);
	}

	return out - buf;
}

static int uhci_show_sc(int port, unsigned short status, char *buf, int len)
{
	char *out = buf;

	/* Try to make sure there's enough memory */
	if (len < 160)
		return 0;

	out += sprintf(out, "  stat%d     =     %04x  %s%s%s%s%s%s%s%s%s%s\n",
		port,
		status,
		(status & USBPORTSC_SUSP) ?	" Suspend" : "",
		(status & USBPORTSC_OCC) ?	" OverCurrentChange" : "",
		(status & USBPORTSC_OC) ?	" OverCurrent" : "",
		(status & USBPORTSC_PR) ?	" Reset" : "",
		(status & USBPORTSC_LSDA) ?	" LowSpeed" : "",
		(status & USBPORTSC_RD) ?	" ResumeDetect" : "",
		(status & USBPORTSC_PEC) ?	" EnableChange" : "",
		(status & USBPORTSC_PE) ?	" Enabled" : "",
		(status & USBPORTSC_CSC) ?	" ConnectChange" : "",
		(status & USBPORTSC_CCS) ?	" Connected" : "");

	return out - buf;
}

static int uhci_show_root_hub_state(struct uhci_hcd *uhci, char *buf, int len)
{
	char *out = buf;
	char *rh_state;

	/* Try to make sure there's enough memory */
	if (len < 60)
		return 0;

	switch (uhci->rh_state) {
	    case UHCI_RH_RESET:
		rh_state = "reset";		break;
	    case UHCI_RH_SUSPENDED:
		rh_state = "suspended";		break;
	    case UHCI_RH_AUTO_STOPPED:
		rh_state = "auto-stopped";	break;
	    case UHCI_RH_RESUMING:
		rh_state = "resuming";		break;
	    case UHCI_RH_SUSPENDING:
		rh_state = "suspending";	break;
	    case UHCI_RH_RUNNING:
		rh_state = "running";		break;
	    case UHCI_RH_RUNNING_NODEVS:
		rh_state = "running, no devs";	break;
	    default:
		rh_state = "?";			break;
	}
	out += sprintf(out, "Root-hub state: %s   FSBR: %d\n",
			rh_state, uhci->fsbr_is_on);
	return out - buf;
}

static int uhci_show_status(struct uhci_hcd *uhci, char *buf, int len)
{
	char *out = buf;
	unsigned short usbcmd, usbstat, usbint, usbfrnum;
	unsigned int flbaseadd;
	unsigned char sof;
	unsigned short portsc1, portsc2;

	/* Try to make sure there's enough memory */
	if (len < 80 * 9)
		return 0;

	usbcmd    = uhci_readw(uhci, 0);
	usbstat   = uhci_readw(uhci, 2);
	usbint    = uhci_readw(uhci, 4);
	usbfrnum  = uhci_readw(uhci, 6);
	flbaseadd = uhci_readl(uhci, 8);
	sof       = uhci_readb(uhci, 12);
	portsc1   = uhci_readw(uhci, 16);
	portsc2   = uhci_readw(uhci, 18);

	out += sprintf(out, "  usbcmd    =     %04x   %s%s%s%s%s%s%s%s\n",
		usbcmd,
		(usbcmd & USBCMD_MAXP) ?    "Maxp64 " : "Maxp32 ",
		(usbcmd & USBCMD_CF) ?      "CF " : "",
		(usbcmd & USBCMD_SWDBG) ?   "SWDBG " : "",
		(usbcmd & USBCMD_FGR) ?     "FGR " : "",
		(usbcmd & USBCMD_EGSM) ?    "EGSM " : "",
		(usbcmd & USBCMD_GRESET) ?  "GRESET " : "",
		(usbcmd & USBCMD_HCRESET) ? "HCRESET " : "",
		(usbcmd & USBCMD_RS) ?      "RS " : "");

	out += sprintf(out, "  usbstat   =     %04x   %s%s%s%s%s%s\n",
		usbstat,
		(usbstat & USBSTS_HCH) ?    "HCHalted " : "",
		(usbstat & USBSTS_HCPE) ?   "HostControllerProcessError " : "",
		(usbstat & USBSTS_HSE) ?    "HostSystemError " : "",
		(usbstat & USBSTS_RD) ?     "ResumeDetect " : "",
		(usbstat & USBSTS_ERROR) ?  "USBError " : "",
		(usbstat & USBSTS_USBINT) ? "USBINT " : "");

	out += sprintf(out, "  usbint    =     %04x\n", usbint);
	out += sprintf(out, "  usbfrnum  =   (%d)%03x\n", (usbfrnum >> 10) & 1,
		0xfff & (4*(unsigned int)usbfrnum));
	out += sprintf(out, "  flbaseadd = %08x\n", flbaseadd);
	out += sprintf(out, "  sof       =       %02x\n", sof);
	out += uhci_show_sc(1, portsc1, out, len - (out - buf));
	out += uhci_show_sc(2, portsc2, out, len - (out - buf));
	out += sprintf(out, "Most recent frame: %x (%d)   "
			"Last ISO frame: %x (%d)\n",
			uhci->frame_number, uhci->frame_number & 1023,
			uhci->last_iso_frame, uhci->last_iso_frame & 1023);

	return out - buf;
}

static int uhci_sprint_schedule(struct uhci_hcd *uhci, char *buf, int len)
{
	char *out = buf;
	int i, j;
	struct uhci_qh *qh;
	struct uhci_td *td;
	struct list_head *tmp, *head;
	int nframes, nerrs;
	__hc32 link;
	__hc32 fsbr_link;

	static const char * const qh_names[] = {
		"unlink", "iso", "int128", "int64", "int32", "int16",
		"int8", "int4", "int2", "async", "term"
	};

	out += uhci_show_root_hub_state(uhci, out, len - (out - buf));
	out += sprintf(out, "HC status\n");
	out += uhci_show_status(uhci, out, len - (out - buf));

	out += sprintf(out, "Periodic load table\n");
	for (i = 0; i < MAX_PHASE; ++i) {
		out += sprintf(out, "\t%d", uhci->load[i]);
		if (i % 8 == 7)
			*out++ = '\n';
	}
	out += sprintf(out, "Total: %d, #INT: %d, #ISO: %d\n",
			uhci->total_load,
			uhci_to_hcd(uhci)->self.bandwidth_int_reqs,
			uhci_to_hcd(uhci)->self.bandwidth_isoc_reqs);
	if (debug <= 1)
		return out - buf;

	out += sprintf(out, "Frame List\n");
	nframes = 10;
	nerrs = 0;
	for (i = 0; i < UHCI_NUMFRAMES; ++i) {
		__hc32 qh_dma;

		j = 0;
		td = uhci->frame_cpu[i];
		link = uhci->frame[i];
		if (!td)
			goto check_link;

		if (nframes > 0) {
			out += sprintf(out, "- Frame %d -> (%08x)\n",
					i, hc32_to_cpu(uhci, link));
			j = 1;
		}

		head = &td->fl_list;
		tmp = head;
		do {
			td = list_entry(tmp, struct uhci_td, fl_list);
			tmp = tmp->next;
			if (link != LINK_TO_TD(uhci, td)) {
				if (nframes > 0)
					out += sprintf(out, "    link does "
						"not match list entry!\n");
				else
					++nerrs;
			}
			if (nframes > 0)
				out += uhci_show_td(uhci, td, out,
						len - (out - buf), 4);
			link = td->link;
		} while (tmp != head);

check_link:
		qh_dma = uhci_frame_skel_link(uhci, i);
		if (link != qh_dma) {
			if (nframes > 0) {
				if (!j) {
					out += sprintf(out,
						"- Frame %d -> (%08x)\n",
						i, hc32_to_cpu(uhci, link));
					j = 1;
				}
				out += sprintf(out, "   link does not match "
					"QH (%08x)!\n",
					hc32_to_cpu(uhci, qh_dma));
			} else
				++nerrs;
		}
		nframes -= j;
	}
	if (nerrs > 0)
		out += sprintf(out, "Skipped %d bad links\n", nerrs);

	out += sprintf(out, "Skeleton QHs\n");

	fsbr_link = 0;
	for (i = 0; i < UHCI_NUM_SKELQH; ++i) {
		int cnt = 0;

		qh = uhci->skelqh[i];
		out += sprintf(out, "- skel_%s_qh\n", qh_names[i]); \
		out += uhci_show_qh(uhci, qh, out, len - (out - buf), 4);

		/* Last QH is the Terminating QH, it's different */
		if (i == SKEL_TERM) {
			if (qh_element(qh) != LINK_TO_TD(uhci, uhci->term_td))
				out += sprintf(out, "    skel_term_qh element is not set to term_td!\n");
			link = fsbr_link;
			if (!link)
				link = LINK_TO_QH(uhci, uhci->skel_term_qh);
			goto check_qh_link;
		}

		head = &qh->node;
		tmp = head->next;

		while (tmp != head) {
			qh = list_entry(tmp, struct uhci_qh, node);
			tmp = tmp->next;
			if (++cnt <= 10)
				out += uhci_show_qh(uhci, qh, out,
						len - (out - buf), 4);
			if (!fsbr_link && qh->skel >= SKEL_FSBR)
				fsbr_link = LINK_TO_QH(uhci, qh);
		}
		if ((cnt -= 10) > 0)
			out += sprintf(out, "    Skipped %d QHs\n", cnt);

		link = UHCI_PTR_TERM(uhci);
		if (i <= SKEL_ISO)
			;
		else if (i < SKEL_ASYNC)
			link = LINK_TO_QH(uhci, uhci->skel_async_qh);
		else if (!uhci->fsbr_is_on)
			;
		else
			link = LINK_TO_QH(uhci, uhci->skel_term_qh);
check_qh_link:
		if (qh->link != link)
			out += sprintf(out, "    last QH not linked to next skeleton!\n");
	}

	return out - buf;
}

#ifdef CONFIG_DEBUG_FS

#define MAX_OUTPUT	(64 * 1024)

struct uhci_debug {
	int size;
	char *data;
};

static int uhci_debug_open(struct inode *inode, struct file *file)
{
	struct uhci_hcd *uhci = inode->i_private;
	struct uhci_debug *up;
	unsigned long flags;

	up = kmalloc(sizeof(*up), GFP_KERNEL);
	if (!up)
		return -ENOMEM;

	up->data = kmalloc(MAX_OUTPUT, GFP_KERNEL);
	if (!up->data) {
		kfree(up);
		return -ENOMEM;
	}

	up->size = 0;
	spin_lock_irqsave(&uhci->lock, flags);
	if (uhci->is_initialized)
		up->size = uhci_sprint_schedule(uhci, up->data, MAX_OUTPUT);
	spin_unlock_irqrestore(&uhci->lock, flags);

	file->private_data = up;

	return 0;
}

static loff_t uhci_debug_lseek(struct file *file, loff_t off, int whence)
{
	struct uhci_debug *up;
	loff_t new = -1;

	up = file->private_data;

	/* XXX: atomic 64bit seek access, but that needs to be fixed in the VFS */
	switch (whence) {
	case 0:
		new = off;
		break;
	case 1:
		new = file->f_pos + off;
		break;
	}

	if (new < 0 || new > up->size)
		return -EINVAL;

	return (file->f_pos = new);
}

static ssize_t uhci_debug_read(struct file *file, char __user *buf,
				size_t nbytes, loff_t *ppos)
{
	struct uhci_debug *up = file->private_data;
	return simple_read_from_buffer(buf, nbytes, ppos, up->data, up->size);
}

static int uhci_debug_release(struct inode *inode, struct file *file)
{
	struct uhci_debug *up = file->private_data;

	kfree(up->data);
	kfree(up);

	return 0;
}

static const struct file_operations uhci_debug_operations = {
	.owner =	THIS_MODULE,
	.open =		uhci_debug_open,
	.llseek =	uhci_debug_lseek,
	.read =		uhci_debug_read,
	.release =	uhci_debug_release,
};
#define UHCI_DEBUG_OPS

#endif	/* CONFIG_DEBUG_FS */

#else	/* DEBUG */

static inline void lprintk(char *buf)
{}

static inline int uhci_show_qh(struct uhci_hcd *uhci,
		struct uhci_qh *qh, char *buf, int len, int space)
{
	return 0;
}

static inline int uhci_sprint_schedule(struct uhci_hcd *uhci,
		char *buf, int len)
{
	return 0;
}

#endif
Commit	Line	Data
1da177e4 LT	1	/*
	2	* UHCI-specific debugging code. Invaluable when something
	3	* goes wrong, but don't get in my face.
	4	*
687f5f34 AS	5	* Kernel visible pointers are surrounded in []s and bus
687f5f34 AS	6	* visible pointers are surrounded in ()s
1da177e4 LT	7	*
	8	* (C) Copyright 1999 Linus Torvalds
	9	* (C) Copyright 1999-2001 Johannes Erdfelt
	10	*/
	11
5a0e3ad6	12	#include <linux/slab.h>
1da177e4 LT	13	#include <linux/kernel.h>
1da177e4 LT	14	#include <linux/debugfs.h>
1da177e4 LT	15	#include <asm/io.h>
	16
	17	#include "uhci-hcd.h"
	18
8d402e1a AS	19	static struct dentry *uhci_debugfs_root;
	20
	21	#ifdef DEBUG
1da177e4	22
687f5f34	23	/* Handle REALLY large printks so we don't overflow buffers */
8d402e1a	24	static void lprintk(char *buf)
1da177e4 LT	25	{
	26	char *p;
	27
	28	/* Just write one line at a time */
	29	while (buf) {
	30	p = strchr(buf, '\n');
	31	if (p)
	32	*p = 0;
	33	printk(KERN_DEBUG "%s\n", buf);
	34	buf = p;
	35	if (buf)
	36	buf++;
	37	}
	38	}
	39
51e2f62f JA	40	static int uhci_show_td(struct uhci_hcd uhci, struct uhci_td td, char *buf,
51e2f62f JA	41	int len, int space)
1da177e4 LT	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
51e2f62f JA	51	status = td_status(uhci, td);
	52	out += sprintf(out, "%*s[%p] link (%08x) ", space, "", td,
	53	hc32_to_cpu(uhci, td->link));
1da177e4 LT	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
51e2f62f	68	token = td_token(uhci, td);
1da177e4 LT	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);
51e2f62f	91	out += sprintf(out, "(buf=%08x)\n", hc32_to_cpu(uhci, td->buffer));
1da177e4 LT	92
	93	return out - buf;
	94	}
	95
51e2f62f JA	96	static int uhci_show_urbp(struct uhci_hcd uhci, struct urb_priv urbp,
51e2f62f JA	97	char *buf, int len, int space)
1da177e4 LT	98	{
1da177e4 LT	99	char *out = buf;
1da177e4	100	struct uhci_td *td;
dccf4a48	101	int i, nactive, ninactive;
4de7d2c2	102	char *ptype;
dccf4a48 AS	103
	104	if (len < 200)
	105	return 0;
	106
	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"));
	113
	114	switch (usb_pipetype(urbp->urb->pipe)) {
4de7d2c2 AS	115	case PIPE_ISOCHRONOUS: ptype = "ISO"; break;
	116	case PIPE_INTERRUPT: ptype = "INT"; break;
	117	case PIPE_BULK: ptype = "BLK"; break;
	118	default:
	119	case PIPE_CONTROL: ptype = "CTL"; break;
dccf4a48 AS	120	}
dccf4a48 AS	121
4de7d2c2	122	out += sprintf(out, "%s%s", ptype, (urbp->fsbr ? " FSBR" : ""));
7ea0a2bc AS	123	out += sprintf(out, " Actlen=%d%s", urbp->urb->actual_length,
	124	(urbp->qh->type == USB_ENDPOINT_XFER_CONTROL ?
	125	"-8" : ""));
dccf4a48	126
eb231054 AS	127	if (urbp->urb->unlinked)
eb231054 AS	128	out += sprintf(out, " Unlinked=%d", urbp->urb->unlinked);
dccf4a48 AS	129	out += sprintf(out, "\n");
	130
	131	i = nactive = ninactive = 0;
	132	list_for_each_entry(td, &urbp->td_list, list) {
c8155cc5 AS	133	if (urbp->qh->type != USB_ENDPOINT_XFER_ISOC &&
c8155cc5 AS	134	(++i <= 10 \|\| debug > 2)) {
dccf4a48	135	out += sprintf(out, "%*s%d: ", space + 2, "", i);
51e2f62f JA	136	out += uhci_show_td(uhci, td, out,
51e2f62f JA	137	len - (out - buf), 0);
dccf4a48	138	} else {
51e2f62f	139	if (td_status(uhci, td) & TD_CTRL_ACTIVE)
dccf4a48 AS	140	++nactive;
	141	else
	142	++ninactive;
	143	}
	144	}
	145	if (nactive + ninactive > 0)
	146	out += sprintf(out, "%*s[skipped %d inactive and %d active "
	147	"TDs]\n",
	148	space, "", ninactive, nactive);
	149
	150	return out - buf;
	151	}
	152
e009f1b2 AS	153	static int uhci_show_qh(struct uhci_hcd *uhci,
e009f1b2 AS	154	struct uhci_qh qh, char buf, int len, int space)
dccf4a48 AS	155	{
	156	char *out = buf;
	157	int i, nurbs;
51e2f62f	158	__hc32 element = qh_element(qh);
4de7d2c2	159	char *qtype;
1da177e4 LT	160
1da177e4 LT	161	/* Try to make sure there's enough memory */
caf3827a	162	if (len < 80 * 7)
1da177e4 LT	163	return 0;
1da177e4 LT	164
4de7d2c2 AS	165	switch (qh->type) {
	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;
	171	}
	172
	173	out += sprintf(out, "%*s[%p] %s QH link (%08x) element (%08x)\n",
	174	space, "", qh, qtype,
51e2f62f JA	175	hc32_to_cpu(uhci, qh->link),
51e2f62f JA	176	hc32_to_cpu(uhci, element));
caf3827a	177	if (qh->type == USB_ENDPOINT_XFER_ISOC)
3ca2a321 AS	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);
1da177e4	185
51e2f62f	186	if (element & UHCI_PTR_QH(uhci))
1da177e4 LT	187	out += sprintf(out, "%*s Element points to QH (bug?)\n", space, "");
1da177e4 LT	188
51e2f62f	189	if (element & UHCI_PTR_DEPTH(uhci))
1da177e4 LT	190	out += sprintf(out, "%*s Depth traverse\n", space, "");
1da177e4 LT	191
51e2f62f	192	if (element & cpu_to_hc32(uhci, 8))
1da177e4 LT	193	out += sprintf(out, "%*s Bit 3 set (bug?)\n", space, "");
1da177e4 LT	194
51e2f62f	195	if (!(element & ~(UHCI_PTR_QH(uhci) \| UHCI_PTR_DEPTH(uhci))))
1da177e4 LT	196	out += sprintf(out, "%*s Element is NULL (bug?)\n", space, "");
1da177e4 LT	197
dccf4a48 AS	198	if (list_empty(&qh->queue)) {
dccf4a48 AS	199	out += sprintf(out, "%*s queue is empty\n", space, "");
e009f1b2	200	if (qh == uhci->skel_async_qh)
51e2f62f	201	out += uhci_show_td(uhci, uhci->term_td, out,
e009f1b2	202	len - (out - buf), 0);
dccf4a48 AS	203	} else {
	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);
	208
51e2f62f	209	if (element != LINK_TO_TD(uhci, td))
dccf4a48 AS	210	out += sprintf(out, "%*s Element != First TD\n",
	211	space, "");
	212	i = nurbs = 0;
	213	list_for_each_entry(urbp, &qh->queue, node) {
	214	if (++i <= 10)
51e2f62f	215	out += uhci_show_urbp(uhci, urbp, out,
dccf4a48 AS	216	len - (out - buf), space + 2);
	217	else
	218	++nurbs;
1da177e4	219	}
dccf4a48 AS	220	if (nurbs > 0)
	221	out += sprintf(out, "%*s Skipped %d URBs\n",
	222	space, "", nurbs);
1da177e4 LT	223	}
1da177e4 LT	224
85a975d0	225	if (qh->dummy_td) {
af0bb599	226	out += sprintf(out, "%*s Dummy TD\n", space, "");
51e2f62f JA	227	out += uhci_show_td(uhci, qh->dummy_td, out,
51e2f62f JA	228	len - (out - buf), 0);
af0bb599 AS	229	}
af0bb599 AS	230
1da177e4 LT	231	return out - buf;
	232	}
	233
1da177e4 LT	234	static int uhci_show_sc(int port, unsigned short status, char *buf, int len)
	235	{
	236	char *out = buf;
	237
	238	/* Try to make sure there's enough memory */
	239	if (len < 160)
	240	return 0;
	241
	242	out += sprintf(out, " stat%d = %04x %s%s%s%s%s%s%s%s%s%s\n",
	243	port,
	244	status,
	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" : "");
	255
	256	return out - buf;
	257	}
	258
c8f4fe43 AS	259	static int uhci_show_root_hub_state(struct uhci_hcd uhci, char buf, int len)
	260	{
	261	char *out = buf;
	262	char *rh_state;
	263
	264	/* Try to make sure there's enough memory */
	265	if (len < 60)
	266	return 0;
	267
	268	switch (uhci->rh_state) {
	269	case UHCI_RH_RESET:
	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;
	283	default:
	284	rh_state = "?"; break;
	285	}
84afddd7 AS	286	out += sprintf(out, "Root-hub state: %s FSBR: %d\n",
84afddd7 AS	287	rh_state, uhci->fsbr_is_on);
c8f4fe43 AS	288	return out - buf;
	289	}
	290
1da177e4 LT	291	static int uhci_show_status(struct uhci_hcd uhci, char buf, int len)
	292	{
	293	char *out = buf;
1da177e4 LT	294	unsigned short usbcmd, usbstat, usbint, usbfrnum;
	295	unsigned int flbaseadd;
	296	unsigned char sof;
	297	unsigned short portsc1, portsc2;
	298
	299	/* Try to make sure there's enough memory */
c4334726	300	if (len < 80 * 9)
1da177e4 LT	301	return 0;
1da177e4 LT	302
9faa091a JA	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);
1da177e4 LT	311
	312	out += sprintf(out, " usbcmd = %04x %s%s%s%s%s%s%s%s\n",
	313	usbcmd,
	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 " : "");
	322
	323	out += sprintf(out, " usbstat = %04x %s%s%s%s%s%s\n",
	324	usbstat,
	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 " : "");
	331
	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));
c8155cc5 AS	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);
1da177e4 LT	343
	344	return out - buf;
	345	}
	346
1da177e4 LT	347	static int uhci_sprint_schedule(struct uhci_hcd uhci, char buf, int len)
1da177e4 LT	348	{
1da177e4 LT	349	char *out = buf;
	350	int i, j;
	351	struct uhci_qh *qh;
	352	struct uhci_td *td;
	353	struct list_head tmp, head;
f3fe239b	354	int nframes, nerrs;
51e2f62f JA	355	__hc32 link;
51e2f62f JA	356	__hc32 fsbr_link;
17230acd AS	357
	358	static const char * const qh_names[] = {
	359	"unlink", "iso", "int128", "int64", "int32", "int16",
	360	"int8", "int4", "int2", "async", "term"
	361	};
1da177e4	362
c8f4fe43	363	out += uhci_show_root_hub_state(uhci, out, len - (out - buf));
1da177e4 LT	364	out += sprintf(out, "HC status\n");
1da177e4 LT	365	out += uhci_show_status(uhci, out, len - (out - buf));
3ca2a321 AS	366
	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]);
	370	if (i % 8 == 7)
	371	*out++ = '\n';
	372	}
	373	out += sprintf(out, "Total: %d, #INT: %d, #ISO: %d\n",
	374	uhci->total_load,
	375	uhci_to_hcd(uhci)->self.bandwidth_int_reqs,
	376	uhci_to_hcd(uhci)->self.bandwidth_isoc_reqs);
dccf4a48 AS	377	if (debug <= 1)
dccf4a48 AS	378	return out - buf;
1da177e4 LT	379
1da177e4 LT	380	out += sprintf(out, "Frame List\n");
f3fe239b AS	381	nframes = 10;
f3fe239b AS	382	nerrs = 0;
1da177e4	383	for (i = 0; i < UHCI_NUMFRAMES; ++i) {
51e2f62f	384	__hc32 qh_dma;
f3fe239b AS	385
f3fe239b AS	386	j = 0;
a1d59ce8	387	td = uhci->frame_cpu[i];
f3fe239b	388	link = uhci->frame[i];
1da177e4	389	if (!td)
f3fe239b	390	goto check_link;
1da177e4	391
f3fe239b AS	392	if (nframes > 0) {
f3fe239b AS	393	out += sprintf(out, "- Frame %d -> (%08x)\n",
51e2f62f	394	i, hc32_to_cpu(uhci, link));
f3fe239b AS	395	j = 1;
f3fe239b AS	396	}
1da177e4 LT	397
	398	head = &td->fl_list;
	399	tmp = head;
	400	do {
	401	td = list_entry(tmp, struct uhci_td, fl_list);
	402	tmp = tmp->next;
51e2f62f	403	if (link != LINK_TO_TD(uhci, td)) {
f3fe239b AS	404	if (nframes > 0)
	405	out += sprintf(out, " link does "
	406	"not match list entry!\n");
	407	else
	408	++nerrs;
	409	}
	410	if (nframes > 0)
51e2f62f	411	out += uhci_show_td(uhci, td, out,
f3fe239b AS	412	len - (out - buf), 4);
f3fe239b AS	413	link = td->link;
1da177e4	414	} while (tmp != head);
f3fe239b AS	415
	416	check_link:
	417	qh_dma = uhci_frame_skel_link(uhci, i);
	418	if (link != qh_dma) {
	419	if (nframes > 0) {
	420	if (!j) {
	421	out += sprintf(out,
	422	"- Frame %d -> (%08x)\n",
51e2f62f	423	i, hc32_to_cpu(uhci, link));
f3fe239b AS	424	j = 1;
	425	}
	426	out += sprintf(out, " link does not match "
51e2f62f JA	427	"QH (%08x)!\n",
51e2f62f JA	428	hc32_to_cpu(uhci, qh_dma));
f3fe239b AS	429	} else
	430	++nerrs;
	431	}
	432	nframes -= j;
1da177e4	433	}
f3fe239b AS	434	if (nerrs > 0)
f3fe239b AS	435	out += sprintf(out, "Skipped %d bad links\n", nerrs);
1da177e4	436
687f5f34	437	out += sprintf(out, "Skeleton QHs\n");
1da177e4	438
e009f1b2	439	fsbr_link = 0;
1da177e4	440	for (i = 0; i < UHCI_NUM_SKELQH; ++i) {
dccf4a48	441	int cnt = 0;
1da177e4 LT	442
1da177e4 LT	443	qh = uhci->skelqh[i];
17230acd	444	out += sprintf(out, "- skel_%s_qh\n", qh_names[i]); \
e009f1b2	445	out += uhci_show_qh(uhci, qh, out, len - (out - buf), 4);
1da177e4 LT	446
1da177e4 LT	447	/* Last QH is the Terminating QH, it's different */
17230acd	448	if (i == SKEL_TERM) {
51e2f62f	449	if (qh_element(qh) != LINK_TO_TD(uhci, uhci->term_td))
1da177e4	450	out += sprintf(out, " skel_term_qh element is not set to term_td!\n");
e009f1b2 AS	451	link = fsbr_link;
e009f1b2 AS	452	if (!link)
51e2f62f	453	link = LINK_TO_QH(uhci, uhci->skel_term_qh);
e009f1b2	454	goto check_qh_link;
1da177e4 LT	455	}
1da177e4 LT	456
dccf4a48	457	head = &qh->node;
1da177e4 LT	458	tmp = head->next;
	459
	460	while (tmp != head) {
dccf4a48	461	qh = list_entry(tmp, struct uhci_qh, node);
1da177e4	462	tmp = tmp->next;
dccf4a48	463	if (++cnt <= 10)
e009f1b2	464	out += uhci_show_qh(uhci, qh, out,
dccf4a48	465	len - (out - buf), 4);
17230acd	466	if (!fsbr_link && qh->skel >= SKEL_FSBR)
51e2f62f	467	fsbr_link = LINK_TO_QH(uhci, qh);
1da177e4	468	}
dccf4a48 AS	469	if ((cnt -= 10) > 0)
dccf4a48 AS	470	out += sprintf(out, " Skipped %d QHs\n", cnt);
1da177e4	471
51e2f62f	472	link = UHCI_PTR_TERM(uhci);
17230acd AS	473	if (i <= SKEL_ISO)
	474	;
	475	else if (i < SKEL_ASYNC)
51e2f62f	476	link = LINK_TO_QH(uhci, uhci->skel_async_qh);
17230acd AS	477	else if (!uhci->fsbr_is_on)
17230acd AS	478	;
17230acd	479	else
51e2f62f	480	link = LINK_TO_QH(uhci, uhci->skel_term_qh);
17230acd AS	481	check_qh_link:
	482	if (qh->link != link)
	483	out += sprintf(out, " last QH not linked to next skeleton!\n");
1da177e4 LT	484	}
1da177e4 LT	485
1da177e4 LT	486	return out - buf;
	487	}
	488
8d402e1a AS	489	#ifdef CONFIG_DEBUG_FS
8d402e1a AS	490
1da177e4 LT	491	#define MAX_OUTPUT (64 * 1024)
	492
	493	struct uhci_debug {
	494	int size;
	495	char *data;
1da177e4 LT	496	};
	497
	498	static int uhci_debug_open(struct inode inode, struct file file)
	499	{
8e18e294	500	struct uhci_hcd *uhci = inode->i_private;
1da177e4	501	struct uhci_debug *up;
dccf4a48	502	unsigned long flags;
1da177e4	503
1da177e4 LT	504	up = kmalloc(sizeof(*up), GFP_KERNEL);
1da177e4 LT	505	if (!up)
00b81fb2	506	return -ENOMEM;
1da177e4 LT	507
	508	up->data = kmalloc(MAX_OUTPUT, GFP_KERNEL);
	509	if (!up->data) {
	510	kfree(up);
00b81fb2	511	return -ENOMEM;
1da177e4 LT	512	}
1da177e4 LT	513
8d402e1a	514	up->size = 0;
dccf4a48	515	spin_lock_irqsave(&uhci->lock, flags);
8d402e1a AS	516	if (uhci->is_initialized)
8d402e1a AS	517	up->size = uhci_sprint_schedule(uhci, up->data, MAX_OUTPUT);
dccf4a48	518	spin_unlock_irqrestore(&uhci->lock, flags);
1da177e4 LT	519
	520	file->private_data = up;
	521
00b81fb2	522	return 0;
1da177e4 LT	523	}
	524
	525	static loff_t uhci_debug_lseek(struct file *file, loff_t off, int whence)
	526	{
	527	struct uhci_debug *up;
	528	loff_t new = -1;
	529
1da177e4 LT	530	up = file->private_data;
1da177e4 LT	531
00b81fb2	532	/* XXX: atomic 64bit seek access, but that needs to be fixed in the VFS */
1da177e4 LT	533	switch (whence) {
	534	case 0:
	535	new = off;
	536	break;
	537	case 1:
	538	new = file->f_pos + off;
	539	break;
	540	}
00b81fb2 AK	541
00b81fb2 AK	542	if (new < 0 \|\| new > up->size)
1da177e4	543	return -EINVAL;
00b81fb2	544
1da177e4 LT	545	return (file->f_pos = new);
	546	}
	547
	548	static ssize_t uhci_debug_read(struct file file, char __user buf,
	549	size_t nbytes, loff_t *ppos)
	550	{
	551	struct uhci_debug *up = file->private_data;
	552	return simple_read_from_buffer(buf, nbytes, ppos, up->data, up->size);
	553	}
	554
	555	static int uhci_debug_release(struct inode inode, struct file file)
	556	{
	557	struct uhci_debug *up = file->private_data;
	558
	559	kfree(up->data);
	560	kfree(up);
	561
	562	return 0;
	563	}
	564
066202dd	565	static const struct file_operations uhci_debug_operations = {
8d402e1a	566	.owner = THIS_MODULE,
1da177e4 LT	567	.open = uhci_debug_open,
	568	.llseek = uhci_debug_lseek,
	569	.read = uhci_debug_read,
	570	.release = uhci_debug_release,
	571	};
b409214c	572	#define UHCI_DEBUG_OPS
1da177e4	573
8d402e1a	574	#endif /* CONFIG_DEBUG_FS */
1da177e4	575
8d402e1a AS	576	#else /* DEBUG */
	577
	578	static inline void lprintk(char *buf)
	579	{}
	580
e009f1b2 AS	581	static inline int uhci_show_qh(struct uhci_hcd *uhci,
e009f1b2 AS	582	struct uhci_qh qh, char buf, int len, int space)
8d402e1a AS	583	{
	584	return 0;
	585	}
	586
	587	static inline int uhci_sprint_schedule(struct uhci_hcd *uhci,
	588	char *buf, int len)
	589	{
	590	return 0;
	591	}
1da177e4 LT	592
1da177e4 LT	593	#endif