[1/2] doc/power: library can now use intel-pstate

Message ID 20190115141701.53956-1-david.hunt@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series [1/2] doc/power: library can now use intel-pstate |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Hunt, David Jan. 15, 2019, 2:17 p.m. UTC
  With the addition of the patchset to allow auto-detection and use
of the intel_pstate kernel driver instead of the acpi-cpufreq kernel
driver, we need to reflect this in the documentation.

Now, instead of telling the user to disable intel_pstate in all cases,
it is now an optional step, should the user want to use acpi-cpufreq.

Signed-off-by: David Hunt <david.hunt@intel.com>
---
 doc/guides/sample_app_ug/vm_power_management.rst | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)
  

Comments

Kovacevic, Marko Jan. 17, 2019, 10:57 a.m. UTC | #1
Acked-by: Marko Kovacevic <marko.kovacevic@intel.com>
  
Thomas Monjalon Jan. 20, 2019, 1:46 p.m. UTC | #2
15/01/2019 15:17, David Hunt:
> With the addition of the patchset to allow auto-detection and use
> of the intel_pstate kernel driver instead of the acpi-cpufreq kernel
> driver, we need to reflect this in the documentation.
> 
> Now, instead of telling the user to disable intel_pstate in all cases,
> it is now an optional step, should the user want to use acpi-cpufreq.
> 
> Signed-off-by: David Hunt <david.hunt@intel.com>

Applied with release notes squashed, thanks
  

Patch

diff --git a/doc/guides/sample_app_ug/vm_power_management.rst b/doc/guides/sample_app_ug/vm_power_management.rst
index 5be9f24d5..14d432e78 100644
--- a/doc/guides/sample_app_ug/vm_power_management.rst
+++ b/doc/guides/sample_app_ug/vm_power_management.rst
@@ -131,10 +131,15 @@  can be accessed.
 Host Operating System
 ~~~~~~~~~~~~~~~~~~~~~
 
-The Host OS must also have the *apci_cpufreq* module installed, in some cases
-the *intel_pstate* driver may be the default Power Management environment.
-To enable *acpi_cpufreq* and disable *intel_pstate*, add the following
-to the grub Linux command line:
+The DPDK Power Library can use either the *acpi_cpufreq* or *intel_pstate*
+kernel driver for the management of core frequencies. In many cases
+the *intel_pstate* driver is the default Power Management environment.
+
+Should the *acpi-cpufreq* driver be required, the *intel_pstate* module must
+be disabled, and *apci_cpufreq* module loaded in its place.
+
+To disable *intel_pstate* driver, add the following to the grub Linux
+command line:
 
 .. code-block:: console