1What:		/sys/class/powercap/
  2Date:		September 2013
  3KernelVersion:	3.13
  4Contact:	linux-pm@vger.kernel.org
  5Description:
  6		The powercap/ class sub directory belongs to the power cap
  7		subsystem. Refer to
  8		Documentation/power/powercap/powercap.rst for details.
  9
 10What:		/sys/class/powercap/<control type>
 11Date:		September 2013
 12KernelVersion:	3.13
 13Contact:	linux-pm@vger.kernel.org
 14Description:
 15		A <control type> is a unique name under /sys/class/powercap.
 16		Here <control type> determines how the power is going to be
 17		controlled. A <control type> can contain multiple power zones.
 18
 19What:		/sys/class/powercap/<control type>/enabled
 20Date:		September 2013
 21KernelVersion:	3.13
 22Contact:	linux-pm@vger.kernel.org
 23Description:
 24		This allows to enable/disable power capping for a "control type".
 25		This status affects every power zone using this "control_type.
 26
 27What:		/sys/class/powercap/<control type>/<power zone>
 28Date:		September 2013
 29KernelVersion:	3.13
 30Contact:	linux-pm@vger.kernel.org
 31Description:
 32		A power zone is a single or a collection of devices, which can
 33		be independently monitored and controlled. A power zone sysfs
 34		entry is qualified with the name of the <control type>.
 35		E.g. intel-rapl:0:1:1.
 36
 37What:		/sys/class/powercap/<control type>/<power zone>/<child power zone>
 38Date:		September 2013
 39KernelVersion:	3.13
 40Contact:	linux-pm@vger.kernel.org
 41Description:
 42		Power zones may be organized in a hierarchy in which child
 43		power zones provide monitoring and control for a subset of
 44		devices under the parent. For example, if there is a parent
 45		power zone for a whole CPU package, each CPU core in it can
 46		be a child power zone.
 47
 48What:		/sys/class/powercap/.../<power zone>/name
 49Date:		September 2013
 50KernelVersion:	3.13
 51Contact:	linux-pm@vger.kernel.org
 52Description:
 53		Specifies the name of this power zone.
 54
 55What:		/sys/class/powercap/.../<power zone>/energy_uj
 56Date:		September 2013
 57KernelVersion:	3.13
 58Contact:	linux-pm@vger.kernel.org
 59Description:
 60		Current energy counter in micro-joules. Write "0" to reset.
 61		If the counter can not be reset, then this attribute is
 62		read-only.
 63
 64What:		/sys/class/powercap/.../<power zone>/max_energy_range_uj
 65Date:		September 2013
 66KernelVersion:	3.13
 67Contact:	linux-pm@vger.kernel.org
 68Description:
 69		Range of the above energy counter in micro-joules.
 70
 71
 72What:		/sys/class/powercap/.../<power zone>/power_uw
 73Date:		September 2013
 74KernelVersion:	3.13
 75Contact:	linux-pm@vger.kernel.org
 76Description:
 77		Current power in micro-watts.
 78
 79What:		/sys/class/powercap/.../<power zone>/max_power_range_uw
 80Date:		September 2013
 81KernelVersion:	3.13
 82Contact:	linux-pm@vger.kernel.org
 83Description:
 84		Range of the above power value in micro-watts.
 85
 86What:		/sys/class/powercap/.../<power zone>/constraint_X_name
 87Date:		September 2013
 88KernelVersion:	3.13
 89Contact:	linux-pm@vger.kernel.org
 90Description:
 91		Each power zone can define one or more constraints. Each
 92		constraint can have an optional name. Here "X" can have values
 93		from 0 to max integer.
 94
 95What:		/sys/class/powercap/.../<power zone>/constraint_X_power_limit_uw
 96Date:		September 2013
 97KernelVersion:	3.13
 98Contact:	linux-pm@vger.kernel.org
 99Description:
100		Power limit in micro-watts should be applicable for
101		the time window specified by "constraint_X_time_window_us".
102		Here "X" can have values from 0 to max integer.
103
104What:		/sys/class/powercap/.../<power zone>/constraint_X_time_window_us
105Date:		September 2013
106KernelVersion:	3.13
107Contact:	linux-pm@vger.kernel.org
108Description:
109		Time window in micro seconds. This is used along with
110		constraint_X_power_limit_uw to define a power constraint.
111		Here "X" can have values from 0 to max integer.
112
113
114What:		/sys/class/powercap/<control type>/.../constraint_X_max_power_uw
115Date:		September 2013
116KernelVersion:	3.13
117Contact:	linux-pm@vger.kernel.org
118Description:
119		Maximum allowed power in micro watts for this constraint.
120		Here "X" can have values from 0 to max integer.
121
122What:		/sys/class/powercap/<control type>/.../constraint_X_min_power_uw
123Date:		September 2013
124KernelVersion:	3.13
125Contact:	linux-pm@vger.kernel.org
126Description:
127		Minimum allowed power in micro watts for this constraint.
128		Here "X" can have values from 0 to max integer.
129
130What:		/sys/class/powercap/.../<power zone>/constraint_X_max_time_window_us
131Date:		September 2013
132KernelVersion:	3.13
133Contact:	linux-pm@vger.kernel.org
134Description:
135		Maximum allowed time window in micro seconds for this
136		constraint. Here "X" can have values from 0 to max integer.
137
138What:		/sys/class/powercap/.../<power zone>/constraint_X_min_time_window_us
139Date:		September 2013
140KernelVersion:	3.13
141Contact:	linux-pm@vger.kernel.org
142Description:
143		Minimum allowed time window in micro seconds for this
144		constraint. Here "X" can have values from 0 to max integer.
145
146What:		/sys/class/powercap/.../<power zone>/enabled
147Date:		September 2013
148KernelVersion:	3.13
149Contact:	linux-pm@vger.kernel.org
150Description:
151		This allows to enable/disable power capping at power zone level.
152		This applies to current power zone and its children.