xref: /linux/Documentation/ABI/testing/debugfs-hisi-zip (revision 7a5f1cd22d47f8ca4b760b6334378ae42c1bd24b)
1What:		/sys/kernel/debug/hisi_zip/<bdf>/comp_core[01]/regs
2Date:		Nov 2018
3Contact:	linux-crypto@vger.kernel.org
4Description:	Dump of compression cores related debug registers.
5		Only available for PF.
6
7What:		/sys/kernel/debug/hisi_zip/<bdf>/decomp_core[0-5]/regs
8Date:		Nov 2018
9Contact:	linux-crypto@vger.kernel.org
10Description:	Dump of decompression cores related debug registers.
11		Only available for PF.
12
13What:		/sys/kernel/debug/hisi_zip/<bdf>/clear_enable
14Date:		Nov 2018
15Contact:	linux-crypto@vger.kernel.org
16Description:	Compression/decompression core debug registers read clear
17		control. 1 means enable register read clear, otherwise 0.
18		Writing to this file has no functional effect, only enable or
19		disable counters clear after reading of these registers.
20		Only available for PF.
21
22What:		/sys/kernel/debug/hisi_zip/<bdf>/current_qm
23Date:		Nov 2018
24Contact:	linux-crypto@vger.kernel.org
25Description:	One ZIP controller has one PF and multiple VFs, each function
26		has a QM. Select the QM which below qm refers to.
27		Only available for PF.
28
29What:		/sys/kernel/debug/hisi_zip/<bdf>/alg_qos
30Date:		Jun 2021
31Contact:	linux-crypto@vger.kernel.org
32Description:	The <bdf> is related the function for PF and VF.
33		ZIP driver supports to configure each function's QoS, the driver
34		supports to write <bdf> value to alg_qos in the host. Such as
35		"echo <bdf> value > alg_qos". The qos value is 1~1000, means
36		1/1000~1000/1000 of total QoS. The driver reading alg_qos to
37		get related QoS in the host and VM, Such as "cat alg_qos".
38
39What:		/sys/kernel/debug/hisi_zip/<bdf>/dev_usage
40Date:		Mar 2026
41Contact:	linux-crypto@vger.kernel.org
42Description:	Query the real-time bandwidth usage of device.
43		Returns the bandwidth usage of each channel on the device.
44		The returned number is in percentage.
45
46What:		/sys/kernel/debug/hisi_zip/<bdf>/qm/regs
47Date:		Nov 2018
48Contact:	linux-crypto@vger.kernel.org
49Description:	Dump of QM related debug registers.
50		Available for PF and VF in host. VF in guest currently only
51		has one debug register.
52
53What:		/sys/kernel/debug/hisi_zip/<bdf>/qm/current_q
54Date:		Nov 2018
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_zip/<bdf>/qm/clear_enable
61Date:		Nov 2018
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_zip/<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 ZIP.
75
76What:		/sys/kernel/debug/hisi_zip/<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 ZIP.
81
82What:		/sys/kernel/debug/hisi_zip/<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 ZIP.
87
88What:		/sys/kernel/debug/hisi_zip/<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 ZIP.
93
94What:		/sys/kernel/debug/hisi_zip/<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 ZIP.
99
100What:		/sys/kernel/debug/hisi_zip/<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 ZIP.
106
107What:		/sys/kernel/debug/hisi_zip/<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 registers value. This
112		node can be help users to check the change of register values.
113
114What:		/sys/kernel/debug/hisi_zip/<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 ZIP.
120
121What:		/sys/kernel/debug/hisi_zip/<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 ZIP.
126		0: not wait(default), others value: wait dev_timeout * 20 microsecond.
127
128What:		/sys/kernel/debug/hisi_zip/<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 ZIP.
135
136What:		/sys/kernel/debug/hisi_zip/<bdf>/zip_dfx/diff_regs
137Date:		Mar 2022
138Contact:	linux-crypto@vger.kernel.org
139Description:	ZIP debug registers(regs) read hardware register value. This
140		node is used to show the change of the registers value. this
141		node can be help users to check the change of register values.
142
143What:		/sys/kernel/debug/hisi_zip/<bdf>/zip_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 ZIP.
148
149What:		/sys/kernel/debug/hisi_zip/<bdf>/zip_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 ZIP.
154
155What:		/sys/kernel/debug/hisi_zip/<bdf>/zip_dfx/send_busy_cnt
156Date:		Apr 2020
157Contact:	linux-crypto@vger.kernel.org
158Description:	Dump the total number of requests received
159		with returning busy.
160		Available for both PF and VF, and take no other effect on ZIP.
161
162What:		/sys/kernel/debug/hisi_zip/<bdf>/zip_dfx/err_bd_cnt
163Date:		Apr 2020
164Contact:	linux-crypto@vger.kernel.org
165Description:	Dump the total number of BD type error requests
166		to be received.
167		Available for both PF and VF, and take no other effect on ZIP.
168
169What:           /sys/kernel/debug/hisi_zip/<bdf>/cap_regs
170Date:           Oct 2024
171Contact:        linux-crypto@vger.kernel.org
172Description:    Dump the values of the qm and zip capability bit registers and
173                support the query of device specifications to facilitate fault locating.
174                Available for both PF and VF, and take no other effect on ZIP.
175