Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/54436/?format=api
{ "id": 54436, "url": "http://patches.dpdk.org/api/patches/54436/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/patch/1559765196-250614-4-git-send-email-nicolas.chautru@intel.com/", "project": { "id": 1, "url": "http://patches.dpdk.org/api/projects/1/?format=api", "name": "DPDK", "link_name": "dpdk", "list_id": "dev.dpdk.org", "list_email": "dev@dpdk.org", "web_url": "http://core.dpdk.org", "scm_url": "git://dpdk.org/dpdk", "webscm_url": "http://git.dpdk.org/dpdk", "list_archive_url": "https://inbox.dpdk.org/dev", "list_archive_url_format": "https://inbox.dpdk.org/dev/{}", "commit_url_format": "" }, "msgid": "<1559765196-250614-4-git-send-email-nicolas.chautru@intel.com>", "list_archive_url": "https://inbox.dpdk.org/dev/1559765196-250614-4-git-send-email-nicolas.chautru@intel.com", "date": "2019-06-05T20:06:36", "name": "[v2,3/3] docs/guides: updating turbo_sw building steps", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": true, "hash": "f48b1e0794a1a502cd67a1d64232290e075c3207", "submitter": { "id": 1314, "url": "http://patches.dpdk.org/api/people/1314/?format=api", "name": "Chautru, Nicolas", "email": "nicolas.chautru@intel.com" }, "delegate": null, "mbox": "http://patches.dpdk.org/project/dpdk/patch/1559765196-250614-4-git-send-email-nicolas.chautru@intel.com/mbox/", "series": [ { "id": 4913, "url": "http://patches.dpdk.org/api/series/4913/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=4913", "date": "2019-06-05T20:06:33", "name": "BBDEV turbo_sw PMD compilation fix", "version": 2, "mbox": "http://patches.dpdk.org/series/4913/mbox/" } ], "comments": "http://patches.dpdk.org/api/patches/54436/comments/", "check": "success", "checks": "http://patches.dpdk.org/api/patches/54436/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@dpdk.org", "Delivered-To": "patchwork@dpdk.org", "Received": [ "from [92.243.14.124] (localhost [127.0.0.1])\n\tby dpdk.org (Postfix) with ESMTP id 4A5CB1B9B4;\n\tWed, 5 Jun 2019 22:08:32 +0200 (CEST)", "from mga06.intel.com (mga06.intel.com [134.134.136.31])\n\tby dpdk.org (Postfix) with ESMTP id 3A1051B9A9\n\tfor <dev@dpdk.org>; Wed, 5 Jun 2019 22:08:28 +0200 (CEST)", "from orsmga005.jf.intel.com ([10.7.209.41])\n\tby orsmga104.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;\n\t05 Jun 2019 13:08:26 -0700", "from skx-5gnr-sc12-1.sc.intel.com ([172.25.69.194])\n\tby orsmga005.jf.intel.com with ESMTP; 05 Jun 2019 13:08:26 -0700" ], "X-Amp-Result": "SKIPPED(no attachment in message)", "X-Amp-File-Uploaded": "False", "X-ExtLoop1": "1", "From": "Nicolas Chautru <nicolas.chautru@intel.com>", "To": "thomas@monjalon.net, akhil.goyal@nxp.com, dev@dpdk.org\u001b\b\b", "Cc": "ferruh.yigit@intel.com,\n\tNicolas Chautru <nicolas.chautru@intel.com>", "Date": "Wed, 5 Jun 2019 13:06:36 -0700", "Message-Id": "<1559765196-250614-4-git-send-email-nicolas.chautru@intel.com>", "X-Mailer": "git-send-email 1.8.3.1", "In-Reply-To": "<1559765196-250614-1-git-send-email-nicolas.chautru@intel.com>", "References": "<1559756323-179855-2-git-send-email-nicolas.chautru@intel.com>\n\t<1559765196-250614-1-git-send-email-nicolas.chautru@intel.com>", "Subject": "[dpdk-dev] [PATCH v2 3/3] docs/guides: updating turbo_sw building\n\tsteps", "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>,\n\t<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>,\n\t<mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org", "Sender": "\"dev\" <dev-bounces@dpdk.org>" }, "content": "The documentation is clarified to point to steps on building the\nSDK libraries which are now publicly available.\n\nSigned-off-by: Nicolas Chautru <nicolas.chautru@intel.com>\n---\n doc/guides/bbdevs/turbo_sw.rst | 84 +++++++++++++++++++++++-------------------\n 1 file changed, 46 insertions(+), 38 deletions(-)", "diff": "diff --git a/doc/guides/bbdevs/turbo_sw.rst b/doc/guides/bbdevs/turbo_sw.rst\nindex 29f7ec9..196b3d6 100644\n--- a/doc/guides/bbdevs/turbo_sw.rst\n+++ b/doc/guides/bbdevs/turbo_sw.rst\n@@ -1,26 +1,43 @@\n .. SPDX-License-Identifier: BSD-3-Clause\n Copyright(c) 2017 Intel Corporation\n \n-SW Turbo Poll Mode Driver\n+SW FEC Poll Mode Driver\n =========================\n \n-The SW Turbo PMD (**baseband_turbo_sw**) provides a poll mode bbdev driver that utilizes\n-Intel optimized libraries for LTE Layer 1 workloads acceleration. This PMD\n-supports the functions: Turbo FEC, Rate Matching and CRC functions.\n+The SW FEC PMD (**baseband_turbo_sw**) provides a software only poll mode bbdev\n+driver that can optionally utilize Intel optimized libraries for LTE and 5GNR\n+Layer 1 workloads acceleration.\n+\n+Note that the driver can also be built without any dependency with reduced\n+functionality for maintenance purpose.\n+\n+To enable linking to the SDK libraries see detailed installation section below.\n+Two flags can be enabled depending on whether the target machine can support\n+AVX2 and AVX512 instructions sets and the related SDK libraries for vectorized\n+signal processing functions are installed :\n+- CONFIG_RTE_BBDEV_SDK_AVX2\n+- CONFIG_RTE_BBDEV_SDK_AVX512\n+By default these 2 flags are disabled by default. For AVX2 machine and SDK\n+library installed then the first flag can be enabled. For AVX512 machine and\n+SDK library installed then both flags can be enabled for full real time capability.\n+\n+This PMD supports the functions: FEC, Rate Matching and CRC functions detailed\n+in the Features section.\n \n Features\n --------\n \n-SW Turbo PMD has support for the following capabilities:\n+SW FEC PMD can support for the following capabilities when the SDK libraries\n+are used:\n \n-For the encode operation:\n+For the LTE encode operation:\n \n * ``RTE_BBDEV_TURBO_CRC_24A_ATTACH``\n * ``RTE_BBDEV_TURBO_CRC_24B_ATTACH``\n * ``RTE_BBDEV_TURBO_RATE_MATCH``\n * ``RTE_BBDEV_TURBO_RV_INDEX_BYPASS``\n \n-For the decode operation:\n+For the LTE decode operation:\n \n * ``RTE_BBDEV_TURBO_SUBBLOCK_DEINTERLEAVE``\n * ``RTE_BBDEV_TURBO_CRC_TYPE_24B``\n@@ -41,14 +58,10 @@ Installation\n FlexRAN SDK Download\n ~~~~~~~~~~~~~~~~~~~~\n \n-To build DPDK with the *baseband_turbo_sw* PMD the user is required to download\n-the export controlled ``FlexRAN SDK`` Libraries. An account at `Intel Resource\n-Design Center <https://www.intel.com/content/www/us/en/design/resource-design-center.html>`_\n-needs to be registered.\n+As an option it is possible to link this driver with FleXRAN SDK libraries\n+which can enable real time signal processing using AVX instructions.\n \n-Once registered, the user needs to log in, and look for\n-*Intel FlexRAN Software Release Package -18-09* to download or directly through\n-this `link <https://cdrdv2.intel.com/v1/dl/getContent/605167>`_.\n+These libraries are available through this link `link <https://software.intel.com/en-us/articles/flexran-lte-and-5g-nr-fec-software-development-kit-modules>`_.\n \n After download is complete, the user needs to unpack and compile on their\n system before building DPDK.\n@@ -57,24 +70,24 @@ The following table maps DPDK versions with past FlexRAN SDK releases:\n \n .. _table_flexran_releases:\n \n-.. table:: DPDK and FlexRAN SDK releases compliance\n+.. table:: DPDK and FlexRAN FEC SDK releases compliance\n \n ===================== ============================\n- DPDK version FlexRAN SDK release\n+ DPDK version FlexRAN FEC SDK release\n ===================== ============================\n- 18.02 1.3.0\n- 18.05 1.4.0\n- 18.08 1.6.0\n- 19.02 18.09\n+ 19.08 19.04\n ===================== ============================\n \n FlexRAN SDK Installation\n ~~~~~~~~~~~~~~~~~~~~~~~~\n \n+Note that the installation of these libraries is optional.\n+\n The following are pre-requisites for building FlexRAN SDK Libraries:\n- (a) An AVX2 supporting machine\n- (b) CentOS Linux release 7.2.1511 (Core) operating system\n- (c) Intel ICC 18.0.1 20171018 compiler installed\n+ (a) An AVX2 or AVX512 supporting machine\n+ (b) CentOS Linux release 7.2.1511 (Core) operating system is advised\n+ (c) Intel ICC 18.0.1 20171018 compiler or more recent and related libraries\n+ ICC is available with a free community license `link <https://software.intel.com/en-us/system-studio/choose-download#technical>`_.\n \n The following instructions should be followed in this exact order:\n \n@@ -84,25 +97,18 @@ The following instructions should be followed in this exact order:\n \n source <path-to-icc-compiler-install-folder>/linux/bin/compilervars.sh intel64 -platform linux\n \n-#. Extract the ``605167-flexran-18-09-tar.gz`` package:\n-\n- .. code-block:: console\n-\n- mkdir FlexRAN-18.09\n- tar xvzf 605167-flexran-18-09-tar.gz -C FlexRAN-18.09/\n-\n #. Run the SDK extractor script and accept the license:\n \n .. code-block:: console\n \n- cd <path-to-workspace>/FlexRAN-18.09/\n- ./SDK-18.09.sh\n+ cd <path-to-workspace>\n+ ./FlexRAN-FEC-SDK-19-04.sh\n \n #. Generate makefiles based on system configuration:\n \n .. code-block:: console\n \n- cd <path-to-workspace>/FlexRAN-18.09/SDK-18.09/sdk/\n+ cd <path-to-workspace>/FlexRAN-FEC-SDK-19-04/sdk/\n ./create-makefiles-linux.sh\n \n #. A build folder is generated in this form ``build-<ISA>-<CC>``, enter that\n@@ -129,12 +135,14 @@ Example:\n \n .. code-block:: console\n \n- export FLEXRAN_SDK=<path-to-workspace>/FlexRAN-18.09/SDK-18.09/sdk/build-avx2-icc/install\n- export DIR_WIRELESS_SDK=<path-to-workspace>/FlexRAN-18.09/SDK-18.09/sdk/\n-\n+ export FLEXRAN_SDK=<path-to-workspace>/FlexRAN-FEC-SDK-19-04/sdk/build-avx2-icc/install\n+ export DIR_WIRELESS_SDK=<path-to-workspace>/FlexRAN-FEC-SDK-19-04/sdk/build-avx2-icc/\n \n-* Set ``CONFIG_RTE_LIBRTE_PMD_BBDEV_TURBO_SW=y`` in DPDK common configuration\n- file ``config/common_base``.\n+* Set ``CONFIG_RTE_BBDEV_SDK_AVX2=y``\n+ in DPDK common configuration file ``config/common_base`` to be able to use\n+ the SDK libraries as mentioned above.\n+ If no flag are set the PMD driver will still build but its capabilities\n+ will be limited accordingly.\n \n To use the PMD in an application, user must:\n \n", "prefixes": [ "v2", "3/3" ] }