From: Dave Burley <dave.burley@accelercomm.com>
To: dev@dpdk.org
Subject: Re: [dpdk-dev] [PATCH v3 14/14] doc: add feature matrix table for bbdev devices
Date: Fri, 13 Mar 2020 11:05:16 +0000 [thread overview]
Message-ID: <40ae824b-a2e5-8bd0-c834-48b76aef6aa2@accelercomm.com> (raw)
In-Reply-To: <1583348102-13253-15-git-send-email-nicolas.chautru@intel.com>
Acked-by: Dave Burley <dave.burley@accelercomm.com>
On 04/03/2020 18:55, Nicolas Chautru wrote:
> From: Nic Chautru <nicolas.chautru@intel.com>
>
> Adding missing overview page in documentation with
> comparison of feature set by PMD implementation.
>
> Signed-off-by: Nic 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 '
next prev parent reply other threads:[~2020-03-13 11:05 UTC|newest]
Thread overview: 115+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-02-27 4:38 [dpdk-dev] [PATCH v1 00/14] bbdev new features Nicolas Chautru
2020-02-27 4:38 ` [dpdk-dev] [PATCH v1 01/14] bbdev: add capability flag for filler bits inclusion in HARQ Nicolas Chautru
2020-02-27 4:38 ` [dpdk-dev] [PATCH v1 02/14] bbdev: expose device HARQ buffer size at device level Nicolas Chautru
2020-02-27 4:38 ` [dpdk-dev] [PATCH v1 03/14] baseband/turbo_sw: fix the exposed LLR decimals assumption Nicolas Chautru
2020-02-27 4:38 ` [dpdk-dev] [PATCH v1 04/14] baseband/turbo_sw: support large size code block Nicolas Chautru
2020-02-27 4:38 ` [dpdk-dev] [PATCH v1 05/14] test-bbdev: rename FPGA LTE macros to be more explicit Nicolas Chautru
2020-02-27 4:39 ` [dpdk-dev] [PATCH v1 06/14] test-bbdev: support HARQ validation Nicolas Chautru
2020-02-27 4:39 ` [dpdk-dev] [PATCH v1 07/14] test-bbdev: support for performance tests Nicolas Chautru
2020-02-27 4:39 ` [dpdk-dev] [PATCH v1 08/14] test-bbdev: support for LDPC interrupt test Nicolas Chautru
2020-02-27 4:39 ` [dpdk-dev] [PATCH v1 09/14] test-bbdev: support for offload test for LDPC Nicolas Chautru
2020-02-27 4:39 ` [dpdk-dev] [PATCH v1 10/14] test-bbdev: vectors update Nicolas Chautru
2020-02-27 4:39 ` [dpdk-dev] [PATCH v1 11/14] doc: update of testbbdev documentation Nicolas Chautru
2020-02-27 4:39 ` [dpdk-dev] [PATCH v1 12/14] drivers/baseband: add PMD for FPGA 5GNR FEC Nicolas Chautru
2020-02-27 4:39 ` [dpdk-dev] [PATCH v1 13/14] test-bbdev: add support for FPGA driver initialization Nicolas Chautru
2020-02-27 4:39 ` [dpdk-dev] [PATCH v1 14/14] doc: add feature matrix table for bbdev devices Nicolas Chautru
2020-03-04 18:22 ` [dpdk-dev] [PATCH v2 00/15] bbdev new features Nicolas Chautru
2020-03-04 18:22 ` [dpdk-dev] [PATCH v2 01/15] bbdev: add capability flag for filler bits inclusion in HARQ Nicolas Chautru
2020-03-04 18:22 ` [dpdk-dev] [PATCH v2 02/15] bbdev: expose device HARQ buffer size at device level Nicolas Chautru
2020-03-04 18:22 ` [dpdk-dev] [PATCH v2 03/15] baseband/turbo_sw: fix the exposed LLR decimals assumption Nicolas Chautru
2020-03-04 18:22 ` [dpdk-dev] [PATCH v2 04/15] baseband/turbo_sw: support large size code block Nicolas Chautru
2020-03-04 18:22 ` [dpdk-dev] [PATCH v2 05/15] test-bbdev: rename FPGA LTE macros to be more explicit Nicolas Chautru
2020-03-04 18:22 ` [dpdk-dev] [PATCH v2 06/15] test-bbdev: support HARQ validation Nicolas Chautru
2020-03-04 18:22 ` [dpdk-dev] [PATCH v2 07/15] test-bbdev: support for performance tests Nicolas Chautru
2020-03-04 18:22 ` [dpdk-dev] [PATCH v2 08/15] test-bbdev: support for LDPC interrupt test Nicolas Chautru
2020-03-04 18:22 ` [dpdk-dev] [PATCH v2 09/15] test-bbdev: support for offload test for LDPC Nicolas Chautru
2020-03-04 18:22 ` [dpdk-dev] [PATCH v2 10/15] test-bbdev: vectors update Nicolas Chautru
2020-03-04 18:22 ` [dpdk-dev] [PATCH v2 11/15] doc: update of testbbdev documentation Nicolas Chautru
2020-03-04 18:22 ` [dpdk-dev] [PATCH v2 12/15] drivers/baseband: add PMD for FPGA 5GNR FEC Nicolas Chautru
2020-03-04 18:22 ` [dpdk-dev] [PATCH v2 13/15] test-bbdev: add support for FPGA driver initialization Nicolas Chautru
2020-03-04 18:22 ` [dpdk-dev] [PATCH v2 14/15] doc: add feature matrix table for bbdev devices Nicolas Chautru
2020-03-04 18:22 ` [dpdk-dev] [PATCH v2 15/15] doc: add release note for bbdev PMD update Nicolas Chautru
2020-03-04 18:54 ` [dpdk-dev] [PATCH v3 00/14] bbdev new features Nicolas Chautru
2020-03-04 18:54 ` [dpdk-dev] [PATCH v3 01/14] bbdev: add capability flag for filler bits inclusion in HARQ Nicolas Chautru
2020-03-13 10:42 ` Dave Burley
2020-03-25 9:53 ` Akhil Goyal
2020-03-26 2:47 ` Chautru, Nicolas
2020-03-04 18:54 ` [dpdk-dev] [PATCH v3 02/14] bbdev: expose device HARQ buffer size at device level Nicolas Chautru
2020-03-13 10:47 ` Dave Burley
2020-03-04 18:54 ` [dpdk-dev] [PATCH v3 03/14] baseband/turbo_sw: fix the exposed LLR decimals assumption Nicolas Chautru
2020-03-04 18:54 ` [dpdk-dev] [PATCH v3 04/14] baseband/turbo_sw: support large size code block Nicolas Chautru
2020-03-13 16:10 ` Dave Burley
2020-03-25 10:18 ` Akhil Goyal
2020-03-26 2:50 ` Chautru, Nicolas
2020-03-04 18:54 ` [dpdk-dev] [PATCH v3 05/14] test-bbdev: rename FPGA LTE macros to be more explicit Nicolas Chautru
2020-03-13 10:55 ` Dave Burley
2020-03-04 18:54 ` [dpdk-dev] [PATCH v3 06/14] test-bbdev: support HARQ validation Nicolas Chautru
2020-03-25 13:23 ` Akhil Goyal
2020-03-26 2:53 ` Chautru, Nicolas
2020-03-04 18:54 ` [dpdk-dev] [PATCH v3 07/14] test-bbdev: support for performance tests Nicolas Chautru
2020-03-13 10:58 ` Dave Burley
2020-03-25 13:47 ` Akhil Goyal
2020-03-26 2:56 ` Chautru, Nicolas
2020-03-04 18:54 ` [dpdk-dev] [PATCH v3 08/14] test-bbdev: support for LDPC interrupt test Nicolas Chautru
2020-03-13 10:59 ` Dave Burley
2020-03-04 18:54 ` [dpdk-dev] [PATCH v3 09/14] test-bbdev: support for offload test for LDPC Nicolas Chautru
2020-03-25 13:54 ` Akhil Goyal
2020-03-26 2:57 ` Chautru, Nicolas
2020-03-04 18:54 ` [dpdk-dev] [PATCH v3 10/14] test-bbdev: vectors update Nicolas Chautru
2020-03-13 11:02 ` Dave Burley
2020-03-25 13:58 ` Akhil Goyal
2020-03-26 2:59 ` Chautru, Nicolas
2020-03-04 18:54 ` [dpdk-dev] [PATCH v3 11/14] doc: update of testbbdev documentation Nicolas Chautru
2020-03-13 11:03 ` Dave Burley
2020-03-25 14:48 ` Akhil Goyal
2020-03-26 3:02 ` Chautru, Nicolas
2020-03-04 18:55 ` [dpdk-dev] [PATCH v3 12/14] drivers/baseband: add PMD for FPGA 5GNR FEC Nicolas Chautru
2020-03-13 11:03 ` Dave Burley
2020-03-25 14:59 ` Akhil Goyal
2020-03-26 3:16 ` Chautru, Nicolas
2020-03-26 5:27 ` Akhil Goyal
2020-03-30 0:09 ` Chautru, Nicolas
2020-03-04 18:55 ` [dpdk-dev] [PATCH v3 13/14] test-bbdev: add support for FPGA driver initialization Nicolas Chautru
2020-03-13 11:05 ` Dave Burley
2020-03-04 18:55 ` [dpdk-dev] [PATCH v3 14/14] doc: add feature matrix table for bbdev devices Nicolas Chautru
2020-03-13 11:05 ` Dave Burley [this message]
2020-03-12 20:10 ` [dpdk-dev] [PATCH v3 00/14] bbdev new features Chautru, Nicolas
2020-03-13 7:15 ` Akhil Goyal
2020-03-24 23:47 ` Chautru, Nicolas
2020-03-26 2:45 ` [dpdk-dev] [PATCH v4 00/10] " Nicolas Chautru
2020-03-26 2:45 ` [dpdk-dev] [PATCH v4 01/10] bbdev: add capability flag for filler bits inclusion in HARQ Nicolas Chautru
2020-03-26 2:45 ` [dpdk-dev] [PATCH v4 02/10] bbdev: expose device HARQ buffer size at device level Nicolas Chautru
2020-03-26 2:45 ` [dpdk-dev] [PATCH v4 03/10] baseband/turbo_sw: fix the exposed LLR decimals assumption Nicolas Chautru
2020-03-26 2:45 ` [dpdk-dev] [PATCH v4 04/10] baseband/turbo_sw: support large size code block Nicolas Chautru
2020-03-26 2:45 ` [dpdk-dev] [PATCH v4 05/10] test-bbdev: rename FPGA LTE macros to be more explicit Nicolas Chautru
2020-03-26 2:45 ` [dpdk-dev] [PATCH v4 06/10] test-bbdev: support HARQ validation Nicolas Chautru
2020-03-26 2:45 ` [dpdk-dev] [PATCH v4 07/10] test-bbdev: support for performance tests Nicolas Chautru
2020-03-26 2:45 ` [dpdk-dev] [PATCH v4 08/10] test-bbdev: support for LDPC interrupt test Nicolas Chautru
2020-03-26 2:45 ` [dpdk-dev] [PATCH v4 09/10] test-bbdev: support for offload test for LDPC Nicolas Chautru
2020-03-26 2:45 ` [dpdk-dev] [PATCH v4 10/10] test-bbdev: vectors update Nicolas Chautru
2020-03-26 3:27 ` [dpdk-dev] [PATCH v5 00/10] bbdev new features Nicolas Chautru
2020-03-26 3:27 ` [dpdk-dev] [PATCH v5 01/10] bbdev: add capability flag for filler bits inclusion in HARQ Nicolas Chautru
2020-03-27 11:44 ` Dave Burley
2020-03-26 3:27 ` [dpdk-dev] [PATCH v5 02/10] bbdev: expose device HARQ buffer size at device level Nicolas Chautru
2020-03-27 11:45 ` Dave Burley
2020-03-26 3:27 ` [dpdk-dev] [PATCH v5 03/10] baseband/turbo_sw: fix the exposed LLR decimals assumption Nicolas Chautru
2020-03-27 11:45 ` Dave Burley
2020-03-26 3:27 ` [dpdk-dev] [PATCH v5 04/10] baseband/turbo_sw: support large size code block Nicolas Chautru
2020-03-27 11:45 ` Dave Burley
2020-03-26 3:27 ` [dpdk-dev] [PATCH v5 05/10] test-bbdev: rename FPGA LTE macros to be more explicit Nicolas Chautru
2020-03-27 11:45 ` Dave Burley
2020-03-26 3:27 ` [dpdk-dev] [PATCH v5 06/10] test-bbdev: support HARQ validation Nicolas Chautru
2020-03-27 11:47 ` Dave Burley
2020-03-26 3:27 ` [dpdk-dev] [PATCH v5 07/10] test-bbdev: support for performance tests Nicolas Chautru
2020-03-27 11:47 ` Dave Burley
2020-03-26 3:27 ` [dpdk-dev] [PATCH v5 08/10] test-bbdev: support for LDPC interrupt test Nicolas Chautru
2020-03-27 11:47 ` Dave Burley
2020-03-26 3:27 ` [dpdk-dev] [PATCH v5 09/10] test-bbdev: support for offload test for LDPC Nicolas Chautru
2020-03-27 11:47 ` Dave Burley
2020-03-26 3:27 ` [dpdk-dev] [PATCH v5 10/10] test-bbdev: vectors update Nicolas Chautru
2020-03-27 11:47 ` Dave Burley
2020-03-27 11:43 ` [dpdk-dev] [PATCH v5 00/10] bbdev new features Dave Burley
2020-04-05 16:41 ` Akhil Goyal
2020-03-03 18:08 ` [dpdk-dev] [PATCH v1 00/14] " Chautru, Nicolas
2020-03-04 8:23 ` Thomas Monjalon
2020-03-04 18:28 ` Chautru, Nicolas
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=40ae824b-a2e5-8bd0-c834-48b76aef6aa2@accelercomm.com \
--to=dave.burley@accelercomm.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).