Documentation / ABI / testing / sysfs-class-powercap


Based on kernel version 6.8. Page generated on 2024-03-11 21:26 EST.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
What:		/sys/class/powercap/
Date:		September 2013
KernelVersion:	3.13
Contact:	linux-pm@vger.kernel.org
Description:
		The powercap/ class sub directory belongs to the power cap
		subsystem. Refer to
		Documentation/power/powercap/powercap.rst for details.

What:		/sys/class/powercap/<control type>
Date:		September 2013
KernelVersion:	3.13
Contact:	linux-pm@vger.kernel.org
Description:
		A <control type> is a unique name under /sys/class/powercap.
		Here <control type> determines how the power is going to be
		controlled. A <control type> can contain multiple power zones.

What:		/sys/class/powercap/<control type>/enabled
Date:		September 2013
KernelVersion:	3.13
Contact:	linux-pm@vger.kernel.org
Description:
		This allows to enable/disable power capping for a "control type".
		This status affects every power zone using this "control_type.

What:		/sys/class/powercap/<control type>/<power zone>
Date:		September 2013
KernelVersion:	3.13
Contact:	linux-pm@vger.kernel.org
Description:
		A power zone is a single or a collection of devices, which can
		be independently monitored and controlled. A power zone sysfs
		entry is qualified with the name of the <control type>.
		E.g. intel-rapl:0:1:1.

What:		/sys/class/powercap/<control type>/<power zone>/<child power zone>
Date:		September 2013
KernelVersion:	3.13
Contact:	linux-pm@vger.kernel.org
Description:
		Power zones may be organized in a hierarchy in which child
		power zones provide monitoring and control for a subset of
		devices under the parent. For example, if there is a parent
		power zone for a whole CPU package, each CPU core in it can
		be a child power zone.

What:		/sys/class/powercap/.../<power zone>/name
Date:		September 2013
KernelVersion:	3.13
Contact:	linux-pm@vger.kernel.org
Description:
		Specifies the name of this power zone.

What:		/sys/class/powercap/.../<power zone>/energy_uj
Date:		September 2013
KernelVersion:	3.13
Contact:	linux-pm@vger.kernel.org
Description:
		Current energy counter in micro-joules. Write "0" to reset.
		If the counter can not be reset, then this attribute is
		read-only.

What:		/sys/class/powercap/.../<power zone>/max_energy_range_uj
Date:		September 2013
KernelVersion:	3.13
Contact:	linux-pm@vger.kernel.org
Description:
		Range of the above energy counter in micro-joules.


What:		/sys/class/powercap/.../<power zone>/power_uw
Date:		September 2013
KernelVersion:	3.13
Contact:	linux-pm@vger.kernel.org
Description:
		Current power in micro-watts.

What:		/sys/class/powercap/.../<power zone>/max_power_range_uw
Date:		September 2013
KernelVersion:	3.13
Contact:	linux-pm@vger.kernel.org
Description:
		Range of the above power value in micro-watts.

What:		/sys/class/powercap/.../<power zone>/constraint_X_name
Date:		September 2013
KernelVersion:	3.13
Contact:	linux-pm@vger.kernel.org
Description:
		Each power zone can define one or more constraints. Each
		constraint can have an optional name. Here "X" can have values
		from 0 to max integer.

What:		/sys/class/powercap/.../<power zone>/constraint_X_power_limit_uw
Date:		September 2013
KernelVersion:	3.13
Contact:	linux-pm@vger.kernel.org
Description:
		Power limit in micro-watts should be applicable for
		the time window specified by "constraint_X_time_window_us".
		Here "X" can have values from 0 to max integer.

What:		/sys/class/powercap/.../<power zone>/constraint_X_time_window_us
Date:		September 2013
KernelVersion:	3.13
Contact:	linux-pm@vger.kernel.org
Description:
		Time window in micro seconds. This is used along with
		constraint_X_power_limit_uw to define a power constraint.
		Here "X" can have values from 0 to max integer.


What:		/sys/class/powercap/<control type>/.../constraint_X_max_power_uw
Date:		September 2013
KernelVersion:	3.13
Contact:	linux-pm@vger.kernel.org
Description:
		Maximum allowed power in micro watts for this constraint.
		Here "X" can have values from 0 to max integer.

What:		/sys/class/powercap/<control type>/.../constraint_X_min_power_uw
Date:		September 2013
KernelVersion:	3.13
Contact:	linux-pm@vger.kernel.org
Description:
		Minimum allowed power in micro watts for this constraint.
		Here "X" can have values from 0 to max integer.

What:		/sys/class/powercap/.../<power zone>/constraint_X_max_time_window_us
Date:		September 2013
KernelVersion:	3.13
Contact:	linux-pm@vger.kernel.org
Description:
		Maximum allowed time window in micro seconds for this
		constraint. Here "X" can have values from 0 to max integer.

What:		/sys/class/powercap/.../<power zone>/constraint_X_min_time_window_us
Date:		September 2013
KernelVersion:	3.13
Contact:	linux-pm@vger.kernel.org
Description:
		Minimum allowed time window in micro seconds for this
		constraint. Here "X" can have values from 0 to max integer.

What:		/sys/class/powercap/.../<power zone>/enabled
Date:		September 2013
KernelVersion:	3.13
Contact:	linux-pm@vger.kernel.org
Description:
		This allows to enable/disable power capping at power zone level.
		This applies to current power zone and its children.