Documentation/ABI/testing/debugfs-hisi-zip

Source file repositories/reference/linux-study-clean/Documentation/ABI/testing/debugfs-hisi-zip

File Facts

System
Linux kernel
Corpus path
Documentation/ABI/testing/debugfs-hisi-zip
Extension
[no extension]
Size
6943 bytes
Lines
175
Domain
Support Tooling And Documentation
Bucket
Documentation
Inferred role
Support Tooling And Documentation: Documentation
Status
atlas-only

Why This File Exists

Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.

Dependency Surface

Detected Declarations

Annotated Snippet

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>/dev_usage
Date:		Mar 2026
Contact:	linux-crypto@vger.kernel.org
Description:	Query the real-time bandwidth usage of device.
		Returns the bandwidth usage of each channel on the device.
		The returned number is in percentage.

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

Annotation

Implementation Notes