[v1,1/2] doc: update bbdev documentation

Message ID 20250228165022.480453-2-nicolas.chautru@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Maxime Coquelin
Headers
Series bbdev: doc and vector clean up |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Nicolas Chautru Feb. 28, 2025, 4:50 p.m. UTC
Correcting the scope of supported bbdev operations.

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

Comments

Maxime Coquelin March 4, 2025, 4:17 p.m. UTC | #1
On 2/28/25 5:50 PM, Nicolas Chautru wrote:
> Correcting the scope of supported bbdev operations.
> 
> Signed-off-by: Nicolas Chautru <nicolas.chautru@intel.com>
> ---
>   doc/guides/prog_guide/bbdev.rst | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/doc/guides/prog_guide/bbdev.rst b/doc/guides/prog_guide/bbdev.rst
> index e3f356450b..f0fbb0c1c0 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 FEC function.
> +The framework currently supports FEC functions (5G/4G Encoder/Decoder), as well as FFT and MLD-TS.
>   
>   
>   Design Principles

Reviewed-by: Maxime Coquelin <maxime.coquelin@redhat.com>

Thanks,
Maxime
  

Patch

diff --git a/doc/guides/prog_guide/bbdev.rst b/doc/guides/prog_guide/bbdev.rst
index e3f356450b..f0fbb0c1c0 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 FEC function.
+The framework currently supports FEC functions (5G/4G Encoder/Decoder), as well as FFT and MLD-TS.
 
 
 Design Principles