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