DPDK patches and discussions
 help / color / mirror / Atom feed
From: <guyk@marvell.com>
To: <orika@mellanox.com>, <jerinj@marvell.com>,
	<ndabilpuram@marvell.com>, <thomas@monjalon.net>, <mdr@ashroe.eu>,
	<nhorman@tuxdriver.com>, <bruce.richardson@intel.com>,
	<anatoly.burakov@intel.com>, <john.mcnamara@intel.com>,
	<marko.kovacevic@intel.com>
Cc: <dev@dpdk.org>, <smadarf@marvell.com>, <dovrat@marvell.com>,
	<guyk@marvell.com>, <lironh@marvell.com>
Subject: [dpdk-dev] [PATCH v2 4/4] doc: add Marvell OCTEON TX2 regex guide
Date: Mon, 12 Oct 2020 14:31:35 +0300
Message-ID: <20201012113135.19476-5-guyk@marvell.com> (raw)
In-Reply-To: <20201012113135.19476-1-guyk@marvell.com>

From: Guy Kaneti <guyk@marvell.com>

Added Marvell OCTEON TX2 regex guide, features
and updated release notes.

Signed-off-by: Guy Kaneti <guyk@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 57e3edcdd..90b32936f 100644
--- a/doc/guides/rel_notes/release_20_11.rst
+++ b/doc/guides/rel_notes/release_20_11.rst
@@ -148,6 +148,11 @@ New Features
   * Extern objects and functions can be plugged into the pipeline.
   * Transaction-oriented table updates.
 
+* **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


  parent reply	other threads:[~2020-10-12 11:34 UTC|newest]

Thread overview: 33+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-01 12:24 [dpdk-dev] [PATCH 0/4] Add Marvell OCTEON TX2 regex driver guyk
2020-09-01 12:24 ` [dpdk-dev] [PATCH 1/4] common/octeontx2: add REE definitions and logging support guyk
2020-10-11  7:35   ` Liron Himi
2020-09-01 12:24 ` [dpdk-dev] [PATCH 2/4] regex/octeontx2: add build infra and device support guyk
2020-10-11  7:36   ` Liron Himi
2020-09-01 12:24 ` [dpdk-dev] [PATCH 3/4] usertools: add octeontx2 REE device binding guyk
2020-10-11  7:36   ` Liron Himi
2020-09-01 12:24 ` [dpdk-dev] [PATCH 4/4] doc: add Marvell OCTEON TX2 regex guide guyk
2020-10-11  7:36   ` Liron Himi
2020-10-08  6:31 ` [dpdk-dev] [PATCH 0/4] Add Marvell OCTEON TX2 regex driver Guy Kaneti
2020-10-11 21:23   ` Thomas Monjalon
2020-10-12 11:34     ` [dpdk-dev] [EXT] " Guy Kaneti
2020-10-12 11:31 ` [dpdk-dev] [PATCH v2 " guyk
2020-10-12 11:31   ` [dpdk-dev] [PATCH v2 1/4] common/octeontx2: add REE definitions and logging support guyk
2020-10-12 11:31   ` [dpdk-dev] [PATCH v2 2/4] regex/octeontx2: add build infra and device support guyk
2020-10-12 14:33     ` Thomas Monjalon
2020-10-12 17:06       ` [dpdk-dev] [EXT] " Guy Kaneti
2020-10-12 17:10         ` Thomas Monjalon
2020-10-12 17:13           ` Guy Kaneti
2020-10-12 17:19             ` Thomas Monjalon
2020-10-12 11:31   ` [dpdk-dev] [PATCH v2 3/4] usertools: add octeontx2 REE device binding guyk
2020-10-12 14:35     ` Thomas Monjalon
2020-10-12 11:31   ` guyk [this message]
2020-10-12 14:38     ` [dpdk-dev] [PATCH v2 4/4] doc: add Marvell OCTEON TX2 regex guide Thomas Monjalon
2020-10-12 17:09       ` [dpdk-dev] [EXT] " Guy Kaneti
2020-10-12 17:12         ` Thomas Monjalon
2020-10-13 10:10 ` [dpdk-dev] [PATCH v3 0/3] Add Marvell OCTEON TX2 regex driver guyk
2020-10-13 10:10   ` [dpdk-dev] [PATCH v3 1/3] common/octeontx2: add REE definitions and logging support guyk
2020-10-14  8:18     ` Thomas Monjalon
2020-10-13 10:10   ` [dpdk-dev] [PATCH v3 2/3] regex/octeontx2: add build infra and device support guyk
2020-10-14  8:26     ` Thomas Monjalon
2020-10-13 10:10   ` [dpdk-dev] [PATCH v3 3/3] usertools: add octeontx2 REE device binding guyk
2020-10-14  8:42   ` [dpdk-dev] [PATCH v3 0/3] Add Marvell OCTEON TX2 regex driver Thomas Monjalon

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20201012113135.19476-5-guyk@marvell.com \
    --to=guyk@marvell.com \
    --cc=anatoly.burakov@intel.com \
    --cc=bruce.richardson@intel.com \
    --cc=dev@dpdk.org \
    --cc=dovrat@marvell.com \
    --cc=jerinj@marvell.com \
    --cc=john.mcnamara@intel.com \
    --cc=lironh@marvell.com \
    --cc=marko.kovacevic@intel.com \
    --cc=mdr@ashroe.eu \
    --cc=ndabilpuram@marvell.com \
    --cc=nhorman@tuxdriver.com \
    --cc=orika@mellanox.com \
    --cc=smadarf@marvell.com \
    --cc=thomas@monjalon.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

DPDK patches and discussions

This inbox may be cloned and mirrored by anyone:

	git clone --mirror https://inbox.dpdk.org/dev/0 dev/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 dev dev/ https://inbox.dpdk.org/dev \
		dev@dpdk.org
	public-inbox-index dev

Example config snippet for mirrors.
Newsgroup available over NNTP:
	nntp://inbox.dpdk.org/inbox.dpdk.dev


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git