xref: /linux/Documentation/ABI/testing/sysfs-driver-qat (revision 8d2b0853add1d7534dc0794e3c8e0b9e8c4ec640)
1What:		/sys/bus/pci/devices/<BDF>/qat/state
2Date:		June 2022
3KernelVersion:	6.0
4Contact:	qat-linux@intel.com
5Description:	(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 available for qat_4xxx and qat_6xxx devices.
18
19What:		/sys/bus/pci/devices/<BDF>/qat/cfg_services
20Date:		June 2022
21KernelVersion:	6.0
22Contact:	qat-linux@intel.com
23Description:	(RW) Reports the current configuration of the QAT device.
24		Write to the file to change the configured services.
25
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.
30
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.
48
49		It is possible to set the configuration only if the device
50		is in the `down` state (see /sys/bus/pci/devices/<BDF>/qat/state)
51
52		The following example shows how to change the configuration of
53		a device configured for running crypto services in order to
54		run data compression::
55
56			# cat /sys/bus/pci/devices/<BDF>/qat/state
57			up
58			# cat /sys/bus/pci/devices/<BDF>/qat/cfg_services
59			sym;asym
60			# echo down > /sys/bus/pci/devices/<BDF>/qat/state
61			# echo dc > /sys/bus/pci/devices/<BDF>/qat/cfg_services
62			# echo up > /sys/bus/pci/devices/<BDF>/qat/state
63			# cat /sys/bus/pci/devices/<BDF>/qat/cfg_services
64			dc
65
66		This attribute is available for qat_4xxx and qat_6xxx devices.
67
68What:		/sys/bus/pci/devices/<BDF>/qat/pm_idle_enabled
69Date:		June 2023
70KernelVersion:	6.5
71Contact:	qat-linux@intel.com
72Description:	(RW) This configuration option provides a way to force the device into remaining in
73		the MAX power state.
74		If idle support is enabled the device will transition to the `MIN` power state when
75		idle, otherwise will stay in the MAX power state.
76		Write to the file to enable or disable idle support.
77
78		The values are:
79
80		* 0: idle support is disabled
81		* 1: idle support is enabled
82
83		Default value is 1.
84
85		It is possible to set the pm_idle_enabled value only if the device
86		is in the `down` state (see /sys/bus/pci/devices/<BDF>/qat/state)
87
88		The following example shows how to change the pm_idle_enabled of
89		a device::
90
91			# cat /sys/bus/pci/devices/<BDF>/qat/state
92			up
93			# cat /sys/bus/pci/devices/<BDF>/qat/pm_idle_enabled
94			1
95			# echo down > /sys/bus/pci/devices/<BDF>/qat/state
96			# echo 0 > /sys/bus/pci/devices/<BDF>/qat/pm_idle_enabled
97			# echo up > /sys/bus/pci/devices/<BDF>/qat/state
98			# cat /sys/bus/pci/devices/<BDF>/qat/pm_idle_enabled
99			0
100
101		This attribute is available for qat_4xxx and qat_6xxx devices.
102
103What:		/sys/bus/pci/devices/<BDF>/qat/rp2srv
104Date:		January 2024
105KernelVersion:	6.7
106Contact:	qat-linux@intel.com
107Description:
108		(RW) This attribute provides a way for a user to query a
109		specific ring pair for the type of service that it is currently
110		configured for.
111
112		When written to, the value is cached and used to perform the
113		read operation. Allowed values are in the range 0 to N-1, where
114		N is the max number of ring pairs supported by a device. This
115		can be queried using the attribute qat/num_rps.
116
117		A read returns the service associated to the ring pair queried.
118
119		The values are:
120
121		* dc: the ring pair is configured for running compression services
122		* sym: the ring pair is configured for running symmetric crypto
123		  services
124		* asym: the ring pair is configured for running asymmetric crypto
125		  services
126
127		Example usage::
128
129			# echo 1 > /sys/bus/pci/devices/<BDF>/qat/rp2srv
130			# cat /sys/bus/pci/devices/<BDF>/qat/rp2srv
131			sym
132
133		This attribute is available for qat_4xxx and qat_6xxx devices.
134
135What:		/sys/bus/pci/devices/<BDF>/qat/num_rps
136Date:		January 2024
137KernelVersion:	6.7
138Contact:	qat-linux@intel.com
139Description:
140		(RO) Returns the number of ring pairs that a single device has.
141
142		Example usage::
143
144			# cat /sys/bus/pci/devices/<BDF>/qat/num_rps
145			64
146
147		This attribute is available for qat_4xxx and qat_6xxx devices.
148
149What:		/sys/bus/pci/devices/<BDF>/qat/auto_reset
150Date:		May 2024
151KernelVersion:	6.9
152Contact:	qat-linux@intel.com
153Description:	(RW) Reports the current state of the autoreset feature
154		for a QAT device
155
156		Write to the attribute to enable or disable device auto reset.
157
158		Device auto reset is disabled by default.
159
160		The values are:
161
162		* 1/Yy/on: auto reset enabled. If the device encounters an
163		  unrecoverable error, it will be reset automatically.
164		* 0/Nn/off: auto reset disabled. If the device encounters an
165		  unrecoverable error, it will not be reset.
166
167		This attribute is available for qat_4xxx and qat_6xxx devices.
168