[v1] doc: update bbdev guide
diff mbox series

Message ID 1597957080-66453-1-git-send-email-nicolas.chautru@intel.com
State Accepted, archived
Delegated to: akhil goyal
Headers show
Series
  • [v1] doc: update bbdev guide
Related show

Checks

Context Check Description
ci/travis-robot success Travis build: passed
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

Chautru, Nicolas Aug. 20, 2020, 8:58 p.m. UTC
Clarify the capability assumptions for LLR and HARQ
compression format.
Correct one historical typo.

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

Comments

Aidan Goddard Sept. 15, 2020, 9:56 a.m. UTC | #1
Acked-by: Aidan Goddard <aidan.goddard@accelercomm.com>


From: dev <dev-bounces@dpdk.org> on behalf of Nicolas Chautru <nicolas.chautru@intel.com>
Sent: 20 August 2020 21:58
To: dev@dpdk.org <dev@dpdk.org>
Cc: Dave Burley <dave.burley@accelercomm.com>; Nicolas Chautru <nicolas.chautru@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@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    |
Akhil Goyal Oct. 6, 2020, 8:53 p.m. UTC | #2
> 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@intel.com>
> ---
Should this be cced to stable for back port?
Chautru, Nicolas Oct. 6, 2020, 9 p.m. UTC | #3
Hi Akhil, 

> -----Original Message-----
> From: Akhil Goyal <akhil.goyal@nxp.com>
> Sent: Tuesday, October 6, 2020 1:53 PM
> To: Chautru, Nicolas <nicolas.chautru@intel.com>; dev@dpdk.org
> Cc: dave.burley@accelercomm.com
> Subject: RE: [dpdk-dev] [PATCH v1] doc: update bbdev guide
> 
> > 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@intel.com>
> > ---
> Should this be cced to stable for back port?

I have no strong opinion given this is minor doc clarification update. 
Also the related feature is not really exercised until 20.11 really (with new PMD).
Still if you think it is required the change would refer to that commit 3f3f608142cf48
Let me know if I should resubmit.

Thanks
Nic
Akhil Goyal Oct. 6, 2020, 9:10 p.m. UTC | #4
Hi Nic,

> Hi Akhil,
> 
> I have no strong opinion given this is minor doc clarification update.
> Also the related feature is not really exercised until 20.11 really (with new PMD).
> Still if you think it is required the change would refer to that commit
> 3f3f608142cf48
> Let me know if I should resubmit.

I applied it as is.
Thanks.

Patch
diff mbox series

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    |