From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <dev-bounces@dpdk.org>
Received: from dpdk.org (dpdk.org [92.243.14.124])
by inbox.dpdk.org (Postfix) with ESMTP id B0CF0A0471
for <public@inbox.dpdk.org>; Fri, 19 Jul 2019 00:01:10 +0200 (CEST)
Received: from [92.243.14.124] (localhost [127.0.0.1])
by dpdk.org (Postfix) with ESMTP id 271D2322C;
Fri, 19 Jul 2019 00:01:09 +0200 (CEST)
Received: from wout2-smtp.messagingengine.com (wout2-smtp.messagingengine.com
[64.147.123.25]) by dpdk.org (Postfix) with ESMTP id C7B4E2BC7
for <dev@dpdk.org>; Fri, 19 Jul 2019 00:01:07 +0200 (CEST)
Received: from compute1.internal (compute1.nyi.internal [10.202.2.41])
by mailout.west.internal (Postfix) with ESMTP id A3FBC424;
Thu, 18 Jul 2019 18:01:06 -0400 (EDT)
Received: from mailfrontend2 ([10.202.2.163])
by compute1.internal (MEProxy); Thu, 18 Jul 2019 18:01:07 -0400
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h=
from:to:cc:subject:date:message-id:in-reply-to:references
:mime-version:content-transfer-encoding; s=mesmtp; bh=lMMgtS/Na5
BNWQvhLkY24yUFX2wAtQiFj6fd7qH7Sj8=; b=TREHvU5mKoDSBrh25I0CITwQ8Q
pHFPlrGTLR50QU0ZMAPzz8ySu2ZzutZnk/8HBfw92uMqQZoLgMiSHByWcfuA15MH
XdMbSuy4XjCsn8n5BncJCfNKT21IUViWdgrcfDfKb4zyTURVQkWRRGtmXC7rzGQS
prID31b8nvKDHqFNE=
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=
messagingengine.com; h=cc:content-transfer-encoding:date:from
:in-reply-to:message-id:mime-version:references:subject:to
:x-me-proxy:x-me-proxy:x-me-sender:x-me-sender:x-sasl-enc; s=
fm3; bh=lMMgtS/Na5BNWQvhLkY24yUFX2wAtQiFj6fd7qH7Sj8=; b=clYjikTW
NxuEwBbcytWLIBYr6YlTv+DV7gsowpr6g9m2vQylkRaQEuymCUstc7W8g3azIXS9
XbyvCYwahskeSZMl2+XZJtmjxBri/MAzJC2nhs/rRsWq7EFDXTkbzEXiIpHSp96p
828yuHQyCcdZBMTnwohDDXl7Zk8/+LcMTX+/IVqUGA+QrUJzQSCSIOVsmpc0WZIT
Nlo/PtkoWRJ0qVLdxaqN/x5ZnHJ/IzLjALnVv18vafKAllelVlRYA4ZpTbE7hNCh
0C+ae3sN2UVBLS1FXaGPuDX+DGDsFcLJ03Ecx4o1mP2Qtxu9ScF1wkCTzq98Y/t3
8XxeM66DBU+wQQ==
X-ME-Sender: <xms:IewwXYNbZDXYx8pkImP82lHA7SqxHzF5oXMMfqLJKGRm_7qBW8Omlg>
X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgeduvddrieeigddtiecutefuodetggdotefrodftvf
curfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfghnecu
uegrihhlohhuthemuceftddtnecusecvtfgvtghiphhivghnthhsucdlqddutddtmdenuc
fjughrpefhvffufffkofgjfhgggfestdekredtredttdenucfhrhhomhepvfhhohhmrghs
ucfoohhnjhgrlhhonhcuoehthhhomhgrshesmhhonhhjrghlohhnrdhnvghtqeenucffoh
hmrghinhepughpughkrdhorhhgnecukfhppeejjedrudefgedrvddtfedrudekgeenucfr
rghrrghmpehmrghilhhfrhhomhepthhhohhmrghssehmohhnjhgrlhhonhdrnhgvthenuc
evlhhushhtvghrufhiiigvpedt
X-ME-Proxy: <xmx:IewwXR0LQssqFoFy4NKmSSTbq8VyuUp9oXCec8F-37OsQqwR415w5w>
<xmx:IewwXQFpSidzEb56OxO0Et7w4N46MfInFl_IwXke2Tcdd0tOUTx5kg>
<xmx:IewwXShxrnG1nea0eC-RQcamSa2V7_mg1KyUum0Sy-AdqXpAQHP4UQ>
<xmx:IuwwXYSIyRtK1h3XrNykeYVhOf5W6H8J5DMf04vv7l2PB5E7vPVyLA>
Received: from xps.monjalon.net (184.203.134.77.rev.sfr.net [77.134.203.184])
by mail.messagingengine.com (Postfix) with ESMTPA id D26BF38008A;
Thu, 18 Jul 2019 18:01:04 -0400 (EDT)
From: Thomas Monjalon <thomas@monjalon.net>
To: Nicolas Chautru <nicolas.chautru@intel.com>,
John McNamara <john.mcnamara@intel.com>,
Marko Kovacevic <marko.kovacevic@intel.com>
Cc: dev@dpdk.org
Date: Fri, 19 Jul 2019 00:01:01 +0200
Message-Id: <20190718220101.16900-1-thomas@monjalon.net>
X-Mailer: git-send-email 2.21.0
In-Reply-To: <1563431079-14170-1-git-send-email-nicolas.chautru@intel.com>
References: <1563431079-14170-1-git-send-email-nicolas.chautru@intel.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Subject: [dpdk-dev] [PATCH v3] doc: fix PDF build of bbdev prog guide
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
<mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
<mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>
Some machine (like on dpdk.org) may fail to build the prog guide PDF
because of a table characher being "+" instead of "|".
Some figure references are also fixed with automatic numbering.
Fixes: 3f3f608142cf ("doc: update bbdev guide for 5GNR operations")
Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
Signed-off-by: Nicolas Chautru <nicolas.chautru@intel.com>
---
v3: fix only the bad character and keep complex table (Thomas)
v2: try simpler table and fix figure refs (Nicolas)
v1: remove some table rows (Thomas)
---
doc/guides/prog_guide/bbdev.rst | 12 +++++++-----
1 file changed, 7 insertions(+), 5 deletions(-)
diff --git a/doc/guides/prog_guide/bbdev.rst b/doc/guides/prog_guide/bbdev.rst
index ef05dcb4c..d49184967 100644
--- a/doc/guides/prog_guide/bbdev.rst
+++ b/doc/guides/prog_guide/bbdev.rst
@@ -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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -1077,8 +1078,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
--
2.21.0