1/*
2 * Copyright (c) 2001-2002 by David Brownell
3 *
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License as published by the
6 * Free Software Foundation; either version 2 of the License, or (at your
7 * option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
11 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
12 * for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software Foundation,
16 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17 */
18
19/* this file is part of ehci-hcd.c */
20
21#ifdef CONFIG_DYNAMIC_DEBUG
22
23/* check the values in the HCSPARAMS register
24 * (host controller _Structural_ parameters)
25 * see EHCI spec, Table 2-4 for each value
26 */
27static void dbg_hcs_params (struct ehci_hcd *ehci, char *label)
28{
29	u32	params = ehci_readl(ehci, &ehci->caps->hcs_params);
30
31	ehci_dbg (ehci,
32		"%s hcs_params 0x%x dbg=%d%s cc=%d pcc=%d%s%s ports=%d\n",
33		label, params,
34		HCS_DEBUG_PORT (params),
35		HCS_INDICATOR (params) ? " ind" : "",
36		HCS_N_CC (params),
37		HCS_N_PCC (params),
38		HCS_PORTROUTED (params) ? "" : " ordered",
39		HCS_PPC (params) ? "" : " !ppc",
40		HCS_N_PORTS (params)
41		);
42	/* Port routing, per EHCI 0.95 Spec, Section 2.2.5 */
43	if (HCS_PORTROUTED (params)) {
44		int i;
45		char buf [46], tmp [7], byte;
46
47		buf[0] = 0;
48		for (i = 0; i < HCS_N_PORTS (params); i++) {
49			// FIXME MIPS won't readb() ...
50			byte = readb (&ehci->caps->portroute[(i>>1)]);
51			sprintf(tmp, "%d ",
52				((i & 0x1) ? ((byte)&0xf) : ((byte>>4)&0xf)));
53			strcat(buf, tmp);
54		}
55		ehci_dbg (ehci, "%s portroute %s\n",
56				label, buf);
57	}
58}
59#else
60
61static inline void dbg_hcs_params (struct ehci_hcd *ehci, char *label) {}
62
63#endif
64
65#ifdef CONFIG_DYNAMIC_DEBUG
66
67/* check the values in the HCCPARAMS register
68 * (host controller _Capability_ parameters)
69 * see EHCI Spec, Table 2-5 for each value
70 * */
71static void dbg_hcc_params (struct ehci_hcd *ehci, char *label)
72{
73	u32	params = ehci_readl(ehci, &ehci->caps->hcc_params);
74
75	if (HCC_ISOC_CACHE (params)) {
76		ehci_dbg (ehci,
77			"%s hcc_params %04x caching frame %s%s%s\n",
78			label, params,
79			HCC_PGM_FRAMELISTLEN(params) ? "256/512/1024" : "1024",
80			HCC_CANPARK(params) ? " park" : "",
81			HCC_64BIT_ADDR(params) ? " 64 bit addr" : "");
82	} else {
83		ehci_dbg (ehci,
84			"%s hcc_params %04x thresh %d uframes %s%s%s%s%s%s%s\n",
85			label,
86			params,
87			HCC_ISOC_THRES(params),
88			HCC_PGM_FRAMELISTLEN(params) ? "256/512/1024" : "1024",
89			HCC_CANPARK(params) ? " park" : "",
90			HCC_64BIT_ADDR(params) ? " 64 bit addr" : "",
91			HCC_LPM(params) ? " LPM" : "",
92			HCC_PER_PORT_CHANGE_EVENT(params) ? " ppce" : "",
93			HCC_HW_PREFETCH(params) ? " hw prefetch" : "",
94			HCC_32FRAME_PERIODIC_LIST(params) ?
95				" 32 periodic list" : "");
96	}
97}
98#else
99
100static inline void dbg_hcc_params (struct ehci_hcd *ehci, char *label) {}
101
102#endif
103
104#ifdef CONFIG_DYNAMIC_DEBUG
105
106static void __maybe_unused
107dbg_qtd (const char *label, struct ehci_hcd *ehci, struct ehci_qtd *qtd)
108{
109	ehci_dbg(ehci, "%s td %p n%08x %08x t%08x p0=%08x\n", label, qtd,
110		hc32_to_cpup(ehci, &qtd->hw_next),
111		hc32_to_cpup(ehci, &qtd->hw_alt_next),
112		hc32_to_cpup(ehci, &qtd->hw_token),
113		hc32_to_cpup(ehci, &qtd->hw_buf [0]));
114	if (qtd->hw_buf [1])
115		ehci_dbg(ehci, "  p1=%08x p2=%08x p3=%08x p4=%08x\n",
116			hc32_to_cpup(ehci, &qtd->hw_buf[1]),
117			hc32_to_cpup(ehci, &qtd->hw_buf[2]),
118			hc32_to_cpup(ehci, &qtd->hw_buf[3]),
119			hc32_to_cpup(ehci, &qtd->hw_buf[4]));
120}
121
122static void __maybe_unused
123dbg_qh (const char *label, struct ehci_hcd *ehci, struct ehci_qh *qh)
124{
125	struct ehci_qh_hw *hw = qh->hw;
126
127	ehci_dbg (ehci, "%s qh %p n%08x info %x %x qtd %x\n", label,
128		qh, hw->hw_next, hw->hw_info1, hw->hw_info2, hw->hw_current);
129	dbg_qtd("overlay", ehci, (struct ehci_qtd *) &hw->hw_qtd_next);
130}
131
132static void __maybe_unused
133dbg_itd (const char *label, struct ehci_hcd *ehci, struct ehci_itd *itd)
134{
135	ehci_dbg (ehci, "%s [%d] itd %p, next %08x, urb %p\n",
136		label, itd->frame, itd, hc32_to_cpu(ehci, itd->hw_next),
137		itd->urb);
138	ehci_dbg (ehci,
139		"  trans: %08x %08x %08x %08x %08x %08x %08x %08x\n",
140		hc32_to_cpu(ehci, itd->hw_transaction[0]),
141		hc32_to_cpu(ehci, itd->hw_transaction[1]),
142		hc32_to_cpu(ehci, itd->hw_transaction[2]),
143		hc32_to_cpu(ehci, itd->hw_transaction[3]),
144		hc32_to_cpu(ehci, itd->hw_transaction[4]),
145		hc32_to_cpu(ehci, itd->hw_transaction[5]),
146		hc32_to_cpu(ehci, itd->hw_transaction[6]),
147		hc32_to_cpu(ehci, itd->hw_transaction[7]));
148	ehci_dbg (ehci,
149		"  buf:   %08x %08x %08x %08x %08x %08x %08x\n",
150		hc32_to_cpu(ehci, itd->hw_bufp[0]),
151		hc32_to_cpu(ehci, itd->hw_bufp[1]),
152		hc32_to_cpu(ehci, itd->hw_bufp[2]),
153		hc32_to_cpu(ehci, itd->hw_bufp[3]),
154		hc32_to_cpu(ehci, itd->hw_bufp[4]),
155		hc32_to_cpu(ehci, itd->hw_bufp[5]),
156		hc32_to_cpu(ehci, itd->hw_bufp[6]));
157	ehci_dbg (ehci, "  index: %d %d %d %d %d %d %d %d\n",
158		itd->index[0], itd->index[1], itd->index[2],
159		itd->index[3], itd->index[4], itd->index[5],
160		itd->index[6], itd->index[7]);
161}
162
163static void __maybe_unused
164dbg_sitd (const char *label, struct ehci_hcd *ehci, struct ehci_sitd *sitd)
165{
166	ehci_dbg (ehci, "%s [%d] sitd %p, next %08x, urb %p\n",
167		label, sitd->frame, sitd, hc32_to_cpu(ehci, sitd->hw_next),
168		sitd->urb);
169	ehci_dbg (ehci,
170		"  addr %08x sched %04x result %08x buf %08x %08x\n",
171		hc32_to_cpu(ehci, sitd->hw_fullspeed_ep),
172		hc32_to_cpu(ehci, sitd->hw_uframe),
173		hc32_to_cpu(ehci, sitd->hw_results),
174		hc32_to_cpu(ehci, sitd->hw_buf[0]),
175		hc32_to_cpu(ehci, sitd->hw_buf[1]));
176}
177
178static int __maybe_unused
179dbg_status_buf (char *buf, unsigned len, const char *label, u32 status)
180{
181	return scnprintf (buf, len,
182		"%s%sstatus %04x%s%s%s%s%s%s%s%s%s%s%s",
183		label, label [0] ? " " : "", status,
184		(status & STS_PPCE_MASK) ? " PPCE" : "",
185		(status & STS_ASS) ? " Async" : "",
186		(status & STS_PSS) ? " Periodic" : "",
187		(status & STS_RECL) ? " Recl" : "",
188		(status & STS_HALT) ? " Halt" : "",
189		(status & STS_IAA) ? " IAA" : "",
190		(status & STS_FATAL) ? " FATAL" : "",
191		(status & STS_FLR) ? " FLR" : "",
192		(status & STS_PCD) ? " PCD" : "",
193		(status & STS_ERR) ? " ERR" : "",
194		(status & STS_INT) ? " INT" : ""
195		);
196}
197
198static int __maybe_unused
199dbg_intr_buf (char *buf, unsigned len, const char *label, u32 enable)
200{
201	return scnprintf (buf, len,
202		"%s%sintrenable %02x%s%s%s%s%s%s%s",
203		label, label [0] ? " " : "", enable,
204		(enable & STS_PPCE_MASK) ? " PPCE" : "",
205		(enable & STS_IAA) ? " IAA" : "",
206		(enable & STS_FATAL) ? " FATAL" : "",
207		(enable & STS_FLR) ? " FLR" : "",
208		(enable & STS_PCD) ? " PCD" : "",
209		(enable & STS_ERR) ? " ERR" : "",
210		(enable & STS_INT) ? " INT" : ""
211		);
212}
213
214static const char *const fls_strings [] =
215    { "1024", "512", "256", "??" };
216
217static int
218dbg_command_buf (char *buf, unsigned len, const char *label, u32 command)
219{
220	return scnprintf (buf, len,
221		"%s%scommand %07x %s%s%s%s%s%s=%d ithresh=%d%s%s%s%s "
222		"period=%s%s %s",
223		label, label [0] ? " " : "", command,
224		(command & CMD_HIRD) ? " HIRD" : "",
225		(command & CMD_PPCEE) ? " PPCEE" : "",
226		(command & CMD_FSP) ? " FSP" : "",
227		(command & CMD_ASPE) ? " ASPE" : "",
228		(command & CMD_PSPE) ? " PSPE" : "",
229		(command & CMD_PARK) ? " park" : "(park)",
230		CMD_PARK_CNT (command),
231		(command >> 16) & 0x3f,
232		(command & CMD_LRESET) ? " LReset" : "",
233		(command & CMD_IAAD) ? " IAAD" : "",
234		(command & CMD_ASE) ? " Async" : "",
235		(command & CMD_PSE) ? " Periodic" : "",
236		fls_strings [(command >> 2) & 0x3],
237		(command & CMD_RESET) ? " Reset" : "",
238		(command & CMD_RUN) ? "RUN" : "HALT"
239		);
240}
241
242static int
243dbg_port_buf (char *buf, unsigned len, const char *label, int port, u32 status)
244{
245	char	*sig;
246
247	/* signaling state */
248	switch (status & (3 << 10)) {
249	case 0 << 10: sig = "se0"; break;
250	case 1 << 10: sig = "k"; break;		/* low speed */
251	case 2 << 10: sig = "j"; break;
252	default: sig = "?"; break;
253	}
254
255	return scnprintf (buf, len,
256		"%s%sport:%d status %06x %d %s%s%s%s%s%s "
257		"sig=%s%s%s%s%s%s%s%s%s%s%s",
258		label, label [0] ? " " : "", port, status,
259		status>>25,/*device address */
260		(status & PORT_SSTS)>>23 == PORTSC_SUSPEND_STS_ACK ?
261						" ACK" : "",
262		(status & PORT_SSTS)>>23 == PORTSC_SUSPEND_STS_NYET ?
263						" NYET" : "",
264		(status & PORT_SSTS)>>23 == PORTSC_SUSPEND_STS_STALL ?
265						" STALL" : "",
266		(status & PORT_SSTS)>>23 == PORTSC_SUSPEND_STS_ERR ?
267						" ERR" : "",
268		(status & PORT_POWER) ? " POWER" : "",
269		(status & PORT_OWNER) ? " OWNER" : "",
270		sig,
271		(status & PORT_LPM) ? " LPM" : "",
272		(status & PORT_RESET) ? " RESET" : "",
273		(status & PORT_SUSPEND) ? " SUSPEND" : "",
274		(status & PORT_RESUME) ? " RESUME" : "",
275		(status & PORT_OCC) ? " OCC" : "",
276		(status & PORT_OC) ? " OC" : "",
277		(status & PORT_PEC) ? " PEC" : "",
278		(status & PORT_PE) ? " PE" : "",
279		(status & PORT_CSC) ? " CSC" : "",
280		(status & PORT_CONNECT) ? " CONNECT" : "");
281}
282
283#else
284static inline void __maybe_unused
285dbg_qh (char *label, struct ehci_hcd *ehci, struct ehci_qh *qh)
286{}
287
288static inline int __maybe_unused
289dbg_status_buf (char *buf, unsigned len, const char *label, u32 status)
290{ return 0; }
291
292static inline int __maybe_unused
293dbg_command_buf (char *buf, unsigned len, const char *label, u32 command)
294{ return 0; }
295
296static inline int __maybe_unused
297dbg_intr_buf (char *buf, unsigned len, const char *label, u32 enable)
298{ return 0; }
299
300static inline int __maybe_unused
301dbg_port_buf (char *buf, unsigned len, const char *label, int port, u32 status)
302{ return 0; }
303
304#endif	/* CONFIG_DYNAMIC_DEBUG */
305
306/* functions have the "wrong" filename when they're output... */
307#define dbg_status(ehci, label, status) { \
308	char _buf [80]; \
309	dbg_status_buf (_buf, sizeof _buf, label, status); \
310	ehci_dbg (ehci, "%s\n", _buf); \
311}
312
313#define dbg_cmd(ehci, label, command) { \
314	char _buf [80]; \
315	dbg_command_buf (_buf, sizeof _buf, label, command); \
316	ehci_dbg (ehci, "%s\n", _buf); \
317}
318
319#define dbg_port(ehci, label, port, status) { \
320	char _buf [80]; \
321	dbg_port_buf (_buf, sizeof _buf, label, port, status); \
322	ehci_dbg (ehci, "%s\n", _buf); \
323}
324
325/*-------------------------------------------------------------------------*/
326
327#ifdef STUB_DEBUG_FILES
328
329static inline void create_debug_files (struct ehci_hcd *bus) { }
330static inline void remove_debug_files (struct ehci_hcd *bus) { }
331
332#else
333
334/* troubleshooting help: expose state in debugfs */
335
336static int debug_async_open(struct inode *, struct file *);
337static int debug_bandwidth_open(struct inode *, struct file *);
338static int debug_periodic_open(struct inode *, struct file *);
339static int debug_registers_open(struct inode *, struct file *);
340
341static ssize_t debug_output(struct file*, char __user*, size_t, loff_t*);
342static int debug_close(struct inode *, struct file *);
343
344static const struct file_operations debug_async_fops = {
345	.owner		= THIS_MODULE,
346	.open		= debug_async_open,
347	.read		= debug_output,
348	.release	= debug_close,
349	.llseek		= default_llseek,
350};
351static const struct file_operations debug_bandwidth_fops = {
352	.owner		= THIS_MODULE,
353	.open		= debug_bandwidth_open,
354	.read		= debug_output,
355	.release	= debug_close,
356	.llseek		= default_llseek,
357};
358static const struct file_operations debug_periodic_fops = {
359	.owner		= THIS_MODULE,
360	.open		= debug_periodic_open,
361	.read		= debug_output,
362	.release	= debug_close,
363	.llseek		= default_llseek,
364};
365static const struct file_operations debug_registers_fops = {
366	.owner		= THIS_MODULE,
367	.open		= debug_registers_open,
368	.read		= debug_output,
369	.release	= debug_close,
370	.llseek		= default_llseek,
371};
372
373static struct dentry *ehci_debug_root;
374
375struct debug_buffer {
376	ssize_t (*fill_func)(struct debug_buffer *);	/* fill method */
377	struct usb_bus *bus;
378	struct mutex mutex;	/* protect filling of buffer */
379	size_t count;		/* number of characters filled into buffer */
380	char *output_buf;
381	size_t alloc_size;
382};
383
384#define speed_char(info1) ({ char tmp; \
385		switch (info1 & (3 << 12)) { \
386		case QH_FULL_SPEED: tmp = 'f'; break; \
387		case QH_LOW_SPEED:  tmp = 'l'; break; \
388		case QH_HIGH_SPEED: tmp = 'h'; break; \
389		default: tmp = '?'; break; \
390		} tmp; })
391
392static inline char token_mark(struct ehci_hcd *ehci, __hc32 token)
393{
394	__u32 v = hc32_to_cpu(ehci, token);
395
396	if (v & QTD_STS_ACTIVE)
397		return '*';
398	if (v & QTD_STS_HALT)
399		return '-';
400	if (!IS_SHORT_READ (v))
401		return ' ';
402	/* tries to advance through hw_alt_next */
403	return '/';
404}
405
406static void qh_lines (
407	struct ehci_hcd *ehci,
408	struct ehci_qh *qh,
409	char **nextp,
410	unsigned *sizep
411)
412{
413	u32			scratch;
414	u32			hw_curr;
415	struct list_head	*entry;
416	struct ehci_qtd		*td;
417	unsigned		temp;
418	unsigned		size = *sizep;
419	char			*next = *nextp;
420	char			mark;
421	__le32			list_end = EHCI_LIST_END(ehci);
422	struct ehci_qh_hw	*hw = qh->hw;
423
424	if (hw->hw_qtd_next == list_end)	/* NEC does this */
425		mark = '@';
426	else
427		mark = token_mark(ehci, hw->hw_token);
428	if (mark == '/') {	/* qh_alt_next controls qh advance? */
429		if ((hw->hw_alt_next & QTD_MASK(ehci))
430				== ehci->async->hw->hw_alt_next)
431			mark = '#';	/* blocked */
432		else if (hw->hw_alt_next == list_end)
433			mark = '.';	/* use hw_qtd_next */
434		/* else alt_next points to some other qtd */
435	}
436	scratch = hc32_to_cpup(ehci, &hw->hw_info1);
437	hw_curr = (mark == '*') ? hc32_to_cpup(ehci, &hw->hw_current) : 0;
438	temp = scnprintf (next, size,
439			"qh/%p dev%d %cs ep%d %08x %08x (%08x%c %s nak%d)",
440			qh, scratch & 0x007f,
441			speed_char (scratch),
442			(scratch >> 8) & 0x000f,
443			scratch, hc32_to_cpup(ehci, &hw->hw_info2),
444			hc32_to_cpup(ehci, &hw->hw_token), mark,
445			(cpu_to_hc32(ehci, QTD_TOGGLE) & hw->hw_token)
446				? "data1" : "data0",
447			(hc32_to_cpup(ehci, &hw->hw_alt_next) >> 1) & 0x0f);
448	size -= temp;
449	next += temp;
450
451	/* hc may be modifying the list as we read it ... */
452	list_for_each (entry, &qh->qtd_list) {
453		td = list_entry (entry, struct ehci_qtd, qtd_list);
454		scratch = hc32_to_cpup(ehci, &td->hw_token);
455		mark = ' ';
456		if (hw_curr == td->qtd_dma)
457			mark = '*';
458		else if (hw->hw_qtd_next == cpu_to_hc32(ehci, td->qtd_dma))
459			mark = '+';
460		else if (QTD_LENGTH (scratch)) {
461			if (td->hw_alt_next == ehci->async->hw->hw_alt_next)
462				mark = '#';
463			else if (td->hw_alt_next != list_end)
464				mark = '/';
465		}
466		temp = snprintf (next, size,
467				"\n\t%p%c%s len=%d %08x urb %p",
468				td, mark, ({ char *tmp;
469				 switch ((scratch>>8)&0x03) {
470				 case 0: tmp = "out"; break;
471				 case 1: tmp = "in"; break;
472				 case 2: tmp = "setup"; break;
473				 default: tmp = "?"; break;
474				 } tmp;}),
475				(scratch >> 16) & 0x7fff,
476				scratch,
477				td->urb);
478		if (size < temp)
479			temp = size;
480		size -= temp;
481		next += temp;
482		if (temp == size)
483			goto done;
484	}
485
486	temp = snprintf (next, size, "\n");
487	if (size < temp)
488		temp = size;
489	size -= temp;
490	next += temp;
491
492done:
493	*sizep = size;
494	*nextp = next;
495}
496
497static ssize_t fill_async_buffer(struct debug_buffer *buf)
498{
499	struct usb_hcd		*hcd;
500	struct ehci_hcd		*ehci;
501	unsigned long		flags;
502	unsigned		temp, size;
503	char			*next;
504	struct ehci_qh		*qh;
505
506	hcd = bus_to_hcd(buf->bus);
507	ehci = hcd_to_ehci (hcd);
508	next = buf->output_buf;
509	size = buf->alloc_size;
510
511	*next = 0;
512
513	/* dumps a snapshot of the async schedule.
514	 * usually empty except for long-term bulk reads, or head.
515	 * one QH per line, and TDs we know about
516	 */
517	spin_lock_irqsave (&ehci->lock, flags);
518	for (qh = ehci->async->qh_next.qh; size > 0 && qh; qh = qh->qh_next.qh)
519		qh_lines (ehci, qh, &next, &size);
520	if (!list_empty(&ehci->async_unlink) && size > 0) {
521		temp = scnprintf(next, size, "\nunlink =\n");
522		size -= temp;
523		next += temp;
524
525		list_for_each_entry(qh, &ehci->async_unlink, unlink_node) {
526			if (size <= 0)
527				break;
528			qh_lines(ehci, qh, &next, &size);
529		}
530	}
531	spin_unlock_irqrestore (&ehci->lock, flags);
532
533	return strlen(buf->output_buf);
534}
535
536static ssize_t fill_bandwidth_buffer(struct debug_buffer *buf)
537{
538	struct ehci_hcd		*ehci;
539	struct ehci_tt		*tt;
540	struct ehci_per_sched	*ps;
541	unsigned		temp, size;
542	char			*next;
543	unsigned		i;
544	u8			*bw;
545	u16			*bf;
546	u8			budget[EHCI_BANDWIDTH_SIZE];
547
548	ehci = hcd_to_ehci(bus_to_hcd(buf->bus));
549	next = buf->output_buf;
550	size = buf->alloc_size;
551
552	*next = 0;
553
554	spin_lock_irq(&ehci->lock);
555
556	/* Dump the HS bandwidth table */
557	temp = scnprintf(next, size,
558			"HS bandwidth allocation (us per microframe)\n");
559	size -= temp;
560	next += temp;
561	for (i = 0; i < EHCI_BANDWIDTH_SIZE; i += 8) {
562		bw = &ehci->bandwidth[i];
563		temp = scnprintf(next, size,
564				"%2u: %4u%4u%4u%4u%4u%4u%4u%4u\n",
565				i, bw[0], bw[1], bw[2], bw[3],
566					bw[4], bw[5], bw[6], bw[7]);
567		size -= temp;
568		next += temp;
569	}
570
571	/* Dump all the FS/LS tables */
572	list_for_each_entry(tt, &ehci->tt_list, tt_list) {
573		temp = scnprintf(next, size,
574				"\nTT %s port %d  FS/LS bandwidth allocation (us per frame)\n",
575				dev_name(&tt->usb_tt->hub->dev),
576				tt->tt_port + !!tt->usb_tt->multi);
577		size -= temp;
578		next += temp;
579
580		bf = tt->bandwidth;
581		temp = scnprintf(next, size,
582				"  %5u%5u%5u%5u%5u%5u%5u%5u\n",
583				bf[0], bf[1], bf[2], bf[3],
584					bf[4], bf[5], bf[6], bf[7]);
585		size -= temp;
586		next += temp;
587
588		temp = scnprintf(next, size,
589				"FS/LS budget (us per microframe)\n");
590		size -= temp;
591		next += temp;
592		compute_tt_budget(budget, tt);
593		for (i = 0; i < EHCI_BANDWIDTH_SIZE; i += 8) {
594			bw = &budget[i];
595			temp = scnprintf(next, size,
596					"%2u: %4u%4u%4u%4u%4u%4u%4u%4u\n",
597					i, bw[0], bw[1], bw[2], bw[3],
598						bw[4], bw[5], bw[6], bw[7]);
599			size -= temp;
600			next += temp;
601		}
602		list_for_each_entry(ps, &tt->ps_list, ps_list) {
603			temp = scnprintf(next, size,
604					"%s ep %02x:  %4u @ %2u.%u+%u mask %04x\n",
605					dev_name(&ps->udev->dev),
606					ps->ep->desc.bEndpointAddress,
607					ps->tt_usecs,
608					ps->bw_phase, ps->phase_uf,
609					ps->bw_period, ps->cs_mask);
610			size -= temp;
611			next += temp;
612		}
613	}
614	spin_unlock_irq(&ehci->lock);
615
616	return next - buf->output_buf;
617}
618
619#define DBG_SCHED_LIMIT 64
620static ssize_t fill_periodic_buffer(struct debug_buffer *buf)
621{
622	struct usb_hcd		*hcd;
623	struct ehci_hcd		*ehci;
624	unsigned long		flags;
625	union ehci_shadow	p, *seen;
626	unsigned		temp, size, seen_count;
627	char			*next;
628	unsigned		i;
629	__hc32			tag;
630
631	seen = kmalloc(DBG_SCHED_LIMIT * sizeof *seen, GFP_ATOMIC);
632	if (!seen)
633		return 0;
634	seen_count = 0;
635
636	hcd = bus_to_hcd(buf->bus);
637	ehci = hcd_to_ehci (hcd);
638	next = buf->output_buf;
639	size = buf->alloc_size;
640
641	temp = scnprintf (next, size, "size = %d\n", ehci->periodic_size);
642	size -= temp;
643	next += temp;
644
645	/* dump a snapshot of the periodic schedule.
646	 * iso changes, interrupt usually doesn't.
647	 */
648	spin_lock_irqsave (&ehci->lock, flags);
649	for (i = 0; i < ehci->periodic_size; i++) {
650		p = ehci->pshadow [i];
651		if (likely (!p.ptr))
652			continue;
653		tag = Q_NEXT_TYPE(ehci, ehci->periodic [i]);
654
655		temp = scnprintf (next, size, "%4d: ", i);
656		size -= temp;
657		next += temp;
658
659		do {
660			struct ehci_qh_hw *hw;
661
662			switch (hc32_to_cpu(ehci, tag)) {
663			case Q_TYPE_QH:
664				hw = p.qh->hw;
665				temp = scnprintf (next, size, " qh%d-%04x/%p",
666						p.qh->ps.period,
667						hc32_to_cpup(ehci,
668							&hw->hw_info2)
669							/* uframe masks */
670							& (QH_CMASK | QH_SMASK),
671						p.qh);
672				size -= temp;
673				next += temp;
674				/* don't repeat what follows this qh */
675				for (temp = 0; temp < seen_count; temp++) {
676					if (seen [temp].ptr != p.ptr)
677						continue;
678					if (p.qh->qh_next.ptr) {
679						temp = scnprintf (next, size,
680							" ...");
681						size -= temp;
682						next += temp;
683					}
684					break;
685				}
686				/* show more info the first time around */
687				if (temp == seen_count) {
688					u32	scratch = hc32_to_cpup(ehci,
689							&hw->hw_info1);
690					struct ehci_qtd	*qtd;
691					char		*type = "";
692
693					/* count tds, get ep direction */
694					temp = 0;
695					list_for_each_entry (qtd,
696							&p.qh->qtd_list,
697							qtd_list) {
698						temp++;
699						switch (0x03 & (hc32_to_cpu(
700							ehci,
701							qtd->hw_token) >> 8)) {
702						case 0: type = "out"; continue;
703						case 1: type = "in"; continue;
704						}
705					}
706
707					temp = scnprintf (next, size,
708						" (%c%d ep%d%s "
709						"[%d/%d] q%d p%d)",
710						speed_char (scratch),
711						scratch & 0x007f,
712						(scratch >> 8) & 0x000f, type,
713						p.qh->ps.usecs,
714						p.qh->ps.c_usecs,
715						temp,
716						0x7ff & (scratch >> 16));
717
718					if (seen_count < DBG_SCHED_LIMIT)
719						seen [seen_count++].qh = p.qh;
720				} else
721					temp = 0;
722				tag = Q_NEXT_TYPE(ehci, hw->hw_next);
723				p = p.qh->qh_next;
724				break;
725			case Q_TYPE_FSTN:
726				temp = scnprintf (next, size,
727					" fstn-%8x/%p", p.fstn->hw_prev,
728					p.fstn);
729				tag = Q_NEXT_TYPE(ehci, p.fstn->hw_next);
730				p = p.fstn->fstn_next;
731				break;
732			case Q_TYPE_ITD:
733				temp = scnprintf (next, size,
734					" itd/%p", p.itd);
735				tag = Q_NEXT_TYPE(ehci, p.itd->hw_next);
736				p = p.itd->itd_next;
737				break;
738			case Q_TYPE_SITD:
739				temp = scnprintf (next, size,
740					" sitd%d-%04x/%p",
741					p.sitd->stream->ps.period,
742					hc32_to_cpup(ehci, &p.sitd->hw_uframe)
743						& 0x0000ffff,
744					p.sitd);
745				tag = Q_NEXT_TYPE(ehci, p.sitd->hw_next);
746				p = p.sitd->sitd_next;
747				break;
748			}
749			size -= temp;
750			next += temp;
751		} while (p.ptr);
752
753		temp = scnprintf (next, size, "\n");
754		size -= temp;
755		next += temp;
756	}
757	spin_unlock_irqrestore (&ehci->lock, flags);
758	kfree (seen);
759
760	return buf->alloc_size - size;
761}
762#undef DBG_SCHED_LIMIT
763
764static const char *rh_state_string(struct ehci_hcd *ehci)
765{
766	switch (ehci->rh_state) {
767	case EHCI_RH_HALTED:
768		return "halted";
769	case EHCI_RH_SUSPENDED:
770		return "suspended";
771	case EHCI_RH_RUNNING:
772		return "running";
773	case EHCI_RH_STOPPING:
774		return "stopping";
775	}
776	return "?";
777}
778
779static ssize_t fill_registers_buffer(struct debug_buffer *buf)
780{
781	struct usb_hcd		*hcd;
782	struct ehci_hcd		*ehci;
783	unsigned long		flags;
784	unsigned		temp, size, i;
785	char			*next, scratch [80];
786	static char		fmt [] = "%*s\n";
787	static char		label [] = "";
788
789	hcd = bus_to_hcd(buf->bus);
790	ehci = hcd_to_ehci (hcd);
791	next = buf->output_buf;
792	size = buf->alloc_size;
793
794	spin_lock_irqsave (&ehci->lock, flags);
795
796	if (!HCD_HW_ACCESSIBLE(hcd)) {
797		size = scnprintf (next, size,
798			"bus %s, device %s\n"
799			"%s\n"
800			"SUSPENDED (no register access)\n",
801			hcd->self.controller->bus->name,
802			dev_name(hcd->self.controller),
803			hcd->product_desc);
804		goto done;
805	}
806
807	/* Capability Registers */
808	i = HC_VERSION(ehci, ehci_readl(ehci, &ehci->caps->hc_capbase));
809	temp = scnprintf (next, size,
810		"bus %s, device %s\n"
811		"%s\n"
812		"EHCI %x.%02x, rh state %s\n",
813		hcd->self.controller->bus->name,
814		dev_name(hcd->self.controller),
815		hcd->product_desc,
816		i >> 8, i & 0x0ff, rh_state_string(ehci));
817	size -= temp;
818	next += temp;
819
820#ifdef	CONFIG_PCI
821	/* EHCI 0.96 and later may have "extended capabilities" */
822	if (dev_is_pci(hcd->self.controller)) {
823		struct pci_dev	*pdev;
824		u32		offset, cap, cap2;
825		unsigned	count = 256/4;
826
827		pdev = to_pci_dev(ehci_to_hcd(ehci)->self.controller);
828		offset = HCC_EXT_CAPS(ehci_readl(ehci,
829				&ehci->caps->hcc_params));
830		while (offset && count--) {
831			pci_read_config_dword (pdev, offset, &cap);
832			switch (cap & 0xff) {
833			case 1:
834				temp = scnprintf (next, size,
835					"ownership %08x%s%s\n", cap,
836					(cap & (1 << 24)) ? " linux" : "",
837					(cap & (1 << 16)) ? " firmware" : "");
838				size -= temp;
839				next += temp;
840
841				offset += 4;
842				pci_read_config_dword (pdev, offset, &cap2);
843				temp = scnprintf (next, size,
844					"SMI sts/enable 0x%08x\n", cap2);
845				size -= temp;
846				next += temp;
847				break;
848			case 0:		/* illegal reserved capability */
849				cap = 0;
850				/* FALLTHROUGH */
851			default:		/* unknown */
852				break;
853			}
854			temp = (cap >> 8) & 0xff;
855		}
856	}
857#endif
858
859	// FIXME interpret both types of params
860	i = ehci_readl(ehci, &ehci->caps->hcs_params);
861	temp = scnprintf (next, size, "structural params 0x%08x\n", i);
862	size -= temp;
863	next += temp;
864
865	i = ehci_readl(ehci, &ehci->caps->hcc_params);
866	temp = scnprintf (next, size, "capability params 0x%08x\n", i);
867	size -= temp;
868	next += temp;
869
870	/* Operational Registers */
871	temp = dbg_status_buf (scratch, sizeof scratch, label,
872			ehci_readl(ehci, &ehci->regs->status));
873	temp = scnprintf (next, size, fmt, temp, scratch);
874	size -= temp;
875	next += temp;
876
877	temp = dbg_command_buf (scratch, sizeof scratch, label,
878			ehci_readl(ehci, &ehci->regs->command));
879	temp = scnprintf (next, size, fmt, temp, scratch);
880	size -= temp;
881	next += temp;
882
883	temp = dbg_intr_buf (scratch, sizeof scratch, label,
884			ehci_readl(ehci, &ehci->regs->intr_enable));
885	temp = scnprintf (next, size, fmt, temp, scratch);
886	size -= temp;
887	next += temp;
888
889	temp = scnprintf (next, size, "uframe %04x\n",
890			ehci_read_frame_index(ehci));
891	size -= temp;
892	next += temp;
893
894	for (i = 1; i <= HCS_N_PORTS (ehci->hcs_params); i++) {
895		temp = dbg_port_buf (scratch, sizeof scratch, label, i,
896				ehci_readl(ehci,
897					&ehci->regs->port_status[i - 1]));
898		temp = scnprintf (next, size, fmt, temp, scratch);
899		size -= temp;
900		next += temp;
901		if (i == HCS_DEBUG_PORT(ehci->hcs_params) && ehci->debug) {
902			temp = scnprintf (next, size,
903					"    debug control %08x\n",
904					ehci_readl(ehci,
905						&ehci->debug->control));
906			size -= temp;
907			next += temp;
908		}
909	}
910
911	if (!list_empty(&ehci->async_unlink)) {
912		temp = scnprintf(next, size, "async unlink qh %p\n",
913				list_first_entry(&ehci->async_unlink,
914						struct ehci_qh, unlink_node));
915		size -= temp;
916		next += temp;
917	}
918
919#ifdef EHCI_STATS
920	temp = scnprintf (next, size,
921		"irq normal %ld err %ld iaa %ld (lost %ld)\n",
922		ehci->stats.normal, ehci->stats.error, ehci->stats.iaa,
923		ehci->stats.lost_iaa);
924	size -= temp;
925	next += temp;
926
927	temp = scnprintf (next, size, "complete %ld unlink %ld\n",
928		ehci->stats.complete, ehci->stats.unlink);
929	size -= temp;
930	next += temp;
931#endif
932
933done:
934	spin_unlock_irqrestore (&ehci->lock, flags);
935
936	return buf->alloc_size - size;
937}
938
939static struct debug_buffer *alloc_buffer(struct usb_bus *bus,
940				ssize_t (*fill_func)(struct debug_buffer *))
941{
942	struct debug_buffer *buf;
943
944	buf = kzalloc(sizeof(struct debug_buffer), GFP_KERNEL);
945
946	if (buf) {
947		buf->bus = bus;
948		buf->fill_func = fill_func;
949		mutex_init(&buf->mutex);
950		buf->alloc_size = PAGE_SIZE;
951	}
952
953	return buf;
954}
955
956static int fill_buffer(struct debug_buffer *buf)
957{
958	int ret = 0;
959
960	if (!buf->output_buf)
961		buf->output_buf = vmalloc(buf->alloc_size);
962
963	if (!buf->output_buf) {
964		ret = -ENOMEM;
965		goto out;
966	}
967
968	ret = buf->fill_func(buf);
969
970	if (ret >= 0) {
971		buf->count = ret;
972		ret = 0;
973	}
974
975out:
976	return ret;
977}
978
979static ssize_t debug_output(struct file *file, char __user *user_buf,
980			    size_t len, loff_t *offset)
981{
982	struct debug_buffer *buf = file->private_data;
983	int ret = 0;
984
985	mutex_lock(&buf->mutex);
986	if (buf->count == 0) {
987		ret = fill_buffer(buf);
988		if (ret != 0) {
989			mutex_unlock(&buf->mutex);
990			goto out;
991		}
992	}
993	mutex_unlock(&buf->mutex);
994
995	ret = simple_read_from_buffer(user_buf, len, offset,
996				      buf->output_buf, buf->count);
997
998out:
999	return ret;
1000
1001}
1002
1003static int debug_close(struct inode *inode, struct file *file)
1004{
1005	struct debug_buffer *buf = file->private_data;
1006
1007	if (buf) {
1008		vfree(buf->output_buf);
1009		kfree(buf);
1010	}
1011
1012	return 0;
1013}
1014
1015static int debug_async_open(struct inode *inode, struct file *file)
1016{
1017	file->private_data = alloc_buffer(inode->i_private, fill_async_buffer);
1018
1019	return file->private_data ? 0 : -ENOMEM;
1020}
1021
1022static int debug_bandwidth_open(struct inode *inode, struct file *file)
1023{
1024	file->private_data = alloc_buffer(inode->i_private,
1025			fill_bandwidth_buffer);
1026
1027	return file->private_data ? 0 : -ENOMEM;
1028}
1029
1030static int debug_periodic_open(struct inode *inode, struct file *file)
1031{
1032	struct debug_buffer *buf;
1033	buf = alloc_buffer(inode->i_private, fill_periodic_buffer);
1034	if (!buf)
1035		return -ENOMEM;
1036
1037	buf->alloc_size = (sizeof(void *) == 4 ? 6 : 8)*PAGE_SIZE;
1038	file->private_data = buf;
1039	return 0;
1040}
1041
1042static int debug_registers_open(struct inode *inode, struct file *file)
1043{
1044	file->private_data = alloc_buffer(inode->i_private,
1045					  fill_registers_buffer);
1046
1047	return file->private_data ? 0 : -ENOMEM;
1048}
1049
1050static inline void create_debug_files (struct ehci_hcd *ehci)
1051{
1052	struct usb_bus *bus = &ehci_to_hcd(ehci)->self;
1053
1054	ehci->debug_dir = debugfs_create_dir(bus->bus_name, ehci_debug_root);
1055	if (!ehci->debug_dir)
1056		return;
1057
1058	if (!debugfs_create_file("async", S_IRUGO, ehci->debug_dir, bus,
1059						&debug_async_fops))
1060		goto file_error;
1061
1062	if (!debugfs_create_file("bandwidth", S_IRUGO, ehci->debug_dir, bus,
1063						&debug_bandwidth_fops))
1064		goto file_error;
1065
1066	if (!debugfs_create_file("periodic", S_IRUGO, ehci->debug_dir, bus,
1067						&debug_periodic_fops))
1068		goto file_error;
1069
1070	if (!debugfs_create_file("registers", S_IRUGO, ehci->debug_dir, bus,
1071						    &debug_registers_fops))
1072		goto file_error;
1073
1074	return;
1075
1076file_error:
1077	debugfs_remove_recursive(ehci->debug_dir);
1078}
1079
1080static inline void remove_debug_files (struct ehci_hcd *ehci)
1081{
1082	debugfs_remove_recursive(ehci->debug_dir);
1083}
1084
1085#endif /* STUB_DEBUG_FILES */
1086