f-stack/dpdk/doc/guides/regexdevs/cn9k.rst

50 lines
1.6 KiB
ReStructuredText
Raw Normal View History

2021-02-05 08:48:47 +00:00
.. SPDX-License-Identifier: BSD-3-Clause
Copyright(c) 2020 Marvell International Ltd.
2023-09-13 12:21:49 +00:00
CN9K REE Regexdev Driver
2021-02-05 08:48:47 +00:00
==============================
2023-09-13 12:21:49 +00:00
The CN9K REE PMD (**librte_regex_cn9k**) provides poll mode
regexdev driver support for the inbuilt regex device found in the **Marvell CN9K**
2021-02-05 08:48:47 +00:00
SoC family.
2023-09-13 12:21:49 +00:00
More information about CN9K SoC can be found at `Marvell Official Website
2021-02-05 08:48:47 +00:00
<https://www.marvell.com/embedded-processors/infrastructure-processors/>`_.
Features
--------
2023-09-13 12:21:49 +00:00
Features of the CN9K REE PMD are:
2021-02-05 08:48:47 +00:00
- 36 queues
- Up to 254 matches for each regex operation
Prerequisites and Compilation procedure
---------------------------------------
2023-09-13 12:21:49 +00:00
See :doc:`../platform/cnxk` for setup information.
2021-02-05 08:48:47 +00:00
Device Setup
------------
2023-09-13 12:21:49 +00:00
The CN9K REE devices will need to be bound to a user-space IO driver
2021-02-05 08:48:47 +00:00
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
-----------------
2023-09-13 12:21:49 +00:00
.. _table_cn9k_regex_debug_options:
2021-02-05 08:48:47 +00:00
2023-09-13 12:21:49 +00:00
.. table:: CN9K regex device debug options
2021-02-05 08:48:47 +00:00
+---+------------+-------------------------------------------------------+
| # | Component | EAL log command |
+===+============+=======================================================+
2023-09-13 12:21:49 +00:00
| 1 | REE | --log-level='pmd\.regex\.cn9k,8' |
2021-02-05 08:48:47 +00:00
+---+------------+-------------------------------------------------------+