[PATCH v6 01/11] doc: add skeleton for eventdevs feature matrices
skori at marvell.com
skori at marvell.com
Mon Nov 15 14:15:08 CET 2021
From: Sunil Kumar Kori <skori at 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 at marvell.com>
---
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/cn10k.ini | 14 ++++++
doc/guides/eventdevs/features/cn9k.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 ++++++++++++++++
14 files changed, 248 insertions(+)
create mode 100644 doc/guides/eventdevs/features/cn10k.ini
create mode 100644 doc/guides/eventdevs/features/cn9k.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/cn10k.ini b/doc/guides/eventdevs/features/cn10k.ini
new file mode 100644
index 0000000000..c7ddde5a65
--- /dev/null
+++ b/doc/guides/eventdevs/features/cn10k.ini
@@ -0,0 +1,14 @@
+;
+; Supported features of the 'cn10k' 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/cn9k.ini b/doc/guides/eventdevs/features/cn9k.ini
new file mode 100644
index 0000000000..4b87ca93df
--- /dev/null
+++ b/doc/guides/eventdevs/features/cn9k.ini
@@ -0,0 +1,14 @@
+;
+; Supported features of the 'cn9k' 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
More information about the dev
mailing list