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