tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

Documentation: qat: update sysfs-driver-qat for GEN6 devices

Reorganize and expand documentation for service configurations. This
reworks the `cfg_services` section by removing explicit service
combinations (e.g., asym;sym, sym;asym) and clarifying that multiple
services can be configured in any order.

Update the documentation to reflect that the attribute previously limited
to qat_4xxx devices is also applicable to qat_6xxx devices.

Signed-off-by: Suman Kumar Chakraborty <suman.kumar.chakraborty@intel.com>
Reviewed-by: Giovanni Cabiddu <giovanni.cabiddu@intel.com>
Reviewed-by: Fiona Trahe <fiona.trahe@intel.com>
Signed-off-by: Herbert Xu <herbert@gondor.apana.org.au>

authored by

Suman Kumar Chakraborty and committed by
Herbert Xu 10294362 8f2e1a3c

+27 -23
+27 -23
Documentation/ABI/testing/sysfs-driver-qat
··· 14 14 It is possible to transition the device from up to down only 15 15 if the device is up and vice versa. 16 16 17 - This attribute is only available for qat_4xxx devices. 17 + This attribute is available for qat_4xxx and qat_6xxx devices. 18 18 19 19 What: /sys/bus/pci/devices/<BDF>/qat/cfg_services 20 20 Date: June 2022 ··· 23 23 Description: (RW) Reports the current configuration of the QAT device. 24 24 Write to the file to change the configured services. 25 25 26 - The values are: 26 + One or more services can be enabled per device. 27 + Certain configurations are restricted to specific device types; 28 + where applicable this is explicitly indicated, for example 29 + (qat_6xxx) denotes applicability exclusively to that device series. 27 30 28 - * sym;asym: the device is configured for running crypto 29 - services 30 - * asym;sym: identical to sym;asym 31 - * dc: the device is configured for running compression services 32 - * dcc: identical to dc but enables the dc chaining feature, 33 - hash then compression. If this is not required chose dc 34 - * sym: the device is configured for running symmetric crypto 35 - services 36 - * asym: the device is configured for running asymmetric crypto 37 - services 38 - * asym;dc: the device is configured for running asymmetric 39 - crypto services and compression services 40 - * dc;asym: identical to asym;dc 41 - * sym;dc: the device is configured for running symmetric crypto 42 - services and compression services 43 - * dc;sym: identical to sym;dc 31 + The available services include: 32 + 33 + * sym: Configures the device for symmetric cryptographic operations. 34 + * asym: Configures the device for asymmetric cryptographic operations. 35 + * dc: Configures the device for compression and decompression 36 + operations. 37 + * dcc: Similar to dc, but with the additional dc chaining feature 38 + enabled, cipher then compress (qat_6xxx), hash then compression. 39 + If this is not required choose dc. 40 + * decomp: Configures the device for decompression operations (qat_6xxx). 41 + 42 + Service combinations are permitted for all services except dcc. 43 + On QAT GEN4 devices (qat_4xxx driver) a maximum of two services can be 44 + combined and on QAT GEN6 devices (qat_6xxx driver ) a maximum of three 45 + services can be combined. 46 + The order of services is not significant. For instance, sym;asym is 47 + functionally equivalent to asym;sym. 44 48 45 49 It is possible to set the configuration only if the device 46 50 is in the `down` state (see /sys/bus/pci/devices/<BDF>/qat/state) ··· 63 59 # cat /sys/bus/pci/devices/<BDF>/qat/cfg_services 64 60 dc 65 61 66 - This attribute is only available for qat_4xxx devices. 62 + This attribute is available for qat_4xxx and qat_6xxx devices. 67 63 68 64 What: /sys/bus/pci/devices/<BDF>/qat/pm_idle_enabled 69 65 Date: June 2023 ··· 98 94 # cat /sys/bus/pci/devices/<BDF>/qat/pm_idle_enabled 99 95 0 100 96 101 - This attribute is only available for qat_4xxx devices. 97 + This attribute is available for qat_4xxx and qat_6xxx devices. 102 98 103 99 What: /sys/bus/pci/devices/<BDF>/qat/rp2srv 104 100 Date: January 2024 ··· 130 126 # cat /sys/bus/pci/devices/<BDF>/qat/rp2srv 131 127 sym 132 128 133 - This attribute is only available for qat_4xxx devices. 129 + This attribute is available for qat_4xxx and qat_6xxx devices. 134 130 135 131 What: /sys/bus/pci/devices/<BDF>/qat/num_rps 136 132 Date: January 2024 ··· 144 140 # cat /sys/bus/pci/devices/<BDF>/qat/num_rps 145 141 64 146 142 147 - This attribute is only available for qat_4xxx devices. 143 + This attribute is available for qat_4xxx and qat_6xxx devices. 148 144 149 145 What: /sys/bus/pci/devices/<BDF>/qat/auto_reset 150 146 Date: May 2024 ··· 164 160 * 0/Nn/off: auto reset disabled. If the device encounters an 165 161 unrecoverable error, it will not be reset. 166 162 167 - This attribute is only available for qat_4xxx devices. 163 + This attribute is available for qat_4xxx and qat_6xxx devices.