[dpdk-dev] [PATCH v1] doc: update bbdev guide

[Aidan Goddard]

Acked-by: Aidan Goddard <aidan.goddard at accelercomm.com>


From: dev <dev-bounces at dpdk.org> on behalf of Nicolas Chautru <nicolas.chautru at intel.com>
Sent: 20 August 2020 21:58
To: dev at dpdk.org <dev at dpdk.org>
Cc: Dave Burley <dave.burley at accelercomm.com>; Nicolas Chautru <nicolas.chautru at intel.com>
Subject: [dpdk-dev] [PATCH v1] doc: update bbdev guide 
 
Clarify the capability assumptions for LLR and HARQ
compression format.
Correct one historical typo.

Signed-off-by: Nicolas Chautru <nicolas.chautru at intel.com>
---
 doc/guides/prog_guide/bbdev.rst | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/doc/guides/prog_guide/bbdev.rst b/doc/guides/prog_guide/bbdev.rst
index d39167a..6b2bd54 100644
--- a/doc/guides/prog_guide/bbdev.rst
+++ b/doc/guides/prog_guide/bbdev.rst
@@ -13,7 +13,7 @@ optimized libraries to appear as virtual bbdev devices.
 The functional scope of the BBDEV library are those functions in relation to
 the 3GPP Layer 1 signal processing (channel coding, modulation, ...).
 
-The framework currently only supports Turbo Code FEC function.
+The framework currently only supports FEC function.
 
 
 Design Principles
@@ -927,9 +927,11 @@ given below.
 +--------------------------------------------------------------------+
 |RTE_BBDEV_LDPC_HARQ_6BIT_COMPRESSION                                |
 | Set if a device supports input/output HARQ compression             |
+| Data is packed as 6 bits by dropping and saturating the MSBs       |
 +--------------------------------------------------------------------+
 |RTE_BBDEV_LDPC_LLR_COMPRESSION                                      |
 | Set if a device supports input LLR compression                     |
+| Data is packed as 6 bits by dropping and saturating the MSBs       |
 +--------------------------------------------------------------------+
 |RTE_BBDEV_LDPC_INTERNAL_HARQ_MEMORY_IN_ENABLE                       |
 | Set if a device supports HARQ input to device's internal memory    |
-- 
1.8.3.1