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);
114 static void xhci_debugfs_regset(struct xhci_hcd *xhci, u32 base,
115 const struct debugfs_reg32 *regs,
116 size_t nregs, struct dentry *parent,
117 const char *fmt, ...)
119 struct xhci_regset *rgs;
121 struct debugfs_regset32 *regset;
122 struct usb_hcd *hcd = xhci_to_hcd(xhci);
124 rgs = xhci_debugfs_alloc_regset(xhci);
129 vsnprintf(rgs->name, sizeof(rgs->name), fmt, args);
132 regset = &rgs->regset;
134 regset->nregs = nregs;
135 regset->base = hcd->regs + base;
136 regset->dev = hcd->self.controller;
138 debugfs_create_regset32((const char *)rgs->name, 0444, parent, regset);
141 static void xhci_debugfs_extcap_regset(struct xhci_hcd *xhci, int cap_id,
142 const struct debugfs_reg32 *regs,
143 size_t n, const char *cap_name)
147 size_t psic, nregs = n;
148 void __iomem *base = &xhci->cap_regs->hc_capbase;
150 offset = xhci_find_next_ext_cap(base, 0, cap_id);
152 if (cap_id == XHCI_EXT_CAPS_PROTOCOL) {
153 psic = XHCI_EXT_PORT_PSIC(readl(base + offset + 8));
154 nregs = min(4 + psic, n);
157 xhci_debugfs_regset(xhci, offset, regs, nregs,
158 xhci->debugfs_root, "%s:%02d",
160 offset = xhci_find_next_ext_cap(base, offset, cap_id);
165 static int xhci_ring_enqueue_show(struct seq_file *s, void *unused)
168 struct xhci_ring *ring = *(struct xhci_ring **)s->private;
170 dma = xhci_trb_virt_to_dma(ring->enq_seg, ring->enqueue);
171 seq_printf(s, "%pad\n", &dma);
176 static int xhci_ring_dequeue_show(struct seq_file *s, void *unused)
179 struct xhci_ring *ring = *(struct xhci_ring **)s->private;
181 dma = xhci_trb_virt_to_dma(ring->deq_seg, ring->dequeue);
182 seq_printf(s, "%pad\n", &dma);
187 static int xhci_ring_cycle_show(struct seq_file *s, void *unused)
189 struct xhci_ring *ring = *(struct xhci_ring **)s->private;
191 seq_printf(s, "%d\n", ring->cycle_state);
196 static void xhci_ring_dump_segment(struct seq_file *s,
197 struct xhci_segment *seg)
202 char str[XHCI_MSG_MAX];
204 for (i = 0; i < TRBS_PER_SEGMENT; i++) {
206 dma = seg->dma + i * sizeof(*trb);
207 seq_printf(s, "%2u %pad: %s\n", seg->num, &dma,
208 xhci_decode_trb(str, XHCI_MSG_MAX, le32_to_cpu(trb->generic.field[0]),
209 le32_to_cpu(trb->generic.field[1]),
210 le32_to_cpu(trb->generic.field[2]),
211 le32_to_cpu(trb->generic.field[3])));
215 static int xhci_ring_trb_show(struct seq_file *s, void *unused)
218 struct xhci_ring *ring = *(struct xhci_ring **)s->private;
219 struct xhci_segment *seg = ring->first_seg;
221 for (i = 0; i < ring->num_segs; i++) {
222 xhci_ring_dump_segment(s, seg);
229 static struct xhci_file_map ring_files[] = {
230 {"enqueue", xhci_ring_enqueue_show, },
231 {"dequeue", xhci_ring_dequeue_show, },
232 {"cycle", xhci_ring_cycle_show, },
233 {"trbs", xhci_ring_trb_show, },
236 static int xhci_ring_open(struct inode *inode, struct file *file)
239 struct xhci_file_map *f_map;
240 const char *file_name = file_dentry(file)->d_iname;
242 for (i = 0; i < ARRAY_SIZE(ring_files); i++) {
243 f_map = &ring_files[i];
245 if (strcmp(f_map->name, file_name) == 0)
249 return single_open(file, f_map->show, inode->i_private);
252 static const struct file_operations xhci_ring_fops = {
253 .open = xhci_ring_open,
256 .release = single_release,
259 static int xhci_slot_context_show(struct seq_file *s, void *unused)
261 struct xhci_hcd *xhci;
262 struct xhci_slot_ctx *slot_ctx;
263 struct xhci_slot_priv *priv = s->private;
264 struct xhci_virt_device *dev = priv->dev;
265 char str[XHCI_MSG_MAX];
267 xhci = hcd_to_xhci(bus_to_hcd(dev->udev->bus));
268 slot_ctx = xhci_get_slot_ctx(xhci, dev->out_ctx);
269 seq_printf(s, "%pad: %s\n", &dev->out_ctx->dma,
270 xhci_decode_slot_context(str,
271 le32_to_cpu(slot_ctx->dev_info),
272 le32_to_cpu(slot_ctx->dev_info2),
273 le32_to_cpu(slot_ctx->tt_info),
274 le32_to_cpu(slot_ctx->dev_state)));
279 static int xhci_endpoint_context_show(struct seq_file *s, void *unused)
283 struct xhci_hcd *xhci;
284 struct xhci_ep_ctx *ep_ctx;
285 struct xhci_slot_priv *priv = s->private;
286 struct xhci_virt_device *dev = priv->dev;
287 char str[XHCI_MSG_MAX];
289 xhci = hcd_to_xhci(bus_to_hcd(dev->udev->bus));
291 for (ep_index = 0; ep_index < 31; ep_index++) {
292 ep_ctx = xhci_get_ep_ctx(xhci, dev->out_ctx, ep_index);
293 dma = dev->out_ctx->dma + (ep_index + 1) * CTX_SIZE(xhci->hcc_params);
294 seq_printf(s, "%pad: %s\n", &dma,
295 xhci_decode_ep_context(str,
296 le32_to_cpu(ep_ctx->ep_info),
297 le32_to_cpu(ep_ctx->ep_info2),
298 le64_to_cpu(ep_ctx->deq),
299 le32_to_cpu(ep_ctx->tx_info)));
305 static int xhci_device_name_show(struct seq_file *s, void *unused)
307 struct xhci_slot_priv *priv = s->private;
308 struct xhci_virt_device *dev = priv->dev;
310 seq_printf(s, "%s\n", dev_name(&dev->udev->dev));
315 static struct xhci_file_map context_files[] = {
316 {"name", xhci_device_name_show, },
317 {"slot-context", xhci_slot_context_show, },
318 {"ep-context", xhci_endpoint_context_show, },
321 static int xhci_context_open(struct inode *inode, struct file *file)
324 struct xhci_file_map *f_map;
325 const char *file_name = file_dentry(file)->d_iname;
327 for (i = 0; i < ARRAY_SIZE(context_files); i++) {
328 f_map = &context_files[i];
330 if (strcmp(f_map->name, file_name) == 0)
334 return single_open(file, f_map->show, inode->i_private);
337 static const struct file_operations xhci_context_fops = {
338 .open = xhci_context_open,
341 .release = single_release,
346 static int xhci_portsc_show(struct seq_file *s, void *unused)
348 struct xhci_port *port = s->private;
350 char str[XHCI_MSG_MAX];
352 portsc = readl(port->addr);
353 seq_printf(s, "%s\n", xhci_decode_portsc(str, portsc));
358 static int xhci_port_open(struct inode *inode, struct file *file)
360 return single_open(file, xhci_portsc_show, inode->i_private);
363 static ssize_t xhci_port_write(struct file *file, const char __user *ubuf,
364 size_t count, loff_t *ppos)
366 struct seq_file *s = file->private_data;
367 struct xhci_port *port = s->private;
368 struct xhci_hcd *xhci = hcd_to_xhci(port->rhub->hcd);
373 if (copy_from_user(&buf, ubuf, min_t(size_t, sizeof(buf) - 1, count)))
376 if (!strncmp(buf, "compliance", 10)) {
377 /* If CTC is clear, compliance is enabled by default */
378 if (!HCC2_CTC(xhci->hcc_params2))
380 spin_lock_irqsave(&xhci->lock, flags);
381 /* compliance mode can only be enabled on ports in RxDetect */
382 portsc = readl(port->addr);
383 if ((portsc & PORT_PLS_MASK) != XDEV_RXDETECT) {
384 spin_unlock_irqrestore(&xhci->lock, flags);
387 portsc = xhci_port_state_to_neutral(portsc);
388 portsc &= ~PORT_PLS_MASK;
389 portsc |= PORT_LINK_STROBE | XDEV_COMP_MODE;
390 writel(portsc, port->addr);
391 spin_unlock_irqrestore(&xhci->lock, flags);
398 static const struct file_operations port_fops = {
399 .open = xhci_port_open,
400 .write = xhci_port_write,
403 .release = single_release,
406 static void xhci_debugfs_create_files(struct xhci_hcd *xhci,
407 struct xhci_file_map *files,
408 size_t nentries, void *data,
409 struct dentry *parent,
410 const struct file_operations *fops)
414 for (i = 0; i < nentries; i++)
415 debugfs_create_file(files[i].name, 0444, parent, data, fops);
418 static struct dentry *xhci_debugfs_create_ring_dir(struct xhci_hcd *xhci,
419 struct xhci_ring **ring,
421 struct dentry *parent)
425 dir = debugfs_create_dir(name, parent);
426 xhci_debugfs_create_files(xhci, ring_files, ARRAY_SIZE(ring_files),
427 ring, dir, &xhci_ring_fops);
432 static void xhci_debugfs_create_context_files(struct xhci_hcd *xhci,
433 struct dentry *parent,
436 struct xhci_virt_device *dev = xhci->devs[slot_id];
438 xhci_debugfs_create_files(xhci, context_files,
439 ARRAY_SIZE(context_files),
440 dev->debugfs_private,
441 parent, &xhci_context_fops);
444 void xhci_debugfs_create_endpoint(struct xhci_hcd *xhci,
445 struct xhci_virt_device *dev,
448 struct xhci_ep_priv *epriv;
449 struct xhci_slot_priv *spriv = dev->debugfs_private;
454 if (spriv->eps[ep_index])
457 epriv = kzalloc(sizeof(*epriv), GFP_KERNEL);
461 epriv->show_ring = dev->eps[ep_index].ring;
463 snprintf(epriv->name, sizeof(epriv->name), "ep%02d", ep_index);
464 epriv->root = xhci_debugfs_create_ring_dir(xhci,
468 spriv->eps[ep_index] = epriv;
471 void xhci_debugfs_remove_endpoint(struct xhci_hcd *xhci,
472 struct xhci_virt_device *dev,
475 struct xhci_ep_priv *epriv;
476 struct xhci_slot_priv *spriv = dev->debugfs_private;
478 if (!spriv || !spriv->eps[ep_index])
481 epriv = spriv->eps[ep_index];
482 debugfs_remove_recursive(epriv->root);
483 spriv->eps[ep_index] = NULL;
487 static int xhci_stream_id_show(struct seq_file *s, void *unused)
489 struct xhci_ep_priv *epriv = s->private;
491 if (!epriv->stream_info)
494 seq_printf(s, "Show stream ID %d trb ring, supported [1 - %d]\n",
495 epriv->stream_id, epriv->stream_info->num_streams - 1);
500 static int xhci_stream_id_open(struct inode *inode, struct file *file)
502 return single_open(file, xhci_stream_id_show, inode->i_private);
505 static ssize_t xhci_stream_id_write(struct file *file, const char __user *ubuf,
506 size_t count, loff_t *ppos)
508 struct seq_file *s = file->private_data;
509 struct xhci_ep_priv *epriv = s->private;
511 u16 stream_id; /* MaxPStreams + 1 <= 16 */
513 if (!epriv->stream_info)
517 ret = kstrtou16_from_user(ubuf, count, 10, &stream_id);
521 if (stream_id == 0 || stream_id >= epriv->stream_info->num_streams)
524 epriv->stream_id = stream_id;
525 epriv->show_ring = epriv->stream_info->stream_rings[stream_id];
530 static const struct file_operations stream_id_fops = {
531 .open = xhci_stream_id_open,
532 .write = xhci_stream_id_write,
535 .release = single_release,
538 static int xhci_stream_context_array_show(struct seq_file *s, void *unused)
540 struct xhci_ep_priv *epriv = s->private;
541 struct xhci_stream_ctx *stream_ctx;
545 if (!epriv->stream_info)
548 seq_printf(s, "Allocated %d streams and %d stream context array entries\n",
549 epriv->stream_info->num_streams,
550 epriv->stream_info->num_stream_ctxs);
552 for (id = 0; id < epriv->stream_info->num_stream_ctxs; id++) {
553 stream_ctx = epriv->stream_info->stream_ctx_array + id;
554 dma = epriv->stream_info->ctx_array_dma + id * 16;
555 if (id < epriv->stream_info->num_streams)
556 seq_printf(s, "%pad stream id %d deq %016llx\n", &dma,
557 id, le64_to_cpu(stream_ctx->stream_ring));
559 seq_printf(s, "%pad stream context entry not used deq %016llx\n",
560 &dma, le64_to_cpu(stream_ctx->stream_ring));
565 DEFINE_SHOW_ATTRIBUTE(xhci_stream_context_array);
567 void xhci_debugfs_create_stream_files(struct xhci_hcd *xhci,
568 struct xhci_virt_device *dev,
571 struct xhci_slot_priv *spriv = dev->debugfs_private;
572 struct xhci_ep_priv *epriv;
574 if (!spriv || !spriv->eps[ep_index] ||
575 !dev->eps[ep_index].stream_info)
578 epriv = spriv->eps[ep_index];
579 epriv->stream_info = dev->eps[ep_index].stream_info;
581 /* Show trb ring of stream ID 1 by default */
582 epriv->stream_id = 1;
583 epriv->show_ring = epriv->stream_info->stream_rings[1];
584 debugfs_create_file("stream_id", 0644,
587 debugfs_create_file("stream_context_array", 0444,
589 &xhci_stream_context_array_fops);
592 void xhci_debugfs_create_slot(struct xhci_hcd *xhci, int slot_id)
594 struct xhci_slot_priv *priv;
595 struct xhci_virt_device *dev = xhci->devs[slot_id];
597 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
601 snprintf(priv->name, sizeof(priv->name), "%02d", slot_id);
602 priv->root = debugfs_create_dir(priv->name, xhci->debugfs_slots);
604 dev->debugfs_private = priv;
606 xhci_debugfs_create_ring_dir(xhci, &dev->eps[0].ring,
609 xhci_debugfs_create_context_files(xhci, priv->root, slot_id);
612 void xhci_debugfs_remove_slot(struct xhci_hcd *xhci, int slot_id)
615 struct xhci_slot_priv *priv;
616 struct xhci_virt_device *dev = xhci->devs[slot_id];
618 if (!dev || !dev->debugfs_private)
621 priv = dev->debugfs_private;
623 debugfs_remove_recursive(priv->root);
625 for (i = 0; i < 31; i++)
629 dev->debugfs_private = NULL;
632 static void xhci_debugfs_create_ports(struct xhci_hcd *xhci,
633 struct dentry *parent)
635 unsigned int num_ports;
637 struct xhci_port *port;
640 num_ports = HCS_MAX_PORTS(xhci->hcs_params1);
642 parent = debugfs_create_dir("ports", parent);
644 while (num_ports--) {
645 scnprintf(port_name, sizeof(port_name), "port%02d",
647 dir = debugfs_create_dir(port_name, parent);
648 port = &xhci->hw_ports[num_ports];
649 debugfs_create_file("portsc", 0644, dir, port, &port_fops);
653 void xhci_debugfs_init(struct xhci_hcd *xhci)
655 struct device *dev = xhci_to_hcd(xhci)->self.controller;
657 xhci->debugfs_root = debugfs_create_dir(dev_name(dev),
660 INIT_LIST_HEAD(&xhci->regset_list);
662 xhci_debugfs_regset(xhci,
664 xhci_cap_regs, ARRAY_SIZE(xhci_cap_regs),
665 xhci->debugfs_root, "reg-cap");
667 xhci_debugfs_regset(xhci,
668 HC_LENGTH(readl(&xhci->cap_regs->hc_capbase)),
669 xhci_op_regs, ARRAY_SIZE(xhci_op_regs),
670 xhci->debugfs_root, "reg-op");
672 xhci_debugfs_regset(xhci,
673 readl(&xhci->cap_regs->run_regs_off) & RTSOFF_MASK,
674 xhci_runtime_regs, ARRAY_SIZE(xhci_runtime_regs),
675 xhci->debugfs_root, "reg-runtime");
677 xhci_debugfs_extcap_regset(xhci, XHCI_EXT_CAPS_LEGACY,
679 ARRAY_SIZE(xhci_extcap_legsup),
682 xhci_debugfs_extcap_regset(xhci, XHCI_EXT_CAPS_PROTOCOL,
683 xhci_extcap_protocol,
684 ARRAY_SIZE(xhci_extcap_protocol),
687 xhci_debugfs_extcap_regset(xhci, XHCI_EXT_CAPS_DEBUG,
689 ARRAY_SIZE(xhci_extcap_dbc),
692 xhci_debugfs_create_ring_dir(xhci, &xhci->cmd_ring,
696 xhci_debugfs_create_ring_dir(xhci, &xhci->interrupter->event_ring,
700 xhci->debugfs_slots = debugfs_create_dir("devices", xhci->debugfs_root);
702 xhci_debugfs_create_ports(xhci, xhci->debugfs_root);
705 void xhci_debugfs_exit(struct xhci_hcd *xhci)
707 struct xhci_regset *rgs, *tmp;
709 debugfs_remove_recursive(xhci->debugfs_root);
710 xhci->debugfs_root = NULL;
711 xhci->debugfs_slots = NULL;
713 list_for_each_entry_safe(rgs, tmp, &xhci->regset_list, list)
714 xhci_debugfs_free_regset(rgs);
717 void __init xhci_debugfs_create_root(void)
719 xhci_debugfs_root = debugfs_create_dir("xhci", usb_debug_root);
722 void __exit xhci_debugfs_remove_root(void)
724 debugfs_remove_recursive(xhci_debugfs_root);
725 xhci_debugfs_root = NULL;