xref: /linux/Documentation/ABI/testing/debugfs-hisi-zip (revision be239684b18e1cdcafcf8c7face4a2f562c745ad)
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>/qm/regs
40Date:		Nov 2018
41Contact:	linux-crypto@vger.kernel.org
42Description:	Dump of QM related debug registers.
43		Available for PF and VF in host. VF in guest currently only
44		has one debug register.
45
46What:		/sys/kernel/debug/hisi_zip/<bdf>/qm/current_q
47Date:		Nov 2018
48Contact:	linux-crypto@vger.kernel.org
49Description:	One QM may contain multiple queues. Select specific queue to
50		show its debug registers in above regs.
51		Only available for PF.
52
53What:		/sys/kernel/debug/hisi_zip/<bdf>/qm/clear_enable
54Date:		Nov 2018
55Contact:	linux-crypto@vger.kernel.org
56Description:	QM debug registers(regs) read clear control. 1 means enable
57		register read clear, otherwise 0.
58		Writing to this file has no functional effect, only enable or
59		disable counters clear after reading of these registers.
60		Only available for PF.
61
62What:		/sys/kernel/debug/hisi_zip/<bdf>/qm/err_irq
63Date:		Apr 2020
64Contact:	linux-crypto@vger.kernel.org
65Description:	Dump the number of invalid interrupts for
66		QM task completion.
67		Available for both PF and VF, and take no other effect on ZIP.
68
69What:		/sys/kernel/debug/hisi_zip/<bdf>/qm/aeq_irq
70Date:		Apr 2020
71Contact:	linux-crypto@vger.kernel.org
72Description:	Dump the number of QM async event queue interrupts.
73		Available for both PF and VF, and take no other effect on ZIP.
74
75What:		/sys/kernel/debug/hisi_zip/<bdf>/qm/abnormal_irq
76Date:		Apr 2020
77Contact:	linux-crypto@vger.kernel.org
78Description:	Dump the number of interrupts for QM abnormal event.
79		Available for both PF and VF, and take no other effect on ZIP.
80
81What:		/sys/kernel/debug/hisi_zip/<bdf>/qm/create_qp_err
82Date:		Apr 2020
83Contact:	linux-crypto@vger.kernel.org
84Description:	Dump the number of queue allocation errors.
85		Available for both PF and VF, and take no other effect on ZIP.
86
87What:		/sys/kernel/debug/hisi_zip/<bdf>/qm/mb_err
88Date:		Apr 2020
89Contact:	linux-crypto@vger.kernel.org
90Description:	Dump the number of failed QM mailbox commands.
91		Available for both PF and VF, and take no other effect on ZIP.
92
93What:		/sys/kernel/debug/hisi_zip/<bdf>/qm/status
94Date:		Apr 2020
95Contact:	linux-crypto@vger.kernel.org
96Description:	Dump the status of the QM.
97		Two states: work, stop.
98		Available for both PF and VF, and take no other effect on ZIP.
99
100What:		/sys/kernel/debug/hisi_zip/<bdf>/qm/diff_regs
101Date:		Mar 2022
102Contact:	linux-crypto@vger.kernel.org
103Description:	QM debug registers(regs) read hardware register value. This
104		node is used to show the change of the qm registers value. This
105		node can be help users to check the change of register values.
106
107What:		/sys/kernel/debug/hisi_zip/<bdf>/zip_dfx/diff_regs
108Date:		Mar 2022
109Contact:	linux-crypto@vger.kernel.org
110Description:	ZIP debug registers(regs) read hardware register value. This
111		node is used to show the change of the registers value. this
112		node can be help users to check the change of register values.
113
114What:		/sys/kernel/debug/hisi_zip/<bdf>/zip_dfx/send_cnt
115Date:		Apr 2020
116Contact:	linux-crypto@vger.kernel.org
117Description:	Dump the total number of sent requests.
118		Available for both PF and VF, and take no other effect on ZIP.
119
120What:		/sys/kernel/debug/hisi_zip/<bdf>/zip_dfx/recv_cnt
121Date:		Apr 2020
122Contact:	linux-crypto@vger.kernel.org
123Description:	Dump the total number of received requests.
124		Available for both PF and VF, and take no other effect on ZIP.
125
126What:		/sys/kernel/debug/hisi_zip/<bdf>/zip_dfx/send_busy_cnt
127Date:		Apr 2020
128Contact:	linux-crypto@vger.kernel.org
129Description:	Dump the total number of requests received
130		with returning busy.
131		Available for both PF and VF, and take no other effect on ZIP.
132
133What:		/sys/kernel/debug/hisi_zip/<bdf>/zip_dfx/err_bd_cnt
134Date:		Apr 2020
135Contact:	linux-crypto@vger.kernel.org
136Description:	Dump the total number of BD type error requests
137		to be received.
138		Available for both PF and VF, and take no other effect on ZIP.
139