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 <nicolas.chautru@intel.com>
Acked-by: Dave Burley <dave.burley@accelercomm.com>
Acked-by: Niall Power <niall.power@intel.com>
Acked-by: Akhil Goyal <akhil.goyal@nxp.com>
This commit is contained in:
Nicolas Chautru 2020-04-18 15:46:48 -07:00 committed by Akhil Goyal
parent b7b1ba6450
commit 65f1eecaa0
10 changed files with 88 additions and 0 deletions

1
.gitignore vendored
View File

@ -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

View File

@ -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 =

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -8,6 +8,7 @@ Baseband Device Drivers
:maxdepth: 2
:numbered:
overview
null
turbo_sw
fpga_lte_fec

View File

@ -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

View File

@ -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 '