debugfs-driver-qat

  1What:		/sys/kernel/debug/qat_<device>_<BDF>/fw_counters
  2Date:		November 2023
  3KernelVersion:	6.6
  4Contact:	qat-linux@intel.com
  5Description:	(RO) Read returns the number of requests sent to the FW and the number of responses
  6		received from the FW for each Acceleration Engine
  7		Reported firmware counters::
  8
  9			<N>: Number of requests sent from Acceleration Engine N to FW and responses
 10			     Acceleration Engine N received from FW
 11
 12What:		/sys/kernel/debug/qat_<device>_<BDF>/heartbeat/config
 13Date:		November 2023
 14KernelVersion:	6.6
 15Contact:	qat-linux@intel.com
 16Description:	(RW) Read returns value of the Heartbeat update period.
 17		Write to the file changes this period value.
 18
 19		This period should reflect planned polling interval of device
 20		health status. High frequency Heartbeat monitoring wastes CPU cycles
 21		but minimizes the customer’s system downtime. Also, if there are
 22		large service requests that take some time to complete, high frequency
 23		Heartbeat monitoring could result in false reports of unresponsiveness
 24		and in those cases, period needs to be increased.
 25
 26		This parameter is effective only for c3xxx, c62x, dh895xcc devices.
 27		4xxx has this value internally fixed to 200ms.
 28
 29		Default value is set to 500. Minimal allowed value is 200.
 30		All values are expressed in milliseconds.
 31
 32What:		/sys/kernel/debug/qat_<device>_<BDF>/heartbeat/queries_failed
 33Date:		November 2023
 34KernelVersion:	6.6
 35Contact:	qat-linux@intel.com
 36Description:	(RO) Read returns the number of times the device became unresponsive.
 37
 38		Attribute returns value of the counter which is incremented when
 39		status query results negative.
 40
 41What:		/sys/kernel/debug/qat_<device>_<BDF>/heartbeat/queries_sent
 42Date:		November 2023
 43KernelVersion:	6.6
 44Contact:	qat-linux@intel.com
 45Description:	(RO) Read returns the number of times the control process checked
 46		if the device is responsive.
 47
 48		Attribute returns value of the counter which is incremented on
 49		every status query.
 50
 51What:		/sys/kernel/debug/qat_<device>_<BDF>/heartbeat/status
 52Date:		November 2023
 53KernelVersion:	6.6
 54Contact:	qat-linux@intel.com
 55Description:	(RO) Read returns the device health status.
 56
 57		Returns 0 when device is healthy or -1 when is unresponsive
 58		or the query failed to send.
 59
 60		The driver does not monitor for Heartbeat. It is left for a user
 61		to poll the status periodically.
 62
 63What:		/sys/kernel/debug/qat_<device>_<BDF>/pm_status
 64Date:		January 2024
 65KernelVersion:	6.7
 66Contact:	qat-linux@intel.com
 67Description:	(RO) Read returns power management information specific to the
 68		QAT device.
 69
 70		This attribute is only available for qat_4xxx and qat_6xxx devices.
 71
 72What:		/sys/kernel/debug/qat_<device>_<BDF>/cnv_errors
 73Date:		January 2024
 74KernelVersion:	6.7
 75Contact:	qat-linux@intel.com
 76Description:	(RO) Read returns, for each Acceleration Engine (AE), the number
 77		of errors and the type of the last error detected by the device
 78		when performing verified compression.
 79		Reported counters::
 80
 81			<N>: Number of Compress and Verify (CnV) errors and type
 82			     of the last CnV error detected by Acceleration
 83			     Engine N.
 84
 85What:		/sys/kernel/debug/qat_<device>_<BDF>/heartbeat/inject_error
 86Date:		March 2024
 87KernelVersion:	6.8
 88Contact:	qat-linux@intel.com
 89Description:	(WO) Write to inject an error that simulates an heartbeat
 90		failure. This is to be used for testing purposes.
 91
 92		After writing this file, the driver stops arbitration on a
 93		random engine and disables the fetching of heartbeat counters.
 94		If a workload is running on the device, a job submitted to the
 95		accelerator might not get a response and a read of the
 96		`heartbeat/status` attribute might report -1, i.e. device
 97		unresponsive.
 98		The error is unrecoverable thus the device must be restarted to
 99		restore its functionality.
100
101		This attribute is available only when the kernel is built with
102		CONFIG_CRYPTO_DEV_QAT_ERROR_INJECTION=y.
103
104		A write of 1 enables error injection.
105
106		The following example shows how to enable error injection::
107
108			# cd /sys/kernel/debug/qat_<device>_<BDF>
109			# echo 1 > heartbeat/inject_error