Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 8201fdf4 authored by Zhou Wang's avatar Zhou Wang Committed by Herbert Xu
Browse files

Documentation: Add debugfs doc for hisi_zip 



Add debugfs descriptions for HiSilicon ZIP and QM driver.

Signed-off-by: default avatarZhou Wang <wangzhou1@hisilicon.com>
Reviewed-by: default avatarJonathan Cameron <Jonathan.Cameron@huawei.com>
Signed-off-by: default avatarHerbert Xu <herbert@gondor.apana.org.au>
parent 79e09f30

Documentation/ABI/testing/debugfs-hisi-zip

0 → 100644
+50 −0
Original line number Diff line number Diff line 
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>/qm/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 qm_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(qm_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.