doc: add cryptodev sample code
[dpdk.git] / doc / guides / sample_app_ug / vm_power_management.rst
index 16f44c4..05c26b0 100644 (file)
@@ -72,13 +72,14 @@ The solution is comprised of two high-level components:
    the APCI cpufreq sysfs interface used on the host.
 
    The l3fwd-power application will use this implementation when deployed on a VM
-   (see Chapter 11 "L3 Forwarding with Power Management Application").
+   (see :doc:`l3_forward_power_man`).
 
-.. _figure_24:
+.. _figure_vm_power_mgr_highlevel:
 
-**Figure 24. Highlevel Solution**
+.. figure:: img/vm_power_mgr_highlevel.*
+
+   Highlevel Solution
 
-|vm_power_mgr_highlevel|
 
 Overview
 --------
@@ -105,11 +106,12 @@ at runtime based on the environment.
 Upon receiving a request, the host translates the vCPU to a pCPU via
 the libvirt API before forwarding to the host librte_power.
 
-.. _figure_25:
+.. _figure_vm_power_mgr_vm_request_seq:
+
+.. figure:: img/vm_power_mgr_vm_request_seq.*
 
-**Figure 25. VM request to scale frequency**
+   VM request to scale frequency
 
-|vm_power_mgr_vm_request_seq|
 
 Performance Considerations
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -139,7 +141,7 @@ 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:
+to the grub Linux command line:
 
 .. code-block:: console
 
@@ -165,7 +167,7 @@ Virtio-Serial channels are configured via libvirt XML:
   </controller>
   <channel type='unix'>
     <source mode='bind' path='/tmp/powermonitor/{vm_name}.{channel_num}'/>
-    <target type='virtio' name='virtio.serial.port.poweragent.{vm_channel_num}/>
+    <target type='virtio' name='virtio.serial.port.poweragent.{vm_channel_num}'/>
     <address type='virtio-serial' controller='0' bus='0' port='{N}'/>
   </channel>
 
@@ -218,9 +220,9 @@ on cores 0 & 1 on a system with 4 memory channels:
 
 .. code-block:: console
 
- ./build/vm_power_mgr -c 0x3 -n 4
+ ./build/vm_power_mgr -l 0-1 -n 4
 
-After successful initialisation the user is presented with VM Power Manager CLI:
+After successful initialization the user is presented with VM Power Manager CLI:
 
 .. code-block:: console
 
@@ -312,7 +314,7 @@ Manual control and inspection can also be carried in relation CPU frequency scal
 Compiling and Running the Guest Applications
 --------------------------------------------
 
-For compiling and running l3fwd-power, see Chapter 11 "L3 Forwarding with Power Management Application".
+For compiling and running l3fwd-power, see :doc:`l3_forward_power_man`.
 
 A guest CLI is also provided for validating the setup.
 
@@ -340,10 +342,10 @@ for example to run on cores 0,1,2,3 on a system with 4 memory channels:
 
 .. code-block:: console
 
- ./build/guest_vm_power_mgr -c 0xf -n 4
+ ./build/guest_vm_power_mgr -l 0-3 -n 4
 
 
-After successful initialisation the user is presented with VM Power Manager Guest CLI:
+After successful initialization the user is presented with VM Power Manager Guest CLI:
 
 .. code-block:: console
 
@@ -355,7 +357,3 @@ Where {core_num} is the lcore and channel to change frequency by scaling up/down
 .. code-block:: console
 
   set_cpu_freq {core_num} up|down|min|max
-
-.. |vm_power_mgr_highlevel| image:: img/vm_power_mgr_highlevel.svg
-
-.. |vm_power_mgr_vm_request_seq| image:: img/vm_power_mgr_vm_request_seq.svg