8809f78c7d
Since the built driver filenames have changed in DPDK 20.11, we need to
update the driver doc to match.
Most drivers start their section with the driver filename highlighted in
bold, while a number were missing the highlight. When updating the names,
add the markers for bold text to any missing it, so as to have things more
consistent.
Fixes: a20b2c01a7 ("build: standardize component names and defines")
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
Reviewed-by: David Marchand <david.marchand@redhat.com>
Reviewed-by: Rosen Xu <rosen.xu@intel.com>
Acked-by: Ajit Khaparde <ajit.khaparde@broadcom.com>
50 lines
1.7 KiB
ReStructuredText
50 lines
1.7 KiB
ReStructuredText
.. SPDX-License-Identifier: BSD-3-Clause
|
|
Copyright(c) 2020 Marvell International Ltd.
|
|
|
|
OCTEON TX2 REE Regexdev Driver
|
|
==============================
|
|
|
|
The OCTEON TX2 REE PMD (**librte_regex_octeontx2**) provides poll mode
|
|
regexdev driver support for the inbuilt regex device found in the **Marvell OCTEON TX2**
|
|
SoC family.
|
|
|
|
More information about OCTEON TX2 SoC can be found at `Marvell Official Website
|
|
<https://www.marvell.com/embedded-processors/infrastructure-processors/>`_.
|
|
|
|
Features
|
|
--------
|
|
|
|
Features of the OCTEON TX2 REE PMD are:
|
|
|
|
- 36 queues
|
|
- Up to 254 matches for each regex operation
|
|
|
|
Prerequisites and Compilation procedure
|
|
---------------------------------------
|
|
|
|
See :doc:`../platform/octeontx2` for setup information.
|
|
|
|
Device Setup
|
|
------------
|
|
|
|
The OCTEON TX2 REE devices will need to be bound to a user-space IO driver
|
|
for use. The script ``dpdk-devbind.py`` script included with DPDK can be
|
|
used to view the state of the devices and to bind them to a suitable
|
|
DPDK-supported kernel driver. When querying the status of the devices,
|
|
they will appear under the category of "REGEX devices", i.e. the command
|
|
``dpdk-devbind.py --status-dev regex`` can be used to see the state of
|
|
those devices alone.
|
|
|
|
Debugging Options
|
|
-----------------
|
|
|
|
.. _table_octeontx2_regex_debug_options:
|
|
|
|
.. table:: OCTEON TX2 regex device debug options
|
|
|
|
+---+------------+-------------------------------------------------------+
|
|
| # | Component | EAL log command |
|
|
+===+============+=======================================================+
|
|
| 1 | REE | --log-level='pmd\.regex\.octeontx2,8' |
|
|
+---+------------+-------------------------------------------------------+
|