Documentation: qat: rewrite description

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>
Signed-off-by: Herbert Xu <herbert@gondor.apana.org.au>

diff --git a/Documentation/ABI/testing/sysfs-driver-qat b/Documentation/ABI/testing/sysfs-driver-qat
index 43e081ec22cc4ab58b66d98c9d73e0d66a8e2fb3..185f81a2aab3603c0822fb8bebce46dbe53f97b6 100644 (file)
--- 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.
-
-               This attribute is RW.
-
-               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
+Description:   (RW) Reports the current configuration of the QAT device.
+               Write to the file to change the configured services.
+
+               The values are:
+
+               * 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)