xref: /dpdk/doc/guides/regexdevs/mlx5.rst (revision cb0da841649ee317e44faacbc4063caa26008366)
1cf9b3c36SYuval Avnery.. SPDX-License-Identifier: BSD-3-Clause
2cf9b3c36SYuval Avnery   Copyright 2020 Mellanox Technologies, Ltd
3cf9b3c36SYuval Avnery
4cf9b3c36SYuval Avnery.. include:: <isonum.txt>
5cf9b3c36SYuval Avnery
60f91f952SThomas MonjalonNVIDIA MLX5 RegEx Driver
70f91f952SThomas Monjalon========================
80f91f952SThomas Monjalon
90f91f952SThomas Monjalon.. note::
100f91f952SThomas Monjalon
110f91f952SThomas Monjalon   NVIDIA acquired Mellanox Technologies in 2020.
120f91f952SThomas Monjalon   The DPDK documentation and code might still include instances
130f91f952SThomas Monjalon   of or references to Mellanox trademarks (like BlueField and ConnectX)
140f91f952SThomas Monjalon   that are now NVIDIA trademarks.
15cf9b3c36SYuval Avnery
16a3ade5e3SMichael BaumThe mlx5 RegEx (Regular Expression) driver library
17*cb0da841SRaslan Darawsheh(**librte_regex_mlx5**) provides support for **NVIDIA BlueField-2**,
18*cb0da841SRaslan Darawshehand **NVIDIA BlueField-3** families 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
46*cb0da841SRaslan Darawsheh* NVIDIA\ |reg| BlueField-3 SmartNIC
47cf9b3c36SYuval Avnery
48cf9b3c36SYuval AvneryPrerequisites
49cf9b3c36SYuval Avnery-------------
50cf9b3c36SYuval Avnery
51*cb0da841SRaslan Darawsheh- BlueField-2 or BlueField-3 running NVIDIA supported kernel.
52*cb0da841SRaslan Darawsheh- Enable the RegEx capabilities using system call from the BlueField-2 or BlueField-3.
53cf9b3c36SYuval Avnery- Official support is not yet released.
54cf9b3c36SYuval Avnery
55a3ade5e3SMichael Baum
560253af30SOri KamLimitations
570253af30SOri Kam-----------
580253af30SOri Kam
59*cb0da841SRaslan Darawsheh- The firmware version must be greater than 24.31.0364 for BlueField-2
60*cb0da841SRaslan Darawsheh  and 32.36.xxxx for BlueField-3.
61