xref: /linux/Documentation/ABI/testing/debugfs-hisi-hpre (revision a1c3be890440a1769ed6f822376a3e3ab0d42994)
1What:           /sys/kernel/debug/hisi_hpre/<bdf>/cluster[0-3]/regs
2Date:           Sep 2019
3Contact:        linux-crypto@vger.kernel.org
4Description:    Dump debug registers from the HPRE cluster.
5		Only available for PF.
6
7What:           /sys/kernel/debug/hisi_hpre/<bdf>/cluster[0-3]/cluster_ctrl
8Date:           Sep 2019
9Contact:        linux-crypto@vger.kernel.org
10Description:    Write the HPRE core selection in the cluster into this file,
11		and then we can read the debug information of the core.
12		Only available for PF.
13
14What:           /sys/kernel/debug/hisi_hpre/<bdf>/rdclr_en
15Date:           Sep 2019
16Contact:        linux-crypto@vger.kernel.org
17Description:    HPRE cores debug registers read clear control. 1 means enable
18		register read clear, otherwise 0. Writing to this file has no
19		functional effect, only enable or disable counters clear after
20		reading of these registers.
21		Only available for PF.
22
23What:           /sys/kernel/debug/hisi_hpre/<bdf>/current_qm
24Date:           Sep 2019
25Contact:        linux-crypto@vger.kernel.org
26Description:    One HPRE controller has one PF and multiple VFs, each function
27		has a QM. Select the QM which below qm refers to.
28		Only available for PF.
29
30What:           /sys/kernel/debug/hisi_hpre/<bdf>/regs
31Date:           Sep 2019
32Contact:        linux-crypto@vger.kernel.org
33Description:    Dump debug registers from the HPRE.
34		Only available for PF.
35
36What:           /sys/kernel/debug/hisi_hpre/<bdf>/qm/regs
37Date:           Sep 2019
38Contact:        linux-crypto@vger.kernel.org
39Description:    Dump debug registers from the QM.
40		Available for PF and VF in host. VF in guest currently only
41		has one debug register.
42
43What:           /sys/kernel/debug/hisi_hpre/<bdf>/qm/current_q
44Date:           Sep 2019
45Contact:        linux-crypto@vger.kernel.org
46Description:    One QM may contain multiple queues. Select specific queue to
47		show its debug registers in above regs.
48		Only available for PF.
49
50What:           /sys/kernel/debug/hisi_hpre/<bdf>/qm/clear_enable
51Date:           Sep 2019
52Contact:        linux-crypto@vger.kernel.org
53Description:    QM debug registers(regs) read clear control. 1 means enable
54		register read clear, otherwise 0.
55		Writing to this file has no functional effect, only enable or
56		disable counters clear after reading of these registers.
57		Only available for PF.
58
59What:           /sys/kernel/debug/hisi_hpre/<bdf>/qm/err_irq
60Date:           Apr 2020
61Contact:        linux-crypto@vger.kernel.org
62Description:    Dump the number of invalid interrupts for
63		QM task completion.
64		Available for both PF and VF, and take no other effect on HPRE.
65
66What:           /sys/kernel/debug/hisi_hpre/<bdf>/qm/aeq_irq
67Date:           Apr 2020
68Contact:        linux-crypto@vger.kernel.org
69Description:    Dump the number of QM async event queue interrupts.
70		Available for both PF and VF, and take no other effect on HPRE.
71
72What:           /sys/kernel/debug/hisi_hpre/<bdf>/qm/abnormal_irq
73Date:           Apr 2020
74Contact:        linux-crypto@vger.kernel.org
75Description:    Dump the number of interrupts for QM abnormal event.
76		Available for both PF and VF, and take no other effect on HPRE.
77
78What:           /sys/kernel/debug/hisi_hpre/<bdf>/qm/create_qp_err
79Date:           Apr 2020
80Contact:        linux-crypto@vger.kernel.org
81Description:    Dump the number of queue allocation errors.
82		Available for both PF and VF, and take no other effect on HPRE.
83
84What:           /sys/kernel/debug/hisi_hpre/<bdf>/qm/mb_err
85Date:           Apr 2020
86Contact:        linux-crypto@vger.kernel.org
87Description:    Dump the number of failed QM mailbox commands.
88		Available for both PF and VF, and take no other effect on HPRE.
89
90What:           /sys/kernel/debug/hisi_hpre/<bdf>/qm/status
91Date:           Apr 2020
92Contact:        linux-crypto@vger.kernel.org
93Description:    Dump the status of the QM.
94		Four states: initiated, started, stopped and closed.
95		Available for both PF and VF, and take no other effect on HPRE.
96
97What:           /sys/kernel/debug/hisi_hpre/<bdf>/hpre_dfx/send_cnt
98Date:           Apr 2020
99Contact:        linux-crypto@vger.kernel.org
100Description:    Dump the total number of sent requests.
101		Available for both PF and VF, and take no other effect on HPRE.
102
103What:           /sys/kernel/debug/hisi_hpre/<bdf>/hpre_dfx/recv_cnt
104Date:           Apr 2020
105Contact:        linux-crypto@vger.kernel.org
106Description:    Dump the total number of received requests.
107		Available for both PF and VF, and take no other effect on HPRE.
108
109What:           /sys/kernel/debug/hisi_hpre/<bdf>/hpre_dfx/send_busy_cnt
110Date:           Apr 2020
111Contact:        linux-crypto@vger.kernel.org
112Description:    Dump the total number of requests sent
113		with returning busy.
114		Available for both PF and VF, and take no other effect on HPRE.
115
116What:           /sys/kernel/debug/hisi_hpre/<bdf>/hpre_dfx/send_fail_cnt
117Date:           Apr 2020
118Contact:        linux-crypto@vger.kernel.org
119Description:    Dump the total number of completed but error requests.
120		Available for both PF and VF, and take no other effect on HPRE.
121
122What:           /sys/kernel/debug/hisi_hpre/<bdf>/hpre_dfx/invalid_req_cnt
123Date:           Apr 2020
124Contact:        linux-crypto@vger.kernel.org
125Description:    Dump the total number of invalid requests being received.
126		Available for both PF and VF, and take no other effect on HPRE.
127
128What:           /sys/kernel/debug/hisi_hpre/<bdf>/hpre_dfx/overtime_thrhld
129Date:           Apr 2020
130Contact:        linux-crypto@vger.kernel.org
131Description:    Set the threshold time for counting the request which is
132		processed longer than the threshold.
133		0: disable(default), 1: 1 microsecond.
134		Available for both PF and VF, and take no other effect on HPRE.
135
136What:           /sys/kernel/debug/hisi_hpre/<bdf>/hpre_dfx/over_thrhld_cnt
137Date:           Apr 2020
138Contact:        linux-crypto@vger.kernel.org
139Description:    Dump the total number of time out requests.
140		Available for both PF and VF, and take no other effect on HPRE.
141