doc: update QinQ strip & VLAN filter notes

Message ID 20251202205554.24405-1-anurag.mandal@intel.com (mailing list archive)
State New
Delegated to: Bruce Richardson
Headers
Series doc: update QinQ strip & VLAN filter notes |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/intel-Functional success Functional PASS
ci/github-robot: build success github build: passed
ci/github-robot-post success github post: success
ci/aws-unit-testing success Unit Testing PASS

Commit Message

Mandal, Anurag Dec. 2, 2025, 8:55 p.m. UTC
Tested QinQ stripping with TPIDs 0x88A8 and 0x8100.
Removed QinQ related obsolete notes for FW version >= 8.4.
Added new "QinQ strip" section under "Sample Application Notes".
Added VLAN filter enable command to its notes as, VLAN cannot
be added to port without it.

Signed-off-by: Anurag Mandal <anurag.mandal@intel.com>
---
 doc/guides/nics/i40e.rst | 37 +++++++++++++++++++++++++++++++++----
 1 file changed, 33 insertions(+), 4 deletions(-)
  

Patch

diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst
index 165798fb94..45dc083c94 100644
--- a/doc/guides/nics/i40e.rst
+++ b/doc/guides/nics/i40e.rst
@@ -357,9 +357,41 @@  To start ``testpmd``, and add vlan 10 to port 0:
     ...
 
     testpmd> set promisc 0 off
+    testpmd> vlan set filter on 0
     testpmd> rx_vlan add 10 0
 
 
+QinQ strip
+~~~~~~~~~~~
+
+QinQ TPID is set as 0x8100 IEEE 802.1Q by default.
+For QinQ strip with TPID 0x88A8 IEEE 802.1ad, extend VLAN is enabled and VLAN outer tpid is set to 0x88A8.
+Vlan filter steps can be added before or after.
+
+To start ``testpmd``, and enable QinQ strip for TPID 0x88A8 on port 0:
+
+.. code-block:: console
+
+    ./<build_dir>/app/dpdk-testpmd -l 0-15 -- -i --forward-mode=mac
+    ...
+
+    testpmd> vlan set extend on 0
+    testpmd> vlan set outer tpid 0x88A8 0
+    testpmd> vlan set qinq_strip on 0
+
+For QinQ strip with TPID 0x8100, extend VLAN is enabled only.
+
+To start ``testpmd``, and enable QinQ strip for default TPID on port 0:
+
+.. code-block:: console
+
+    ./<build_dir>/app/dpdk-testpmd -l 0-15 -- -i --forward-mode=mac
+    ...
+
+    testpmd> vlan set extend on 0
+    testpmd> vlan set qinq_strip on 0
+
+
 Flow Director
 ~~~~~~~~~~~~~
 
@@ -919,10 +951,7 @@  Vlan related Features miss when FW >= 8.4
 
 If FW version >= 8.4, there'll be some Vlan related issues:
 
-#. TCI input set for QinQ  is invalid.
-#. Fail to configure TPID for QinQ.
-#. Need to enable QinQ before enabling Vlan filter.
-#. Fail to strip outer Vlan.
+#. TCI input set for QinQ is invalid.
 
 Example of getting best performance with l3fwd example
 ------------------------------------------------------