* [PATCH 0/2] Documentation: qat: documentation fixes
@ 2022-07-13 3:03 Bagas Sanjaya
2022-07-13 3:03 ` [PATCH 1/2] Documentation: qat: Use code block for qat sysfs example Bagas Sanjaya
` (2 more replies)
0 siblings, 3 replies; 4+ messages in thread
From: Bagas Sanjaya @ 2022-07-13 3:03 UTC (permalink / raw)
To: linux-doc, linux-next; +Cc: Bagas Sanjaya, linux-kernel, linux-crypto
Here are documentation fixes for qat driver, as recently reported in
linux-next.
Changes since v1 [1]:
- 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/20220712092954.142027-1-bagasdotme@gmail.com/
Cc: linux-kernel@vger.kernel.org
Cc: linux-crypto@vger.kernel.org
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(-)
--
An old man doll... just what I always wanted! - Clara
^ permalink raw reply [flat|nested] 4+ messages in thread
* [PATCH 1/2] Documentation: qat: Use code block for qat sysfs example
2022-07-13 3:03 [PATCH 0/2] Documentation: qat: documentation fixes Bagas Sanjaya
@ 2022-07-13 3:03 ` Bagas Sanjaya
2022-07-13 3:03 ` [PATCH 2/2] Documentation: qat: rewrite description Bagas Sanjaya
2022-07-13 8:48 ` [PATCH 0/2] Documentation: qat: documentation fixes Bagas Sanjaya
2 siblings, 0 replies; 4+ messages in thread
From: Bagas Sanjaya @ 2022-07-13 3:03 UTC (permalink / raw)
To: linux-doc, linux-next
Cc: Bagas Sanjaya, kernel test robot, Stephen Rothwell,
Giovanni Cabiddu, Wojciech Ziemba, Adam Guerin, Fiona Trahe,
Herbert Xu, Vladis Dronov, Tomasz Kowallik, linux-crypto,
linux-kernel
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.
Link: https://lore.kernel.org/linux-next/20220711204932.333379b4@canb.auug.org.au/
Link: https://lore.kernel.org/linux-doc/202207090803.TEGI95qw-lkp@intel.com/
Reported-by: kernel test robot <lkp@intel.com>
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Fixes: d4cfb144f60551 ("crypto: qat - expose device config through sysfs for 4xxx")
Acked-by: Giovanni Cabiddu <giovanni.cabiddu@intel.com>
Cc: Wojciech Ziemba <wojciech.ziemba@intel.com>
Cc: Adam Guerin <adam.guerin@intel.com>
Cc: Fiona Trahe <fiona.trahe@intel.com>
Cc: Herbert Xu <herbert@gondor.apana.org.au>
Cc: Vladis Dronov <vdronov@redhat.com>
Cc: Tomasz Kowallik <tomaszx.kowalik@intel.com>
Cc: linux-crypto@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
Documentation/ABI/testing/sysfs-driver-qat | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/Documentation/ABI/testing/sysfs-driver-qat b/Documentation/ABI/testing/sysfs-driver-qat
index a600531e95628f..43e081ec22cc4a 100644
--- a/Documentation/ABI/testing/sysfs-driver-qat
+++ b/Documentation/ABI/testing/sysfs-driver-qat
@@ -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
--
An old man doll... just what I always wanted! - Clara
^ permalink raw reply related [flat|nested] 4+ messages in thread
* [PATCH 2/2] Documentation: qat: rewrite description
2022-07-13 3:03 [PATCH 0/2] Documentation: qat: documentation fixes Bagas Sanjaya
2022-07-13 3:03 ` [PATCH 1/2] Documentation: qat: Use code block for qat sysfs example Bagas Sanjaya
@ 2022-07-13 3:03 ` Bagas Sanjaya
2022-07-13 8:48 ` [PATCH 0/2] Documentation: qat: documentation fixes Bagas Sanjaya
2 siblings, 0 replies; 4+ messages in thread
From: Bagas Sanjaya @ 2022-07-13 3:03 UTC (permalink / raw)
To: linux-doc, linux-next
Cc: Bagas Sanjaya, Giovanni Cabiddu, Adam Guerin, Tomasz Kowallik,
Wojciech Ziemba, Fiona Trahe, linux-crypto, linux-kernel
The sysfs description contains redundancy on returned and allowed values
list, due to the described sysfs is read-write. Rewrite.
Acked-by: Giovanni Cabiddu <giovanni.cabiddu@intel.com>
Cc: Adam Guerin <adam.guerin@intel.com>
Cc: Tomasz Kowallik <tomaszx.kowalik@intel.com>
Cc: Giovanni Cabiddu <giovanni.cabiddu@intel.com>
Cc: Wojciech Ziemba <wojciech.ziemba@intel.com>
Cc: Fiona Trahe <fiona.trahe@intel.com>
Cc: linux-crypto@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
Documentation/ABI/testing/sysfs-driver-qat | 34 +++++++---------------
1 file changed, 11 insertions(+), 23 deletions(-)
diff --git a/Documentation/ABI/testing/sysfs-driver-qat b/Documentation/ABI/testing/sysfs-driver-qat
index 43e081ec22cc4a..185f81a2aab360 100644
--- a/Documentation/ABI/testing/sysfs-driver-qat
+++ b/Documentation/ABI/testing/sysfs-driver-qat
@@ -2,18 +2,14 @@ What: /sys/bus/pci/devices/<BDF>/qat/state
Date: June 2022
KernelVersion: 5.20
Contact: qat-linux@intel.com
-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: qat-linux@intel.com
-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)
--
An old man doll... just what I always wanted! - Clara
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH 0/2] Documentation: qat: documentation fixes
2022-07-13 3:03 [PATCH 0/2] Documentation: qat: documentation fixes Bagas Sanjaya
2022-07-13 3:03 ` [PATCH 1/2] Documentation: qat: Use code block for qat sysfs example Bagas Sanjaya
2022-07-13 3:03 ` [PATCH 2/2] Documentation: qat: rewrite description Bagas Sanjaya
@ 2022-07-13 8:48 ` Bagas Sanjaya
2 siblings, 0 replies; 4+ messages in thread
From: Bagas Sanjaya @ 2022-07-13 8:48 UTC (permalink / raw)
To: linux-doc, linux-next; +Cc: linux-kernel, linux-crypto
On Wed, Jul 13, 2022 at 10:03:31AM +0700, Bagas Sanjaya wrote:
> Here are documentation fixes for qat driver, as recently reported in
> linux-next.
>
> Changes since v1 [1]:
> - 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/20220712092954.142027-1-bagasdotme@gmail.com/
>
> Cc: linux-kernel@vger.kernel.org
> Cc: linux-crypto@vger.kernel.org
>
Oops, missing v2 subject prefix. Will resend.
--
An old man doll... just what I always wanted! - Clara
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2022-07-13 8:49 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-07-13 3:03 [PATCH 0/2] Documentation: qat: documentation fixes Bagas Sanjaya
2022-07-13 3:03 ` [PATCH 1/2] Documentation: qat: Use code block for qat sysfs example Bagas Sanjaya
2022-07-13 3:03 ` [PATCH 2/2] Documentation: qat: rewrite description Bagas Sanjaya
2022-07-13 8:48 ` [PATCH 0/2] Documentation: qat: documentation fixes Bagas Sanjaya
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).