diff mbox series

[v1] doc/power: add commands for core query from VM

Message ID 20191115125124.6941-1-david.hunt@intel.com (mailing list archive)
State Accepted, archived
Delegated to: David Marchand
Headers
Series [v1] doc/power: add commands for core query from VM |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/travis-robot warning Travis build: failed

Commit Message

Hunt, David Nov. 15, 2019, 12:51 p.m. UTC 
  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>
---
 .../sample_app_ug/vm_power_management.rst     | 23 +++++++++++++++++++
 1 file changed, 23 insertions(+)

Comments

John McNamara Nov. 15, 2019, 1:05 p.m. UTC | #1 
> -----Original Message-----
> From: Hunt, David <david.hunt@intel.com>
> Sent: Friday, November 15, 2019 12:51 PM
> To: dev@dpdk.org
> Cc: Mcnamara, John <john.mcnamara@intel.com>; Hunt, David
> <david.hunt@intel.com>
> Subject: [PATCH v1] doc/power: add commands for core query from VM
> 


Acked-by: John McNamara <john.mcnamara@intel.com>
David Marchand Nov. 26, 2019, 4:35 p.m. UTC | #2 
On Fri, Nov 15, 2019 at 1:52 PM David Hunt <david.hunt@intel.com> wrote:
>
> 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>

Applied, thanks.


--
David Marchand
diff mbox series

Patch

diff --git a/doc/guides/sample_app_ug/vm_power_management.rst b/doc/guides/sample_app_ug/vm_power_management.rst
index 0ffff835e..f5e24b25d 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,23 @@  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