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>
This commit is contained in:
Bagas Sanjaya 2022-07-13 15:56:28 +07:00 committed by Herbert Xu
parent 19cdbdb7cd
commit 1b466b8cbf
1 changed files with 11 additions and 23 deletions

View File

@ -2,18 +2,14 @@ What: /sys/bus/pci/devices/<BDF>/qat/state
Date: June 2022 Date: June 2022
KernelVersion: 5.20 KernelVersion: 5.20
Contact: qat-linux@intel.com Contact: qat-linux@intel.com
Description: Reports the current state of the QAT device and allows to Description: (RW) Reports the current state of the QAT device. Write to
change it. the file to start or stop the device.
This attribute is RW. The values are:
Returned values: * up: the device is up and running
up: the device is up and running * down: the device is down
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 It is possible to transition the device from up to down only
if the device is up and vice versa. if the device is up and vice versa.
@ -24,22 +20,14 @@ What: /sys/bus/pci/devices/<BDF>/qat/cfg_services
Date: June 2022 Date: June 2022
KernelVersion: 5.20 KernelVersion: 5.20
Contact: qat-linux@intel.com Contact: qat-linux@intel.com
Description: Reports the current configuration of the QAT device and allows Description: (RW) Reports the current configuration of the QAT device.
to change it. 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
sym;asym: the device is configured for running services
crypto services * dc: the device is configured for running compression 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
It is possible to set the configuration only if the device It is possible to set the configuration only if the device
is in the `down` state (see /sys/bus/pci/devices/<BDF>/qat/state) is in the `down` state (see /sys/bus/pci/devices/<BDF>/qat/state)