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