Documentation/ABI/testing/debugfs-hisi-hpre

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

File Facts

System
Linux kernel
Corpus path
Documentation/ABI/testing/debugfs-hisi-hpre
Extension
[no extension]
Size
8029 bytes
Lines
201
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_hpre/<bdf>/cluster[0-3]/regs
Date:		Sep 2019
Contact:	linux-crypto@vger.kernel.org
Description:	Dump debug registers from the HPRE cluster.
		Only available for PF.

What:		/sys/kernel/debug/hisi_hpre/<bdf>/cluster[0-3]/cluster_ctrl
Date:		Sep 2019
Contact:	linux-crypto@vger.kernel.org
Description:	Write the HPRE core selection in the cluster into this file,
		and then we can read the debug information of the core.
		Only available for PF.

What:		/sys/kernel/debug/hisi_hpre/<bdf>/rdclr_en
Date:		Sep 2019
Contact:	linux-crypto@vger.kernel.org
Description:	HPRE cores 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_hpre/<bdf>/current_qm
Date:		Sep 2019
Contact:	linux-crypto@vger.kernel.org
Description:	One HPRE 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_hpre/<bdf>/alg_qos
Date:		Jun 2021
Contact:	linux-crypto@vger.kernel.org
Description:	The <bdf> is related the function for PF and VF.
		HPRE 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_hpre/<bdf>/regs
Date:		Sep 2019
Contact:	linux-crypto@vger.kernel.org
Description:	Dump debug registers from the HPRE.
		Only available for PF.

What:		/sys/kernel/debug/hisi_hpre/<bdf>/qm/regs
Date:		Sep 2019
Contact:	linux-crypto@vger.kernel.org
Description:	Dump debug registers from the QM.
		Available for PF and VF in host. VF in guest currently only
		has one debug register.

What:		/sys/kernel/debug/hisi_hpre/<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_hpre/<bdf>/qm/current_q
Date:		Sep 2019
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_hpre/<bdf>/qm/clear_enable
Date:		Sep 2019
Contact:	linux-crypto@vger.kernel.org
Description:	QM debug registers(regs) read clear control. 1 means enable

Annotation

Implementation Notes