Documentation: qat: documentation fixes
Subsystems (3)
v2 cover Documentation: qat: documentation fixes
Here are documentation fixes for qat driver, as recently reported in linux-next. This is resend of [1], due to missing v2 subject prefix. Sorry for noise.
Changes since v1 [2]:
- based on next-20220712
- Drop kvms390 (already applied by respective maintainer)
- Focused on qat driver
- Drop "initialize" from [2/2]
- Collect Acked-by from Giovanni Cabiddu
[1]: https://lore.kernel.org/linux-doc/[email protected]/
[2]: https://lore.kernel.org/linux-doc/[email protected]/
Bagas Sanjaya (2):
Documentation: qat: Use code block for qat sysfs example
Documentation: qat: rewrite description
Documentation/ABI/testing/sysfs-driver-qat | 37 ++++++++-------------- 1 file changed, 13 insertions(+), 24 deletions(-)
Signature · 1 line
An old man doll... just what I always wanted! - Clara
PATCH RESEND v2 1/2 Documentation: qat: Use code block for qat sysfs example
kernel test robot and Stephen Rothwell reported htmldocs warning:
Documentation/ABI/testing/sysfs-driver-qat:24: WARNING: Unexpected indentation.
The warning isn't caused by Date: field pointed by the warning, but rather by sysfs example that isn't in literal code block.
Add the code block marker.
--- Documentation/ABI/testing/sysfs-driver-qat | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)
Documentation/ABI/testing/sysfs-driver-qat +2 -1
@@ -46,7 +46,8 @@ Description: Reports the current configuration of the QAT device and allows The following example shows how to change the configuration of a device configured for running crypto services in order to - run data compression: + run data compression:: + # cat /sys/bus/pci/devices/<BDF>/qat/state up # cat /sys/bus/pci/devices/<BDF>/qat/cfg_services
Signature · 1 line
An old man doll... just what I always wanted! - Clara
Re: [PATCH RESEND v2 1/2] Documentation: qat: Use code block for qat sysfs example
Hi,
Quoted 33 lines · Bagas Sanjaya
kernel test robot and Stephen Rothwell reported htmldocs warning:
Documentation/ABI/testing/sysfs-driver-qat:24: WARNING: Unexpected indentation.The warning isn't caused by Date: field pointed by the warning, but rather by sysfs example that isn't in literal code block.
Add the code block marker.
Reported-by kernel test robot <[email protected]>Reported-by Stephen Rothwell <[email protected]>Fixes d4cfb144f60551 ("crypto: qat - expose device config through sysfs for 4xxx")Acked-by Giovanni Cabiddu <[email protected]>Cc Wojciech Ziemba <[email protected]>Cc Adam Guerin <[email protected]>Cc Fiona Trahe <[email protected]>Cc Herbert Xu <[email protected]>Cc Vladis Dronov <[email protected]>Cc Tomasz Kowallik <[email protected]>Signed-off-by Bagas Sanjaya <[email protected]>--- Documentation/ABI/testing/sysfs-driver-qat | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)Documentation/ABI/testing/sysfs-driver-qat +0
-0
Documentation/ABI/testing/sysfs-driver-qat Description: Reports the current configuration of the QAT device and allows
Quoted 10 lines
Documentation/ABI/testing/sysfs-driver-qat +2
-2@@ -46,7 +46,8 @@ Description: Reports the current configuration of the QAT device and allows The following example shows how to change the configuration of a device configured for running crypto services in order to - run data compression: + run data compression:: + # cat /sys/bus/pci/devices/<BDF>/qat/state up # cat /sys/bus/pci/devices/<BDF>/qat/cfg_services --
Best regards,
Vladis Dronov | Red Hat, Inc. | The Core Kernel | Senior Software Engineer
Herbert Xu
maintainerRe: [PATCH RESEND v2 1/2] Documentation: qat: Use code block for qat sysfs example
In reply to Bagas SanjayaQuoted 24 lines · Bagas Sanjaya
kernel test robot and Stephen Rothwell reported htmldocs warning:
Documentation/ABI/testing/sysfs-driver-qat:24: WARNING: Unexpected indentation.The warning isn't caused by Date: field pointed by the warning, but rather by sysfs example that isn't in literal code block.
Add the code block marker.
Reported-by kernel test robot <[email protected]>Reported-by Stephen Rothwell <[email protected]>Fixes d4cfb144f60551 ("crypto: qat - expose device config through sysfs for 4xxx")Acked-by Giovanni Cabiddu <[email protected]>Cc Wojciech Ziemba <[email protected]>Cc Adam Guerin <[email protected]>Cc Fiona Trahe <[email protected]>Cc Herbert Xu <[email protected]>Cc Vladis Dronov <[email protected]>Cc Tomasz Kowallik <[email protected]>Signed-off-by Bagas Sanjaya <[email protected]>
Quoted 3 lines
--- Documentation/ABI/testing/sysfs-driver-qat | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)
All applied. Thanks.
Signature · 3 lines
Email: Herbert Xu <[email protected]> Home Page: http://gondor.apana.org.au/~herbert/ PGP Key: http://gondor.apana.org.au/~herbert/pubkey.txt
PATCH RESEND v2 2/2 Documentation: qat: rewrite description
In reply to Bagas SanjayaThe sysfs description contains redundancy on returned and allowed values list, due to the described sysfs is read-write. Rewrite.
--- Documentation/ABI/testing/sysfs-driver-qat | 34 +++++++--------------- 1 file changed, 11 insertions(+), 23 deletions(-)
Documentation/ABI/testing/sysfs-driver-qat +11 -23
@@ -2,18 +2,14 @@ What: /sys/bus/pci/devices/<BDF>/qat/state Date: June 2022 KernelVersion: 5.20 Contact: [email protected] -Description: Reports the current state of the QAT device and allows to - change it. +Description: (RW) Reports the current state of the QAT device. Write to + the file to start or stop the device. - This attribute is RW. + The values are: - Returned values: - up: the device is up and running - down: the device is down + * up: the device is up and running + * down: the device is down - Allowed values: - up: initialize and start the device - down: stop the device and bring it down It is possible to transition the device from up to down only if the device is up and vice versa.
@@ -24,22 +20,14 @@ What: /sys/bus/pci/devices/<BDF>/qat/cfg_services Date: June 2022 KernelVersion: 5.20 Contact: [email protected] -Description: Reports the current configuration of the QAT device and allows - to change it. +Description: (RW) Reports the current configuration of the QAT device. + Write to the file to change the configured services. - This attribute is RW. + The values are: - Returned values: - sym;asym: the device is configured for running - crypto services - dc: the device is configured for running - compression services - - Allowed values: - sym;asym: configure the device for running - crypto services - dc: configure the device for running - compression services + * sym;asym: the device is configured for running crypto + services + * dc: the device is configured for running compression services It is possible to set the configuration only if the device is in the `down` state (see /sys/bus/pci/devices/<BDF>/qat/state)
Signature · 1 line
An old man doll... just what I always wanted! - Clara