xref: /linux/Documentation/ABI/testing/debugfs-hisi-sec (revision 2573c25e2c482b53b6e1142ff3cd28f6de13e659)
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>/qm/qm_regs
28Date:		Oct 2019
29Contact:	linux-crypto@vger.kernel.org
30Description:	Dump of QM related debug registers.
31		Available for PF and VF in host. VF in guest currently only
32		has one debug register.
33
34What:		/sys/kernel/debug/hisi_sec2/<bdf>/qm/current_q
35Date:		Oct 2019
36Contact:	linux-crypto@vger.kernel.org
37Description:	One QM of SEC may contain multiple queues. Select specific
38		queue to show its debug registers in above 'regs'.
39		Only available for PF.
40
41What:		/sys/kernel/debug/hisi_sec2/<bdf>/qm/clear_enable
42Date:		Oct 2019
43Contact:	linux-crypto@vger.kernel.org
44Description:	Enabling/disabling of clear action after reading
45		the SEC's QM debug registers.
46		0: disable, 1: enable.
47		Only available for PF, and take no other effect on SEC.
48
49What:		/sys/kernel/debug/hisi_sec2/<bdf>/qm/err_irq
50Date:		Apr 2020
51Contact:	linux-crypto@vger.kernel.org
52Description:	Dump the number of invalid interrupts for
53		QM task completion.
54		Available for both PF and VF, and take no other effect on SEC.
55
56What:		/sys/kernel/debug/hisi_sec2/<bdf>/qm/aeq_irq
57Date:		Apr 2020
58Contact:	linux-crypto@vger.kernel.org
59Description:	Dump the number of QM async event queue interrupts.
60		Available for both PF and VF, and take no other effect on SEC.
61
62What:		/sys/kernel/debug/hisi_sec2/<bdf>/qm/abnormal_irq
63Date:		Apr 2020
64Contact:	linux-crypto@vger.kernel.org
65Description:	Dump the number of interrupts for QM abnormal event.
66		Available for both PF and VF, and take no other effect on SEC.
67
68What:		/sys/kernel/debug/hisi_sec2/<bdf>/qm/create_qp_err
69Date:		Apr 2020
70Contact:	linux-crypto@vger.kernel.org
71Description:	Dump the number of queue allocation errors.
72		Available for both PF and VF, and take no other effect on SEC.
73
74What:		/sys/kernel/debug/hisi_sec2/<bdf>/qm/mb_err
75Date:		Apr 2020
76Contact:	linux-crypto@vger.kernel.org
77Description:	Dump the number of failed QM mailbox commands.
78		Available for both PF and VF, and take no other effect on SEC.
79
80What:		/sys/kernel/debug/hisi_sec2/<bdf>/qm/status
81Date:		Apr 2020
82Contact:	linux-crypto@vger.kernel.org
83Description:	Dump the status of the QM.
84		Two states: work, stop.
85		Available for both PF and VF, and take no other effect on SEC.
86
87What:		/sys/kernel/debug/hisi_sec2/<bdf>/qm/diff_regs
88Date:		Mar 2022
89Contact:	linux-crypto@vger.kernel.org
90Description:	QM debug registers(regs) read hardware register value. This
91		node is used to show the change of the qm register values. This
92		node can be help users to check the change of register values.
93
94What:		/sys/kernel/debug/hisi_sec2/<bdf>/qm/qm_state
95Date:		Jan 2024
96Contact:	linux-crypto@vger.kernel.org
97Description:	Dump the state of the device.
98		0: busy, 1: idle.
99		Only available for PF, and take no other effect on SEC.
100
101What:		/sys/kernel/debug/hisi_sec2/<bdf>/qm/dev_timeout
102Date:		Feb 2024
103Contact:	linux-crypto@vger.kernel.org
104Description:	Set the wait time when stop queue fails. Available for both PF
105		and VF, and take no other effect on SEC.
106		0: not wait(default), others value: wait dev_timeout * 20 microsecond.
107
108What:		/sys/kernel/debug/hisi_sec2/<bdf>/qm/dev_state
109Date:		Feb 2024
110Contact:	linux-crypto@vger.kernel.org
111Description:	Dump the stop queue status of the QM. The default value is 0,
112		if dev_timeout is set, when stop queue fails, the dev_state
113		will return non-zero value. Available for both PF and VF,
114		and take no other effect on SEC.
115
116What:		/sys/kernel/debug/hisi_sec2/<bdf>/sec_dfx/diff_regs
117Date:		Mar 2022
118Contact:	linux-crypto@vger.kernel.org
119Description:	SEC debug registers(regs) read hardware register value. This
120		node is used to show the change of the register values. This
121		node can be help users to check the change of register values.
122
123What:		/sys/kernel/debug/hisi_sec2/<bdf>/sec_dfx/send_cnt
124Date:		Apr 2020
125Contact:	linux-crypto@vger.kernel.org
126Description:	Dump the total number of sent requests.
127		Available for both PF and VF, and take no other effect on SEC.
128
129What:		/sys/kernel/debug/hisi_sec2/<bdf>/sec_dfx/recv_cnt
130Date:		Apr 2020
131Contact:	linux-crypto@vger.kernel.org
132Description:	Dump the total number of received requests.
133		Available for both PF and VF, and take no other effect on SEC.
134
135What:		/sys/kernel/debug/hisi_sec2/<bdf>/sec_dfx/send_busy_cnt
136Date:		Apr 2020
137Contact:	linux-crypto@vger.kernel.org
138Description:	Dump the total number of requests sent with returning busy.
139		Available for both PF and VF, and take no other effect on SEC.
140
141What:		/sys/kernel/debug/hisi_sec2/<bdf>/sec_dfx/err_bd_cnt
142Date:		Apr 2020
143Contact:	linux-crypto@vger.kernel.org
144Description:	Dump the total number of BD type error requests
145		to be received.
146		Available for both PF and VF, and take no other effect on SEC.
147
148What:		/sys/kernel/debug/hisi_sec2/<bdf>/sec_dfx/invalid_req_cnt
149Date:		Apr 2020
150Contact:	linux-crypto@vger.kernel.org
151Description:	Dump the total number of invalid requests being received.
152		Available for both PF and VF, and take no other effect on SEC.
153
154What:		/sys/kernel/debug/hisi_sec2/<bdf>/sec_dfx/done_flag_cnt
155Date:		Apr 2020
156Contact:	linux-crypto@vger.kernel.org
157Description:	Dump the total number of completed but marked error requests
158		to be received.
159		Available for both PF and VF, and take no other effect on SEC.
160