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