_sphinx.addnodesdocument)}( rawsourcechildren]( translations LanguagesNode)}(hhh](h pending_xref)}(hhh]docutils.nodesTextChinese (Simplified)}parenthsba attributes}(ids]classes]names]dupnames]backrefs] refdomainstdreftypedoc reftarget+/translations/zh_CN/power/powercap/powercapmodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget+/translations/zh_TW/power/powercap/powercapmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget+/translations/it_IT/power/powercap/powercapmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget+/translations/ja_JP/power/powercap/powercapmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget+/translations/ko_KR/power/powercap/powercapmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hPortuguese (Brazilian)}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget+/translations/pt_BR/power/powercap/powercapmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget+/translations/sp_SP/power/powercap/powercapmodnameN classnameN refexplicituh1hhh ubeh}(h]h ]h"]h$]h&]current_languageEnglishuh1h hh _documenthsourceNlineNubhsection)}(hhh](htitle)}(hPower Capping Frameworkh]hPower Capping Framework}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhE/var/lib/git/docbuild/linux/Documentation/power/powercap/powercap.rsthKubh paragraph)}(hThe power capping framework provides a consistent interface between the kernel and the user space that allows power capping drivers to expose the settings to user space in a uniform way.h]hThe power capping framework provides a consistent interface between the kernel and the user space that allows power capping drivers to expose the settings to user space in a uniform way.}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hhh](h)}(h Terminologyh]h Terminology}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhK ubh)}(hXThe framework exposes power capping devices to user space via sysfs in the form of a tree of objects. The objects at the root level of the tree represent 'control types', which correspond to different methods of power capping. For example, the intel-rapl control type represents the Intel "Running Average Power Limit" (RAPL) technology, whereas the 'idle-injection' control type corresponds to the use of idle injection for controlling power.h]hXThe framework exposes power capping devices to user space via sysfs in the form of a tree of objects. The objects at the root level of the tree represent ‘control types’, which correspond to different methods of power capping. For example, the intel-rapl control type represents the Intel “Running Average Power Limit” (RAPL) technology, whereas the ‘idle-injection’ control type corresponds to the use of idle injection for controlling power.}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK hhhhubh)}(hXSPower zones represent different parts of the system, which can be controlled and monitored using the power capping method determined by the control type the given zone belongs to. They each contain attributes for monitoring power, as well as controls represented in the form of power constraints. If the parts of the system represented by different power zones are hierarchical (that is, one bigger part consists of multiple smaller parts that each have their own power controls), those power zones may also be organized in a hierarchy with one parent power zone containing multiple subzones and so on to reflect the power control topology of the system. In that case, it is possible to apply power capping to a set of devices together using the parent power zone and if more fine grained control is required, it can be applied through the subzones.h]hXSPower zones represent different parts of the system, which can be controlled and monitored using the power capping method determined by the control type the given zone belongs to. They each contain attributes for monitoring power, as well as controls represented in the form of power constraints. If the parts of the system represented by different power zones are hierarchical (that is, one bigger part consists of multiple smaller parts that each have their own power controls), those power zones may also be organized in a hierarchy with one parent power zone containing multiple subzones and so on to reflect the power control topology of the system. In that case, it is possible to apply power capping to a set of devices together using the parent power zone and if more fine grained control is required, it can be applied through the subzones.}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hExample sysfs interface tree::h]hExample sysfs interface tree:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK hhhhubh literal_block)}(hX/sys/devices/virtual/powercap └──intel-rapl ├──intel-rapl:0 │   ├──constraint_0_name │   ├──constraint_0_power_limit_uw │   ├──constraint_0_time_window_us │   ├──constraint_1_name │   ├──constraint_1_power_limit_uw │   ├──constraint_1_time_window_us │   ├──device -> ../../intel-rapl │   ├──energy_uj │   ├──intel-rapl:0:0 │   │   ├──constraint_0_name │   │   ├──constraint_0_power_limit_uw │   │   ├──constraint_0_time_window_us │   │   ├──constraint_1_name │   │   ├──constraint_1_power_limit_uw │   │   ├──constraint_1_time_window_us │   │   ├──device -> ../../intel-rapl:0 │   │   ├──energy_uj │   │   ├──max_energy_range_uj │   │   ├──name │   │   ├──enabled │   │   ├──power │   │   │   ├──async │   │   │   [] │   │   ├──subsystem -> ../../../../../../class/power_cap │   │   └──uevent │   ├──intel-rapl:0:1 │   │   ├──constraint_0_name │   │   ├──constraint_0_power_limit_uw │   │   ├──constraint_0_time_window_us │   │   ├──constraint_1_name │   │   ├──constraint_1_power_limit_uw │   │   ├──constraint_1_time_window_us │   │   ├──device -> ../../intel-rapl:0 │   │   ├──energy_uj │   │   ├──max_energy_range_uj │   │   ├──name │   │   ├──enabled │   │   ├──power │   │   │   ├──async │   │   │   [] │   │   ├──subsystem -> ../../../../../../class/power_cap │   │   └──uevent │   ├──max_energy_range_uj │   ├──max_power_range_uw │   ├──name │   ├──enabled │   ├──power │   │   ├──async │   │   [] │   ├──subsystem -> ../../../../../class/power_cap │   ├──enabled │   ├──uevent ├──intel-rapl:1 │   ├──constraint_0_name │   ├──constraint_0_power_limit_uw │   ├──constraint_0_time_window_us │   ├──constraint_1_name │   ├──constraint_1_power_limit_uw │   ├──constraint_1_time_window_us │   ├──device -> ../../intel-rapl │   ├──energy_uj │   ├──intel-rapl:1:0 │   │   ├──constraint_0_name │   │   ├──constraint_0_power_limit_uw │   │   ├──constraint_0_time_window_us │   │   ├──constraint_1_name │   │   ├──constraint_1_power_limit_uw │   │   ├──constraint_1_time_window_us │   │   ├──device -> ../../intel-rapl:1 │   │   ├──energy_uj │   │   ├──max_energy_range_uj │   │   ├──name │   │   ├──enabled │   │   ├──power │   │   │   ├──async │   │   │   [] │   │   ├──subsystem -> ../../../../../../class/power_cap │   │   └──uevent │   ├──intel-rapl:1:1 │   │   ├──constraint_0_name │   │   ├──constraint_0_power_limit_uw │   │   ├──constraint_0_time_window_us │   │   ├──constraint_1_name │   │   ├──constraint_1_power_limit_uw │   │   ├──constraint_1_time_window_us │   │   ├──device -> ../../intel-rapl:1 │   │   ├──energy_uj │   │   ├──max_energy_range_uj │   │   ├──name │   │   ├──enabled │   │   ├──power │   │   │   ├──async │   │   │   [] │   │   ├──subsystem -> ../../../../../../class/power_cap │   │   └──uevent │   ├──max_energy_range_uj │   ├──max_power_range_uw │   ├──name │   ├──enabled │   ├──power │   │   ├──async │   │   [] │   ├──subsystem -> ../../../../../class/power_cap │   ├──uevent ├──power │   ├──async │   [] ├──subsystem -> ../../../../class/power_cap ├──enabled └──ueventh]hX/sys/devices/virtual/powercap └──intel-rapl ├──intel-rapl:0 │   ├──constraint_0_name │   ├──constraint_0_power_limit_uw │   ├──constraint_0_time_window_us │   ├──constraint_1_name │   ├──constraint_1_power_limit_uw │   ├──constraint_1_time_window_us │   ├──device -> ../../intel-rapl │   ├──energy_uj │   ├──intel-rapl:0:0 │   │   ├──constraint_0_name │   │   ├──constraint_0_power_limit_uw │   │   ├──constraint_0_time_window_us │   │   ├──constraint_1_name │   │   ├──constraint_1_power_limit_uw │   │   ├──constraint_1_time_window_us │   │   ├──device -> ../../intel-rapl:0 │   │   ├──energy_uj │   │   ├──max_energy_range_uj │   │   ├──name │   │   ├──enabled │   │   ├──power │   │   │   ├──async │   │   │   [] │   │   ├──subsystem -> ../../../../../../class/power_cap │   │   └──uevent │   ├──intel-rapl:0:1 │   │   ├──constraint_0_name │   │   ├──constraint_0_power_limit_uw │   │   ├──constraint_0_time_window_us │   │   ├──constraint_1_name │   │   ├──constraint_1_power_limit_uw │   │   ├──constraint_1_time_window_us │   │   ├──device -> ../../intel-rapl:0 │   │   ├──energy_uj │   │   ├──max_energy_range_uj │   │   ├──name │   │   ├──enabled │   │   ├──power │   │   │   ├──async │   │   │   [] │   │   ├──subsystem -> ../../../../../../class/power_cap │   │   └──uevent │   ├──max_energy_range_uj │   ├──max_power_range_uw │   ├──name │   ├──enabled │   ├──power │   │   ├──async │   │   [] │   ├──subsystem -> ../../../../../class/power_cap │   ├──enabled │   ├──uevent ├──intel-rapl:1 │   ├──constraint_0_name │   ├──constraint_0_power_limit_uw │   ├──constraint_0_time_window_us │   ├──constraint_1_name │   ├──constraint_1_power_limit_uw │   ├──constraint_1_time_window_us │   ├──device -> ../../intel-rapl │   ├──energy_uj │   ├──intel-rapl:1:0 │   │   ├──constraint_0_name │   │   ├──constraint_0_power_limit_uw │   │   ├──constraint_0_time_window_us │   │   ├──constraint_1_name │   │   ├──constraint_1_power_limit_uw │   │   ├──constraint_1_time_window_us │   │   ├──device -> ../../intel-rapl:1 │   │   ├──energy_uj │   │   ├──max_energy_range_uj │   │   ├──name │   │   ├──enabled │   │   ├──power │   │   │   ├──async │   │   │   [] │   │   ├──subsystem -> ../../../../../../class/power_cap │   │   └──uevent │   ├──intel-rapl:1:1 │   │   ├──constraint_0_name │   │   ├──constraint_0_power_limit_uw │   │   ├──constraint_0_time_window_us │   │   ├──constraint_1_name │   │   ├──constraint_1_power_limit_uw │   │   ├──constraint_1_time_window_us │   │   ├──device -> ../../intel-rapl:1 │   │   ├──energy_uj │   │   ├──max_energy_range_uj │   │   ├──name │   │   ├──enabled │   │   ├──power │   │   │   ├──async │   │   │   [] │   │   ├──subsystem -> ../../../../../../class/power_cap │   │   └──uevent │   ├──max_energy_range_uj │   ├──max_power_range_uw │   ├──name │   ├──enabled │   ├──power │   │   ├──async │   │   [] │   ├──subsystem -> ../../../../../class/power_cap │   ├──uevent ├──power │   ├──async │   [] ├──subsystem -> ../../../../class/power_cap ├──enabled └──uevent}hjsbah}(h]h ]h"]h$]h&] xml:spacepreserveuh1jhhhK"hhhhubh)}(hXThe above example illustrates a case in which the Intel RAPL technology, available in Intel® IA-64 and IA-32 Processor Architectures, is used. There is one control type called intel-rapl which contains two power zones, intel-rapl:0 and intel-rapl:1, representing CPU packages. Each of these power zones contains two subzones, intel-rapl:j:0 and intel-rapl:j:1 (j = 0, 1), representing the "core" and the "uncore" parts of the given CPU package, respectively. All of the zones and subzones contain energy monitoring attributes (energy_uj, max_energy_range_uj) and constraint attributes (constraint_*) allowing controls to be applied (the constraints in the 'package' power zones apply to the whole CPU packages and the subzone constraints only apply to the respective parts of the given package individually). Since Intel RAPL doesn't provide instantaneous power value, there is no power_uw attribute.h]hXThe above example illustrates a case in which the Intel RAPL technology, available in Intel® IA-64 and IA-32 Processor Architectures, is used. There is one control type called intel-rapl which contains two power zones, intel-rapl:0 and intel-rapl:1, representing CPU packages. Each of these power zones contains two subzones, intel-rapl:j:0 and intel-rapl:j:1 (j = 0, 1), representing the “core” and the “uncore” parts of the given CPU package, respectively. All of the zones and subzones contain energy monitoring attributes (energy_uj, max_energy_range_uj) and constraint attributes (constraint_*) allowing controls to be applied (the constraints in the ‘package’ power zones apply to the whole CPU packages and the subzone constraints only apply to the respective parts of the given package individually). Since Intel RAPL doesn’t provide instantaneous power value, there is no power_uw attribute.}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hIn addition to that, each power zone contains a name attribute, allowing the part of the system represented by that zone to be identified. For example::h]hIn addition to that, each power zone contains a name attribute, allowing the part of the system represented by that zone to be identified. For example:}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubj)}(h5cat /sys/class/power_cap/intel-rapl/intel-rapl:0/nameh]h5cat /sys/class/power_cap/intel-rapl/intel-rapl:0/name}hjDsbah}(h]h ]h"]h$]h&]j&j'uh1jhhhKhhhhubh)}(hhh](h)}(h package-0h]h package-0}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjRhhhhhKubh)}(hXDepending on different power zones, the Intel RAPL technology allows one or multiple constraints like short term, long term and peak power, with different time windows to be applied to each power zone. All the zones contain attributes representing the constraint names, power limits and the sizes of the time windows. Note that time window is not applicable to peak power. Here, constraint_j_* attributes correspond to the jth constraint (j = 0,1,2).h]hXDepending on different power zones, the Intel RAPL technology allows one or multiple constraints like short term, long term and peak power, with different time windows to be applied to each power zone. All the zones contain attributes representing the constraint names, power limits and the sizes of the time windows. Note that time window is not applicable to peak power. Here, constraint_j_* attributes correspond to the jth constraint (j = 0,1,2).}(hjchhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjRhhubh)}(h For example::h]h For example:}(hjqhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjRhhubj)}(hconstraint_0_name constraint_0_power_limit_uw constraint_0_time_window_us constraint_1_name constraint_1_power_limit_uw constraint_1_time_window_us constraint_2_name constraint_2_power_limit_uw constraint_2_time_window_ush]hconstraint_0_name constraint_0_power_limit_uw constraint_0_time_window_us constraint_1_name constraint_1_power_limit_uw constraint_1_time_window_us constraint_2_name constraint_2_power_limit_uw constraint_2_time_window_us}hjsbah}(h]h ]h"]h$]h&]j&j'uh1jhhhKhjRhhubeh}(h] package-0ah ]h"] package-0ah$]h&]uh1hhhhhhhhKubeh}(h] terminologyah ]h"] terminologyah$]h&]uh1hhhhhhhhK ubh)}(hhh](h)}(hPower Zone Attributesh]hPower Zone Attributes}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKubh)}(hhh](h)}(hMonitoring attributesh]hMonitoring attributes}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKubhdefinition_list)}(hhh](hdefinition_list_item)}(henergy_uj (rw) Current energy counter in micro joules. Write "0" to reset. If the counter can not be reset, then this attribute is read only. h](hterm)}(henergy_uj (rw)h]henergy_uj (rw)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjubh definition)}(hhh]h)}(h~Current energy counter in micro joules. Write "0" to reset. If the counter can not be reset, then this attribute is read only.h]hCurrent energy counter in micro joules. Write “0” to reset. If the counter can not be reset, then this attribute is read only.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hLmax_energy_range_uj (ro) Range of the above energy counter in micro-joules. h](j)}(hmax_energy_range_uj (ro)h]hmax_energy_range_uj (ro)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hhh]h)}(h2Range of the above energy counter in micro-joules.h]h2Range of the above energy counter in micro-joules.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhKhjhhubj)}(h,power_uw (ro) Current power in micro watts. h](j)}(h power_uw (ro)h]h power_uw (ro)}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhj(ubj)}(hhh]h)}(hCurrent power in micro watts.h]hCurrent power in micro watts.}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj:ubah}(h]h ]h"]h$]h&]uh1jhj(ubeh}(h]h ]h"]h$]h&]uh1jhhhKhjhhubj)}(hGmax_power_range_uw (ro) Range of the above power value in micro-watts. h](j)}(hmax_power_range_uw (ro)h]hmax_power_range_uw (ro)}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjWubj)}(hhh]h)}(h.Range of the above power value in micro-watts.h]h.Range of the above power value in micro-watts.}(hjlhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjiubah}(h]h ]h"]h$]h&]uh1jhjWubeh}(h]h ]h"]h$]h&]uh1jhhhKhjhhubj)}(h#name (ro) Name of this power zone. h](j)}(h name (ro)h]h name (ro)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hhh]h)}(hName of this power zone.h]hName of this power zone.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhKhjhhubeh}(h]h ]h"]h$]h&]uh1jhjhhhhhNubh)}(hrIt is possible that some domains have both power ranges and energy counter ranges; however, only one is mandatory.h]hrIt is possible that some domains have both power ranges and energy counter ranges; however, only one is mandatory.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubeh}(h]monitoring-attributesah ]h"]monitoring attributesah$]h&]uh1hhjhhhhhKubh)}(hhh](h)}(h Constraintsh]h Constraints}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKubj)}(hhh](j)}(hconstraint_X_power_limit_uw (rw) Power limit in micro watts, which should be applicable for the time window specified by "constraint_X_time_window_us". h](j)}(h constraint_X_power_limit_uw (rw)h]h constraint_X_power_limit_uw (rw)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hhh]h)}(hvPower limit in micro watts, which should be applicable for the time window specified by "constraint_X_time_window_us".h]hzPower limit in micro watts, which should be applicable for the time window specified by “constraint_X_time_window_us”.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(h?constraint_X_time_window_us (rw) Time window in micro seconds. h](j)}(h constraint_X_time_window_us (rw)h]h constraint_X_time_window_us (rw)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hhh]h)}(hTime window in micro seconds.h]hTime window in micro seconds.}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj&ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhKhjhhubj)}(h:constraint_X_name (ro) An optional name of the constraint h](j)}(hconstraint_X_name (ro)h]hconstraint_X_name (ro)}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjCubj)}(hhh]h)}(h"An optional name of the constrainth]h"An optional name of the constraint}(hjXhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjUubah}(h]h ]h"]h$]h&]uh1jhjCubeh}(h]h ]h"]h$]h&]uh1jhhhKhjhhubj)}(hDconstraint_X_max_power_uw(ro) Maximum allowed power in micro watts. h](j)}(hconstraint_X_max_power_uw(ro)h]hconstraint_X_max_power_uw(ro)}(hjvhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjrubj)}(hhh]h)}(h%Maximum allowed power in micro watts.h]h%Maximum allowed power in micro watts.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjrubeh}(h]h ]h"]h$]h&]uh1jhhhKhjhhubj)}(hDconstraint_X_min_power_uw(ro) Minimum allowed power in micro watts. h](j)}(hconstraint_X_min_power_uw(ro)h]hconstraint_X_min_power_uw(ro)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hhh]h)}(h%Minimum allowed power in micro watts.h]h%Minimum allowed power in micro watts.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhKhjhhubj)}(hRconstraint_X_max_time_window_us(ro) Maximum allowed time window in micro seconds. h](j)}(h#constraint_X_max_time_window_us(ro)h]h#constraint_X_max_time_window_us(ro)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hhh]h)}(h-Maximum allowed time window in micro seconds.h]h-Maximum allowed time window in micro seconds.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhKhjhhubj)}(hRconstraint_X_min_time_window_us(ro) Minimum allowed time window in micro seconds. h](j)}(h#constraint_X_min_time_window_us(ro)h]h#constraint_X_min_time_window_us(ro)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKhjubj)}(hhh]h)}(h-Minimum allowed time window in micro seconds.h]h-Minimum allowed time window in micro seconds.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhKhjhhubeh}(h]h ]h"]h$]h&]uh1jhjhhhhhNubh)}(hCExcept power_limit_uw and time_window_us other fields are optional.h]hCExcept power_limit_uw and time_window_us other fields are optional.}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubeh}(h] constraintsah ]h"] constraintsah$]h&]uh1hhjhhhhhKubh)}(hhh](h)}(h'Common zone and control type attributesh]h'Common zone and control type attributes}(hjMhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjJhhhhhKubh)}(hZenabled (rw): Enable/Disable controls at zone level or for all zones using a control type.h]hZenabled (rw): Enable/Disable controls at zone level or for all zones using a control type.}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjJhhubeh}(h]'common-zone-and-control-type-attributesah ]h"]'common zone and control type attributesah$]h&]uh1hhjhhhhhKubeh}(h]power-zone-attributesah ]h"]power zone attributesah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(h!Power Cap Client Driver Interfaceh]h!Power Cap Client Driver Interface}(hj|hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjyhhhhhKubh)}(hThe API summary:h]hThe API summary:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjyhhubh)}(hXCall powercap_register_control_type() to register control type object. Call powercap_register_zone() to register a power zone (under a given control type), either as a top-level power zone or as a subzone of another power zone registered earlier. The number of constraints in a power zone and the corresponding callbacks have to be defined prior to calling powercap_register_zone() to register that zone.h]hXCall powercap_register_control_type() to register control type object. Call powercap_register_zone() to register a power zone (under a given control type), either as a top-level power zone or as a subzone of another power zone registered earlier. The number of constraints in a power zone and the corresponding callbacks have to be defined prior to calling powercap_register_zone() to register that zone.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjyhhubh)}(hTo Free a power zone call powercap_unregister_zone(). To free a control type object call powercap_unregister_control_type(). Detailed API can be generated using kernel-doc on include/linux/powercap.h.h]hTo Free a power zone call powercap_unregister_zone(). To free a control type object call powercap_unregister_control_type(). Detailed API can be generated using kernel-doc on include/linux/powercap.h.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjyhhubeh}(h]!power-cap-client-driver-interfaceah ]h"]!power cap client driver interfaceah$]h&]uh1hhhhhhhhKubeh}(h]power-capping-frameworkah ]h"]power capping frameworkah$]h&]uh1hhhhhhhhKubeh}(h]h ]h"]h$]h&]sourcehuh1hcurrent_sourceN current_lineNsettingsdocutils.frontendValues)}(hN generatorN datestampN source_linkN source_urlN toc_backlinksentryfootnote_backlinksK sectnum_xformKstrip_commentsNstrip_elements_with_classesN strip_classesN report_levelK halt_levelKexit_status_levelKdebugNwarning_streamN tracebackinput_encoding utf-8-siginput_encoding_error_handlerstrictoutput_encodingutf-8output_encoding_error_handlerjerror_encodingutf-8error_encoding_error_handlerbackslashreplace language_codeenrecord_dependenciesNconfigN id_prefixhauto_id_prefixid dump_settingsNdump_internalsNdump_transformsNdump_pseudo_xmlNexpose_internalsNstrict_visitorN_disable_configN_sourcehʌ _destinationN _config_files]7/var/lib/git/docbuild/linux/Documentation/docutils.confafile_insertion_enabled raw_enabledKline_length_limitM'pep_referencesN pep_base_urlhttps://peps.python.org/pep_file_url_templatepep-%04drfc_referencesN rfc_base_url&https://datatracker.ietf.org/doc/html/ tab_widthKtrim_footnote_reference_spacesyntax_highlightlong smart_quotessmartquotes_locales]character_level_inline_markupdoctitle_xform docinfo_xformKsectsubtitle_xform image_loadinglinkembed_stylesheetcloak_email_addressessection_self_linkenvNubreporterNindirect_targets]substitution_defs}substitution_names}refnames}refids}nameids}(jjjjjjjvjsjjjGjDjnjkjju nametypes}(jjjjvjjGjnjuh}(jhjhjjRjsjjjjDjjkjJjjyu footnote_refs} citation_refs} autofootnotes]autofootnote_refs]symbol_footnotes]symbol_footnote_refs] footnotes] citations]autofootnote_startKsymbol_footnote_startK id_counter collectionsCounter}Rparse_messages]transform_messages] transformerN include_log] decorationNhhub.