| Message ID | 20220712092954.142027-3-bagasdotme@gmail.com (mailing list archive) |
|---|---|
| State | Superseded |
| Delegated to: | Herbert Xu |
| Headers | show |
| Series | miscellaneous documentation fixes for linux-next | expand |
On Tue, Jul 12, 2022 at 04:29:53PM +0700, Bagas Sanjaya wrote: > The sysfs description contains redundancy on returned and allowed values > list, due to the described sysfs is read-write. Rewrite. > > 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> Acked-by: Giovanni Cabiddu <giovanni.cabiddu@intel.com>
On Tue, Jul 12, 2022 at 04:29:53PM +0700, Bagas Sanjaya wrote: > The sysfs description contains redundancy on returned and allowed values > list, due to the described sysfs is read-write. Rewrite. > > 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..be6c200abd783c 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 initalize and start the device or to stop it. ^^^^^^^^^ Typo: initalize. It is possible just to say: "Write to the file to start or stop the device". Regards,
diff --git a/Documentation/ABI/testing/sysfs-driver-qat b/Documentation/ABI/testing/sysfs-driver-qat index 43e081ec22cc4a..be6c200abd783c 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 initalize and start the device or to stop it. - 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)
The sysfs description contains redundancy on returned and allowed values list, due to the described sysfs is read-write. Rewrite. 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(-)