From: Nicolas Chautru <nicolas.chautru@intel.com>
To: dev@dpdk.org
Cc: Nicolas Chautru <nicolas.chautru@intel.com>
Subject: [dpdk-dev] [PATCH v1 13/13] doc: add feature matrix table for bbdev devices
Date: Sun, 29 Mar 2020 13:18:20 -0700 [thread overview]
Message-ID: <1585513100-67277-14-git-send-email-nicolas.chautru@intel.com> (raw)
In-Reply-To: <1585513100-67277-1-git-send-email-nicolas.chautru@intel.com>
Adding missing overview page in documentation with
comparison of feature set by each available PMD implementation.
Signed-off-by: Nicolas Chautru <nicolas.chautru@intel.com>
---
.gitignore | 1 +
doc/guides/bbdevs/features/default.ini | 16 ++++++++++++++++
doc/guides/bbdevs/features/fpga_5gnr_fec.ini | 11 +++++++++++
doc/guides/bbdevs/features/fpga_lte_fec.ini | 10 ++++++++++
doc/guides/bbdevs/features/mbc.ini | 14 ++++++++++++++
doc/guides/bbdevs/features/null.ini | 7 +++++++
doc/guides/bbdevs/features/turbo_sw.ini | 11 +++++++++++
doc/guides/bbdevs/index.rst | 1 +
doc/guides/bbdevs/overview.rst | 15 +++++++++++++++
doc/guides/conf.py | 5 +++++
10 files changed, 91 insertions(+)
create mode 100644 doc/guides/bbdevs/features/default.ini
create mode 100644 doc/guides/bbdevs/features/fpga_5gnr_fec.ini
create mode 100644 doc/guides/bbdevs/features/fpga_lte_fec.ini
create mode 100644 doc/guides/bbdevs/features/mbc.ini
create mode 100644 doc/guides/bbdevs/features/null.ini
create mode 100644 doc/guides/bbdevs/features/turbo_sw.ini
create mode 100644 doc/guides/bbdevs/overview.rst
diff --git a/.gitignore b/.gitignore
index 2acb459..f2f8892 100644
--- a/.gitignore
+++ b/.gitignore
@@ -10,6 +10,7 @@ doc/guides/cryptodevs/overview_aead_table.txt
doc/guides/cryptodevs/overview_asym_table.txt
doc/guides/compressdevs/overview_feature_table.txt
doc/guides/vdpadevs/overview_feature_table.txt
+doc/guides/bbdevs/overview_feature_table.txt
# ignore generated ctags/cscope files
cscope.out.po
diff --git a/doc/guides/bbdevs/features/default.ini b/doc/guides/bbdevs/features/default.ini
new file mode 100644
index 0000000..5fe267a
--- /dev/null
+++ b/doc/guides/bbdevs/features/default.ini
@@ -0,0 +1,16 @@
+;
+; Features of a default bbdev 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]
+Turbo Decoder (4G) =
+Turbo Encoder (4G) =
+LDPC Decoder (5G) =
+LDPC Encoder (5G) =
+LLR/HARQ Compression =
+External DDR Access =
+HW Accelerated =
+BBDEV API =
diff --git a/doc/guides/bbdevs/features/fpga_5gnr_fec.ini b/doc/guides/bbdevs/features/fpga_5gnr_fec.ini
new file mode 100644
index 0000000..7a0b8d4
--- /dev/null
+++ b/doc/guides/bbdevs/features/fpga_5gnr_fec.ini
@@ -0,0 +1,11 @@
+;
+; Supported features of the 'fpga_5ngr_fec' bbdev driver.
+;
+; Refer to default.ini for the full list of available PMD features.
+;
+[Features]
+LDPC Decoder (5G) = Y
+LDPC Encoder (5G) = Y
+External DDR Access = Y
+HW Accelerated = Y
+BBDEV API = Y
diff --git a/doc/guides/bbdevs/features/fpga_lte_fec.ini b/doc/guides/bbdevs/features/fpga_lte_fec.ini
new file mode 100644
index 0000000..f1cfb92
--- /dev/null
+++ b/doc/guides/bbdevs/features/fpga_lte_fec.ini
@@ -0,0 +1,10 @@
+;
+; Supported features of the 'fpga_lte_fec' bbdev driver.
+;
+; Refer to default.ini for the full list of available PMD features.
+;
+[Features]
+Turbo Decoder (4G) = Y
+Turbo Encoder (4G) = Y
+HW Accelerated = Y
+BBDEV API = Y
diff --git a/doc/guides/bbdevs/features/mbc.ini b/doc/guides/bbdevs/features/mbc.ini
new file mode 100644
index 0000000..78a7b95
--- /dev/null
+++ b/doc/guides/bbdevs/features/mbc.ini
@@ -0,0 +1,14 @@
+;
+; Supported features of the 'mbc' bbdev driver.
+;
+; Refer to default.ini for the full list of available PMD features.
+;
+[Features]
+Turbo Decoder (4G) = Y
+Turbo Encoder (4G) = Y
+LDPC Decoder (5G) = Y
+LDPC Encoder (5G) = Y
+LLR/HARQ Compression = Y
+External DDR Access = Y
+HW Accelerated = Y
+BBDEV API = Y
diff --git a/doc/guides/bbdevs/features/null.ini b/doc/guides/bbdevs/features/null.ini
new file mode 100644
index 0000000..d9bbda9
--- /dev/null
+++ b/doc/guides/bbdevs/features/null.ini
@@ -0,0 +1,7 @@
+;
+; Supported features of the 'null' bbdev driver.
+;
+; Refer to default.ini for the full list of available PMD features.
+;
+[Features]
+BBDEV API = Y
diff --git a/doc/guides/bbdevs/features/turbo_sw.ini b/doc/guides/bbdevs/features/turbo_sw.ini
new file mode 100644
index 0000000..2c7075e
--- /dev/null
+++ b/doc/guides/bbdevs/features/turbo_sw.ini
@@ -0,0 +1,11 @@
+;
+; Supported features of the 'turbo_sw' bbdev driver.
+;
+; Refer to default.ini for the full list of available PMD features.
+;
+[Features]
+Turbo Decoder (4G) = Y
+Turbo Encoder (4G) = Y
+LDPC Decoder (5G) = Y
+LDPC Encoder (5G) = Y
+BBDEV API = Y
diff --git a/doc/guides/bbdevs/index.rst b/doc/guides/bbdevs/index.rst
index 1a79343..a8092dd 100644
--- a/doc/guides/bbdevs/index.rst
+++ b/doc/guides/bbdevs/index.rst
@@ -8,6 +8,7 @@ Baseband Device Drivers
:maxdepth: 2
:numbered:
+ overview
null
turbo_sw
fpga_lte_fec
diff --git a/doc/guides/bbdevs/overview.rst b/doc/guides/bbdevs/overview.rst
new file mode 100644
index 0000000..ace4e67
--- /dev/null
+++ b/doc/guides/bbdevs/overview.rst
@@ -0,0 +1,15 @@
+.. SPDX-License-Identifier: BSD-3-Clause
+ Copyright(c) 2020 Intel Corporation.
+
+Baseband Device Supported Functionality Matrices
+==============================================
+
+Supported Feature Flags
+-----------------------
+
+.. _table_bbdev_pmd_features:
+
+.. include:: overview_feature_table.txt
+
+
+
diff --git a/doc/guides/conf.py b/doc/guides/conf.py
index c368fa5..d52b584 100644
--- a/doc/guides/conf.py
+++ b/doc/guides/conf.py
@@ -406,6 +406,11 @@ def setup(app):
'Features',
'Features availability in vDPA drivers',
'Feature')
+ table_file = dirname(__file__) + '/bbdevs/overview_feature_table.txt'
+ generate_overview_table(table_file, 1,
+ 'Features',
+ 'Features availability in bbdev drivers',
+ 'Feature')
if LooseVersion(sphinx_version) < LooseVersion('1.3.1'):
print('Upgrade sphinx to version >= 1.3.1 for '
--
1.8.3.1
prev parent reply other threads:[~2020-03-29 20:21 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-03-29 20:18 [dpdk-dev] [PATCH v1 00/13] drivers/baseband: PMD for FPGA 5GNR FEC Nicolas Chautru
2020-03-29 20:18 ` [dpdk-dev] [PATCH v1 01/13] bbdev: add capability flag for filler bits inclusion in HARQ Nicolas Chautru
2020-03-29 20:18 ` [dpdk-dev] [PATCH v1 02/13] bbdev: expose device HARQ buffer size at device level Nicolas Chautru
2020-03-29 20:18 ` [dpdk-dev] [PATCH v1 03/13] drivers/baseband: add PMD for FPGA 5GNR FEC Nicolas Chautru
2020-03-29 20:18 ` [dpdk-dev] [PATCH v1 04/13] baseband/fpga_5gnr_fec: add register definition file Nicolas Chautru
2020-03-29 20:18 ` [dpdk-dev] [PATCH v1 05/13] baseband/fpga_5gnr_fec: add device info_get function Nicolas Chautru
2020-03-29 20:18 ` [dpdk-dev] [PATCH v1 06/13] baseband/fpga_5gnr_fec: add queue configuration Nicolas Chautru
2020-03-29 20:18 ` [dpdk-dev] [PATCH v1 07/13] baseband/fpga_5gnr_fec: add LDPC processing functions Nicolas Chautru
2020-03-29 20:18 ` [dpdk-dev] [PATCH v1 08/13] baseband/fpga_5gnr_fec: add HW error capture Nicolas Chautru
2020-03-29 20:18 ` [dpdk-dev] [PATCH v1 09/13] baseband/fpga_5gnr_fec: add debug functionality Nicolas Chautru
2020-03-29 20:18 ` [dpdk-dev] [PATCH v1 10/13] baseband/fpga_5gnr_fec: add configure function Nicolas Chautru
2020-03-29 20:18 ` [dpdk-dev] [PATCH v1 11/13] baseband/fpga_5gnr_fec: add harq loopback capability Nicolas Chautru
2020-03-29 20:18 ` [dpdk-dev] [PATCH v1 12/13] baseband/fpga_5gnr_fec: add interrupt support Nicolas Chautru
2020-03-29 20:18 ` Nicolas Chautru [this message]
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=1585513100-67277-14-git-send-email-nicolas.chautru@intel.com \
--to=nicolas.chautru@intel.com \
--cc=dev@dpdk.org \
/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
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).