[v2,1/3] doc: add skeleton for eventdevs feature matrices
Checks
Commit Message
Patch adds skeleton for feature matrices for event dev
and Rx/Tx adapters.
Signed-off-by: Sunil Kumar Kori <skori@marvell.com>
---
v2:
- Review comments incorporated
doc/guides/eventdevs/index.rst | 1 +
doc/guides/eventdevs/overview.rst | 19 +++++
.../overview_adptr_feature_table.txt | 81 ++++++++++++++++++
.../eventdevs/overview_feature_table.txt | 82 +++++++++++++++++++
4 files changed, 183 insertions(+)
create mode 100644 doc/guides/eventdevs/overview.rst
create mode 100644 doc/guides/eventdevs/overview_adptr_feature_table.txt
create mode 100644 doc/guides/eventdevs/overview_feature_table.txt
Comments
21/11/2019 08:44, Sunil Kumar Kori:
> Patch adds skeleton for feature matrices for event dev
> and Rx/Tx adapters.
[...]
> +.. table:: Features availability in eventdev drivers
> +
> + ===================================== = = = = = = =
> + Feature d d d o o o s
> + p p s c c p w
> + a a w t t d
> + a a e e l
> + 2 o o
> + n n
> + t t
> + x x
> + 2
> + ===================================== = = = = = = =
> + 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
> + ===================================== = = = = = = =
This table should be automatically generated from conf.py.
(Ideally we should have a custom sphinx class for it)
Please rework and do not commit such .txt file, thanks
@@ -11,6 +11,7 @@ application trough the eventdev API.
:maxdepth: 2
:numbered:
+ overview
dpaa
dpaa2
dsw
new file mode 100644
@@ -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
new file mode 100644
@@ -0,0 +1,81 @@
+
+.. raw:: html
+
+ <style>
+ .wy-nav-content {
+ opacity: .99;
+ }
+ table#id1 {
+ cursor: default;
+ overflow: hidden;
+ }
+ table#id1 th, table#id1 td {
+ text-align: center;
+ }
+ table#id1 th {
+ font-size: 72%;
+ white-space: pre-wrap;
+ vertical-align: top;
+ padding: 0.5em 0;
+ min-width: 0.9em;
+ width: 2em;
+ }
+ table#id1 col:first-child {
+ width: 0;
+ }
+ table#id1 th:first-child {
+ vertical-align: bottom;
+ }
+ table#id1 td {
+ font-size: 70%;
+ padding: 1px;
+ }
+ table#id1 td:first-child {
+ padding-left: 1em;
+ text-align: left;
+ }
+ table#id1 tr:nth-child(2n-1) td {
+ background-color: rgba(210, 210, 210, 0.2);
+ }
+ table#id1 th:not(:first-child):hover,
+ table#id1 td:not(:first-child):hover {
+ position: relative;
+ }
+ table#id1 th:not(:first-child):hover::after,
+ table#id1 td:not(:first-child):hover::after {
+ content: '';
+ height: 6000px;
+ top: -3000px;
+ width: 100%;
+ left: 0;
+ position: absolute;
+ z-index: -1;
+ background-color: #ffb;
+ }
+ table#id1 tr:hover td {
+ background-color: #ffb;
+ }
+ </style>
+
+.. table:: Features availability for adapters
+
+ ========================================== = = = = = = =
+ Feature d d d o o o s
+ p p s c c p w
+ a a w t t d
+ a a e e l
+ 2 o o
+ n n
+ t t
+ x x
+ 2
+ ========================================== = = = = = = =
+ 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,82 @@
+
+.. raw:: html
+
+ <style>
+ .wy-nav-content {
+ opacity: .99;
+ }
+ table#id1 {
+ cursor: default;
+ overflow: hidden;
+ }
+ table#id1 th, table#id1 td {
+ text-align: center;
+ }
+ table#id1 th {
+ font-size: 72%;
+ white-space: pre-wrap;
+ vertical-align: top;
+ padding: 0.5em 0;
+ min-width: 0.9em;
+ width: 2em;
+ }
+ table#id1 col:first-child {
+ width: 0;
+ }
+ table#id1 th:first-child {
+ vertical-align: bottom;
+ }
+ table#id1 td {
+ font-size: 70%;
+ padding: 1px;
+ }
+ table#id1 td:first-child {
+ padding-left: 1em;
+ text-align: left;
+ }
+ table#id1 tr:nth-child(2n-1) td {
+ background-color: rgba(210, 210, 210, 0.2);
+ }
+ table#id1 th:not(:first-child):hover,
+ table#id1 td:not(:first-child):hover {
+ position: relative;
+ }
+ table#id1 th:not(:first-child):hover::after,
+ table#id1 td:not(:first-child):hover::after {
+ content: '';
+ height: 6000px;
+ top: -3000px;
+ width: 100%;
+ left: 0;
+ position: absolute;
+ z-index: -1;
+ background-color: #ffb;
+ }
+ table#id1 tr:hover td {
+ background-color: #ffb;
+ }
+ </style>
+
+.. table:: Features availability in eventdev drivers
+
+ ===================================== = = = = = = =
+ Feature d d d o o o s
+ p p s c c p w
+ a a w t t d
+ a a e e l
+ 2 o o
+ n n
+ t t
+ x x
+ 2
+ ===================================== = = = = = = =
+ 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
+ ===================================== = = = = = = =