xref: /linux/Documentation/ABI/testing/debugfs-hisi-zip (revision 79790b6818e96c58fe2bffee1b418c16e64e7b80)

What:		/sys/kernel/debug/hisi_zip/<bdf>/comp_core[01]/regs
Date:		Nov 2018
Contact:	linux-crypto@vger.kernel.org
Description:	Dump of compression cores related debug registers.
		Only available for PF.

What:		/sys/kernel/debug/hisi_zip/<bdf>/decomp_core[0-5]/regs
Date:		Nov 2018
Contact:	linux-crypto@vger.kernel.org
Description:	Dump of decompression cores related debug registers.
		Only available for PF.

What:		/sys/kernel/debug/hisi_zip/<bdf>/clear_enable
Date:		Nov 2018
Contact:	linux-crypto@vger.kernel.org
Description:	Compression/decompression core debug registers read clear
		control. 1 means enable register read clear, otherwise 0.
		Writing to this file has no functional effect, only enable or
		disable counters clear after reading of these registers.
		Only available for PF.

What:		/sys/kernel/debug/hisi_zip/<bdf>/current_qm
Date:		Nov 2018
Contact:	linux-crypto@vger.kernel.org
Description:	One ZIP controller has one PF and multiple VFs, each function
		has a QM. Select the QM which below qm refers to.
		Only available for PF.

What:		/sys/kernel/debug/hisi_zip/<bdf>/alg_qos
Date:		Jun 2021
Contact:	linux-crypto@vger.kernel.org
Description:	The <bdf> is related the function for PF and VF.
		ZIP driver supports to configure each function's QoS, the driver
		supports to write <bdf> value to alg_qos in the host. Such as
		"echo <bdf> value > alg_qos". The qos value is 1~1000, means
		1/1000~1000/1000 of total QoS. The driver reading alg_qos to
		get related QoS in the host and VM, Such as "cat alg_qos".

What:		/sys/kernel/debug/hisi_zip/<bdf>/qm/regs
Date:		Nov 2018
Contact:	linux-crypto@vger.kernel.org
Description:	Dump of QM related debug registers.
		Available for PF and VF in host. VF in guest currently only
		has one debug register.

What:		/sys/kernel/debug/hisi_zip/<bdf>/qm/current_q
Date:		Nov 2018
Contact:	linux-crypto@vger.kernel.org
Description:	One QM may contain multiple queues. Select specific queue to
		show its debug registers in above regs.
		Only available for PF.

What:		/sys/kernel/debug/hisi_zip/<bdf>/qm/clear_enable
Date:		Nov 2018
Contact:	linux-crypto@vger.kernel.org
Description:	QM debug registers(regs) read clear control. 1 means enable
		register read clear, otherwise 0.
		Writing to this file has no functional effect, only enable or
		disable counters clear after reading of these registers.
		Only available for PF.

What:		/sys/kernel/debug/hisi_zip/<bdf>/qm/err_irq
Date:		Apr 2020
Contact:	linux-crypto@vger.kernel.org
Description:	Dump the number of invalid interrupts for
		QM task completion.
		Available for both PF and VF, and take no other effect on ZIP.

What:		/sys/kernel/debug/hisi_zip/<bdf>/qm/aeq_irq
Date:		Apr 2020
Contact:	linux-crypto@vger.kernel.org
Description:	Dump the number of QM async event queue interrupts.
		Available for both PF and VF, and take no other effect on ZIP.

What:		/sys/kernel/debug/hisi_zip/<bdf>/qm/abnormal_irq
Date:		Apr 2020
Contact:	linux-crypto@vger.kernel.org
Description:	Dump the number of interrupts for QM abnormal event.
		Available for both PF and VF, and take no other effect on ZIP.

What:		/sys/kernel/debug/hisi_zip/<bdf>/qm/create_qp_err
Date:		Apr 2020
Contact:	linux-crypto@vger.kernel.org
Description:	Dump the number of queue allocation errors.
		Available for both PF and VF, and take no other effect on ZIP.

What:		/sys/kernel/debug/hisi_zip/<bdf>/qm/mb_err
Date:		Apr 2020
Contact:	linux-crypto@vger.kernel.org
Description:	Dump the number of failed QM mailbox commands.
		Available for both PF and VF, and take no other effect on ZIP.

What:		/sys/kernel/debug/hisi_zip/<bdf>/qm/status
Date:		Apr 2020
Contact:	linux-crypto@vger.kernel.org
Description:	Dump the status of the QM.
		Two states: work, stop.
		Available for both PF and VF, and take no other effect on ZIP.

What:		/sys/kernel/debug/hisi_zip/<bdf>/qm/diff_regs
Date:		Mar 2022
Contact:	linux-crypto@vger.kernel.org
Description:	QM debug registers(regs) read hardware register value. This
		node is used to show the change of the qm registers value. This
		node can be help users to check the change of register values.

What:		/sys/kernel/debug/hisi_zip/<bdf>/qm/qm_state
Date:		Jan 2024
Contact:	linux-crypto@vger.kernel.org
Description:	Dump the state of the device.
		0: busy, 1: idle.
		Only available for PF, and take no other effect on ZIP.

What:		/sys/kernel/debug/hisi_zip/<bdf>/qm/dev_timeout
Date:		Feb 2024
Contact:	linux-crypto@vger.kernel.org
Description:	Set the wait time when stop queue fails. Available for both PF
		and VF, and take no other effect on ZIP.
		0: not wait(default), others value: wait dev_timeout * 20 microsecond.

What:		/sys/kernel/debug/hisi_zip/<bdf>/qm/dev_state
Date:		Feb 2024
Contact:	linux-crypto@vger.kernel.org
Description:	Dump the stop queue status of the QM. The default value is 0,
		if dev_timeout is set, when stop queue fails, the dev_state
		will return non-zero value. Available for both PF and VF,
		and take no other effect on ZIP.

What:		/sys/kernel/debug/hisi_zip/<bdf>/zip_dfx/diff_regs
Date:		Mar 2022
Contact:	linux-crypto@vger.kernel.org
Description:	ZIP debug registers(regs) read hardware register value. This
		node is used to show the change of the registers value. this
		node can be help users to check the change of register values.

What:		/sys/kernel/debug/hisi_zip/<bdf>/zip_dfx/send_cnt
Date:		Apr 2020
Contact:	linux-crypto@vger.kernel.org
Description:	Dump the total number of sent requests.
		Available for both PF and VF, and take no other effect on ZIP.

What:		/sys/kernel/debug/hisi_zip/<bdf>/zip_dfx/recv_cnt
Date:		Apr 2020
Contact:	linux-crypto@vger.kernel.org
Description:	Dump the total number of received requests.
		Available for both PF and VF, and take no other effect on ZIP.

What:		/sys/kernel/debug/hisi_zip/<bdf>/zip_dfx/send_busy_cnt
Date:		Apr 2020
Contact:	linux-crypto@vger.kernel.org
Description:	Dump the total number of requests received
		with returning busy.
		Available for both PF and VF, and take no other effect on ZIP.

What:		/sys/kernel/debug/hisi_zip/<bdf>/zip_dfx/err_bd_cnt
Date:		Apr 2020
Contact:	linux-crypto@vger.kernel.org
Description:	Dump the total number of BD type error requests
		to be received.
		Available for both PF and VF, and take no other effect on ZIP.