From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <dev-bounces@dpdk.org>
Received: from dpdk.org (dpdk.org [92.243.14.124])
by inbox.dpdk.org (Postfix) with ESMTP id 763D2A04C1;
Thu, 21 Nov 2019 08:45:06 +0100 (CET)
Received: from [92.243.14.124] (localhost [127.0.0.1])
by dpdk.org (Postfix) with ESMTP id 6893F2BA2;
Thu, 21 Nov 2019 08:45:05 +0100 (CET)
Received: from mx0b-0016f401.pphosted.com (mx0a-0016f401.pphosted.com
[67.231.148.174]) by dpdk.org (Postfix) with ESMTP id 9B9A0271
for <dev@dpdk.org>; Thu, 21 Nov 2019 08:45:03 +0100 (CET)
Received: from pps.filterd (m0045849.ppops.net [127.0.0.1])
by mx0a-0016f401.pphosted.com (8.16.0.42/8.16.0.42) with SMTP id
xAL7eMYn019460; Wed, 20 Nov 2019 23:45:02 -0800
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=marvell.com;
h=from : to : cc :
subject : date : message-id : in-reply-to : references : mime-version :
content-type; s=pfpt0818; bh=vP1FP/iX25Vlb9ijTgFkFXQo4VANMU4nBj/Y9feV+aY=;
b=iKHox74JdKyqnu3wWkzVubRcpTjMUdJfol2K+Vjlho0mHgy7r1YUSpvCyF2o0bDV562m
AEQwWlS1Noli3cQtKfFTwNYsQtG7k4v3OEDbVpGDDICqqbC62xqZnP0JqmByt+mKAg75
RJlwr3hOR9aiP9QVxc3YFzZY0RC06eYL6FnD1zfWhlFUnKhKdfn2xhhlP4h3FE6IYfeG
AeJoMXJ+hJszYYfIfMk1xgS6o1MxdHch9MAFjbHt7ankEhWrUc1+grPxHcyEbnz3HHea
ZD1oEl9NA9jZWobe5FpsxQDikMM1MXIHZduOSbqLEiAC6iVeEyvZZcPA4aOJ4m6fdTJN LA==
Received: from sc-exch01.marvell.com ([199.233.58.181])
by mx0a-0016f401.pphosted.com with ESMTP id 2wc842c34v-1
(version=TLSv1.2 cipher=ECDHE-RSA-AES256-SHA384 bits=256 verify=NOT);
Wed, 20 Nov 2019 23:45:02 -0800
Received: from SC-EXCH01.marvell.com (10.93.176.81) by SC-EXCH01.marvell.com
(10.93.176.81) with Microsoft SMTP Server (TLS) id 15.0.1367.3; Wed, 20 Nov
2019 23:45:00 -0800
Received: from maili.marvell.com (10.93.176.43) by SC-EXCH01.marvell.com
(10.93.176.81) with Microsoft SMTP Server id 15.0.1367.3 via Frontend
Transport; Wed, 20 Nov 2019 23:45:00 -0800
Received: from localhost.localdomain (unknown [10.28.34.200])
by maili.marvell.com (Postfix) with ESMTP id 817C03F703F;
Wed, 20 Nov 2019 23:44:57 -0800 (PST)
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>
Date: Thu, 21 Nov 2019 13:14:50 +0530
Message-ID: <20191121074452.2291-1-skori@marvell.com>
X-Mailer: git-send-email 2.17.1
In-Reply-To: <20191107111207.17143-1-skori@marvell.com>
References: <20191107111207.17143-1-skori@marvell.com>
MIME-Version: 1.0
Content-Type: text/plain
X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:6.0.95,18.0.572
definitions=2019-11-20_08:2019-11-20,2019-11-20 signatures=0
Subject: [dpdk-dev] [PATCH v2 1/3] doc: add skeleton for eventdevs feature
matrices
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
<mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
<mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>
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
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
diff --git a/doc/guides/eventdevs/overview_adptr_feature_table.txt b/doc/guides/eventdevs/overview_adptr_feature_table.txt
new file mode 100644
index 000000000..a2e2c0ab3
--- /dev/null
+++ b/doc/guides/eventdevs/overview_adptr_feature_table.txt
@@ -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
+ ========================================== = = = = = = =
diff --git a/doc/guides/eventdevs/overview_feature_table.txt b/doc/guides/eventdevs/overview_feature_table.txt
new file mode 100644
index 000000000..c2e9bd289
--- /dev/null
+++ b/doc/guides/eventdevs/overview_feature_table.txt
@@ -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
+ ===================================== = = = = = = =
--
2.17.1