regex/octeontx2: introduce REE driver
[dpdk.git] / doc / guides / regexdevs / octeontx2.rst
1 ..  SPDX-License-Identifier: BSD-3-Clause
2     Copyright(c) 2020 Marvell International Ltd.
3
4 OCTEON TX2 REE Regexdev Driver
5 ==============================
6
7 The OCTEON TX2 REE PMD (**librte_pmd_octeontx2_regex**) provides poll mode
8 regexdev driver support for the inbuilt regex device found in the **Marvell OCTEON TX2**
9 SoC family.
10
11 More information about OCTEON TX2 SoC can be found at `Marvell Official Website
12 <https://www.marvell.com/embedded-processors/infrastructure-processors/>`_.
13
14 Features
15 --------
16
17 Features of the OCTEON TX2 REE PMD are:
18
19 - 36 queues
20 - Up to 254 matches for each regex operation
21
22 Prerequisites and Compilation procedure
23 ---------------------------------------
24
25    See :doc:`../platform/octeontx2` for setup information.
26
27 Debugging Options
28 -----------------
29
30 .. _table_octeontx2_regex_debug_options:
31
32 .. table:: OCTEON TX2 regex device debug options
33
34    +---+------------+-------------------------------------------------------+
35    | # | Component  | EAL log command                                       |
36    +===+============+=======================================================+
37    | 1 | REE        | --log-level='pmd\.regex\.octeontx2,8'                 |
38    +---+------------+-------------------------------------------------------+