1..  SPDX-License-Identifier: BSD-3-Clause
2    Copyright(c) 2020 Marvell International Ltd.
3
4OCTEON TX2 REE Regexdev Driver
5==============================
6
7The OCTEON TX2 REE PMD (**librte_regex_octeontx2**) provides poll mode
8regexdev driver support for the inbuilt regex device found in the **Marvell OCTEON TX2**
9SoC family.
10
11More information about OCTEON TX2 SoC can be found at `Marvell Official Website
12<https://www.marvell.com/embedded-processors/infrastructure-processors/>`_.
13
14Features
15--------
16
17Features of the OCTEON TX2 REE PMD are:
18
19- 36 queues
20- Up to 254 matches for each regex operation
21
22Prerequisites and Compilation procedure
23---------------------------------------
24
25   See :doc:`../platform/octeontx2` for setup information.
26
27Device Setup
28------------
29
30The OCTEON TX2 REE devices will need to be bound to a user-space IO driver
31for use. The script ``dpdk-devbind.py`` script included with DPDK can be
32used to view the state of the devices and to bind them to a suitable
33DPDK-supported kernel driver. When querying the status of the devices,
34they will appear under the category of "REGEX devices", i.e. the command
35``dpdk-devbind.py --status-dev regex`` can be used to see the state of
36those devices alone.
37
38Debugging Options
39-----------------
40
41.. _table_octeontx2_regex_debug_options:
42
43.. table:: OCTEON TX2 regex device debug options
44
45   +---+------------+-------------------------------------------------------+
46   | # | Component  | EAL log command                                       |
47   +===+============+=======================================================+
48   | 1 | REE        | --log-level='pmd\.regex\.octeontx2,8'                 |
49   +---+------------+-------------------------------------------------------+
50