<JIRA ID: ODUHIGH-393 : e-release Documentation> 50/7250/9
authorbarveankit <anbarve@radisys.com>
Wed, 15 Dec 2021 08:21:16 +0000 (13:51 +0530)
committerbarveankit <anbarve@radisys.com>
Wed, 15 Dec 2021 09:35:56 +0000 (15:05 +0530)
Change-Id: I4b894c652ef3a3584670a9f26de87c2b2b3bd8f2
Signed-off-by: barveankit <anbarve@radisys.com>
13 files changed:
build/config/cellConfig.xml [new file with mode: 0644]
build/config/rrmPolicy.xml [new file with mode: 0644]
docs/CLA_call_flow.png
docs/CellUpAndBroadcast.png
docs/Network_Slicing.png [new file with mode: 0644]
docs/README
docs/UeAttach.png
docs/api-docs.rst
docs/installation-guide.rst
docs/overview.rst
docs/release-notes.rst
docs/user-guide.rst
src/o1/ves/PerfMeasurementEvent.cpp

diff --git a/build/config/cellConfig.xml b/build/config/cellConfig.xml
new file mode 100644 (file)
index 0000000..f3d0285
--- /dev/null
@@ -0,0 +1,76 @@
+<?xml version="1.0" encoding="UTF-8"?>\r
+<ManagedElement xmlns="urn:3gpp:sa5:_3gpp-common-managed-element">\r
+  <id>me-1</id>\r
+  <attributes>\r
+    <priorityLabel>1</priorityLabel>\r
+  </attributes>\r
+  <GNBDUFunction xmlns="urn:3gpp:sa5:_3gpp-nr-nrm-gnbdufunction">\r
+    <id>gnb-1</id>\r
+    <attributes>\r
+      <gNBId>1</gNBId>\r
+      <gNBIdLength>23</gNBIdLength>\r
+      <gNBDUId>3</gNBDUId>\r
+      <priorityLabel>1</priorityLabel>\r
+      <resourceType>PRB_DL</resourceType>\r
+      <rRMPolicyMemberList>\r
+       <mcc>901</mcc>\r
+       <mnc>44</mnc>\r
+       <sd>000001</sd>\r
+       <sst>1</sst>\r
+      </rRMPolicyMemberList>\r
+      <rRMPolicyMemberList>\r
+       <mcc>901</mcc>\r
+       <mnc>44</mnc>\r
+       <sd>000002</sd>\r
+       <sst>1</sst>\r
+      </rRMPolicyMemberList>\r
+    </attributes>\r
+    <NRCellDU xmlns="urn:3gpp:sa5:_3gpp-nr-nrm-nrcelldu">\r
+      <id>nrcell-1</id>\r
+      <attributes>\r
+       <priorityLabel>1</priorityLabel>\r
+       <resourceType>PRB_DL</resourceType>\r
+       <rRMPolicyMemberList>\r
+         <mcc>901</mcc>\r
+         <mnc>44</mnc>\r
+         <sd>000001</sd>\r
+         <sst>1</sst>\r
+       </rRMPolicyMemberList>\r
+       <rRMPolicyMemberList>\r
+         <mcc>901</mcc>\r
+         <mnc>44</mnc>\r
+         <sd>000002</sd>\r
+         <sst>1</sst>\r
+       </rRMPolicyMemberList>\r
+       <cellLocalId>1</cellLocalId>\r
+       <pLMNInfoList>\r
+         <mcc>901</mcc>\r
+         <mnc>44</mnc>\r
+         <sd>000001</sd>\r
+         <sst>1</sst>\r
+       </pLMNInfoList>\r
+       <pLMNInfoList>\r
+         <mcc>901</mcc>\r
+         <mnc>44</mnc>\r
+         <sd>000002</sd>\r
+         <sst>1</sst>\r
+       </pLMNInfoList>\r
+       <nRPCI>1</nRPCI>\r
+       <ssbFrequency>1</ssbFrequency>\r
+       <ssbPeriodicity>5</ssbPeriodicity>\r
+       <ssbSubCarrierSpacing>15</ssbSubCarrierSpacing>\r
+       <ssbOffset>0</ssbOffset>\r
+       <ssbDuration>1</ssbDuration>\r
+       <nRSectorCarrierRef>CN=John Smith,OU=Sales,O=ACME Limited,L=Moab,ST=Utah,C=US</nRSectorCarrierRef>\r
+       <administrativeState>UNLOCKED</administrativeState>\r
+       <nRTAC>1</nRTAC>\r
+       <arfcnDL>428000</arfcnDL>\r
+       <arfcnUL>390000</arfcnUL>\r
+       <arfcnSUL>200</arfcnSUL>\r
+       <bSChannelBwDL>20</bSChannelBwDL>\r
+       <bSChannelBwUL>20</bSChannelBwUL>\r
+       <bSChannelBwSUL>14</bSChannelBwSUL>\r
+      </attributes>\r
+    </NRCellDU>\r
+  </GNBDUFunction>\r
+</ManagedElement>\r
diff --git a/build/config/rrmPolicy.xml b/build/config/rrmPolicy.xml
new file mode 100644 (file)
index 0000000..bf6b8a5
--- /dev/null
@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<RRMPolicyRatio xmlns="urn:3gpp:sa5:_3gpp-nr-nrm-rrmpolicy">
+  <id>rrm-1</id>
+  <attributes>
+    <resourceType>PRB_UL</resourceType>
+    <rRMPolicyMemberList>
+       <mcc>901</mcc>
+       <mnc>44</mnc>
+       <sd>000002</sd>
+       <sst>1</sst>
+    </rRMPolicyMemberList>
+    <rRMPolicyMaxRatio>90</rRMPolicyMaxRatio>
+    <rRMPolicyMinRatio>40</rRMPolicyMinRatio>
+    <rRMPolicyDedicatedRatio>40</rRMPolicyDedicatedRatio>
+  </attributes>
+</RRMPolicyRatio> 
index 16ddaeb..13e2895 100644 (file)
Binary files a/docs/CLA_call_flow.png and b/docs/CLA_call_flow.png differ
index b3d316d..9f0a787 100644 (file)
Binary files a/docs/CellUpAndBroadcast.png and b/docs/CellUpAndBroadcast.png differ
diff --git a/docs/Network_Slicing.png b/docs/Network_Slicing.png
new file mode 100644 (file)
index 0000000..1e83810
Binary files /dev/null and b/docs/Network_Slicing.png differ
index bd57bec..1d91990 100644 (file)
@@ -52,13 +52,57 @@ C. Pre-requisite for O1 Interface (Required only if run with O1 interface enable
    a. Open the startup_config.xml and edit the desired IP and Port for CU, DU and RIC.
    b. Open the nacm_config.xml and edit the desired user name to provide the access to that user.
    c. Open the netconf_server_ipv6.xml and edit the desired netconf server configuration.
-   d. Open the vesConfig.json and edit the details of VES collector.
-   e. Open the netconfConfig.json and edit the details of Netopeer server.
-   f. Install the yang modules and load initial configuration
+   d. Open the oamVesConfig.json and edit the details of OAM VES collector.
+   e. Open the smoVesConfig.json and edit the details of SMO VES collector.
+   f. Open the netconfConfig.json and edit the details of Netopeer server.
+   g. Install the yang modules and load initial configuration
 
    $cd l2/build/scripts
    $sudo ./load_yang.sh
 
+   h. Install additional 3GPP yang models.
+
+      Download following 3GPP REL17 YANG models
+      https://forge.3gpp.org/rep/sa5/MnS/tree/Rel17-draft/yang-models
+
+   $cd l2/build/yang
+
+   _3gpp-common-top.yang
+   _3gpp-5g-common-yang-types.yang
+   _3gpp-common-yang-types.yang
+   _3gpp-common-managed-element.yang
+   _3gpp-common-measurements.yang
+   _3gpp-common-subscription-control.yang
+   _3gpp-common-fm.yang
+   _3gpp-common-trace.yang
+   _3gpp-common-managed-function.yang
+   _3gpp-nr-nrm-gnbdufunction.yang
+   _3gpp-nr-nrm-nrcelldu.yang
+   _3gpp-nr-nrm-rrmpolicy.yang
+
+   Note :There are some corrections required in _3gpp-common-trace.yang and _3gpp-common-trace.yang yang model. Please follow these steps.
+
+   $cd l2/build/yang
+   $sed -i -e 's/"IMMEDIATE_MDT"/"IMMEDIATE_MDT_ONLY"/g' _3gpp-common-trace.yang
+   $sed -i -e 's/"TRACE"/"TRACE_ONLY"/g' _3gpp-common-trace.yang
+
+   Install all the downloaded yang models.
+
+   $cd l2/build/yang
+   $sysrepoctl -i      _3gpp-common-top.yang
+   $sysrepoctl -i      _3gpp-5g-common-yang-types.yang
+   $sysrepoctl -i      _3gpp-common-yang-types.yang
+   $sysrepoctl -i      _3gpp-common-managed-element.yang
+   $sysrepoctl -i      _3gpp-common-measurements.yang
+   $sysrepoctl -i      _3gpp-common-subscription-control.yang
+   $sysrepoctl -i      _3gpp-common-fm.yang
+   $sysrepoctl -i      _3gpp-common-trace.yang
+   $sysrepoctl -i      _3gpp-common-managed-function.yang
+   $sysrepoctl -i      _3gpp-nr-nrm-gnbdufunction.yang
+   $sysrepoctl -i      _3gpp-nr-nrm-nrcelldu.yang
+   $sysrepoctl -i      _3gpp-nr-nrm-rrmpolicy.yang
+
+
 3. Start Netopeer2-server:
    $cd l2/build/scripts
    $sudo ./netopeer-server.sh start
@@ -278,8 +322,17 @@ H. How to execute the Health Check : get alarm-list
 
    The XML output is a list of active alarms in the O-DU High system.
 
+I. Push cell and slice configuration over O1 using netopeer-cli
+---------------------------------------------------------------
+   When O-DU High is run with O1 enabled it waits for cell configuration to be pushed by SMO. In case the SMO is not available then these configurations can be pushed via netopeer-cli as follows.
+   1. Follow step H.1 and H.2.
+   2. update cellConfig.xml and rrmPolicy.xml.
+      $cd l2/build/config
+      $edit-config --target candidate --config=cellConfig.xml
+      $edit-config --target candidate --config=rrmPolicy.xml
+
 
-G. Troubleshooting Netconf server issues
+J. Troubleshooting Netconf server issues
 ----------------------------------------
    In case the Netconf server and sysrepo breaks down, run the following steps:
 
index 7cdc5d3..5440359 100644 (file)
Binary files a/docs/UeAttach.png and b/docs/UeAttach.png differ
index 9bf0c22..8be3300 100644 (file)
@@ -6,7 +6,7 @@
 API-Docs
 **********
 
-This is the API-docs for D relase o-du/l2.
+This is the API-docs for e-release o-du/l2.
 
 .. contents::
    :depth: 3
@@ -16,146 +16,161 @@ This is the API-docs for D relase o-du/l2.
 Introduction
 -----------------
 This document lists the APIs implemented between various modules of ODU-High and their functionality.
-These are in line with ORAN-WG8.AAD-v3.00.00, hereafter referred to as AAD Spec.
+These are in line with ORAN-WG8.AAD-v5.00.00, hereafter referred to as AAD Spec.
+
+Note: DU APP module consist functionality related to F1 Handler and O1 Handler
 
 API Functions
 -------------
 1. RLC-MAC Interface
 
-   - AAD Spec : section 9.2.1
+   - AAD Spec : section 9.2.2
 
    A. RLC to MAC
    
-      a. Data Transfer(DL) : Transfers DL data to MAC as per Section 9.2.1.1 of the AAD Spec
+      a. Data Transfer(DL) : Transfers DL data to MAC as per Section 9.2.2.1 of the AAD Spec
 
-      b. Buffer Status Reporting(DL) : Reports DL data volume pending in the RLC entity, as per Section 9.2.1.4 of the
+      b. Buffer Status Reporting(DL) : Reports DL data volume pending in the RLC entity, as per Section 9.2.2.4 of the
          AAD Spec
 
    B. MAC to RLC
 
-      a. Data Transfer(UL) : Transfers UL data to RLC as per Section 9.2.1.2 of the AAD Spec
+      a. Data Transfer(UL) : Transfers UL data to RLC as per Section 9.2.2.2 of the AAD Spec
 
-      b. Schedule Result Reporting (DL) : Reports DL schedule result to RLC as per Section 9.2.1.3 of the AAD Spec
+      b. Schedule Result Reporting (DL) : Reports DL schedule result to RLC as per Section 9.2.2.3 of the AAD Spec
 
 2. MAC-Scheduler Interface
 
-   - AAD Spec : section 9.2.2
+   - AAD Spec : section 9.2.3
 
    A. MAC to Scheduler
 
       a. Air Interface Time : Sends timing information over air interface in terms of SFN and slo, as per Section
-         9.2.2.1.1 of the AAD Spec
+         9.2.3.1.1 of the AAD Spec
 
-      b. Cell Configuration Request : MAC provides SCH the cell configuration as per Section 9.2.2.2.1 of the AAD Spec
+      b. Cell Configuration Request : MAC provides SCH the cell configuration as per Section 9.2.3.2.1 of the AAD Spec
 
-      c. Add UE Configuration Request : MAC provides SCH the configuration/capabilities of a UE as per Section 9.2.2.2.3
-         of the AAD Spec
+      c. Add UE Configuration Request : MAC provides SCH the configuration/capabilities of a UE as per Section 9.2.3.2.5 of the AAD Spec
 
       d. Modify UE Reconfiguration Request : MAC provides SCH the re-configuration of UE, also used to
-         add/release/modify existing bearers, as per Section 9.2.2.2.4 of the AAD Spec
+         add/release/modify existing bearers, as per Section 9.2.3.2.6 of the AAD Spec
 
-      e. RACH Indication : MAC receives the RACH Indication and share the contents with SCH as per Section 9.2.2.2.10 of
-         the AAD Spec
+      e. RACH Indication : MAC receives the RACH Indication and share the contents with SCH as per Section 9.2.3.2.12 of the AAD Spec
 
       f. DL RLC Buffer Status Information : Reports data volume per LC when it is received at MAC as per Section
-         9.2.2.2.14 of the AAD Spec
+         9.2.3.2.16 of the AAD Spec
 
       g. UL Buffer Status Report Indication : On reception and decoding of received BSR from the UE, MAC provides SCH
-         buffer status report for UL scheduling, as per Section 9.2.2.2.16 of the AAD Spec
+         buffer status report for UL scheduling, as per Section 9.2.3.2.18 of the AAD Spec
 
-      h. UE Delete Request : MAC receives UE delete request and forwards the request to SCH as per Section 9.2.2.2.5 
+      h. UE Delete Request : MAC receives UE delete request and forwards the request to SCH as per Section 9.2.3.2.7
          of the AAD spec.
 
-      i. Cell Delete Request :  MAC receives UE delete request and forwards the request to SCH as per Section 9.2.2.2.2
+      i. Cell Delete Request :  MAC receives UE delete request and forwards the request to SCH as per Section 9.2.3.2.2
          of the AAD spec.
+
+      j. Slice Configuration Request : MAC receives Slice Configuration request and forwards the request to SCH as per Section
+         9.2.3.2.3 of the AAD Spec
         
+      k. Slice Reconfiguration Request : MAC receives Slice Reconfiguration request and forwards the request to SCH as per 
+         Section 9.2.3.2.4 of the AAD Spec
+
    B. Scheduler to MAC
 
-      a. Cell Configuration Response - Response to cell configuration request from MAC, as per Section 9.2.2.3.1 of the
-         AAD Spec
+      a. Cell Configuration Response - Response to cell configuration request from MAC, as per Section 9.2.3.3.1 of the AAD Spec
 
-      b. UE Reconfiguration Response - Response to UE reconfiguration request from MAC, as per Section 9.2.2.3.3 of the
-         AAD Spec
+      b. UE Reconfiguration Response - Response to UE reconfiguration request from MAC, as per Section 9.2.3.3.6 of the AAD Spec
 
       c. DL Scheduling Information - Provides scheduling information for a given slot for downlink data, as per Section
-         9.2.2.3.5 of the AAD spec.
+         9.2.3.3.8 of the AAD spec.
     
       d. UL Scheduling Information - Provides scheduled information for MAC to form the UL_TTI.request towards O-DU Low,
-         as per Section 9.2.2.3.6 of the AAD Spec.
+         as per Section 9.2.3.3.9 of the AAD Spec.
 
-      e. RAR Information - Informs MAC of uplink scheduling and Msg3 scheduling information, as per Section 9.2.2.3.7 of
-         the AAD Spec.
+      e. RAR Information - Informs MAC of uplink scheduling and Msg3 scheduling information, as per Section 9.2.3.3.10 of the AAD Spec.
 
       f. Downlink Control Channel Information - Provides DCI scheduling information for a given slot on PDCCH, as per
-         Section 9.2.2.3.8 of the AAD Spec
+         Section 9.2.3.3.11 of the AAD Spec
 
       g. Downlink Broadcast Allocation - Provides DCI and DL data scheduling information for SIB1 for a given slot for
-         Broadcast Channel, as per Section 9.2.2.3.9 of the AAD Spec.
+         Broadcast Channel, as per Section 9.2.3.3.12 of the AAD Spec.
 
-      h. UE Delete Response - Response to UE delete request from MAC, as per Section 9.2.2.3.4
+      h. UE Delete Response - Response to UE delete request from MAC, as per Section 9.2.3.3.7
+
+      i. Cell Delete Response - Response to Cell delete request from MAC, as per Section 9.2.3.3.2
+
+      j. Slice Configuration Response : Response to Slice Configuration request from MAC, as per Section 9.2.3.3.3 of the AAD Spec
+        
+      k. Slice Reconfiguration Response : Response to Slice Reconfiguration request from MAC, as per Section 9.2.3.3.4 of the AAD Spec
 
-      i. Cell Delete Response - Response to Cell delete response from MAC, as per Section 9.2.2.3.2
 
 3. DU APP - MAC Interface
 
-   - AAD Spec : section 9.2.3
+   - AAD Spec : section 9.2.4
 
    A. DU APP to MAC
    
       a. Cell Start - Commands MAC to start cell at L1 and to start broadcasting system information, as per Section
-         9.2.3.1 of the AAD Spec.
+         9.2.4.1 of the AAD Spec.
 
-      b. UE Create Request - Adds UE information at MAC as per Section 9.2.3.3 of the AAD Spec.
+      b. UE Create Request - Adds UE information at MAC as per Section 9.2.4.3 of the AAD Spec.
 
-      c. UE Reconfiguration Request - Reconfigure UE information for a UE already added at MAC, as per Section 9.2.3.5
-         of the AAD Spec.
+      c. UE Reconfiguration Request - Reconfigure UE information for a UE already added at MAC, as per Section 9.2.4.5 of the AAD Spec.
 
-      d. DL CCCH Indication - Sends DL CCCH Message to MAC to be sent to UE, as per Section 9.2.3.16 of the AAD Spec.
+      d. DL CCCH Indication - Sends DL CCCH Message to MAC to be sent to UE, as per Section 9.2.4.16 of the AAD Spec.
 
-      e. Cell Stop - Commands MAC to stop cell at L1, as per Section 9.2.3.2 of the AAD spec.
+      e. Cell Stop - Commands MAC to stop cell at L1, as per Section 9.2.4.2 of the AAD spec.
 
-      f. UE Delete Request - Deletes UE information at MAC as per Section 9.2.3.7  of the AAD Spec.
+      f. UE Delete Request - Deletes UE information at MAC as per Section 9.2.4.7  of the AAD Spec.
+      
 
    B. MAC to DU APP
 
-      a. UE Create Response - Response to UE Create Request from DU Manager as per Section 9.2.3.4 of the AAD Spec.
+      a. UE Create Response - Response to UE Create Request from DU Manager as per Section 9.2.4.4 of the AAD Spec.
 
-      b. UE Reconfiguration Response - Response to UE Reconfiguration Request from DU APP as per Section 9.2.3.6 of the
+      b. UE Reconfiguration Response - Response to UE Reconfiguration Request from DU APP as per Section 9.2.4.6 of the
          AAD Spec.
 
-      c. UL-CCCH Indication - Sends the UL CCCH Message received from UE to DU APP as per Section 9.2.3.15 of AAD Spec.
-
-      d. UE Delete Response - Response to UE Delete Request from DU Manager as per Section 9.2.3.8 of the AAD Spec.
+      c. UL-CCCH Indication - Sends the UL CCCH Message received from UE to DU APP as per Section 9.2.4.15 of AAD Spec.
 
+      d. UE Delete Response - Response to UE Delete Request from DU Manager as per Section 9.2.4.8 of the AAD Spec.
+      
 4. DU APP - RLC Interface
-
-   - AAD Spec : section 9.2.4
+   
+   - AAD Spec : section 9.2.5
 
    A. DU APP to RLC
 
-      a. UE Create - Adds UE associated RLC entity and related information as per Section 9.2.4.1 of the AAD Spec.
+      a. UE Create - Adds UE associated RLC entity and related information as per Section 9.2.5.1 of the AAD Spec.
 
-      b. UE Reconfiguration - Reconfigures the UE associated RLC entity previously added at RLC, as per Section 9.2.4.3
-         of the AAD Spec.
+      b. UE Reconfiguration - Reconfigures the UE associated RLC entity previously added at RLC, as per Section 9.2.5.3 of the AAD Spec.
 
-      c. DL RRC Message Transfer - Requests RLC to deliver RRC message from CU to the UE, as per Section 9.2.4.7 of the
-         AAD Spec.
+      c. DL RRC Message Transfer - Requests RLC to deliver RRC message from CU to the UE, as per Section 9.2.5.7 of the AAD Spec.
 
-      d. UE Delete Request - Deletes UE associated RLC entity and related information as per Section 9.2.4.5 of the 
-         AAD Spec.
+      d. UE Delete Request - Deletes UE associated RLC entity and related information as per Section 9.2.5.5 of the  AAD Spec.
 
    B. RLC to DU APP
 
-      a. UE Create Response - Response to UE Create Request from DU APP, as per Section 9.2.4.3
+      a. UE Create Response - Response to UE Create Request from DU APP, as per Section 9.2.5.3
 
-      b. UE Reconfiguration Response - Response to UE Recofiguration Request from DU APP, as per Section 9.2.4.4
+      b. UE Reconfiguration Response - Response to UE Recofiguration Request from DU APP, as per Section 9.2.5.4
 
-      c. UL RRC Message Tranfer - Delivers RRC Message from UE to CU as per Section 9.2.4.8 of the AAD spec.
+      c. UL RRC Message Tranfer - Delivers RRC Message from UE to CU as per Section 9.2.5.8 of the AAD spec.
 
       d. RRC Message Delivery Report - Informs DU Manager on failed/successful delivery of a DL RRC message to UE, as
-         per Section 9.2.4.9 of the AAD Spec.
+         per Section 9.2.5.9 of the AAD Spec.
+
+      e. UE Delete Response - Response to UE Delete Request from DU APP, as per section 9.2.5.6
 
-      e. UE Delete Response - Response to UE Delete Request from DU APP, as per section 9.2.4.6
+5. SMO-OAM - DU APP
+
+   - AAD Spec: Section 9.2.1
+
+   A. SMO-OAM to DU APP
+
+      a. Cell Configuration - Sends Basic Cell Configurations to DU APP as per Section 9.2.1.1
+      
+      b. Slice Configuration - Sends Slice Configurations to DU APP as per Section 9.2.1.2
 
 Additional APIs
 ----------------
@@ -164,25 +179,42 @@ Additional APIs
 
    A. DU APP to MAC
      
-      a. Cell Configuration Request - Configures cell information at MAC
+      a. Cell Configuration Request - Configures cell information at MAC.
 
-      b. Cell Delete Request - Deletes cell information at MAC
+      b. Cell Delete Request - Deletes cell information at MAC.
+      
+      c. Slice Configuration Request : Triggers Slice Configuration request once received from O1 towards MAC.
+        
+      d. Slice Reconfiguration Request : Triggers Slice Reconfiguration request once received from O1 towards MAC. 
 
    B. MAC to DU APP
 
       a. Cell Configuration Response - Response to Cell Configuration Request from DU APP
 
       b. Cell Delete Response - Response to Cell Delet request from DU APP
+      
+      c. Slice Configuration Respone :  Response to Slice Configuration request from DU Manager.
+        
+      d. Slice Reconfiguration Request : Response to Slice Reconfiguration request from DU Manager.
 
 2. DU APP - RLC Interface
 
    A. RLC to DU APP
 
-      c. DL RRC Message Response - Informs DU APP if a DL RRC Message was successfuly processed at RLC and sent to MAC.
+      a. DL RRC Message Response - Informs DU APP if a DL RRC Message was successfuly processed at RLC and sent to MAC.
+
+      b. Slice Performance Metrics - Sends PM to DU APP every 60sec for every Slice configured.
 
-3. DU APP - O1 Interface
+
+3. DU APP - SMO-OAM
 
    a. Bring cell up - Informs DU to bring a specific cell up
+
    b. Bring cell down - Informs DU to bring specific cell up
+
    c. Set the cell operational state - Sets the cell state to ACTIVE/INACTIVE
-   d. Raise a cell alarm - Raise an alarm when the cell is ACTIVE/INACTIV
+
+   d. Raise a cell alarm - Raise an alarm when the cell is ACTIVE/INACTIVE
+
+   e. Slice PM - DU APP sends PM for all Slices in 60sec duration.
+
index fbc9060..d337736 100644 (file)
@@ -24,6 +24,10 @@ Version history
 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
+| 2021-12-15         |  3.0.0             |  Radisys,          |  e-release         |
+|                    |                    |  HCL Technologies  |                    |
+|                    |                    |  Ltd.              |                    |
++--------------------+--------------------+--------------------+--------------------+
 | 2021-07-07         |  2.0.0             |  Radisys,          |  D Release         |
 |                    |                    |  HCL Technologies  |                    |
 |                    |                    |  Ltd.              |                    |
@@ -140,19 +144,65 @@ Setting up Netconf server (Only if O1 interface enabled)
 
     - Navigate to config folder and update the desired initial configuration
 
-   - Ubuntu :
-       | cd <O-DU High Directory>/l2/build/config
+      | cd <O-DU High Directory>/l2/build/config
 
       | Open the startup_config.xml and edit the desired IP and Port for CU, DU and RIC.
       | Open the nacm_config.xml and edit the desired user name to provide the access to that user.
       | Open the netconf_server_ipv6.xml and edit the desired netconf server configuration.
-      | Open the vesConfig.json and edit the details of VES collector.
+      | Open the oamVesConfig.json and edit the details of OAM VES collector.
+      | Open the smoVesConfig.json and edit the details of SMO VES collector.
       | Open the netconfConfig.json and edit the details of Netopeer server.
       | Install the yang modules and load initial configuration.
 
-   - Ubuntu :
-       | cd <O-DU High Directory>/l2/build/scripts
-       | sudo ./load_yang.sh
+      - Ubuntu :
+      
+      | $cd <O-DU High Directory>/l2/build/scripts
+      | $sudo ./load_yang.sh
+
+    - Install additional 3GPP YANG models.
+
+      | $cd <O-DU High Directory>/l2/build/yang
+
+      | Download following 3GPP REL17 YANG models
+      | https://forge.3gpp.org/rep/sa5/MnS/tree/Rel17-draft/yang-models
+
+      | _3gpp-common-top.yang
+      | _3gpp-5g-common-yang-types.yang
+      | _3gpp-common-yang-types.yang
+      | _3gpp-common-managed-element.yang
+      | _3gpp-common-measurements.yang
+      | _3gpp-common-subscription-control.yang
+      | _3gpp-common-fm.yang
+      | _3gpp-common-trace.yang
+      | _3gpp-common-managed-function.yang
+      | _3gpp-nr-nrm-gnbdufunction.yang
+      | _3gpp-nr-nrm-nrcelldu.yang
+      | _3gpp-nr-nrm-rrmpolicy.yang
+
+      | Note : There are some corrections required in _3gpp-common-trace.yang and _3gpp-common-trace.yang yang model. Please follow these steps.
+
+      - Ubuntu :
+      
+      | sed -i -e 's/"IMMEDIATE_MDT"/"IMMEDIATE_MDT_ONLY"/g' _3gpp-common-trace.yang
+      | sed -i -e 's/"TRACE"/"TRACE_ONLY"/g' _3gpp-common-trace.yang
+
+   - Install all the downloaded yang models.
+
+       - Ubuntu :
+       
+       | cd <O-DU High Directory>/l2/build/yang
+       | sysrepoctl -i      _3gpp-common-top.yang
+       | sysrepoctl -i      _3gpp-5g-common-yang-types.yang
+       | sysrepoctl -i      _3gpp-common-yang-types.yang
+       | sysrepoctl -i      _3gpp-common-managed-element.yang
+       | sysrepoctl -i      _3gpp-common-measurements.yang
+       | sysrepoctl -i      _3gpp-common-subscription-control.yang
+       | sysrepoctl -i      _3gpp-common-fm.yang
+       | sysrepoctl -i      _3gpp-common-trace.yang
+       | sysrepoctl -i      _3gpp-common-managed-function.yang
+       | sysrepoctl -i      _3gpp-nr-nrm-gnbdufunction.yang
+       | sysrepoctl -i      _3gpp-nr-nrm-nrcelldu.yang
+       | sysrepoctl -i      _3gpp-nr-nrm-rrmpolicy.yang
 
 - Start Netopeer2-server:
 
index 0cf0541..e0c3192 100644 (file)
@@ -241,6 +241,10 @@ This section describes the cell-up procedure within O-DU High.
 
 
 As seen in the Figure 4,
+- If O1 interface is enabled, SMO sends cell configuration to DU APP. DU APP stores the configurations in its local database.
+
+- If O1 interface is disabled, DU APP module uses static configuration.
+
 - The DU APP module of O-DU High sends F1 Setup Request to O-CU. This message contains a list of cells that the O-DU High has been configured with.
 
 - The O-CU responds with F1 Setup Response. This message contains a list of cells which must be activated.
@@ -261,7 +265,7 @@ As seen in the Figure 4,
   The frequency of these slot indications is determined by the numerology(Mu) supported.
   5G NR MAC forwards these slot indications to the 5G NR SCH and DU APP modules.
 
-- When the first slot indication reaches the DU APP, cell is marked as up.
+- When the first slot indication reaches the DU APP, cell is marked as up. If O1 is enabled, DU APP triggers an alarm to SMO to indicate the CELL is UP.
 
 - The 5G NR SCH, keeps tracking the SSB and SIB1 ocassions on receiving regular slot indications. 
   On detecting the relevant ocassion, 5G NR SCH schedules SSB/SIB1 and forwards the DL Scheduling Information to 5G NR MAC.
@@ -348,11 +352,11 @@ This section describes the closed loop automation procedure within O-DU High.
    
 4. DU APP then sends UE delete request to MAC and RLC. Once a confirmation is received from both MAC and RLC, DU APP deletes UE from its own database as well.
 
-4. Once all UEs are released, O-DU High sends STOP.Request to L1. L1 responds with stop indication.
+5. Once all UEs are released, O-DU High sends STOP.Request to L1. L1 responds with stop indication.
 
-5. Once cell has stopped, DU APP sends cell delete request to MAC. On receiving confimation from MAC, DU APP deletes cell information from its own database as well and sends UE Context Release Complete.
+6. Once cell has stopped, DU APP sends cell delete request to MAC. On receiving confimation from MAC, DU APP deletes cell information from its own database as well and sends UE Context Release Complete.
 
-6. On receiving cell bring up command from SMO, the complete Cell bring up and UE attach procedure will be repeated (as explained in above sections)
+7. On receiving cell bring up command from SMO, the complete Cell bring up and UE attach procedure will be repeated (as explained in above sections)
 
 
 O1 Netconf get-alarm list procedure
@@ -379,6 +383,34 @@ As seen in the Figure 7,
 
 - The callback function fetches the alarm list from Alarm Manager and sends it back to the client (SMO/OAM) via  Netconf interface. 
 
+
+Network Slicing procedure
+--------------------------
+
+This section describes the Network Slicing feature within O-DU High.
+
+
+.. figure:: Network_Slicing.png 
+  :width: 869
+  :alt: Network Slicing flow
+
+  Figure 8 -  Network Slicing flow
+
+As seen in the Figure 8,
+
+- Once the Cell is UP, Slice Configuration received from O1 to O-DU is processed. DU APP forwards the Slice Configuration Request towards MAC which is further forwarded to Scheduler.
+
+- Scheduler stores the Slice Configuration in DB and sends the Slice Configuration Response for each Slice to MAC and further towards DU APP. Slice Configuration Procedure completes.
+
+- Once a UE attaches and PDU session is established then RLC will periodically calculate the Slice Performance Metrics(UL and DL Throughput) for slices configured during UE Context Setup/Modification procedure.
+
+- RLC sends the Consolidated Slice Metrics to DU APP at every 60 sec duration. This is further forwarded towards SMO/Non-RT RIC.
+
+- SMO/Non-RT RIC analyses these metrics and may optimize the slice configuration(RRM Policies) for dedicated slice. This is received at MAC and Scheduler as Slice Reconfiguration Request from DU APP.
+
+- Scheduler updates the received Slice Configuration in its DB and sends back the Slice Reconfiguration Response to MAC and further MAC forwards it to DU APP. Scheduler applies the optimized RRM policies for the dedicated slice.
+
+
 OSC Testcases Supported
 =========================
 
index 2993c09..5fe1a5d 100644 (file)
@@ -20,6 +20,10 @@ Version history
 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
+| 2021-12-15         | 5.0.0              | Radisys,           | e-release          |
+|                    |                    | HCL Technologies   |                    |
+|                    |                    | Ltd.               |                    |
++--------------------+--------------------+--------------------+--------------------+
 | 2021-09-06         | 4.0.0              | Radisys,           | D Release          |
 |                    |                    | HCL Technologies   |                    |
 |                    |                    | Ltd.               |                    |
@@ -39,6 +43,29 @@ Version history
 Summary
 -------
 
+e-release
+^^^^^^^^^^
+This release contains the following:
+
+ - Support for multiple bearers per UE
+
+ - Support for multiple UEs per cell. Maximum 3 UEs supported in this release.
+
+ - Enhancement of scheduler for round robin scheduling of UEs
+ - Enhancement of scheduler to allocate grid resources to UL/DL channels based on slice(RRM Policies), UE and logical channel configurations
+
+ - Support for Network slicing
+      
+      - Measures the Slice performance and periodically reports the slice performance statistics to O1.
+      - Adjusting/Improving Slice performance via Slice Reconfiguration with optimized resource quota from SMO.
+ - O1 Module
+
+      - Support for cell configuration over O1 interface.
+      - Support for RRM policy configuration over O1 interface.
+      - Support VES PM data stream for sending slice metrics parameters to SMO.
+
 D
 ^^^^^^^^
 This release contains the following:
@@ -52,23 +79,18 @@ This release contains the following:
  - O-DU low – O-DU high pairwise testing in Radio mode (Broadcast message successfully received at O-DU Low).
 
  - O1 Module
-      Re-structure O1 module to run as a thread in ODU-High.
-
-      CM Support - IP and Port configuration for DU, CU stub and RIC stub via Netconf interface.
-
-      VES PNF Registration.
-
-      Support for Closed Loop Automation use-case.
+      
+      - Re-structure O1 module to run as a thread in ODU-High.
+      - CM Support - IP and Port configuration for DU, CU stub and RIC stub via Netconf interface.
+      - VES PNF Registration.
+      - Support for Closed Loop Automation use-case.
 
  - Maintenance release includes :
-
-      Memory handling optimization and fixes.
-
-      Improvement in logging.
-
-      K0, K1 and K2 configuration.
       
-      Fixes in proccessing of RACH Indication and RAR.
+      - Memory handling optimization and fixes.
+      - Improvement in logging.
+      - K0, K1 and K2 configuration.
+      - Fixes in proccessing of RACH Indication and RAR.
 
 Cherry
 ^^^^^^^^
@@ -132,6 +154,26 @@ This release contains the following:
 Release Data
 ------------
 
+e-release
+^^^^^^^^^^ 
++--------------------------------------+--------------------------------------+
+| **Project**                          | ODUHIGH                              |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Repo/commit-ID**                   | o-du/l2/                             |
+|                                      | I4b894c652ef3a3584670a9f26de87c2b2b3b|
+|                                      | d8f2                                 |
++--------------------------------------+--------------------------------------+
+| **Release designation**              | e-release                            |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release date**                     | 2021-12-15                           |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Purpose of the delivery**          | e-release                            |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+
 D
 ^^^^^^ 
 +--------------------------------------+--------------------------------------+
@@ -222,6 +264,29 @@ Feature Additions
 
 **JIRA BACK-LOG:**
 
+e-release
+^^^^^^^^^^
+
++-----------------------------------------------+-----------------------------------------------+
+| **JIRA REFERENCE**                            | **SLOGAN**                                    |
+|                                               |                                               |
++-----------------------------------------------+-----------------------------------------------+
+| https://jira.o-ran-sc.org/browse/ODUHIGH-351  | Support for Multi bearers                     | 
+|                                               |                                               |
++-----------------------------------------------+-----------------------------------------------+
+| https://jira.o-ran-sc.org/browse/ODUHIGH-352  | Support for Multi UE                          |
+|                                               |                                               |
++-----------------------------------------------+-----------------------------------------------+
+| https://jira.o-ran-sc.org/browse/ODUHIGH-363  | Network Slicing support                       |
+|                                               |                                               |
++-----------------------------------------------+-----------------------------------------------+
+| https://jira.o-ran-sc.org/browse/ODUHIGH-340  | Resource allocation in time domain changes to |
+|                                               | meet flexible k0, k1 and k2 values            |
++-----------------------------------------------+-----------------------------------------------+
+| https://jira.o-ran-sc.org/browse/ODUHIGH-361  | Support for cell configuration over O1        |
+|                                               | interface                                     |
++-----------------------------------------------+-----------------------------------------------+
+
 D
 ^^^^^^^
 
@@ -376,17 +441,14 @@ System Limitations
 ^^^^^^^^^^^^^^^^^^
 - Current code contains support only for below configuration:
 
-   [TDD] [Mu1] [100MHz]
-
-   [FDD] [Mu0] [ 20MHz]
+   - [TDD] [Mu1] [100MHz]
+   - [FDD] [Mu0] [ 20MHz]
+   - Freuency Range = FR 1
+   - DL/UL Modulation = QPSK
 
-   Freuency Range = FR 1
+- Current code is locally tested to support upto three UEs.
 
-   DL/UL Modulation = QPSK
-
-   single UE.
-
-- This release implements a basic scheduler with fixed scheduling for single UE.
+- NR-MAC supports Round Robin scheduling currently.
 
 - Cell broadcast is for SSB and SIB1 only.
 
@@ -401,12 +463,16 @@ System Limitations
 
 - On the F1-U interface, UE, RB and tunnel configurations are static.
 
-- System runs on preconfigured values due to absence of CM support on O1 interface.
+- Cell configuration is supported by CM on O1 interface. All other configurations are static.
 
 - O-DU High has not been integrated with O-CU.(Using Radisys commercial CU as a test fixture)
 
 - Netconf TLS connection is not supported
 
+- Current code supports two Network Slices, One Default and other one Dedicated Slice.
+
+- We have to manually download the 3GPP yang models and install.
+
 Known Issues
 ^^^^^^^^^^^^^
 
@@ -416,9 +482,8 @@ Known Issues
 
 - Frequency domain allocation in DCI is a bit map where:
 
-     As per spec : the most significant bit corresponds to the group of lowest frequency.
-
-     As per L1 : the least significant bit corresponds to the lowest frequency group.
+     - As per spec : the most significant bit corresponds to the group of lowest frequency.
+     - As per L1 : the least significant bit corresponds to the lowest frequency group.
 
 - Only Resource allocation type 1 (i.e RB allocation using Start RB and Number of RBs) is supported for PDSCH.
 
@@ -440,7 +505,7 @@ O-DU High uses FAPI interface files provided by Intel and therefore, not complet
 
 References
 ----------
-1. ORAN-WG8.AAD.0-v02.05.00
+1. ORAN-WG8.AAD.0-v05.00.00
 
 2. ORAN WG3.E2AP v01.00
 
@@ -462,3 +527,8 @@ References
 
 11. 5G PHY FAPI Specification v1.0.5
 
+12. 3GPP TS 28.541 Specfication V16.6
+
+13. O-RAN WG1.O1-Interface v04.00
+
+14. O-RAN WG1.OAM-Architecture v04.00
index 1d077d7..990ab0b 100644 (file)
@@ -4,7 +4,7 @@
 User Guide
 ***********
 
-This is the user guide for release of O-DU/l2.
+This is the user guide for e-release of O-DU/l2.
 Follow installation-guide to get all the dependencies ready.
 
 .. contents::
@@ -58,6 +58,7 @@ PS: If O1 interface is enabled, IPs should match those configured in "startup_co
       - ./odu
 
 PS: CU stub and RIC stub must be run (in no particular sequence) before ODU. 
+    In case O1 is enabled and SMO is not available follow section E below.
 
 II. Execution - Using Docker Images
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -241,3 +242,15 @@ Here are the steps as executed in the terminal
      |  </odu>
 
 The XML output is a list of active alarms in the O-DU High system.
+
+E. Push cell and slice configuration over O1 using netopeer-cli
+---------------------------------------------------------------
+
+When O-DU High is run with O1 enabled it waits for cell configuration to be pushed by SMO. In case the SMO is not available then these configurations can be pushed via netopeer-cli as follows.
+
+   1. Follow step D.1 and D.2.
+   2. update cellConfig.xml and rrmPolicy.xml.
+
+      | $cd <O-DU High Directory>/l2/build/config
+      | $edit-config --target candidate --config=cellConfig.xml
+      | $edit-config --target candidate --config=rrmPolicy.xml
index 98be603..940c6ed 100644 (file)
@@ -74,7 +74,7 @@ void PerfMeasurementEvent::getConfig()
  ******************************************************************/
 void PerfMeasurementEvent::createUrl()
 {
-   mVesUrl = "https://" + mVesServerIp + ":" + mVesServerPort + "/eventListener/v7";
+   mVesUrl = "https://" + mVesServerIp + ":" + mVesServerPort + "/eventListener/v7/events";
    O1_LOG("\nURL=%s", mVesUrl.c_str());
 }