1 // SPDX-License-Identifier: GPL-2.0
3 * xhci-debugfs.c - xHCI debugfs interface
5 * Copyright (C) 2017 Intel Corporation
7 * Author: Lu Baolu <baolu.lu@linux.intel.com>
10 #include <linux/slab.h>
11 #include <linux/uaccess.h>
14 #include "xhci-debugfs.h"
16 static const struct debugfs_reg32 xhci_cap_regs[] = {
17 dump_register(CAPLENGTH),
18 dump_register(HCSPARAMS1),
19 dump_register(HCSPARAMS2),
20 dump_register(HCSPARAMS3),
21 dump_register(HCCPARAMS1),
22 dump_register(DOORBELLOFF),
23 dump_register(RUNTIMEOFF),
24 dump_register(HCCPARAMS2),
27 static const struct debugfs_reg32 xhci_op_regs[] = {
28 dump_register(USBCMD),
29 dump_register(USBSTS),
30 dump_register(PAGESIZE),
31 dump_register(DNCTRL),
33 dump_register(DCBAAP_LOW),
34 dump_register(DCBAAP_HIGH),
35 dump_register(CONFIG),
38 static const struct debugfs_reg32 xhci_runtime_regs[] = {
39 dump_register(MFINDEX),
40 dump_register(IR0_IMAN),
41 dump_register(IR0_IMOD),
42 dump_register(IR0_ERSTSZ),
43 dump_register(IR0_ERSTBA_LOW),
44 dump_register(IR0_ERSTBA_HIGH),
45 dump_register(IR0_ERDP_LOW),
46 dump_register(IR0_ERDP_HIGH),
49 static const struct debugfs_reg32 xhci_extcap_legsup[] = {
50 dump_register(EXTCAP_USBLEGSUP),
51 dump_register(EXTCAP_USBLEGCTLSTS),
54 static const struct debugfs_reg32 xhci_extcap_protocol[] = {
55 dump_register(EXTCAP_REVISION),
56 dump_register(EXTCAP_NAME),
57 dump_register(EXTCAP_PORTINFO),
58 dump_register(EXTCAP_PORTTYPE),
59 dump_register(EXTCAP_MANTISSA1),
60 dump_register(EXTCAP_MANTISSA2),
61 dump_register(EXTCAP_MANTISSA3),
62 dump_register(EXTCAP_MANTISSA4),
63 dump_register(EXTCAP_MANTISSA5),
64 dump_register(EXTCAP_MANTISSA6),
67 static const struct debugfs_reg32 xhci_extcap_dbc[] = {
68 dump_register(EXTCAP_DBC_CAPABILITY),
69 dump_register(EXTCAP_DBC_DOORBELL),
70 dump_register(EXTCAP_DBC_ERSTSIZE),
71 dump_register(EXTCAP_DBC_ERST_LOW),
72 dump_register(EXTCAP_DBC_ERST_HIGH),
73 dump_register(EXTCAP_DBC_ERDP_LOW),
74 dump_register(EXTCAP_DBC_ERDP_HIGH),
75 dump_register(EXTCAP_DBC_CONTROL),
76 dump_register(EXTCAP_DBC_STATUS),
77 dump_register(EXTCAP_DBC_PORTSC),
78 dump_register(EXTCAP_DBC_CONT_LOW),
79 dump_register(EXTCAP_DBC_CONT_HIGH),
80 dump_register(EXTCAP_DBC_DEVINFO1),
81 dump_register(EXTCAP_DBC_DEVINFO2),
84 static struct dentry *xhci_debugfs_root;
86 static struct xhci_regset *xhci_debugfs_alloc_regset(struct xhci_hcd *xhci)
88 struct xhci_regset *regset;
90 regset = kzalloc(sizeof(*regset), GFP_KERNEL);
95 * The allocation and free of regset are executed in order.
96 * We needn't a lock here.
98 INIT_LIST_HEAD(®set->list);
99 list_add_tail(®set->list, &xhci->regset_list);
104 static void xhci_debugfs_free_regset(struct xhci_regset *regset)
109 list_del(®set->list);
113 static void xhci_debugfs_regset(struct xhci_hcd *xhci, u32 base,
114 const struct debugfs_reg32 *regs,
115 size_t nregs, struct dentry *parent,
116 const char *fmt, ...)
118 struct xhci_regset *rgs;
120 struct debugfs_regset32 *regset;
121 struct usb_hcd *hcd = xhci_to_hcd(xhci);
123 rgs = xhci_debugfs_alloc_regset(xhci);
128 vsnprintf(rgs->name, sizeof(rgs->name), fmt, args);
131 regset = &rgs->regset;
133 regset->nregs = nregs;
134 regset->base = hcd->regs + base;
135 regset->dev = hcd->self.controller;
137 debugfs_create_regset32((const char *)rgs->name, 0444, parent, regset);
140 static void xhci_debugfs_extcap_regset(struct xhci_hcd *xhci, int cap_id,
141 const struct debugfs_reg32 *regs,
142 size_t n, const char *cap_name)
146 size_t psic, nregs = n;
147 void __iomem *base = &xhci->cap_regs->hc_capbase;
149 offset = xhci_find_next_ext_cap(base, 0, cap_id);
151 if (cap_id == XHCI_EXT_CAPS_PROTOCOL) {
152 psic = XHCI_EXT_PORT_PSIC(readl(base + offset + 8));
153 nregs = min(4 + psic, n);
156 xhci_debugfs_regset(xhci, offset, regs, nregs,
157 xhci->debugfs_root, "%s:%02d",
159 offset = xhci_find_next_ext_cap(base, offset, cap_id);
164 static int xhci_ring_enqueue_show(struct seq_file *s, void *unused)
167 struct xhci_ring *ring = *(struct xhci_ring **)s->private;
169 dma = xhci_trb_virt_to_dma(ring->enq_seg, ring->enqueue);
170 seq_printf(s, "%pad\n", &dma);
175 static int xhci_ring_dequeue_show(struct seq_file *s, void *unused)
178 struct xhci_ring *ring = *(struct xhci_ring **)s->private;
180 dma = xhci_trb_virt_to_dma(ring->deq_seg, ring->dequeue);
181 seq_printf(s, "%pad\n", &dma);
186 static int xhci_ring_cycle_show(struct seq_file *s, void *unused)
188 struct xhci_ring *ring = *(struct xhci_ring **)s->private;
190 seq_printf(s, "%d\n", ring->cycle_state);
195 static void xhci_ring_dump_segment(struct seq_file *s,
196 struct xhci_segment *seg)
202 for (i = 0; i < TRBS_PER_SEGMENT; i++) {
204 dma = seg->dma + i * sizeof(*trb);
205 seq_printf(s, "%pad: %s\n", &dma,
206 xhci_decode_trb(le32_to_cpu(trb->generic.field[0]),
207 le32_to_cpu(trb->generic.field[1]),
208 le32_to_cpu(trb->generic.field[2]),
209 le32_to_cpu(trb->generic.field[3])));
213 static int xhci_ring_trb_show(struct seq_file *s, void *unused)
216 struct xhci_ring *ring = *(struct xhci_ring **)s->private;
217 struct xhci_segment *seg = ring->first_seg;
219 for (i = 0; i < ring->num_segs; i++) {
220 xhci_ring_dump_segment(s, seg);
227 static struct xhci_file_map ring_files[] = {
228 {"enqueue", xhci_ring_enqueue_show, },
229 {"dequeue", xhci_ring_dequeue_show, },
230 {"cycle", xhci_ring_cycle_show, },
231 {"trbs", xhci_ring_trb_show, },
234 static int xhci_ring_open(struct inode *inode, struct file *file)
237 struct xhci_file_map *f_map;
238 const char *file_name = file_dentry(file)->d_iname;
240 for (i = 0; i < ARRAY_SIZE(ring_files); i++) {
241 f_map = &ring_files[i];
243 if (strcmp(f_map->name, file_name) == 0)
247 return single_open(file, f_map->show, inode->i_private);
250 static const struct file_operations xhci_ring_fops = {
251 .open = xhci_ring_open,
254 .release = single_release,
257 static int xhci_slot_context_show(struct seq_file *s, void *unused)
259 struct xhci_hcd *xhci;
260 struct xhci_slot_ctx *slot_ctx;
261 struct xhci_slot_priv *priv = s->private;
262 struct xhci_virt_device *dev = priv->dev;
264 xhci = hcd_to_xhci(bus_to_hcd(dev->udev->bus));
265 slot_ctx = xhci_get_slot_ctx(xhci, dev->out_ctx);
266 seq_printf(s, "%pad: %s\n", &dev->out_ctx->dma,
267 xhci_decode_slot_context(le32_to_cpu(slot_ctx->dev_info),
268 le32_to_cpu(slot_ctx->dev_info2),
269 le32_to_cpu(slot_ctx->tt_info),
270 le32_to_cpu(slot_ctx->dev_state)));
275 static int xhci_endpoint_context_show(struct seq_file *s, void *unused)
279 struct xhci_hcd *xhci;
280 struct xhci_ep_ctx *ep_ctx;
281 struct xhci_slot_priv *priv = s->private;
282 struct xhci_virt_device *dev = priv->dev;
284 xhci = hcd_to_xhci(bus_to_hcd(dev->udev->bus));
286 for (ep_index = 0; ep_index < 31; ep_index++) {
287 ep_ctx = xhci_get_ep_ctx(xhci, dev->out_ctx, ep_index);
288 dma = dev->out_ctx->dma + (ep_index + 1) * CTX_SIZE(xhci->hcc_params);
289 seq_printf(s, "%pad: %s\n", &dma,
290 xhci_decode_ep_context(le32_to_cpu(ep_ctx->ep_info),
291 le32_to_cpu(ep_ctx->ep_info2),
292 le64_to_cpu(ep_ctx->deq),
293 le32_to_cpu(ep_ctx->tx_info)));
299 static int xhci_device_name_show(struct seq_file *s, void *unused)
301 struct xhci_slot_priv *priv = s->private;
302 struct xhci_virt_device *dev = priv->dev;
304 seq_printf(s, "%s\n", dev_name(&dev->udev->dev));
309 static struct xhci_file_map context_files[] = {
310 {"name", xhci_device_name_show, },
311 {"slot-context", xhci_slot_context_show, },
312 {"ep-context", xhci_endpoint_context_show, },
315 static int xhci_context_open(struct inode *inode, struct file *file)
318 struct xhci_file_map *f_map;
319 const char *file_name = file_dentry(file)->d_iname;
321 for (i = 0; i < ARRAY_SIZE(context_files); i++) {
322 f_map = &context_files[i];
324 if (strcmp(f_map->name, file_name) == 0)
328 return single_open(file, f_map->show, inode->i_private);
331 static const struct file_operations xhci_context_fops = {
332 .open = xhci_context_open,
335 .release = single_release,
340 static int xhci_portsc_show(struct seq_file *s, void *unused)
342 struct xhci_port *port = s->private;
345 portsc = readl(port->addr);
346 seq_printf(s, "%s\n", xhci_decode_portsc(portsc));
351 static int xhci_port_open(struct inode *inode, struct file *file)
353 return single_open(file, xhci_portsc_show, inode->i_private);
356 static ssize_t xhci_port_write(struct file *file, const char __user *ubuf,
357 size_t count, loff_t *ppos)
359 struct seq_file *s = file->private_data;
360 struct xhci_port *port = s->private;
361 struct xhci_hcd *xhci = hcd_to_xhci(port->rhub->hcd);
366 if (copy_from_user(&buf, ubuf, min_t(size_t, sizeof(buf) - 1, count)))
369 if (!strncmp(buf, "compliance", 10)) {
370 /* If CTC is clear, compliance is enabled by default */
371 if (!HCC2_CTC(xhci->hcc_params2))
373 spin_lock_irqsave(&xhci->lock, flags);
374 /* compliance mode can only be enabled on ports in RxDetect */
375 portsc = readl(port->addr);
376 if ((portsc & PORT_PLS_MASK) != XDEV_RXDETECT) {
377 spin_unlock_irqrestore(&xhci->lock, flags);
380 portsc = xhci_port_state_to_neutral(portsc);
381 portsc &= ~PORT_PLS_MASK;
382 portsc |= PORT_LINK_STROBE | XDEV_COMP_MODE;
383 writel(portsc, port->addr);
384 spin_unlock_irqrestore(&xhci->lock, flags);
391 static const struct file_operations port_fops = {
392 .open = xhci_port_open,
393 .write = xhci_port_write,
396 .release = single_release,
399 static void xhci_debugfs_create_files(struct xhci_hcd *xhci,
400 struct xhci_file_map *files,
401 size_t nentries, void *data,
402 struct dentry *parent,
403 const struct file_operations *fops)
407 for (i = 0; i < nentries; i++)
408 debugfs_create_file(files[i].name, 0444, parent, data, fops);
411 static struct dentry *xhci_debugfs_create_ring_dir(struct xhci_hcd *xhci,
412 struct xhci_ring **ring,
414 struct dentry *parent)
418 dir = debugfs_create_dir(name, parent);
419 xhci_debugfs_create_files(xhci, ring_files, ARRAY_SIZE(ring_files),
420 ring, dir, &xhci_ring_fops);
425 static void xhci_debugfs_create_context_files(struct xhci_hcd *xhci,
426 struct dentry *parent,
429 struct xhci_virt_device *dev = xhci->devs[slot_id];
431 xhci_debugfs_create_files(xhci, context_files,
432 ARRAY_SIZE(context_files),
433 dev->debugfs_private,
434 parent, &xhci_context_fops);
437 void xhci_debugfs_create_endpoint(struct xhci_hcd *xhci,
438 struct xhci_virt_device *dev,
441 struct xhci_ep_priv *epriv;
442 struct xhci_slot_priv *spriv = dev->debugfs_private;
447 if (spriv->eps[ep_index])
450 epriv = kzalloc(sizeof(*epriv), GFP_KERNEL);
454 snprintf(epriv->name, sizeof(epriv->name), "ep%02d", ep_index);
455 epriv->root = xhci_debugfs_create_ring_dir(xhci,
456 &dev->eps[ep_index].ring,
459 spriv->eps[ep_index] = epriv;
462 void xhci_debugfs_remove_endpoint(struct xhci_hcd *xhci,
463 struct xhci_virt_device *dev,
466 struct xhci_ep_priv *epriv;
467 struct xhci_slot_priv *spriv = dev->debugfs_private;
469 if (!spriv || !spriv->eps[ep_index])
472 epriv = spriv->eps[ep_index];
473 debugfs_remove_recursive(epriv->root);
474 spriv->eps[ep_index] = NULL;
478 void xhci_debugfs_create_slot(struct xhci_hcd *xhci, int slot_id)
480 struct xhci_slot_priv *priv;
481 struct xhci_virt_device *dev = xhci->devs[slot_id];
483 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
487 snprintf(priv->name, sizeof(priv->name), "%02d", slot_id);
488 priv->root = debugfs_create_dir(priv->name, xhci->debugfs_slots);
490 dev->debugfs_private = priv;
492 xhci_debugfs_create_ring_dir(xhci, &dev->eps[0].ring,
495 xhci_debugfs_create_context_files(xhci, priv->root, slot_id);
498 void xhci_debugfs_remove_slot(struct xhci_hcd *xhci, int slot_id)
501 struct xhci_slot_priv *priv;
502 struct xhci_virt_device *dev = xhci->devs[slot_id];
504 if (!dev || !dev->debugfs_private)
507 priv = dev->debugfs_private;
509 debugfs_remove_recursive(priv->root);
511 for (i = 0; i < 31; i++)
515 dev->debugfs_private = NULL;
518 static void xhci_debugfs_create_ports(struct xhci_hcd *xhci,
519 struct dentry *parent)
521 unsigned int num_ports;
523 struct xhci_port *port;
526 num_ports = HCS_MAX_PORTS(xhci->hcs_params1);
528 parent = debugfs_create_dir("ports", parent);
530 while (num_ports--) {
531 scnprintf(port_name, sizeof(port_name), "port%02d",
533 dir = debugfs_create_dir(port_name, parent);
534 port = &xhci->hw_ports[num_ports];
535 debugfs_create_file("portsc", 0644, dir, port, &port_fops);
539 void xhci_debugfs_init(struct xhci_hcd *xhci)
541 struct device *dev = xhci_to_hcd(xhci)->self.controller;
543 xhci->debugfs_root = debugfs_create_dir(dev_name(dev),
546 INIT_LIST_HEAD(&xhci->regset_list);
548 xhci_debugfs_regset(xhci,
550 xhci_cap_regs, ARRAY_SIZE(xhci_cap_regs),
551 xhci->debugfs_root, "reg-cap");
553 xhci_debugfs_regset(xhci,
554 HC_LENGTH(readl(&xhci->cap_regs->hc_capbase)),
555 xhci_op_regs, ARRAY_SIZE(xhci_op_regs),
556 xhci->debugfs_root, "reg-op");
558 xhci_debugfs_regset(xhci,
559 readl(&xhci->cap_regs->run_regs_off) & RTSOFF_MASK,
560 xhci_runtime_regs, ARRAY_SIZE(xhci_runtime_regs),
561 xhci->debugfs_root, "reg-runtime");
563 xhci_debugfs_extcap_regset(xhci, XHCI_EXT_CAPS_LEGACY,
565 ARRAY_SIZE(xhci_extcap_legsup),
568 xhci_debugfs_extcap_regset(xhci, XHCI_EXT_CAPS_PROTOCOL,
569 xhci_extcap_protocol,
570 ARRAY_SIZE(xhci_extcap_protocol),
573 xhci_debugfs_extcap_regset(xhci, XHCI_EXT_CAPS_DEBUG,
575 ARRAY_SIZE(xhci_extcap_dbc),
578 xhci_debugfs_create_ring_dir(xhci, &xhci->cmd_ring,
582 xhci_debugfs_create_ring_dir(xhci, &xhci->event_ring,
586 xhci->debugfs_slots = debugfs_create_dir("devices", xhci->debugfs_root);
588 xhci_debugfs_create_ports(xhci, xhci->debugfs_root);
591 void xhci_debugfs_exit(struct xhci_hcd *xhci)
593 struct xhci_regset *rgs, *tmp;
595 debugfs_remove_recursive(xhci->debugfs_root);
596 xhci->debugfs_root = NULL;
597 xhci->debugfs_slots = NULL;
599 list_for_each_entry_safe(rgs, tmp, &xhci->regset_list, list)
600 xhci_debugfs_free_regset(rgs);
603 void __init xhci_debugfs_create_root(void)
605 xhci_debugfs_root = debugfs_create_dir("xhci", usb_debug_root);
608 void __exit xhci_debugfs_remove_root(void)
610 debugfs_remove_recursive(xhci_debugfs_root);
611 xhci_debugfs_root = NULL;