xref: /linux/Documentation/ABI/testing/debugfs-hisi-hpre (revision 6e7fd890f1d6ac83805409e9c346240de2705584)
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>/alg_qos
31Date:		Jun 2021
32Contact:	linux-crypto@vger.kernel.org
33Description:	The <bdf> is related the function for PF and VF.
34		HPRE driver supports to configure each function's QoS, the driver
35		supports to write <bdf> value to alg_qos in the host. Such as
36		"echo <bdf> value > alg_qos". The qos value is 1~1000, means
37		1/1000~1000/1000 of total QoS. The driver reading alg_qos to
38		get related QoS in the host and VM, Such as "cat alg_qos".
39
40What:		/sys/kernel/debug/hisi_hpre/<bdf>/regs
41Date:		Sep 2019
42Contact:	linux-crypto@vger.kernel.org
43Description:	Dump debug registers from the HPRE.
44		Only available for PF.
45
46What:		/sys/kernel/debug/hisi_hpre/<bdf>/qm/regs
47Date:		Sep 2019
48Contact:	linux-crypto@vger.kernel.org
49Description:	Dump debug registers from the QM.
50		Available for PF and VF in host. VF in guest currently only
51		has one debug register.
52
53What:		/sys/kernel/debug/hisi_hpre/<bdf>/qm/current_q
54Date:		Sep 2019
55Contact:	linux-crypto@vger.kernel.org
56Description:	One QM may contain multiple queues. Select specific queue to
57		show its debug registers in above regs.
58		Only available for PF.
59
60What:		/sys/kernel/debug/hisi_hpre/<bdf>/qm/clear_enable
61Date:		Sep 2019
62Contact:	linux-crypto@vger.kernel.org
63Description:	QM debug registers(regs) read clear control. 1 means enable
64		register read clear, otherwise 0.
65		Writing to this file has no functional effect, only enable or
66		disable counters clear after reading of these registers.
67		Only available for PF.
68
69What:		/sys/kernel/debug/hisi_hpre/<bdf>/qm/err_irq
70Date:		Apr 2020
71Contact:	linux-crypto@vger.kernel.org
72Description:	Dump the number of invalid interrupts for
73		QM task completion.
74		Available for both PF and VF, and take no other effect on HPRE.
75
76What:		/sys/kernel/debug/hisi_hpre/<bdf>/qm/aeq_irq
77Date:		Apr 2020
78Contact:	linux-crypto@vger.kernel.org
79Description:	Dump the number of QM async event queue interrupts.
80		Available for both PF and VF, and take no other effect on HPRE.
81
82What:		/sys/kernel/debug/hisi_hpre/<bdf>/qm/abnormal_irq
83Date:		Apr 2020
84Contact:	linux-crypto@vger.kernel.org
85Description:	Dump the number of interrupts for QM abnormal event.
86		Available for both PF and VF, and take no other effect on HPRE.
87
88What:		/sys/kernel/debug/hisi_hpre/<bdf>/qm/create_qp_err
89Date:		Apr 2020
90Contact:	linux-crypto@vger.kernel.org
91Description:	Dump the number of queue allocation errors.
92		Available for both PF and VF, and take no other effect on HPRE.
93
94What:		/sys/kernel/debug/hisi_hpre/<bdf>/qm/mb_err
95Date:		Apr 2020
96Contact:	linux-crypto@vger.kernel.org
97Description:	Dump the number of failed QM mailbox commands.
98		Available for both PF and VF, and take no other effect on HPRE.
99
100What:		/sys/kernel/debug/hisi_hpre/<bdf>/qm/status
101Date:		Apr 2020
102Contact:	linux-crypto@vger.kernel.org
103Description:	Dump the status of the QM.
104		Two states: work, stop.
105		Available for both PF and VF, and take no other effect on HPRE.
106
107What:		/sys/kernel/debug/hisi_hpre/<bdf>/qm/diff_regs
108Date:		Mar 2022
109Contact:	linux-crypto@vger.kernel.org
110Description:	QM debug registers(regs) read hardware register value. This
111		node is used to show the change of the qm register values. This
112		node can be help users to check the change of register values.
113
114What:		/sys/kernel/debug/hisi_hpre/<bdf>/qm/qm_state
115Date:		Jan 2024
116Contact:	linux-crypto@vger.kernel.org
117Description:	Dump the state of the device.
118		0: busy, 1: idle.
119		Only available for PF, and take no other effect on HPRE.
120
121What:		/sys/kernel/debug/hisi_hpre/<bdf>/qm/dev_timeout
122Date:		Feb 2024
123Contact:	linux-crypto@vger.kernel.org
124Description:	Set the wait time when stop queue fails. Available for both PF
125		and VF, and take no other effect on HPRE.
126		0: not wait(default), others value: wait dev_timeout * 20 microsecond.
127
128What:		/sys/kernel/debug/hisi_hpre/<bdf>/qm/dev_state
129Date:		Feb 2024
130Contact:	linux-crypto@vger.kernel.org
131Description:	Dump the stop queue status of the QM. The default value is 0,
132		if dev_timeout is set, when stop queue fails, the dev_state
133		will return non-zero value. Available for both PF and VF,
134		and take no other effect on HPRE.
135
136What:		/sys/kernel/debug/hisi_hpre/<bdf>/hpre_dfx/diff_regs
137Date:		Mar 2022
138Contact:	linux-crypto@vger.kernel.org
139Description:	HPRE debug registers(regs) read hardware register value. This
140		node is used to show the change of the register values. This
141		node can be help users to check the change of register values.
142
143What:		/sys/kernel/debug/hisi_hpre/<bdf>/hpre_dfx/send_cnt
144Date:		Apr 2020
145Contact:	linux-crypto@vger.kernel.org
146Description:	Dump the total number of sent requests.
147		Available for both PF and VF, and take no other effect on HPRE.
148
149What:		/sys/kernel/debug/hisi_hpre/<bdf>/hpre_dfx/recv_cnt
150Date:		Apr 2020
151Contact:	linux-crypto@vger.kernel.org
152Description:	Dump the total number of received requests.
153		Available for both PF and VF, and take no other effect on HPRE.
154
155What:		/sys/kernel/debug/hisi_hpre/<bdf>/hpre_dfx/send_busy_cnt
156Date:		Apr 2020
157Contact:	linux-crypto@vger.kernel.org
158Description:	Dump the total number of requests sent
159		with returning busy.
160		Available for both PF and VF, and take no other effect on HPRE.
161
162What:		/sys/kernel/debug/hisi_hpre/<bdf>/hpre_dfx/send_fail_cnt
163Date:		Apr 2020
164Contact:	linux-crypto@vger.kernel.org
165Description:	Dump the total number of completed but error requests.
166		Available for both PF and VF, and take no other effect on HPRE.
167
168What:		/sys/kernel/debug/hisi_hpre/<bdf>/hpre_dfx/invalid_req_cnt
169Date:		Apr 2020
170Contact:	linux-crypto@vger.kernel.org
171Description:	Dump the total number of invalid requests being received.
172		Available for both PF and VF, and take no other effect on HPRE.
173
174What:		/sys/kernel/debug/hisi_hpre/<bdf>/hpre_dfx/overtime_thrhld
175Date:		Apr 2020
176Contact:	linux-crypto@vger.kernel.org
177Description:	Set the threshold time for counting the request which is
178		processed longer than the threshold.
179		0: disable(default), 1: 1 microsecond.
180		Available for both PF and VF, and take no other effect on HPRE.
181
182What:		/sys/kernel/debug/hisi_hpre/<bdf>/hpre_dfx/over_thrhld_cnt
183Date:		Apr 2020
184Contact:	linux-crypto@vger.kernel.org
185Description:	Dump the total number of time out requests.
186		Available for both PF and VF, and take no other effect on HPRE.
187