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