From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 77C26A0573; Wed, 4 Mar 2020 19:56:04 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 95F141BFF8; Wed, 4 Mar 2020 19:55:23 +0100 (CET) Received: from mga03.intel.com (mga03.intel.com [134.134.136.65]) by dpdk.org (Postfix) with ESMTP id 3057A2C02 for ; Wed, 4 Mar 2020 19:55:15 +0100 (CET) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by orsmga103.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 04 Mar 2020 10:55:14 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.70,514,1574150400"; d="scan'208";a="274778284" Received: from skx-5gnr-sc12-4.sc.intel.com ([172.25.69.210]) by fmsmga002.fm.intel.com with ESMTP; 04 Mar 2020 10:55:12 -0800 From: Nicolas Chautru To: thomas@monjalon.net, akhil.goyal@nxp.com, dev@dpdk.org Cc: ferruh.yigit@intel.com, Nic Chautru Date: Wed, 4 Mar 2020 10:55:02 -0800 Message-Id: <1583348102-13253-15-git-send-email-nicolas.chautru@intel.com> X-Mailer: git-send-email 1.8.3.1 In-Reply-To: <1583348102-13253-1-git-send-email-nicolas.chautru@intel.com> References: <1582778348-113547-15-git-send-email-nicolas.chautru@intel.com> <1583348102-13253-1-git-send-email-nicolas.chautru@intel.com> Subject: [dpdk-dev] [PATCH v3 14/14] doc: add feature matrix table for bbdev devices X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" From: Nic Chautru Adding missing overview page in documentation with comparison of feature set by PMD implementation. Signed-off-by: Nic Chautru --- .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