1 module o-ran-compression-factors {
3 namespace "urn:o-ran:compression-factors:1.0";
4 prefix "o-ran-compression-factors";
7 organization "O-RAN Alliance";
13 "This module defines the module capabilities for
14 the O-RAN Radio Unit U-Plane configuration.
16 Copyright 2020 the O-RAN Alliance.
18 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS'
19 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 POSSIBILITY OF SUCH DAMAGE.
30 Redistribution and use in source and binary forms, with or without
31 modification, are permitted provided that the following conditions are met:
33 * Redistributions of source code must retain the above copyright notice,
34 this list of conditions and the above disclaimer.
35 * Redistributions in binary form must reproduce the above copyright notice,
36 this list of conditions and the above disclaimer in the documentation
37 and/or other materials provided with the distribution.
38 * Neither the Members of the O-RAN Alliance nor the names of its
39 contributors may be used to endorse or promote products derived from
40 this software without specific prior written permission.";
42 revision "2020-08-10" {
46 1) supporting compression types per endpoint
47 2) adding feature for configurable fs-offset for compression";
49 reference "ORAN-WG4.M.0-v04.00";
52 revision "2020-04-17" {
56 1) adding selective RE sending compression types";
58 reference "ORAN-WG4.M.0-v03.00";
61 revision "2019-07-03" {
65 1) changes related to compression bitwidth presentation";
67 reference "ORAN-WG4.M.0-v01.00";
70 revision "2019-02-04" {
74 1) imported model from xRAN
75 2) changed namespace and reference from xran to o-ran";
77 reference "ORAN-WG4.M.0-v01.00";
80 feature CONFIGURABLE-FS-OFFSET {
82 "Presence of this feature means that O-RU supports configurable fs-offset for compression.";
85 grouping compression-method-grouping {
87 "Grouping for compression method.";
92 "Bitwidth to be used in compression";
95 leaf compression-method {
99 "No compression will be used";
101 enum BLOCK_FLOATING_POINT {
103 "Block floating point compression and decompression will be used";
108 "Block scaling compression and decompresion will be used";
113 "u-Law compression and decompresion method will be used";
118 "Beamspace compression and decompression will be used";
123 "Modulation compression and decompression will be used";
125 enum BLOCK-FLOATING-POINT-SELECTIVE-RE-SENDING {
127 "block floating point with selective re sending
128 compression and decompression will be used";
130 enum MODULATION-COMPRESSION-SELECTIVE-RE-SENDING {
132 "modulation compression with selective re sending
133 compression and decompression will be used";
137 "Compresion method which can be supported by the O-RU";
141 grouping compression-formats {
143 "Grouping deicated to list compression formats as choice";
145 choice compression-format {
147 "Choice of compression format for particular element";
149 case no-compresison {
150 description "Compression for beam weights is not supported.";
152 case block-floating-point {
153 description "Block floating point compression and decompression is supported.";
159 description "Exponent bit width size in number of bits used when encoding in udCompParam.";
163 case block-floating-point-selective-re-sending {
165 "Block floating point with selective re sending compression and decompression is supported.";
171 description "Exponent bit width size in number of bits used when encoding in udCompParam.";
176 description "Block scaling compression and decompresion is supported.";
180 "Common scaler for compressed PRB";
185 description "u-Law compression and decompresion method is supported.";
186 leaf comp-bit-width {
190 description "Bit with for u-law compression";
197 "the shift applied to the entire PRB";
201 case beam-space-compression {
202 description "Beamspace compression and decompression is supported. Applies to beamforming weights only.";
203 leaf-list active-beam-space-coeficient-mask {
206 "active beamspace coefficient indices associated with the compressed beamforming vector";
211 "Common scaler for compressed beamforming coefficients";
215 case modulation-compression {
216 description "Modulation compression and decompression is supported.";
221 description "Constallation shift flag";
224 leaf mod-comp-scaler {
228 description "Modulation compression scaler value.";
232 case modulation-compression-selective-re-sending {
233 description "Modulation compression with selective re sending and decompression is supported.";
238 description "Constallation shift flag";
241 leaf sres-mod-comp-scaler {
245 description "Modulation compression scaler value.";
252 grouping compression-params {
254 "Parameters to define compression";
256 leaf compression-type {
260 "Indicates that static compression method will be used (both compression and IQ bitwidth)";
264 "Indicates that dynamic compression method will be used";
269 "Compression type that O-DU wants to be supported";
272 // *********** TO BE REMOVED ***********
274 when "../compression-type = 'STATIC'";
278 "Bitwidth to be used in compression.
279 This has since been replaced in M-Plane version
280 2.0.0 with the iq-bitwidth schema node";
282 // *************************************
284 uses compression-formats;
287 grouping compression-parameters {
289 "Parameters used to define description type";
294 "Bitwidth to be used in compression";
297 uses compression-formats;
300 grouping format-of-iq-sample {
302 "Indicates module capabilities about IQ samples";
304 leaf dynamic-compression-supported {
308 "Informs if radio supports dynamic compression method";
311 leaf realtime-variable-bit-width-supported {
315 "Informs if O-RU supports realtime variable bit with";
318 list compression-method-supported {
319 uses compression-parameters;
322 "List of supported compression methods by O-RU
323 Note: if O-RU supports different compression methods per endpoint
324 then please refer do endpoints to have information what
325 exactly is supported on a paticular endpoint";
328 leaf syminc-supported {
332 "Informs if symbol number increment command in a C-Plane is
336 leaf regularization-factor-se-supported {
340 "Informs if regularizationFactor in section type 5 is
341 supported(true) or not(false)";
344 leaf little-endian-supported {
349 "All O-RUs support bigendian byte order. This node informs if module supports the
350 the optional capability for little endian byte order for C/U plane data flows.
352 Note - little endian support does not invalidate bigendian support.";
357 grouping compression-details {
363 "Bitwidth to be used in compression";
366 uses compression-params;