Skip to content

Commit 7043a9f

Browse files
torvic9shuahkh
authored andcommitted
tools/power/cpupower: Add documentation for some recently introduced options
The 'cpupower-set' tool has been enhanced with new features: commit f2ab555 ("cpupower: Add EPP value change support") commit df8776b ("cpupower: Add support for amd_pstate mode change") commit eb426fc ("cpupower: Add turbo-boost support in cpupower") However, the corresponding manpage was never updated. Add a basic description of these new options to the existing manpage. Commit description updated to fix checkpatch errors: Shuah Khan Signed-off-by: Tor Vic <torvic9@mailbox.org> Signed-off-by: Shuah Khan <skhan@linuxfoundation.org>
1 parent 9852d85 commit 7043a9f

File tree

1 file changed

+36
-2
lines changed

1 file changed

+36
-2
lines changed

tools/power/cpupower/man/cpupower-set.1

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
cpupower\-set \- Set processor power related kernel or hardware configurations
44
.SH SYNOPSIS
55
.ft B
6-
.B cpupower set [ \-b VAL ]
6+
.B cpupower set [ \-b VAL | \-e POLICY | \-m MODE | \-t BOOL ]
77

88

99
.SH DESCRIPTION
@@ -19,7 +19,7 @@ described in the Options sections.
1919
Use \fBcpupower info \fP to read out current settings and whether they are
2020
supported on the system at all.
2121

22-
.SH Options
22+
.SH OPTIONS
2323
.PP
2424
\-\-perf-bias, \-b
2525
.RS 4
@@ -56,6 +56,40 @@ Use \fBcpupower -c all info -b\fP to verify.
5656
This options needs the msr kernel driver (CONFIG_X86_MSR) loaded.
5757
.RE
5858

59+
.PP
60+
\-\-epp, \-e
61+
.RS 4
62+
Sets the energy performance policy preference on supported Intel or AMD
63+
processors which use the Intel or AMD P-State cpufreq driver respectively.
64+
65+
Available policies can be found with
66+
\fBcat /sys/devices/system/cpu/cpufreq/policy0/energy_performance_available_preferences\fP :
67+
.RS 4
68+
default performance balance_performance balance_power power
69+
.RE
70+
71+
.RE
72+
73+
.PP
74+
\-\-amd\-pstate\-mode, \-m
75+
.RS 4
76+
Sets the AMD P-State mode for supported AMD processors.
77+
Available modes are "active", "guided" or "passive".
78+
79+
Refer to the AMD P-State kernel documentation for further information.
80+
81+
.RE
82+
83+
.PP
84+
\-\-turbo\-boost, \-t
85+
.RS 4
86+
This option is used to enable or disable the turbo boost feature on
87+
supported Intel and AMD processors.
88+
89+
This option takes as parameter either \fB1\fP to enable, or \fB0\fP to disable the feature.
90+
91+
.RE
92+
5993
.SH "SEE ALSO"
6094
cpupower-info(1), cpupower-monitor(1), powertop(1)
6195
.PP

0 commit comments

Comments
 (0)