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 only available for qat_4xxx 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		The values are:
27
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
44
45		It is possible to set the configuration only if the device
46		is in the `down` state (see /sys/bus/pci/devices/<BDF>/qat/state)
47
48		The following example shows how to change the configuration of
49		a device configured for running crypto services in order to
50		run data compression::
51
52			# cat /sys/bus/pci/devices/<BDF>/qat/state
53			up
54			# cat /sys/bus/pci/devices/<BDF>/qat/cfg_services
55			sym;asym
56			# echo down > /sys/bus/pci/devices/<BDF>/qat/state
57			# echo dc > /sys/bus/pci/devices/<BDF>/qat/cfg_services
58			# echo up > /sys/bus/pci/devices/<BDF>/qat/state
59			# cat /sys/bus/pci/devices/<BDF>/qat/cfg_services
60			dc
61
62		This attribute is only available for qat_4xxx devices.
63
64What:		/sys/bus/pci/devices/<BDF>/qat/pm_idle_enabled
65Date:		June 2023
66KernelVersion:	6.5
67Contact:	qat-linux@intel.com
68Description:	(RW) This configuration option provides a way to force the device into remaining in
69		the MAX power state.
70		If idle support is enabled the device will transition to the `MIN` power state when
71		idle, otherwise will stay in the MAX power state.
72		Write to the file to enable or disable idle support.
73
74		The values are:
75
76		* 0: idle support is disabled
77		* 1: idle support is enabled
78
79		Default value is 1.
80
81		It is possible to set the pm_idle_enabled value only if the device
82		is in the `down` state (see /sys/bus/pci/devices/<BDF>/qat/state)
83
84		The following example shows how to change the pm_idle_enabled of
85		a device::
86
87			# cat /sys/bus/pci/devices/<BDF>/qat/state
88			up
89			# cat /sys/bus/pci/devices/<BDF>/qat/pm_idle_enabled
90			1
91			# echo down > /sys/bus/pci/devices/<BDF>/qat/state
92			# echo 0 > /sys/bus/pci/devices/<BDF>/qat/pm_idle_enabled
93			# echo up > /sys/bus/pci/devices/<BDF>/qat/state
94			# cat /sys/bus/pci/devices/<BDF>/qat/pm_idle_enabled
95			0
96
97		This attribute is only available for qat_4xxx devices.
98