Skip to content

Commit 9b2983d

Browse files
readme: Add core UMaskExt documentation
This commit adds documentation for the core event attribute UMaskExt. Note that the attribute will eventually be renamed to UMask2 to align with the Intel SDM.
1 parent d4934c3 commit 9b2983d

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,9 +199,19 @@ is defined architecturally. Each value corresponds to an event logic unit and sh
199199
mask value to obtain an architectural performance event.
200200
201201
### UMask
202-
This field maps to the Unit Mask filed in the `IA32_PERFEVTSELx[15:8]` MSRs. It further qualifies the event logic
202+
This field maps to the Unit Mask field in the `IA32_PERFEVTSELx[15:8]` MSRs. It further qualifies the event logic
203203
unit selected in the event select field to detect a specific micro-architectural condition.
204204
205+
### UMaskExt (Core events)
206+
This field maps to the Unit Mask 2 field in the `IA32_PERFEVTSELx[47:40]` MSRs. First introduced with architectural
207+
performance monitoring version 6.
208+
209+
> These bits qualify the condition that the selected event logic unit detects. Valid UMASK2 values for each
210+
event logic unit are specific to the unit. The new UMASK2 field may also be used in conjunction with UMASK.
211+
212+
:warning: `UMaskExt` will be renamed to `UMask2` to align with the Intel® SDM. Please refer to
213+
https://github.com/intel/perfmon/issues/357 for additional information.
214+
205215
### EventName
206216
It is a string of characters to identify the programming of an event.
207217

0 commit comments

Comments
 (0)