X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fprog_guide%2Fbbdev.rst;h=6b2bd54e1ae7c2eebaff1073d431979f0eacc159;hb=52bf2010c97e20ef90e3e919126694a4393c81e2;hp=ef05dcb4ccdce813b701a6cfbdc269213a423769;hpb=3f3f608142cf48048c31fda35bb3b3cc86f006f0;p=dpdk.git diff --git a/doc/guides/prog_guide/bbdev.rst b/doc/guides/prog_guide/bbdev.rst index ef05dcb4cc..6b2bd54e1a 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 @@ -809,7 +809,7 @@ The LDPC encode parameters are set out in the table below. +----------------+------------+-------------------------------------------------------+ | |r |index of the first CB in the inbound mbuf data | +----------------+------------+-------------------------------------------------------+ -+ +c_ab +number of CBs that use Ea before switching to Eb | +| |c_ab |number of CBs that use Ea before switching to Eb | +----------------+------------+-------------------------------------------------------+ | |ea |Ea, length of the RM output sequence in bits, r < cab | +----------------+------------+-------------------------------------------------------+ @@ -865,8 +865,9 @@ calculated by BBDEV before signalling to the driver. The number of CBs in the group should not be confused with ``c``, the total number of CBs in the full TB (``C`` as per 3GPP TS 38.212 section 5.2.2) -Figure 13.1 above showing the Turbo encoding of CBs using BBDEV -interface in TB-mode is also valid for LDPC encode. +Figure :numref:`figure_turbo_tb_encode` above +showing the Turbo encoding of CBs using BBDEV interface in TB-mode +is also valid for LDPC encode. BBDEV LDPC Decode Operation ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -926,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 | @@ -1068,7 +1071,7 @@ The mbuf ``length`` is inclusive of CRC24A/B where present and is equal the code block size ``K``. The first CB Virtual Circular Buffer (VCB) index is given by ``r`` but the -the number of the remaining CB VCBs is calculated automatically by BBDEV +number of the remaining CB VCBs is calculated automatically by BBDEV and passed down to the driver. The number of remaining CB VCBs should not be confused with ``c``, the @@ -1077,8 +1080,9 @@ total number of CBs in the full TB (``C`` as per 3GPP TS 38.212 section 5.2.2) The ``length`` is total size of the CBs inclusive of any CRC24A and CRC24B in case they were appended by the application. -Figure 13.2 above showing the Turbo decoding of CBs using BBDEV -interface in TB-mode is also valid for LDPC decode. +Figure :numref:`figure_turbo_tb_decode` above +showing the Turbo decoding of CBs using BBDEV interface in TB-mode +is also valid for LDPC decode. Sample code