doc: update mlx5 encap/decap limitations

Message ID 1582450259-7235-1-git-send-email-rasland@mellanox.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series doc: update mlx5 encap/decap limitations |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/travis-robot success Travis build: passed

Commit Message

Raslan Darawsheh Feb. 23, 2020, 9:30 a.m. UTC
  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 | 11 +++++++++++
 1 file changed, 11 insertions(+)
  

Comments

Thomas Monjalon Feb. 25, 2020, 12:32 p.m. UTC | #1
23/02/2020 10:30, Raslan Darawsheh:
> Document validation limitations for encap/decap.
> 
> Signed-off-by: Raslan Darawsheh <rasland@mellanox.com>
> Acked-by: Ori kam <orika@mellanox.com>

Applied, thanks
  

Patch

diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index dd2fbde..7991da9 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -215,6 +215,17 @@  Limitations
   - Rx queue with LRO offload enabled, receiving a non-LRO packet, can forward
     it with size limited to max LRO size, not to max RX packet length.
 
+- Decap / raw_decap:
+
+ - The decap is always done up to the first HW detected tunnel.
+ - Decap buffer is not validated, only matters for deciding the decap type
+   l3/l2 decap using the buffer size.
+
+- Encap / raw_encap:
+
+ - No validation is done on the encap buffer, it's user responsibility to
+   provide valid buffer.
+
 Statistics
 ----------