Skip to content

Commit 4c61090

Browse files
committed
pcm-raw: document raw pmt access
Change-Id: I215ee0f5e06ead3164a0bb4ea06b0ba6bd745599
1 parent 0b838b0 commit 4c61090

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

doc/PCM_RAW_README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -193,3 +193,34 @@ Sample csv output (date,time,event_name,milliseconds_between_samples,TSC_cycles_
193193
2021-09-27,00:07:40.507,UNC_UPI_L1_POWER_CYCLES,1000,2102078418,0,0,1200328715,0,0,1200283803
194194
```
195195
The unit can be logical core, memory channel, CHA, etc, depending on the event type.
196+
197+
--------------------------------------------------------------------------------
198+
Low-level access to Intel PMT telemetry data
199+
--------------------------------------------------------------------------------
200+
201+
pcm-raw can read raw telemetry data from Intel PMT (https://github.com/intel/Intel-PMT/).
202+
203+
Syntax for a PMT raw telemetry counter:
204+
205+
```
206+
pcm-raw -e pmt/config=<uniqueid>,config1=<sampleID>,config2=<sampleType>,config3=<lsb,config4=<msb>[,name=<description>]
207+
208+
```
209+
210+
The fields are the values for the counter from the Intel PMT aggregator XML:
211+
212+
* uniqueid : Intel PMT Telemetry unique identifier
213+
* sampleID : sample ID of the counter
214+
* sampleType counter encoding:
215+
- 0 : Snapshot (last value reported in csv)
216+
- non-zero : Counter (delta to last value reported in csv)
217+
* lsb : lsb field
218+
* msb : msb field
219+
220+
Example:
221+
```
222+
# for https://github.com/intel/Intel-PMT/blob/868049006ad2770a75e5fc7526fd0c4b22438e27/xml/SPR/OOBMSM/CORE/spr_aggregator.xml#L15428
223+
pmt/config=0x87b6fef1,config1=770,config2=0,config3=32,config4=63,name="Temperature_histogram_range_5_(50.5-57.5C)_counter_for_core_0"
224+
```
225+
226+
Current limitations: this feature (PMT access) is currently only available on Linux (with Intel PMT Linux driver).

0 commit comments

Comments
 (0)