Documentation/ABI/testing/sysfs-driver-qat

Source file repositories/reference/linux-study-clean/Documentation/ABI/testing/sysfs-driver-qat

File Facts

System
Linux kernel
Corpus path
Documentation/ABI/testing/sysfs-driver-qat
Extension
[no extension]
Size
5668 bytes
Lines
168
Domain
Support Tooling And Documentation
Bucket
Documentation
Inferred role
Support Tooling And Documentation: Documentation
Status
atlas-only

Why This File Exists

Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.

Dependency Surface

Detected Declarations

Annotated Snippet

What:		/sys/bus/pci/devices/<BDF>/qat/state
Date:		June 2022
KernelVersion:	6.0
Contact:	qat-linux@intel.com
Description:	(RW) Reports the current state of the QAT device. Write to
		the file to start or stop the device.

		The values are:

		* up: the device is up and running
		* down: the device is down


		It is possible to transition the device from up to down only
		if the device is up and vice versa.

		This attribute is available for qat_4xxx and qat_6xxx devices.

What:		/sys/bus/pci/devices/<BDF>/qat/cfg_services
Date:		June 2022
KernelVersion:	6.0
Contact:	qat-linux@intel.com
Description:	(RW) Reports the current configuration of the QAT device.
		Write to the file to change the configured services.

		One or more services can be enabled per device.
		Certain configurations are restricted to specific device types;
		where applicable this is explicitly indicated, for example
		(qat_6xxx) denotes applicability exclusively to that device series.

		The available services include:

		* sym: Configures the device for symmetric cryptographic operations.
		* asym: Configures the device for asymmetric cryptographic operations.
		* dc: Configures the device for compression and decompression
		  operations.
		* dcc: Similar to dc, but with the additional dc chaining feature
		  enabled, cipher then compress (qat_6xxx), hash then compression.
		  If this is not required choose dc.
		* decomp: Configures the device for decompression operations (qat_6xxx).

		Service combinations are permitted for all services except dcc.
		On QAT GEN4 devices (qat_4xxx driver) a maximum of two services can be
		combined and on QAT GEN6 devices (qat_6xxx driver ) a maximum of three
		services can be combined.
		The order of services is not significant. For instance, sym;asym is
		functionally equivalent to asym;sym.

		It is possible to set the configuration only if the device
		is in the `down` state (see /sys/bus/pci/devices/<BDF>/qat/state)

		The following example shows how to change the configuration of
		a device configured for running crypto services in order to
		run data compression::

			# cat /sys/bus/pci/devices/<BDF>/qat/state
			up
			# cat /sys/bus/pci/devices/<BDF>/qat/cfg_services
			sym;asym
			# echo down > /sys/bus/pci/devices/<BDF>/qat/state
			# echo dc > /sys/bus/pci/devices/<BDF>/qat/cfg_services
			# echo up > /sys/bus/pci/devices/<BDF>/qat/state
			# cat /sys/bus/pci/devices/<BDF>/qat/cfg_services
			dc

		This attribute is available for qat_4xxx and qat_6xxx devices.

What:		/sys/bus/pci/devices/<BDF>/qat/pm_idle_enabled
Date:		June 2023
KernelVersion:	6.5

Annotation

Implementation Notes