xref: /linux/Documentation/ABI/testing/debugfs-cros-ec (revision 24168c5e6dfbdd5b414f048f47f75d64533296ca)
1What:		/sys/kernel/debug/<cros-ec-device>/console_log
2Date:		September 2017
3KernelVersion:	4.13
4Description:
5		If the EC supports the CONSOLE_READ command type, this file
6		can be used to grab the EC logs. The kernel polls for the log
7		and keeps its own buffer but userspace should grab this and
8		write it out to some logs.
9
10What:		/sys/kernel/debug/<cros-ec-device>/panicinfo
11Date:		September 2017
12KernelVersion:	4.13
13Description:
14		This file dumps the EC panic information from the previous
15		reboot. This file will only exist if the PANIC_INFO command
16		type is supported by the EC.
17
18What:		/sys/kernel/debug/<cros-ec-device>/pdinfo
19Date:		June 2018
20KernelVersion:	4.17
21Description:
22		This file provides the port role, muxes and power debug
23		information for all the USB PD/type-C ports available. If
24		the are no ports available, this file will be just an empty
25		file.
26
27What:		/sys/kernel/debug/<cros-ec-device>/uptime
28Date:		June 2019
29KernelVersion:	5.3
30Description:
31		A u32 providing the time since EC booted in ms. This is
32		is used for synchronizing the AP host time with the EC
33		log. An error is returned if the command is not supported
34		by the EC or there is a communication problem.
35
36What:		/sys/kernel/debug/<cros-ec-device>/last_resume_result
37Date:		June 2019
38KernelVersion:	5.3
39Description:
40		Some ECs have a feature where they will track transitions to
41		the (Intel) processor's SLP_S0 line, in order to detect cases
42		where a system failed to go into S0ix. When the system resumes,
43		an EC with this feature will return a summary of SLP_S0
44		transitions that occurred. The last_resume_result file returns
45		the most recent response from the AP's resume message to the EC.
46
47		The bottom 31 bits contain a count of the number of SLP_S0
48		transitions that occurred since the suspend message was
49		received. Bit 31 is set if the EC attempted to wake the
50		system due to a timeout when watching for SLP_S0 transitions.
51		Callers can use this to detect a wake from the EC due to
52		S0ix timeouts. The result will be zero if no suspend
53		transitions have been attempted, or the EC does not support
54		this feature.
55
56		Output will be in the format: "0x%08x\n".
57
58What:		/sys/kernel/debug/<cros-ec-device>/suspend_timeout_ms
59Date:		August 2022
60KernelVersion:	6.1
61Description:
62		Some ECs have a feature where they will track transitions of
63		a hardware-controlled sleep line, such as Intel's SLP_S0 line,
64		in order to detect cases where a system failed to go into deep
65		sleep states. The suspend_timeout_ms file controls the amount of
66		time in milliseconds the EC will wait before declaring a sleep
67		timeout event and attempting to wake the system.
68
69		Supply 0 to use the default value coded into EC firmware. Supply
70		65535 (EC_HOST_SLEEP_TIMEOUT_INFINITE) to disable the EC sleep
71		failure detection mechanism. Values in between 0 and 65535
72		indicate the number of milliseconds the EC should wait after a
73		sleep transition before declaring a timeout. This includes both
74		the duration after a sleep command was received but before the
75		hardware line changed, as well as the duration between when the
76		hardware line changed and the kernel sent an EC resume command.
77
78		Output will be in the format: "%u\n".
79