DPDK patches and discussions
 help / color / mirror / Atom feed
From: Nicolas Chautru <nicolas.chautru@intel.com>
To: dev@dpdk.org, maxime.coquelin@redhat.com
Cc: hemant.agrawal@nxp.com, david.marchand@redhat.com,
	hernan.vargas@intel.com
Subject: [PATCH v3 2/2] doc: update FlexRAN SDK links
Date: Fri, 27 Oct 2023 22:03:43 +0000	[thread overview]
Message-ID: <20231027220343.499706-3-nicolas.chautru@intel.com> (raw)
In-Reply-To: <20231027220343.499706-1-nicolas.chautru@intel.com>

From: Hernan Vargas <hernan.vargas@intel.com>

Update FlexRAN SDK module link to use FEC_SDK_23.07.
Update compiler links to use ICX.
Update build SDK build instructions.

Signed-off-by: Hernan Vargas <hernan.vargas@intel.com>
---
 doc/guides/bbdevs/turbo_sw.rst | 53 +++++++++++++++++++---------------
 1 file changed, 30 insertions(+), 23 deletions(-)

diff --git a/doc/guides/bbdevs/turbo_sw.rst b/doc/guides/bbdevs/turbo_sw.rst
index 1056e7a47a..9445cf1327 100644
--- a/doc/guides/bbdevs/turbo_sw.rst
+++ b/doc/guides/bbdevs/turbo_sw.rst
@@ -67,11 +67,13 @@ FlexRAN SDK Download
 As an option it is possible to link this driver with FleXRAN SDK libraries
 which can enable real time signal processing using AVX instructions.
 
-These libraries are available through this `link <https://software.intel.com/en-us/articles/flexran-lte-and-5g-nr-fec-software-development-kit-modules>`_.
+These libraries are available through this `link <https://github.com/intel/FlexRAN-FEC-SDK-Modules/tree/Branch_FEC_SDK_23.07>`_.
 
 After download is complete, the user needs to unpack and compile on their
 system before building DPDK.
 
+To get the FlexRAN FEC SDK User manual extract this `doxygen <https://github.com/intel/FlexRAN-FEC-SDK-Modules/blob/Branch_FEC_SDK_23.07/doc/doxygen/html.zip>`_.
+
 The following table maps DPDK versions with past FlexRAN SDK releases:
 
 .. _table_flexran_releases:
@@ -83,6 +85,7 @@ The following table maps DPDK versions with past FlexRAN SDK releases:
    =====================  ============================
    19.08 to 22.07         19.04
    22.11+                 22.11
+   23.11+                 FEC_SDK_23.07
    =====================  ============================
 
 FlexRAN SDK Installation
@@ -91,31 +94,34 @@ FlexRAN SDK Installation
 Note that the installation of these libraries is optional.
 
 The following are pre-requisites for building FlexRAN SDK Libraries:
- (a) An AVX2 or AVX512 supporting machine
- (b) CentOS Linux release 7.2.1511 (Core) operating system is advised
- (c) Intel ICC 18.0.1 20171018 compiler or more recent and related libraries
-     ICC is `available with a free community license <https://software.intel.com/en-us/system-studio/choose-download#technical>`_.
+ (a) An AVX512 supporting machine.
+ (b) Ubuntu Linux release 22.04 operating system is advised.
+ (c) Intel ICX 2023.0.0 compiler or more recent and related libraries.
+     ICX is available `here <https://docs.o-ran-sc.org/projects/o-ran-sc-o-du-phy/en/latest/build_prerequisite.html#download-and-install-oneapi>`_.
+ (d) `FlexRAN SDK Modules <https://github.com/intel/FlexRAN-FEC-SDK-Modules/tree/Branch_FEC_SDK_23.07>`_.
+ (e) CMake 3.9.2 (Minimum 2.8.12)
+ (f) Google Test 1.7.0 (Required to run the verification and compute performance tests)
+ (g) Math Kernel Library 18.0 (Required by some functions in SDK)
 
 The following instructions should be followed in this exact order:
 
-#. Set the environment variables:
+#. Clone the SDK (Folder name needs to end in 'sdk')
 
     .. code-block:: console
 
