Commit 18c5b9ea authored by Len Brown's avatar Len Brown
Browse files

tools/power x86_energy_perf_policy.8: Document SoC Slider Options 



x86_energy_perf_policy accesses the SoC Slider via standard
user/kernel APIs to the processor_thermal_soc_slider driver.

Machines that support SoC Slider largely use it instead of EPP,
which may continue to exist in a diminished role, or vanish entirely.

Signed-off-by: default avatarLen Brown <len.brown@intel.com>
parent 25ff5848

tools/power/x86/x86_energy_perf_policy/x86_energy_perf_policy.8

+26 −0
Original line number Diff line number Diff line
@@ -15,6 +15,8 @@ x86_energy_perf_policy \- Manage Energy vs. Performance Policy 
.br

.RB "other: (\-\-force | \-\-hwp-enable | \-\-turbo-enable)  value)"

.br

.RB "soc-slider: --soc-slider-balance # | --soc-slider-offset # | --platform-profile <name>"

.br

.RB "value: # | default | performance | balance-performance | balance-power | power"

.SH DESCRIPTION

\fBx86_energy_perf_policy\fP
@@ -154,6 +156,26 @@ level on this processor, specified in multiples of 100 MHz. 
in the sliding window that HWP uses to maintain average frequency.

This parameter is meaningful only when the "desired" field above is non-zero.

Default is 0, allowing the HW to choose.

.SH SOC SLIDER OPTIONS

.PP

Note that the Platform Profile Name must be "SoC Slider", and the

Platform Profile must be "balanced" for the --soc-slider-balance

and --soc-slider-offset options to take effect.

.PP

\fB--soc-slider-balance #\fP write numeric value to the SoC Slider.

Values range from 0 to 6.

Lower values result in higher performance,

and higher values improve energy efficiency.

Actual values are model specific.

.PP

\fB--soc-slider-offset #\fP write the numeric value to the Soc Slider Offset.

The slider offset is the maximum value that software allows the SoC to

autonomously add to the SoC Slider to improve energy efficiency.

The value 0 prohibits the SoC from autonomously changing the slider.

.PP

\fB--platform-profile <name>"\fP set the platform profile to <name>.

Available choices are in platform-profile-0/choices.  The Soc Slider

driver currently supports "low-power", "balanced", and "performance".

.SH OTHER OPTIONS

.PP

\fB-f, --force\fP writes the specified values without bounds checking.
@@ -208,6 +230,10 @@ runs only as root. 
EPB: /sys/devices/system/cpu/cpu*/power/energy_perf_bias

EPP: /sys/devices/system/cpu/cpu*/cpufreq/energy_performance_preference

MSR: /dev/cpu/*/msr

Platform Profile Name: /sys/class/platform-profile/platform-profile-0/name

Platform Profile: /sys/class/platform-profile/platform-profile-0/profile

SOC Slider Balanced: /sys/module/processor_thermal_soc_slider/parameters/slider_balance

SOC Slider Balanced Offset: /sys/module/processor_thermal_soc_slider/parameters/slider_offset

.fi

.SH "SEE ALSO"

.nf