* [PATCH] doc: add mlx5 PMD flex item documentation
@ 2021-11-16 14:51 Gregory Etelson
2021-11-16 15:05 ` Thomas Monjalon
2021-11-16 15:45 ` [PATCH v2] " Gregory Etelson
0 siblings, 2 replies; 6+ messages in thread
From: Gregory Etelson @ 2021-11-16 14:51 UTC (permalink / raw)
To: dev, getelson; +Cc: viacheslavo, matan, rasland, thomas
Describe firmware configuration requirements.
List mlx5 hardware and PMD limitations.
Signed-off-by: Gregory Etelson <getelson@nvidia.com>
---
doc/guides/nics/mlx5.rst | 16 ++++++++++++++++
1 file changed, 16 insertions(+)
diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index 552e06c0db..bbeeb1a3d4 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:
+
+ - Firmware configuration: ``FLEX_PARSER_PROFILE_ENABLE=4 PROG_PARSE_GRAPH=1``.
+ - 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 IN arc - ``eth`` or ``udp`` and up to 2 OUT arcs - ``ipv4`` or ``ipv6``.
+ - Flex item fields (next_header, next_protocol, samples) do not participate in RSS hash functions.
+ - In RTE 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 RTE flex item::
+
+ FLEX_PARSER_PROFILE_ENABLE=4
+ PROG_PARSE_GRAPH=1
+
Linux Prerequisites
-------------------
--
2.33.1
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] doc: add mlx5 PMD flex item documentation
2021-11-16 14:51 [PATCH] doc: add mlx5 PMD flex item documentation Gregory Etelson
@ 2021-11-16 15:05 ` Thomas Monjalon
2021-11-16 15:45 ` [PATCH v2] " Gregory Etelson
1 sibling, 0 replies; 6+ messages in thread
From: Thomas Monjalon @ 2021-11-16 15:05 UTC (permalink / raw)
To: Gregory Etelson; +Cc: dev, viacheslavo, matan, rasland
16/11/2021 15:51, Gregory Etelson:
> Describe firmware configuration requirements.
> List mlx5 hardware and PMD limitations.
That's a pity we missed documentation when adding the feature.
Please a line "Fixes".
[...]
> +- Flex item API:
> +
> + - Firmware configuration: ``FLEX_PARSER_PROFILE_ENABLE=4 PROG_PARSE_GRAPH=1``.
This is not a limitation and it is redundant with the last part of this patch.
> + - Hardware support: BlueField-2.
I think it should be a space: 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.
Please break lines after a dot.
> + - Supported flex item can have 1 IN arc - ``eth`` or ``udp`` and up to 2 OUT arcs - ``ipv4`` or ``ipv6``.
Is "arc" defined somewhere?
> + - Flex item fields (next_header, next_protocol, samples) do not participate in RSS hash functions.
Fields should be enclosed with quotes.
> + - In RTE flex item configuration, ``next_header.field_base`` value must be byte aligned (multiple of 8).
Please don't say "RTE".
[...]
> +- enable dynamic flex parser for RTE flex item::
Again, please stop using "RTE". I really wonder why I see this in a lot of patches.
In user doc, it doesn't make sense at all.
If you really want to distinguish API and driver implementation, use "API".
> +
> + FLEX_PARSER_PROFILE_ENABLE=4
> + PROG_PARSE_GRAPH=1
^ permalink raw reply [flat|nested] 6+ messages in thread
* [PATCH v2] doc: add mlx5 PMD flex item documentation
2021-11-16 14:51 [PATCH] doc: add mlx5 PMD flex item documentation Gregory Etelson
2021-11-16 15:05 ` Thomas Monjalon
@ 2021-11-16 15:45 ` Gregory Etelson
2021-11-22 10:42 ` Slava Ovsiienko
2021-11-23 9:29 ` [PATCH v3] " Gregory Etelson
1 sibling, 2 replies; 6+ messages in thread
From: Gregory Etelson @ 2021-11-16 15:45 UTC (permalink / raw)
To: dev, getelson; +Cc: rasland, thomas, Matan Azrad, Viacheslav Ovsiienko
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(+)
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
-------------------
--
2.33.1
^ permalink raw reply [flat|nested] 6+ messages in thread
* RE: [PATCH v2] doc: add mlx5 PMD flex item documentation
2021-11-16 15:45 ` [PATCH v2] " Gregory Etelson
@ 2021-11-22 10:42 ` Slava Ovsiienko
2021-11-23 9:29 ` [PATCH v3] " Gregory Etelson
1 sibling, 0 replies; 6+ messages in thread
From: Slava Ovsiienko @ 2021-11-22 10:42 UTC (permalink / raw)
To: Gregory Etelson, dev
Cc: Raslan Darawsheh, NBU-Contact-Thomas Monjalon (EXTERNAL), Matan Azrad
> -----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>
^ permalink raw reply [flat|nested] 6+ messages in thread
* [PATCH v3] doc: add mlx5 PMD flex item documentation
2021-11-16 15:45 ` [PATCH v2] " Gregory Etelson
2021-11-22 10:42 ` Slava Ovsiienko
@ 2021-11-23 9:29 ` Gregory Etelson
2021-11-23 17:35 ` Ferruh Yigit
1 sibling, 1 reply; 6+ messages in thread
From: Gregory Etelson @ 2021-11-23 9:29 UTC (permalink / raw)
To: dev, getelson
Cc: Ferruh Yigit, Viacheslav Ovsiienko, Raslan Darawsheh, Matan Azrad
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>
Acked-by: Raslan Darawsheh <rasland@nvidia.com>
---
v2: Style fixes.
v3: Update hardware and port support.
---
doc/guides/nics/mlx5.rst | 17 +++++++++++++++++
1 file changed, 17 insertions(+)
diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index 552e06c0db..7b2647dad6 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -494,6 +494,18 @@ Limitations
from the reference "Clock Queue" completions,
the scheduled send timestamps should not be specified with non-zero MSB.
+- Flex item API:
+
+ - Firmware configuration: ``FLEX_PARSER_PROFILE_ENABLE=4 PROG_PARSE_GRAPH=1``.
+ - Hardware support: BlueField 2.
+ - Flex item is supported for DPDK ports created over ECPF (Uplink representor, VF representor,
+ SF representor, HPF representor).
+ - 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 IN arc - ``eth`` or ``udp`` and up to 2 OUT arcs - ``ipv4`` or ``ipv6``.
+ - Flex item fields do not participate in RSS hash functions.
+ - In RTE flex item configuration, ``next_header.field_base`` value must be byte aligned (multiple of 8).
+
Statistics
----------
@@ -1260,6 +1272,11 @@ Below are some firmware configurations listed.
REAL_TIME_CLOCK_ENABLE=1
+- enable dynamic flex parser for RTE flex item::
+
+ FLEX_PARSER_PROFILE_ENABLE=4
+ PROG_PARSE_GRAPH=1
+
Linux Prerequisites
-------------------
--
2.34.0
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH v3] doc: add mlx5 PMD flex item documentation
2021-11-23 9:29 ` [PATCH v3] " Gregory Etelson
@ 2021-11-23 17:35 ` Ferruh Yigit
0 siblings, 0 replies; 6+ messages in thread
From: Ferruh Yigit @ 2021-11-23 17:35 UTC (permalink / raw)
To: Gregory Etelson, dev; +Cc: Viacheslav Ovsiienko, Raslan Darawsheh, Matan Azrad
On 11/23/2021 9:29 AM, Gregory Etelson wrote:
> 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>
> Acked-by: Raslan Darawsheh <rasland@nvidia.com>
> ---
> v2: Style fixes.
> v3: Update hardware and port support.
Patch is already in next-net-mlx tree, pulled from there to next-net.
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2021-11-23 18:02 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-11-16 14:51 [PATCH] doc: add mlx5 PMD flex item documentation Gregory Etelson
2021-11-16 15:05 ` Thomas Monjalon
2021-11-16 15:45 ` [PATCH v2] " Gregory Etelson
2021-11-22 10:42 ` Slava Ovsiienko
2021-11-23 9:29 ` [PATCH v3] " Gregory Etelson
2021-11-23 17:35 ` Ferruh Yigit
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).