[v8,01/10] doc: add skeleton for eventdevs feature matrices
Checks
Commit Message
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
Comments
23/11/2021 12:07, skori@marvell.com:
> .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(+)
Why dlb2 is missing?
>-----Original Message-----
>From: Thomas Monjalon <thomas@monjalon.net>
>Sent: Wednesday, November 24, 2021 3:34 PM
>To: Jerin Jacob Kollanukkaran <jerinj@marvell.com>; Sunil Kumar Kori
><skori@marvell.com>
>Cc: nikhil.rao@intel.com; Pavan Nikhilesh Bhagavatula
><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; dev@dpdk.org
>Subject: [EXT] Re: [PATCH v8 01/10] doc: add skeleton for eventdevs feature
>matrices
>
>External Email
>
>----------------------------------------------------------------------
>23/11/2021 12:07, skori@marvell.com:
>> .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(+)
>
>Why dlb2 is missing?
No specific reason. It's missed by mistake. I will send a patch to fix it.
>
>
>
24/11/2021 11:30, Sunil Kumar Kori:
> From: Thomas Monjalon <thomas@monjalon.net>
> >23/11/2021 12:07, skori@marvell.com:
> >> .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(+)
> >
> >Why dlb2 is missing?
> No specific reason. It's missed by mistake. I will send a patch to fix it.
I think a v9 is needed.
I am sending other comments.
Note: it can all be in one single patch.
23/11/2021 12:07, skori@marvell.com:
> +[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 =
Would be better to align the equal signs as done by the script
%-20s =
Regards
Sunil Kumar Kori
>-----Original Message-----
>From: Thomas Monjalon <thomas@monjalon.net>
>Sent: Wednesday, November 24, 2021 4:18 PM
>To: Sunil Kumar Kori <skori@marvell.com>
>Cc: Jerin Jacob Kollanukkaran <jerinj@marvell.com>; nikhil.rao@intel.com;
>Pavan Nikhilesh Bhagavatula <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; dev@dpdk.org
>Subject: [EXT] Re: [PATCH v8 01/10] doc: add skeleton for eventdevs feature
>matrices
>
>External Email
>
>----------------------------------------------------------------------
>23/11/2021 12:07, skori@marvell.com:
>> +[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 =
>
>Would be better to align the equal signs as done by the script
> %-20s =
>
Ack.
Hi Thomas,
Just wanted to confirm that all documentation patches should go as single patch or I can send it as a series of patches.
I am ready with dlb2 changes also. Once you confirm I will send patches accordingly. Please confirm.
Regards
Sunil Kumar Kori
>-----Original Message-----
>From: Thomas Monjalon <thomas@monjalon.net>
>Sent: Wednesday, November 24, 2021 4:14 PM
>To: Sunil Kumar Kori <skori@marvell.com>
>Cc: Jerin Jacob Kollanukkaran <jerinj@marvell.com>; dev@dpdk.org;
>nikhil.rao@intel.com; Pavan Nikhilesh Bhagavatula
><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; dev@dpdk.org
>Subject: Re: [EXT] Re: [PATCH v8 01/10] doc: add skeleton for eventdevs
>feature matrices
>
>24/11/2021 11:30, Sunil Kumar Kori:
>> From: Thomas Monjalon <thomas@monjalon.net>
>> >23/11/2021 12:07, skori@marvell.com:
>> >> .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(+)
>> >
>> >Why dlb2 is missing?
>> No specific reason. It's missed by mistake. I will send a patch to fix it.
>
>I think a v9 is needed.
>I am sending other comments.
>Note: it can all be in one single patch.
>
24/11/2021 13:35, Sunil Kumar Kori:
> Hi Thomas,
>
> Just wanted to confirm that all documentation patches should go as single patch or I can send it as a series of patches.
> I am ready with dlb2 changes also. Once you confirm I will send patches accordingly. Please confirm.
There is no specific comment in each patch, so it can go all in a single patch (v9).
Regards
Sunil Kumar Kori
>-----Original Message-----
>From: Thomas Monjalon <thomas@monjalon.net>
>Sent: Wednesday, November 24, 2021 6:12 PM
>To: Sunil Kumar Kori <skori@marvell.com>
>Cc: Jerin Jacob Kollanukkaran <jerinj@marvell.com>; dev@dpdk.org;
>nikhil.rao@intel.com; Pavan Nikhilesh Bhagavatula
><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; dev@dpdk.org
>Subject: Re: [EXT] Re: [PATCH v8 01/10] doc: add skeleton for eventdevs
>feature matrices
>
>24/11/2021 13:35, Sunil Kumar Kori:
>> Hi Thomas,
>>
>> Just wanted to confirm that all documentation patches should go as single
>patch or I can send it as a series of patches.
>> I am ready with dlb2 changes also. Once you confirm I will send patches
>accordingly. Please confirm.
>
>There is no specific comment in each patch, so it can go all in a single patch
>(v9).
>
>
Ack.
Regards
Sunil Kumar Kori
>-----Original Message-----
>From: Sunil Kumar Kori <skori@marvell.com>
>Sent: Wednesday, November 24, 2021 6:17 PM
>To: Thomas Monjalon <thomas@monjalon.net>
>Cc: Jerin Jacob Kollanukkaran <jerinj@marvell.com>; dev@dpdk.org;
>nikhil.rao@intel.com; Pavan Nikhilesh Bhagavatula
><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; dev@dpdk.org
>Subject: RE: [EXT] Re: [PATCH v8 01/10] doc: add skeleton for eventdevs
>feature matrices
>
>
>
>Regards
>Sunil Kumar Kori
>
>>-----Original Message-----
>>From: Thomas Monjalon <thomas@monjalon.net>
>>Sent: Wednesday, November 24, 2021 6:12 PM
>>To: Sunil Kumar Kori <skori@marvell.com>
>>Cc: Jerin Jacob Kollanukkaran <jerinj@marvell.com>; dev@dpdk.org;
>>nikhil.rao@intel.com; Pavan Nikhilesh Bhagavatula
>><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; dev@dpdk.org
>>Subject: Re: [EXT] Re: [PATCH v8 01/10] doc: add skeleton for eventdevs
>>feature matrices
>>
>>24/11/2021 13:35, Sunil Kumar Kori:
>>> Hi Thomas,
>>>
>>> Just wanted to confirm that all documentation patches should go as
>>> single
>>patch or I can send it as a series of patches.
>>> I am ready with dlb2 changes also. Once you confirm I will send
>>> patches
>>accordingly. Please confirm.
>>
>>There is no specific comment in each patch, so it can go all in a
>>single patch (v9).
>>
>>
>Ack.
I sent v9. Please have a look.
@@ -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
@@ -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 '
new file mode 100644
@@ -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]
new file mode 100644
@@ -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 =
new file mode 100644
@@ -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]
new file mode 100644
@@ -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]
new file mode 100644
@@ -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]
new file mode 100644
@@ -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]
new file mode 100644
@@ -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]
new file mode 100644
@@ -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]
new file mode 100644
@@ -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]
@@ -11,6 +11,7 @@ application through the eventdev API.
:maxdepth: 2
:numbered:
+ overview
cnxk
dlb2
dpaa
new file mode 100644
@@ -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