[v6,4/4] doc/guides/sample_app_ug/l3_forward_power_man.rst: empty poll update

Message ID 1535727871-30168-4-git-send-email-liang.j.ma@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series [v6,1/4] lib/librte_power: traffic pattern aware power control |

Checks

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

Commit Message

Liang, Ma Aug. 31, 2018, 3:04 p.m. UTC
  add empty poll mode command line example

Signed-off-by: Liang Ma <liang.j.ma@intel.com>
---
 doc/guides/sample_app_ug/l3_forward_power_man.rst | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
  

Patch

diff --git a/doc/guides/sample_app_ug/l3_forward_power_man.rst b/doc/guides/sample_app_ug/l3_forward_power_man.rst
index 795a570..7bea0a8 100644
--- a/doc/guides/sample_app_ug/l3_forward_power_man.rst
+++ b/doc/guides/sample_app_ug/l3_forward_power_man.rst
@@ -362,3 +362,24 @@  The algorithm has the following sleeping behavior depending on the idle counter:
 If a thread polls multiple Rx queues and different queue returns different sleep duration values,
 the algorithm controls the sleep time in a conservative manner by sleeping for the least possible time
 in order to avoid a potential performance impact.
+
+Empty Poll Mode
+-------------------------
+There is a new Mode which is added recently. Empty poll mode can be enabled by
+command option --empty-poll.
+
+See "Power Management" chapter in the DPDK Programmer's Guide for empty poll mode details.
+
+.. code-block:: console
+
+    ./l3fwd-power -l xxx   -n 4   -w 0000:xx:00.0 -w 0000:xx:00.1 -- -p 0x3 -P --config="(0,0,xx),(1,0,xx)" --empty-poll -l 14 -m 9 -h 1
+
+Where,
+
+--empty-poll: Enable the empty poll mode instead of original algorithm
+
+-l : optional, set up the LOW power state frequency index
+
+-m : optional, set up the MED power state frequency index
+
+-h : optional, set up the HIGH power state frequency index