1 .. Copyright (c) 2019 Intel
3 .. Licensed under the Apache License, Version 2.0 (the "License");
4 .. you may not use this file except in compliance with the License.
5 .. You may obtain a copy of the License at
7 .. http://www.apache.org/licenses/LICENSE-2.0
9 .. Unless required by applicable law or agreed to in writing, software
10 .. distributed under the License is distributed on an "AS IS" BASIS,
11 .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 .. See the License for the specific language governing permissions and
13 .. limitations under the License.
26 This section describes how to install and build the required components needed to build the FHI Library, WLS Library and the 5G FAPI TM modules.
30 IntelĀ® C++ Compiler v19.0.3 is used for the test application and system integration with L1,
31 The IntelĀ® C++ Compiler can be obtained using the follwoing link https://software.intel.com/en-us/system-studio/choose-download with community |br|
34 COPY $icc_license_file $BUILD_DIR/license.lic
36 *Note: The version available at this link is always the latest ICC version, the verification for that version may not have been
37 performed yet, so please provide feedback through O-DU Low project WIKI page if you face any issues.*
40 Download Intel System Studio from Intel website and install ICC ::
42 #wget https://registrationcenter-download.intel.com/akdlm/irc_nas/16242/system_studio_2020_ultimate_edition_offline.tar.gz
43 #cd /opt && mkdir intel && cp $BUILD_DIR/license.lic intel/license.lic
44 #tar -zxvf $BUILD_DIR/system_studio_2020_ultimate_edition_offline.tar.gz
46 Edit system_studio_2020_ultimate_edition_offline/silent.cfg to accept the EULA file as below example::
49 PSET_INSTALL_DIR=opt/intel
50 ACTIVATION_LICENSE_FILE=/opt/intel/license.lic
51 ACTIVATION_TYPE=license_file
55 #./install.sh -s silent.cfg
59 #source /opt/intel/system_studio_2020/bin/iccvars.sh intel64
60 #export PATH=/opt/intel/system_studio_2020/bin/:$PATH
65 - download FEC SDK lib::
67 #wget https://software.intel.com/sites/default/files/managed/23/b8/FlexRAN-FEC-SDK-19-04.tar.gz
68 #tar -xzvf FlexRAN-FEC-SDK-19-04.tar.gz
72 #./FlexRAN-FEC-SDK-19-04.sh
73 #cd FlexRAN-FEC-SDK-19-04/sdk
74 #./create-makefiles-linux.sh
78 *note: you need to accept the Intel OBL commercial use license during the installation*
82 #wget http://fast.dpdk.org/rel/dpdk-18.08.tar.xz
83 #tar -xf dpdk-18.08.tar.xz
84 #export RTE_TARGET=x86_64-native-linuxapp-icc
85 #export RTE_SDK=Intallation_DIR/dpdk-18.08
88 - patch DPDK for O-RAN FHI lib, this patch is specific for O-RAN FHI to reduce the data transmission latency of Intel NIC. This may not be needed for some NICs, please refer to O-RAN FHI Lib Introduction -> setup configuration -> A.2 prerequisites
91 - change DPDK config to enable SW FEC support
93 check the configuration as below in dpdk-18.08/config/common_base::
95 CONFIG_RTE_LIBRTE_BBDEV=y
96 CONFIG_RTE_LIBRTE_BBDEV_DEBUG=n
97 CONFIG_RTE_BBDEV_MAX_DEVS=128
98 CONFIG_RTE_BBDEV_OFFLOAD_COST=y
99 CONFIG_RTE_BBDEV_SDK_AVX2=y
100 CONFIG_RTE_BBDEV_SDK_AVX512=y
102 - enable FEC accelerator card, DPDK BBDev framework support any kind of accelerator card to plug in the associated driver while using the same interface. Right now there is no open source driver available yet, so you need to get the associated vendor's driver to enable the capability to use an accelerator card.
104 - enable IGB UIO for FEC card and NIC configure::
106 CONFIG_RTE_EAL_IGB_UIO=y
107 CONFIG_RTE_KNI_KMOD=y
110 setup Env for BBDev SW::
112 #export FLEXRAN_SDK=$Intallation_DIR/FlexRAN-FEC-SDK-19-04/sdk/build-avx512-icc/install
116 #./usertools/dpdk-setup.sh
117 select [16] x86_64-native-linuxapp-icc
118 select [19] Insert VFIO module
119 exit [35] Exit Script
121 this path should be always there during you build and run lib/app::
123 #export RTE_SDK="your DPDK path"
128 Download google test from https://github.com/google/googletest/releases
129 - Example build and installation commands::
131 #tar -xvf googletest-release-1.7.0.tar.gz
132 #mv googletest-release-1.7.0 gtest-1.7.0
133 #export GTEST_DIR=YOUR_DIR/gtest-1.7.0
135 #g++ -isystem ${GTEST_DIR}/include -I${GTEST_DIR} -pthread -c ${GTEST_DIR}/src/gtest-all.cc
136 #ar -rv libgtest.a gtest-all.o
137 #cd ${GTEST_DIR}/build-aux
141 #ln -s build-aux/libgtest_main.a libgtest_main.a
143 - Set the google test Path
144 this path should be always here when you build and run O-RAN FH lib unit test::
146 #export DIR_ROOT_GTEST="your google test path"
151 For the Bronze Release only as SW FEC is available so this step is not needed, for later releases the required information will be added to the document.