xref: /openbmc/linux/drivers/usb/chipidea/debug.c (revision 60772e48)
1 // SPDX-License-Identifier: GPL-2.0
2 #include <linux/kernel.h>
3 #include <linux/device.h>
4 #include <linux/types.h>
5 #include <linux/spinlock.h>
6 #include <linux/debugfs.h>
7 #include <linux/seq_file.h>
8 #include <linux/uaccess.h>
9 #include <linux/usb/ch9.h>
10 #include <linux/usb/gadget.h>
11 #include <linux/usb/phy.h>
12 #include <linux/usb/otg.h>
13 #include <linux/usb/otg-fsm.h>
14 #include <linux/usb/chipidea.h>
15 
16 #include "ci.h"
17 #include "udc.h"
18 #include "bits.h"
19 #include "otg.h"
20 
21 /**
22  * ci_device_show: prints information about device capabilities and status
23  */
24 static int ci_device_show(struct seq_file *s, void *data)
25 {
26 	struct ci_hdrc *ci = s->private;
27 	struct usb_gadget *gadget = &ci->gadget;
28 
29 	seq_printf(s, "speed             = %d\n", gadget->speed);
30 	seq_printf(s, "max_speed         = %d\n", gadget->max_speed);
31 	seq_printf(s, "is_otg            = %d\n", gadget->is_otg);
32 	seq_printf(s, "is_a_peripheral   = %d\n", gadget->is_a_peripheral);
33 	seq_printf(s, "b_hnp_enable      = %d\n", gadget->b_hnp_enable);
34 	seq_printf(s, "a_hnp_support     = %d\n", gadget->a_hnp_support);
35 	seq_printf(s, "a_alt_hnp_support = %d\n", gadget->a_alt_hnp_support);
36 	seq_printf(s, "name              = %s\n",
37 		   (gadget->name ? gadget->name : ""));
38 
39 	if (!ci->driver)
40 		return 0;
41 
42 	seq_printf(s, "gadget function   = %s\n",
43 		       (ci->driver->function ? ci->driver->function : ""));
44 	seq_printf(s, "gadget max speed  = %d\n", ci->driver->max_speed);
45 
46 	return 0;
47 }
48 
49 static int ci_device_open(struct inode *inode, struct file *file)
50 {
51 	return single_open(file, ci_device_show, inode->i_private);
52 }
53 
54 static const struct file_operations ci_device_fops = {
55 	.open		= ci_device_open,
56 	.read		= seq_read,
57 	.llseek		= seq_lseek,
58 	.release	= single_release,
59 };
60 
61 /**
62  * ci_port_test_show: reads port test mode
63  */
64 static int ci_port_test_show(struct seq_file *s, void *data)
65 {
66 	struct ci_hdrc *ci = s->private;
67 	unsigned long flags;
68 	unsigned mode;
69 
70 	pm_runtime_get_sync(ci->dev);
71 	spin_lock_irqsave(&ci->lock, flags);
72 	mode = hw_port_test_get(ci);
73 	spin_unlock_irqrestore(&ci->lock, flags);
74 	pm_runtime_put_sync(ci->dev);
75 
76 	seq_printf(s, "mode = %u\n", mode);
77 
78 	return 0;
79 }
80 
81 /**
82  * ci_port_test_write: writes port test mode
83  */
84 static ssize_t ci_port_test_write(struct file *file, const char __user *ubuf,
85 				  size_t count, loff_t *ppos)
86 {
87 	struct seq_file *s = file->private_data;
88 	struct ci_hdrc *ci = s->private;
89 	unsigned long flags;
90 	unsigned mode;
91 	char buf[32];
92 	int ret;
93 
94 	count = min_t(size_t, sizeof(buf) - 1, count);
95 	if (copy_from_user(buf, ubuf, count))
96 		return -EFAULT;
97 
98 	/* sscanf requires a zero terminated string */
99 	buf[count] = '\0';
100 
101 	if (sscanf(buf, "%u", &mode) != 1)
102 		return -EINVAL;
103 
104 	if (mode > 255)
105 		return -EBADRQC;
106 
107 	pm_runtime_get_sync(ci->dev);
108 	spin_lock_irqsave(&ci->lock, flags);
109 	ret = hw_port_test_set(ci, mode);
110 	spin_unlock_irqrestore(&ci->lock, flags);
111 	pm_runtime_put_sync(ci->dev);
112 
113 	return ret ? ret : count;
114 }
115 
116 static int ci_port_test_open(struct inode *inode, struct file *file)
117 {
118 	return single_open(file, ci_port_test_show, inode->i_private);
119 }
120 
121 static const struct file_operations ci_port_test_fops = {
122 	.open		= ci_port_test_open,
123 	.write		= ci_port_test_write,
124 	.read		= seq_read,
125 	.llseek		= seq_lseek,
126 	.release	= single_release,
127 };
128 
129 /**
130  * ci_qheads_show: DMA contents of all queue heads
131  */
132 static int ci_qheads_show(struct seq_file *s, void *data)
133 {
134 	struct ci_hdrc *ci = s->private;
135 	unsigned long flags;
136 	unsigned i, j;
137 
138 	if (ci->role != CI_ROLE_GADGET) {
139 		seq_printf(s, "not in gadget mode\n");
140 		return 0;
141 	}
142 
143 	spin_lock_irqsave(&ci->lock, flags);
144 	for (i = 0; i < ci->hw_ep_max/2; i++) {
145 		struct ci_hw_ep *hweprx = &ci->ci_hw_ep[i];
146 		struct ci_hw_ep *hweptx =
147 			&ci->ci_hw_ep[i + ci->hw_ep_max/2];
148 		seq_printf(s, "EP=%02i: RX=%08X TX=%08X\n",
149 			   i, (u32)hweprx->qh.dma, (u32)hweptx->qh.dma);
150 		for (j = 0; j < (sizeof(struct ci_hw_qh)/sizeof(u32)); j++)
151 			seq_printf(s, " %04X:    %08X    %08X\n", j,
152 				   *((u32 *)hweprx->qh.ptr + j),
153 				   *((u32 *)hweptx->qh.ptr + j));
154 	}
155 	spin_unlock_irqrestore(&ci->lock, flags);
156 
157 	return 0;
158 }
159 
160 static int ci_qheads_open(struct inode *inode, struct file *file)
161 {
162 	return single_open(file, ci_qheads_show, inode->i_private);
163 }
164 
165 static const struct file_operations ci_qheads_fops = {
166 	.open		= ci_qheads_open,
167 	.read		= seq_read,
168 	.llseek		= seq_lseek,
169 	.release	= single_release,
170 };
171 
172 /**
173  * ci_requests_show: DMA contents of all requests currently queued (all endpts)
174  */
175 static int ci_requests_show(struct seq_file *s, void *data)
176 {
177 	struct ci_hdrc *ci = s->private;
178 	unsigned long flags;
179 	struct ci_hw_req *req = NULL;
180 	struct td_node *node, *tmpnode;
181 	unsigned i, j, qsize = sizeof(struct ci_hw_td)/sizeof(u32);
182 
183 	if (ci->role != CI_ROLE_GADGET) {
184 		seq_printf(s, "not in gadget mode\n");
185 		return 0;
186 	}
187 
188 	spin_lock_irqsave(&ci->lock, flags);
189 	for (i = 0; i < ci->hw_ep_max; i++)
190 		list_for_each_entry(req, &ci->ci_hw_ep[i].qh.queue, queue) {
191 			list_for_each_entry_safe(node, tmpnode, &req->tds, td) {
192 				seq_printf(s, "EP=%02i: TD=%08X %s\n",
193 					   i % (ci->hw_ep_max / 2),
194 					   (u32)node->dma,
195 					   ((i < ci->hw_ep_max/2) ?
196 					   "RX" : "TX"));
197 
198 				for (j = 0; j < qsize; j++)
199 					seq_printf(s, " %04X:    %08X\n", j,
200 						   *((u32 *)node->ptr + j));
201 			}
202 		}
203 	spin_unlock_irqrestore(&ci->lock, flags);
204 
205 	return 0;
206 }
207 
208 static int ci_requests_open(struct inode *inode, struct file *file)
209 {
210 	return single_open(file, ci_requests_show, inode->i_private);
211 }
212 
213 static const struct file_operations ci_requests_fops = {
214 	.open		= ci_requests_open,
215 	.read		= seq_read,
216 	.llseek		= seq_lseek,
217 	.release	= single_release,
218 };
219 
220 static int ci_otg_show(struct seq_file *s, void *unused)
221 {
222 	struct ci_hdrc *ci = s->private;
223 	struct otg_fsm *fsm;
224 
225 	if (!ci || !ci_otg_is_fsm_mode(ci))
226 		return 0;
227 
228 	fsm = &ci->fsm;
229 
230 	/* ------ State ----- */
231 	seq_printf(s, "OTG state: %s\n\n",
232 			usb_otg_state_string(ci->otg.state));
233 
234 	/* ------ State Machine Variables ----- */
235 	seq_printf(s, "a_bus_drop: %d\n", fsm->a_bus_drop);
236 
237 	seq_printf(s, "a_bus_req: %d\n", fsm->a_bus_req);
238 
239 	seq_printf(s, "a_srp_det: %d\n", fsm->a_srp_det);
240 
241 	seq_printf(s, "a_vbus_vld: %d\n", fsm->a_vbus_vld);
242 
243 	seq_printf(s, "b_conn: %d\n", fsm->b_conn);
244 
245 	seq_printf(s, "adp_change: %d\n", fsm->adp_change);
246 
247 	seq_printf(s, "power_up: %d\n", fsm->power_up);
248 
249 	seq_printf(s, "a_bus_resume: %d\n", fsm->a_bus_resume);
250 
251 	seq_printf(s, "a_bus_suspend: %d\n", fsm->a_bus_suspend);
252 
253 	seq_printf(s, "a_conn: %d\n", fsm->a_conn);
254 
255 	seq_printf(s, "b_bus_req: %d\n", fsm->b_bus_req);
256 
257 	seq_printf(s, "b_bus_suspend: %d\n", fsm->b_bus_suspend);
258 
259 	seq_printf(s, "b_se0_srp: %d\n", fsm->b_se0_srp);
260 
261 	seq_printf(s, "b_ssend_srp: %d\n", fsm->b_ssend_srp);
262 
263 	seq_printf(s, "b_sess_vld: %d\n", fsm->b_sess_vld);
264 
265 	seq_printf(s, "b_srp_done: %d\n", fsm->b_srp_done);
266 
267 	seq_printf(s, "drv_vbus: %d\n", fsm->drv_vbus);
268 
269 	seq_printf(s, "loc_conn: %d\n", fsm->loc_conn);
270 
271 	seq_printf(s, "loc_sof: %d\n", fsm->loc_sof);
272 
273 	seq_printf(s, "adp_prb: %d\n", fsm->adp_prb);
274 
275 	seq_printf(s, "id: %d\n", fsm->id);
276 
277 	seq_printf(s, "protocol: %d\n", fsm->protocol);
278 
279 	return 0;
280 }
281 
282 static int ci_otg_open(struct inode *inode, struct file *file)
283 {
284 	return single_open(file, ci_otg_show, inode->i_private);
285 }
286 
287 static const struct file_operations ci_otg_fops = {
288 	.open			= ci_otg_open,
289 	.read			= seq_read,
290 	.llseek			= seq_lseek,
291 	.release		= single_release,
292 };
293 
294 static int ci_role_show(struct seq_file *s, void *data)
295 {
296 	struct ci_hdrc *ci = s->private;
297 
298 	if (ci->role != CI_ROLE_END)
299 		seq_printf(s, "%s\n", ci_role(ci)->name);
300 
301 	return 0;
302 }
303 
304 static ssize_t ci_role_write(struct file *file, const char __user *ubuf,
305 			     size_t count, loff_t *ppos)
306 {
307 	struct seq_file *s = file->private_data;
308 	struct ci_hdrc *ci = s->private;
309 	enum ci_role role;
310 	char buf[8];
311 	int ret;
312 
313 	if (copy_from_user(buf, ubuf, min_t(size_t, sizeof(buf) - 1, count)))
314 		return -EFAULT;
315 
316 	for (role = CI_ROLE_HOST; role < CI_ROLE_END; role++)
317 		if (ci->roles[role] &&
318 		    !strncmp(buf, ci->roles[role]->name,
319 			     strlen(ci->roles[role]->name)))
320 			break;
321 
322 	if (role == CI_ROLE_END || role == ci->role)
323 		return -EINVAL;
324 
325 	pm_runtime_get_sync(ci->dev);
326 	disable_irq(ci->irq);
327 	ci_role_stop(ci);
328 	ret = ci_role_start(ci, role);
329 	enable_irq(ci->irq);
330 	pm_runtime_put_sync(ci->dev);
331 
332 	return ret ? ret : count;
333 }
334 
335 static int ci_role_open(struct inode *inode, struct file *file)
336 {
337 	return single_open(file, ci_role_show, inode->i_private);
338 }
339 
340 static const struct file_operations ci_role_fops = {
341 	.open		= ci_role_open,
342 	.write		= ci_role_write,
343 	.read		= seq_read,
344 	.llseek		= seq_lseek,
345 	.release	= single_release,
346 };
347 
348 static int ci_registers_show(struct seq_file *s, void *unused)
349 {
350 	struct ci_hdrc *ci = s->private;
351 	u32 tmp_reg;
352 
353 	if (!ci || ci->in_lpm)
354 		return -EPERM;
355 
356 	/* ------ Registers ----- */
357 	tmp_reg = hw_read_intr_enable(ci);
358 	seq_printf(s, "USBINTR reg: %08x\n", tmp_reg);
359 
360 	tmp_reg = hw_read_intr_status(ci);
361 	seq_printf(s, "USBSTS reg: %08x\n", tmp_reg);
362 
363 	tmp_reg = hw_read(ci, OP_USBMODE, ~0);
364 	seq_printf(s, "USBMODE reg: %08x\n", tmp_reg);
365 
366 	tmp_reg = hw_read(ci, OP_USBCMD, ~0);
367 	seq_printf(s, "USBCMD reg: %08x\n", tmp_reg);
368 
369 	tmp_reg = hw_read(ci, OP_PORTSC, ~0);
370 	seq_printf(s, "PORTSC reg: %08x\n", tmp_reg);
371 
372 	if (ci->is_otg) {
373 		tmp_reg = hw_read_otgsc(ci, ~0);
374 		seq_printf(s, "OTGSC reg: %08x\n", tmp_reg);
375 	}
376 
377 	return 0;
378 }
379 
380 static int ci_registers_open(struct inode *inode, struct file *file)
381 {
382 	return single_open(file, ci_registers_show, inode->i_private);
383 }
384 
385 static const struct file_operations ci_registers_fops = {
386 	.open			= ci_registers_open,
387 	.read			= seq_read,
388 	.llseek			= seq_lseek,
389 	.release		= single_release,
390 };
391 
392 /**
393  * dbg_create_files: initializes the attribute interface
394  * @ci: device
395  *
396  * This function returns an error code
397  */
398 int dbg_create_files(struct ci_hdrc *ci)
399 {
400 	struct dentry *dent;
401 
402 	ci->debugfs = debugfs_create_dir(dev_name(ci->dev), NULL);
403 	if (!ci->debugfs)
404 		return -ENOMEM;
405 
406 	dent = debugfs_create_file("device", S_IRUGO, ci->debugfs, ci,
407 				   &ci_device_fops);
408 	if (!dent)
409 		goto err;
410 
411 	dent = debugfs_create_file("port_test", S_IRUGO | S_IWUSR, ci->debugfs,
412 				   ci, &ci_port_test_fops);
413 	if (!dent)
414 		goto err;
415 
416 	dent = debugfs_create_file("qheads", S_IRUGO, ci->debugfs, ci,
417 				   &ci_qheads_fops);
418 	if (!dent)
419 		goto err;
420 
421 	dent = debugfs_create_file("requests", S_IRUGO, ci->debugfs, ci,
422 				   &ci_requests_fops);
423 	if (!dent)
424 		goto err;
425 
426 	if (ci_otg_is_fsm_mode(ci)) {
427 		dent = debugfs_create_file("otg", S_IRUGO, ci->debugfs, ci,
428 					&ci_otg_fops);
429 		if (!dent)
430 			goto err;
431 	}
432 
433 	dent = debugfs_create_file("role", S_IRUGO | S_IWUSR, ci->debugfs, ci,
434 				   &ci_role_fops);
435 	if (!dent)
436 		goto err;
437 
438 	dent = debugfs_create_file("registers", S_IRUGO, ci->debugfs, ci,
439 				&ci_registers_fops);
440 
441 	if (dent)
442 		return 0;
443 err:
444 	debugfs_remove_recursive(ci->debugfs);
445 	return -ENOMEM;
446 }
447 
448 /**
449  * dbg_remove_files: destroys the attribute interface
450  * @ci: device
451  */
452 void dbg_remove_files(struct ci_hdrc *ci)
453 {
454 	debugfs_remove_recursive(ci->debugfs);
455 }
456