xref: /linux/Documentation/ABI/testing/debugfs-driver-qat (revision 359b84f8db942ef46d24de8aa397790c3fae22e0)
1865b50feSLucas Segarra FernandezWhat:		/sys/kernel/debug/qat_<device>_<BDF>/qat/fw_counters
2865b50feSLucas Segarra FernandezDate:		November 2023
3865b50feSLucas Segarra FernandezKernelVersion:	6.6
4865b50feSLucas Segarra FernandezContact:	qat-linux@intel.com
5865b50feSLucas Segarra FernandezDescription:	(RO) Read returns the number of requests sent to the FW and the number of responses
6865b50feSLucas Segarra Fernandez		received from the FW for each Acceleration Engine
7865b50feSLucas Segarra Fernandez		Reported firmware counters::
8865b50feSLucas Segarra Fernandez
9865b50feSLucas Segarra Fernandez			<N>: Number of requests sent from Acceleration Engine N to FW and responses
10865b50feSLucas Segarra Fernandez			     Acceleration Engine N received from FW
11*359b84f8SDamian Muszynski
12*359b84f8SDamian MuszynskiWhat:		/sys/kernel/debug/qat_<device>_<BDF>/heartbeat/config
13*359b84f8SDamian MuszynskiDate:		November 2023
14*359b84f8SDamian MuszynskiKernelVersion:	6.6
15*359b84f8SDamian MuszynskiContact:	qat-linux@intel.com
16*359b84f8SDamian MuszynskiDescription:	(RW) Read returns value of the Heartbeat update period.
17*359b84f8SDamian Muszynski		Write to the file changes this period value.
18*359b84f8SDamian Muszynski
19*359b84f8SDamian Muszynski		This period should reflect planned polling interval of device
20*359b84f8SDamian Muszynski		health status. High frequency Heartbeat monitoring wastes CPU cycles
21*359b84f8SDamian Muszynski		but minimizes the customer’s system downtime. Also, if there are
22*359b84f8SDamian Muszynski		large service requests that take some time to complete, high frequency
23*359b84f8SDamian Muszynski		Heartbeat monitoring could result in false reports of unresponsiveness
24*359b84f8SDamian Muszynski		and in those cases, period needs to be increased.
25*359b84f8SDamian Muszynski
26*359b84f8SDamian Muszynski		This parameter is effective only for c3xxx, c62x, dh895xcc devices.
27*359b84f8SDamian Muszynski		4xxx has this value internally fixed to 200ms.
28*359b84f8SDamian Muszynski
29*359b84f8SDamian Muszynski		Default value is set to 500. Minimal allowed value is 200.
30*359b84f8SDamian Muszynski		All values are expressed in milliseconds.
31*359b84f8SDamian Muszynski
32*359b84f8SDamian MuszynskiWhat:		/sys/kernel/debug/qat_<device>_<BDF>/heartbeat/queries_failed
33*359b84f8SDamian MuszynskiDate:		November 2023
34*359b84f8SDamian MuszynskiKernelVersion:	6.6
35*359b84f8SDamian MuszynskiContact:	qat-linux@intel.com
36*359b84f8SDamian MuszynskiDescription:	(RO) Read returns the number of times the device became unresponsive.
37*359b84f8SDamian Muszynski
38*359b84f8SDamian Muszynski		Attribute returns value of the counter which is incremented when
39*359b84f8SDamian Muszynski		status query results negative.
40*359b84f8SDamian Muszynski
41*359b84f8SDamian MuszynskiWhat:		/sys/kernel/debug/qat_<device>_<BDF>/heartbeat/queries_sent
42*359b84f8SDamian MuszynskiDate:		November 2023
43*359b84f8SDamian MuszynskiKernelVersion:	6.6
44*359b84f8SDamian MuszynskiContact:	qat-linux@intel.com
45*359b84f8SDamian MuszynskiDescription:	(RO) Read returns the number of times the control process checked
46*359b84f8SDamian Muszynski		if the device is responsive.
47*359b84f8SDamian Muszynski
48*359b84f8SDamian Muszynski		Attribute returns value of the counter which is incremented on
49*359b84f8SDamian Muszynski		every status query.
50*359b84f8SDamian Muszynski
51*359b84f8SDamian MuszynskiWhat:		/sys/kernel/debug/qat_<device>_<BDF>/heartbeat/status
52*359b84f8SDamian MuszynskiDate:		November 2023
53*359b84f8SDamian MuszynskiKernelVersion:	6.6
54*359b84f8SDamian MuszynskiContact:	qat-linux@intel.com
55*359b84f8SDamian MuszynskiDescription:	(RO) Read returns the device health status.
56*359b84f8SDamian Muszynski
57*359b84f8SDamian Muszynski		Returns 0 when device is healthy or -1 when is unresponsive
58*359b84f8SDamian Muszynski		or the query failed to send.
59*359b84f8SDamian Muszynski
60*359b84f8SDamian Muszynski		The driver does not monitor for Heartbeat. It is left for a user
61*359b84f8SDamian Muszynski		to poll the status periodically.
62