[v3,6/7] doc/mlx5: update mlx5 doc

Message ID 20230223070633.946328-7-rongweil@nvidia.com (mailing list archive)
State Superseded, archived
Delegated to: Raslan Darawsheh
Headers
Series add flex item implementation |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Rongwei Liu Feb. 23, 2023, 7:06 a.m. UTC
  Add flex item matching and modify field feature into
mlx5 documents.

Signed-off-by: Rongwei Liu <rongweil@nvidia.com>
Acked-by: Viacheslav Ovsiienko <viacheslavo@nvidia.com>
---
 doc/guides/nics/mlx5.rst | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
  

Comments

Thomas Monjalon Feb. 23, 2023, 12:37 p.m. UTC | #1
23/02/2023 08:06, Rongwei Liu:
> Add flex item matching and modify field feature into
> mlx5 documents.
> 
> Signed-off-by: Rongwei Liu <rongweil@nvidia.com>
> Acked-by: Viacheslav Ovsiienko <viacheslavo@nvidia.com>

Please don't do a separate commit for doc update.
The doc should be updated with the related code in the same patch.
  

Patch

diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index f182baa37e..09828a5cf4 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -108,6 +108,7 @@  Features
 - Sub-Function.
 - Matching on represented port.
 - Matching on IPv6 routing extension header.
+- Modify flex item field.
 
 
 Limitations
@@ -291,11 +292,12 @@  Limitations
   - Firmware supports 8 global sample fields.
     Each flex item allocates non-shared sample fields from that pool.
   - Supported flex item can have 1 input link - ``eth`` or ``udp``
-    and up to 2 output links - ``ipv4`` or ``ipv6``.
+    and up to 3 output links - ``ipv4`` or ``ipv6``.
   - Flex item fields (``next_header``, ``next_protocol``, ``samples``)
     do not participate in RSS hash functions.
   - In flex item configuration, ``next_header.field_base`` value
     must be byte aligned (multiple of 8).
+  - Modify field with flex item, the offset must be byte aligned (multiple of 8).
 
 - No Tx metadata go to the E-Switch steering domain for the Flow group 0.
   The flows within group 0 and set metadata action are rejected by hardware.