From: Nicolas Chautru Date: Sat, 18 Apr 2020 22:46:48 +0000 (-0700) Subject: doc: add feature matrix table for bbdev X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=65f1eec;p=dpdk.git doc: add feature matrix table for bbdev Adding missing overview page in documentation with comparison of feature set by each available PMD implementation. Signed-off-by: Nicolas Chautru Acked-by: Dave Burley Acked-by: Niall Power Acked-by: Akhil Goyal --- diff --git a/.gitignore b/.gitignore index 2acb459752..f2f8892946 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 0000000000..5fe267a625 --- /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 0000000000..7a0b8d4e75 --- /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 0000000000..f1cfb924a2 --- /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 0000000000..78a7b95da3 --- /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 0000000000..d9bbda9cf0 --- /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 0000000000..2c7075e212 --- /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 1a79343ff1..a8092dd2e9 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 0000000000..8dc35a3c1b --- /dev/null +++ b/doc/guides/bbdevs/overview.rst @@ -0,0 +1,12 @@ +.. 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 9093ad31a0..700e05e170 100644 --- a/doc/guides/conf.py +++ b/doc/guides/conf.py @@ -414,6 +414,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 '