GNU Linux-libre 6.1.90-gnu
[releases.git] / Documentation / ABI / testing / sysfs-driver-qat
1 What:           /sys/bus/pci/devices/<BDF>/qat/state
2 Date:           June 2022
3 KernelVersion:  5.20
4 Contact:        qat-linux@intel.com
5 Description:    (RW) Reports the current state of the QAT device. Write to
6                 the file to start or stop the device.
7
8                 The values are:
9
10                 * up: the device is up and running
11                 * down: the device is down
12
13
14                 It is possible to transition the device from up to down only
15                 if the device is up and vice versa.
16
17                 This attribute is only available for qat_4xxx devices.
18
19 What:           /sys/bus/pci/devices/<BDF>/qat/cfg_services
20 Date:           June 2022
21 KernelVersion:  5.20
22 Contact:        qat-linux@intel.com
23 Description:    (RW) Reports the current configuration of the QAT device.
24                 Write to the file to change the configured services.
25
26                 The values are:
27
28                 * sym;asym: the device is configured for running crypto
29                   services
30                 * dc: the device is configured for running compression services
31
32                 It is possible to set the configuration only if the device
33                 is in the `down` state (see /sys/bus/pci/devices/<BDF>/qat/state)
34
35                 The following example shows how to change the configuration of
36                 a device configured for running crypto services in order to
37                 run data compression::
38
39                         # cat /sys/bus/pci/devices/<BDF>/qat/state
40                         up
41                         # cat /sys/bus/pci/devices/<BDF>/qat/cfg_services
42                         sym;asym
43                         # echo down > /sys/bus/pci/devices/<BDF>/qat/state
44                         # echo dc > /sys/bus/pci/devices/<BDF>/qat/cfg_services
45                         # echo up > /sys/bus/pci/devices/<BDF>/qat/state
46                         # cat /sys/bus/pci/devices/<BDF>/qat/cfg_services
47                         dc
48
49                 This attribute is only available for qat_4xxx devices.