-        source <path-to-icc-compiler-install-folder>/linux/bin/compilervars.sh intel64 -platform linux
+        git clone -b Branch_FEC_SDK_23.07 https://github.com/intel/FlexRAN-FEC-SDK-Modules.git flexran_sdk
 
-#. Run the SDK extractor script and accept the license:
+#. Set the environment variables:
 
     .. code-block:: console
 
-        cd <path-to-workspace>
-        ./FlexRAN-FEC-SDK-19-04.sh
+        source <path-to-workspace>/export_settings.sh -o -avx512
 
 #. Generate makefiles based on system configuration:
 
     .. code-block:: console
 
-        cd <path-to-workspace>/FlexRAN-FEC-SDK-19-04/sdk/
+        cd <path-to-workspace>
         ./create-makefiles-linux.sh
 
 #. A build folder is generated in this form ``build-<ISA>-<CC>``, enter that
@@ -123,11 +129,11 @@ The following instructions should be followed in this exact order:
 
     .. code-block:: console
 
-        cd build-avx512-icc/
-        make && make install
+        cd <path-to-workspace>/build-${WIRELESS_SDK_TARGET_ISA}-${WIRELESS_SDK_TOOLCHAIN}/
+        make -j$(nproc) && make install
 
-Initialization
---------------
+DPDK Initialization
+~~~~~~~~~~~~~~~~~~~
 
 In order to enable this virtual bbdev PMD, the user may:
 
@@ -142,18 +148,20 @@ In order to enable this virtual bbdev PMD, the user may:
 
 Example:
 
-.. code-block:: console
+    .. code-block:: console
 
-    export FLEXRAN_SDK=<path-to-workspace>/FlexRAN-FEC-SDK-19-04/sdk/build-avx2-icc/install
-    export DIR_WIRELESS_SDK=<path-to-workspace>/FlexRAN-FEC-SDK-19-04/sdk/build-avx2-icc/
-    export PKG_CONFIG_PATH=$DIR_WIRELESS_SDK/pkgcfg:$PKG_CONFIG_PATH
-    cd build
-    meson configure
+        export FLEXRAN_SDK=<path-to-workspace>/build-${WIRELESS_SDK_TARGET_ISA}-${WIRELESS_SDK_TOOLCHAIN}/install
+        export DIR_WIRELESS_SDK=<path-to-workspace>/build-${WIRELESS_SDK_TARGET_ISA}-${WIRELESS_SDK_TOOLCHAIN}
+        export PKG_CONFIG_PATH=${DIR_WIRELESS_SDK}/pkgcfg:${PKG_CONFIG_PATH}
+        cd build
+        meson configure
 
 * 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 will still build but its capabilities will be limited accordingly.
 
+SW Turbo PMD Usage
+~~~~~~~~~~~~~~~~~~
 
 To use the PMD in an application, user must:
 
@@ -169,9 +177,8 @@ The following parameters (all optional) can be provided in the previous two call
 * ``max_nb_queues``: Specify the maximum number of queues in the device (default is ``RTE_MAX_LCORE``).
 
 Example:
-~~~~~~~~
 
-.. code-block:: console
+  .. code-block:: console
 
     ./test-bbdev.py -e="--vdev=baseband_turbo_sw,socket_id=0,max_nb_queues=8" \
     -c validation -v ./turbo_*_default.data
-- 
2.34.1


  parent reply	other threads:[~2023-10-27 22:10 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-10-27 22:03 [PATCH v3 0/2] FlexRAN SDK update for 23.11 Nicolas Chautru
2023-10-27 22:03 ` [PATCH v3 1/2] baseband/acc: support ACC100 deRM corner case SDK Nicolas Chautru
2023-11-09 10:51   ` Maxime Coquelin
2023-10-27 22:03 ` Nicolas Chautru [this message]
2023-11-09 10:20   ` [PATCH v3 2/2] doc: update FlexRAN SDK links Maxime Coquelin
2023-11-09 15:50 ` [PATCH v3 0/2] FlexRAN SDK update for 23.11 Maxime Coquelin

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20231027220343.499706-3-nicolas.chautru@intel.com \
    --to=nicolas.chautru@intel.com \
    --cc=david.marchand@redhat.com \
    --cc=dev@dpdk.org \
    --cc=hemant.agrawal@nxp.com \
    --cc=hernan.vargas@intel.com \
    --cc=maxime.coquelin@redhat.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).