1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun * xhci-debugfs.h - xHCI debugfs interface
4*4882a593Smuzhiyun *
5*4882a593Smuzhiyun * Copyright (C) 2017 Intel Corporation
6*4882a593Smuzhiyun *
7*4882a593Smuzhiyun * Author: Lu Baolu <baolu.lu@linux.intel.com>
8*4882a593Smuzhiyun */
9*4882a593Smuzhiyun
10*4882a593Smuzhiyun #ifndef __LINUX_XHCI_DEBUGFS_H
11*4882a593Smuzhiyun #define __LINUX_XHCI_DEBUGFS_H
12*4882a593Smuzhiyun
13*4882a593Smuzhiyun #include <linux/debugfs.h>
14*4882a593Smuzhiyun
15*4882a593Smuzhiyun #define DEBUGFS_NAMELEN 32
16*4882a593Smuzhiyun
17*4882a593Smuzhiyun #define REG_CAPLENGTH 0x00
18*4882a593Smuzhiyun #define REG_HCSPARAMS1 0x04
19*4882a593Smuzhiyun #define REG_HCSPARAMS2 0x08
20*4882a593Smuzhiyun #define REG_HCSPARAMS3 0x0c
21*4882a593Smuzhiyun #define REG_HCCPARAMS1 0x10
22*4882a593Smuzhiyun #define REG_DOORBELLOFF 0x14
23*4882a593Smuzhiyun #define REG_RUNTIMEOFF 0x18
24*4882a593Smuzhiyun #define REG_HCCPARAMS2 0x1c
25*4882a593Smuzhiyun
26*4882a593Smuzhiyun #define REG_USBCMD 0x00
27*4882a593Smuzhiyun #define REG_USBSTS 0x04
28*4882a593Smuzhiyun #define REG_PAGESIZE 0x08
29*4882a593Smuzhiyun #define REG_DNCTRL 0x14
30*4882a593Smuzhiyun #define REG_CRCR 0x18
31*4882a593Smuzhiyun #define REG_DCBAAP_LOW 0x30
32*4882a593Smuzhiyun #define REG_DCBAAP_HIGH 0x34
33*4882a593Smuzhiyun #define REG_CONFIG 0x38
34*4882a593Smuzhiyun
35*4882a593Smuzhiyun #define REG_MFINDEX 0x00
36*4882a593Smuzhiyun #define REG_IR0_IMAN 0x20
37*4882a593Smuzhiyun #define REG_IR0_IMOD 0x24
38*4882a593Smuzhiyun #define REG_IR0_ERSTSZ 0x28
39*4882a593Smuzhiyun #define REG_IR0_ERSTBA_LOW 0x30
40*4882a593Smuzhiyun #define REG_IR0_ERSTBA_HIGH 0x34
41*4882a593Smuzhiyun #define REG_IR0_ERDP_LOW 0x38
42*4882a593Smuzhiyun #define REG_IR0_ERDP_HIGH 0x3c
43*4882a593Smuzhiyun
44*4882a593Smuzhiyun #define REG_EXTCAP_USBLEGSUP 0x00
45*4882a593Smuzhiyun #define REG_EXTCAP_USBLEGCTLSTS 0x04
46*4882a593Smuzhiyun
47*4882a593Smuzhiyun #define REG_EXTCAP_REVISION 0x00
48*4882a593Smuzhiyun #define REG_EXTCAP_NAME 0x04
49*4882a593Smuzhiyun #define REG_EXTCAP_PORTINFO 0x08
50*4882a593Smuzhiyun #define REG_EXTCAP_PORTTYPE 0x0c
51*4882a593Smuzhiyun #define REG_EXTCAP_MANTISSA1 0x10
52*4882a593Smuzhiyun #define REG_EXTCAP_MANTISSA2 0x14
53*4882a593Smuzhiyun #define REG_EXTCAP_MANTISSA3 0x18
54*4882a593Smuzhiyun #define REG_EXTCAP_MANTISSA4 0x1c
55*4882a593Smuzhiyun #define REG_EXTCAP_MANTISSA5 0x20
56*4882a593Smuzhiyun #define REG_EXTCAP_MANTISSA6 0x24
57*4882a593Smuzhiyun
58*4882a593Smuzhiyun #define REG_EXTCAP_DBC_CAPABILITY 0x00
59*4882a593Smuzhiyun #define REG_EXTCAP_DBC_DOORBELL 0x04
60*4882a593Smuzhiyun #define REG_EXTCAP_DBC_ERSTSIZE 0x08
61*4882a593Smuzhiyun #define REG_EXTCAP_DBC_ERST_LOW 0x10
62*4882a593Smuzhiyun #define REG_EXTCAP_DBC_ERST_HIGH 0x14
63*4882a593Smuzhiyun #define REG_EXTCAP_DBC_ERDP_LOW 0x18
64*4882a593Smuzhiyun #define REG_EXTCAP_DBC_ERDP_HIGH 0x1c
65*4882a593Smuzhiyun #define REG_EXTCAP_DBC_CONTROL 0x20
66*4882a593Smuzhiyun #define REG_EXTCAP_DBC_STATUS 0x24
67*4882a593Smuzhiyun #define REG_EXTCAP_DBC_PORTSC 0x28
68*4882a593Smuzhiyun #define REG_EXTCAP_DBC_CONT_LOW 0x30
69*4882a593Smuzhiyun #define REG_EXTCAP_DBC_CONT_HIGH 0x34
70*4882a593Smuzhiyun #define REG_EXTCAP_DBC_DEVINFO1 0x38
71*4882a593Smuzhiyun #define REG_EXTCAP_DBC_DEVINFO2 0x3c
72*4882a593Smuzhiyun
73*4882a593Smuzhiyun #define dump_register(nm) \
74*4882a593Smuzhiyun { \
75*4882a593Smuzhiyun .name = __stringify(nm), \
76*4882a593Smuzhiyun .offset = REG_ ##nm, \
77*4882a593Smuzhiyun }
78*4882a593Smuzhiyun
79*4882a593Smuzhiyun struct xhci_regset {
80*4882a593Smuzhiyun char name[DEBUGFS_NAMELEN];
81*4882a593Smuzhiyun struct debugfs_regset32 regset;
82*4882a593Smuzhiyun size_t nregs;
83*4882a593Smuzhiyun struct list_head list;
84*4882a593Smuzhiyun };
85*4882a593Smuzhiyun
86*4882a593Smuzhiyun struct xhci_file_map {
87*4882a593Smuzhiyun const char *name;
88*4882a593Smuzhiyun int (*show)(struct seq_file *s, void *unused);
89*4882a593Smuzhiyun };
90*4882a593Smuzhiyun
91*4882a593Smuzhiyun struct xhci_ep_priv {
92*4882a593Smuzhiyun char name[DEBUGFS_NAMELEN];
93*4882a593Smuzhiyun struct dentry *root;
94*4882a593Smuzhiyun struct xhci_stream_info *stream_info;
95*4882a593Smuzhiyun struct xhci_ring *show_ring;
96*4882a593Smuzhiyun unsigned int stream_id;
97*4882a593Smuzhiyun };
98*4882a593Smuzhiyun
99*4882a593Smuzhiyun struct xhci_slot_priv {
100*4882a593Smuzhiyun char name[DEBUGFS_NAMELEN];
101*4882a593Smuzhiyun struct dentry *root;
102*4882a593Smuzhiyun struct xhci_ep_priv *eps[31];
103*4882a593Smuzhiyun struct xhci_virt_device *dev;
104*4882a593Smuzhiyun };
105*4882a593Smuzhiyun
106*4882a593Smuzhiyun #ifdef CONFIG_DEBUG_FS
107*4882a593Smuzhiyun void xhci_debugfs_init(struct xhci_hcd *xhci);
108*4882a593Smuzhiyun void xhci_debugfs_exit(struct xhci_hcd *xhci);
109*4882a593Smuzhiyun void __init xhci_debugfs_create_root(void);
110*4882a593Smuzhiyun void __exit xhci_debugfs_remove_root(void);
111*4882a593Smuzhiyun void xhci_debugfs_create_slot(struct xhci_hcd *xhci, int slot_id);
112*4882a593Smuzhiyun void xhci_debugfs_remove_slot(struct xhci_hcd *xhci, int slot_id);
113*4882a593Smuzhiyun void xhci_debugfs_create_endpoint(struct xhci_hcd *xhci,
114*4882a593Smuzhiyun struct xhci_virt_device *virt_dev,
115*4882a593Smuzhiyun int ep_index);
116*4882a593Smuzhiyun void xhci_debugfs_remove_endpoint(struct xhci_hcd *xhci,
117*4882a593Smuzhiyun struct xhci_virt_device *virt_dev,
118*4882a593Smuzhiyun int ep_index);
119*4882a593Smuzhiyun void xhci_debugfs_create_stream_files(struct xhci_hcd *xhci,
120*4882a593Smuzhiyun struct xhci_virt_device *virt_dev,
121*4882a593Smuzhiyun int ep_index);
122*4882a593Smuzhiyun #else
xhci_debugfs_init(struct xhci_hcd * xhci)123*4882a593Smuzhiyun static inline void xhci_debugfs_init(struct xhci_hcd *xhci) { }
xhci_debugfs_exit(struct xhci_hcd * xhci)124*4882a593Smuzhiyun static inline void xhci_debugfs_exit(struct xhci_hcd *xhci) { }
xhci_debugfs_create_root(void)125*4882a593Smuzhiyun static inline void __init xhci_debugfs_create_root(void) { }
xhci_debugfs_remove_root(void)126*4882a593Smuzhiyun static inline void __exit xhci_debugfs_remove_root(void) { }
xhci_debugfs_create_slot(struct xhci_hcd * x,int s)127*4882a593Smuzhiyun static inline void xhci_debugfs_create_slot(struct xhci_hcd *x, int s) { }
xhci_debugfs_remove_slot(struct xhci_hcd * x,int s)128*4882a593Smuzhiyun static inline void xhci_debugfs_remove_slot(struct xhci_hcd *x, int s) { }
129*4882a593Smuzhiyun static inline void
xhci_debugfs_create_endpoint(struct xhci_hcd * xhci,struct xhci_virt_device * virt_dev,int ep_index)130*4882a593Smuzhiyun xhci_debugfs_create_endpoint(struct xhci_hcd *xhci,
131*4882a593Smuzhiyun struct xhci_virt_device *virt_dev,
132*4882a593Smuzhiyun int ep_index) { }
133*4882a593Smuzhiyun static inline void
xhci_debugfs_remove_endpoint(struct xhci_hcd * xhci,struct xhci_virt_device * virt_dev,int ep_index)134*4882a593Smuzhiyun xhci_debugfs_remove_endpoint(struct xhci_hcd *xhci,
135*4882a593Smuzhiyun struct xhci_virt_device *virt_dev,
136*4882a593Smuzhiyun int ep_index) { }
137*4882a593Smuzhiyun static inline void
xhci_debugfs_create_stream_files(struct xhci_hcd * xhci,struct xhci_virt_device * virt_dev,int ep_index)138*4882a593Smuzhiyun xhci_debugfs_create_stream_files(struct xhci_hcd *xhci,
139*4882a593Smuzhiyun struct xhci_virt_device *virt_dev,
140*4882a593Smuzhiyun int ep_index) { }
141*4882a593Smuzhiyun #endif /* CONFIG_DEBUG_FS */
142*4882a593Smuzhiyun
143*4882a593Smuzhiyun #endif /* __LINUX_XHCI_DEBUGFS_H */
144