X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fapi-docs.rst;fp=docs%2Fapi-docs.rst;h=81d30c06e49db74ecd79bd65ad48046783550037;hb=c1e93b027631a245fc6791ea1052da5b905b4d8c;hp=c5b6500fe9fa40e3c0ea2593e28bd9f5a5067e05;hpb=e6cf50fe5be43291899cae7a1a24af906901ceff;p=o-du%2Fl2.git diff --git a/docs/api-docs.rst b/docs/api-docs.rst index c5b6500fe..81d30c06e 100644 --- a/docs/api-docs.rst +++ b/docs/api-docs.rst @@ -2,27 +2,180 @@ .. http://creativecommons.org/licenses/by/4.0 - +######## API-Docs -********** +######## -This is the API-docs for H release o-du/l2. +This is the API-docs for I release o-du/l2. .. contents:: :depth: 3 :local: - Introduction ------------------ -This document tabulates the APIs Aligned(Implemented)/Not Implemented/Additional APIs between various modules of -ODU-High and their functionality. -These are in line with ORAN-WG8.AAD-v7.00.00, hereafter referred to as AAD Spec. +============ + +This section tabulates the APIs Aligned(Implemented)/Not Implemented/Additional APIs between various modules of +ODU-High and also with external modules of ORAN. + +***************** +F1 Interface APIs +***************** + +Below table lists APIs Aligned(Implemented)/Not Implemented at F1 interface of +ODU-High i.e. between O-DU and O-CU. These are in line with 3GPP 38.473 V15.3.0. + ++------------+-------------------------------+-----------------+-----------+-----------------------------------------+ +| Interface | API | Status | Section | Remark | ++============+===============================+=================+===========+=========================================+ +| |Reset | Aligned |9.2.1.1 | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |Reset Acknowledge | Aligned |9.2.1.2 | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |Error Indication | Not Implemented |9.2.1.3 | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |F1 Setup Request | Aligned |9.2.1.4 | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |F1 Setup Response | Aligned |9.2.1.5 | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |F1 Setup Failure | Not Implemented |9.2.1.6 | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |GNB-DU Configuration Update | Aligned |9.2.1.7 | | +| **CU** +-------------------------------+-----------------+-----------+-----------------------------------------+ +| & **DU** |GNB-DU Configuration Update | Aligned |9.2.1.8 | | +| |Acknowledge | | | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |GNB-DU Configuration Update | Not Implemented |9.2.1.9 | | +| |Failure | | | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |GNB-CU Configuration Update | Not Implemented |9.2.1.10 | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |GNB-CU Configuration Update | Not Implemented |9.2.1.11 | | +| |Acknowledge | | | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |GNB-CU Configuration Update | Not Implemented |9.2.1.12 | | +| |Failure | | | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |GNB-DU Resource Coordination | Not Implemented |9.2.1.13 | | +| |Request | | | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |GNB-DU Resource Coordination | Not Implemented |9.2.1.14 | | +| |Response | | | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |GNB-DU Status Indication | Not Implemented |9.2.1.15 | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |UE Context Setup Request | Aligned |9.2.2.1 | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |UE Context Setup Response | Aligned |9.2.2.2 | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |UE Context Setup Faliure | Not Implemented |9.2.2.3 | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |UE Context Release Request | Aligned |9.2.2.4 | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |UE Context Release Command | Aligned |9.2.2.5 | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |UE Context Release Complete | Aligned |9.2.2.6 | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |UE Context Modification | Aligned |9.2.2.7 | | +| |Request | | | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |UE Context Modification | Aligned |9.2.2.8 | | +| |Response | | | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |UE Context Modification | Not Implemented |9.2.2.9 | | +| |Failure | | | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |UE Context Modification | Not Implemented |9.2.2.10 | | +| |Required | | | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |UE Context Modification | Not Implemented |9.2.2.11 | | +| |Confirm | | | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |UE Inactivity Notification | Not Implemented |9.2.2.12 | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |Notify | Not Implemented |9.2.2.13 | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |Initial UL RRC Message | Aligned |9.2.3.1 | | +| |Transfer | | | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |DL RRC Message Transfer | Aligned |9.2.3.2 | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |UL RRC Message Transfer | Aligned |9.2.3.3 | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |Write-Replace Warning Request | Not Implemented |9.2.4.1 | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |Write-Replace Warning Response | Not Implemented |9.2.4.2 | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |PWS Cancel Request | Not Implemented |9.2.4.3 | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |PWS Cancel Response | Not Implemented |9.2.4.4 | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |PWS Restart Indication | Not Implemented |9.2.4.5 | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |PWS failure Indication | Not Implemented |9.2.4.6 | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |System Information Delivery | Not Implemented |9.2.5.1 | | +| |Command | | | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |Paging | Aligned |9.2.6.1 | | ++------------+-------------------------------+-----------------+-----------+-----------------------------------------+ + +***************** +E2 Interface APIs +***************** + +This section tabulates the APIs Aligned(Implemented)/Not Implemented between ODU-High and Near-RT RIC. +These are in line with O-RAN.WG3.E2GAP-R003-v03.00 and O-RAN.WG3.E2AP-R003-v03.00. +Below mentioned section number are taken reference from sections of O-RAN.WG3.E2AP-R003-v03.00. + ++------------+-------------------------------+-----------------+-----------+-----------------------------------------+ +| Interface | API | Status |Section | Remark | ++============+===============================+=================+===========+=========================================+ +| |RIC Subscription procedure | Aligned |8.2.1 | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |RIC Subscription Delete | Aligned |8.2.2 | | +| |procedure | | | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |RIC Subscription Delete | Aligned |8.2.2A | | +| |Required procedure | | | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |RIC Indication procedure | Aligned |8.2.3 | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |RIC Control procedure | Not Implemented |8.2.4 | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |RIC Subscription Modification | Aligned |8.2.5 | | +| |procedure | | | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| **DU** |RIC Subscription Modification | Aligned |8.2.6 | | +| &**RIC** |Required procedure | | | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |RIC query procedure | Not Implemented |8.2.7 | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |E2 Setup procedure | Aligned |8.3.1 | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |Reset procedure | Aligned |8.3.2 | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |Error Indication | Aligned |8.3.3 | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |RIC Service Update procedure | Aligned |8.3.4 | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |E2 Node Configuration Update | Aligned |8.3.5 | | +| |procedure | | | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |E2 Connection Update procedure | Aligned |8.3.6 | | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |E2 Removal procedure | Aligned |8.3.7 | | ++------------+-------------------------------+-----------------+-----------+-----------------------------------------+ + +******************************** +ODU-High Internal Interface APIs +******************************** + +Below table lists APIs Aligned(Implemented)/Not Implemented/Additional APIs between various modules of ODU-High. +These are in line with ORAN-WG8.AAD-v9.00.00, hereafter referred to as AAD Spec. -Note: DU APP module consist functionality related to F1 Handler and O1 Handler +Note: DU APP module consist functionality related to F1 Handler, E2 Handler and O1 Handler. -API Table ------------ +------------+-------------------------------+-----------------+-----------+-----------------------------------------+ | Interface | API | Status | Section | Remark | +============+===============================+=================+===========+=========================================+ @@ -87,6 +240,12 @@ API Table | |UL Buffer Status Report Ind | Aligned |11.2.4.2.18| | | +-------------------------------+-----------------+-----------+-----------------------------------------+ | |Power Headroom Indication | Aligned |11.2.4.2.19| | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |Statistics Request | Additional API | | Adding new statistics group | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |Statistics Modification Request| Additional API | | Modification of statistics group | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |Statistics Delete Request | Additional API | | Deletion of statistics group | +------------+-------------------------------+-----------------+-----------+-----------------------------------------+ | |Cell Configuration Response | Aligned |11.2.4.3.1 | | | +-------------------------------+-----------------+-----------+-----------------------------------------+ @@ -120,6 +279,16 @@ API Table | +-------------------------------+-----------------+-----------+-----------------------------------------+ | |RACH Resource Response | Additional API | |Response to RACH Resource Request for | | | | | |dedicated resource for CF-RA | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |Statistics Response | Additional API | |Response to statistics request | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |Statistics Modification | Additional API | |Response to statistics modification | +| |Resonse | | |request | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |Statistics Delete Response | Additional API | |Response to statistics delete request | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |Statistics Indication | Additional API | |Calculate the KPI related to a specific | +| | | | |statistics group | +------------+-------------------------------+-----------------+-----------+-----------------------------------------+ | |Cell Start | Aligned |1.1.1.1 | | | +-------------------------------+-----------------+-----------+-----------------------------------------+ @@ -175,6 +344,23 @@ API Table | +-------------------------------+-----------------+-----------+-----------------------------------------+ | |Slot Indication | Additional API | |Indication about the ongoing SFN and | | | | | | Slot information to DU APP | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |Statistics Request | Additional API | | Adding new statistics at DU layer | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |Statistics Response | Additional API | | Response to statistics request from MAC | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |Statistics Modification Request| Additional API | | Modification of statistics at DU layer | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |Statistics Modification | Additional API | | Response to statistics modification | +| |Response | | | request from MAC | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |Statistics Delete Request | Additional API | | Deletion of statistics at DU layer | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |Statistics Delete Response | Additional API | | Response to statistics delete request | +| | | | | from MAC | +| +-------------------------------+-----------------+-----------+-----------------------------------------+ +| |Statistics Indication | Additional API | | Sending the calculated KPI value to DU | +| | | | | from MAC | +------------+-------------------------------+-----------------+-----------+-----------------------------------------+ | |UE Create | Aligned |11.2.5.1 | | | +-------------------------------+-----------------+-----------+-----------------------------------------+ @@ -211,3 +397,4 @@ API Table | | | | |every 60sec for every slice configured | +------------+-------------------------------+-----------------+-----------+-----------------------------------------+ +