xref: /dpdk/doc/guides/regexdevs/mlx5.rst (revision 7b61f14edbc2aeebfba3b2d359359a76fae641f4)
1cf9b3c36SYuval Avnery.. SPDX-License-Identifier: BSD-3-Clause
2cf9b3c36SYuval Avnery   Copyright 2020 Mellanox Technologies, Ltd
3cf9b3c36SYuval Avnery
4cf9b3c36SYuval Avnery.. include:: <isonum.txt>
5cf9b3c36SYuval Avnery
6a3ade5e3SMichael BaumMLX5 RegEx Driver
7cf9b3c36SYuval Avnery=================
8cf9b3c36SYuval Avnery
9a3ade5e3SMichael BaumThe mlx5 RegEx (Regular Expression) driver library
10*7b61f14eSRaslan Darawsheh(**librte_regex_mlx5**) provides support for **NVIDIA BlueField-2**
11cf9b3c36SYuval Avneryfamilies of 25/50/100/200 Gb/s adapters.
12cf9b3c36SYuval Avnery
13cf9b3c36SYuval AvneryDesign
14cf9b3c36SYuval Avnery------
15cf9b3c36SYuval Avnery
16cf9b3c36SYuval AvneryThis PMD is configuring the RegEx HW engine.
17cf9b3c36SYuval AvneryFor the PMD to work, the application must supply
18cf9b3c36SYuval Avnerya precompiled rule file in rof2 format.
19cf9b3c36SYuval Avnery
20a3ade5e3SMichael BaumSee :doc:`../../platform/mlx5` guide for more design details.
21cf9b3c36SYuval Avnery
22330a70b7SSuanming MouFeatures
23330a70b7SSuanming Mou--------
24330a70b7SSuanming Mou
25330a70b7SSuanming Mou- Multi segments mbuf support.
26330a70b7SSuanming Mou
27a3ade5e3SMichael BaumConfiguration
28a3ade5e3SMichael Baum-------------
29a3ade5e3SMichael Baum
30a3ade5e3SMichael BaumSee :ref:`mlx5 common compilation <mlx5_common_compilation>`,
31a3ade5e3SMichael Baum:ref:`mlx5 firmware configuration <mlx5_firmware_config>`,
32a3ade5e3SMichael Baumand :ref:`mlx5 common driver options <mlx5_common_driver_options>`.
33a3ade5e3SMichael Baum
34a3ade5e3SMichael Baum
35cf9b3c36SYuval AvnerySupported NICs
36cf9b3c36SYuval Avnery--------------
37cf9b3c36SYuval Avnery
38*7b61f14eSRaslan Darawsheh* NVIDIA\ |reg| BlueField-2 SmartNIC
39cf9b3c36SYuval Avnery
40cf9b3c36SYuval AvneryPrerequisites
41cf9b3c36SYuval Avnery-------------
42cf9b3c36SYuval Avnery
43*7b61f14eSRaslan Darawsheh- BlueField-2 running NVIDIA supported kernel.
4467e1bb42SMichael Baum- Enable the RegEx capabilities using system call from the BlueField-2.
45cf9b3c36SYuval Avnery- Official support is not yet released.
46cf9b3c36SYuval Avnery
47a3ade5e3SMichael Baum
480253af30SOri KamLimitations
490253af30SOri Kam-----------
500253af30SOri Kam
519fa82d28SAdy Agbarih- The firmware version must be greater than XX.31.0364
52