xref: /dpdk/doc/guides/regexdevs/mlx5.rst (revision 09442498ef736d0a96632cf8b8c15d8ca78a6468)
1.. SPDX-License-Identifier: BSD-3-Clause
2   Copyright 2020 Mellanox Technologies, Ltd
3
4.. include:: <isonum.txt>
5
6NVIDIA MLX5 RegEx Driver
7========================
8
9.. note::
10
11   NVIDIA acquired Mellanox Technologies in 2020.
12   The DPDK documentation and code might still include instances
13   of or references to Mellanox trademarks (like BlueField and ConnectX)
14   that are now NVIDIA trademarks.
15
16The mlx5 RegEx (Regular Expression) driver library
17(**librte_regex_mlx5**) provides support for **NVIDIA BlueField-2**
18families of 25/50/100/200 Gb/s adapters.
19
20Design
21------
22
23This PMD is configuring the RegEx HW engine.
24For the PMD to work, the application must supply
25a precompiled rule file in rof2 format.
26
27See :doc:`../../platform/mlx5` guide for more design details.
28
29Features
30--------
31
32- Multi segments mbuf support.
33
34Configuration
35-------------
36
37See :ref:`mlx5 common compilation <mlx5_common_compilation>`,
38:ref:`mlx5 firmware configuration <mlx5_firmware_config>`,
39and :ref:`mlx5 common driver options <mlx5_common_driver_options>`.
40
41
42Supported NICs
43--------------
44
45* NVIDIA\ |reg| BlueField-2 SmartNIC
46
47Prerequisites
48-------------
49
50- BlueField-2 running NVIDIA supported kernel.
51- Enable the RegEx capabilities using system call from the BlueField-2.
52- Official support is not yet released.
53
54
55Limitations
56-----------
57
58- The firmware version must be greater than XX.31.0364
59