1 // SPDX-License-Identifier: GPL-2.0
3 * xhci-debugfs.c - xHCI debugfs interface
5 * Copyright (C) 2017 Intel Corporation
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)
217 struct xhci_ring *ring = *(struct xhci_ring **)s->private;
218 struct xhci_segment *seg = ring->first_seg;
220 xhci_for_each_ring_seg(ring->first_seg, seg)
221 xhci_ring_dump_segment(s, seg);
226 static struct xhci_file_map ring_files[] = {
227 {"enqueue", xhci_ring_enqueue_show, },
228 {"dequeue", xhci_ring_dequeue_show, },
229 {"cycle", xhci_ring_cycle_show, },
230 {"trbs", xhci_ring_trb_show, },
233 static int xhci_ring_open(struct inode *inode, struct file *file)
236 struct xhci_file_map *f_map;
237 const char *file_name = file_dentry(file)->d_iname;
239 for (i = 0; i < ARRAY_SIZE(ring_files); i++) {
240 f_map = &ring_files[i];
242 if (strcmp(f_map->name, file_name) == 0)
246 return single_open(file, f_map->show, inode->i_private);
249 static const struct file_operations xhci_ring_fops = {
250 .open = xhci_ring_open,
253 .release = single_release,
256 static int xhci_slot_context_show(struct seq_file *s, void *unused)
258 struct xhci_hcd *xhci;
259 struct xhci_slot_ctx *slot_ctx;
260 struct xhci_slot_priv *priv = s->private;
261 struct xhci_virt_device *dev = priv->dev;
262 char str[XHCI_MSG_MAX];
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(str,
268 le32_to_cpu(slot_ctx->dev_info),
269 le32_to_cpu(slot_ctx->dev_info2),
270 le32_to_cpu(slot_ctx->tt_info),
271 le32_to_cpu(slot_ctx->dev_state)));
276 static int xhci_endpoint_context_show(struct seq_file *s, void *unused)
280 struct xhci_hcd *xhci;
281 struct xhci_ep_ctx *ep_ctx;
282 struct xhci_slot_priv *priv = s->private;
283 struct xhci_virt_device *dev = priv->dev;
284 char str[XHCI_MSG_MAX];
286 xhci = hcd_to_xhci(bus_to_hcd(dev->udev->bus));
288 for (ep_index = 0; ep_index < 31; ep_index++) {
289 ep_ctx = xhci_get_ep_ctx(xhci, dev->out_ctx, ep_index);
290 dma = dev->out_ctx->dma + (ep_index + 1) * CTX_SIZE(xhci->hcc_params);
291 seq_printf(s, "%pad: %s, virt_state:%#x\n", &dma,
292 xhci_decode_ep_context(str,
293 le32_to_cpu(ep_ctx->ep_info),
294 le32_to_cpu(ep_ctx->ep_info2),
295 le64_to_cpu(ep_ctx->deq),
296 le32_to_cpu(ep_ctx->tx_info)),
297 dev->eps[ep_index].ep_state);
303 static int xhci_device_name_show(struct seq_file *s, void *unused)
305 struct xhci_slot_priv *priv = s->private;
306 struct xhci_virt_device *dev = priv->dev;
308 seq_printf(s, "%s\n", dev_name(&dev->udev->dev));
313 static struct xhci_file_map context_files[] = {
314 {"name", xhci_device_name_show, },
315 {"slot-context", xhci_slot_context_show, },
316 {"ep-context", xhci_endpoint_context_show, },
319 static int xhci_context_open(struct inode *inode, struct file *file)
322 struct xhci_file_map *f_map;
323 const char *file_name = file_dentry(file)->d_iname;
325 for (i = 0; i < ARRAY_SIZE(context_files); i++) {
326 f_map = &context_files[i];
328 if (strcmp(f_map->name, file_name) == 0)
332 return single_open(file, f_map->show, inode->i_private);
335 static const struct file_operations xhci_context_fops = {
336 .open = xhci_context_open,
339 .release = single_release,
344 static int xhci_portsc_show(struct seq_file *s, void *unused)
346 struct xhci_port *port = s->private;
348 char str[XHCI_MSG_MAX];
350 portsc = readl(port->addr);
351 seq_printf(s, "%s\n", xhci_decode_portsc(str, portsc));
356 static int xhci_port_open(struct inode *inode, struct file *file)
358 return single_open(file, xhci_portsc_show, inode->i_private);
361 static ssize_t xhci_port_write(struct file *file, const char __user *ubuf,
362 size_t count, loff_t *ppos)
364 struct seq_file *s = file->private_data;
365 struct xhci_port *port = s->private;
366 struct xhci_hcd *xhci = hcd_to_xhci(port->rhub->hcd);
371 if (copy_from_user(&buf, ubuf, min_t(size_t, sizeof(buf) - 1, count)))
374 if (!strncmp(buf, "compliance", 10)) {
375 /* If CTC is clear, compliance is enabled by default */
376 if (!HCC2_CTC(xhci->hcc_params2))
378 spin_lock_irqsave(&xhci->lock, flags);
379 /* compliance mode can only be enabled on ports in RxDetect */
380 portsc = readl(port->addr);
381 if ((portsc & PORT_PLS_MASK) != XDEV_RXDETECT) {
382 spin_unlock_irqrestore(&xhci->lock, flags);
385 portsc = xhci_port_state_to_neutral(portsc);
386 portsc &= ~PORT_PLS_MASK;
387 portsc |= PORT_LINK_STROBE | XDEV_COMP_MODE;
388 writel(portsc, port->addr);
389 spin_unlock_irqrestore(&xhci->lock, flags);
396 static const struct file_operations port_fops = {
397 .open = xhci_port_open,
398 .write = xhci_port_write,
401 .release = single_release,
404 static void xhci_debugfs_create_files(struct xhci_hcd *xhci,
405 struct xhci_file_map *files,
406 size_t nentries, void *data,
407 struct dentry *parent,
408 const struct file_operations *fops)
412 for (i = 0; i < nentries; i++)
413 debugfs_create_file(files[i].name, 0444, parent, data, fops);
416 static struct dentry *xhci_debugfs_create_ring_dir(struct xhci_hcd *xhci,
417 struct xhci_ring **ring,
419 struct dentry *parent)
423 dir = debugfs_create_dir(name, parent);
424 xhci_debugfs_create_files(xhci, ring_files, ARRAY_SIZE(ring_files),
425 ring, dir, &xhci_ring_fops);
430 static void xhci_debugfs_create_context_files(struct xhci_hcd *xhci,
431 struct dentry *parent,
434 struct xhci_virt_device *dev = xhci->devs[slot_id];
436 xhci_debugfs_create_files(xhci, context_files,
437 ARRAY_SIZE(context_files),
438 dev->debugfs_private,
439 parent, &xhci_context_fops);
442 void xhci_debugfs_create_endpoint(struct xhci_hcd *xhci,
443 struct xhci_virt_device *dev,
446 struct xhci_ep_priv *epriv;
447 struct xhci_slot_priv *spriv = dev->debugfs_private;
452 if (spriv->eps[ep_index])
455 epriv = kzalloc(sizeof(*epriv), GFP_KERNEL);
459 epriv->show_ring = dev->eps[ep_index].ring;
461 snprintf(epriv->name, sizeof(epriv->name), "ep%02d", ep_index);
462 epriv->root = xhci_debugfs_create_ring_dir(xhci,
466 spriv->eps[ep_index] = epriv;
469 void xhci_debugfs_remove_endpoint(struct xhci_hcd *xhci,
470 struct xhci_virt_device *dev,
473 struct xhci_ep_priv *epriv;
474 struct xhci_slot_priv *spriv = dev->debugfs_private;
476 if (!spriv || !spriv->eps[ep_index])
479 epriv = spriv->eps[ep_index];
480 debugfs_remove_recursive(epriv->root);
481 spriv->eps[ep_index] = NULL;
485 static int xhci_stream_id_show(struct seq_file *s, void *unused)
487 struct xhci_ep_priv *epriv = s->private;
489 if (!epriv->stream_info)
492 seq_printf(s, "Show stream ID %d trb ring, supported [1 - %d]\n",
493 epriv->stream_id, epriv->stream_info->num_streams - 1);
498 static int xhci_stream_id_open(struct inode *inode, struct file *file)
500 return single_open(file, xhci_stream_id_show, inode->i_private);
503 static ssize_t xhci_stream_id_write(struct file *file, const char __user *ubuf,
504 size_t count, loff_t *ppos)
506 struct seq_file *s = file->private_data;
507 struct xhci_ep_priv *epriv = s->private;
509 u16 stream_id; /* MaxPStreams + 1 <= 16 */
511 if (!epriv->stream_info)
515 ret = kstrtou16_from_user(ubuf, count, 10, &stream_id);
519 if (stream_id == 0 || stream_id >= epriv->stream_info->num_streams)
522 epriv->stream_id = stream_id;
523 epriv->show_ring = epriv->stream_info->stream_rings[stream_id];
528 static const struct file_operations stream_id_fops = {
529 .open = xhci_stream_id_open,
530 .write = xhci_stream_id_write,
533 .release = single_release,
536 static int xhci_stream_context_array_show(struct seq_file *s, void *unused)
538 struct xhci_ep_priv *epriv = s->private;
539 struct xhci_stream_ctx *stream_ctx;
543 if (!epriv->stream_info)
546 seq_printf(s, "Allocated %d streams and %d stream context array entries\n",
547 epriv->stream_info->num_streams,
548 epriv->stream_info->num_stream_ctxs);
550 for (id = 0; id < epriv->stream_info->num_stream_ctxs; id++) {
551 stream_ctx = epriv->stream_info->stream_ctx_array + id;
552 dma = epriv->stream_info->ctx_array_dma + id * 16;
553 if (id < epriv->stream_info->num_streams)
554 seq_printf(s, "%pad stream id %d deq %016llx\n", &dma,
555 id, le64_to_cpu(stream_ctx->stream_ring));
557 seq_printf(s, "%pad stream context entry not used deq %016llx\n",
558 &dma, le64_to_cpu(stream_ctx->stream_ring));
563 DEFINE_SHOW_ATTRIBUTE(xhci_stream_context_array);
565 void xhci_debugfs_create_stream_files(struct xhci_hcd *xhci,
566 struct xhci_virt_device *dev,
569 struct xhci_slot_priv *spriv = dev->debugfs_private;
570 struct xhci_ep_priv *epriv;
572 if (!spriv || !spriv->eps[ep_index] ||
573 !dev->eps[ep_index].stream_info)
576 epriv = spriv->eps[ep_index];
577 epriv->stream_info = dev->eps[ep_index].stream_info;
579 /* Show trb ring of stream ID 1 by default */
580 epriv->stream_id = 1;
581 epriv->show_ring = epriv->stream_info->stream_rings[1];
582 debugfs_create_file("stream_id", 0644,
585 debugfs_create_file("stream_context_array", 0444,
587 &xhci_stream_context_array_fops);
590 void xhci_debugfs_create_slot(struct xhci_hcd *xhci, int slot_id)
592 struct xhci_slot_priv *priv;
593 struct xhci_virt_device *dev = xhci->devs[slot_id];
595 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
599 snprintf(priv->name, sizeof(priv->name), "%02d", slot_id);
600 priv->root = debugfs_create_dir(priv->name, xhci->debugfs_slots);
602 dev->debugfs_private = priv;
604 xhci_debugfs_create_ring_dir(xhci, &dev->eps[0].ring,
607 xhci_debugfs_create_context_files(xhci, priv->root, slot_id);
610 void xhci_debugfs_remove_slot(struct xhci_hcd *xhci, int slot_id)
613 struct xhci_slot_priv *priv;
614 struct xhci_virt_device *dev = xhci->devs[slot_id];
616 if (!dev || !dev->debugfs_private)
619 priv = dev->debugfs_private;
621 debugfs_remove_recursive(priv->root);
623 for (i = 0; i < 31; i++)
627 dev->debugfs_private = NULL;
630 static void xhci_debugfs_create_ports(struct xhci_hcd *xhci,
631 struct dentry *parent)
633 unsigned int num_ports;
635 struct xhci_port *port;
638 num_ports = HCS_MAX_PORTS(xhci->hcs_params1);
640 parent = debugfs_create_dir("ports", parent);
642 while (num_ports--) {
643 scnprintf(port_name, sizeof(port_name), "port%02d",
645 dir = debugfs_create_dir(port_name, parent);
646 port = &xhci->hw_ports[num_ports];
647 debugfs_create_file("portsc", 0644, dir, port, &port_fops);
651 void xhci_debugfs_init(struct xhci_hcd *xhci)
653 struct device *dev = xhci_to_hcd(xhci)->self.controller;
655 xhci->debugfs_root = debugfs_create_dir(dev_name(dev),
658 INIT_LIST_HEAD(&xhci->regset_list);
660 xhci_debugfs_regset(xhci,
662 xhci_cap_regs, ARRAY_SIZE(xhci_cap_regs),
663 xhci->debugfs_root, "reg-cap");
665 xhci_debugfs_regset(xhci,
666 HC_LENGTH(readl(&xhci->cap_regs->hc_capbase)),
667 xhci_op_regs, ARRAY_SIZE(xhci_op_regs),
668 xhci->debugfs_root, "reg-op");
670 xhci_debugfs_regset(xhci,
671 readl(&xhci->cap_regs->run_regs_off) & RTSOFF_MASK,
672 xhci_runtime_regs, ARRAY_SIZE(xhci_runtime_regs),
673 xhci->debugfs_root, "reg-runtime");
675 xhci_debugfs_extcap_regset(xhci, XHCI_EXT_CAPS_LEGACY,
677 ARRAY_SIZE(xhci_extcap_legsup),
680 xhci_debugfs_extcap_regset(xhci, XHCI_EXT_CAPS_PROTOCOL,
681 xhci_extcap_protocol,
682 ARRAY_SIZE(xhci_extcap_protocol),
685 xhci_debugfs_extcap_regset(xhci, XHCI_EXT_CAPS_DEBUG,
687 ARRAY_SIZE(xhci_extcap_dbc),
690 xhci_debugfs_create_ring_dir(xhci, &xhci->cmd_ring,
694 xhci_debugfs_create_ring_dir(xhci, &xhci->interrupters[0]->event_ring,
698 xhci->debugfs_slots = debugfs_create_dir("devices", xhci->debugfs_root);
700 xhci_debugfs_create_ports(xhci, xhci->debugfs_root);
703 void xhci_debugfs_exit(struct xhci_hcd *xhci)
705 struct xhci_regset *rgs, *tmp;
707 debugfs_remove_recursive(xhci->debugfs_root);
708 xhci->debugfs_root = NULL;
709 xhci->debugfs_slots = NULL;
711 list_for_each_entry_safe(rgs, tmp, &xhci->regset_list, list)
712 xhci_debugfs_free_regset(rgs);
715 void __init xhci_debugfs_create_root(void)
717 xhci_debugfs_root = debugfs_create_dir("xhci", usb_debug_root);
720 void __exit xhci_debugfs_remove_root(void)
722 debugfs_remove_recursive(xhci_debugfs_root);
723 xhci_debugfs_root = NULL;