Documentation/ABI/testing/sysfs-class-intel_pmt

   1 What:           /sys/class/intel_pmt/
   2 Date:           October 2020
   3 KernelVersion:  5.10
   4 Contact:        David Box <david.e.box@linux.intel.com>
   5 Description:
   6                 The intel_pmt/ class directory contains information for
   7                 devices that expose hardware telemetry using Intel Platform
   8                 Monitoring Technology (PMT)
   9
  10 What:           /sys/class/intel_pmt/telem<x>
  11 Date:           October 2020
  12 KernelVersion:  5.10
  13 Contact:        David Box <david.e.box@linux.intel.com>
  14 Description:
  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
  23 What:           /sys/class/intel_pmt/telem<x>/telem
  24 Date:           October 2020
  25 KernelVersion:  5.10
  26 Contact:        David Box <david.e.box@linux.intel.com>
  27 Description:
  28                 (RO) The telemetry data for this telemetry device. This file
  29                 may be mapped or read to obtain the data.
  30
  31 What:           /sys/class/intel_pmt/telem<x>/guid
  32 Date:           October 2020
  33 KernelVersion:  5.10
  34 Contact:        David Box <david.e.box@linux.intel.com>
  35 Description:
  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
  40 What:           /sys/class/intel_pmt/telem<x>/size
  41 Date:           October 2020
  42 KernelVersion:  5.10
  43 Contact:        David Box <david.e.box@linux.intel.com>
  44 Description:
  45                 (RO) The size of telemetry region in bytes that corresponds to
  46                 the mapping size for the telem file.
  47
  48 What:           /sys/class/intel_pmt/telem<x>/offset
  49 Date:           October 2020
  50 KernelVersion:  5.10
  51 Contact:        David Box <david.e.box@linux.intel.com>
  52 Description:
  53                 (RO) The offset of telemetry region in bytes that corresponds to
  54                 the mapping for the telem file.
  55
  56 What:           /sys/class/intel_pmt/crashlog<x>
  57 Date:           October 2020
  58 KernelVersion:  5.10
  59 Contact:        Alexander Duyck <alexander.h.duyck@linux.intel.com>
  60 Description:
  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
  69 What:           /sys/class/intel_pmt/crashlog<x>/crashlog
  70 Date:           October 2020
  71 KernelVersion:  5.10
  72 Contact:        David Box <david.e.box@linux.intel.com>
  73 Description:
  74                 (RO) The crashlog buffer for this crashlog device. This file
  75                 may be mapped or read to obtain the data.
  76
  77 What:           /sys/class/intel_pmt/crashlog<x>/guid
  78 Date:           October 2020
  79 KernelVersion:  5.10
  80 Contact:        Alexander Duyck <alexander.h.duyck@linux.intel.com>
  81 Description:
  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
  86 What:           /sys/class/intel_pmt/crashlog<x>/size
  87 Date:           October 2020
  88 KernelVersion:  5.10
  89 Contact:        Alexander Duyck <alexander.h.duyck@linux.intel.com>
  90 Description:
  91                 (RO) The length of the result buffer in bytes that corresponds
  92                 to the size for the crashlog buffer.
  93
  94 What:           /sys/class/intel_pmt/crashlog<x>/offset
  95 Date:           October 2020
  96 KernelVersion:  5.10
  97 Contact:        Alexander Duyck <alexander.h.duyck@linux.intel.com>
  98 Description:
  99                 (RO) The offset of the buffer in bytes that corresponds
 100                 to the mapping for the crashlog device.
 101
 102 What:           /sys/class/intel_pmt/crashlog<x>/enable
 103 Date:           October 2020
 104 KernelVersion:  5.10
 105 Contact:        Alexander Duyck <alexander.h.duyck@linux.intel.com>
 106 Description:
 107                 (RW) Boolean value controlling if the crashlog functionality
 108                 is enabled for the crashlog device.
 109
 110 What:           /sys/class/intel_pmt/crashlog<x>/trigger
 111 Date:           October 2020
 112 KernelVersion:  5.10
 113 Contact:        Alexander Duyck <alexander.h.duyck@linux.intel.com>
 114 Description:
 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.