[dpdk-dev] [PATCH v5 1/4] doc: add skeleton for eventdevs feature matrices

[Jerin Jacob]

On Fri, Oct 22, 2021 at 1:18 PM <skori at marvell.com> wrote:
>
> 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>

Series Acked-by: Jerin Jacob <jerinj at 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
>