{"type":"doc","content":[{"type":"heading","attrs":{"level":2},"content":[{"text":"1. Introduction","type":"text"}]},{"type":"paragraph","content":[{"type":"emoji","attrs":{"id":"atlassian-info","text":":info:","shortName":":info:"}},{"text":" Detail the approach of steps for xFAPI, OSC-DU & FlexRAN deployment","type":"text"}]},{"type":"paragraph","content":[{"text":"1.1) Description: ","type":"text"},{"type":"hardBreak"},{"text":" xFAPI is an intermediate component that bridges the L1 and L2 layers within the O-RAN architecture. It functions as a translator for both FAPI and nFAPI interfaces, ensuring seamless communication between these interfaces.","type":"text"}]},{"type":"paragraph","content":[{"text":"It comprises of two major components:","type":"text"},{"type":"hardBreak"},{"text":"API Translator translates the vendor-specific APIs used by L1 and L2 vendors whereas IPC Integrator provides interoperability between L1 and L2 components by overcoming IPC compatibility challenges.","type":"text"}]},{"type":"paragraph","content":[{"text":"In addition to its core functions, xFAPI provides advanced features such as detailed PDU statistics generation at both interfaces, robust debugging tools like a memory logger, state manager, multi-level logging, and a comprehensive dashboard for monitoring and analysis.","type":"text"}]},{"type":"paragraph","content":[{"text":"xSM: The \"x\" in xSM signifies \"any,\" while \"SM\" stands for \"Shared Memory.\" xSM is an advanced shared memory library designed to standardize IPC through shared memory. It simplifies communication between L1 and L2 components, which often rely on different shared memory libraries.","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"1.2) System topology","type":"text"}]},{"type":"paragraph"},{"type":"mediaSingle","attrs":{"layout":"center","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":9550,"alt":"image-20241118-074707.png","id":"91a9ecde-3502-43f1-b8c5-a1f86ed677b4","collection":"contentId-176226489","type":"file","height":2497}},{"type":"caption","content":[{"text":"Topology : [OSC DU-High – xFAPI – FlexRAN]","type":"text"}]}]},{"type":"paragraph"},{"type":"mediaSingle","attrs":{"layout":"center","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1348,"alt":"xFAPI.png","id":"49bf9bc8-c086-458c-9afc-035d2470fc47","collection":"contentId-176226489","type":"file","height":676}},{"type":"caption","content":[{"text":"xFAPI Reference Architecture ","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"2. Minimum Requirements","type":"text"}]},{"type":"paragraph","content":[{"type":"emoji","attrs":{"id":"atlassian-info","text":":info:","shortName":":info:"}},{"text":" Detail the hardware and software requirements necessary for the installation","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Cores: 3rd gen N series Intel Cpu","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Accelerator : ACC100","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"RAM : 128 GB memory","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Storage: 500 GB","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Operating System: Ubuntu 22.04 with Real-time kernel","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Recommended","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Cores: 4th Gen N series Intel Cpu with Vran boost","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"RAM: 256Gi Memory","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"3. Installation","type":"text"}]},{"type":"paragraph","content":[{"type":"emoji","attrs":{"id":"atlassian-info","text":":info:","shortName":":info:"}},{"text":" Step-by-step instructions for deployment","type":"text"}]},{"type":"paragraph","content":[{"text":"3.1) ","type":"text"},{"text":"Environment Setup","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Step up the env. variables for FlexRAN :","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"cd phy/\nsource setupenv.sh","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Load Env. variables for xFAPI :","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"cd \nsource loadenvvar.sh","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Configure IPs for OSC-DU High and cu_stub :","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"ifconfig lo:ODU \"192.168.130.81\"\nifconfig lo:CU_STUB \"192.168.130.82\"","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"3.2) ","type":"text"},{"text":"Prerequisites","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","marks":[{"type":"indentation","attrs":{"level":1}}],"content":[{"text":"Before proceeding, ensure the following dependencies are installed on your system:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"GCC","type":"text"}]}]}]},{"type":"paragraph","marks":[{"type":"indentation","attrs":{"level":1}}],"content":[{"text":"Make sure you have GCC version 9.5 installed :","type":"text"}]},{"type":"codeBlock","content":[{"text":"sudo apt-get install -y build-essential\ngcc --version","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"LKSCTP","type":"text"}]}]}]},{"type":"paragraph","marks":[{"type":"indentation","attrs":{"level":1}}],"content":[{"text":"Install the LKSCTP library:","type":"text"}]},{"type":"codeBlock","content":[{"text":"sudo apt-get install -y libsctp-dev","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"PCAP:","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"sudo apt-get install -y libpcap-dev","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ICX :","type":"text"}]}]}]},{"type":"paragraph","marks":[{"type":"indentation","attrs":{"level":1}}],"content":[{"text":"icx (ICX) 2023.0.0 (2023.0.0.20221201)","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Intel oneAPI :","type":"text"}]}]}]},{"type":"paragraph","marks":[{"type":"indentation","attrs":{"level":1}}],"content":[{"text":"Intel oneAPI version: l_BaseKit_p_2023.0.0.25537_offline.sh, (2023.0.0)","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"DPDK :","type":"text"}]}]}]},{"type":"paragraph","marks":[{"type":"indentation","attrs":{"level":1}}],"content":[{"text":"DPDK Configuration: Intel DPDK version 22.11.1","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Cmake :","type":"text"}]}]}]},{"type":"paragraph","marks":[{"type":"indentation","attrs":{"level":1}}],"content":[{"text":"Recommended version of Cmake: cmake version 3.9.2","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":" 3.3) ","type":"text"},{"text":"FlexRAN","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Clone the project repo: ","type":"text"}]},{"type":"codeBlock","content":[{"text":"git clone https://github.com/intel/FlexRAN ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add the env setting script to .bashrc :","type":"text"}]},{"type":"codeBlock","content":[{"text":"vim ~/.bashrc\nadd source /opt/intel/oneapi/setvars.sh to the script","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"3.4) ","type":"text"},{"text":"xSM Library","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Locate the Zip Folder:","type":"text"}]},{"type":"codeBlock","content":[{"text":"mv /path/to/xSM_lib.zip /desired/deployment/path/","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Unzip the project :","type":"text"}]},{"type":"codeBlock","content":[{"text":"cd /desired/deployment/path/\nunzip xSM_lib.zip","type":"text"}]}]}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"3.5) ","type":"text"},{"text":"OSC Du-High","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"First, create a directory where you will clone the O-DU High code. This folder will be referred to as ","type":"text"},{"text":".","type":"text","marks":[{"type":"em"}]}]},{"type":"codeBlock","content":[{"text":"mkdir \ncd ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Clone the project repo:","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"git clone https://github.com/o-ran-sc/o-du-l2.git \ncd o-du-l2\ngit checkout i-release","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Modify the Makefile :","type":"text"}]}]}]},{"type":"paragraph","marks":[{"type":"indentation","attrs":{"level":1}}],"content":[{"text":"Go to the /build/odu directory and make the following changes in the Makefile:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Copy the wls_lib folder from the O-DU PHY repository:","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"git clone https://github.com/o-ran-sc/o-du-phy.git ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"After cloning, copy the wls_lib folder into the O-DU L2 source directory (/o-du-l2/src/):","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"cp -r o-du-phy/wls_lib/ /o-du-l2/src/","type":"text"}]},{"type":"paragraph","marks":[{"type":"indentation","attrs":{"level":1}}]},{"type":"paragraph","marks":[{"type":"indentation","attrs":{"level":1}}],"content":[{"text":"Compilation","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Build O-DU High in the o-du-l2/build/odu Directory:","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"make clean_odu PHY=INTEL_L1 MACHINE=BIT64 MODE=TDD\nmake odu PHY=INTEL_L1 MACHINE=BIT64 MODE=TDD","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Build cu_stub :","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"make clean_cu NODE=TEST_STUB MACHINE=BIT64 MODE=TDD\nmake cu_stub NODE=TEST_STUB MACHINE=BIT64 MODE=TDD","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Copy the libxsm.so from /src/xSM_lib :","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"cp ../../src/xSM_lib/libxsm.so ../../bin/odu","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Navigate to the Binary Directory:","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"cd ../../bin","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"3.6) ","type":"text"},{"text":"xFAPI","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Locate the Zip Folder:","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"mv /path/to/xfapi.zip /desired/deployment/path/","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Unzip the project :","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"cd /desired/deployment/path/ unzip xfapi.zip","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"},{"text":"3.7) ","type":"text"},{"text":"By this point, we should have the required binaries at these places","type":"text","marks":[{"type":"strong"}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Flexran binary [l1app] at:","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"FlexRAN/l1/bin/nr5g/gnb/l1","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"xFAPI binary [xfapi_app] at :","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"/bin/xfapi_app","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":" xSM_lib .so file [","type":"text"},{"text":"libxsm.so","type":"text","marks":[{"type":"link","attrs":{"href":"http://libxsm.so"}}]},{"text":"] at :","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"/bin/libxsm.so\n/bin/odu/libxsm.so","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ODU binary [odu] at :","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"/bin/odu/cu_stub","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"cu_stub binary [cu_stub] at :","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"/bin/odu/odu","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"3.8) ","type":"text"},{"text":"Executing Stack","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"The sequence of execution of binaries is:","type":"text","marks":[{"type":"strong"}]}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"FlexRAN","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"xFAPI","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"cu_stub","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"OSC DU-High","type":"text"}]}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Executing FlexRAN :","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"codeBlock","content":[{"text":"cd FlexRAN/l1/bin/nr5g/gnb/l1\n./l1.sh -xran [for radio]\n./l1.sh -e [for timer mode]","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Executing xFAPI :","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"codeBlock","content":[{"text":"cd /bin\n./run_xfapi.sh","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Executing cu_stub :","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"codeBlock","content":[{"text":"cd /bin/odu/odu\n./cu_stub","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Executing DU-High :","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"codeBlock","content":[{"text":"cd /bin/odu/odu\n./odu","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"4. Post-Installation Verification","type":"text"}]},{"type":"paragraph","content":[{"type":"emoji","attrs":{"id":"atlassian-info","text":":info:","shortName":":info:"}},{"text":" Outline how to verify that the installation was successful.","type":"text"},{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"Expected Result: ","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"5. Demonstration","type":"text"}]},{"type":"paragraph","content":[{"text":"Here is a demo of the deployment of xFAPI, following this guide :","type":"text"}]},{"type":"paragraph","content":[{"text":"Demo Video","type":"text","marks":[{"type":"link","attrs":{"href":"https://youtu.be/sXFv2xor5pg?si=JoBynp_ypC-xHIOT"}}]},{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"6. Troubleshooting","type":"text"}]},{"type":"paragraph","content":[{"type":"emoji","attrs":{"id":"atlassian-info","text":":info:","shortName":":info:"}},{"text":" Provide common issues and their solutions.","type":"text"}]},{"type":"paragraph","content":[{"text":"Issue 1: Error in loading shared libraries while executing the FlexRAN","type":"text"}]},{"type":"codeBlock","content":[{"text":"./l1.shxran\nRadio mode with XRAN Sub6 100Mhz\n./l1.sh: line 33: ./dpdk.sh: No such file or directory\nkernel.sched_rt_runtime_us = -1\nkernel.shmmax = 2147483648\nkernel.shmall = 2147483648\nusing configuration file phycfg_xran.xml\nusing configuration file xrancfg_sub6.xml","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"},{"text":"Solution: ","type":"text"}]},{"type":"codeBlock","content":[{"text":"cd phy/\nsource setupenv.sh","type":"text"}]},{"type":"paragraph"},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Issue 2: Parsing error in FlexRAN","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"FlexRAN SDK bblib_lte_rate_dematching_5gnr version #DIRTY# Cannot open file\nFlexRAN SDK bblib_lte_turbo version #DIRTY#\nFlexRAN SDK bblib_lte_rate_matching version #DIRTY#\nFlexRAN SDK bblib_srs_fft_cestimate_5gnr version #DIRTY#\nFlexRAN SDK bblib_mldts_process_5gnr version #DIRTY#\nExitting the application because of xml parsing issues\nCleanup after [PID] 1233284","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"},{"text":"Solution: ","type":"text"}]},{"type":"codeBlock","content":[{"text":"Update the in phycfg_xran.cfg file, located at :\nFlexRAN/l1/bin/nr5g/gnb/l1/phycfg_xran.xml\n\n# Original File\n\noran_k_release_v1.0\n\n SCTP: Initializing\ndate: 10/08/2024 time: 07:55:32\nmtss(posix): sw error: ent: 255 inst: 255 proc id: 000\nfile: /home/four/du_with_cuStub/src/cm/cm_inet.c line: 1743 errcode: 00007 errcls: ERRCLS_DEBUG errval: 00000 errdesc: cmInetSctpBindx() Failed: error (99), port (38472), sockFd->fd(5)","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"},{"text":"Solution: ","type":"text"}]},{"type":"codeBlock","content":[{"text":"Configure the virtual IP addresses\nifconfig lo:ODU \"192.168.130.81\"\nifconfig lo:CU_STUB \"192.168.130.82\"","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"NOTE:","type":"text","marks":[{"type":"strong"}]},{"text":" Log files can be generated in xFAPI for detailed analysis. Both horizontal and vertical logging levels can be configured in the xfapi_cfg.cfg file.","type":"text"}]},{"type":"codeBlock","content":[{"text":"Log file configuraitons\n[log_file]\nGenerate_Logs_File=true\n#verical level logs generation in log file\nVertical_Level_File=LOG_DEBUG\n#xfapi log generation in log file\nXfapi_Log_File=true\n#XSM log generation in log file\nxSM_Log_File=true\n#P5 log generation in log file\nP5_Log_File=true\n#P7 log generation in log file\nP7_Log_File=true\n#Date and time log generation in log file\nPrint_Datetime_File= true","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"7. Additional Resources","type":"text"}]},{"type":"paragraph","content":[{"type":"emoji","attrs":{"id":"atlassian-info","text":":info:","shortName":":info:"}},{"text":" List of additional documentation, links, or resources that may be helpful.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Documentation: (Link to official documentation or user manuals.)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Support: (Contact information for support or a link to a support forum.)","type":"text"}]}]}]}],"version":1}

Browser not supported