diff mbox series

[v2] doc: add mlx5 PMD flex item documentation

Message ID 20211116154514.4029-1-getelson@nvidia.com (mailing list archive)
State Superseded, archived
Delegated to: Raslan Darawsheh
Headers
Series [v2] doc: add mlx5 PMD flex item documentation |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/iol-testing warning apply patch failure
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/github-robot: build success github build: passed

Commit Message

Gregory Etelson Nov. 16, 2021, 3:45 p.m. UTC 
  Describe firmware configuration requirements.
List mlx5 hardware and PMD limitations.

Signed-off-by: Gregory Etelson <getelson@nvidia.com>
---
v2: Style fixes.
---
 doc/guides/nics/mlx5.rst | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

Comments

Slava Ovsiienko Nov. 22, 2021, 10:42 a.m. UTC | #1 
> -----Original Message-----
> From: Gregory Etelson <getelson@nvidia.com>
> Sent: Tuesday, November 16, 2021 17:45
> To: dev@dpdk.org; Gregory Etelson <getelson@nvidia.com>
> Cc: Raslan Darawsheh <rasland@nvidia.com>; NBU-Contact-Thomas Monjalon
> <thomas@monjalon.net>; Matan Azrad <matan@nvidia.com>; Slava
> Ovsiienko <viacheslavo@nvidia.com>
> Subject: [PATCH v2] doc: add mlx5 PMD flex item documentation
> 
> Describe firmware configuration requirements.
> List mlx5 hardware and PMD limitations.
> 
> Signed-off-by: Gregory Etelson <getelson@nvidia.com>
Acked-by: Viacheslav Ovsiienko <viacheslavo@nvidia.com>
diff mbox series

Patch

diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index 552e06c0db..855ee9a119 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -494,6 +494,17 @@  Limitations
     from the reference "Clock Queue" completions,
     the scheduled send timestamps should not be specified with non-zero MSB.
 
+- Flex item API:
+
+  - Hardware support: BlueField 2.
+  - Flex item is supported on PF only.
+  - Hardware limits ``header_length_mask_width`` up to 6 bits.
+  - 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``.
+  - 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).
+
 Statistics
 ----------
 
@@ -1260,6 +1271,11 @@  Below are some firmware configurations listed.
 
    REAL_TIME_CLOCK_ENABLE=1
 
+- enable dynamic flex parser for flex item::
+
+   FLEX_PARSER_PROFILE_ENABLE=4
+   PROG_PARSE_GRAPH=1
+
 Linux Prerequisites
 -------------------