doc: add raw encap/decap limitations in mlx5 guide
authorRaslan Darawsheh <rasland@mellanox.com>
Sun, 23 Feb 2020 09:30:59 +0000 (11:30 +0200)
committerThomas Monjalon <thomas@monjalon.net>
Tue, 25 Feb 2020 13:16:19 +0000 (14:16 +0100)
Document validation limitations for encap/decap.

Signed-off-by: Raslan Darawsheh <rasland@mellanox.com>
Acked-by: Ori Kam <orika@mellanox.com>
doc/guides/nics/mlx5.rst

index 2e9c71a..7fac9d1 100644 (file)
@@ -202,6 +202,16 @@ Limitations
   - can be applied to VF ports only.
   - must specify PF port action (packet redirection from VF to PF).
 
+- Raw encapsulation:
+
+  - The input buffer, used as outer header, is not validated.
+
+- Raw decapsulation:
+
+  - The decapsulation is always done up to the outermost tunnel detected by the HW.
+  - The input buffer, providing the removal size, is not validated.
+  - The buffer size must match the length of the headers to be removed.
+
 - ICMP/ICMP6 code/type matching, IP-in-IP and MPLS flow matching are all
   mutually exclusive features which cannot be supported together
   (see :ref:`mlx5_firmware_config`).