From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id ECFE4A0C43; Fri, 22 Oct 2021 09:48:53 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id AADB941103; Fri, 22 Oct 2021 09:48:53 +0200 (CEST) Received: from mx0b-0016f401.pphosted.com (mx0a-0016f401.pphosted.com [67.231.148.174]) by mails.dpdk.org (Postfix) with ESMTP id 23E7D4069D for ; Fri, 22 Oct 2021 09:48:51 +0200 (CEST) Received: from pps.filterd (m0045849.ppops.net [127.0.0.1]) by mx0a-0016f401.pphosted.com (8.16.1.2/8.16.1.2) with SMTP id 19M5qdsv016909; Fri, 22 Oct 2021 00:48:51 -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=/Z7MxL69iJvQRUu6qRFu+HEg5DBpFavJOTkfHWkEhp0=; b=Pk9jMDprlxFIcC3c6lamrrau9JtjLFhCx2VdqJCEpu5JfHRD1+QXl06n+rMYckotkhEk +AGrHpNSVp3HpZYtFPHq0ixrbAWKxMkVfT/ZHk9q5cJLkBHRbBFPFb12i5BBVASVzxAl ezbSGNr/aT5/HXXgQrjxCkHygvrU3r7mmZgYkjZiROIQDyMkLe/EfYjOY9ETPOiGminf pkZfgpEjnqgUz2b9DKG9P1r/XbWjLQlTgS6NIfOQwxWEJKx3XiK6EEprJNjVlVv+9G5a GE+/+vmFYt98VqRJS1Koy2Mt95yJOOFd6Hzall/185ie+dqaiHSfLI+RzEJzFr4H8wJf 0A== Received: from dc5-exch01.marvell.com ([199.233.59.181]) by mx0a-0016f401.pphosted.com with ESMTP id 3bueuyte1u-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-SHA384 bits=256 verify=NOT); Fri, 22 Oct 2021 00:48:51 -0700 Received: from DC5-EXCH01.marvell.com (10.69.176.38) by DC5-EXCH01.marvell.com (10.69.176.38) with Microsoft SMTP Server (TLS) id 15.0.1497.18; Fri, 22 Oct 2021 00:48:49 -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.18 via Frontend Transport; Fri, 22 Oct 2021 00:48:49 -0700 Received: from localhost.localdomain (unknown [10.28.34.25]) by maili.marvell.com (Postfix) with ESMTP id D264D3F707D; Fri, 22 Oct 2021 00:48:46 -0700 (PDT) From: To: , , , , , , , CC: , Sunil Kumar Kori Date: Fri, 22 Oct 2021 13:18:40 +0530 Message-ID: <20211022074843.907766-1-skori@marvell.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20200227070301.11520-1-skori@marvell.com> References: <20200227070301.11520-1-skori@marvell.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Type: text/plain X-Proofpoint-ORIG-GUID: rWCoZdgQPCRWQ0CFfx0j63nmi6cE9kFd X-Proofpoint-GUID: rWCoZdgQPCRWQ0CFfx0j63nmi6cE9kFd X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.182.1,Aquarius:18.0.790,Hydra:6.0.425,FMLib:17.0.607.475 definitions=2021-10-22_02,2021-10-21_02,2020-04-07_01 Subject: [dpdk-dev] [PATCH v5 1/4] doc: add skeleton for eventdevs feature matrices X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 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" From: Sunil Kumar Kori Patch adds skeleton for feature matrices for event dev and Rx/Tx adapters. Along with, .ini files are added for all supported PMDs. Signed-off-by: Sunil Kumar Kori --- v5: - Rebased to 21.11 - Added feature matrix for cnxk. v4: - Rebased to 20.02 v3: - Removed .txt files to generate tables. - Use conf.py script to generate tables. - Add .ini file for all supported PMDs. v2: - Review comments incorporated .gitignore | 2 ++ doc/guides/conf.py | 12 ++++++++- doc/guides/eventdevs/features/cnxk.ini | 8 ++++++ doc/guides/eventdevs/features/default.ini | 30 +++++++++++++++++++++ doc/guides/eventdevs/features/dpaa.ini | 8 ++++++ doc/guides/eventdevs/features/dpaa2.ini | 8 ++++++ doc/guides/eventdevs/features/dsw.ini | 8 ++++++ doc/guides/eventdevs/features/octeontx.ini | 8 ++++++ doc/guides/eventdevs/features/octeontx2.ini | 8 ++++++ doc/guides/eventdevs/features/opdl.ini | 8 ++++++ doc/guides/eventdevs/features/sw.ini | 8 ++++++ doc/guides/eventdevs/index.rst | 1 + doc/guides/eventdevs/overview.rst | 19 +++++++++++++ 13 files changed, 127 insertions(+), 1 deletion(-) create mode 100644 doc/guides/eventdevs/features/cnxk.ini create mode 100644 doc/guides/eventdevs/features/default.ini create mode 100644 doc/guides/eventdevs/features/dpaa.ini create mode 100644 doc/guides/eventdevs/features/dpaa2.ini create mode 100644 doc/guides/eventdevs/features/dsw.ini create mode 100644 doc/guides/eventdevs/features/octeontx.ini create mode 100644 doc/guides/eventdevs/features/octeontx2.ini create mode 100644 doc/guides/eventdevs/features/opdl.ini create mode 100644 doc/guides/eventdevs/features/sw.ini create mode 100644 doc/guides/eventdevs/overview.rst diff --git a/.gitignore b/.gitignore index b19c0717e6..b3fc783945 100644 --- a/.gitignore +++ b/.gitignore @@ -14,6 +14,8 @@ doc/guides/compressdevs/overview_feature_table.txt doc/guides/regexdevs/overview_feature_table.txt doc/guides/vdpadevs/overview_feature_table.txt doc/guides/bbdevs/overview_feature_table.txt +doc/guides/eventdevs/overview_feature_table.txt +doc/guides/eventdevs/overview_adptr_feature_table.txt # ignore generated ctags/cscope files cscope.out.po diff --git a/doc/guides/conf.py b/doc/guides/conf.py index 67d2dd62c7..9d8e20e5fc 100644 --- a/doc/guides/conf.py +++ b/doc/guides/conf.py @@ -41,7 +41,7 @@ master_doc = 'index' # Maximum feature description string length -feature_str_len = 30 +feature_str_len = 45 # Figures, tables and code-blocks automatically numbered if they have caption numfig = True @@ -388,6 +388,16 @@ def setup(app): 'Features', 'Features availability in bbdev drivers', 'Feature') + table_file = dirname(__file__) + '/eventdevs/overview_feature_table.txt' + generate_overview_table(table_file, 1, + 'Features', + 'Features availability in eventdev drivers', + 'Feature') + table_file = dirname(__file__) + '/eventdevs/overview_adptr_feature_table.txt' + generate_overview_table(table_file, 2, + 'Adapter Features', + 'Features availability for adapters', + 'Feature') if LooseVersion(sphinx_version) < LooseVersion('1.3.1'): print('Upgrade sphinx to version >= 1.3.1 for ' diff --git a/doc/guides/eventdevs/features/cnxk.ini b/doc/guides/eventdevs/features/cnxk.ini new file mode 100644 index 0000000000..a461966d69 --- /dev/null +++ b/doc/guides/eventdevs/features/cnxk.ini @@ -0,0 +1,8 @@ +; +; Supported features of the 'cnxk' eventdev driver. +; +; Refer to default.ini for the full list of available PMD features. +; +[Features] + +[Adapter Features] diff --git a/doc/guides/eventdevs/features/default.ini b/doc/guides/eventdevs/features/default.ini new file mode 100644 index 0000000000..d007d7a69e --- /dev/null +++ b/doc/guides/eventdevs/features/default.ini @@ -0,0 +1,30 @@ +; +; Features of a default eventdev driver. +; +; This file defines the features that are valid for inclusion in +; the other driver files and also the order that they appear in +; the features table in the documentation. +; +[Features] +Event queue priority based scheduling = +Event priority based scheduling = +Event device distributed scheduling = +Event device non sequential mode = +Event queue all types = +Burst mode enqueue/dequeue = +Event port implicit release disable = +Runtime event queue/port linking = +Multi queue linking per port = + +; +; Features of a default adapter. +; +[Adapter Features] +Eth Rx/Tx adapter on internal port = +Multiple event queues per ethdev = +Override flow ID = +Crypto adapter new event enqueue = +Crypto adapter forwarded event enqueue = +Crypto queue pair mapping to event queue = +Crypto adapter session data store/retrieve = +Timer adapter support in H/W = diff --git a/doc/guides/eventdevs/features/dpaa.ini b/doc/guides/eventdevs/features/dpaa.ini new file mode 100644 index 0000000000..3cf172f408 --- /dev/null +++ b/doc/guides/eventdevs/features/dpaa.ini @@ -0,0 +1,8 @@ +; +; Supported features of the 'dpaa' eventdev driver. +; +; Refer to default.ini for the full list of available PMD features. +; +[Features] + +[Adapter Features] diff --git a/doc/guides/eventdevs/features/dpaa2.ini b/doc/guides/eventdevs/features/dpaa2.ini new file mode 100644 index 0000000000..822a82ef3e --- /dev/null +++ b/doc/guides/eventdevs/features/dpaa2.ini @@ -0,0 +1,8 @@ +; +; Supported features of the 'dpaa2' eventdev driver. +; +; Refer to default.ini for the full list of available PMD features. +; +[Features] + +[Adapter Features] diff --git a/doc/guides/eventdevs/features/dsw.ini b/doc/guides/eventdevs/features/dsw.ini new file mode 100644 index 0000000000..230737045b --- /dev/null +++ b/doc/guides/eventdevs/features/dsw.ini @@ -0,0 +1,8 @@ +; +; Supported features of the 'distributed software' eventdev driver. +; +; Refer to default.ini for the full list of available PMD features. +; +[Features] + +[Adapter Features] diff --git a/doc/guides/eventdevs/features/octeontx.ini b/doc/guides/eventdevs/features/octeontx.ini new file mode 100644 index 0000000000..d1b1fe6d62 --- /dev/null +++ b/doc/guides/eventdevs/features/octeontx.ini @@ -0,0 +1,8 @@ +; +; Supported features of the 'octeontx' eventdev driver. +; +; Refer to default.ini for the full list of available PMD features. +; +[Features] + +[Adapter Features] diff --git a/doc/guides/eventdevs/features/octeontx2.ini b/doc/guides/eventdevs/features/octeontx2.ini new file mode 100644 index 0000000000..96f1af0dca --- /dev/null +++ b/doc/guides/eventdevs/features/octeontx2.ini @@ -0,0 +1,8 @@ +; +; Supported features of the 'octeontx2' eventdev driver. +; +; Refer to default.ini for the full list of available PMD features. +; +[Features] + +[Adapter Features] diff --git a/doc/guides/eventdevs/features/opdl.ini b/doc/guides/eventdevs/features/opdl.ini new file mode 100644 index 0000000000..020808fced --- /dev/null +++ b/doc/guides/eventdevs/features/opdl.ini @@ -0,0 +1,8 @@ +; +; Supported features of 'Ordered Packet Distribution Library' eventdev driver. +; +; Refer to default.ini for the full list of available PMD features. +; +[Features] + +[Adapter Features] diff --git a/doc/guides/eventdevs/features/sw.ini b/doc/guides/eventdevs/features/sw.ini new file mode 100644 index 0000000000..a5789f56d4 --- /dev/null +++ b/doc/guides/eventdevs/features/sw.ini @@ -0,0 +1,8 @@ +; +; Supported features of the 'software' eventdev driver. +; +; Refer to default.ini for the full list of available PMD features. +; +[Features] + +[Adapter Features] diff --git a/doc/guides/eventdevs/index.rst b/doc/guides/eventdevs/index.rst index 2143025390..b11657f7ae 100644 --- a/doc/guides/eventdevs/index.rst +++ b/doc/guides/eventdevs/index.rst @@ -11,6 +11,7 @@ application through the eventdev API. :maxdepth: 2 :numbered: + overview cnxk dlb2 dpaa diff --git a/doc/guides/eventdevs/overview.rst b/doc/guides/eventdevs/overview.rst new file mode 100644 index 0000000000..5d34d2c57b --- /dev/null +++ b/doc/guides/eventdevs/overview.rst @@ -0,0 +1,19 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(C) 2021 Marvell. + +Event Device Supported Functionality Matrices +============================================= + +Event Device Supported Feature Flags +------------------------------------ + +.. _table_eventdev_pmd_features: + +.. include:: overview_feature_table.txt + +Adapter Supported Feature Flags +------------------------------- + +.. _table_adapter_features: + +.. include:: overview_adptr_feature_table.txt -- 2.25.1