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 {
13 import o-ran-common-yang-types {
17 import o-ran-wg4-features {
21 import o-ran-usermgmt {
25 organization "O-RAN Alliance";
31 "This module defines the YANG definitions for shared cell capable O-RU (Cascade and FHM).
33 Copyright 2020 the O-RAN Alliance.
35 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS'
36 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
37 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
38 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
39 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
40 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
41 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
42 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
43 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
44 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
45 POSSIBILITY OF SUCH DAMAGE.
47 Redistribution and use in source and binary forms, with or without
48 modification, are permitted provided that the following conditions are met:
50 * Redistributions of source code must retain the above copyright notice,
51 this list of conditions and the above disclaimer.
52 * Redistributions in binary form must reproduce the above copyright notice,
53 this list of conditions and the above disclaimer in the documentation
54 and/or other materials provided with the distribution.
55 * Neither the Members of the O-RAN Alliance nor the names of its
56 contributors may be used to endorse or promote products derived from
57 this software without specific prior written permission.";
59 revision "2022-12-05" {
63 1) eaxc-id-group support in shared cell";
65 reference "ORAN-WG4.M.0-v11.00";
69 revision "2022-08-15" {
73 1) added SHARED-ORU-MULTI-OPERATOR anf SHARED-ORU-MULTI-ODU features";
75 reference "ORAN-WG4.M.0-v10.00";
77 revision "2021-12-01" {
81 1) typographical corrections in descriptions.
82 2) add support for multi-cell in cascade mode.
83 3) add SCS info and mapping with eaxc-id into Combine-entity.
84 4) add enhanced-t-combine feature Add T_combine-net (capability)
85 5) add Tx-duration, enhanced-t-combine-enabled";
87 reference "ORAN-WG4.M.0-v08.00";
90 revision "2020-12-10" {
94 1) added selective combining using beamId.";
96 reference "ORAN-WG4.M.0-v05.00";
99 revision "2020-04-17" {
103 1) initial version for shared cell O-RU related yang module.";
105 reference "ORAN-WG4.M.0-v03.00";
110 "Presence of feature indicates that O-RU acts as FHM and doesn't have
111 the capability of radio transmission and reception. Absence of feature
112 indicates that O-RU does not act as FHM and supports radio transmission
113 and reception function.";
116 feature SELECTIVE-BEAM-ID {
118 "Presence of feature indicates that FHM supports the selective combining
119 function by using beamId";
123 grouping radio-offset {
125 "shared cell FHM mode needs the configuration for radio related offset";
126 leaf downlink-radio-frame-offset {
133 "This parameter is used for offsetting the starting position of
135 Note: Unit is 1/1.2288e9 sec.";
138 leaf downlink-sfn-offset {
145 "This parameter is used for offsetting SFN value.
150 // shared cell capability
151 grouping shared-cell-module-capability{
153 "shared cell related module capability of O-RU";
154 container shared-cell-module-cap {
157 "indicates shared cell specific module capability";
164 "Corresponding to the maximum FHM or cascade O-RU processing delay
165 between receiving an IQ sample over the fronthaul interface from
166 the north-node, coping it and transmitting it over the fronthaul
167 interface to the south-node.";
175 "Corresponding to the maximum FHM or cascade O-RU processing delay
176 between receiving an IQ sample over the fronthaul interface from
177 the south-node(s), combing them and transmitting it over the
178 fronthaul interface to the north-node.
180 When enhanced-t-combine-enabled is 'true' by O-DU, FHM/Cascade O-RU supporting
181 ENHANCED-T-COMBINE uses t-combine-net and tx-duration instead of this value.";
188 "Corresponding to the maximum FHM or cascade O-RU processing delay
189 between starting time to combine IQ data from received message(s)
190 and starting time to transmit them with a message over the fronthaul
191 interface to O-DU or the north-node.";
194 leaf ta3-prime-max-upper-range {
199 "The upper limit for the configurable ta3-prime-max value.
200 This is the capability information of O-RU that comes from
201 the O-RU internal memory for the combine operation.";
204 leaf max-number-node-copy-and-combine {
210 "Indicates the maximum number of south-node for the copy-and-combine
211 functions of cascade O-RU or FHM.
212 For cascade mode, this value is one. It means
213 O-RU copies the stream of eCPRI messages only once for the connected
214 south-node and copied stream are forwarded to the south-node.
215 Similarly, the cascade O-RU combines once for the streams of
216 eCPRI messages received from the south node and the streams of radio
218 For FHM mode, FHM is able to copy the stream of eCPRI messages
219 according to this parameter and forward each copied stream
220 to each south-node. FHM is able to combine the streams of eCPRI
221 messages received from the multiple south-nodes corresponding to
222 this parameter at most.";
225 leaf max-number-eaxcid-copy {
231 "Indicates the maximum number of eaxc-ids for the copy functions
232 of cascade O-RU or FHM.
233 For Cascade O-RU, it is same number of static-low-level-tx-endpoints plus
234 static-low-level-rx-endpoints, for which low-level-tx(rx)-endpoints
235 are configured with eaxc-id in u-plane configuration.
236 For FHM, it is max configurable number of eaxc-ids in
237 tx-eaxc-id and rx-eaxc-id in shared-cell-copy-uplane-config.";
240 leaf max-number-eaxcid-combine {
246 "Indicates the maximum number of eaxc-ids for the combine functions
247 of cascade O-RU or FHM.
248 For Cascade O-RU, it is same number of static-low-level-rx-endpoints,
249 for which low-level-rx-endpoints are configured with eaxc-id in
250 u-plane configuration.
251 For FHM, it is max configurable number of eaxc-ids in rx-eaxc-id
252 in shared-cell-combine-uplane-config across all combine-enities.
254 When multiple scs or multiple c-plane section types with a single eaxc-id
255 are used for FHM supporting MULTIPLE-SCS-IN-EAXC, all eaxc-id instances
256 across scs, C-Plane section types and combine entities are counted even
257 though they are same eaxc-id. The counted number shall not excced this value.";
260 container eaxc-id-group-capabilities {
263 "Presence of this container indicates that FHM can refer to C-Plane in UL direction
264 to support combining U-Plane messages commanded by C-Plane with Section Extension 10.";
265 leaf max-num-rx-eaxc-id-groups {
268 "Maximum number of configurable rx-eaxc-id-group supported by FHM.";
271 leaf max-num-rx-eaxc-ids-per-group {
274 "Maximum number of member-rx-eaxc-id in single rx-eaxc-id-group supported by FHM.";
278 list compression-method-supported {
281 "List of supported compression methods for FHM";
282 uses cf:compression-details;
285 leaf multi-cell-in-cascade-mode-supported {
288 "This parameter indicates whether O-RU supports multi cell
289 operation in shared cell cascade mode.
290 If multi-cell-in-cascade-mode-supported = false then each shared cell
291 O-RU in a physical cascaded chain can only be used for operating
292 carriers that correspond to a single cell.
293 If multi-cell-in-cascade-mode-supported = true, it means that the O-RU
294 may be configured such that the shared-cell carriers can be used to
295 support mutiple different cells, where each cell is served by its own
296 separate cascade chain. See CUS-Plane Specification for more details.";
301 // shared cell mode configuration
302 grouping shared-cell-mode{
304 "A grouping defining the schema nodes for shared cell configuration";
305 choice shared-cell-copy-combine-mode {
308 "all eCPRI payload are the target for copy and combine functions.
309 Common set of eaxc-ids are used in O-RU in the shared cell network.
310 For cascade mode, eaxc-ids of low-level-tx(rx)-links in
311 o-ran-uplane-configuration that has relation to the
312 processing-element are used.
313 For FHM mode, eaxc-ids of shared-cell-copy-uplane-config and
314 those of shared-cell-combine-config are used.";
316 uses shared-cell-copy-configuration;
317 uses shared-cell-combine-configuration;
319 case SELECTIVE-BEAM-ID {
320 if-feature "FHM and SELECTIVE-BEAM-ID";
322 "Case that FHM has selective transmission and reception function
325 uses shared-cell-copy-configuration-for-selective-beam-id;
326 uses shared-cell-combine-configuration-for-selective-beam-id;
329 description "for future use";
332 "configuration mode can be selected.";
336 // processing elements set
337 grouping processing-element-set{
339 "shared-cell-copy/combine-configuration refers the pair of processing
340 element set of a north-node and a south-node.";
342 leaf north-node-processing-element{
344 path "/o-ran-pe:processing-elements/o-ran-pe:ru-elements/o-ran-pe:name";
347 "north-node processing element indicates the set of
348 'north-node-mac-address', 'ru-mac-address' and 'vlan-id' in case
349 north-eth-flow is selected for the transport flow.";
352 leaf-list south-node-processing-elements{
354 path "/o-ran-pe:processing-elements/o-ran-pe:ru-elements/o-ran-pe:name";
357 "south-node processing elements indicate the sets of
358 'south-node-mac-address', 'ru-mac-address' and 'vlan-id' in case
359 south-eth-flow is selected for the transport flow.";
361 } // processing-element-set
363 // processing elements set for SELECTIVE-BEAM-ID
364 grouping processing-element-set-for-selective-beam-id{
366 "shared-cell-copy/combine-configuration refers the pair of processing
367 element set of a north-node and a south-node.";
369 leaf north-node-processing-element{
371 path "/o-ran-pe:processing-elements/o-ran-pe:ru-elements/o-ran-pe:name";
374 "north-node processing element indicates the set of
375 'north-node-mac-address', 'ru-mac-address' and 'vlan-id' in case
376 north-eth-flow is selected for the transport flow.";
379 leaf-list south-node-processing-elements{
381 path "/o-ran-pe:processing-elements/o-ran-pe:ru-elements/o-ran-pe:name";
384 "south-node processing elements indicate the sets of
385 'south-node-mac-address', 'ru-mac-address' and 'vlan-id' in case
386 south-eth-flow is selected for the transport flow.";
389 list mapping-table-for-selective-beam-id {
390 key "global-beam-id south-node-processing-elements";
391 description "the mapping information between global-beam-id and local-beam-id";
396 "This parameter indicates the beam ID to be applied to the U-Plane data
397 on O-DU as same as existing beamId. One global beamId can be mapped
398 to one or multiple local beamId.
399 The mapping information between each global beamId, O-RU(s),
400 and local beamId is configured to the FHM during M-Plane start-up procedure.";
402 leaf south-node-processing-elements {
404 path "/o-ran-pe:processing-elements/o-ran-pe:ru-elements/o-ran-pe:name";
407 "south-node processing elements indicate the sets of
408 'south-node-mac-address', 'ru-mac-address' and 'vlan-id' in case
409 south-eth-flow is selected for the transport flow.";
413 description "This parameter indicates the beam ID to be applied to
414 the U-Plane data on O-RU as same as existing beamId.
415 In one O-RU, different beams can not map to one global beamId.
416 Local beamId shall be unique within O-RU.";
419 } // processing-element-set for SELECTIVE-BEAM-ID
421 // shared cell copy and combine config
422 grouping shared-cell-copy-configuration{
424 "shared-cell-copy-configuration";
425 list shared-cell-copy-entities{
428 "copy entity. The north-node is an O-DU or an O-RU.
429 The south-nodes are O-RUs.
430 The number of south-nodes is at most one for cascade O-RU and
431 more than one for FHM";
436 "the name of shared-cell-copy-entity.";
440 if-feature feat:SHARED-ORU-MULTI-ODU;
443 "An optional o-du identity associated with this list entry.
444 When present, indicates that the list entry is associated with
445 a particular odu-id.";
449 if-feature feat:SHARED-ORU-MULTI-OPERATOR;
451 path "/or-user:users/or-user:user/or-user:sro-id";
454 "An optional shared resource identity associated with this list entry.
455 When present, indicates that the list entry corresponds to a shared cell copy entity
456 associated with a shared resouce operator where the sro-id
457 identifies the specific shared resouce operator.
459 This schema-node is used to refince NACM privileges for shared
463 uses processing-element-set;
465 container shared-cell-copy-uplane-config {
468 "Container consists of uplane-info for copy-configuration for FHM.";
473 "used for low-level-tx-endpoints to copy";
478 "encoded value of eaxcid to be read by CU-Plane";
484 "used for low-level-rx-endpoints to copy";
489 "encoded value of eaxcid to be read by CU-Plane";
495 } // shared-cell-copy-entities
496 } // shared-cell-copy-configuration (groupings)
498 grouping shared-cell-copy-configuration-for-selective-beam-id{
500 "shared-cell-copy-configuration for selective function by beam id";
501 list shared-cell-copy-entities-selective-beam-id{
504 "copy entity. The north-node is an O-DU or an O-RU.
505 The south-nodes are O-RUs.
506 The number of south-nodes is at most one for cascade O-RU and
507 more than one for FHM";
512 "the name of shared-cell-copy-entity.";
516 if-feature feat:SHARED-ORU-MULTI-ODU;
519 "An optional o-du identity associated with this list entry.
520 When present, indicates that the list entry is associated with
521 a particular odu-id.";
525 if-feature feat:SHARED-ORU-MULTI-OPERATOR;
527 path "/or-user:users/or-user:user/or-user:sro-id";
530 "An optional shared resource identity associated with this list entry.
531 When present, indicates that the list entry corresponds to a shared cell copy entity
532 with selective bean id associated with a shared resouce operator where the sro-id
533 identifies the specific shared resouce operator.
535 This schema-node is used to refince NACM privileges for shared
539 uses processing-element-set-for-selective-beam-id;
541 container shared-cell-copy-uplane-config {
544 "Container consists of uplane-info for copy-configuration for FHM.";
549 "used for low-level-tx-endpoints to copy";
554 "encoded value of eaxcid to be read by CU-Plane";
560 "used for low-level-rx-endpoints to copy";
565 "encoded value of eaxcid to be read by CU-Plane";
571 } // shared-cell-copy-entities for SELECTIVE-BEAM-ID
572 } // shared-cell-copy-configuration (groupings) for SELECTIVE-BEAM-ID
574 grouping shared-cell-combine-configuration{
576 "shared-cell-combine-configuration";
578 list shared-cell-combine-entities{
581 "combine configuration. The north-node is O-DU or O-RU.
582 The south-nodes are O-RUs.
583 The number of south-nodes is at most one for cascade O-RU and
584 more than one for FHM";
589 "name of shared-cell-combine-entity";
593 if-feature feat:SHARED-ORU-MULTI-ODU;
596 "An optional o-du identity associated with this list entry.
597 When present, indicates that the list entry is associated with
598 a particular odu-id.";
602 if-feature feat:SHARED-ORU-MULTI-OPERATOR;
604 path "/or-user:users/or-user:user/or-user:sro-id";
607 "An optional shared resource identity associated with this list entry.
608 When present, indicates that the list entry corresponds to a shared cell combine entity
609 associated with a shared resouce operator where the sro-id
610 identifies the specific shared resouce operator.
612 This schema-node is used to refince NACM privileges for shared
617 uses processing-element-set;
620 type o-ran-cmn:scs-config-type;
622 "sub-carrier spacing of U-Plane messages belong to combine-entity";
629 "indicates the latest time that FHM or cascade O-RU is allowed to
630 send UL U-plane message to north-node relative to reception
631 timing at O-RU antenna.";
638 "informs FHM/Cascade O-RU of the maximum duration time of transmission
639 over the fronthaul interface to O-DU or north-node for messages
640 to be sent within Ta3-prime-max.";
643 uses shared-cell-combine-uplane-config;
647 grouping shared-cell-combine-configuration-for-selective-beam-id{
649 "shared-cell-combine-configuration for selective function by beam id";
651 list shared-cell-combine-entities-for-selective-beam-id{
654 "combine configuration. The north-node is O-DU or O-RU.
655 The south-nodes are O-RUs.
656 The number of south-nodes is at most one for cascade O-RU and
657 more than one for FHM";
662 "name of shared-cell-combine-entity";
666 if-feature feat:SHARED-ORU-MULTI-ODU;
669 "An optional o-du identity associated with this list entry.
670 When present, indicates that the list entry is associated with
671 a particular odu-id.";
675 if-feature feat:SHARED-ORU-MULTI-OPERATOR;
677 path "/or-user:users/or-user:user/or-user:sro-id";
680 "An optional shared resource identity associated with this list entry.
681 When present, indicates that the list entry corresponds to a shared cell combine entity
682 for selective beam id associated with a shared resouce operator where the sro-id
683 identifies the specific shared resouce operator.
685 This schema-node is used to refince NACM privileges for shared
689 uses processing-element-set;
692 type o-ran-cmn:scs-config-type;
694 "sub-carrier spacing of U-Plane messages belong to combine-entity";
701 "indicates the latest time that FHM or cascade O-RU is allowed to
702 send UL U-plane message to north-node relative to reception
703 timing at O-RU antenna.";
710 "informs FHM/Cascade O-RU of the maximum duration time of transmission
711 over the fronthaul interface to O-DU or north-node for messages
712 to be sent within Ta3-prime-max.";
715 uses shared-cell-combine-uplane-config;
720 grouping shared-cell-combine-uplane-config{
722 "shared cell related uplane configuration applicable to O-RU which
723 doesn't have radio transmission capability";
724 container shared-cell-combine-uplane-config {
727 "when O-RU doesn't have radio transmission availability for FHM mode,
728 the required u-plane configuration for copy and combine function
729 are defined, instead of the lists of o-ran-uplane-conf.yang";
734 "used for low-level-rx-endpoints to combine";
738 "encoded value of eaxc-id to be read by CU-Plane";
744 "Determines max number of PRBs that can be scheduled in all sections
746 This value is used when uplink C-plane message indicates that all PRBs
747 is indicated in the field of numPrbc or tx-duration is calculated.";
750 leaf-list cp-ul-section-type {
754 "section type 1 is used.";
758 "section type 3 is used for PRACH .";
762 "section type 3 is used for PUxCH when mixed numeroloy is applied.";
766 "indicates what section type is used for a specific eaxc-id with a specfic
767 SCS/frameStructure which belongs to this combine-entity.";
770 container comression-method {
772 "for combine mechanism, compression method per eaxc-id applied in
773 south-node is known to FHM ";
774 uses cf:compression-details;
785 "Value of configurable N-TA offset
786 units are Tc=~0.5ns=1/1.96608GHz";
794 "Determines max number of PRBs that will be used in all sections
796 This value is used only when uplink C-plane message indicates that
797 all PRB is used in the field of numPrbc
799 This node is deprecated and replaced by number-of-prb in the list of rx-eaxc-id.
800 This movement is intended to prevent the fragmentation of shared-cell-combine-entities
801 according to the different value of number-of-prb.";
806 // top-level container
807 container shared-cell{
809 "This container for shared-cell consists of capability information and
810 configurable parameters";
811 uses shared-cell-module-capability;
813 container shared-cell-config {
814 description "configuration for shared cell.";
815 uses shared-cell-mode;
817 leaf max-num-rx-eaxc-ids-per-group {
820 path "/o-ran-sc:shared-cell/o-ran-sc:shared-cell-module-cap/o-ran-sc:eaxc-id-group-capabilities/o-ran-sc:max-num-rx-eaxc-ids-per-group";
821 require-instance false;
823 description "RW value of max-num-rx-eaxc-ids-per-group";
825 leaf max-num-rx-eaxc-id-groups {
828 path "/o-ran-sc:shared-cell/o-ran-sc:shared-cell-module-cap/o-ran-sc:eaxc-id-group-capabilities/o-ran-sc:max-num-rx-eaxc-id-groups";
829 require-instance false;
831 description "RW value of max-num-rx-eaxc-id-groups";
834 list rx-eaxc-id-group {
836 must "count(../rx-eaxc-id-group) <= ../max-num-rx-eaxc-id-groups" {
837 error-message "too many rx-eaxcid-id groups";
839 key "representative-rx-eaxc-id";
841 "This is a list of the groups of the eAxC IDs.
842 Each group is a union of a 'representative-rx-eaxc-id'and 'member-rx-eaxc-id's.
843 When section type 3 C-Plane in UL direction is used with Section Extension 10 in the shared cell,
844 this group shall be informed to FHM.";
845 leaf representative-rx-eaxc-id {
848 "This parameter contains eAxC_ID that populates content of C-Plane section
849 extension 10 to eAxC_IDs configured in the group as 'member-rx-eaxc-id'(s).";
851 leaf-list member-rx-eaxc-id {
853 must "count(../member-rx-eaxc-id) <= ../../max-num-rx-eaxc-ids-per-group" {
854 error-message "too many rx-eaxcid-id members";
856 must "current()!=../representative-rx-eaxc-id" {
857 error-message "the representative eaxcid does not need to be a list member";
860 "This is a list of member eAxC IDs,which is associated with 'representative-rx-eaxc-id' in a group.";
864 leaf enhanced-t-combine-enabled {
865 if-feature feat:ENHANCED-T-COMBINE;
869 "O-DU informs FHM/Cascade O-RU that t-combine-net and tx-duration
870 are used to calculate T-waiting instead of t-combine.";
873 leaf multiple-scs-in-eaxc-used {
874 if-feature feat:MULTIPLE-SCS-IN-EAXC;
878 "O-DU informs FHM/Cascade O-RU that multiple scs or
879 multiple section types in a single eAxC id are used.";