diff mbox series

[v2,4/4] doc: add Marvell OCTEON TX2 regex guide

Message ID 20201012113135.19476-5-guyk@marvell.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers show
Series Add Marvell OCTEON TX2 regex driver | expand

Checks

Context Check Description
ci/Intel-compilation success Compilation OK
ci/iol-mellanox-Performance success Performance Testing PASS
ci/travis-robot success Travis build: passed
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-testing success Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/checkpatch success coding style OK

Commit Message

Guy Kaneti Oct. 12, 2020, 11:31 a.m. UTC
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

Comments

Thomas Monjalon Oct. 12, 2020, 2:38 p.m. UTC | #1
12/10/2020 13:31, guyk@marvell.com:
> From: Guy Kaneti <guyk@marvell.com>
> 
> Added Marvell OCTEON TX2 regex guide, features
> and updated release notes.

I think this patch should be merged with doc changes:
	- almost all in patch 2 with driver code
	- the dpdk-devbind.py chapter in patch 3


> 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.

Missing blank line and should be sorted with other drivers (before rawdev).
Guy Kaneti Oct. 12, 2020, 5:09 p.m. UTC | #2
Hi,

> -----Original Message-----
> From: Thomas Monjalon <thomas@monjalon.net>
> Sent: Monday, October 12, 2020 5:39 PM
> To: Guy Kaneti <guyk@marvell.com>
> Cc: orika@mellanox.com; Jerin Jacob Kollanukkaran <jerinj@marvell.com>;
> Nithin Kumar Dabilpuram <ndabilpuram@marvell.com>; mdr@ashroe.eu;
> nhorman@tuxdriver.com; bruce.richardson@intel.com;
> anatoly.burakov@intel.com; john.mcnamara@intel.com;
> marko.kovacevic@intel.com; dev@dpdk.org; Smadar Fuks
> <smadarf@marvell.com>; Dovrat Zifroni <dovrat@marvell.com>; Liron Himi
> <lironh@marvell.com>
> Subject: [EXT] Re: [dpdk-dev] [PATCH v2 4/4] doc: add Marvell OCTEON TX2
> regex guide
> 
> External Email
> 
> ----------------------------------------------------------------------
> 12/10/2020 13:31, guyk@marvell.com:
> > From: Guy Kaneti <guyk@marvell.com>
> >
> > Added Marvell OCTEON TX2 regex guide, features and updated release
> > notes.
> 
> I think this patch should be merged with doc changes:
> 	- almost all in patch 2 with driver code
> 	- the dpdk-devbind.py chapter in patch 3

Do you mean do merge this patch with patch 2?
Thomas Monjalon Oct. 12, 2020, 5:12 p.m. UTC | #3
12/10/2020 19:09, Guy Kaneti:
> From: Thomas Monjalon <thomas@monjalon.net>
> > 12/10/2020 13:31, guyk@marvell.com:
> > > From: Guy Kaneti <guyk@marvell.com>
> > >
> > > Added Marvell OCTEON TX2 regex guide, features and updated release
> > > notes.
> > 
> > I think this patch should be merged with doc changes:

I meant with "code changes".

> > 	- almost all in patch 2 with driver code
> > 	- the dpdk-devbind.py chapter in patch 3
> 
> Do you mean do merge this patch with patch 2?

Almost yes.
The doc part about dpdk-devbind.py should be in patch 3.
diff mbox series

Patch

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
 -------------