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