xref: /linux/Documentation/ABI/testing/debugfs-driver-qat (revision 7ba98583448b7a0dbfa8121c7be642651e0abd61)
1*7ba98583SGiovanni CabidduWhat:		/sys/kernel/debug/qat_<device>_<BDF>/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
11359b84f8SDamian Muszynski
12359b84f8SDamian MuszynskiWhat:		/sys/kernel/debug/qat_<device>_<BDF>/heartbeat/config
13359b84f8SDamian MuszynskiDate:		November 2023
14359b84f8SDamian MuszynskiKernelVersion:	6.6
15359b84f8SDamian MuszynskiContact:	qat-linux@intel.com
16359b84f8SDamian MuszynskiDescription:	(RW) Read returns value of the Heartbeat update period.
17359b84f8SDamian Muszynski		Write to the file changes this period value.
18359b84f8SDamian Muszynski
19359b84f8SDamian Muszynski		This period should reflect planned polling interval of device
20359b84f8SDamian Muszynski		health status. High frequency Heartbeat monitoring wastes CPU cycles
21359b84f8SDamian Muszynski		but minimizes the customer’s system downtime. Also, if there are
22359b84f8SDamian Muszynski		large service requests that take some time to complete, high frequency
23359b84f8SDamian Muszynski		Heartbeat monitoring could result in false reports of unresponsiveness
24359b84f8SDamian Muszynski		and in those cases, period needs to be increased.
25359b84f8SDamian Muszynski
26359b84f8SDamian Muszynski		This parameter is effective only for c3xxx, c62x, dh895xcc devices.
27359b84f8SDamian Muszynski		4xxx has this value internally fixed to 200ms.
28359b84f8SDamian Muszynski
29359b84f8SDamian Muszynski		Default value is set to 500. Minimal allowed value is 200.
30359b84f8SDamian Muszynski		All values are expressed in milliseconds.
31359b84f8SDamian Muszynski
32359b84f8SDamian MuszynskiWhat:		/sys/kernel/debug/qat_<device>_<BDF>/heartbeat/queries_failed
33359b84f8SDamian MuszynskiDate:		November 2023
34359b84f8SDamian MuszynskiKernelVersion:	6.6
35359b84f8SDamian MuszynskiContact:	qat-linux@intel.com
36359b84f8SDamian MuszynskiDescription:	(RO) Read returns the number of times the device became unresponsive.
37359b84f8SDamian Muszynski
38359b84f8SDamian Muszynski		Attribute returns value of the counter which is incremented when
39359b84f8SDamian Muszynski		status query results negative.
40359b84f8SDamian Muszynski
41359b84f8SDamian MuszynskiWhat:		/sys/kernel/debug/qat_<device>_<BDF>/heartbeat/queries_sent
42359b84f8SDamian MuszynskiDate:		November 2023
43359b84f8SDamian MuszynskiKernelVersion:	6.6
44359b84f8SDamian MuszynskiContact:	qat-linux@intel.com
45359b84f8SDamian MuszynskiDescription:	(RO) Read returns the number of times the control process checked
46359b84f8SDamian Muszynski		if the device is responsive.
47359b84f8SDamian Muszynski
48359b84f8SDamian Muszynski		Attribute returns value of the counter which is incremented on
49359b84f8SDamian Muszynski		every status query.
50359b84f8SDamian Muszynski
51359b84f8SDamian MuszynskiWhat:		/sys/kernel/debug/qat_<device>_<BDF>/heartbeat/status
52359b84f8SDamian MuszynskiDate:		November 2023
53359b84f8SDamian MuszynskiKernelVersion:	6.6
54359b84f8SDamian MuszynskiContact:	qat-linux@intel.com
55359b84f8SDamian MuszynskiDescription:	(RO) Read returns the device health status.
56359b84f8SDamian Muszynski
57359b84f8SDamian Muszynski		Returns 0 when device is healthy or -1 when is unresponsive
58359b84f8SDamian Muszynski		or the query failed to send.
59359b84f8SDamian Muszynski
60359b84f8SDamian Muszynski		The driver does not monitor for Heartbeat. It is left for a user
61359b84f8SDamian Muszynski		to poll the status periodically.
62