1 module o-ran-ecpri-delay {
3 namespace "urn:o-ran:message5:1.0";
6 import o-ran-processing-element {
10 import o-ran-wg4-features {
14 organization "O-RAN Alliance";
20 "This module is an optional module for supporting eCPRI message 5 handling
21 used for eCPRI based delay measurements.
23 Copyright 2021 the O-RAN Alliance.
25 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS'
26 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
29 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35 POSSIBILITY OF SUCH DAMAGE.
37 Redistribution and use in source and binary forms, with or without
38 modification, are permitted provided that the following conditions are met:
40 * Redistributions of source code must retain the above copyright notice,
41 this list of conditions and the above disclaimer.
42 * Redistributions in binary form must reproduce the above copyright notice,
43 this list of conditions and the above disclaimer in the documentation
44 and/or other materials provided with the distribution.
45 * Neither the Members of the O-RAN Alliance nor the names of its
46 contributors may be used to endorse or promote products derived from
47 this software without specific prior written permission.";
49 revision "2021-12-01" {
53 1) typographical corrections in descriptions.
54 2) Add support for multiple transport-session-type per O-RU.";
56 reference "ORAN-WG4.M.0-v08.00";
59 revision "2021-07-26" {
63 1) add support for optional reporting of one or two-step measurements";
65 reference "ORAN-WG4.M.0-v07.00";
68 revision "2019-02-04" {
72 1) imported model from xRAN
73 2) changed namespace and reference from xran to o-ran";
75 reference "ORAN-WG4.M.0-v01.00";
81 description "an eCPRI message 5 grouping";
83 container ru-compensation {
86 "leafs for ru timing compensation based on message 5 handling";
91 "a compensation value to account for expected delay from packet
92 receipt at R2 to timestamping in the O-RU";
98 "a compensation value to account for expected processing time from
99 timestamping in the O-RU until actual packet transmission at R3";
103 leaf enable-message5 {
107 "whether O-RU's eCPRI message 5 handling is enabled.";
110 leaf one-step-t34-supported {
114 "Indicates whether O-RU supports eCPRI message 5 one-step procedure for
116 An O-RU supporting this YANG model shall at least set one of
117 one-step-t34-supported or two-step-t34-supported to true.
119 Note, all O-RUs supporting this model shall support one-step measurements
120 for T12 measurement";
123 leaf two-step-t34-supported {
127 "Indicates whether O-RU supports eCPRI message 5 two-step procedure for
129 An O-RU supporting this YANG model shall at least set one of
130 one-step-t34-supported or two-step-t34-supported to true
132 Note, all O-RUs supporting this model shall support two-step measurements
133 for T12 measurement";
136 container message5-sessions {
137 description "session information for eCPRI message 5";
139 list session-parameters {
141 description "list of MSG5 session information";
144 description "Session ID for MSG5 responder";
146 leaf processing-element-name {
148 path "/element:processing-elements/element:ru-elements/element:name";
150 description "the name of the processing element used for MSG5";
153 leaf transport-session-type {
154 if-feature "feat:MULTIPLE-TRANSPORT-SESSION-TYPE";
157 description "VLAN based CUS Transport ";
159 enum UDPIP-INTERFACE {
160 description "UDP/IP based CUS Transport ";
162 enum ALIASMAC-INTERFACE{
163 description "Alias MAC address based CUS Transport ";
167 "transport session type used when an O-RU is configured with multiple processing elements of different transport session types,
168 in which case it is used for referencing a processing element in 'transport-qualified-processing-element-name'";
171 leaf transport-qualified-processing-element-name {
172 if-feature "feat:MULTIPLE-TRANSPORT-SESSION-TYPE";
174 path "/element:processing-elements/element:additional-transport-session-type-elements[element:transport-session-type = current()/../transport-session-type]/element:ru-elements/element:name";
177 "the name of the processing element used for MSG5, used when the processing element
178 is configured by the list 'additional-transport-session-type-elements'";
181 container flow-state {
183 description "MSG5 flow state";
184 leaf responses-transmitted {
187 "The total number of eCPRI message 5 response messages transmitted by
190 leaf requests-transmitted {
193 "The total number of eCPRI message 5 request messages transmitted by
196 leaf followups-transmitted {
199 "The total number of eCPRI message 5 follow up messages transmitted by
207 // top level container
209 container ecpri-delay-message {
210 description "top-level tree covering off O-DU to O-RU msg5 delay measurement";