From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id DA422A0C45; Fri, 13 Aug 2021 18:52:05 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 82FE341288; Fri, 13 Aug 2021 18:51:41 +0200 (CEST) Received: from mga14.intel.com (mga14.intel.com [192.55.52.115]) by mails.dpdk.org (Postfix) with ESMTP id AB0F141180 for ; Fri, 13 Aug 2021 18:51:38 +0200 (CEST) X-IronPort-AV: E=McAfee;i="6200,9189,10075"; a="215320194" X-IronPort-AV: E=Sophos;i="5.84,319,1620716400"; d="scan'208";a="215320194" Received: from fmsmga008.fm.intel.com ([10.253.24.58]) by fmsmga103.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 13 Aug 2021 09:51:37 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.84,319,1620716400"; d="scan'208";a="486025113" Received: from unknown (HELO icx-npg-scs1-cp1.localdomain) ([10.233.180.245]) by fmsmga008.fm.intel.com with ESMTP; 13 Aug 2021 09:51:37 -0700 From: Nicolas Chautru To: dev@dpdk.org, gakhil@marvell.com Cc: thomas@monjalon.net, trix@redhat.com, hemant.agrawal@nxp.com, mingshan.zhang@intel.com, Nicolas Chautru Date: Fri, 13 Aug 2021 09:51:24 -0700 Message-Id: <1628873485-30596-6-git-send-email-nicolas.chautru@intel.com> X-Mailer: git-send-email 1.8.3.1 In-Reply-To: <1628873485-30596-1-git-send-email-nicolas.chautru@intel.com> References: <1628873485-30596-1-git-send-email-nicolas.chautru@intel.com> Subject: [dpdk-dev] [PATCH v1 5/6] doc: clarification of usage of HARQ in bbdev doc X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" New paragraph detailing typical VRAN usecase and mapping to bbdev API usage. Signed-off-by: Nicolas Chautru --- doc/guides/prog_guide/bbdev.rst | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/doc/guides/prog_guide/bbdev.rst b/doc/guides/prog_guide/bbdev.rst index 8bd7cba..d48c9a0 100644 --- a/doc/guides/prog_guide/bbdev.rst +++ b/doc/guides/prog_guide/bbdev.rst @@ -1054,6 +1054,29 @@ capability RTE_BBDEV_LDPC_INTERNAL_HARQ_MEMORY_OUT_ENABLE is set then the HARQ is stored in memory internal to the device and not visible to BBDEV. +.. note:: + More explicitly for a typical usage of HARQ retransmission in a VRAN + application using a HW PMD, there will be 2 cases. + + For 1st transmission, only the HARQ output is enabled : + + - the harq_combined_output.offset is provided to a given address. ie. typicallly an integer index * 32K, where the index is tracked by the application based on code block index for a given UE and HARQ process. + + - the related operation flag would notably include RTE_BBDEV_LDPC_HQ_COMBINE_OUT_ENABLE and RTE_BBDEV_LDPC_HARQ_6BIT_COMPRESSION. + + - note that not explicit flush or reset of the memory is required. + + For 2nd transmission, an input is also required to benefit from HARQ combination gain: + + - the changes mentioned above are the same (note that rvIndex may be adjusted). + + - the operation flag would additionally include the LDPC_HQ_COMBINE_IN_ENABLE flag. + + - the harq_combined_input.offset must set to the address of the related code block (ie. same as the harq_combine_output index above for the same code block, HARQ process, UE). + + - the harq_combined_input.length must be set to the length which was provided back in the related harq_combined_output.length when it has processed and dequeued (previous HARQ iteration). + + The output mbuf data structures are expected to be allocated by the application with enough room for the output data. -- 1.8.3.1