[v3,4/4] doc: add MLX5 PMD integrity item support

Message ID 20210429183659.14765-5-getelson@nvidia.com (mailing list archive)
State Accepted, archived
Delegated to: Ferruh Yigit
Headers
Series net/mlx5: add integrity flow item support |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-abi-testing success Testing PASS
ci/iol-testing success Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/Intel-compilation warning apply issues

Commit Message

Gregory Etelson April 29, 2021, 6:36 p.m. UTC
  Add MLX5 PMD integrity item support to 21.05 release notes.

Add MLX5 PMD integrity item limitations to the PMD records.

Signed-off-by: Gregory Etelson <getelson@nvidia.com>
Acked-by: Viacheslav Ovsiienko <viacheslavo@nvidia.com>
---
 doc/guides/nics/mlx5.rst               | 15 +++++++++++++++
 doc/guides/rel_notes/release_21_02.rst |  1 +
 2 files changed, 16 insertions(+)
  

Comments

Ferruh Yigit May 4, 2021, 3:21 p.m. UTC | #1
On 4/29/2021 7:36 PM, Gregory Etelson wrote:
> Add MLX5 PMD integrity item support to 21.05 release notes.
> 
> Add MLX5 PMD integrity item limitations to the PMD records.
> 

Hi Gregory,

It is expected to have doc updates with the actual patch, it seems we have
missed it for this time.

Can you please add the fixes tag for the patch that added the feature?

> Signed-off-by: Gregory Etelson <getelson@nvidia.com>
> Acked-by: Viacheslav Ovsiienko <viacheslavo@nvidia.com>
> ---
>  doc/guides/nics/mlx5.rst               | 15 +++++++++++++++
>  doc/guides/rel_notes/release_21_02.rst |  1 +
>  2 files changed, 16 insertions(+)
> 
> diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
> index 2bb4f18a08..cbf16ad598 100644
> --- a/doc/guides/nics/mlx5.rst
> +++ b/doc/guides/nics/mlx5.rst
> @@ -107,6 +107,7 @@ Features
>  - 21844 flow priorities for ingress or egress flow groups greater than 0 and for any transfer
>    flow group.
>  - Flow metering, including meter policy API.
> +- Flow integrity offload API.
>  
>  Limitations
>  -----------
> @@ -418,6 +419,20 @@ Limitations
>       - RED: must be DROP.
>    - meter profile packet mode is supported.
>  
> +- Integrity:
> +
> +  - Integrity offload is enabled for **ConnectX-6** family.
> +  - Verification bits provided by the hardware are ``l3_ok``, ``ipv4_csum_ok``, ``l4_ok``, ``l4_csum_ok``.
> +  - ``level`` value 0 references outer headers.
> +  - Multiple integrity items not supported in a single flow rule.
> +  - Flow rule items supplied by application must explicitly specify network headers referred by integrity item.
> +    For example, if integrity item mask sets ``l4_ok`` or ``l4_csum_ok`` bits, reference to L4 network header,
> +    TCP or UDP, must be in the rule pattern as well::
> +
> +      flow create 0 ingress pattern integrity level is 0 value mask l3_ok value spec l3_ok / eth / ipv6 / end …
> +      or
> +      flow create 0 ingress pattern integrity level is 0 value mask l4_ok value spec 0 / eth / ipv4 proto is udp / end …
> +
>  Statistics
>  ----------
>  
> diff --git a/doc/guides/rel_notes/release_21_02.rst b/doc/guides/rel_notes/release_21_02.rst
> index 1813fe767a..ce27879f08 100644
> --- a/doc/guides/rel_notes/release_21_02.rst
> +++ b/doc/guides/rel_notes/release_21_02.rst
> @@ -138,6 +138,7 @@ New Features
>      egress flow groups greater than 0 and for any transfer flow group.
>    * Added support for the Tx mbuf fast free offload.
>    * Added support for flow modify field action.
> +  * Added support for flow integrity item.
>  
>  * **Updated the Pensando ionic driver.**
>  
>
  
Ferruh Yigit May 4, 2021, 3:26 p.m. UTC | #2
On 5/4/2021 4:21 PM, Ferruh Yigit wrote:
> On 4/29/2021 7:36 PM, Gregory Etelson wrote:
>> Add MLX5 PMD integrity item support to 21.05 release notes.
>>
>> Add MLX5 PMD integrity item limitations to the PMD records.
>>
> 
> Hi Gregory,
> 
> It is expected to have doc updates with the actual patch, it seems we have
> missed it for this time.
> 
> Can you please add the fixes tag for the patch that added the feature?
> 

Ahh, it is introduced in the same set, I will squash this patch to it.
  

Patch

diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index 2bb4f18a08..cbf16ad598 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -107,6 +107,7 @@  Features
 - 21844 flow priorities for ingress or egress flow groups greater than 0 and for any transfer
   flow group.
 - Flow metering, including meter policy API.
+- Flow integrity offload API.
 
 Limitations
 -----------
@@ -418,6 +419,20 @@  Limitations
      - RED: must be DROP.
   - meter profile packet mode is supported.
 
+- Integrity:
+
+  - Integrity offload is enabled for **ConnectX-6** family.
+  - Verification bits provided by the hardware are ``l3_ok``, ``ipv4_csum_ok``, ``l4_ok``, ``l4_csum_ok``.
+  - ``level`` value 0 references outer headers.
+  - Multiple integrity items not supported in a single flow rule.
+  - Flow rule items supplied by application must explicitly specify network headers referred by integrity item.
+    For example, if integrity item mask sets ``l4_ok`` or ``l4_csum_ok`` bits, reference to L4 network header,
+    TCP or UDP, must be in the rule pattern as well::
+
+      flow create 0 ingress pattern integrity level is 0 value mask l3_ok value spec l3_ok / eth / ipv6 / end …
+      or
+      flow create 0 ingress pattern integrity level is 0 value mask l4_ok value spec 0 / eth / ipv4 proto is udp / end …
+
 Statistics
 ----------
 
diff --git a/doc/guides/rel_notes/release_21_02.rst b/doc/guides/rel_notes/release_21_02.rst
index 1813fe767a..ce27879f08 100644
--- a/doc/guides/rel_notes/release_21_02.rst
+++ b/doc/guides/rel_notes/release_21_02.rst
@@ -138,6 +138,7 @@  New Features
     egress flow groups greater than 0 and for any transfer flow group.
   * Added support for the Tx mbuf fast free offload.
   * Added support for flow modify field action.
+  * Added support for flow integrity item.
 
 * **Updated the Pensando ionic driver.**