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 68B52A0C4C; Tue, 23 Nov 2021 12:07:53 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 34DEC40040; Tue, 23 Nov 2021 12:07:53 +0100 (CET) Received: from mx0b-0016f401.pphosted.com (mx0b-0016f401.pphosted.com [67.231.156.173]) by mails.dpdk.org (Postfix) with ESMTP id F09654003C for ; Tue, 23 Nov 2021 12:07:51 +0100 (CET) Received: from pps.filterd (m0045851.ppops.net [127.0.0.1]) by mx0b-0016f401.pphosted.com (8.16.1.2/8.16.1.2) with ESMTP id 1ANANGPw005869; Tue, 23 Nov 2021 03:07:51 -0800 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=6TgI7SUV5RKn99KWhvXSbvOdaVa8LmnQOoV3GmpQO00=; b=cKRE2ngqbevoBzMkOI4f8RJdUjI2NjQEMzCWWpJSogC6efGMYNojUCYVlujrS/ooUpeA wdas1tmB1ng4wn5la1T/6nsYJrHIN8Jdpry3+mwoFOtfZcx3qNZmc6SbShtJGJcPi/1E PiHNlcYiNlZcNNXZ+Tl0/O+JDb0eDbBCz2SP6M7Oqgp4Mb64TJUasxcxO5PqIHntc3g4 5mI7QChelrNBXmFCNFB4bthIXUcj2lAnPMx8Qpt3f8KQ0oN+/WYRMkeXxfrgBfO28n5A 8BRAne4FAn6WuHjd+c81NPEs0MSazdgt8uDtA28Sf68hkH2ZcRMDDeBlockybhMrkepd Dg== Received: from dc5-exch01.marvell.com ([199.233.59.181]) by mx0b-0016f401.pphosted.com (PPS) with ESMTPS id 3cgug50xjj-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-SHA384 bits=256 verify=NOT); Tue, 23 Nov 2021 03:07:51 -0800 Received: from DC5-EXCH02.marvell.com (10.69.176.39) by DC5-EXCH01.marvell.com (10.69.176.38) with Microsoft SMTP Server (TLS) id 15.0.1497.2; Tue, 23 Nov 2021 03:07:48 -0800 Received: from maili.marvell.com (10.69.176.80) by DC5-EXCH02.marvell.com (10.69.176.39) with Microsoft SMTP Server id 15.0.1497.18 via Frontend Transport; Tue, 23 Nov 2021 03:07:49 -0800 Received: from localhost.localdomain (unknown [10.28.34.25]) by maili.marvell.com (Postfix) with ESMTP id 4325D3F7078; Tue, 23 Nov 2021 03:07:46 -0800 (PST) From: To: , , , , , , , CC: , Sunil Kumar Kori Subject: [PATCH v8 01/10] doc: add skeleton for eventdevs feature matrices Date: Tue, 23 Nov 2021 16:37:34 +0530 Message-ID: <20211123110743.2002557-1-skori@marvell.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20211122075414.1834651-1-skori@marvell.com> References: <20211122075414.1834651-1-skori@marvell.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Type: text/plain X-Proofpoint-GUID: 3VJIR5KhAge6-WyXTbBo5osVFCQoN9F1 X-Proofpoint-ORIG-GUID: 3VJIR5KhAge6-WyXTbBo5osVFCQoN9F1 X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.205,Aquarius:18.0.790,Hydra:6.0.425,FMLib:17.0.607.475 definitions=2021-11-23_04,2021-11-23_01,2020-04-07_01 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 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 --- v8: - Fix script dump for dsw and SW driver - Review comments incorporated v7: - Rebased to 21.11 rc3 - Fix Tx adapter capabilities for SW driver v6: - Rebased to 21.11 rc2 - Added feature matrices for all supported drivers - Added doc vs code check script 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 | 5 ++ doc/guides/conf.py | 25 ++++++++++ doc/guides/eventdevs/features/cnxk.ini | 14 ++++++ doc/guides/eventdevs/features/default.ini | 51 +++++++++++++++++++++ doc/guides/eventdevs/features/dpaa.ini | 14 ++++++ doc/guides/eventdevs/features/dpaa2.ini | 14 ++++++ doc/guides/eventdevs/features/dsw.ini | 14 ++++++ doc/guides/eventdevs/features/octeontx.ini | 14 ++++++ doc/guides/eventdevs/features/octeontx2.ini | 14 ++++++ doc/guides/eventdevs/features/opdl.ini | 14 ++++++ doc/guides/eventdevs/features/sw.ini | 14 ++++++ doc/guides/eventdevs/index.rst | 1 + doc/guides/eventdevs/overview.rst | 40 ++++++++++++++++ 13 files changed, 234 insertions(+) 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 b98a43a601..212c7aa28e 100644 --- a/.gitignore +++ b/.gitignore @@ -16,6 +16,11 @@ doc/guides/regexdevs/overview_feature_table.txt doc/guides/vdpadevs/overview_feature_table.txt doc/guides/bbdevs/overview_feature_table.txt doc/guides/gpus/overview_feature_table.txt +doc/guides/eventdevs/overview_feature_table.txt +doc/guides/eventdevs/overview_rx_adptr_feature_table.txt +doc/guides/eventdevs/overview_tx_adptr_feature_table.txt +doc/guides/eventdevs/overview_crypto_adptr_feature_table.txt +doc/guides/eventdevs/overview_timer_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 e6ce929bc8..1743ce301f 100644 --- a/doc/guides/conf.py +++ b/doc/guides/conf.py @@ -401,6 +401,31 @@ def setup(app): 'Features', 'Features availability in GPU drivers', 'Feature') + table_file = dirname(__file__) + '/eventdevs/overview_feature_table.txt' + generate_overview_table(table_file, 1, + 'Scheduling Features', + 'Features availability in eventdev drivers', + 'Feature') + table_file = dirname(__file__) + '/eventdevs/overview_rx_adptr_feature_table.txt' + generate_overview_table(table_file, 2, + 'Eth Rx adapter Features', + 'Features availability for Ethdev Rx adapters', + 'Feature') + table_file = dirname(__file__) + '/eventdevs/overview_tx_adptr_feature_table.txt' + generate_overview_table(table_file, 3, + 'Eth Tx adapter Features', + 'Features availability for Ethdev Tx adapters', + 'Feature') + table_file = dirname(__file__) + '/eventdevs/overview_crypto_adptr_feature_table.txt' + generate_overview_table(table_file, 4, + 'Crypto adapter Features', + 'Features availability for Crypto adapters', + 'Feature') + table_file = dirname(__file__) + '/eventdevs/overview_timer_adptr_feature_table.txt' + generate_overview_table(table_file, 5, + 'Timer adapter Features', + 'Features availability for Timer 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..480b5d03c6 --- /dev/null +++ b/doc/guides/eventdevs/features/cnxk.ini @@ -0,0 +1,14 @@ +; +; Supported features of the 'cnxk' eventdev driver. +; +; Refer to default.ini for the full list of available PMD features. +; +[Scheduling Features] + +[Eth Rx adapter Features] + +[Eth Tx adapter Features] + +[Crypto adapter Features] + +[Timer adapter Features] diff --git a/doc/guides/eventdevs/features/default.ini b/doc/guides/eventdevs/features/default.ini new file mode 100644 index 0000000000..5b16c45193 --- /dev/null +++ b/doc/guides/eventdevs/features/default.ini @@ -0,0 +1,51 @@ +; +; 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. +; +[Scheduling Features] +queue_qos = +event_qos = +distributed_sched = +queue_all_types = +burst_mode = +implicit_release_disable = +nonseq_mode = +runtime_port_link = +multiple_queue_port = +carry_flow_id = +maintenance_free = + +; +; Features of a default Ethernet Rx adapter. +; +[Eth Rx adapter Features] +internal_port = +multi_eventq = +override_flow_id = +event_vector = + +; +; Features of a default Ethernet Tx adapter. +; +[Eth Tx adapter Features] +internal_port = +event_vector = + +; +; Features of a default Crypto adapter. +; +[Crypto adapter Features] +internal_port_op_new = +internal_port_op_fwd = +internal_port_qp_ev_bind = +session_private_data = + +; +; Features of a default Timer adapter. +; +[Timer adapter Features] +internal_port = +periodic = diff --git a/doc/guides/eventdevs/features/dpaa.ini b/doc/guides/eventdevs/features/dpaa.ini new file mode 100644 index 0000000000..2a88b81e05 --- /dev/null +++ b/doc/guides/eventdevs/features/dpaa.ini @@ -0,0 +1,14 @@ +; +; Supported features of the 'dpaa' eventdev driver. +; +; Refer to default.ini for the full list of available PMD features. +; +[Scheduling Features] + +[Eth Rx adapter Features] + +[Eth Tx adapter Features] + +[Crypto adapter Features] + +[Timer adapter Features] diff --git a/doc/guides/eventdevs/features/dpaa2.ini b/doc/guides/eventdevs/features/dpaa2.ini new file mode 100644 index 0000000000..67988af042 --- /dev/null +++ b/doc/guides/eventdevs/features/dpaa2.ini @@ -0,0 +1,14 @@ +; +; Supported features of the 'dpaa2' eventdev driver. +; +; Refer to default.ini for the full list of available PMD features. +; +[Scheduling Features] + +[Eth Rx adapter Features] + +[Eth Tx adapter Features] + +[Crypto adapter Features] + +[Timer adapter Features] diff --git a/doc/guides/eventdevs/features/dsw.ini b/doc/guides/eventdevs/features/dsw.ini new file mode 100644 index 0000000000..7de3f7b91b --- /dev/null +++ b/doc/guides/eventdevs/features/dsw.ini @@ -0,0 +1,14 @@ +; +; Supported features of the 'distributed software' eventdev driver. +; +; Refer to default.ini for the full list of available PMD features. +; +[Scheduling Features] + +[Eth Rx adapter Features] + +[Eth Tx adapter Features] + +[Crypto adapter Features] + +[Timer adapter Features] diff --git a/doc/guides/eventdevs/features/octeontx.ini b/doc/guides/eventdevs/features/octeontx.ini new file mode 100644 index 0000000000..ac06d43d03 --- /dev/null +++ b/doc/guides/eventdevs/features/octeontx.ini @@ -0,0 +1,14 @@ +; +; Supported features of the 'octeontx' eventdev driver. +; +; Refer to default.ini for the full list of available PMD features. +; +[Scheduling Features] + +[Eth Rx adapter Features] + +[Eth Tx adapter Features] + +[Crypto adapter Features] + +[Timer adapter Features] diff --git a/doc/guides/eventdevs/features/octeontx2.ini b/doc/guides/eventdevs/features/octeontx2.ini new file mode 100644 index 0000000000..3bce593858 --- /dev/null +++ b/doc/guides/eventdevs/features/octeontx2.ini @@ -0,0 +1,14 @@ +; +; Supported features of the 'octeontx2' eventdev driver. +; +; Refer to default.ini for the full list of available PMD features. +; +[Scheduling Features] + +[Eth Rx adapter Features] + +[Eth Tx adapter Features] + +[Crypto adapter Features] + +[Timer adapter Features] diff --git a/doc/guides/eventdevs/features/opdl.ini b/doc/guides/eventdevs/features/opdl.ini new file mode 100644 index 0000000000..73922ca79f --- /dev/null +++ b/doc/guides/eventdevs/features/opdl.ini @@ -0,0 +1,14 @@ +; +; Supported features of 'Ordered Packet Distribution Library' eventdev driver. +; +; Refer to default.ini for the full list of available PMD features. +; +[Scheduling Features] + +[Eth Rx adapter Features] + +[Eth Tx adapter Features] + +[Crypto adapter Features] + +[Timer adapter Features] diff --git a/doc/guides/eventdevs/features/sw.ini b/doc/guides/eventdevs/features/sw.ini new file mode 100644 index 0000000000..5d787a6220 --- /dev/null +++ b/doc/guides/eventdevs/features/sw.ini @@ -0,0 +1,14 @@ +; +; Supported features of the 'software' eventdev driver. +; +; Refer to default.ini for the full list of available PMD features. +; +[Scheduling Features] + +[Eth Rx adapter Features] + +[Eth Tx adapter Features] + +[Crypto adapter Features] + +[Timer 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..3c5ee515f8 --- /dev/null +++ b/doc/guides/eventdevs/overview.rst @@ -0,0 +1,40 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(C) 2021 Marvell. + +Event Device Supported Functionality Matrices +============================================= + +Event device supported features +------------------------------- + +.. _table_eventdev_pmd_features: + +.. include:: overview_feature_table.txt + +Ethernet Rx adapter supported features +-------------------------------------- + +.. _table_eventdev_rx_adapter_features: + +.. include:: overview_rx_adptr_feature_table.txt + +Ethernet Tx adapter supported features +-------------------------------------- + +.. _table_eventdev_tx_adapter_features: + +.. include:: overview_tx_adptr_feature_table.txt + +Crypto device adapter supported features +---------------------------------------- + +.. _table_cryptodev_adapter_features: + +.. include:: overview_crypto_adptr_feature_table.txt + +Timer adapter supported features +-------------------------------- + +.. _table_timer_adapter_features: + +.. include:: overview_timer_adptr_feature_table.txt -- 2.25.1