[dpdk-dev] [PATCH v8 4/4] doc/guides/sample_app_ug/l3_forward_power_man.rst: empty poll update

[Liang Ma]

Add empty poll mode command line example

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

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..ca9c70a 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,32 @@ 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="0,0,0" -l 14 -m 9 -h 1
+
+Where,
+
+--empty-poll: Enable the empty poll mode instead of original algorithm
+
+--empty-poll="training_flag, med_threshold, high_threshold"
+
+* training_flag : optional, enable/disable training mode. Default value is 0.
+
+* med_threshold : optional, indicate the empty poll threshold of modest state which is customized by user. Default value is 0.
+
+* high_threshold : optional, indicate the empty poll threshold of busy state which is customized by user. Default value is 0.
+
+* -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
-- 
2.7.5