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 AD1A7A04B6; Sun, 11 Oct 2020 09:37:30 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id D9FB61D537; Sun, 11 Oct 2020 09:37:05 +0200 (CEST) Received: from mx0b-0016f401.pphosted.com (mx0a-0016f401.pphosted.com [67.231.148.174]) by dpdk.org (Postfix) with ESMTP id 642241D183 for ; Sun, 11 Oct 2020 09:37:04 +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 09B7Z9hW004551; Sun, 11 Oct 2020 00:37:00 -0700 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=marvell.com; h=from : to : cc : subject : date : message-id : references : in-reply-to : content-type : content-transfer-encoding : mime-version; s=pfpt0220; bh=6Gb0TTqhgsdmFwyiY4ZksB6LgeBXKbMCG1xmKQJGbrk=; b=Yh/4y53/kNBvq8AsNQG6I3QU9YiTdLGFHd9/OiikpRNIfNbGQjsAOp0ujVNKdOUNRfZU g9E1spTxUArppuB1ZR2eau4LUZgztvEyA9QYrmK2ifb2oE57YT0msfU+BfhnnEcNMuBp u5EUO54TbOuJKVuGdCqj/b51XVUJSR3/2RMIctSt4Y+wamluce0vxSfIn8fIqmhc/zF6 8KWDU+AdOPmLK8RfkAfFrYnewHMAKK6ttVBqhpsab9vJKc+CArJz+Mo6thsA3/b5jo/4 yPVO3xtGyNNEJ3JjG3KAnkXONoFi+SrFg6zJrFjoruvewgnA5zE/wNn9LI1gBfy3CZEp Cw== Received: from sc-exch03.marvell.com ([199.233.58.183]) by mx0a-0016f401.pphosted.com with ESMTP id 343aana8j0-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-SHA384 bits=256 verify=NOT); Sun, 11 Oct 2020 00:37:00 -0700 Received: from SC-EXCH04.marvell.com (10.93.176.84) by SC-EXCH03.marvell.com (10.93.176.83) with Microsoft SMTP Server (TLS) id 15.0.1497.2; Sun, 11 Oct 2020 00:36:59 -0700 Received: from NAM12-MW2-obe.outbound.protection.outlook.com (104.47.66.45) by SC-EXCH04.marvell.com (10.93.176.84) with Microsoft SMTP Server (TLS) id 15.0.1497.2 via Frontend Transport; Sun, 11 Oct 2020 00:36:59 -0700 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=bJx8SHtb+w9ckCjO6/MbIU2kBfu4Sd6u7pe4cBL83y66lad0sTct8wWNk7EGntkgY1m1ApMJiMB/1pq/8kD7qcMm/qToWdVfL6ncekwIJo5+/HxQMMGDGetkWaPYdKh1eZZwvtnFSOv7mKXSBTPkUGUmd3S/w6804xgpDyKQGBtqz6FcQ7ImRnuJFmYn4YrDu7+R8XQ8o/Qz2wOTVDDtnR9aqJ0hbkUdxuSwZY7RbR6nFN1eolxp2h4J/ZDPxDYmXg/A5M3pZy57j9lO9HKvauCk16qcoQp3sgxTf9UdmE9C4sIja1AhaKbx0RjRHejvIwBlIHNpkeUCT2sunUW5Ww== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=6Gb0TTqhgsdmFwyiY4ZksB6LgeBXKbMCG1xmKQJGbrk=; b=CmFgRQW7KVww1DnOK6/s3GVc0U/0iVXmSSZzzq46lg65eu/5GJCzNfFzIrR8R5gTonoQej6CVo1lR102NvJi5/P/BqThk1zgkswkN6N/W89HYrw2qkFzLijdNp/XFJhhGeAX4pFLo+ADv0mOlr5hQ0+JNT9OVymIDnHnvaEB2seTwVX12ZCVkyt07jpmQdqoeHPFuXdMaLhYR5homk39Lkys7dFLXTBddj2/qhauECDa2i8SgVUM4Agbi2+nZljhfzsELO7y4bU2bkeksnACX5Q4P1sBQPtWVKbwYUZyYzkzrkLEN50EbkyTTvqb9I5QD6QjecP3LU3poJhRbMMe6g== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=marvell.com; dmarc=pass action=none header.from=marvell.com; dkim=pass header.d=marvell.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=marvell.onmicrosoft.com; s=selector1-marvell-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=6Gb0TTqhgsdmFwyiY4ZksB6LgeBXKbMCG1xmKQJGbrk=; b=JyQbGMIh3UGZW8nyXqwg2gEdnmS4cpkxyD4M3l1VG0euq4t6dtCiV/nN2BZM/h7iIeegLWXPX05j2yKFk9cCPTtH0iGUAtlqZrVAhGBzPumO2Jn7TbiE29MVEn61vX73vbmowZ9rvpY6A66wPvLy0Gl/JwyIx4tbzCvfTLvqqOM= Received: from DM5PR18MB2214.namprd18.prod.outlook.com (2603:10b6:4:b9::21) by DM5PR18MB1321.namprd18.prod.outlook.com (2603:10b6:3:14f::12) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.3455.21; Sun, 11 Oct 2020 07:36:58 +0000 Received: from DM5PR18MB2214.namprd18.prod.outlook.com ([fe80::48c2:9ca9:3159:368e]) by DM5PR18MB2214.namprd18.prod.outlook.com ([fe80::48c2:9ca9:3159:368e%5]) with mapi id 15.20.3455.029; Sun, 11 Oct 2020 07:36:58 +0000 From: Liron Himi To: Guy Kaneti , Jerin Jacob Kollanukkaran , Nithin Kumar Dabilpuram , "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" , Smadar Fuks , "Dovrat Zifroni" , Guy Kaneti , "orika@mellanox.com" , Liron Himi Thread-Topic: [dpdk-dev] [PATCH 4/4] doc: add Marvell OCTEON TX2 regex guide Thread-Index: AQHWgFs63WDA1zFtDUCdmhgTaqXzCamSQdrQ Date: Sun, 11 Oct 2020 07:36:58 +0000 Message-ID: References: <20200901122436.17748-1-guyk@marvell.com> <20200901122436.17748-5-guyk@marvell.com> In-Reply-To: <20200901122436.17748-5-guyk@marvell.com> Accept-Language: he-IL, en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-originating-ip: [89.139.26.150] x-ms-publictraffictype: Email x-ms-office365-filtering-correlation-id: 01868bda-0381-4e63-16f5-08d86db86f93 x-ms-traffictypediagnostic: DM5PR18MB1321: x-ms-exchange-transport-forked: True x-microsoft-antispam-prvs: x-ms-oob-tlc-oobclassifiers: OLM:7219; x-ms-exchange-senderadcheck: 1 x-microsoft-antispam: BCL:0; x-microsoft-antispam-message-info: 0mmUJZ76Kj3RSYnUI+/G6MjPUxAlC/llWXAZcM01zzrRsO75hxQgaj1wpNc2Uac9EZTUF3b1DoNvZJ+AecjnIN0/y7Wq5nzXVoRbeRlKicocoOScDVwT6gspuVa9WurrclD8N4uPnAdTx0G6uA6HVtNrgVOpMxW7jC8rraLUB2a2HuKgLVyDRdVKIiaJwpQAC+o5W/PqV1trWrEozf7E4u7TQxIrq7Ditf9rSNgRy07JGW/S4nh5RtVfqcM12KmxOv/FXrygO73rIIW3X09MWXGdnP/wvWLvQzGVxzeHuXHkaePvevU4RH32iu8sTGBPH1RP9GJ6YFtRLqApR4YCvtTGdFVgbOevfpfpjE3chLTZpE+i/qRFxuc11vcNqDofYNp4Z9ZpClDLzVrRjuKYls75Vs1Y729jqFf3fTal3kpjerutpL6jiENeADoxDqa9lIcmC7v64iw8ToygabbTmg== x-forefront-antispam-report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:DM5PR18MB2214.namprd18.prod.outlook.com; PTR:; CAT:NONE; SFS:(4636009)(39850400004)(136003)(396003)(376002)(366004)(346002)(71200400001)(86362001)(66446008)(478600001)(83080400001)(66476007)(66946007)(8936002)(64756008)(26005)(186003)(9686003)(66556008)(4326008)(110136005)(7696005)(54906003)(53546011)(52536014)(2906002)(5660300002)(6506007)(55016002)(76116006)(8676002)(316002)(83380400001)(107886003)(33656002)(921003); DIR:OUT; SFP:1101; x-ms-exchange-antispam-messagedata: jyg0I4HaF4MuSt96qE8z1VbQOcOFUeTaru2gyr+rwAUn78KwtzR6V0oT6xhnMuAQAsqfi6ewhUKWQvubF3a9NImTspe6lUpTL5afwDLyp8ZvLCdWn9+fnl8tGR26ltIPpJ1KBilXczPj9p/YzFvMkGKAU8wMi5LeKd/pxpb+CQeLv0HWXkvmkb9v7p8yfXj7y95AFIGbYCCP6k8HHDoi36BneCpkQMRAZuuoYlt3uClyF4LJCeurYXFJNW00w7hVdQaEC4u+zOH162iO8GEH0io+4xHRVgJmJwr7tNifgYYLdczuk3fxAU1dZtLHZdYNRqZhglwXDye/R8K6yxA/h6wvGVoDlFqXbqRd79zZxCJA6Vvw4X9NRsFH6QMNKdLExpgu2dyudUd/IQXy68HipoCvBtuoTo+6C0JnGAMvjfperveIz6qaIvxQhiA9wBRqM/CbnjsWbi7fD70L7lPC6yW5hXzDcKqnO3A0+NO5JTcEh5VEflWkyT/xiYQx0RI3Gcy9ABzv+IlCzaVEbxnNm3GI427YFrSXZfbMyoJIeDoMmVBytrhSDRvnoeZc8Tw88Tj1GpzSf6Fv3AbQpv5vXs/0SzCoLz0MO9gty0XbZJgC942jGtOjT+L1nu8/CKrJJ4Jysr8FzsE8nr5yhmevNQ== Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-AuthSource: DM5PR18MB2214.namprd18.prod.outlook.com X-MS-Exchange-CrossTenant-Network-Message-Id: 01868bda-0381-4e63-16f5-08d86db86f93 X-MS-Exchange-CrossTenant-originalarrivaltime: 11 Oct 2020 07:36:58.4526 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: 70e1fb47-1155-421d-87fc-2e58f638b6e0 X-MS-Exchange-CrossTenant-mailboxtype: HOSTED X-MS-Exchange-CrossTenant-userprincipalname: ciUqJ4xBCpNHrkJzeZCPeGXPOkP8uJPZyTcz1GaGM8sAi9eKu9xq6b4Wu/bTPfmcgBTe1xMkYxJUuXsOz4E+gw== X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM5PR18MB1321 X-OriginatorOrg: marvell.com X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:6.0.235, 18.0.687 definitions=2020-10-10_07:2020-10-09, 2020-10-10 signatures=0 Subject: Re: [dpdk-dev] [PATCH 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" Reviewed-by: Liron Himi -----Original Message----- From: dev On Behalf Of guyk@marvell.com Sent: Tuesday, 1 September 2020 15:25 To: Jerin Jacob Kollanukkaran ; Nithin Kumar Dabilpuram= ; thomas@monjalon.net; mdr@ashroe.eu; nhorman@tux= driver.com; bruce.richardson@intel.com; anatoly.burakov@intel.com; john.mcn= amara@intel.com; marko.kovacevic@intel.com Cc: dev@dpdk.org; Smadar Fuks ; Dovrat Zifroni ; Guy Kaneti ; orika@mellanox.com Subject: [dpdk-dev] [PATCH 4/4] doc: add Marvell OCTEON TX2 regex guide From: Guy Kaneti 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/octeon= tx2.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 = | + =20 + +---+-----+----------------------------------------------------------- + ---+ =20 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 informa= tion. =20 +#. **Regex Device Driver** + See :doc:`../regexdevs/octeontx2` for REE regex device driver informati= on. + Procedure to Setup Platform --------------------------- =20 diff --git a/doc/guides/regexdevs/features/octeontx2.ini b/doc/guides/regex= devs/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 =3D Y +PCRE word boundary =3D Y +Run time compilation =3D Y +Armv8 =3D Y diff --git a/doc/guides/regexdevs/index.rst b/doc/guides/regexdevs/index.rs= t 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. =20 features_overview mlx5 + octeontx2 diff --git a/doc/guides/regexdevs/octeontx2.rst b/doc/guides/regexdevs/octe= ontx2.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 +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D + +The OCTEON TX2 REE PMD (**librte_pmd_octeontx2_regex**) provides poll=20 +mode regexdev driver support for the inbuilt regex device found in the=20 +**Marvell OCTEON TX2** SoC family. + +More information about OCTEON TX2 SoC can be found at `Marvell Official=20 +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=20 +driver for use. The script ``dpdk-devbind.py`` script included with=20 +DPDK can be used to view the state of the devices and to bind them to a=20 +suitable DPDK-supported kernel driver. When querying the status of the=20 +devices, they will appear under the category of "REGEX devices", i.e.=20 +the command ``dpdk-devbind.py --status-dev regex`` can be used to see=20 +the state of those devices alone. + +Debugging Options +----------------- + +.. _table_octeontx2_regex_debug_options: + +.. table:: OCTEON TX2 regex device debug options + + +---+------------+-----------------------------------------------------= --+ + | # | Component | EAL log command = | + +=3D=3D=3D+=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D+=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D+ + | 1 | REE | --log-level=3D'pmd\.regex\.octeontx2,8' = | + =20 + +---+------------+---------------------------------------------------- + ---+ 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. =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D =20 +* **Added Marvell OCTEON TX2 regex PMD.** + + Added a new PMD driver for hardware regex offload block for OCTEON TX2 S= oC. + + See the :doc:`../regexdevs/octeontx2` for more details. =20 Removed Items ------------- -- 2.28.0