xref: /dpdk/doc/guides/regexdevs/mlx5.rst (revision 0f91f952bea358e31a00b6eba51cc345c81012ff)
1cf9b3c36SYuval Avnery.. SPDX-License-Identifier: BSD-3-Clause
2cf9b3c36SYuval Avnery   Copyright 2020 Mellanox Technologies, Ltd
3cf9b3c36SYuval Avnery
4cf9b3c36SYuval Avnery.. include:: <isonum.txt>
5cf9b3c36SYuval Avnery
6*0f91f952SThomas MonjalonNVIDIA MLX5 RegEx Driver
7*0f91f952SThomas Monjalon========================
8*0f91f952SThomas Monjalon
9*0f91f952SThomas Monjalon.. note::
10*0f91f952SThomas Monjalon
11*0f91f952SThomas Monjalon   NVIDIA acquired Mellanox Technologies in 2020.
12*0f91f952SThomas Monjalon   The DPDK documentation and code might still include instances
13*0f91f952SThomas Monjalon   of or references to Mellanox trademarks (like BlueField and ConnectX)
14*0f91f952SThomas Monjalon   that are now NVIDIA trademarks.
15cf9b3c36SYuval Avnery
16a3ade5e3SMichael BaumThe mlx5 RegEx (Regular Expression) driver library
177b61f14eSRaslan Darawsheh(**librte_regex_mlx5**) provides support for **NVIDIA BlueField-2**
18cf9b3c36SYuval Avneryfamilies of 25/50/100/200 Gb/s adapters.
19cf9b3c36SYuval Avnery
20cf9b3c36SYuval AvneryDesign
21cf9b3c36SYuval Avnery------
22cf9b3c36SYuval Avnery
23cf9b3c36SYuval AvneryThis PMD is configuring the RegEx HW engine.
24cf9b3c36SYuval AvneryFor the PMD to work, the application must supply
25cf9b3c36SYuval Avnerya precompiled rule file in rof2 format.
26cf9b3c36SYuval Avnery
27a3ade5e3SMichael BaumSee :doc:`../../platform/mlx5` guide for more design details.
28cf9b3c36SYuval Avnery
29330a70b7SSuanming MouFeatures
30330a70b7SSuanming Mou--------
31330a70b7SSuanming Mou
32330a70b7SSuanming Mou- Multi segments mbuf support.
33330a70b7SSuanming Mou
34a3ade5e3SMichael BaumConfiguration
35a3ade5e3SMichael Baum-------------
36a3ade5e3SMichael Baum
37a3ade5e3SMichael BaumSee :ref:`mlx5 common compilation <mlx5_common_compilation>`,
38a3ade5e3SMichael Baum:ref:`mlx5 firmware configuration <mlx5_firmware_config>`,
39a3ade5e3SMichael Baumand :ref:`mlx5 common driver options <mlx5_common_driver_options>`.
40a3ade5e3SMichael Baum
41a3ade5e3SMichael Baum
42cf9b3c36SYuval AvnerySupported NICs
43cf9b3c36SYuval Avnery--------------
44cf9b3c36SYuval Avnery
457b61f14eSRaslan Darawsheh* NVIDIA\ |reg| BlueField-2 SmartNIC
46cf9b3c36SYuval Avnery
47cf9b3c36SYuval AvneryPrerequisites
48cf9b3c36SYuval Avnery-------------
49cf9b3c36SYuval Avnery
507b61f14eSRaslan Darawsheh- BlueField-2 running NVIDIA supported kernel.
5167e1bb42SMichael Baum- Enable the RegEx capabilities using system call from the BlueField-2.
52cf9b3c36SYuval Avnery- Official support is not yet released.
53cf9b3c36SYuval Avnery
54a3ade5e3SMichael Baum
550253af30SOri KamLimitations
560253af30SOri Kam-----------
570253af30SOri Kam
589fa82d28SAdy Agbarih- The firmware version must be greater than XX.31.0364
59