From: Bagas Sanjaya <bagasdotme@gmail.com>
To: linux-doc@vger.kernel.org, linux-next@vger.kernel.org
Cc: Bagas Sanjaya <bagasdotme@gmail.com>,
Giovanni Cabiddu <giovanni.cabiddu@intel.com>,
Adam Guerin <adam.guerin@intel.com>,
Tomasz Kowallik <tomaszx.kowalik@intel.com>,
Wojciech Ziemba <wojciech.ziemba@intel.com>,
Fiona Trahe <fiona.trahe@intel.com>,
linux-crypto@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [PATCH 2/2] Documentation: qat: rewrite description
Date: Wed, 13 Jul 2022 10:03:33 +0700 [thread overview]
Message-ID: <20220713030332.158525-3-bagasdotme@gmail.com> (raw)
In-Reply-To: <20220713030332.158525-1-bagasdotme@gmail.com>
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
next prev parent reply other threads:[~2022-07-13 3:04 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
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 [this message]
2022-07-13 8:48 ` [PATCH 0/2] Documentation: qat: documentation fixes Bagas Sanjaya
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20220713030332.158525-3-bagasdotme@gmail.com \
--to=bagasdotme@gmail.com \
--cc=adam.guerin@intel.com \
--cc=fiona.trahe@intel.com \
--cc=giovanni.cabiddu@intel.com \
--cc=linux-crypto@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-next@vger.kernel.org \
--cc=tomaszx.kowalik@intel.com \
--cc=wojciech.ziemba@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).