From: David Hunt <david.hunt@intel.com>
Date: Fri, 15 Nov 2019 12:51:24 +0000 (+0000)
Subject: doc: add core queries in power example guide
X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=f433878a4fa53011a5027da76989a601717daee1;p=dpdk.git

doc: add core queries in power example guide

This patch adds some minor updates for the vm_power_manager and guest_cli
example applications.

Now that the virtio-serial channels between vm_power manager and
the guest_cli has bi-directional capability, there are some new commands.

Firstly, the command in vm_power_manager to enable queries for a given VM:

  * set_query {vm_name} enable|disable

Then, commands to query the frequencies and capabilities of the cores
in the VM:

  * query_cpu_freq {core_num}|all
  * query_cpu_caps {core_num}|all

Signed-off-by: David Hunt <david.hunt@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
---

diff --git a/doc/guides/sample_app_ug/vm_power_management.rst b/doc/guides/sample_app_ug/vm_power_management.rst
index 8de7cbe859..bb2aa4faf3 100644
--- a/doc/guides/sample_app_ug/vm_power_management.rst
+++ b/doc/guides/sample_app_ug/vm_power_management.rst
@@ -309,6 +309,12 @@ A number of commands can be issued via the CLI in relation to VMs:
 
     set_pcpu {vm_name} {vcpu} {pcpu}
 
+  Enable query of physical core information from a VM:
+
+  .. code-block:: console
+
+    set_query {vm_name} enable|disable
+
 Manual control and inspection can also be carried in relation CPU frequency scaling:
 
   Get the current frequency for each core specified in the mask:
@@ -746,6 +752,22 @@ Where {core_num} is the lcore and channel to change frequency by scaling up/down
 
   set_cpu_freq {core_num} up|down|min|max
 
+To query the available frequences of an lcore, use the query_cpu_freq command.
+Where {core_num} is the lcore to query.
+Before using this command, please enable responses via the set_query command on the host.
+
+.. code-block:: console
+
+  query_cpu_freq {core_num}|all
+
+To query the capabilities of an lcore, use the query_cpu_caps command.
+Where {core_num} is the lcore to query.
+Before using this command, please enable responses via the set_query command on the host.
+
+.. code-block:: console
+
+  query_cpu_caps {core_num}|all
+
 To start the application and configure the power policy, and send it to the host:
 
 .. code-block:: console