[v5,1/4] 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>
---
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 | 2 ++
doc/guides/conf.py | 12 ++++++++-
doc/guides/eventdevs/features/cnxk.ini | 8 ++++++
doc/guides/eventdevs/features/default.ini | 30 +++++++++++++++++++++
doc/guides/eventdevs/features/dpaa.ini | 8 ++++++
doc/guides/eventdevs/features/dpaa2.ini | 8 ++++++
doc/guides/eventdevs/features/dsw.ini | 8 ++++++
doc/guides/eventdevs/features/octeontx.ini | 8 ++++++
doc/guides/eventdevs/features/octeontx2.ini | 8 ++++++
doc/guides/eventdevs/features/opdl.ini | 8 ++++++
doc/guides/eventdevs/features/sw.ini | 8 ++++++
doc/guides/eventdevs/index.rst | 1 +
doc/guides/eventdevs/overview.rst | 19 +++++++++++++
13 files changed, 127 insertions(+), 1 deletion(-)
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
On Fri, Oct 22, 2021 at 1:18 PM <skori@marvell.com> wrote:
>
> 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>
+ Tree maintainers and eventdev adapter maintainers
1) Please rebase to dpdk-next-eventdev
2) Please update devtools/check-doc-vs-code.sh
You can use search _CAP_ and != CAP_REQUIRES_ to detect the capability
change or so.
3) Update the .ini for all the eventdev drivers, not just Marvell ones.
>
> # Maximum feature description string length
> -feature_str_len = 30
> +feature_str_len = 45
I hope this OK. I understand that without this it gives errors and
feature-length is not enough
> diff --git a/doc/guides/eventdevs/features/default.ini b/doc/guides/eventdevs/features/default.ini
> new file mode 100644
> index 0000000000..d007d7a69e
> --- /dev/null
> +++ b/doc/guides/eventdevs/features/default.ini
> @@ -0,0 +1,30 @@
> +;
> +; 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.
> +;
> +[Features]
> +Event queue priority based scheduling =
> +Event priority based scheduling =
> +Event device distributed scheduling =
> +Event device non sequential mode =
> +Event queue all types =
> +Burst mode enqueue/dequeue =
> +Event port implicit release disable =
> +Runtime event queue/port linking =
> +Multi queue linking per port =
1) Please sync the doc order with flag definition order in header file[1]
2) You can remove RTE_EVENT_DEV_CAP_REQUIRES_MAINT from the
list(*CAP_REQUIRES*) as this
is limitation.
[1]
RTE_EVENT_DEV_CAP_QUEUE_QOS
RTE_EVENT_DEV_CAP_EVENT_QOS
RTE_EVENT_DEV_CAP_DISTRIBUTED_SCHED
RTE_EVENT_DEV_CAP_QUEUE_ALL_TYPES
RTE_EVENT_DEV_CAP_BURST_MODE
RTE_EVENT_DEV_CAP_IMPLICIT_RELEASE_DISABLE
RTE_EVENT_DEV_CAP_NONSEQ_MODE
RTE_EVENT_DEV_CAP_RUNTIME_PORT_LINK
RTE_EVENT_DEV_CAP_MULTIPLE_QUEUE_PORT
RTE_EVENT_DEV_CAP_CARRY_FLOW_ID
> +
> +;
> +; Features of a default adapter.
> +;
> +[Adapter Features]
Please make this as [Eth Rx adapter Features]
> +Eth Rx/Tx adapter on internal port =
You can remove Eth Rx/Tx adapter as new subject has [Eth Rx adapter]
> +Multiple event queues per ethdev =
> +Override flow ID =
Missing RTE_EVENT_ETH_RX_ADAPTER_CAP_EVENT_VECTOR
Add new section for Tx adapter
and add
RTE_EVENT_ETH_TX_ADAPTER_CAP_INTERNAL_PORT
RTE_EVENT_ETH_TX_ADAPTER_CAP_EVENT_VECTOR
Add new section for Crypto adapter
> +Crypto adapter new event enqueue =
> +Crypto adapter forwarded event enqueue =
> +Crypto queue pair mapping to event queue =
> +Crypto adapter session data store/retrieve =
Add new section for timer adapter
> +Timer adapter support in H/W =
Missing RTE_EVENT_TIMER_ADAPTER_CAP_PERIODIC
09/11/2021 11:11, Jerin Jacob:
> On Fri, Oct 22, 2021 at 1:18 PM <skori@marvell.com> wrote:
> > # Maximum feature description string length
> > -feature_str_len = 30
> > +feature_str_len = 45
>
> I hope this OK. I understand that without this it gives errors and
> feature-length is not enough
I don't think this is OK, because it would enlarge the size of all tables.
Please confirm (especially for NICs table).
Is there a way to make the feature names smaller?
On 2021-11-09 11:11, Jerin Jacob wrote:
> On Fri, Oct 22, 2021 at 1:18 PM <skori@marvell.com> wrote:
>>
>> 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>
>
>
> + Tree maintainers and eventdev adapter maintainers
>
> 1) Please rebase to dpdk-next-eventdev
> 2) Please update devtools/check-doc-vs-code.sh
> You can use search _CAP_ and != CAP_REQUIRES_ to detect the capability
> change or so.
> 3) Update the .ini for all the eventdev drivers, not just Marvell ones.
>
>>
>> # Maximum feature description string length
>> -feature_str_len = 30
>> +feature_str_len = 45
>
> I hope this OK. I understand that without this it gives errors and
> feature-length is not enough
>
>> diff --git a/doc/guides/eventdevs/features/default.ini b/doc/guides/eventdevs/features/default.ini
>> new file mode 100644
>> index 0000000000..d007d7a69e
>> --- /dev/null
>> +++ b/doc/guides/eventdevs/features/default.ini
>> @@ -0,0 +1,30 @@
>> +;
>> +; 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.
>> +;
>> +[Features]
>> +Event queue priority based scheduling =
>> +Event priority based scheduling =
>> +Event device distributed scheduling =
>> +Event device non sequential mode =
>> +Event queue all types =
>> +Burst mode enqueue/dequeue =
>> +Event port implicit release disable =
>> +Runtime event queue/port linking =
>> +Multi queue linking per port =
>
> 1) Please sync the doc order with flag definition order in header file[1]
> 2) You can remove RTE_EVENT_DEV_CAP_REQUIRES_MAINT from the
> list(*CAP_REQUIRES*) as this
> is limitation.
>
>
Maybe we should negate RTE_EVENT_DEV_CAP_REQUIRES_MAINT to make it fit
better with the other capabilities? To be more in line with how the API
has been adapted to cope with various eventdev hardware limitations
(e.g., RTE_EVENT_DEV_CAP_CARRY_FLOW_ID).
RTE_EVENT_DEV_CAP_MAINTENANCE_FREE
All event devices/drivers would set this except DSW.
If this make sense and it's not too late to tweak the API, I can create
a patch.
> [1]
> RTE_EVENT_DEV_CAP_QUEUE_QOS
> RTE_EVENT_DEV_CAP_EVENT_QOS
> RTE_EVENT_DEV_CAP_DISTRIBUTED_SCHED
> RTE_EVENT_DEV_CAP_QUEUE_ALL_TYPES
> RTE_EVENT_DEV_CAP_BURST_MODE
> RTE_EVENT_DEV_CAP_IMPLICIT_RELEASE_DISABLE
> RTE_EVENT_DEV_CAP_NONSEQ_MODE
> RTE_EVENT_DEV_CAP_RUNTIME_PORT_LINK
> RTE_EVENT_DEV_CAP_MULTIPLE_QUEUE_PORT
> RTE_EVENT_DEV_CAP_CARRY_FLOW_ID
>
>
>
>> +
>> +;
>> +; Features of a default adapter.
>> +;
>> +[Adapter Features]
>
> Please make this as [Eth Rx adapter Features]
>
>> +Eth Rx/Tx adapter on internal port =
> You can remove Eth Rx/Tx adapter as new subject has [Eth Rx adapter]
>
>> +Multiple event queues per ethdev =
>> +Override flow ID =
>
> Missing RTE_EVENT_ETH_RX_ADAPTER_CAP_EVENT_VECTOR
>
>
> Add new section for Tx adapter
> and add
> RTE_EVENT_ETH_TX_ADAPTER_CAP_INTERNAL_PORT
> RTE_EVENT_ETH_TX_ADAPTER_CAP_EVENT_VECTOR
>
>
> Add new section for Crypto adapter
>
>> +Crypto adapter new event enqueue =
>> +Crypto adapter forwarded event enqueue =
>> +Crypto queue pair mapping to event queue =
>> +Crypto adapter session data store/retrieve =
>
>
> Add new section for timer adapter
>
>> +Timer adapter support in H/W =
>
> Missing RTE_EVENT_TIMER_ADAPTER_CAP_PERIODIC
>
> > 1) Please sync the doc order with flag definition order in header file[1]
> > 2) You can remove RTE_EVENT_DEV_CAP_REQUIRES_MAINT from the
> > list(*CAP_REQUIRES*) as this
> > is limitation.
> >
> >
>
> Maybe we should negate RTE_EVENT_DEV_CAP_REQUIRES_MAINT to make it
> fit
> better with the other capabilities? To be more in line with how the API
> has been adapted to cope with various eventdev hardware limitations
> (e.g., RTE_EVENT_DEV_CAP_CARRY_FLOW_ID).
>
> RTE_EVENT_DEV_CAP_MAINTENANCE_FREE
>
> All event devices/drivers would set this except DSW.
>
> If this make sense and it's not too late to tweak the API, I can create
> a patch.
Makes sense. Just add those cap in !dsw drivers.
Please send it now, I will merge it soon.
>
> > [1]
> > RTE_EVENT_DEV_CAP_QUEUE_QOS
> > RTE_EVENT_DEV_CAP_EVENT_QOS
> > RTE_EVENT_DEV_CAP_DISTRIBUTED_SCHED
> > RTE_EVENT_DEV_CAP_QUEUE_ALL_TYPES
> > RTE_EVENT_DEV_CAP_BURST_MODE
> > RTE_EVENT_DEV_CAP_IMPLICIT_RELEASE_DISABLE
> > RTE_EVENT_DEV_CAP_NONSEQ_MODE
> > RTE_EVENT_DEV_CAP_RUNTIME_PORT_LINK
> > RTE_EVENT_DEV_CAP_MULTIPLE_QUEUE_PORT
> > RTE_EVENT_DEV_CAP_CARRY_FLOW_ID
> >
> >
> >
> >> +
> >> +;
> >> +; Features of a default adapter.
> >> +;
> >> +[Adapter Features]
> >
> > Please make this as [Eth Rx adapter Features]
> >
> >> +Eth Rx/Tx adapter on internal port =
> > You can remove Eth Rx/Tx adapter as new subject has [Eth Rx adapter]
> >
> >> +Multiple event queues per ethdev =
> >> +Override flow ID =
> >
> > Missing RTE_EVENT_ETH_RX_ADAPTER_CAP_EVENT_VECTOR
> >
> >
> > Add new section for Tx adapter
> > and add
> > RTE_EVENT_ETH_TX_ADAPTER_CAP_INTERNAL_PORT
> > RTE_EVENT_ETH_TX_ADAPTER_CAP_EVENT_VECTOR
> >
> >
> > Add new section for Crypto adapter
> >
> >> +Crypto adapter new event enqueue =
> >> +Crypto adapter forwarded event enqueue =
> >> +Crypto queue pair mapping to event queue =
> >> +Crypto adapter session data store/retrieve =
> >
> >
> > Add new section for timer adapter
> >
> >> +Timer adapter support in H/W =
> >
> > Missing RTE_EVENT_TIMER_ADAPTER_CAP_PERIODIC
> >
>-----Original Message-----
>From: Thomas Monjalon <thomas@monjalon.net>
>Sent: Tuesday, November 9, 2021 5:05 PM
>To: Sunil Kumar Kori <skori@marvell.com>; Jerin Jacob
><jerinjacobk@gmail.com>
>Cc: Jerin Jacob Kollanukkaran <jerinj@marvell.com>; Nikhil Rao
><nikhil.rao@intel.com>; Pavan Nikhilesh Bhagavatula
><pbhagavatula@marvell.com>; Hemant Agrawal
><hemant.agrawal@nxp.com>; Nipun Gupta <nipun.gupta@nxp.com>; Van
>Haaren, Harry <harry.van.haaren@intel.com>; Mattias Rönnblom
><mattias.ronnblom@ericsson.com>; Liang Ma <liang.j.ma@intel.com>; dpdk-
>dev <dev@dpdk.org>; David Marchand <david.marchand@redhat.com>;
>Gujjar, Abhinandan S <abhinandan.gujjar@intel.com>; Erik Gabriel Carrillo
><erik.g.carrillo@intel.com>; Jayatheerthan, Jay
><jay.jayatheerthan@intel.com>; Ferruh Yigit <ferruh.yigit@intel.com>; Akhil
>Goyal <gakhil@marvell.com>
>Subject: [EXT] Re: [dpdk-dev] [PATCH v5 1/4] doc: add skeleton for eventdevs
>feature matrices
>
>External Email
>
>----------------------------------------------------------------------
>09/11/2021 11:11, Jerin Jacob:
>> On Fri, Oct 22, 2021 at 1:18 PM <skori@marvell.com> wrote:
>> > # Maximum feature description string length -feature_str_len = 30
>> > +feature_str_len = 45
>>
>> I hope this OK. I understand that without this it gives errors and
>> feature-length is not enough
>
>I don't think this is OK, because it would enlarge the size of all tables.
>Please confirm (especially for NICs table).
>Is there a way to make the feature names smaller?
>
Ack. I will limit the string length up to 30 characters.
On Fri, Oct 22, 2021 at 1:18 PM <skori@marvell.com> wrote:
>
> 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>
Please fix the below.
doc out of sync for dsw
Eth Rx adapter Features event_vector
Eth Rx adapter Features multi_eventq
Eth Rx adapter Features override_flow_id
doc out of sync for sw
Eth Rx adapter Features event_vector
Eth Rx adapter Features multi_eventq
Eth Rx adapter Features override_flow_id
Eth Tx adapter Features event_vector
Eth Tx adapter Features internal_port
> ---
> 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 | 2 ++
> doc/guides/conf.py | 12 ++++++++-
> doc/guides/eventdevs/features/cnxk.ini | 8 ++++++
> doc/guides/eventdevs/features/default.ini | 30 +++++++++++++++++++++
> doc/guides/eventdevs/features/dpaa.ini | 8 ++++++
> doc/guides/eventdevs/features/dpaa2.ini | 8 ++++++
> doc/guides/eventdevs/features/dsw.ini | 8 ++++++
> doc/guides/eventdevs/features/octeontx.ini | 8 ++++++
> doc/guides/eventdevs/features/octeontx2.ini | 8 ++++++
> doc/guides/eventdevs/features/opdl.ini | 8 ++++++
> doc/guides/eventdevs/features/sw.ini | 8 ++++++
> doc/guides/eventdevs/index.rst | 1 +
> doc/guides/eventdevs/overview.rst | 19 +++++++++++++
> 13 files changed, 127 insertions(+), 1 deletion(-)
> 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 b19c0717e6..b3fc783945 100644
> --- a/.gitignore
> +++ b/.gitignore
> @@ -14,6 +14,8 @@ doc/guides/compressdevs/overview_feature_table.txt
> doc/guides/regexdevs/overview_feature_table.txt
> doc/guides/vdpadevs/overview_feature_table.txt
> doc/guides/bbdevs/overview_feature_table.txt
> +doc/guides/eventdevs/overview_feature_table.txt
> +doc/guides/eventdevs/overview_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 67d2dd62c7..9d8e20e5fc 100644
> --- a/doc/guides/conf.py
> +++ b/doc/guides/conf.py
> @@ -41,7 +41,7 @@
> master_doc = 'index'
>
> # Maximum feature description string length
> -feature_str_len = 30
> +feature_str_len = 45
>
> # Figures, tables and code-blocks automatically numbered if they have caption
> numfig = True
> @@ -388,6 +388,16 @@ def setup(app):
> 'Features',
> 'Features availability in bbdev drivers',
> 'Feature')
> + table_file = dirname(__file__) + '/eventdevs/overview_feature_table.txt'
> + generate_overview_table(table_file, 1,
> + 'Features',
> + 'Features availability in eventdev drivers',
> + 'Feature')
> + table_file = dirname(__file__) + '/eventdevs/overview_adptr_feature_table.txt'
> + generate_overview_table(table_file, 2,
> + 'Adapter Features',
> + 'Features availability for 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..a461966d69
> --- /dev/null
> +++ b/doc/guides/eventdevs/features/cnxk.ini
> @@ -0,0 +1,8 @@
> +;
> +; Supported features of the 'cnxk' eventdev driver.
> +;
> +; Refer to default.ini for the full list of available PMD features.
> +;
> +[Features]
> +
> +[Adapter Features]
> diff --git a/doc/guides/eventdevs/features/default.ini b/doc/guides/eventdevs/features/default.ini
> new file mode 100644
> index 0000000000..d007d7a69e
> --- /dev/null
> +++ b/doc/guides/eventdevs/features/default.ini
> @@ -0,0 +1,30 @@
> +;
> +; 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.
> +;
> +[Features]
> +Event queue priority based scheduling =
> +Event priority based scheduling =
> +Event device distributed scheduling =
> +Event device non sequential mode =
> +Event queue all types =
> +Burst mode enqueue/dequeue =
> +Event port implicit release disable =
> +Runtime event queue/port linking =
> +Multi queue linking per port =
> +
> +;
> +; Features of a default adapter.
> +;
> +[Adapter Features]
> +Eth Rx/Tx adapter on internal port =
> +Multiple event queues per ethdev =
> +Override flow ID =
> +Crypto adapter new event enqueue =
> +Crypto adapter forwarded event enqueue =
> +Crypto queue pair mapping to event queue =
> +Crypto adapter session data store/retrieve =
> +Timer adapter support in H/W =
> diff --git a/doc/guides/eventdevs/features/dpaa.ini b/doc/guides/eventdevs/features/dpaa.ini
> new file mode 100644
> index 0000000000..3cf172f408
> --- /dev/null
> +++ b/doc/guides/eventdevs/features/dpaa.ini
> @@ -0,0 +1,8 @@
> +;
> +; Supported features of the 'dpaa' eventdev driver.
> +;
> +; Refer to default.ini for the full list of available PMD features.
> +;
> +[Features]
> +
> +[Adapter Features]
> diff --git a/doc/guides/eventdevs/features/dpaa2.ini b/doc/guides/eventdevs/features/dpaa2.ini
> new file mode 100644
> index 0000000000..822a82ef3e
> --- /dev/null
> +++ b/doc/guides/eventdevs/features/dpaa2.ini
> @@ -0,0 +1,8 @@
> +;
> +; Supported features of the 'dpaa2' eventdev driver.
> +;
> +; Refer to default.ini for the full list of available PMD features.
> +;
> +[Features]
> +
> +[Adapter Features]
> diff --git a/doc/guides/eventdevs/features/dsw.ini b/doc/guides/eventdevs/features/dsw.ini
> new file mode 100644
> index 0000000000..230737045b
> --- /dev/null
> +++ b/doc/guides/eventdevs/features/dsw.ini
> @@ -0,0 +1,8 @@
> +;
> +; Supported features of the 'distributed software' eventdev driver.
> +;
> +; Refer to default.ini for the full list of available PMD features.
> +;
> +[Features]
> +
> +[Adapter Features]
> diff --git a/doc/guides/eventdevs/features/octeontx.ini b/doc/guides/eventdevs/features/octeontx.ini
> new file mode 100644
> index 0000000000..d1b1fe6d62
> --- /dev/null
> +++ b/doc/guides/eventdevs/features/octeontx.ini
> @@ -0,0 +1,8 @@
> +;
> +; Supported features of the 'octeontx' eventdev driver.
> +;
> +; Refer to default.ini for the full list of available PMD features.
> +;
> +[Features]
> +
> +[Adapter Features]
> diff --git a/doc/guides/eventdevs/features/octeontx2.ini b/doc/guides/eventdevs/features/octeontx2.ini
> new file mode 100644
> index 0000000000..96f1af0dca
> --- /dev/null
> +++ b/doc/guides/eventdevs/features/octeontx2.ini
> @@ -0,0 +1,8 @@
> +;
> +; Supported features of the 'octeontx2' eventdev driver.
> +;
> +; Refer to default.ini for the full list of available PMD features.
> +;
> +[Features]
> +
> +[Adapter Features]
> diff --git a/doc/guides/eventdevs/features/opdl.ini b/doc/guides/eventdevs/features/opdl.ini
> new file mode 100644
> index 0000000000..020808fced
> --- /dev/null
> +++ b/doc/guides/eventdevs/features/opdl.ini
> @@ -0,0 +1,8 @@
> +;
> +; Supported features of 'Ordered Packet Distribution Library' eventdev driver.
> +;
> +; Refer to default.ini for the full list of available PMD features.
> +;
> +[Features]
> +
> +[Adapter Features]
> diff --git a/doc/guides/eventdevs/features/sw.ini b/doc/guides/eventdevs/features/sw.ini
> new file mode 100644
> index 0000000000..a5789f56d4
> --- /dev/null
> +++ b/doc/guides/eventdevs/features/sw.ini
> @@ -0,0 +1,8 @@
> +;
> +; Supported features of the 'software' eventdev driver.
> +;
> +; Refer to default.ini for the full list of available PMD features.
> +;
> +[Features]
> +
> +[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..5d34d2c57b
> --- /dev/null
> +++ b/doc/guides/eventdevs/overview.rst
> @@ -0,0 +1,19 @@
> +.. SPDX-License-Identifier: BSD-3-Clause
> + Copyright(C) 2021 Marvell.
> +
> +Event Device Supported Functionality Matrices
> +=============================================
> +
> +Event Device Supported Feature Flags
> +------------------------------------
> +
> +.. _table_eventdev_pmd_features:
> +
> +.. include:: overview_feature_table.txt
> +
> +Adapter Supported Feature Flags
> +-------------------------------
> +
> +.. _table_adapter_features:
> +
> +.. include:: overview_adptr_feature_table.txt
> --
> 2.25.1
>
On Fri, Oct 22, 2021 at 1:18 PM <skori@marvell.com> wrote:
>
> 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>
Series Acked-by: Jerin Jacob <jerinj@marvell.com>
Series without patch [10/10][1] applied to
dpdk-next-net-eventdev/for-main. Thanks
[1]
http://patches.dpdk.org/project/dpdk/patch/20211123110743.2002557-10-skori@marvell.com/
@Thomas Monjalon Delegated above patch to you as it is for tooling.
> ---
> 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 | 2 ++
> doc/guides/conf.py | 12 ++++++++-
> doc/guides/eventdevs/features/cnxk.ini | 8 ++++++
> doc/guides/eventdevs/features/default.ini | 30 +++++++++++++++++++++
> doc/guides/eventdevs/features/dpaa.ini | 8 ++++++
> doc/guides/eventdevs/features/dpaa2.ini | 8 ++++++
> doc/guides/eventdevs/features/dsw.ini | 8 ++++++
> doc/guides/eventdevs/features/octeontx.ini | 8 ++++++
> doc/guides/eventdevs/features/octeontx2.ini | 8 ++++++
> doc/guides/eventdevs/features/opdl.ini | 8 ++++++
> doc/guides/eventdevs/features/sw.ini | 8 ++++++
> doc/guides/eventdevs/index.rst | 1 +
> doc/guides/eventdevs/overview.rst | 19 +++++++++++++
> 13 files changed, 127 insertions(+), 1 deletion(-)
> 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 b19c0717e6..b3fc783945 100644
> --- a/.gitignore
> +++ b/.gitignore
> @@ -14,6 +14,8 @@ doc/guides/compressdevs/overview_feature_table.txt
> doc/guides/regexdevs/overview_feature_table.txt
> doc/guides/vdpadevs/overview_feature_table.txt
> doc/guides/bbdevs/overview_feature_table.txt
> +doc/guides/eventdevs/overview_feature_table.txt
> +doc/guides/eventdevs/overview_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 67d2dd62c7..9d8e20e5fc 100644
> --- a/doc/guides/conf.py
> +++ b/doc/guides/conf.py
> @@ -41,7 +41,7 @@
> master_doc = 'index'
>
> # Maximum feature description string length
> -feature_str_len = 30
> +feature_str_len = 45
>
> # Figures, tables and code-blocks automatically numbered if they have caption
> numfig = True
> @@ -388,6 +388,16 @@ def setup(app):
> 'Features',
> 'Features availability in bbdev drivers',
> 'Feature')
> + table_file = dirname(__file__) + '/eventdevs/overview_feature_table.txt'
> + generate_overview_table(table_file, 1,
> + 'Features',
> + 'Features availability in eventdev drivers',
> + 'Feature')
> + table_file = dirname(__file__) + '/eventdevs/overview_adptr_feature_table.txt'
> + generate_overview_table(table_file, 2,
> + 'Adapter Features',
> + 'Features availability for 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..a461966d69
> --- /dev/null
> +++ b/doc/guides/eventdevs/features/cnxk.ini
> @@ -0,0 +1,8 @@
> +;
> +; Supported features of the 'cnxk' eventdev driver.
> +;
> +; Refer to default.ini for the full list of available PMD features.
> +;
> +[Features]
> +
> +[Adapter Features]
> diff --git a/doc/guides/eventdevs/features/default.ini b/doc/guides/eventdevs/features/default.ini
> new file mode 100644
> index 0000000000..d007d7a69e
> --- /dev/null
> +++ b/doc/guides/eventdevs/features/default.ini
> @@ -0,0 +1,30 @@
> +;
> +; 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.
> +;
> +[Features]
> +Event queue priority based scheduling =
> +Event priority based scheduling =
> +Event device distributed scheduling =
> +Event device non sequential mode =
> +Event queue all types =
> +Burst mode enqueue/dequeue =
> +Event port implicit release disable =
> +Runtime event queue/port linking =
> +Multi queue linking per port =
> +
> +;
> +; Features of a default adapter.
> +;
> +[Adapter Features]
> +Eth Rx/Tx adapter on internal port =
> +Multiple event queues per ethdev =
> +Override flow ID =
> +Crypto adapter new event enqueue =
> +Crypto adapter forwarded event enqueue =
> +Crypto queue pair mapping to event queue =
> +Crypto adapter session data store/retrieve =
> +Timer adapter support in H/W =
> diff --git a/doc/guides/eventdevs/features/dpaa.ini b/doc/guides/eventdevs/features/dpaa.ini
> new file mode 100644
> index 0000000000..3cf172f408
> --- /dev/null
> +++ b/doc/guides/eventdevs/features/dpaa.ini
> @@ -0,0 +1,8 @@
> +;
> +; Supported features of the 'dpaa' eventdev driver.
> +;
> +; Refer to default.ini for the full list of available PMD features.
> +;
> +[Features]
> +
> +[Adapter Features]
> diff --git a/doc/guides/eventdevs/features/dpaa2.ini b/doc/guides/eventdevs/features/dpaa2.ini
> new file mode 100644
> index 0000000000..822a82ef3e
> --- /dev/null
> +++ b/doc/guides/eventdevs/features/dpaa2.ini
> @@ -0,0 +1,8 @@
> +;
> +; Supported features of the 'dpaa2' eventdev driver.
> +;
> +; Refer to default.ini for the full list of available PMD features.
> +;
> +[Features]
> +
> +[Adapter Features]
> diff --git a/doc/guides/eventdevs/features/dsw.ini b/doc/guides/eventdevs/features/dsw.ini
> new file mode 100644
> index 0000000000..230737045b
> --- /dev/null
> +++ b/doc/guides/eventdevs/features/dsw.ini
> @@ -0,0 +1,8 @@
> +;
> +; Supported features of the 'distributed software' eventdev driver.
> +;
> +; Refer to default.ini for the full list of available PMD features.
> +;
> +[Features]
> +
> +[Adapter Features]
> diff --git a/doc/guides/eventdevs/features/octeontx.ini b/doc/guides/eventdevs/features/octeontx.ini
> new file mode 100644
> index 0000000000..d1b1fe6d62
> --- /dev/null
> +++ b/doc/guides/eventdevs/features/octeontx.ini
> @@ -0,0 +1,8 @@
> +;
> +; Supported features of the 'octeontx' eventdev driver.
> +;
> +; Refer to default.ini for the full list of available PMD features.
> +;
> +[Features]
> +
> +[Adapter Features]
> diff --git a/doc/guides/eventdevs/features/octeontx2.ini b/doc/guides/eventdevs/features/octeontx2.ini
> new file mode 100644
> index 0000000000..96f1af0dca
> --- /dev/null
> +++ b/doc/guides/eventdevs/features/octeontx2.ini
> @@ -0,0 +1,8 @@
> +;
> +; Supported features of the 'octeontx2' eventdev driver.
> +;
> +; Refer to default.ini for the full list of available PMD features.
> +;
> +[Features]
> +
> +[Adapter Features]
> diff --git a/doc/guides/eventdevs/features/opdl.ini b/doc/guides/eventdevs/features/opdl.ini
> new file mode 100644
> index 0000000000..020808fced
> --- /dev/null
> +++ b/doc/guides/eventdevs/features/opdl.ini
> @@ -0,0 +1,8 @@
> +;
> +; Supported features of 'Ordered Packet Distribution Library' eventdev driver.
> +;
> +; Refer to default.ini for the full list of available PMD features.
> +;
> +[Features]
> +
> +[Adapter Features]
> diff --git a/doc/guides/eventdevs/features/sw.ini b/doc/guides/eventdevs/features/sw.ini
> new file mode 100644
> index 0000000000..a5789f56d4
> --- /dev/null
> +++ b/doc/guides/eventdevs/features/sw.ini
> @@ -0,0 +1,8 @@
> +;
> +; Supported features of the 'software' eventdev driver.
> +;
> +; Refer to default.ini for the full list of available PMD features.
> +;
> +[Features]
> +
> +[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..5d34d2c57b
> --- /dev/null
> +++ b/doc/guides/eventdevs/overview.rst
> @@ -0,0 +1,19 @@
> +.. SPDX-License-Identifier: BSD-3-Clause
> + Copyright(C) 2021 Marvell.
> +
> +Event Device Supported Functionality Matrices
> +=============================================
> +
> +Event Device Supported Feature Flags
> +------------------------------------
> +
> +.. _table_eventdev_pmd_features:
> +
> +.. include:: overview_feature_table.txt
> +
> +Adapter Supported Feature Flags
> +-------------------------------
> +
> +.. _table_adapter_features:
> +
> +.. include:: overview_adptr_feature_table.txt
> --
> 2.25.1
>
23/11/2021 17:44, Jerin Jacob:
> On Fri, Oct 22, 2021 at 1:18 PM <skori@marvell.com> wrote:
> >
> > 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>
>
> Series Acked-by: Jerin Jacob <jerinj@marvell.com>
> Series without patch [10/10][1] applied to
> dpdk-next-net-eventdev/for-main. Thanks
Note: you are replying on v5.
I assume you applied the v8, right?
> [1]
> http://patches.dpdk.org/project/dpdk/patch/20211123110743.2002557-10-skori@marvell.com/
>
> @Thomas Monjalon Delegated above patch to you as it is for tooling.
I'll look at it.
On Wed, Nov 24, 2021 at 1:36 PM Thomas Monjalon <thomas@monjalon.net> wrote:
>
> 23/11/2021 17:44, Jerin Jacob:
> > On Fri, Oct 22, 2021 at 1:18 PM <skori@marvell.com> wrote:
> > >
> > > 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>
> >
> > Series Acked-by: Jerin Jacob <jerinj@marvell.com>
> > Series without patch [10/10][1] applied to
> > dpdk-next-net-eventdev/for-main. Thanks
>
> Note: you are replying on v5.
> I assume you applied the v8, right?
Yes. Lost in Gmail web threading view.
>
> > [1]
> > http://patches.dpdk.org/project/dpdk/patch/20211123110743.2002557-10-skori@marvell.com/
> >
> > @Thomas Monjalon Delegated above patch to you as it is for tooling.
>
> I'll look at it.
Thanks
>
>
@@ -14,6 +14,8 @@ doc/guides/compressdevs/overview_feature_table.txt
doc/guides/regexdevs/overview_feature_table.txt
doc/guides/vdpadevs/overview_feature_table.txt
doc/guides/bbdevs/overview_feature_table.txt
+doc/guides/eventdevs/overview_feature_table.txt
+doc/guides/eventdevs/overview_adptr_feature_table.txt
# ignore generated ctags/cscope files
cscope.out.po
@@ -41,7 +41,7 @@
master_doc = 'index'
# Maximum feature description string length
-feature_str_len = 30
+feature_str_len = 45
# Figures, tables and code-blocks automatically numbered if they have caption
numfig = True
@@ -388,6 +388,16 @@ def setup(app):
'Features',
'Features availability in bbdev drivers',
'Feature')
+ table_file = dirname(__file__) + '/eventdevs/overview_feature_table.txt'
+ generate_overview_table(table_file, 1,
+ 'Features',
+ 'Features availability in eventdev drivers',
+ 'Feature')
+ table_file = dirname(__file__) + '/eventdevs/overview_adptr_feature_table.txt'
+ generate_overview_table(table_file, 2,
+ 'Adapter Features',
+ 'Features availability for 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,8 @@
+;
+; Supported features of the 'cnxk' eventdev driver.
+;
+; Refer to default.ini for the full list of available PMD features.
+;
+[Features]
+
+[Adapter Features]
new file mode 100644
@@ -0,0 +1,30 @@
+;
+; 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.
+;
+[Features]
+Event queue priority based scheduling =
+Event priority based scheduling =
+Event device distributed scheduling =
+Event device non sequential mode =
+Event queue all types =
+Burst mode enqueue/dequeue =
+Event port implicit release disable =
+Runtime event queue/port linking =
+Multi queue linking per port =
+
+;
+; Features of a default adapter.
+;
+[Adapter Features]
+Eth Rx/Tx adapter on internal port =
+Multiple event queues per ethdev =
+Override flow ID =
+Crypto adapter new event enqueue =
+Crypto adapter forwarded event enqueue =
+Crypto queue pair mapping to event queue =
+Crypto adapter session data store/retrieve =
+Timer adapter support in H/W =
new file mode 100644
@@ -0,0 +1,8 @@
+;
+; Supported features of the 'dpaa' eventdev driver.
+;
+; Refer to default.ini for the full list of available PMD features.
+;
+[Features]
+
+[Adapter Features]
new file mode 100644
@@ -0,0 +1,8 @@
+;
+; Supported features of the 'dpaa2' eventdev driver.
+;
+; Refer to default.ini for the full list of available PMD features.
+;
+[Features]
+
+[Adapter Features]
new file mode 100644
@@ -0,0 +1,8 @@
+;
+; Supported features of the 'distributed software' eventdev driver.
+;
+; Refer to default.ini for the full list of available PMD features.
+;
+[Features]
+
+[Adapter Features]
new file mode 100644
@@ -0,0 +1,8 @@
+;
+; Supported features of the 'octeontx' eventdev driver.
+;
+; Refer to default.ini for the full list of available PMD features.
+;
+[Features]
+
+[Adapter Features]
new file mode 100644
@@ -0,0 +1,8 @@
+;
+; Supported features of the 'octeontx2' eventdev driver.
+;
+; Refer to default.ini for the full list of available PMD features.
+;
+[Features]
+
+[Adapter Features]
new file mode 100644
@@ -0,0 +1,8 @@
+;
+; Supported features of 'Ordered Packet Distribution Library' eventdev driver.
+;
+; Refer to default.ini for the full list of available PMD features.
+;
+[Features]
+
+[Adapter Features]
new file mode 100644
@@ -0,0 +1,8 @@
+;
+; Supported features of the 'software' eventdev driver.
+;
+; Refer to default.ini for the full list of available PMD features.
+;
+[Features]
+
+[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,19 @@
+.. SPDX-License-Identifier: BSD-3-Clause
+ Copyright(C) 2021 Marvell.
+
+Event Device Supported Functionality Matrices
+=============================================
+
+Event Device Supported Feature Flags
+------------------------------------
+
+.. _table_eventdev_pmd_features:
+
+.. include:: overview_feature_table.txt
+
+Adapter Supported Feature Flags
+-------------------------------
+
+.. _table_adapter_features:
+
+.. include:: overview_adptr_feature_table.txt