doc/guides/regexdevs/mlx5.rst

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