Signed-off-by: Jan Tluka <jtluka(a)redhat.com>
---
.../disable_idlestates_mixin.rst | 6 ++++++
docs/source/config_mixins.rst | 1 +
.../ENRT/ConfigMixins/DisableIdleStatesMixin.py | 15 +++++++++++++++
3 files changed, 22 insertions(+)
create mode 100644 docs/source/config_mixin_classes/disable_idlestates_mixin.rst
diff --git a/docs/source/config_mixin_classes/disable_idlestates_mixin.rst
b/docs/source/config_mixin_classes/disable_idlestates_mixin.rst
new file mode 100644
index 00000000..48042da9
--- /dev/null
+++ b/docs/source/config_mixin_classes/disable_idlestates_mixin.rst
@@ -0,0 +1,6 @@
+DisableIdleStatesMixin
+======================
+
+.. autoclass::
lnst.Recipes.ENRT.ConfigMixins.DisableIdleStatesMixin.DisableIdleStatesMixin
+ :members:
+ :show-inheritance:
diff --git a/docs/source/config_mixins.rst b/docs/source/config_mixins.rst
index 53451190..240f3f9d 100644
--- a/docs/source/config_mixins.rst
+++ b/docs/source/config_mixins.rst
@@ -14,3 +14,4 @@ ENRT Config Mixins
config_mixin_classes/pause_frames_mixin
config_mixin_classes/perf_reverse_mixin.rst
config_mixin_classes/disable_turboboost_mixin.rst
+ config_mixin_classes/disable_idlestates_mixin.rst
diff --git a/lnst/Recipes/ENRT/ConfigMixins/DisableIdleStatesMixin.py
b/lnst/Recipes/ENRT/ConfigMixins/DisableIdleStatesMixin.py
index ca45dfb3..45fc95a8 100644
--- a/lnst/Recipes/ENRT/ConfigMixins/DisableIdleStatesMixin.py
+++ b/lnst/Recipes/ENRT/ConfigMixins/DisableIdleStatesMixin.py
@@ -2,6 +2,21 @@ from lnst.Common.Parameters import IntParam
from lnst.Recipes.ENRT.ConfigMixins import BaseSubConfigMixin
class DisableIdleStatesMixin(BaseSubConfigMixin):
+ """
+ This mixin class is an extension to the :any:`BaseEnrtRecipe` class that can
+ be used to control the CPU idle states before running the tests.
+
+ Any recipe that wants to use the mixin must define the
+ :attr:`disable_idlestates_host_list` property first.
+
+ :param minimal_idlestates_latency:
+ (optional test parameter) an integer, the value is passed as the latency
+ argument of the **'cpupower idle-set -D'** command that will disable
+ all idle states with an equal or higher latency than the specified value
+ on all hosts defined by :attr:`disable_idlestates_host_list` property.
+ If the value is 0 this will effectively disable all CPU idle states.
+ """
+
minimal_idlestates_latency = IntParam()
@property
--
2.21.3