docs/wls-lib-installation-guide.rst

   1 ..    Copyright (c) 2019-2022 Intel
   2 ..
   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
   6 ..
   7 ..      http://www.apache.org/licenses/LICENSE-2.0
   8 ..
   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.
  14
  15 .. |br| raw:: html
  16
  17    <br />
  18
  19 Wls Lib Installation Guide
  20 ==========================
  21
  22 The wls library uses DPDK as the basis for the shared memory operations and requires that DPDK
  23 be installed in the system since in the makefile it uses the RTE_SDK environment variable when
  24 building the library. |br|
  25 The current release was tested using DPDK version 20.11.1 but it doesn't preclude the
  26 use of newer releases. Since the L1 binaries are built with DPDK 20.11.1 the ODULOW as a whole
  27 does has the limitation to use only this version of DPDK.
  28 Also the library uses the Intel Compiler that is defined as part of the ODULOW documentation.
  29
  30 Contents
  31 --------
  32
  33 - Overview
  34 - Building and Installation
  35 - Command Line Parameters
  36 - Known Issues/Troubleshooting
  37 - License
  38
  39
  40 ================================================================================
  41
  42 Overview
  43 --------
  44
  45 This document describes the wls DPDK base library for ODULOW to ODUHIGH
  46 communication as part of the |br|
  47 ORAN Reference Architecture where an intermediate
  48 shin layer can be present between these components.
  49
  50
  51 ================================================================================
  52
  53
  54 Building and Installation
  55 -------------------------
  56
  57 Retrieve the source files from the Linux Foundation Gerrit server:
  58     `<https://gerrit.o-ran-sc.org/r/gitweb?p=o-du%2Fphy.git;a=summary>`_
  59
  60 1. cd wls_lib
  61 2. wls_lib$ ./build.sh xclean
  62 3. wls_lib$ ./build.sh
  63
  64 The shared library is available at wls_lib/lib
  65
  66 This library is used by the ODUHIGH, shin layer implementing a 5G FAPI to IAPI translator and the
  67 ODULOW components.
  68
  69 Please define an environment variable DIR_WIRELESS_WLS with the path to the root folder of
  70 the wls_lib as it is needed for the fapi_5g build process.
  71
  72 Unit Test building and validation
  73 ---------------------------------
  74
  75 In order to build the unit test do the following steps:
  76
  77 1. cd test
  78 2. ./build.sh xclean
  79 3. ./build.sh
  80 4. Create an SSH session into the target an change directory to wls_lib/bin/phy
  81 5. issue ./phy.sh
  82 6. Create a second SSH session into the target and change directory to wls_lib/bin/fapi
  83 7. issue ./fapi.sh
  84 8. Create a third SSH session into the target and change directory to wls_lib/bin/mac
  85 9. issue ./mac.sh
  86
  87 After the test run you should see that each module sent and receive 16 messages from
  88 the display status messages.
  89
  90 ================================================================================
  91
  92
  93
  94 Known Issues/Troubleshooting
  95 ----------------------------
  96 No known issues.
  97 For troubleshooting use unit test application.
  98
  99 ================================================================================
 100
 101 License
 102 -------
 103
 104 Please see License.txt at the root of the phy repository for license information details
 105
 106