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-02-04" {
49 1) imported model from xRAN
50 2) changed namespace and reference from xran to o-ran";
52 reference "ORAN-WG4.M.0-v01.00";
57 "Indicates that the Radio Unit supports LAA.";
60 feature TRANSPORT-FRAGMENTATION {
62 "This leaf is used to indicate whether the O-RU supports O-RAN Radio Transport Fragmentation";
65 typedef sub-band-string {
69 description "Sub bands definition";
72 typedef scs-config-type {
77 "15kHz sub carrier spacing";
82 "30kHz sub carrier spacing";
87 "60kHz sub carrier spacing";
92 "120kHz sub carrier spacing";
97 "240kHz sub carrier spacing";
102 "1,25kHz sub carrier spacing";
107 "3.75kHz sub carrier spacing";
112 "5kHz sub carrier spacing";
117 "7.5kHz sub carrier spacing";
122 "Scs configuration type definition";
125 grouping compression-method-grouping {
127 "Grouping for compression method.";
129 leaf compression-method {
131 enum BLOCK_FLOATING_POINT {
133 "Block floating point compression and decompression will be used";
138 "Block scaling compression and decompresion will be used";
143 "u-Law compression and decompresion method will be used";
148 "Beamspace compression and decompression will be used";
153 "Modulation compression and decompression will be used";
157 "Compresion method which can be supported by the O-RU";
161 grouping sub-band-max-min-ul-dl-frequency {
163 "Grouping for defining max and min supported frequency - dl and ul.";
165 leaf max-supported-frequency-dl {
168 "This value indicates Maximum supported downlink frequency in the
169 LAA subband. Value unit is Hz.";
172 leaf min-supported-frequency-dl {
175 "This value indicates Minimum supported downlink frequency in the
176 LAA subband. Value unit is Hz.";
180 grouping format-of-iq-sample {
182 "Indicates module capabilities about IQ samples";
184 leaf dynamic-compression-supported {
188 "Informs if radio supports dynamic compression method";
191 leaf realtime-variable-bit-width-supported {
195 "Informs if O-RU supports realtime variable bit with";
198 list compression-method-supported {
199 key "iq-bitwidth compression-type";
200 uses cf:compression-details;
203 "List of supported compression methods by O-RU";
206 leaf variable-bit-width-per-channel-supported {
207 when "/module-capability/ru-capabilities/format-of-iq-sample/realtime-variable-bit-width-supported = 'true'";
211 "Informs if variable bit width per channel is supported or not";
214 leaf syminc-supported {
218 "Informs if symbol number increment command in a C-Plane is
225 "Grouping for scs-a and scs-b";
227 type scs-config-type;
229 "Sub-carrier spacing configuration";
232 type scs-config-type;
234 "Sub-carrier spacing configuration";
238 grouping ul-mixed-num-required-guard-rbs {
240 "Required number of guard resource blocks for the combination of
241 subcarrier spacing values for uplink";
243 leaf number-of-guard-rbs-ul{
246 "This value indicates the required number of guard resource blocks
247 between the mixed numerologies, the RB using scs-a and the RB
248 using scs-b. It's number is based on scs-a";
252 grouping dl-mixed-num-required-guard-rbs {
254 "Required number of guard resource blocks for the combination of
255 subcarrier spacing values for uplink";
257 leaf number-of-guard-rbs-dl{
260 "This value indicates the required number of guard resource blocks
261 between the mixed numerologies, the RB using scs-a and the RB
262 using scs-b. It's number is based on scs-a";
266 grouping ru-capabilities {
268 "Structure representing set of capabilities.";
270 leaf ru-supported-category {
274 "Informs that precoding is not supported in O-RU";
278 "Informs that precoding is supported in O-RU";
283 "Informs about which category O-RU supports";
286 leaf number-of-ru-ports {
289 "Assuming all endpoints support time-managed traffic AND non-time-managed traffic (choice is as per configuration)
290 - 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.
291 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.
292 In case there are specific endpoints that support non-time-managed traffic only
293 - the number of O-RU ports calculated with above mentioned equation is extended by number of endpoints supporting only non-time-managed traffic.";
296 leaf number-of-spatial-streams {
299 "This value indicates the number of spatial streams supported at O-RU for DL and UL.
300 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.";
303 leaf max-power-per-pa-antenna {
308 "This value indicates Maximum Power per PA per antenna. Value unit is dBm.";
311 leaf min-power-per-pa-antenna {
316 "This value indicates Minimum Power per PA per antenna. Value unit is dBm.";
319 leaf fronthaul-split-option {
324 "This value indicates the Fronthaul Split Option, i.e., 2 or 7 in this release.";
327 container format-of-iq-sample {
329 "Indicates module capabilities about IQ samples";
331 uses format-of-iq-sample;
334 list ul-mixed-num-required-guard-rbs {
337 uses ul-mixed-num-required-guard-rbs;
339 list dl-mixed-num-required-guard-rbs {
342 uses dl-mixed-num-required-guard-rbs;
345 leaf energy-saving-by-transmission-blanks {
349 "Parameter informs if unit supports energy saving by transmission blanking";
352 leaf dynamic-transport-delay-management-supported {
356 "Parameter informs if unit supports dynamic transport delay management through eCPRI Msg 5";
360 grouping sub-band-info {
361 description "container for collection of leafs for LAA subband 46";
362 list sub-band-frequency-ranges {
364 description "frequency information on a per sub-band basis";
366 type sub-band-string;
367 description "Sub band when band 46";
369 uses sub-band-max-min-ul-dl-frequency;
371 leaf number-of-laa-scarriers {
374 "This value indicates the number of LAA secondary carriers supported at O-RU.";
377 leaf maximum-laa-buffer-size {
380 "Maximum O-RU buffer size in Kilobytes (KB) per CC. This parameter is
381 needed at the O-DU to know how much data can be sent in advance
382 and stored at the O-RU to address the LBT uncertainity.";
385 leaf maximum-processing-time {
389 "Maximum O-RU Processing time in microseconds at the O-RU to handle the
390 received/transmitted packets from/to the O-DU. This parameter is
391 needed at the O-DU to determine the time where it needs to send
392 the data to the O-RU.";
395 leaf self-configure {
397 description "This value indicates that the O-RU can manage the contention window locally. ";
401 grouping support-for-dl {
403 "Grouping for DL specific parameters";
405 leaf max-supported-frequency-dl {
408 "This value indicates Maximum supported downlink frequency. Value unit is Hz.";
411 leaf min-supported-frequency-dl {
414 "This value indicates Minimum supported downlink frequency. Value unit is Hz.";
417 leaf max-supported-bandwidth-dl {
420 "This value indicates Maximum total downlink bandwidth in module. Value unit is Hz.";
423 leaf max-num-carriers-dl {
426 "This value indicates Maximum number of downlink carriers in module.";
429 leaf max-carrier-bandwidth-dl {
432 "This value indicates Maximum bandwidth per downlink carrier. Value unit is Hz.";
435 leaf min-carrier-bandwidth-dl {
438 "This value indicates Minimum bandwidth per downlink carrier. Value unit is Hz.";
442 grouping support-for-ul {
444 "Grouping for UL specific parameters";
446 leaf max-supported-frequency-ul {
447 when "../band-number != '46'";
450 "This value indicates Maximum supported uplink frequency. Value unit is Hz.";
453 leaf min-supported-frequency-ul {
454 when "../band-number != '46'";
457 "This value indicates Minimum supported uplink frequency. Value unit is Hz.";
460 leaf max-supported-bandwidth-ul {
461 when "../band-number != '46'";
464 "This value indicates Maximum total uplink bandwidth in module. Value unit is Hz.";
467 leaf max-num-carriers-ul {
468 when "../band-number != '46'";
471 "This value indicates Maximum number of uplink carriers in module.";
474 leaf max-carrier-bandwidth-ul {
475 when "../band-number != '46'";
478 "This value indicates Maximum bandwidth per uplink carrier. Value unit is Hz.";
481 leaf min-carrier-bandwidth-ul {
482 when "../band-number != '46'";
485 "This value indicates Minimum bandwidth per uplink carrier. Value unit is Hz.";
489 grouping band-capabilities {
491 "Capabilities that are needed to be defined per each band";
499 container sub-band-info {
500 when "../band-number = '46'";
501 if-feature "o-ran-module-cap:LAA";
502 description "container for collection of leafs for LAA subband 46";
509 leaf max-num-component-carriers {
511 description "maximum number of component carriers supported by the O-RU";
516 description "maximum number of bands supported by the O-RU";
519 leaf max-num-sectors {
521 description "maximum number of sectors supported by the O-RU";
524 leaf max-power-per-antenna {
529 "This value indicates Maximum Power per band per antenna. Value unit is dBm.";
532 leaf min-power-per-antenna {
537 "This value indicates Minimum Power per band per antenna. Value unit is dBm.";
540 leaf codebook-configuration_ng {
543 "This parameter informs the precoder codebook_ng that are used for precoding";
546 leaf codebook-configuration_n1 {
549 "This parameter informs the precoder codebook_n1 that are used for precoding";
552 leaf codebook-configuration_n2 {
555 "This parameter informs the precoder codebook_n2 that are used for precoding";
559 container module-capability {
562 "module capability object responsible for providing module capability.";
564 container ru-capabilities {
566 "Structure representing set of capabilities.";
568 uses ru-capabilities;
571 list band-capabilities {
574 "Capabilities that are needed to be defined per each band";
576 uses band-capabilities;