doc: add steps to configure mlx5 VF as trusted
[dpdk.git] / doc / guides / regexdevs / cn9k.rst
1 ..  SPDX-License-Identifier: BSD-3-Clause
2     Copyright(c) 2020 Marvell International Ltd.
3
4 CN9K REE Regexdev Driver
5 ==============================
6
7 The CN9K REE PMD (**librte_regex_cn9k**) provides poll mode
8 regexdev driver support for the inbuilt regex device found in the **Marvell CN9K**
9 SoC family.
10
11 More information about CN9K 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 CN9K 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/cnxk` for setup information.
26
27 Device Setup
28 ------------
29
30 The CN9K REE devices will need to be bound to a user-space IO driver
31 for use. The script ``dpdk-devbind.py`` script included with DPDK can be
32 used to view the state of the devices and to bind them to a suitable
33 DPDK-supported kernel driver. When querying the status of the devices,
34 they 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
36 those devices alone.
37
38 Debugging Options
39 -----------------
40
41 .. _table_cn9k_regex_debug_options:
42
43 .. table:: CN9K regex device debug options
44
45    +---+------------+-------------------------------------------------------+
46    | # | Component  | EAL log command                                       |
47    +===+============+=======================================================+
48    | 1 | REE        | --log-level='pmd\.regex\.cn9k,8'                      |
49    +---+------------+-------------------------------------------------------+