doc: limit FW support for mlx5 RegEx device

Message ID 20210803190749.659641-1-orika@nvidia.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series doc: limit FW support for mlx5 RegEx device |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/github-robot success github build: passed
ci/iol-spell-check-testing warning Testing issues
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-aarch64-unit-testing success Testing PASS
ci/Intel-compilation success Compilation OK
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/intel-Testing success Testing PASS
ci/iol-abi-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-x86_64-compile-testing fail Testing issues

Commit Message

Ori Kam Aug. 3, 2021, 7:07 p.m. UTC
  MLX5 RegEx is only supported with FW version XX.30.1004 or lower.

Signed-off-by: Ori Kam <orika@nvidia.com>
Acked-by: Asaf Penso <asafp@nvidia.com>
---
 doc/guides/regexdevs/mlx5.rst | 5 +++++
 1 file changed, 5 insertions(+)
  

Comments

Thomas Monjalon Aug. 4, 2021, 9:48 a.m. UTC | #1
03/08/2021 21:07, Ori Kam:
> MLX5 RegEx is only supported with FW version XX.30.1004 or lower.
> 
> Signed-off-by: Ori Kam <orika@nvidia.com>
> Acked-by: Asaf Penso <asafp@nvidia.com>

Applied, thanks.
  

Patch

diff --git a/doc/guides/regexdevs/mlx5.rst b/doc/guides/regexdevs/mlx5.rst
index 45a0b96980..f8000579f1 100644
--- a/doc/guides/regexdevs/mlx5.rst
+++ b/doc/guides/regexdevs/mlx5.rst
@@ -52,6 +52,11 @@  Prerequisites
 - Enable the RegEx capabilities using system call from the BlueField 2.
 - Official support is not yet released.
 
+Limitations
+-----------
+
+- The FW version must be equal to or lower than XX.30.1004
+
 Run-time configuration
 ~~~~~~~~~~~~~~~~~~~~~~