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 <getel...@nvidia.com>
Acked-by: Viacheslav Ovsiienko <viachesl...@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 b27a9a69f6..12b45a69b5 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
-----------
@@ -417,6 +418,20 @@ Limitations
- yellow: must be empty.
- RED: must be DROP.
+- 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.**
--
2.31.1
