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-12-10" {
52 1) added selective combining using beamId.";
54 reference "ORAN-WG4.M.0-v05.00";
57 revision "2020-04-17" {
61 1) initial version for shared cell O-RU related yang module.";
63 reference "ORAN-WG4.M.0-v03.00";
68 "Presence of feature indicates that O-RU acts as FHM and doesn't have
69 the capability of radio transmission and reception. Absence of feature
70 indicates that O-RU does not act as FHM and supports radio transmission
71 and reception function.";
74 feature SELECTIVE-BEAM-ID {
76 "Presence of feature indicates that FHM supports the selective combining
77 function by using beamId";
81 grouping radio-offset {
83 "shared cell FHM mode needs the configuration for radio related offset";
84 leaf downlink-radio-frame-offset {
91 "This parameter is used for offsetting the starting position of
93 Note: Unit is 1/1.2288e9 sec.";
96 leaf downlink-sfn-offset {
103 "This parameter is used for offsetting SFN value.
108 // shared cell capability
109 grouping shared-cell-module-capability{
111 "shared cell related module capability of O-RU";
112 container shared-cell-module-cap {
115 "indicates shared cell specific module capability";
122 "Corresponding to the maximum FHM or cascade O-RU processing delay
123 between receiving an IQ sample over the fronthaul interface from
124 the north-node, coping it and transmitting it over the fronthaul
125 interface to the south-node.";
133 "Corresponding to the maximum FHM or cascade O-RU processing delay
134 between receiving an IQ sample over the fronthaul interface from
135 the south-node(s), combing them and transmitting it over the
136 fronthaul interface to the north-node.";
139 leaf ta3-prime-max-upper-range {
144 "The upper limit for the configurable ta3-prime-max value.
145 This is the capability information of O-RU that comes from
146 the O-RU internal memory for the combine operation.";
149 leaf max-number-node-copy-and-combine {
155 "Indicates the maximum number of south-node for the copy-and-combine
156 functions of cascade O-RU or FHM.
157 For cascade mode, this value is one. It means
158 O-RU copies the stream of eCPRI messages only once for the connected
159 south-node and copied stream are forwarded to the south-node.
160 Similarly, the cascade O-RU combines once for the streams of
161 eCPRI messages received from the south node and the streams of radio
163 For FHM mode, FHM is able to copy the stream of eCPRI messages
164 according to this parameter and forward each copied stream
165 to each south-node. FHM is able to combine the streams of eCPRI
166 messages received from the multiple south-nodes corresponding to
167 this parameter at most.";
170 leaf max-number-eaxcid-copy {
176 "Indicates the maximum number of eaxc-ids for the copy functions
177 of cascade O-RU or FHM.
178 For Cascade, it is same number of static-low-level-tx-endpoints plus
179 static-low-level-rx-endpoints, for which low-level-tx(rx)-endpoints
180 are configured with eaxc-id in u-plane configuration.
181 For FHM, it is max configurable number of eaxc-ids in
182 tx-eaxc-id and rx-eaxc-id in shared-cell-copy-uplane-config.";
185 leaf max-number-eaxcid-combine {
191 "Indicates the maximum number of eaxc-ids for the combine functions
192 of cascade O-RU or FHM.
193 For Cascade, it is same number of static-low-level-rx-endpoints,
194 for which low-level-rx-endpoints are configured with eaxc-id in
195 u-plane configuration.
196 For FHM, it is max configurable number of eaxc-ids in rx-eaxc-id
197 in shared-cell-combine-uplane-config.";
200 list compression-method-supported {
203 "List of supported compression methods for FHM";
204 uses cf:compression-details;
209 // shared cell mode configuration
210 grouping shared-cell-mode{
212 "A grouping defining the schema nodes for shared cell configuration";
213 choice shared-cell-copy-combine-mode {
216 "all eCPRI payload are the target for copy and combine functions.
217 Common set of eaxc-ids are used in O-RU in the shared cell network.
218 For cascade mode, eaxc-ids of low-level-tx(rx)-links in
219 o-ran-uplane-configuration that has relation to the
220 processing-element are used.
221 For FHM mode, eaxc-ids of shared-cell-copy-uplane-config and
222 those of shared-cell-combine-config are used.";
224 uses shared-cell-copy-configuration;
225 uses shared-cell-combine-configuration;
227 case SELECTIVE-BEAM-ID {
228 if-feature "FHM and SELECTIVE-BEAM-ID";
230 "Case that FHM has selective transmission and reception fucntion
233 uses shared-cell-copy-configuration-for-selective-beam-id;
234 uses shared-cell-combine-configuration-for-selective-beam-id;
237 description "for future use";
240 "configuration mode can be selected.";
244 // processing elements set
245 grouping processing-element-set{
247 "shared-cell-copy/combine-configuration refers the pair of processing
248 element set of a north-node and a south-node.";
250 leaf north-node-processing-element{
252 path "/o-ran-pe:processing-elements/o-ran-pe:ru-elements/o-ran-pe:name";
255 "north-node processing element indicates the set of
256 'north-node-mac-address', 'ru-mac-address' and 'vlan-id' in case
257 north-eth-flow is selected for the transport flow.";
260 leaf-list south-node-processing-elements{
262 path "/o-ran-pe:processing-elements/o-ran-pe:ru-elements/o-ran-pe:name";
265 "south-node processing elements indicate the sets of
266 'south-node-mac-address', 'ru-mac-address' and 'vlan-id' in case
267 south-eth-flow is selected for the transport flow.";
269 } // processing-element-set
271 // processing elements set for SELECTIVE-BEAM-ID
272 grouping processing-element-set-for-selective-beam-id{
274 "shared-cell-copy/combine-configuration refers the pair of processing
275 element set of a north-node and a south-node.";
277 leaf north-node-processing-element{
279 path "/o-ran-pe:processing-elements/o-ran-pe:ru-elements/o-ran-pe:name";
282 "north-node processing element indicates the set of
283 'north-node-mac-address', 'ru-mac-address' and 'vlan-id' in case
284 north-eth-flow is selected for the transport flow.";
287 leaf-list south-node-processing-elements{
289 path "/o-ran-pe:processing-elements/o-ran-pe:ru-elements/o-ran-pe:name";
292 "south-node processing elements indicate the sets of
293 'south-node-mac-address', 'ru-mac-address' and 'vlan-id' in case
294 south-eth-flow is selected for the transport flow.";
297 list mapping-table-for-selective-beam-id {
298 key "global-beam-id south-node-processing-elements";
299 description "the mapping information between global-beam-id and local-beam-id";
304 "This parameter indicates the beam ID to be applied to the U-Plane data
305 on O-DU as same as existing beamId. One global beamId can be mapped
306 to one or multiple local beamId.
307 The mapping information between each global beamId, O-RU(s),
308 and local beamId is configured to the FHM during M-Plane start-up procedure.";
310 leaf south-node-processing-elements {
312 path "/o-ran-pe:processing-elements/o-ran-pe:ru-elements/o-ran-pe:name";
315 "south-node processing elements indicate the sets of
316 'south-node-mac-address', 'ru-mac-address' and 'vlan-id' in case
317 south-eth-flow is selected for the transport flow.";
321 description "This parameter indicates the beam ID to be applied to
322 the U-Plane data on O-RU as same as existing beamId.
323 In one O-RU, different beams can not map to one global beamId.
324 Local beamId shall be unique within O-RU.";
327 } // processing-element-set for SELECTIVE-BEAM-ID
329 // shared cell copy and combine config
330 grouping shared-cell-copy-configuration{
332 "shared-cell-copy-configuration";
333 list shared-cell-copy-entities{
336 "copy entity. The north-node is an O-DU or an O-RU.
337 The south-nodes are O-RUs.
338 The number of south-nodes is at most one for cascade O-RU and
339 more than one for FHM";
344 "the name of shared-cell-copy-entity.";
347 uses processing-element-set;
349 container shared-cell-copy-uplane-config {
352 "Container consists of uplane-info for copy-configuration for FHM.";
357 "used for low-level-tx-endpoints to copy";
362 "encoded value of eaxcid to be read by CU-Plane";
368 "used for low-level-rx-endpoints to copy";
373 "encoded value of eaxcid to be read by CU-Plane";
379 } // shared-cell-copy-entities
380 } // shared-cell-copy-configuration (groupings)
382 grouping shared-cell-copy-configuration-for-selective-beam-id{
384 "shared-cell-copy-configuration for selective function by beam id";
385 list shared-cell-copy-entities-selective-beam-id{
388 "copy entity. The north-node is an O-DU or an O-RU.
389 The south-nodes are O-RUs.
390 The number of south-nodes is at most one for cascade O-RU and
391 more than one for FHM";
396 "the name of shared-cell-copy-entity.";
399 uses processing-element-set-for-selective-beam-id;
401 container shared-cell-copy-uplane-config {
404 "Container consists of uplane-info for copy-configuration for FHM.";
409 "used for low-level-tx-endpoints to copy";
414 "encoded value of eaxcid to be read by CU-Plane";
420 "used for low-level-rx-endpoints to copy";
425 "encoded value of eaxcid to be read by CU-Plane";
431 } // shared-cell-copy-entities for SELECTIVE-BEAM-ID
432 } // shared-cell-copy-configuration (groupings) for SELECTIVE-BEAM-ID
434 grouping shared-cell-combine-configuration{
436 "shared-cell-combine-configuration";
438 list shared-cell-combine-entities{
441 "combine configuration. The north-node is O-DU or O-RU.
442 The south-nodes are O-RUs.
443 The number of south-nodes is at most one for cascade O-RU and
444 more than one for FHM";
449 "name of shared-cell-combine-entity";
452 uses processing-element-set;
458 "indicates the latest time that FHM or cascade O-RU is allowed to
459 send UL U-plane message to north-node relative to reception
460 timing at O-RU antenna.";
463 uses shared-cell-combine-uplane-config;
467 grouping shared-cell-combine-configuration-for-selective-beam-id{
469 "shared-cell-combine-configuration for selective function by beam id";
471 list shared-cell-combine-entities-for-selective-beam-id{
474 "combine configuration. The north-node is O-DU or O-RU.
475 The south-nodes are O-RUs.
476 The number of south-nodes is at most one for cascade O-RU and
477 more than one for FHM";
482 "name of shared-cell-combine-entity";
485 uses processing-element-set;
491 "indicates the latest time that FHM or cascade O-RU is allowed to
492 send UL U-plane message to north-node relative to reception
493 timing at O-RU antenna.";
496 uses shared-cell-combine-uplane-config;
501 grouping shared-cell-combine-uplane-config{
503 "shared cell related uplane configuration applicable to O-RU which
504 doesn't have radio transmisison capability";
505 container shared-cell-combine-uplane-config {
508 "when O-RU doesn't have radio transmisison availability for FHM mode,
509 the required u-plane configuration for copy and combine function
510 are defined, instead of the lists of o-ran-uplane-conf.yang";
515 "used for low-level-rx-endpoints to combine";
519 "encoded value of eaxc-id to be read by CU-Plane";
521 container comression-method {
523 "for combine mechanism, compression method per eaxc-id applied in
524 south-node is known to FHM ";
525 uses cf:compression-details;
536 "Value of configurable N-TA offset
537 units are Tc=~0.5ns=1/1.96608GHz";
544 "Determines max number of PRBs that will be used in all sections
546 This value is used only when uplink C-plane message indicates that
547 all PRB is used in the field of numPrbc";
552 // top level container
553 container shared-cell{
555 "This container for shared-cell consists of capability information and
556 configurable parameters";
557 uses shared-cell-module-capability;
559 container shared-cell-config {
560 description "configuration for shared cell.";
561 uses shared-cell-mode;