xref: /linux/Documentation/ABI/testing/sysfs-class-mei (revision d85ddd1318e66c0c2665dbfcbc21a8b66c9152aa)
1What:		/sys/class/mei/
2Date:		May 2014
3KernelVersion:	3.17
4Contact:	Tomas Winkler <tomas.winkler@intel.com>
5Description:
6		The mei/ class sub-directory belongs to mei device class
7
8
9What:		/sys/class/mei/meiN/
10Date:		May 2014
11KernelVersion:	3.17
12Contact:	Tomas Winkler <tomas.winkler@intel.com>
13Description:
14		The /sys/class/mei/meiN directory is created for
15		each probed mei device
16
17What:		/sys/class/mei/meiN/fw_status
18Date:		Nov 2014
19KernelVersion:	3.19
20Contact:	Tomas Winkler <tomas.winkler@intel.com>
21Description:	Display fw status registers content
22
23		The ME FW writes its status information into fw status
24		registers for BIOS and OS to monitor fw health.
25
26		The register contains running state, power management
27		state, error codes, and others. The way the registers
28		are decoded depends on PCH or SoC generation.
29		Also number of registers varies between 1 and 6
30		depending on generation.
31
32What:		/sys/class/mei/meiN/hbm_ver
33Date:		Aug 2016
34KernelVersion:	4.9
35Contact:	Tomas Winkler <tomas.winkler@intel.com>
36Description:	Display the negotiated HBM protocol version.
37
38		The HBM protocol version negotiated
39		between the driver and the device.
40
41What:		/sys/class/mei/meiN/hbm_ver_drv
42Date:		Aug 2016
43KernelVersion:	4.9
44Contact:	Tomas Winkler <tomas.winkler@intel.com>
45Description:	Display the driver HBM protocol version.
46
47		The HBM protocol version supported by the driver.
48
49What:		/sys/class/mei/meiN/tx_queue_limit
50Date:		Jan 2018
51KernelVersion:	4.16
52Contact:	Tomas Winkler <tomas.winkler@intel.com>
53Description:	Configure tx queue limit
54
55		Set maximal number of pending writes
56		per opened session.
57
58What:		/sys/class/mei/meiN/fw_ver
59Date:		May 2018
60KernelVersion:	4.18
61Contact:	Tomas Winkler <tomas.winkler@intel.com>
62Description:	Display the ME firmware version.
63
64		The version of the platform ME firmware is in format:
65		<platform>:<major>.<minor>.<milestone>.<build_no>.
66		There can be up to three such blocks for different
67		FW components.
68
69What:		/sys/class/mei/meiN/dev_state
70Date:		Mar 2019
71KernelVersion:	5.1
72Contact:	Tomas Winkler <tomas.winkler@intel.com>
73Description:	Display the ME device state.
74
75		The device state can have following values:
76		INITIALIZING
77		INIT_CLIENTS
78		ENABLED
79		RESETTING
80		DISABLED
81		POWER_DOWN
82		POWER_UP
83
84What:		/sys/class/mei/meiN/trc
85Date:		Nov 2019
86KernelVersion:	5.5
87Contact:	Tomas Winkler <tomas.winkler@intel.com>
88Description:	Display trc status register content
89
90		The ME FW writes Glitch Detection HW (TRC)
91		status information into trc status register
92		for BIOS and OS to monitor fw health.
93
94What:		/sys/class/mei/meiN/kind
95Date:		Jul 2020
96KernelVersion:	5.8
97Contact:	Tomas Winkler <tomas.winkler@intel.com>
98Description:	Display kind of the device
99
100		Generic devices are marked as "mei"
101		while special purpose have their own
102		names.
103		Available options:
104		- mei:  generic mei device.
105		- itouch:  itouch (ipts) mei device.
106