Blame src/libpfm4/docs/man3/libpfm_intel_snbep_unc_ubo.3

Packit Service a1973e
.TH LIBPFM 3  "August, 2012" "" "Linux Programmer's Manual"
Packit Service a1973e
.SH NAME
Packit Service a1973e
libpfm_intel_snbep_unc_ubo - support for Intel Sandy Bridge-EP U-Box uncore PMU
Packit Service a1973e
.SH SYNOPSIS
Packit Service a1973e
.nf
Packit Service a1973e
.B #include <perfmon/pfmlib.h>
Packit Service a1973e
.sp
Packit Service a1973e
.B PMU name: snbep_unc_ubo
Packit Service a1973e
.B PMU desc: Intel Sandy Bridge-EP U-Box uncore PMU
Packit Service a1973e
.sp
Packit Service a1973e
.SH DESCRIPTION
Packit Service a1973e
The library supports the Intel Sandy Bridge system configuration unit (U-Box) uncore PMU.
Packit Service a1973e
This PMU model only exists on Sandy Bridge model 45. There is only one U-Box PMU
Packit Service a1973e
per processor socket.
Packit Service a1973e
Packit Service a1973e
.SH MODIFIERS
Packit Service a1973e
The following modifiers are supported on Intel Sandy Bridge U-Box uncore PMU:
Packit Service a1973e
.TP
Packit Service a1973e
.B i
Packit Service a1973e
Invert the meaning of the event. The counter will now count HA cycles in which the
Packit Service a1973e
event is \fBnot\fR occurring. This is a boolean modifier
Packit Service a1973e
.TP
Packit Service a1973e
.B e
Packit Service a1973e
Enable edge detection, i.e., count only when there is a state transition from no occurrence of the event to at least one occurrence. This modifier must be combined with a threshold modifier (t) with a value greater or equal to one.  This is a boolean modifier.
Packit Service a1973e
.TP
Packit Service a1973e
.B t
Packit Service a1973e
Set the threshold value. When set to a non-zero value, the counter counts the number
Packit Service a1973e
of HA cycles in which the number of occurrences of the event is greater or equal to
Packit Service a1973e
the threshold.  This is an integer modifier with values in the range [0:15].
Packit Service a1973e
.TP
Packit Service a1973e
.B oi
Packit Service a1973e
Invert the meaning of the occupancy event POWER_STATE_OCCUPANCY. The counter will now count PCU cycles in which the
Packit Service a1973e
event is \fBnot\fR occurring. This is a boolean modifier
Packit Service a1973e
.TP
Packit Service a1973e
.B oe
Packit Service a1973e
Enable edge detection for the occupancy event POWER_STATE_OCCUPANCY. The event now counts only when there is a state
Packit Service a1973e
transition from no occurrence of the event to at least one occurrence. This modifier must be combined with a threshold
Packit Service a1973e
modifier (t) with a value greater or equal to one.  This is a boolean modifier.
Packit Service a1973e
Packit Service a1973e
.TP
Packit Service a1973e
.B ff
Packit Service a1973e
Enable frequency band filtering. This modifier applies only to the UNC_P_FREQ_BANDx_CYCLES events, where x is [0-3].
Packit Service a1973e
The modifiers expects an integer in the range [0-255]. The value is interpreted as a frequency value to be
Packit Service a1973e
multiplied by 100Mhz. Thus if the value is 32, then all cycles where the processor is running at 3.2GHz and more are
Packit Service a1973e
counted.
Packit Service a1973e
Packit Service a1973e
.SH Frequency band filtering
Packit Service a1973e
Packit Service a1973e
There are 3 events which support frequency band filtering, namely, UNC_P_FREQ_BAND0_CYCLES, UNC_P_FREQ_BAND1_CYCLES,
Packit Service a1973e
UNC_P_FREQ_BAND2_CYCLES, UNC_P_FREQ_BAND3_CYCLES. The frequency filter (available via the ff modifier) is stored into
Packit Service a1973e
a PMU shared register which hold all 4 possible frequency bands, one per event. However, the library generate the
Packit Service a1973e
encoding for each event individually because it processes events one at a time. The caller or the underlying kernel
Packit Service a1973e
interface may have to merge the band filter settings to program the filter register properly.
Packit Service a1973e
Packit Service a1973e
.SH AUTHORS
Packit Service a1973e
.nf
Packit Service a1973e
Stephane Eranian <eranian@gmail.com>
Packit Service a1973e
.if
Packit Service a1973e
.PP