1 module o-ran-module-cap {
3 namespace "urn:o-ran:module-cap:1.0";
4 prefix "o-ran-module-cap";
6 import o-ran-compression-factors {
10 organization "O-RAN Alliance";
16 "This module defines the module capabilities for
19 Copyright 2019 the O-RAN Alliance.
21 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS'
22 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
25 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 POSSIBILITY OF SUCH DAMAGE.
33 Redistribution and use in source and binary forms, with or without
34 modification, are permitted provided that the following conditions are met:
36 * Redistributions of source code must retain the above copyright notice,
37 this list of conditions and the above disclaimer.
38 * Redistributions in binary form must reproduce the above copyright notice,
39 this list of conditions and the above disclaimer in the documentation
40 and/or other materials provided with the distribution.
41 * Neither the Members of the O-RAN Alliance nor the names of its
42 contributors may be used to endorse or promote products derived from
43 this software without specific prior written permission.";
45 revision "2019-07-03" {
49 1) backward compatible change to introduce new RW leafs for use in
50 constraints in uplane-config and laa models.
51 2) removing unnecessary relations to band 46 in uplink";
53 reference "ORAN-WG4.M.0-v01.00";
56 revision "2019-02-04" {
60 1) imported model from xRAN
61 2) changed namespace and reference from xran to o-ran";
63 reference "ORAN-WG4.M.0-v01.00";
68 "Indicates that the Radio Unit supports LAA.";
71 feature TRANSPORT-FRAGMENTATION {
73 "This leaf is used to indicate whether the O-RU supports O-RAN Radio Transport Fragmentation";
76 typedef sub-band-string {
80 description "Sub bands definition";
83 typedef scs-config-type {
88 "15kHz sub carrier spacing";
93 "30kHz sub carrier spacing";
98 "60kHz sub carrier spacing";
103 "120kHz sub carrier spacing";
108 "240kHz sub carrier spacing";
113 "1,25kHz sub carrier spacing";
118 "3.75kHz sub carrier spacing";
123 "5kHz sub carrier spacing";
128 "7.5kHz sub carrier spacing";
133 "Scs configuration type definition";
136 grouping compression-method-grouping {
138 "Grouping for compression method.";
140 leaf compression-method {
142 enum BLOCK_FLOATING_POINT {
144 "Block floating point compression and decompression will be used";
149 "Block scaling compression and decompresion will be used";
154 "u-Law compression and decompresion method will be used";
159 "Beamspace compression and decompression will be used";
164 "Modulation compression and decompression will be used";
168 "Compresion method which can be supported by the O-RU";
172 grouping sub-band-max-min-ul-dl-frequency {
174 "Grouping for defining max and min supported frequency - dl and ul.";
176 leaf max-supported-frequency-dl {
179 "This value indicates Maximum supported downlink frequency in the
180 LAA subband. Value unit is Hz.";
183 leaf min-supported-frequency-dl {
186 "This value indicates Minimum supported downlink frequency in the
187 LAA subband. Value unit is Hz.";
191 grouping format-of-iq-sample {
193 "Indicates module capabilities about IQ samples";
195 leaf dynamic-compression-supported {
199 "Informs if radio supports dynamic compression method";
202 leaf realtime-variable-bit-width-supported {
206 "Informs if O-RU supports realtime variable bit with";
209 list compression-method-supported {
210 uses cf:compression-details;
213 "List of supported compression methods by O-RU";
216 leaf variable-bit-width-per-channel-supported {
217 when "/module-capability/ru-capabilities/format-of-iq-sample/realtime-variable-bit-width-supported = 'true'";
221 "Informs if variable bit width per channel is supported or not";
224 leaf syminc-supported {
228 "Informs if symbol number increment command in a C-Plane is
235 "Grouping for scs-a and scs-b";
237 type scs-config-type;
239 "Sub-carrier spacing configuration";
242 type scs-config-type;
244 "Sub-carrier spacing configuration";
248 grouping ul-mixed-num-required-guard-rbs {
250 "Required number of guard resource blocks for the combination of
251 subcarrier spacing values for uplink";
253 leaf number-of-guard-rbs-ul{
256 "This value indicates the required number of guard resource blocks
257 between the mixed numerologies, the RB using scs-a and the RB
258 using scs-b. It's number is based on scs-a";
262 grouping dl-mixed-num-required-guard-rbs {
264 "Required number of guard resource blocks for the combination of
265 subcarrier spacing values for uplink";
267 leaf number-of-guard-rbs-dl{
270 "This value indicates the required number of guard resource blocks
271 between the mixed numerologies, the RB using scs-a and the RB
272 using scs-b. It's number is based on scs-a";
276 grouping ru-capabilities {
278 "Structure representing set of capabilities.";
280 leaf ru-supported-category {
284 "Informs that precoding is not supported in O-RU";
288 "Informs that precoding is supported in O-RU";
293 "Informs about which category O-RU supports";
296 leaf number-of-ru-ports {
299 "Assuming all endpoints support time-managed traffic AND non-time-managed traffic (choice is as per configuration)
300 - the number of O-RU ports is the product of number of spatial streams (leaf number-of-spatial-streams) and number of numerologies O-RU supports.
301 For example, if the number of spatial streams is 4 then the number of O-RU ports is 8 when PUSCH and PRACH are processed in the different endpoints.
302 In case there are specific endpoints that support non-time-managed traffic only
303 - the number of O-RU ports calculated with above mentioned equation is extended by number of endpoints supporting only non-time-managed traffic.";
306 leaf number-of-spatial-streams {
309 "This value indicates the number of spatial streams supported at O-RU for DL and UL.
310 For DL, it is same as the number of antenna ports specified in 3GPP TS38.214, Section 5.2 and 3GPP TS36.213, Section 5.2.";
313 leaf max-power-per-pa-antenna {
318 "This value indicates Maximum Power per PA per antenna. Value unit is dBm.";
321 leaf min-power-per-pa-antenna {
326 "This value indicates Minimum Power per PA per antenna. Value unit is dBm.";
329 leaf fronthaul-split-option {
334 "This value indicates the Fronthaul Split Option, i.e., 2 or 7 in this release.";
337 container format-of-iq-sample {
339 "Indicates module capabilities about IQ samples";
341 uses format-of-iq-sample;
344 list ul-mixed-num-required-guard-rbs {
347 "List of required number of guard resource blocks
348 for the combination of subcarrier spacing values for downlink";
350 uses ul-mixed-num-required-guard-rbs;
352 list dl-mixed-num-required-guard-rbs {
355 "List of required number of guard resource blocks
356 for the combination of subcarrier spacing values for uplink";
358 uses dl-mixed-num-required-guard-rbs;
361 leaf energy-saving-by-transmission-blanks {
365 "Parameter informs if unit supports energy saving by transmission blanking";
368 leaf dynamic-transport-delay-management-supported {
372 "Parameter informs if unit supports dynamic transport delay management through eCPRI Msg 5";
376 grouping sub-band-info {
377 description "container for collection of leafs for LAA subband 46";
378 list sub-band-frequency-ranges {
380 description "frequency information on a per sub-band basis";
382 type sub-band-string;
383 description "Sub band when band 46";
385 uses sub-band-max-min-ul-dl-frequency;
387 leaf number-of-laa-scarriers {
390 "This value indicates the number of LAA secondary carriers supported at O-RU.";
393 leaf maximum-laa-buffer-size {
396 "Maximum O-RU buffer size in Kilobytes (KB) per CC. This parameter is
397 needed at the O-DU to know how much data can be sent in advance
398 and stored at the O-RU to address the LBT uncertainity.";
401 leaf maximum-processing-time {
405 "Maximum O-RU Processing time in microseconds at the O-RU to handle the
406 received/transmitted packets from/to the O-DU. This parameter is
407 needed at the O-DU to determine the time where it needs to send
408 the data to the O-RU.";
411 leaf self-configure {
413 description "This value indicates that the O-RU can manage the contention window locally. ";
417 grouping support-for-dl {
419 "Grouping for DL specific parameters";
421 leaf max-supported-frequency-dl {
424 "This value indicates Maximum supported downlink frequency. Value unit is Hz.";
427 leaf min-supported-frequency-dl {
430 "This value indicates Minimum supported downlink frequency. Value unit is Hz.";
433 leaf max-supported-bandwidth-dl {
436 "This value indicates Maximum total downlink bandwidth in module. Value unit is Hz.";
439 leaf max-num-carriers-dl {
442 "This value indicates Maximum number of downlink carriers in module.";
445 leaf max-carrier-bandwidth-dl {
448 "This value indicates Maximum bandwidth per downlink carrier. Value unit is Hz.";
451 leaf min-carrier-bandwidth-dl {
454 "This value indicates Minimum bandwidth per downlink carrier. Value unit is Hz.";
458 grouping support-for-ul {
460 "Grouping for UL specific parameters";
462 leaf max-supported-frequency-ul {
465 "This value indicates Maximum supported uplink frequency. Value unit is Hz.";
468 leaf min-supported-frequency-ul {
471 "This value indicates Minimum supported uplink frequency. Value unit is Hz.";
474 leaf max-supported-bandwidth-ul {
477 "This value indicates Maximum total uplink bandwidth in module. Value unit is Hz.";
480 leaf max-num-carriers-ul {
483 "This value indicates Maximum number of uplink carriers in module.";
486 leaf max-carrier-bandwidth-ul {
489 "This value indicates Maximum bandwidth per uplink carrier. Value unit is Hz.";
492 leaf min-carrier-bandwidth-ul {
495 "This value indicates Minimum bandwidth per uplink carrier. Value unit is Hz.";
499 grouping band-capabilities {
501 "Capabilities that are needed to be defined per each band";
509 container sub-band-info {
510 when "../band-number = '46'";
511 if-feature "o-ran-module-cap:LAA";
512 description "container for collection of leafs for LAA subband 46";
519 leaf max-num-component-carriers {
521 description "maximum number of component carriers supported by the O-RU";
526 description "maximum number of bands supported by the O-RU";
529 leaf max-num-sectors {
531 description "maximum number of sectors supported by the O-RU";
534 leaf max-power-per-antenna {
539 "This value indicates Maximum Power per band per antenna. Value unit is dBm.";
542 leaf min-power-per-antenna {
547 "This value indicates Minimum Power per band per antenna. Value unit is dBm.";
550 leaf codebook-configuration_ng {
553 "This parameter informs the precoder codebook_ng that are used for precoding";
556 leaf codebook-configuration_n1 {
559 "This parameter informs the precoder codebook_n1 that are used for precoding";
562 leaf codebook-configuration_n2 {
565 "This parameter informs the precoder codebook_n2 that are used for precoding";
569 container module-capability {
572 "module capability object responsible for providing module capability.";
574 container ru-capabilities {
577 "Structure representing set of capabilities.";
579 uses ru-capabilities;
582 list band-capabilities {
586 "Capabilities that are needed to be defined per each band";
588 uses band-capabilities;
590 container rw-sub-band-info {
591 if-feature "o-ran-module-cap:LAA";
592 description "config true leafrefs for use as constraints for config true leafs";
593 leaf rw-number-of-laa-scarriers {
595 path "/module-capability/band-capabilities/sub-band-info/number-of-laa-scarriers";
596 require-instance false;
599 "This value indicates the number of LAA secondary carriers supported at O-RU.";
601 leaf rw-self-configure {
603 path "/module-capability/band-capabilities/sub-band-info/self-configure";
604 require-instance false;
607 "This value indicates that the O-RU can manage the contention window locally.";