From: Sunil Kumar Kori <skori@marvell.com> To: <jerinj@marvell.com>, <nikhil.rao@intel.com>, <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>, John McNamara <john.mcnamara@intel.com>, "Marko Kovacevic" <marko.kovacevic@intel.com> Cc: <dev@dpdk.org>, Sunil Kumar Kori <skori@marvell.com> Subject: [dpdk-dev] [PATCH v3 1/3] doc: add skeleton for eventdevs feature matrices Date: Tue, 3 Dec 2019 11:57:47 +0530 Message-ID: <20191203062749.23319-1-skori@marvell.com> (raw) In-Reply-To: <20191121074452.2291-1-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> --- 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/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 +++++++++++++ 12 files changed, 119 insertions(+), 1 deletion(-) 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 9741ba076..e0299a2e1 100644 --- a/.gitignore +++ b/.gitignore @@ -9,6 +9,8 @@ doc/guides/cryptodevs/overview_auth_table.txt doc/guides/cryptodevs/overview_aead_table.txt doc/guides/cryptodevs/overview_asym_table.txt doc/guides/compressdevs/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 e2b52e2df..ba2833d03 100644 --- a/doc/guides/conf.py +++ b/doc/guides/conf.py @@ -47,7 +47,7 @@ master_doc = 'index' # Maximum feature description string length -feature_str_len = 25 +feature_str_len = 45 # Figures, tables and code-blocks automatically numbered if they have caption numfig = True @@ -401,6 +401,16 @@ def setup(app): 'Features', 'Features availability in compression 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/default.ini b/doc/guides/eventdevs/features/default.ini new file mode 100644 index 000000000..d007d7a69 --- /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 000000000..3cf172f40 --- /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 000000000..822a82ef3 --- /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 000000000..230737045 --- /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 000000000..d1b1fe6d6 --- /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 000000000..96f1af0dc --- /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 000000000..020808fce --- /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 000000000..a5789f56d --- /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 570905b81..540ac762c 100644 --- a/doc/guides/eventdevs/index.rst +++ b/doc/guides/eventdevs/index.rst @@ -11,6 +11,7 @@ application trough the eventdev API. :maxdepth: 2 :numbered: + overview dpaa dpaa2 dsw diff --git a/doc/guides/eventdevs/overview.rst b/doc/guides/eventdevs/overview.rst new file mode 100644 index 000000000..6825b9007 --- /dev/null +++ b/doc/guides/eventdevs/overview.rst @@ -0,0 +1,19 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(C) 2019 Marvell International Ltd. + +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.17.1
next prev parent reply other threads:[~2019-12-03 6:28 UTC|newest] Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top 2019-11-07 11:12 [dpdk-dev] [PATCH 1/3] doc: add skeleton for eventdevs feature metrices Sunil Kumar Kori 2019-11-07 11:12 ` [dpdk-dev] [PATCH 2/3] doc: update eventdev feature matrix for octeontx2 Sunil Kumar Kori 2019-11-07 11:12 ` [dpdk-dev] [PATCH 3/3] doc: update eventdev feature matrix for octeontx Sunil Kumar Kori 2019-11-15 7:38 ` [dpdk-dev] [PATCH 1/3] doc: add skeleton for eventdevs feature metrices Jerin Jacob 2019-11-21 7:44 ` [dpdk-dev] [PATCH v2 1/3] doc: add skeleton for eventdevs feature matrices Sunil Kumar Kori 2019-11-21 7:44 ` [dpdk-dev] [PATCH v2 2/3] doc: update eventdev feature matrix for octeontx2 Sunil Kumar Kori 2019-11-21 7:44 ` [dpdk-dev] [PATCH v2 3/3] doc: update eventdev feature matrix for octeontx Sunil Kumar Kori 2019-11-28 15:49 ` [dpdk-dev] [PATCH v2 1/3] doc: add skeleton for eventdevs feature matrices Thomas Monjalon 2019-12-03 6:27 ` Sunil Kumar Kori [this message] 2019-12-03 6:27 ` [dpdk-dev] [PATCH v3 2/3] doc: update eventdev feature matrix for octeontx2 Sunil Kumar Kori 2019-12-03 6:27 ` [dpdk-dev] [PATCH v3 3/3] doc: update eventdev feature matrix for octeontx Sunil Kumar Kori 2020-02-27 7:02 ` [dpdk-dev] [PATCH v4 1/3] doc: add skeleton for eventdevs feature matrices Sunil Kumar Kori 2020-02-27 7:03 ` [dpdk-dev] [PATCH v4 2/3] doc: update eventdev feature matrix for octeontx2 Sunil Kumar Kori 2020-02-27 7:03 ` [dpdk-dev] [PATCH v4 3/3] doc: update eventdev feature matrix for octeontx Sunil Kumar Kori
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=20191203062749.23319-1-skori@marvell.com \ --to=skori@marvell.com \ --cc=dev@dpdk.org \ --cc=harry.van.haaren@intel.com \ --cc=hemant.agrawal@nxp.com \ --cc=jerinj@marvell.com \ --cc=john.mcnamara@intel.com \ --cc=liang.j.ma@intel.com \ --cc=marko.kovacevic@intel.com \ --cc=mattias.ronnblom@ericsson.com \ --cc=nikhil.rao@intel.com \ --cc=nipun.gupta@nxp.com \ --cc=pbhagavatula@marvell.com \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: link
DPDK patches and discussions This inbox may be cloned and mirrored by anyone: git clone --mirror http://inbox.dpdk.org/dev/0 dev/git/0.git # If you have public-inbox 1.1+ installed, you may # initialize and index your mirror using the following commands: public-inbox-init -V2 dev dev/ http://inbox.dpdk.org/dev \ dev@dpdk.org public-inbox-index dev Example config snippet for mirrors. Newsgroup available over NNTP: nntp://inbox.dpdk.org/inbox.dpdk.dev AGPL code for this site: git clone https://public-inbox.org/public-inbox.git