common/cnxk: enable backpressure on CPT with inline inbound

[dpdk.git] / doc / guides / nics / cnxk.rst

diff --git a/doc/guides/nics/cnxk.rst b/doc/guides/nics/cnxk.rst
index b542437..837ffc0 100644 (file)
--- a/doc/guides/nics/cnxk.rst
+++ b/doc/guides/nics/cnxk.rst
@@ -35,6 +35,7 @@ Features of the CNXK Ethdev PMD are:
 - Debug utilities - Context dump and error interrupt support
 - Support Rx interrupt
 - Inline IPsec processing support
+- Ingress meter support
 
 Prerequisites
 -------------
@@ -231,7 +232,7 @@ Runtime Config Options
 
       -a 0002:02:00.0,outb_nb_crypto_qs=2
 
-   With the above confiuration, two CPT LF's are setup and distributed among
+   With the above configuration, two CPT LF's are setup and distributed among
    all the Tx queues for outbound processing.
 
 - ``Force using inline ipsec device for inbound`` (default ``0``)
@@ -255,6 +256,26 @@ Runtime Config Options
    With the above configuration, inbound encrypted traffic from both the ports
    is received by ipsec inline device.
 
+- ``Inline IPsec device channel and mask`` (default ``none``)
+
+   Set channel and channel mask configuration for the inline IPSec device. This
+   will be used when creating flow rules with RTE_FLOW_ACTION_TYPE_SECURITY
+   action.
+
+   By default, RTE Flow API sets the channel number of the port on which the
+   rule is created in the MCAM entry and matches it exactly. This behaviour can
+   be modified using the ``inl_cpt_channel`` ``devargs`` parameter.
+
+   For example::
+
+      -a 0002:1d:00.0,inl_cpt_channel=0x100/0xf00
+
+   With the above configuration, RTE Flow rules API will set the channel
+   and channel mask as 0x100 and 0xF00 in the MCAM entries of the  flow rules
+   created with RTE_FLOW_ACTION_TYPE_SECURITY action. Since channel number is
+   set with this custom mask, inbound encrypted traffic from all ports with
+   matching channel number pattern will be directed to the inline IPSec device.
+
 .. note::
 
    Above devarg parameters are configurable per device, user needs to pass the
@@ -284,6 +305,11 @@ RTE flow GRE support
 - ``RTE_FLOW_ITEM_TYPE_GRE_KEY`` works only when checksum and routing
   bits in the GRE header are equal to 0.
 
+RTE flow action port_id support
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- ``RTE_FLOW_ACTION_TYPE_PORT_ID`` is only supported between PF and its VFs.
+
 Custom protocols supported in RTE Flow
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~