Skip to content

Commit 46d40b2

Browse files
Shinji Nomotogroeck
authored andcommitted
doc: hwmon: acpi_power_meter: Add information about enabling the power capping feature.
To enable the power capping feature of the acpi_power_meter driver on systems other than IBM products, you must explicitly specify the force_cap_on module parameter. Add information to the documentation about enabling the power capping feature with this driver, including the above, to improve user convenience. Signed-off-by: Shinji Nomoto <fj5851bi@fujitsu.com> Link: https://lore.kernel.org/r/20250520062707.1657667-1-fj5851bi@fujitsu.com Signed-off-by: Guenter Roeck <linux@roeck-us.net>
1 parent b2446a1 commit 46d40b2

File tree

1 file changed

+26
-3
lines changed

1 file changed

+26
-3
lines changed

Documentation/hwmon/acpi_power_meter.rst

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,16 @@ arbitrary strings that ACPI provides with the meter. The measures/ directory
3737
contains symlinks to the devices that this meter measures.
3838

3939
Some computers have the ability to enforce a power cap in hardware. If this is
40-
the case, the `power[1-*]_cap` and related sysfs files will appear. When the
41-
average power consumption exceeds the cap, an ACPI event will be broadcast on
42-
the netlink event socket and a poll notification will be sent to the
40+
the case, the `power[1-*]_cap` and related sysfs files will appear.
41+
For information on enabling the power cap feature, refer to the description
42+
of the "force_on_cap" option in the "Module Parameters" chapter.
43+
To use the power cap feature properly, you need to set appropriate value
44+
(in microWatts) to the `power[1-*]_cap` sysfs files.
45+
The value must be within the range between the minimum value at `power[1-]_cap_min`
46+
and the maximum value at `power[1-]_cap_max (both in microWatts)`.
47+
48+
When the average power consumption exceeds the cap, an ACPI event will be
49+
broadcast on the netlink event socket and a poll notification will be sent to the
4350
appropriate `power[1-*]_alarm` file to indicate that capping has begun, and the
4451
hardware has taken action to reduce power consumption. Most likely this will
4552
result in reduced performance.
@@ -52,3 +59,19 @@ follows:
5259
`power[1-*]_cap` will be notified if the firmware changes the power cap.
5360
`power[1-*]_interval` will be notified if the firmware changes the averaging
5461
interval.
62+
63+
Module Parameters
64+
-----------------
65+
66+
* force_cap_on: bool
67+
Forcefully enable the power capping feature to specify
68+
the upper limit of the system's power consumption.
69+
70+
By default, the driver's power capping feature is only
71+
enabled on IBM products.
72+
Therefore, on other systems that support power capping,
73+
you will need to use the option to enable it.
74+
75+
Note: power capping is potentially unsafe feature.
76+
Please check the platform specifications to make sure
77+
that capping is supported before using this option.

0 commit comments

Comments
 (0)