From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id ED832A04B6; Mon, 12 Oct 2020 16:38:48 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id A1F1D1D72D; Mon, 12 Oct 2020 16:38:47 +0200 (CEST) Received: from new4-smtp.messagingengine.com (new4-smtp.messagingengine.com [66.111.4.230]) by dpdk.org (Postfix) with ESMTP id CB4141D64C for ; Mon, 12 Oct 2020 16:38:45 +0200 (CEST) Received: from compute2.internal (compute2.nyi.internal [10.202.2.42]) by mailnew.nyi.internal (Postfix) with ESMTP id 6E3B65802E0; Mon, 12 Oct 2020 10:38:44 -0400 (EDT) Received: from mailfrontend1 ([10.202.2.162]) by compute2.internal (MEProxy); Mon, 12 Oct 2020 10:38:44 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h= from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding:content-type; s=fm2; bh= F0NNdATM/8rHR4qhsQXlFV0xoe6a6PZzH6DT4hVebCQ=; b=G6pfSFc9pjWm8S6/ h4hNx7/NT9Xe2w0eUHRDsrpllqNIL63s75JPzGN3Dtjx9UwgB4Y7k1FPuLski5vV 83d5WP/7kr9AfnCCD+iF0q5cT+O096FYF0bpplSryoxzb8Bb1OzG7BGbyiV5CTX4 tCZJv/Ef/hoMh491nz5+v6g639R4lyqk5dkp1P5WvL+T++6j8VzQlKswPmFkw7YQ iUDMeCGxCelLj/PSr9T7mQekT7IqouKlG8HMw7V5uIRFYUlvXgp0SZwuwWNE4Q1z tAfDYn+V0U29zAvhQvPh5Suj9yxU8V6BUIoGqZeLVLTGDmcIJcw2ZvQ6Prn9LM8L jVqU+w== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:content-transfer-encoding:content-type :date:from:in-reply-to:message-id:mime-version:references :subject:to:x-me-proxy:x-me-proxy:x-me-sender:x-me-sender :x-sasl-enc; s=fm1; bh=F0NNdATM/8rHR4qhsQXlFV0xoe6a6PZzH6DT4hVeb CQ=; b=V/N5MXjRfDe1dSlpSEUTBl25LD0FeXWFYQofYz/oC1OnRFmJ3qy9QruV5 7HwIredijXD4+UrH76HfLRCxXTFacrxsMkYxoij5yHYwvYxefpOGzWnAOd1N0Fbw JLu997IniSYPbI4J9tOc+9SV426sT7LZFQD2vNUFHa4ZLq/1hIvGDklKhg9RsSw3 NNlyAb3vU87SOE3yd0Nb1kj/GM+v+2J4ZE0+Q8yDnEb7W9gsR5q7vtf9pOJXdZCg nTL0RhMMIIDsq52hX9ji6hGeUaci3tSDAYH7TiAhamjbSoyyou/geU7JokZGQqEW kBnUn+vfvjXMC3poGGKDLjxd6edZg== X-ME-Sender: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedujedrheejgdejlecutefuodetggdotefrodftvf curfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfghnecu uegrihhlohhuthemuceftddtnecunecujfgurhephffvufffkfgjfhgggfgtsehtufertd dttddvnecuhfhrohhmpefvhhhomhgrshcuofhonhhjrghlohhnuceothhhohhmrghssehm ohhnjhgrlhhonhdrnhgvtheqnecuggftrfgrthhtvghrnhepvdfhvdffudfhlefgvdeiue elffffhfetuedtteegfefhgffhgefhhfdtgeegtdfgnecuffhomhgrihhnpehmrghrvhgv lhhlrdgtohhmnecukfhppeejjedrudefgedrvddtfedrudekgeenucevlhhushhtvghruf hiiigvpedtnecurfgrrhgrmhepmhgrihhlfhhrohhmpehthhhomhgrshesmhhonhhjrghl ohhnrdhnvght X-ME-Proxy: Received: from xps.localnet (184.203.134.77.rev.sfr.net [77.134.203.184]) by mail.messagingengine.com (Postfix) with ESMTPA id C3F9F3280059; Mon, 12 Oct 2020 10:38:41 -0400 (EDT) From: Thomas Monjalon To: guyk@marvell.com Cc: orika@mellanox.com, jerinj@marvell.com, 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, smadarf@marvell.com, dovrat@marvell.com, lironh@marvell.com Date: Mon, 12 Oct 2020 16:38:40 +0200 Message-ID: <3477354.qUSQHamrt8@thomas> In-Reply-To: <20201012113135.19476-5-guyk@marvell.com> References: <20200901122436.17748-1-guyk@marvell.com> <20201012113135.19476-1-guyk@marvell.com> <20201012113135.19476-5-guyk@marvell.com> MIME-Version: 1.0 Content-Transfer-Encoding: 7Bit Content-Type: text/plain; charset="us-ascii" Subject: Re: [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 List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 12/10/2020 13:31, guyk@marvell.com: > From: Guy Kaneti > > 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 > --- > 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 > +`_. > + > +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).