[PATCH 0/3] Documentation: update debugfs doc for Hisilicon Accelerator

[PATCH 0/3] Documentation: update debugfs doc for Hisilicon Accelerator

[Kai Ye]

Update documentation describing DebugFS for function's QoS limiting.
Add the note that described how to use the function's QoS limiting.

Kai Ye (3):
  Documentation: update debugfs doc for Hisilicon SEC
  Documentation: update debugfs doc for Hisilicon ZIP
  Documentation: update debugfs doc for Hisilicon HPRE

 Documentation/ABI/testing/debugfs-hisi-hpre | 10 ++++++++++
 Documentation/ABI/testing/debugfs-hisi-sec  | 10 ++++++++++
 Documentation/ABI/testing/debugfs-hisi-zip  | 10 ++++++++++
 3 files changed, 30 insertions(+)

-- 
2.33.0

[PATCH 1/3] Documentation: update debugfs doc for Hisilicon SEC

[Kai Ye]

Update documentation describing DebugFS for function's QoS limiting.

Signed-off-by: Kai Ye <yekai13@huawei.com>
---
 Documentation/ABI/testing/debugfs-hisi-sec | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/Documentation/ABI/testing/debugfs-hisi-sec b/Documentation/ABI/testing/debugfs-hisi-sec
index 85feb4408e0f..9e50ceab94d2 100644
--- a/Documentation/ABI/testing/debugfs-hisi-sec
+++ b/Documentation/ABI/testing/debugfs-hisi-sec
@@ -14,6 +14,16 @@ Description:    One SEC controller has one PF and multiple VFs, each function
 		qm refers to.
 		Only available for PF.
 
+What:           /sys/kernel/debug/hisi_sec2/<bdf>/alg_qos
+Date:           Jun 2021
+Contact:        linux-crypto@vger.kernel.org
+Description:	The <bdf> is related the function for PF and VF.
+		SEC 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_sec2/<bdf>/qm/qm_regs
 Date:           Oct 2019
 Contact:        linux-crypto@vger.kernel.org
-- 
2.33.0

[PATCH 2/3] Documentation: update debugfs doc for Hisilicon ZIP

[Kai Ye]

Update documentation describing DebugFS for function's QoS limiting.

Signed-off-by: Kai Ye <yekai13@huawei.com>
---
 Documentation/ABI/testing/debugfs-hisi-zip | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/Documentation/ABI/testing/debugfs-hisi-zip b/Documentation/ABI/testing/debugfs-hisi-zip
index 3034a2bf99ca..aff2edc24c94 100644
--- a/Documentation/ABI/testing/debugfs-hisi-zip
+++ b/Documentation/ABI/testing/debugfs-hisi-zip
@@ -26,6 +26,16 @@ 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
-- 
2.33.0

[PATCH 3/3] Documentation: update debugfs doc for Hisilicon HPRE

[Kai Ye]

Update documentation describing DebugFS for function's QoS limiting.

Signed-off-by: Kai Ye <yekai13@huawei.com>
---
 Documentation/ABI/testing/debugfs-hisi-hpre | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/Documentation/ABI/testing/debugfs-hisi-hpre b/Documentation/ABI/testing/debugfs-hisi-hpre
index b4be5f1db4b7..8199a754c8c4 100644
--- a/Documentation/ABI/testing/debugfs-hisi-hpre
+++ b/Documentation/ABI/testing/debugfs-hisi-hpre
@@ -27,6 +27,16 @@ 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
-- 
2.33.0

Re: [PATCH 1/3] Documentation: update debugfs doc for Hisilicon SEC

[Greg KH]

On Sat, Dec 25, 2021 at 02:27:16PM +0800, Kai Ye wrote:
> Update documentation describing DebugFS for function's QoS limiting.
> 
> Signed-off-by: Kai Ye <yekai13@huawei.com>
> ---
>  Documentation/ABI/testing/debugfs-hisi-sec | 10 ++++++++++
>  1 file changed, 10 insertions(+)
> 
> diff --git a/Documentation/ABI/testing/debugfs-hisi-sec b/Documentation/ABI/testing/debugfs-hisi-sec
> index 85feb4408e0f..9e50ceab94d2 100644
> --- a/Documentation/ABI/testing/debugfs-hisi-sec
> +++ b/Documentation/ABI/testing/debugfs-hisi-sec
> @@ -14,6 +14,16 @@ Description:    One SEC controller has one PF and multiple VFs, each function
>  		qm refers to.
>  		Only available for PF.
>  
> +What:           /sys/kernel/debug/hisi_sec2/<bdf>/alg_qos
> +Date:           Jun 2021
> +Contact:        linux-crypto@vger.kernel.org

No tabs?  Why not?

thanks,

greg k-h

Re: [PATCH 1/3] Documentation: update debugfs doc for Hisilicon SEC

[yekai(A)]

On 2021/12/26 18:45, Greg KH wrote:
> On Sat, Dec 25, 2021 at 02:27:16PM +0800, Kai Ye wrote:
>> Update documentation describing DebugFS for function's QoS limiting.
>>
>> Signed-off-by: Kai Ye <yekai13@huawei.com>
>> ---
>>  Documentation/ABI/testing/debugfs-hisi-sec | 10 ++++++++++
>>  1 file changed, 10 insertions(+)
>>
>> diff --git a/Documentation/ABI/testing/debugfs-hisi-sec b/Documentation/ABI/testing/debugfs-hisi-sec
>> index 85feb4408e0f..9e50ceab94d2 100644
>> --- a/Documentation/ABI/testing/debugfs-hisi-sec
>> +++ b/Documentation/ABI/testing/debugfs-hisi-sec
>> @@ -14,6 +14,16 @@ Description:    One SEC controller has one PF and multiple VFs, each function
>>  		qm refers to.
>>  		Only available for PF.
>>
>> +What:           /sys/kernel/debug/hisi_sec2/<bdf>/alg_qos
>> +Date:           Jun 2021
>> +Contact:        linux-crypto@vger.kernel.org
>
> No tabs?  Why not?
>
> thanks,
>
> greg k-h
> .
>

I'm read the way it was written before，
i will use the tabs on all Hisilicon Accelerator documentation.

thanks
Kai.