docs/wls-lib-installation-guide.rst

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