[PATCH] doc: fix missing feature matrix for event device
pbhagavatula at marvell.com
pbhagavatula at marvell.com
Sat Jun 14 01:15:19 CEST 2025
From: Pavan Nikhilesh <pbhagavatula at marvell.com>
Fix missing feature matrix addition for event device DMA and
vector adapters.
Fixes: 66a30a29387a ("eventdev/dma: introduce DMA adapter")
Fixes: e12c3754da7a ("eventdev/vector: introduce event vector adapter")
Signed-off-by: Pavan Nikhilesh <pbhagavatula at marvell.com>
---
.gitignore | 2 ++
doc/guides/conf.py | 12 +++++++++++-
doc/guides/eventdevs/features/cnxk.ini | 8 ++++++++
doc/guides/eventdevs/overview.rst | 15 +++++++++++++++
4 files changed, 36 insertions(+), 1 deletion(-)
diff --git a/.gitignore b/.gitignore
index 48b4ce2908f9..c5349f6e979c 100644
--- a/.gitignore
+++ b/.gitignore
@@ -26,6 +26,8 @@ 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
+doc/guides/eventdevs/overview_dma_adptr_feature_table.txt
+doc/guides/eventdevs/overview_vector_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 565f5705d8b8..4b1059c202b5 100644
--- a/doc/guides/conf.py
+++ b/doc/guides/conf.py
@@ -477,11 +477,21 @@ def setup(app):
'Crypto adapter Features',
'Features availability for Crypto adapters',
'Feature')
- table_file = dirname(__file__) + '/eventdevs/overview_timer_adptr_feature_table.txt'
+ table_file = dirname(__file__) + '/eventdevs/overview_dma_adptr_feature_table.txt'
generate_overview_table(table_file, 5,
+ 'DMA adapter Features',
+ 'Features availability for DMA adapters',
+ 'Feature')
+ table_file = dirname(__file__) + '/eventdevs/overview_timer_adptr_feature_table.txt'
+ generate_overview_table(table_file, 6,
'Timer adapter Features',
'Features availability for Timer adapters',
'Feature')
+ table_file = dirname(__file__) + '/eventdevs/overview_vector_adptr_feature_table.txt'
+ generate_overview_table(table_file, 7,
+ 'Vector adapter Features',
+ 'Features availability for Vector adapters',
+ 'Feature')
if Version(sphinx_version) < Version('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
index 5ba528f0861d..af093dda61f3 100644
--- a/doc/guides/eventdevs/features/cnxk.ini
+++ b/doc/guides/eventdevs/features/cnxk.ini
@@ -29,6 +29,14 @@ event_vector = Y
internal_port = Y
event_vector = Y
+;
+; Features of a default DMA adapter.
+;
+[DMA adapter Features]
+internal_port_op_new = Y
+internal_port_op_fwd = Y
+internal_port_vchan_ev_bind =
+
[Crypto adapter Features]
internal_port_op_fwd = Y
session_private_data = Y
diff --git a/doc/guides/eventdevs/overview.rst b/doc/guides/eventdevs/overview.rst
index 3c5ee515f8b5..decae3bd4eaa 100644
--- a/doc/guides/eventdevs/overview.rst
+++ b/doc/guides/eventdevs/overview.rst
@@ -32,9 +32,24 @@ Crypto device adapter supported features
.. include:: overview_crypto_adptr_feature_table.txt
+DMA adapter supported features
+------------------------------
+
+.. _table_dma_adapter_features:
+
+.. include:: overview_dma_adptr_feature_table.txt
+
+
Timer adapter supported features
--------------------------------
.. _table_timer_adapter_features:
.. include:: overview_timer_adptr_feature_table.txt
+
+Event vector adapter supported features
+---------------------------------------
+
+.. _table_vector_adapter_features:
+
+.. include:: overview_vector_adptr_feature_table.txt
--
2.39.5 (Apple Git-154)
More information about the dev
mailing list