1 What: /sys/bus/pci/devices/<BDF>/qat 1 What: /sys/bus/pci/devices/<BDF>/qat/state
2 Date: June 2022 2 Date: June 2022
3 KernelVersion: 6.0 3 KernelVersion: 6.0
4 Contact: qat-linux@intel.com 4 Contact: qat-linux@intel.com
5 Description: (RW) Reports the current state 5 Description: (RW) Reports the current state of the QAT device. Write to
6 the file to start or stop the 6 the file to start or stop the device.
7 7
8 The values are: 8 The values are:
9 9
10 * up: the device is up and run 10 * up: the device is up and running
11 * down: the device is down 11 * down: the device is down
12 12
13 13
14 It is possible to transition t 14 It is possible to transition the device from up to down only
15 if the device is up and vice v 15 if the device is up and vice versa.
16 16
17 This attribute is only availab 17 This attribute is only available for qat_4xxx devices.
18 18
19 What: /sys/bus/pci/devices/<BDF>/qat 19 What: /sys/bus/pci/devices/<BDF>/qat/cfg_services
20 Date: June 2022 20 Date: June 2022
21 KernelVersion: 6.0 21 KernelVersion: 6.0
22 Contact: qat-linux@intel.com 22 Contact: qat-linux@intel.com
23 Description: (RW) Reports the current confi 23 Description: (RW) Reports the current configuration of the QAT device.
24 Write to the file to change th 24 Write to the file to change the configured services.
25 25
26 The values are: 26 The values are:
27 27
28 * sym;asym: the device is conf 28 * sym;asym: the device is configured for running crypto
29 services 29 services
30 * asym;sym: identical to sym;a 30 * asym;sym: identical to sym;asym
31 * dc: the device is configured 31 * dc: the device is configured for running compression services
32 * dcc: identical to dc but ena 32 * dcc: identical to dc but enables the dc chaining feature,
33 hash then compression. If th 33 hash then compression. If this is not required chose dc
34 * sym: the device is configure 34 * sym: the device is configured for running symmetric crypto
35 services 35 services
36 * asym: the device is configur 36 * asym: the device is configured for running asymmetric crypto
37 services 37 services
38 * asym;dc: the device is confi 38 * asym;dc: the device is configured for running asymmetric
39 crypto services and compress 39 crypto services and compression services
40 * dc;asym: identical to asym;d 40 * dc;asym: identical to asym;dc
41 * sym;dc: the device is config 41 * sym;dc: the device is configured for running symmetric crypto
42 services and compression ser 42 services and compression services
43 * dc;sym: identical to sym;dc 43 * dc;sym: identical to sym;dc
44 44
45 It is possible to set the conf 45 It is possible to set the configuration only if the device
46 is in the `down` state (see /s 46 is in the `down` state (see /sys/bus/pci/devices/<BDF>/qat/state)
47 47
48 The following example shows ho 48 The following example shows how to change the configuration of
49 a device configured for runnin 49 a device configured for running crypto services in order to
50 run data compression:: 50 run data compression::
51 51
52 # cat /sys/bus/pci/dev 52 # cat /sys/bus/pci/devices/<BDF>/qat/state
53 up 53 up
54 # cat /sys/bus/pci/dev 54 # cat /sys/bus/pci/devices/<BDF>/qat/cfg_services
55 sym;asym 55 sym;asym
56 # echo down > /sys/bus 56 # echo down > /sys/bus/pci/devices/<BDF>/qat/state
57 # echo dc > /sys/bus/p 57 # echo dc > /sys/bus/pci/devices/<BDF>/qat/cfg_services
58 # echo up > /sys/bus/p 58 # echo up > /sys/bus/pci/devices/<BDF>/qat/state
59 # cat /sys/bus/pci/dev 59 # cat /sys/bus/pci/devices/<BDF>/qat/cfg_services
60 dc 60 dc
61 61
62 This attribute is only availab 62 This attribute is only available for qat_4xxx devices.
63 63
64 What: /sys/bus/pci/devices/<BDF>/qat 64 What: /sys/bus/pci/devices/<BDF>/qat/pm_idle_enabled
65 Date: June 2023 65 Date: June 2023
66 KernelVersion: 6.5 66 KernelVersion: 6.5
67 Contact: qat-linux@intel.com 67 Contact: qat-linux@intel.com
68 Description: (RW) This configuration option 68 Description: (RW) This configuration option provides a way to force the device into remaining in
69 the MAX power state. 69 the MAX power state.
70 If idle support is enabled the 70 If idle support is enabled the device will transition to the `MIN` power state when
71 idle, otherwise will stay in t 71 idle, otherwise will stay in the MAX power state.
72 Write to the file to enable or 72 Write to the file to enable or disable idle support.
73 73
74 The values are: 74 The values are:
75 75
76 * 0: idle support is disabled 76 * 0: idle support is disabled
77 * 1: idle support is enabled 77 * 1: idle support is enabled
78 78
79 Default value is 1. 79 Default value is 1.
80 80
81 It is possible to set the pm_i 81 It is possible to set the pm_idle_enabled value only if the device
82 is in the `down` state (see /s 82 is in the `down` state (see /sys/bus/pci/devices/<BDF>/qat/state)
83 83
84 The following example shows ho 84 The following example shows how to change the pm_idle_enabled of
85 a device:: 85 a device::
86 86
87 # cat /sys/bus/pci/dev 87 # cat /sys/bus/pci/devices/<BDF>/qat/state
88 up 88 up
89 # cat /sys/bus/pci/dev 89 # cat /sys/bus/pci/devices/<BDF>/qat/pm_idle_enabled
90 1 90 1
91 # echo down > /sys/bus 91 # echo down > /sys/bus/pci/devices/<BDF>/qat/state
92 # echo 0 > /sys/bus/pc 92 # echo 0 > /sys/bus/pci/devices/<BDF>/qat/pm_idle_enabled
93 # echo up > /sys/bus/p 93 # echo up > /sys/bus/pci/devices/<BDF>/qat/state
94 # cat /sys/bus/pci/dev 94 # cat /sys/bus/pci/devices/<BDF>/qat/pm_idle_enabled
95 0 95 0
96 96
97 This attribute is only availab 97 This attribute is only available for qat_4xxx devices.
98 <<
99 What: /sys/bus/pci/devices/<BDF>/qat <<
100 Date: January 2024 <<
101 KernelVersion: 6.7 <<
102 Contact: qat-linux@intel.com <<
103 Description: <<
104 (RW) This attribute provides a <<
105 specific ring pair for the typ <<
106 configured for. <<
107 <<
108 When written to, the value is <<
109 read operation. Allowed values <<
110 N is the max number of ring pa <<
111 can be queried using the attri <<
112 <<
113 A read returns the service ass <<
114 <<
115 The values are: <<
116 <<
117 * dc: the ring pair is configu <<
118 * sym: the ring pair is config <<
119 services <<
120 * asym: the ring pair is confi <<
121 services <<
122 <<
123 Example usage:: <<
124 <<
125 # echo 1 > /sys/bus/pc <<
126 # cat /sys/bus/pci/dev <<
127 sym <<
128 <<
129 This attribute is only availab <<
130 <<
131 What: /sys/bus/pci/devices/<BDF>/qat <<
132 Date: January 2024 <<
133 KernelVersion: 6.7 <<
134 Contact: qat-linux@intel.com <<
135 Description: <<
136 (RO) Returns the number of rin <<
137 <<
138 Example usage:: <<
139 <<
140 # cat /sys/bus/pci/dev <<
141 64 <<
142 <<
143 This attribute is only availab <<
144 <<
145 What: /sys/bus/pci/devices/<BDF>/qat <<
146 Date: May 2024 <<
147 KernelVersion: 6.9 <<
148 Contact: qat-linux@intel.com <<
149 Description: (RW) Reports the current state <<
150 for a QAT device <<
151 <<
152 Write to the attribute to enab <<
153 <<
154 Device auto reset is disabled <<
155 <<
156 The values are: <<
157 <<
158 * 1/Yy/on: auto reset enabled. <<
159 unrecoverable error, it will <<
160 * 0/Nn/off: auto reset disable <<
161 unrecoverable error, it will <<
162 <<
163 This attribute is only availab <<
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.