Reviewed-by: Liron Himi <lir...@marvell.com>
-----Original Message-----
From: dev <dev-boun...@dpdk.org> On Behalf Of g...@marvell.com
Sent: Tuesday, 1 September 2020 15:25
To: Jerin Jacob Kollanukkaran <jer...@marvell.com>; Nithin Kumar Dabilpuram
<ndabilpu...@marvell.com>; tho...@monjalon.net; m...@ashroe.eu;
nhor...@tuxdriver.com; bruce.richard...@intel.com; anatoly.bura...@intel.com;
john.mcnam...@intel.com; marko.kovace...@intel.com
Cc: dev@dpdk.org; Smadar Fuks <smad...@marvell.com>; Dovrat Zifroni
<dov...@marvell.com>; Guy Kaneti <g...@marvell.com>; or...@mellanox.com
Subject: [dpdk-dev] [PATCH 4/4] doc: add Marvell OCTEON TX2 regex guide
From: Guy Kaneti <g...@marvell.com>
Signed-off-by: Guy Kaneti <g...@marvell.com>
---
doc/guides/platform/octeontx2.rst | 5 +++
doc/guides/regexdevs/features/octeontx2.ini | 10 +++++
doc/guides/regexdevs/index.rst | 1 +
doc/guides/regexdevs/octeontx2.rst | 49 +++++++++++++++++++++
doc/guides/rel_notes/release_20_11.rst | 5 +++
5 files changed, 70 insertions(+)
create mode 100644 doc/guides/regexdevs/features/octeontx2.ini
create mode 100644 doc/guides/regexdevs/octeontx2.rst
diff --git a/doc/guides/platform/octeontx2.rst
b/doc/guides/platform/octeontx2.rst
index 13255eec5..c4d64ab4b 100644
--- a/doc/guides/platform/octeontx2.rst
+++ b/doc/guides/platform/octeontx2.rst
@@ -67,6 +67,8 @@ DPDK subsystem.
+---+-----+--------------------------------------------------------------+
| 9 | SDP | rte_ethdev |
+---+-----+--------------------------------------------------------------+
+ | 10| REE | rte_regexdev |
+
+ +---+-----+-----------------------------------------------------------
+ ---+
PF0 is called the administrative / admin function (AF) and has exclusive
privileges to provision RVU functional block's LFs to each of the PF/VF.
@@ -156,6 +158,9 @@ This section lists dataplane H/W block(s) available in
OCTEON TX2 SoC.
#. **Crypto Device Driver**
See :doc:`../cryptodevs/octeontx2` for CPT crypto device driver information.
+#. **Regex Device Driver**
+ See :doc:`../regexdevs/octeontx2` for REE regex device driver information.
+
Procedure to Setup Platform
---------------------------
diff --git a/doc/guides/regexdevs/features/octeontx2.ini
b/doc/guides/regexdevs/features/octeontx2.ini
new file mode 100644
index 000000000..c9b421a16
--- /dev/null
+++ b/doc/guides/regexdevs/features/octeontx2.ini
@@ -0,0 +1,10 @@
+;
+; Supported features of the 'octeontx2' regex driver.
+;
+; Refer to default.ini for the full list of available driver features.
+;
+[Features]
+PCRE back reference = Y
+PCRE word boundary = Y
+Run time compilation = Y
+Armv8 = Y
diff --git a/doc/guides/regexdevs/index.rst b/doc/guides/regexdevs/index.rst
index 49216a932..b1abc826b 100644
--- a/doc/guides/regexdevs/index.rst
+++ b/doc/guides/regexdevs/index.rst
@@ -13,3 +13,4 @@ which can be used from an application through RegEx API.
features_overview
mlx5
+ octeontx2
diff --git a/doc/guides/regexdevs/octeontx2.rst
b/doc/guides/regexdevs/octeontx2.rst
new file mode 100644
index 000000000..859780da1
--- /dev/null
+++ b/doc/guides/regexdevs/octeontx2.rst
@@ -0,0 +1,49 @@
+.. SPDX-License-Identifier: BSD-3-Clause
+ Copyright(c) 2020 Marvell International Ltd.
+
+OCTEON TX2 REE Regexdev Driver
+===============================
+
+The OCTEON TX2 REE PMD (**librte_pmd_octeontx2_regex**) 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' |
+
+ +---+------------+----------------------------------------------------
+ ---+
diff --git a/doc/guides/rel_notes/release_20_11.rst
b/doc/guides/rel_notes/release_20_11.rst
index df227a177..05c0a8ba7 100644
--- a/doc/guides/rel_notes/release_20_11.rst
+++ b/doc/guides/rel_notes/release_20_11.rst
@@ -55,6 +55,11 @@ New Features
Also, make sure to start the actual text at the margin.
=======================================================
+* **Added Marvell OCTEON TX2 regex PMD.**
+
+ Added a new PMD driver for hardware regex offload block for OCTEON TX2 SoC.
+
+ See the :doc:`../regexdevs/octeontx2` for more details.
Removed Items
-------------
--
2.28.0
