From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <dev-bounces@dpdk.org>
Received: from dpdk.org (dpdk.org [92.243.14.124])
by inbox.dpdk.org (Postfix) with ESMTP id 75D17A04B6;
Mon, 12 Oct 2020 13:34:49 +0200 (CEST)
Received: from [92.243.14.124] (localhost [127.0.0.1])
by dpdk.org (Postfix) with ESMTP id 09D0C1D717;
Mon, 12 Oct 2020 13:33:40 +0200 (CEST)
Received: from mx0b-0016f401.pphosted.com (mx0a-0016f401.pphosted.com
[67.231.148.174]) by dpdk.org (Postfix) with ESMTP id 2E4151D716
for <dev@dpdk.org>; Mon, 12 Oct 2020 13:33:38 +0200 (CEST)
Received: from pps.filterd (m0045849.ppops.net [127.0.0.1])
by mx0a-0016f401.pphosted.com (8.16.0.42/8.16.0.42) with SMTP id
09CBP6T2007951; Mon, 12 Oct 2020 04:33:35 -0700
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=marvell.com;
h=from : to : cc :
subject : date : message-id : in-reply-to : references : mime-version :
content-transfer-encoding : content-type; s=pfpt0220;
bh=jBBZEoUE0oVwU8QzxtDimx83Ttz/M92CZXuEV8LxnyQ=;
b=c3gIJuKVZ2nelbfxXt7SoXwBYXJaXuhyB01R8BHx8FaQnYjJ40uP9Xa5XYQG7PtxFJPd
3LbTNESrheJypr1HtsJzjCNMPHaaSoPpGy414IisZNDEOu8pvE9nHKHaDjvb96mvc2r4
Cs5TZ9CBwLkddM+i4CqdM0kqzvHUuRcYuI/edEu5zItZooHn65ACssTNmhSYekxW8FME
iNAsGMC9AFINB2ni8ORUCjBPUYLnSoS7jEBuGL4FpDUoKrZqxgKU9uoxIC2J9R8liePt
jiphyF9u9x+bUNo2xd7HtxIG2r2iQfsCh/+2MEjUlmqdCyJM3kUAByiH4acLYBE0tY4+ fA==
Received: from sc-exch02.marvell.com ([199.233.58.182])
by mx0a-0016f401.pphosted.com with ESMTP id 343aandwy7-1
(version=TLSv1.2 cipher=ECDHE-RSA-AES256-SHA384 bits=256 verify=NOT);
Mon, 12 Oct 2020 04:33:35 -0700
Received: from DC5-EXCH01.marvell.com (10.69.176.38) by SC-EXCH02.marvell.com
(10.93.176.82) with Microsoft SMTP Server (TLS) id 15.0.1497.2;
Mon, 12 Oct 2020 04:33:34 -0700
Received: from maili.marvell.com (10.69.176.80) by DC5-EXCH01.marvell.com
(10.69.176.38) with Microsoft SMTP Server id 15.0.1497.2 via Frontend
Transport; Mon, 12 Oct 2020 04:33:34 -0700
Received: from vvenus124.il.marvell.com (unknown [10.5.116.64])
by maili.marvell.com (Postfix) with ESMTP id 481063F703F;
Mon, 12 Oct 2020 04:33:30 -0700 (PDT)
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>
Date: Mon, 12 Oct 2020 14:31:35 +0300
Message-ID: <20201012113135.19476-5-guyk@marvell.com>
X-Mailer: git-send-email 2.28.0
In-Reply-To: <20201012113135.19476-1-guyk@marvell.com>
References: <20200901122436.17748-1-guyk@marvell.com>
<20201012113135.19476-1-guyk@marvell.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:6.0.235, 18.0.687
definitions=2020-10-12_09:2020-10-12,
2020-10-12 signatures=0
Subject: [dpdk-dev] [PATCH v2 4/4] doc: add Marvell OCTEON TX2 regex guide
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
<mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
<mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>
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