1What:		/sys/class/intel_pmt/
2Date:		October 2020
3KernelVersion:	5.10
4Contact:	David Box <david.e.box@linux.intel.com>
5Description:
6		The intel_pmt/ class directory contains information for
7		devices that expose hardware telemetry using Intel Platform
8		Monitoring Technology (PMT)
9
10What:		/sys/class/intel_pmt/telem<x>
11Date:		October 2020
12KernelVersion:	5.10
13Contact:	David Box <david.e.box@linux.intel.com>
14Description:
15		The telem<x> directory contains files describing an instance of
16		a PMT telemetry device that exposes hardware telemetry. Each
17		telem<x> directory has an associated telem file. This file
18		may be opened and mapped or read to access the telemetry space
19		of the device. The register layout of the telemetry space is
20		determined from an XML file that matches the PCI device id and
21		GUID for the device.
22
23What:		/sys/class/intel_pmt/telem<x>/telem
24Date:		October 2020
25KernelVersion:	5.10
26Contact:	David Box <david.e.box@linux.intel.com>
27Description:
28		(RO) The telemetry data for this telemetry device. This file
29		may be mapped or read to obtain the data.
30
31What:		/sys/class/intel_pmt/telem<x>/guid
32Date:		October 2020
33KernelVersion:	5.10
34Contact:	David Box <david.e.box@linux.intel.com>
35Description:
36		(RO) The GUID for this telemetry device. The GUID identifies
37		the version of the XML file for the parent device that is to
38		be used to get the register layout.
39
40What:		/sys/class/intel_pmt/telem<x>/size
41Date:		October 2020
42KernelVersion:	5.10
43Contact:	David Box <david.e.box@linux.intel.com>
44Description:
45		(RO) The size of telemetry region in bytes that corresponds to
46		the mapping size for the telem file.
47
48What:		/sys/class/intel_pmt/telem<x>/offset
49Date:		October 2020
50KernelVersion:	5.10
51Contact:	David Box <david.e.box@linux.intel.com>
52Description:
53		(RO) The offset of telemetry region in bytes that corresponds to
54		the mapping for the telem file.
55
56What:		/sys/class/intel_pmt/crashlog<x>
57Date:		October 2020
58KernelVersion:	5.10
59Contact:	Alexander Duyck <alexander.h.duyck@linux.intel.com>
60Description:
61		The crashlog<x> directory contains files for configuring an
62		instance of a PMT crashlog device that can perform crash data
63		recording. Each crashlog<x> device has an associated crashlog
64		file. This file can be opened and mapped or read to access the
65		resulting crashlog buffer. The register layout for the buffer
66		can be determined from an XML file of specified GUID for the
67		parent device.
68
69What:		/sys/class/intel_pmt/crashlog<x>/crashlog
70Date:		October 2020
71KernelVersion:	5.10
72Contact:	David Box <david.e.box@linux.intel.com>
73Description:
74		(RO) The crashlog buffer for this crashlog device. This file
75		may be mapped or read to obtain the data.
76
77What:		/sys/class/intel_pmt/crashlog<x>/guid
78Date:		October 2020
79KernelVersion:	5.10
80Contact:	Alexander Duyck <alexander.h.duyck@linux.intel.com>
81Description:
82		(RO) The GUID for this crashlog device. The GUID identifies the
83		version of the XML file for the parent device that should be
84		used to determine the register layout.
85
86What:		/sys/class/intel_pmt/crashlog<x>/size
87Date:		October 2020
88KernelVersion:	5.10
89Contact:	Alexander Duyck <alexander.h.duyck@linux.intel.com>
90Description:
91		(RO) The length of the result buffer in bytes that corresponds
92		to the size for the crashlog buffer.
93
94What:		/sys/class/intel_pmt/crashlog<x>/offset
95Date:		October 2020
96KernelVersion:	5.10
97Contact:	Alexander Duyck <alexander.h.duyck@linux.intel.com>
98Description:
99		(RO) The offset of the buffer in bytes that corresponds
100		to the mapping for the crashlog device.
101
102What:		/sys/class/intel_pmt/crashlog<x>/enable
103Date:		October 2020
104KernelVersion:	5.10
105Contact:	Alexander Duyck <alexander.h.duyck@linux.intel.com>
106Description:
107		(RW) Boolean value controlling if the crashlog functionality
108		is enabled for the crashlog device.
109
110What:		/sys/class/intel_pmt/crashlog<x>/trigger
111Date:		October 2020
112KernelVersion:	5.10
113Contact:	Alexander Duyck <alexander.h.duyck@linux.intel.com>
114Description:
115		(RW) Boolean value controlling the triggering of the crashlog
116		device node. When read it provides data on if the crashlog has
117		been triggered. When written to it can be used to either clear
118		the current trigger by writing false, or to trigger a new
119		event if the trigger is not currently set.
120