xref: /linux/Documentation/ABI/testing/debugfs-hisi-hpre (revision aec2f682d47c54ef434b2d440992626d80b1ebdc)
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>/dev_usage
54Date:		Mar 2026
55Contact:	linux-crypto@vger.kernel.org
56Description:	Query the real-time bandwidth usage of device.
57		Returns the bandwidth usage of each channel on the device.
58		The returned number is in percentage.
59
60What:		/sys/kernel/debug/hisi_hpre/<bdf>/qm/current_q
61Date:		Sep 2019
62Contact:	linux-crypto@vger.kernel.org
63Description:	One QM may contain multiple queues. Select specific queue to
64		show its debug registers in above regs.
65		Only available for PF.
66
67What:		/sys/kernel/debug/hisi_hpre/<bdf>/qm/clear_enable
68Date:		Sep 2019
69Contact:	linux-crypto@vger.kernel.org
70Description:	QM debug registers(regs) read clear control. 1 means enable
71		register read clear, otherwise 0.
72		Writing to this file has no functional effect, only enable or
73		disable counters clear after reading of these registers.
74		Only available for PF.
75
76What:		/sys/kernel/debug/hisi_hpre/<bdf>/qm/err_irq
77Date:		Apr 2020
78Contact:	linux-crypto@vger.kernel.org
79Description:	Dump the number of invalid interrupts for
80		QM task completion.
81		Available for both PF and VF, and take no other effect on HPRE.
82
83What:		/sys/kernel/debug/hisi_hpre/<bdf>/qm/aeq_irq
84Date:		Apr 2020
85Contact:	linux-crypto@vger.kernel.org
86Description:	Dump the number of QM async event queue interrupts.
87		Available for both PF and VF, and take no other effect on HPRE.
88
89What:		/sys/kernel/debug/hisi_hpre/<bdf>/qm/abnormal_irq
90Date:		Apr 2020
91Contact:	linux-crypto@vger.kernel.org
92Description:	Dump the number of interrupts for QM abnormal event.
93		Available for both PF and VF, and take no other effect on HPRE.
94
95What:		/sys/kernel/debug/hisi_hpre/<bdf>/qm/create_qp_err
96Date:		Apr 2020
97Contact:	linux-crypto@vger.kernel.org
98Description:	Dump the number of queue allocation errors.
99		Available for both PF and VF, and take no other effect on HPRE.
100
101What:		/sys/kernel/debug/hisi_hpre/<bdf>/qm/mb_err
102Date:		Apr 2020
103Contact:	linux-crypto@vger.kernel.org
104Description:	Dump the number of failed QM mailbox commands.
105		Available for both PF and VF, and take no other effect on HPRE.
106
107What:		/sys/kernel/debug/hisi_hpre/<bdf>/qm/status
108Date:		Apr 2020
109Contact:	linux-crypto@vger.kernel.org
110Description:	Dump the status of the QM.
111		Two states: work, stop.
112		Available for both PF and VF, and take no other effect on HPRE.
113
114What:		/sys/kernel/debug/hisi_hpre/<bdf>/qm/diff_regs
115Date:		Mar 2022
116Contact:	linux-crypto@vger.kernel.org
117Description:	QM debug registers(regs) read hardware register value. This
118		node is used to show the change of the qm register values. This
119		node can be help users to check the change of register values.
120
121What:		/sys/kernel/debug/hisi_hpre/<bdf>/qm/qm_state
122Date:		Jan 2024
123Contact:	linux-crypto@vger.kernel.org
124Description:	Dump the state of the device.
125		0: busy, 1: idle.
126		Only available for PF, and take no other effect on HPRE.
127
128What:		/sys/kernel/debug/hisi_hpre/<bdf>/qm/dev_timeout
129Date:		Feb 2024
130Contact:	linux-crypto@vger.kernel.org
131Description:	Set the wait time when stop queue fails. Available for both PF
132		and VF, and take no other effect on HPRE.
133		0: not wait(default), others value: wait dev_timeout * 20 microsecond.
134
135What:		/sys/kernel/debug/hisi_hpre/<bdf>/qm/dev_state
136Date:		Feb 2024
137Contact:	linux-crypto@vger.kernel.org
138Description:	Dump the stop queue status of the QM. The default value is 0,
139		if dev_timeout is set, when stop queue fails, the dev_state
140		will return non-zero value. Available for both PF and VF,
141		and take no other effect on HPRE.
142
143What:		/sys/kernel/debug/hisi_hpre/<bdf>/hpre_dfx/diff_regs
144Date:		Mar 2022
145Contact:	linux-crypto@vger.kernel.org
146Description:	HPRE debug registers(regs) read hardware register value. This
147		node is used to show the change of the register values. This
148		node can be help users to check the change of register values.
149
150What:		/sys/kernel/debug/hisi_hpre/<bdf>/hpre_dfx/send_cnt
151Date:		Apr 2020
152Contact:	linux-crypto@vger.kernel.org
153Description:	Dump the total number of sent requests.
154		Available for both PF and VF, and take no other effect on HPRE.
155
156What:		/sys/kernel/debug/hisi_hpre/<bdf>/hpre_dfx/recv_cnt
157Date:		Apr 2020
158Contact:	linux-crypto@vger.kernel.org
159Description:	Dump the total number of received requests.
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_busy_cnt
163Date:		Apr 2020
164Contact:	linux-crypto@vger.kernel.org
165Description:	Dump the total number of requests sent
166		with returning busy.
167		Available for both PF and VF, and take no other effect on HPRE.
168
169What:		/sys/kernel/debug/hisi_hpre/<bdf>/hpre_dfx/send_fail_cnt
170Date:		Apr 2020
171Contact:	linux-crypto@vger.kernel.org
172Description:	Dump the total number of completed but error requests.
173		Available for both PF and VF, and take no other effect on HPRE.
174
175What:		/sys/kernel/debug/hisi_hpre/<bdf>/hpre_dfx/invalid_req_cnt
176Date:		Apr 2020
177Contact:	linux-crypto@vger.kernel.org
178Description:	Dump the total number of invalid requests being received.
179		Available for both PF and VF, and take no other effect on HPRE.
180
181What:		/sys/kernel/debug/hisi_hpre/<bdf>/hpre_dfx/overtime_thrhld
182Date:		Apr 2020
183Contact:	linux-crypto@vger.kernel.org
184Description:	Set the threshold time for counting the request which is
185		processed longer than the threshold.
186		0: disable(default), 1: 1 microsecond.
187		Available for both PF and VF, and take no other effect on HPRE.
188
189What:		/sys/kernel/debug/hisi_hpre/<bdf>/hpre_dfx/over_thrhld_cnt
190Date:		Apr 2020
191Contact:	linux-crypto@vger.kernel.org
192Description:	Dump the total number of time out requests.
193		Available for both PF and VF, and take no other effect on HPRE.
194
195What:           /sys/kernel/debug/hisi_hpre/<bdf>/cap_regs
196Date:           Oct 2024
197Contact:        linux-crypto@vger.kernel.org
198Description:    Dump the values of the qm and hpre capability bit registers and
199                support the query of device specifications to facilitate fault locating.
200                Available for both PF and VF, and take no other effect on HPRE.
201