From patchwork Mon Sep 21 13:59:22 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Power, Ciara" X-Patchwork-Id: 78199 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 420B2A04CC; Mon, 21 Sep 2020 16:04:45 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id E8B521DA88; Mon, 21 Sep 2020 16:02:47 +0200 (CEST) Received: from mga05.intel.com (mga05.intel.com [192.55.52.43]) by dpdk.org (Postfix) with ESMTP id E0E7C1DA88 for ; Mon, 21 Sep 2020 16:02:45 +0200 (CEST) IronPort-SDR: Zxnu3gaN0vAq68pBaQu0xBGSuFFHvHa0TxIMsfj21GOR8NsW7Uzo1wQzHzP1PW868GT+AZgvnH ff661z8PKkcg== X-IronPort-AV: E=McAfee;i="6000,8403,9750"; a="245216878" X-IronPort-AV: E=Sophos;i="5.77,286,1596524400"; d="scan'208";a="245216878" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga006.fm.intel.com ([10.253.24.20]) by fmsmga105.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 21 Sep 2020 07:02:45 -0700 IronPort-SDR: h4Lw8pF+3Bp9lfNvyxmbQlWXAWIdRXJsAGnOf+EmJDpuiKAimnQPs5RCczBfK2mIMOjhtYAS9V zE+CKIgk7Pkg== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.77,286,1596524400"; d="scan'208";a="510083167" Received: from silpixa00399953.ir.intel.com (HELO silpixa00399953.ger.corp.intel.com) ([10.237.222.53]) by fmsmga006.fm.intel.com with ESMTP; 21 Sep 2020 07:02:43 -0700 From: Ciara Power To: dev@dpdk.org Cc: Ciara Power , Nicolas Chautru , John McNamara , Marko Kovacevic Date: Mon, 21 Sep 2020 14:59:22 +0100 Message-Id: <20200921135931.13355-12-ciara.power@intel.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20200921135931.13355-1-ciara.power@intel.com> References: <20200807123009.21266-1-ciara.power@intel.com> <20200921135931.13355-1-ciara.power@intel.com> Subject: [dpdk-dev] [PATCH v5 11/20] doc: remove references to make from bbdevs guides X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 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" Make is no longer supported for compiling DPDK, references are now removed in the documentation. Signed-off-by: Ciara Power Reviewed-by: Kevin Laatz --- v5: Added meson steps to turbo_sw doc. --- doc/guides/bbdevs/fpga_5gnr_fec.rst | 7 ++----- doc/guides/bbdevs/fpga_lte_fec.rst | 7 ++----- doc/guides/bbdevs/turbo_sw.rst | 23 ++++++++--------------- 3 files changed, 12 insertions(+), 25 deletions(-) diff --git a/doc/guides/bbdevs/fpga_5gnr_fec.rst b/doc/guides/bbdevs/fpga_5gnr_fec.rst index 6760391e8c..8e00c4ef22 100644 --- a/doc/guides/bbdevs/fpga_5gnr_fec.rst +++ b/doc/guides/bbdevs/fpga_5gnr_fec.rst @@ -51,10 +51,7 @@ FPGA 5GNR FEC does not support the following: Installation ------------ -Section 3 of the DPDK manual provides instructions on installing and compiling DPDK. The -default set of bbdev compile flags may be found in config/common_base, where for example -the flag to build the FPGA 5GNR FEC device, ``CONFIG_RTE_LIBRTE_PMD_BBDEV_FPGA_5GNR_FEC``, -is already set. +Section 3 of the DPDK manual provides instructions on installing and compiling DPDK. DPDK requires hugepages to be configured as detailed in section 2 of the DPDK manual. The bbdev test application has been tested with a configuration 40 x 1GB hugepages. The @@ -94,7 +91,7 @@ the UIO driver by repeating this command for every function. .. code-block:: console cd - insmod ./build/kmod/igb_uio.ko + insmod .//kernel/linux/igb_uio/igb_uio.ko echo "8086 0d8f" > /sys/bus/pci/drivers/igb_uio/new_id lspci -vd8086:0d8f diff --git a/doc/guides/bbdevs/fpga_lte_fec.rst b/doc/guides/bbdevs/fpga_lte_fec.rst index fdc8a76981..14ffa0ee14 100644 --- a/doc/guides/bbdevs/fpga_lte_fec.rst +++ b/doc/guides/bbdevs/fpga_lte_fec.rst @@ -50,10 +50,7 @@ FPGA LTE FEC does not support the following: Installation -------------- -Section 3 of the DPDK manual provides instructions on installing and compiling DPDK. The -default set of bbdev compile flags may be found in config/common_base, where for example -the flag to build the FPGA LTE FEC device, ``CONFIG_RTE_LIBRTE_PMD_BBDEV_FPGA_LTE_FEC``, is already -set. +Section 3 of the DPDK manual provides instructions on installing and compiling DPDK. DPDK requires hugepages to be configured as detailed in section 2 of the DPDK manual. The bbdev test application has been tested with a configuration 40 x 1GB hugepages. The @@ -93,7 +90,7 @@ the UIO driver by repeating this command for every function. .. code-block:: console cd - insmod ./build/kmod/igb_uio.ko + insmod .//kernel/linux/igb_uio/igb_uio.ko echo "1172 5052" > /sys/bus/pci/drivers/igb_uio/new_id lspci -vd1172: diff --git a/doc/guides/bbdevs/turbo_sw.rst b/doc/guides/bbdevs/turbo_sw.rst index 20620c2e20..43c5129fd7 100644 --- a/doc/guides/bbdevs/turbo_sw.rst +++ b/doc/guides/bbdevs/turbo_sw.rst @@ -12,14 +12,6 @@ Note that the driver can also be built without any dependency with reduced functionality for maintenance purpose. To enable linking to the SDK libraries see detailed installation section below. -Two flags can be enabled depending on whether the target machine can support -AVX2 and AVX512 instructions sets and the related SDK libraries for vectorized -signal processing functions are installed : -- CONFIG_RTE_BBDEV_SDK_AVX2 -- CONFIG_RTE_BBDEV_SDK_AVX512 -By default these 2 flags are disabled by default. For AVX2 machine and SDK -library installed then the first flag can be enabled. For AVX512 machine and -SDK library installed then both flags can be enabled for full real time capability. This PMD supports the functions: FEC, Rate Matching and CRC functions detailed in the Features section. @@ -144,20 +136,21 @@ In order to enable this virtual bbdev PMD, the user may: FlexRAN SDK libraries were installed. And ``DIR_WIRELESS_SDK`` to the path where the libraries were extracted. +* Tune the meson build option pointing the location of the FlexRAN SDK libraries ``flexran_sdk`` + Example: .. code-block:: console export FLEXRAN_SDK=/FlexRAN-FEC-SDK-19-04/sdk/build-avx2-icc/install export DIR_WIRELESS_SDK=/FlexRAN-FEC-SDK-19-04/sdk/build-avx2-icc/ + cd build + meson configure -Dflexran_sdk=/FlexRAN-FEC-SDK-19-04/sdk/build-avx512-icc/install + +* For AVX512 machines with SDK libraries installed then both 4G and 5G can be enabled for full real time FEC capability. + For AVX2 machines it is possible to only enable the 4G libraries and the PMD capabilities will be limited to 4G FEC. + If no library is present then the PMD driver will still build but its capabilities will be limited accordingly. -* Set ``CONFIG_RTE_BBDEV_SDK_AVX2=y`` and ``CONFIG_RTE_BBDEV_SDK_AVX512=y`` - in DPDK common configuration file ``config/common_base`` to be able to use - the SDK libraries as mentioned above. - For AVX2 machine it is possible to only enable CONFIG_RTE_BBDEV_SDK_AVX2 - for limited 4G functionality. - If no flag are set the PMD driver will still build but its capabilities - will be limited accordingly. To use the PMD in an application, user must: