DPDK patches and discussions
 help / color / mirror / Atom feed
From: <skori@marvell.com>
To: <jerinj@marvell.com>, <nikhil.rao@intel.com>,
	<pbhagavatula@marvell.com>,  <hemant.agrawal@nxp.com>,
	<nipun.gupta@nxp.com>, <harry.van.haaren@intel.com>,
	<mattias.ronnblom@ericsson.com>, <liang.j.ma@intel.com>
Cc: <dev@dpdk.org>, Sunil Kumar Kori <skori@marvell.com>
Subject: [PATCH v8 01/10] doc: add skeleton for eventdevs feature matrices
Date: Tue, 23 Nov 2021 16:37:34 +0530	[thread overview]
Message-ID: <20211123110743.2002557-1-skori@marvell.com> (raw)
In-Reply-To: <20211122075414.1834651-1-skori@marvell.com>

From: Sunil Kumar Kori <skori@marvell.com>

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 <skori@marvell.com>
---
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


  parent reply	other threads:[~2021-11-23 11:07 UTC|newest]

Thread overview: 86+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-11-07 11:12 [dpdk-dev] [PATCH 1/3] doc: add skeleton for eventdevs feature metrices Sunil Kumar Kori
2019-11-07 11:12 ` [dpdk-dev] [PATCH 2/3] doc: update eventdev feature matrix for octeontx2 Sunil Kumar Kori
2019-11-07 11:12 ` [dpdk-dev] [PATCH 3/3] doc: update eventdev feature matrix for octeontx Sunil Kumar Kori
2019-11-15  7:38 ` [dpdk-dev] [PATCH 1/3] doc: add skeleton for eventdevs feature metrices Jerin Jacob
2019-11-21  7:44 ` [dpdk-dev] [PATCH v2 1/3] doc: add skeleton for eventdevs feature matrices Sunil Kumar Kori
2019-11-21  7:44   ` [dpdk-dev] [PATCH v2 2/3] doc: update eventdev feature matrix for octeontx2 Sunil Kumar Kori
2019-11-21  7:44   ` [dpdk-dev] [PATCH v2 3/3] doc: update eventdev feature matrix for octeontx Sunil Kumar Kori
2019-11-28 15:49   ` [dpdk-dev] [PATCH v2 1/3] doc: add skeleton for eventdevs feature matrices Thomas Monjalon
2019-12-03  6:27   ` [dpdk-dev] [PATCH v3 " Sunil Kumar Kori
2019-12-03  6:27     ` [dpdk-dev] [PATCH v3 2/3] doc: update eventdev feature matrix for octeontx2 Sunil Kumar Kori
2019-12-03  6:27     ` [dpdk-dev] [PATCH v3 3/3] doc: update eventdev feature matrix for octeontx Sunil Kumar Kori
2020-02-27  7:02     ` [dpdk-dev] [PATCH v4 1/3] doc: add skeleton for eventdevs feature matrices Sunil Kumar Kori
2020-02-27  7:03       ` [dpdk-dev] [PATCH v4 2/3] doc: update eventdev feature matrix for octeontx2 Sunil Kumar Kori
2020-02-27  7:03       ` [dpdk-dev] [PATCH v4 3/3] doc: update eventdev feature matrix for octeontx Sunil Kumar Kori
2021-10-22  7:48       ` [dpdk-dev] [PATCH v5 1/4] doc: add skeleton for eventdevs feature matrices skori
2021-10-22  7:48         ` [dpdk-dev] [PATCH v5 2/4] doc: update eventdev feature matrix for octeontx2 skori
2021-10-22  7:48         ` [dpdk-dev] [PATCH v5 3/4] doc: update eventdev feature matrix for octeontx skori
2021-10-22  7:48         ` [dpdk-dev] [PATCH v5 4/4] doc: update eventdev feature matrix for cnxk skori
2021-11-09 10:11         ` [dpdk-dev] [PATCH v5 1/4] doc: add skeleton for eventdevs feature matrices Jerin Jacob
2021-11-09 11:34           ` Thomas Monjalon
2021-11-11  6:40             ` [EXT] " Sunil Kumar Kori
2021-11-10  8:42           ` Mattias Rönnblom
2021-11-10  8:50             ` [dpdk-dev] [EXT] " Jerin Jacob Kollanukkaran
2021-11-10  9:29               ` [dpdk-dev] [PATCH] eventdev: negate maintenance capability flag Mattias Rönnblom
2021-11-10  9:55                 ` Van Haaren, Harry
2021-11-10 10:06                   ` [dpdk-dev] [PATCH v2] " Mattias Rönnblom
2021-11-10 10:07                   ` [dpdk-dev] [PATCH] " Mattias Rönnblom
2021-11-10 10:43                     ` Jerin Jacob
2021-11-10 11:32                       ` [dpdk-dev] [PATCH v3] " Mattias Rönnblom
2021-11-10 18:55                         ` Jerin Jacob
2021-11-10 11:14                   ` [dpdk-dev] [PATCH v2] eventdev: fix Rx adapter stalls on event device backpressure Mattias Rönnblom
2021-11-10 11:23                     ` Jayatheerthan, Jay
2021-11-10 18:56                       ` Jerin Jacob
2021-11-15 13:15         ` [PATCH v6 01/11] doc: add skeleton for eventdevs feature matrices skori
2021-11-15 13:15           ` [PATCH v6 02/11] doc: update eventdev feature matrix for octeontx skori
2021-11-15 13:15           ` [PATCH v6 03/11] doc: update eventdev feature matrix for octeontx2 skori
2021-11-15 13:15           ` [PATCH v6 04/11] doc: update eventdev feature matrix for cn9k skori
2021-11-15 13:15           ` [PATCH v6 05/11] doc: update eventdev feature matrix for cn10k skori
2021-11-15 13:15           ` [PATCH v6 06/11] doc: update eventdev feature matrix for dpaa skori
2021-11-15 13:15           ` [PATCH v6 07/11] doc: update eventdev feature matrix for dpaa2 skori
2021-11-15 13:15           ` [PATCH v6 08/11] doc: update eventdev feature matrix for SW skori
2021-11-15 13:15           ` [PATCH v6 09/11] doc: update eventdev feature matrix for opdl skori
2021-11-15 13:15           ` [PATCH v6 10/11] doc: update eventdev feature matrix for dsw skori
2021-11-15 13:15           ` [PATCH v6 11/11] devtools: check event device doc tables skori
2021-11-22  7:54           ` [PATCH v7 01/11] doc: add skeleton for eventdevs feature matrices skori
2021-11-22  7:54             ` [PATCH v7 02/11] doc: update eventdev feature matrix for octeontx skori
2021-11-22  7:54             ` [PATCH v7 03/11] doc: update eventdev feature matrix for octeontx2 skori
2021-11-22  7:54             ` [PATCH v7 04/11] doc: update eventdev feature matrix for cn9k skori
2021-11-22  7:54             ` [PATCH v7 05/11] doc: update eventdev feature matrix for cn10k skori
2021-11-22 18:25               ` Jerin Jacob
2021-11-22  7:54             ` [PATCH v7 06/11] doc: update eventdev feature matrix for dpaa skori
2021-11-22  7:54             ` [PATCH v7 07/11] doc: update eventdev feature matrix for dpaa2 skori
2021-11-22  7:54             ` [PATCH v7 08/11] doc: update eventdev feature matrix for SW skori
2021-11-22  7:54             ` [PATCH v7 09/11] doc: update eventdev feature matrix for opdl skori
2021-11-22  7:54             ` [PATCH v7 10/11] doc: update eventdev feature matrix for dsw skori
2021-11-22  7:54             ` [PATCH v7 11/11] devtools: check event device doc tables skori
2021-11-22 18:35               ` Jerin Jacob
2021-11-23 11:07             ` skori [this message]
2021-11-23 11:07               ` [PATCH v8 02/10] doc: update eventdev feature matrix for octeontx skori
2021-11-23 11:07               ` [PATCH v8 03/10] doc: update eventdev feature matrix for octeontx2 skori
2021-11-23 11:07               ` [PATCH v8 04/10] doc: update eventdev feature matrix for cnxk skori
2021-11-23 11:07               ` [PATCH v8 05/10] doc: update eventdev feature matrix for dpaa skori
2021-11-23 11:07               ` [PATCH v8 06/10] doc: update eventdev feature matrix for dpaa2 skori
2021-11-23 11:07               ` [PATCH v8 07/10] doc: update eventdev feature matrix for SW skori
2021-11-23 11:07               ` [PATCH v8 08/10] doc: update eventdev feature matrix for opdl skori
2021-11-23 11:07               ` [PATCH v8 09/10] doc: update eventdev feature matrix for dsw skori
2021-11-23 11:07               ` [PATCH v8 10/10] devtools: check event device doc tables skori
2021-11-24 10:52                 ` Thomas Monjalon
2021-11-24 11:16                   ` [EXT] " Sunil Kumar Kori
2021-11-24 11:21                     ` Thomas Monjalon
2021-11-24 10:03               ` [PATCH v8 01/10] doc: add skeleton for eventdevs feature matrices Thomas Monjalon
2021-11-24 10:30                 ` [EXT] " Sunil Kumar Kori
2021-11-24 10:43                   ` Thomas Monjalon
2021-11-24 12:35                     ` Sunil Kumar Kori
2021-11-24 12:41                       ` Thomas Monjalon
2021-11-24 12:46                         ` Sunil Kumar Kori
2021-11-24 13:05                           ` Sunil Kumar Kori
2021-11-24 10:48               ` Thomas Monjalon
2021-11-24 11:12                 ` [EXT] " Sunil Kumar Kori
2021-11-24 12:14               ` [PATCH v1 1/1] doc: update eventdev feature matrix for dlb2 skori
2021-11-24 13:03               ` [PATCH v9 1/1] doc: add eventdevs feature matrices skori
2021-11-26 14:55                 ` Thomas Monjalon
2021-11-15 18:08         ` [dpdk-dev] [PATCH v5 1/4] doc: add skeleton for " Jerin Jacob
2021-11-23 16:44         ` Jerin Jacob
2021-11-24  8:06           ` Thomas Monjalon
2021-11-24  8:14             ` Jerin Jacob

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20211123110743.2002557-1-skori@marvell.com \
    --to=skori@marvell.com \
    --cc=dev@dpdk.org \
    --cc=harry.van.haaren@intel.com \
    --cc=hemant.agrawal@nxp.com \
    --cc=jerinj@marvell.com \
    --cc=liang.j.ma@intel.com \
    --cc=mattias.ronnblom@ericsson.com \
    --cc=nikhil.rao@intel.com \
    --cc=nipun.gupta@nxp.com \
    --cc=pbhagavatula@marvell.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).