xref: /linux/Documentation/ABI/testing/debugfs-hisi-sec (revision b44c7129f1e3cd0e6233c7cb2d88f917d92f213d)
1What:		/sys/kernel/debug/hisi_sec2/<bdf>/clear_enable
2Date:		Oct 2019
3Contact:	linux-crypto@vger.kernel.org
4Description:	Enabling/disabling of clear action after reading
5		the SEC debug registers.
6		0: disable, 1: enable.
7		Only available for PF, and take no other effect on SEC.
8
9What:		/sys/kernel/debug/hisi_sec2/<bdf>/current_qm
10Date:		Oct 2019
11Contact:	linux-crypto@vger.kernel.org
12Description:	One SEC controller has one PF and multiple VFs, each function
13		has a QM. This file can be used to select the QM which below
14		qm refers to.
15		Only available for PF.
16
17What:		/sys/kernel/debug/hisi_sec2/<bdf>/alg_qos
18Date:		Jun 2021
19Contact:	linux-crypto@vger.kernel.org
20Description:	The <bdf> is related the function for PF and VF.
21		SEC driver supports to configure each function's QoS, the driver
22		supports to write <bdf> value to alg_qos in the host. Such as
23		"echo <bdf> value > alg_qos". The qos value is 1~1000, means
24		1/1000~1000/1000 of total QoS. The driver reading alg_qos to
25		get related QoS in the host and VM, Such as "cat alg_qos".
26
27What:		/sys/kernel/debug/hisi_sec2/<bdf>/dev_usage
28Date:		Mar 2026
29Contact:	linux-crypto@vger.kernel.org
30Description:	Query the real-time bandwidth usage of device.
31		Returns the bandwidth usage of each channel on the device.
32		The returned number is in percentage.
33
34What:		/sys/kernel/debug/hisi_sec2/<bdf>/qm/qm_regs
35Date:		Oct 2019
36Contact:	linux-crypto@vger.kernel.org
37Description:	Dump of QM related debug registers.
38		Available for PF and VF in host. VF in guest currently only
39		has one debug register.
40
41What:		/sys/kernel/debug/hisi_sec2/<bdf>/qm/current_q
42Date:		Oct 2019
43Contact:	linux-crypto@vger.kernel.org
44Description:	One QM of SEC may contain multiple queues. Select specific
45		queue to show its debug registers in above 'regs'.
46		Only available for PF.
47
48What:		/sys/kernel/debug/hisi_sec2/<bdf>/qm/clear_enable
49Date:		Oct 2019
50Contact:	linux-crypto@vger.kernel.org
51Description:	Enabling/disabling of clear action after reading
52		the SEC's QM debug registers.
53		0: disable, 1: enable.
54		Only available for PF, and take no other effect on SEC.
55
56What:		/sys/kernel/debug/hisi_sec2/<bdf>/qm/err_irq
57Date:		Apr 2020
58Contact:	linux-crypto@vger.kernel.org
59Description:	Dump the number of invalid interrupts for
60		QM task completion.
61		Available for both PF and VF, and take no other effect on SEC.
62
63What:		/sys/kernel/debug/hisi_sec2/<bdf>/qm/aeq_irq
64Date:		Apr 2020
65Contact:	linux-crypto@vger.kernel.org
66Description:	Dump the number of QM async event queue interrupts.
67		Available for both PF and VF, and take no other effect on SEC.
68
69What:		/sys/kernel/debug/hisi_sec2/<bdf>/qm/abnormal_irq
70Date:		Apr 2020
71Contact:	linux-crypto@vger.kernel.org
72Description:	Dump the number of interrupts for QM abnormal event.
73		Available for both PF and VF, and take no other effect on SEC.
74
75What:		/sys/kernel/debug/hisi_sec2/<bdf>/qm/create_qp_err
76Date:		Apr 2020
77Contact:	linux-crypto@vger.kernel.org
78Description:	Dump the number of queue allocation errors.
79		Available for both PF and VF, and take no other effect on SEC.
80
81What:		/sys/kernel/debug/hisi_sec2/<bdf>/qm/mb_err
82Date:		Apr 2020
83Contact:	linux-crypto@vger.kernel.org
84Description:	Dump the number of failed QM mailbox commands.
85		Available for both PF and VF, and take no other effect on SEC.
86
87What:		/sys/kernel/debug/hisi_sec2/<bdf>/qm/status
88Date:		Apr 2020
89Contact:	linux-crypto@vger.kernel.org
90Description:	Dump the status of the QM.
91		Two states: work, stop.
92		Available for both PF and VF, and take no other effect on SEC.
93
94What:		/sys/kernel/debug/hisi_sec2/<bdf>/qm/diff_regs
95Date:		Mar 2022
96Contact:	linux-crypto@vger.kernel.org
97Description:	QM debug registers(regs) read hardware register value. This
98		node is used to show the change of the qm register values. This
99		node can be help users to check the change of register values.
100
101What:		/sys/kernel/debug/hisi_sec2/<bdf>/qm/qm_state
102Date:		Jan 2024
103Contact:	linux-crypto@vger.kernel.org
104Description:	Dump the state of the device.
105		0: busy, 1: idle.
106		Only available for PF, and take no other effect on SEC.
107
108What:		/sys/kernel/debug/hisi_sec2/<bdf>/qm/dev_timeout
109Date:		Feb 2024
110Contact:	linux-crypto@vger.kernel.org
111Description:	Set the wait time when stop queue fails. Available for both PF
112		and VF, and take no other effect on SEC.
113		0: not wait(default), others value: wait dev_timeout * 20 microsecond.
114
115What:		/sys/kernel/debug/hisi_sec2/<bdf>/qm/dev_state
116Date:		Feb 2024
117Contact:	linux-crypto@vger.kernel.org
118Description:	Dump the stop queue status of the QM. The default value is 0,
119		if dev_timeout is set, when stop queue fails, the dev_state
120		will return non-zero value. Available for both PF and VF,
121		and take no other effect on SEC.
122
123What:		/sys/kernel/debug/hisi_sec2/<bdf>/sec_dfx/diff_regs
124Date:		Mar 2022
125Contact:	linux-crypto@vger.kernel.org
126Description:	SEC debug registers(regs) read hardware register value. This
127		node is used to show the change of the register values. This
128		node can be help users to check the change of register values.
129
130What:		/sys/kernel/debug/hisi_sec2/<bdf>/sec_dfx/send_cnt
131Date:		Apr 2020
132Contact:	linux-crypto@vger.kernel.org
133Description:	Dump the total number of sent requests.
134		Available for both PF and VF, and take no other effect on SEC.
135
136What:		/sys/kernel/debug/hisi_sec2/<bdf>/sec_dfx/recv_cnt
137Date:		Apr 2020
138Contact:	linux-crypto@vger.kernel.org
139Description:	Dump the total number of received requests.
140		Available for both PF and VF, and take no other effect on SEC.
141
142What:		/sys/kernel/debug/hisi_sec2/<bdf>/sec_dfx/send_busy_cnt
143Date:		Apr 2020
144Contact:	linux-crypto@vger.kernel.org
145Description:	Dump the total number of requests sent with returning busy.
146		Available for both PF and VF, and take no other effect on SEC.
147
148What:		/sys/kernel/debug/hisi_sec2/<bdf>/sec_dfx/err_bd_cnt
149Date:		Apr 2020
150Contact:	linux-crypto@vger.kernel.org
151Description:	Dump the total number of BD type error requests
152		to be received.
153		Available for both PF and VF, and take no other effect on SEC.
154
155What:		/sys/kernel/debug/hisi_sec2/<bdf>/sec_dfx/invalid_req_cnt
156Date:		Apr 2020
157Contact:	linux-crypto@vger.kernel.org
158Description:	Dump the total number of invalid requests being received.
159		Available for both PF and VF, and take no other effect on SEC.
160
161What:		/sys/kernel/debug/hisi_sec2/<bdf>/sec_dfx/done_flag_cnt
162Date:		Apr 2020
163Contact:	linux-crypto@vger.kernel.org
164Description:	Dump the total number of completed but marked error requests
165		to be received.
166		Available for both PF and VF, and take no other effect on SEC.
167
168What:           /sys/kernel/debug/hisi_sec2/<bdf>/cap_regs
169Date:           Oct 2024
170Contact:        linux-crypto@vger.kernel.org
171Description:    Dump the values of the qm and sec capability bit registers and
172                support the query of device specifications to facilitate fault locating.
173                Available for both PF and VF, and take no other effect on SEC.
174