path: root/doc/guides/nics
diff options
authorQiming Yang <>2019-10-17 02:33:53 +0800
committerFerruh Yigit <>2019-10-23 16:43:09 +0200
commit0998c89a856410881378a15f268f18a7c65e02ed (patch)
treee19647e270c95a8d47e50e78ae478b3003ef4060 /doc/guides/nics
parent23ecda2aa5023e4d04c8ed61fb1210c5bc92ac2e (diff)
net/ice: add devargs to control pipeline mode
Added a devarg to control the mode in generic flow API. We use none-pipeline mode by default. Signed-off-by: Qiming Yang <> Acked-by: Qi Zhang <> Reviewed-by: Xiaolong Ye <>
Diffstat (limited to 'doc/guides/nics')
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/guides/nics/ice.rst b/doc/guides/nics/ice.rst
index 641f348..933f634 100644
--- a/doc/guides/nics/ice.rst
+++ b/doc/guides/nics/ice.rst
@@ -61,6 +61,25 @@ Runtime Config Options
NOTE: In Safe mode, only very limited features are available, features like RSS,
checksum, fdir, tunneling ... are all disabled.
+- ``Generic Flow Pipeline Mode Support`` (default ``0``)
+ In pipeline mode, a flow can be set at one specific stage by setting parameter
+ ``priority``. Currently, we support two stages: priority = 0 or !0. Flows with
+ priority 0 located at the first pipeline stage which typically be used as a firewall
+ to drop the packet on a blacklist(we called it permission stage). At this stage,
+ flow rules are created for the device's exact match engine: switch. Flows with priority
+ !0 located at the second stage, typically packets are classified here and be steered to
+ specific queue or queue group (we called it distribution stage), At this stage, flow
+ rules are created for device's flow director engine.
+ For none-pipeline mode, ``priority`` is ignored, a flow rule can be created as a flow director
+ rule or a switch rule depends on its pattern/action and the resource allocation situation,
+ all flows are virtually at the same pipeline stage.
+ By default, generic flow API is enabled in none-pipeline mode, user can choose to
+ use pipeline mode by setting ``devargs`` parameter ``pipeline-mode-support``,
+ for example::
+ -w 80:00.0,pipeline-mode-support=1
- ``Protocol extraction for per queue``
Configure the RX queues to do protocol extraction into ``rte_mbuf::udata64``