1 module o-ran-shared-cell {
3 namespace "urn:o-ran:shared-cell:1.0";
6 import o-ran-compression-factors {
9 import o-ran-processing-element {
11 revision-date 2020-04-17;
14 organization "O-RAN Alliance";
20 "This module defines the YANG definitions for shared cell capable O-RU (Cascade and FHM).
22 Copyright 2020 the O-RAN Alliance.
24 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS'
25 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
28 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 POSSIBILITY OF SUCH DAMAGE.
36 Redistribution and use in source and binary forms, with or without
37 modification, are permitted provided that the following conditions are met:
39 * Redistributions of source code must retain the above copyright notice,
40 this list of conditions and the above disclaimer.
41 * Redistributions in binary form must reproduce the above copyright notice,
42 this list of conditions and the above disclaimer in the documentation
43 and/or other materials provided with the distribution.
44 * Neither the Members of the O-RAN Alliance nor the names of its
45 contributors may be used to endorse or promote products derived from
46 this software without specific prior written permission.";
48 revision "2020-04-17" {
52 1) initial version for shared cell O-RU related yang module.";
54 reference "ORAN-WG4.M.0-v03.00";
59 "Presence of feature indicates that O-RU acts as FHM and doesn't have
60 the capability of radio transmission and reception. Absence of feature
61 indicates that O-RU does not act as FHM and supports radio transmission
62 and reception function.";
66 grouping radio-offset {
68 "shared cell FHM mode needs the configuration for radio related offset";
69 leaf downlink-radio-frame-offset {
76 "This parameter is used for offsetting the starting position of
78 Note: Unit is 1/1.2288e9 sec.";
81 leaf downlink-sfn-offset {
88 "This parameter is used for offsetting SFN value.
93 // shared cell capability
94 grouping shared-cell-module-capability{
96 "shared cell related module capability of O-RU";
97 container shared-cell-module-cap {
100 "indicates shared cell specific module capability";
107 "Corresponding to the maximum FHM or cascade O-RU processing delay
108 between receiving an IQ sample over the fronthaul interface from
109 the north-node, coping it and transmitting it over the fronthaul
110 interface to the south-node.";
118 "Corresponding to the maximum FHM or cascade O-RU processing delay
119 between receiving an IQ sample over the fronthaul interface from
120 the south-node(s), combing them and transmitting it over the
121 fronthaul interface to the north-node.";
124 leaf ta3-prime-max-upper-range {
129 "The upper limit for the configurable ta3-prime-max value.
130 This is the capability information of O-RU that comes from
131 the O-RU internal memory for the combine operation.";
134 leaf max-number-node-copy-and-combine {
140 "Indicates the maximum number of south-node for the copy-and-combine
141 functions of cascade O-RU or FHM.
142 For cascade mode, this value is one. It means
143 O-RU copies the stream of eCPRI messages only once for the connected
144 south-node and copied stream are forwarded to the south-node.
145 Similarly, the cascade O-RU combines once for the streams of
146 eCPRI messages received from the south node and the streams of radio
148 For FHM mode, FHM is able to copy the stream of eCPRI messages
149 according to this parameter and forward each copied stream
150 to each south-node. FHM is able to combine the streams of eCPRI
151 messages received from the multiple south-nodes corresponding to
152 this parameter at most.";
155 leaf max-number-eaxcid-copy {
161 "Indicates the maximum number of eaxc-ids for the copy functions
162 of cascade O-RU or FHM.
163 For Cascade, it is same number of static-low-level-tx-endpoints plus
164 static-low-level-rx-endpoints, for which low-level-tx(rx)-endpoints
165 are configured with eaxc-id in u-plane configuration.
166 For FHM, it is max configurable number of eaxc-ids in
167 tx-eaxc-id and rx-eaxc-id in shared-cell-copy-uplane-config.";
170 leaf max-number-eaxcid-combine {
176 "Indicates the maximum number of eaxc-ids for the combine functions
177 of cascade O-RU or FHM.
178 For Cascade, it is same number of static-low-level-rx-endpoints,
179 for which low-level-rx-endpoints are configured with eaxc-id in
180 u-plane configuration.
181 For FHM, it is max configurable number of eaxc-ids in rx-eaxc-id
182 in shared-cell-combine-uplane-config.";
185 list compression-method-supported {
188 "List of supported compression methods for FHM";
189 uses cf:compression-details;
194 // shared cell mode configuration
195 grouping shared-cell-mode{
197 "A grouping defining the schema nodes for shared cell configuration";
198 choice shared-cell-copy-combine-mode {
201 "all eCPRI payload are the target for copy and combine functions.
202 Common set of eaxc-ids are used in O-RU in the shared cell network.
203 For cascade mode, eaxc-ids of low-level-tx(rx)-links in
204 o-ran-uplane-configuration that has relation to the
205 processing-element are used.
206 For FHM mode, eaxc-ids of shared-cell-copy-uplane-config and
207 those of shared-cell-combine-config are used.";
209 uses shared-cell-copy-configuration;
210 uses shared-cell-combine-configuration;
213 description "for future use";
216 "configuration mode can be selected.
217 In this release, COMMON case is only supported.";
221 // processing elements set
222 grouping processing-element-set{
224 "shared-cell-copy/combine-configuration refers the pair of processing
225 element set of a north-node and a south-node.";
227 leaf north-node-processing-element{
229 path "/o-ran-pe:processing-elements/o-ran-pe:ru-elements/o-ran-pe:name";
232 "north-node processing element indicates the set of
233 'north-node-mac-address', 'ru-mac-address' and 'vlan-id' in case
234 north-eth-flow is selected for the transport flow.";
237 leaf-list south-node-processing-elements{
239 path "/o-ran-pe:processing-elements/o-ran-pe:ru-elements/o-ran-pe:name";
242 "south-node processing elements indicate the sets of
243 'south-node-mac-address', 'ru-mac-address' and 'vlan-id' in case
244 south-eth-flow is selected for the transport flow.";
246 } // processing-element-set
248 // shared cell copy and combine config
249 grouping shared-cell-copy-configuration{
251 "shared-cell-copy-configuration";
252 list shared-cell-copy-entities{
255 "copy entity. The north-node is an O-DU or an O-RU.
256 The south-nodes are O-RUs.
257 The number of south-nodes is at most one for cascade O-RU and
258 more than one for FHM";
263 "the name of shared-cell-copy-entity.";
266 uses processing-element-set;
268 container shared-cell-copy-uplane-config {
271 "Container consists of uplane-info for copy-configuration for FHM.";
276 "used for low-level-tx-endpoints to copy";
281 "encoded value of eaxcid to be read by CU-Plane";
287 "used for low-level-rx-endpoints to copy";
292 "encoded value of eaxcid to be read by CU-Plane";
298 } // shared-cell-copy-entities
299 } // shared-cell-copy-configuration (groupings)
301 grouping shared-cell-combine-configuration{
303 "shared-cell-combine-configuration";
305 list shared-cell-combine-entities{
308 "combine configuration. The north-node is O-DU or O-RU.
309 The south-nodes are O-RUs.
310 The number of south-nodes is at most one for cascade O-RU and
311 more than one for FHM";
316 "name of shared-cell-combine-entity";
319 uses processing-element-set;
325 "indicates the latest time that FHM or cascade O-RU is allowed to
326 send UL U-plane message to north-node relative to reception
327 timing at O-RU antenna.";
330 uses shared-cell-combine-uplane-config;
334 grouping shared-cell-combine-uplane-config{
336 "shared cell related uplane configuration applicable to O-RU which
337 doesn't have radio transmisison capability";
338 container shared-cell-combine-uplane-config {
341 "when O-RU doesn't have radio transmisison availability for FHM mode,
342 the required u-plane configuration for copy and combine function
343 are defined, instead of the lists of o-ran-uplane-conf.yang";
348 "used for low-level-rx-endpoints to combine";
352 "encoded value of eaxc-id to be read by CU-Plane";
354 container comression-method {
356 "for combine mechanism, compression method per eaxc-id applied in
357 south-node is known to FHM ";
358 uses cf:compression-details;
369 "Value of configurable N-TA offset
370 units are Tc=~0.5ns=1/1.96608GHz";
377 "Determines max number of PRBs that will be used in all sections
379 This value is used only when uplink C-plane message indicates that
380 all PRB is used in the field of numPrbc";
385 // top level container
386 container shared-cell{
388 "This container for shared-cell consists of capability information and
389 configurable parameters";
390 uses shared-cell-module-capability;
392 container shared-cell-config {
393 description "configuration for shared cell.";
394 uses shared-cell-mode;