1 module o-ran-antenna-calibration {
3 namespace "urn:o-ran:antcal:1.0";
6 organization "O-RAN Alliance";
12 "This module defines the configuration required for supporting the optional
13 antenna calibration functionality.
15 Copyright 2019 the O-RAN Alliance.
17 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS'
18 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
21 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 POSSIBILITY OF SUCH DAMAGE.
29 Redistribution and use in source and binary forms, with or without
30 modification, are permitted provided that the following conditions are met:
32 * Redistributions of source code must retain the above copyright notice,
33 this list of conditions and the above disclaimer.
34 * Redistributions in binary form must reproduce the above copyright notice,
35 this list of conditions and the above disclaimer in the documentation
36 and/or other materials provided with the distribution.
37 * Neither the Members of the O-RAN Alliance nor the names of its
38 contributors may be used to endorse or promote products derived from
39 this software without specific prior written permission.";
45 1) Newly introduced model for supporting optional
46 antenna calibration functionality";
48 reference "ORAN-WG4.MP-v02.00";
51 grouping antenna-calibration-capabilities {
52 description "container for collection of leafs for antenna calibration";
54 leaf self-calibration-support {
58 "Indicates whether O-RU supports self-calibration or not.
60 When true, indicates O-RU can initiate calibration without receiving an
63 leaf number-of-calibration-symbols-per-block-dl {
70 "Indicates how many consecutive symbols are required for DL antenna
71 calibration operation";
73 leaf number-of-calibration-symbols-per-block-ul {
80 "Indicates how many consecutive symbols are required for UL antenna
81 calibration operation";
83 leaf interval-between-calibration-blocks {
87 "if time interval is required between consecutive antenna calibration
88 operation, defines this time value as unit of symbols.
90 A common value is used here for the intervals
91 between DL-DL blocks, UL-UL blocks, DL-UL blocks and UL-DL blocks,
92 which is the largest minimum interval required between any two adjacent
95 leaf number-of-calibration-blocks-per-step-dl {
101 "Indicates how many blocks are required for one step of DL antenna
102 calibration operation";
104 leaf number-of-calibration-blocks-per-step-ul {
110 "Indicates how many blocks are required for one step of UL antenna
111 calibration operation";
113 leaf interval-between-calibration-steps {
117 "If time interval is required between consecutive step of antenna
118 calibration operation, defines this time value as unit of radio frames";
120 leaf number-of-calibration-steps {
126 "Indicates how many steps are required for whole DL/UL antenna
127 calibration operation";
131 grouping antenna-calibration {
132 container antenna-calibration-capabilities {
135 "Describes the antenna calibration capabilities";
136 uses antenna-calibration-capabilities;
138 container self-calibration-policy {
139 leaf self-calibration-allowed {
143 "whether the self-calibration is allowed configured by operator.";
146 "Describes the self calibration policy of the operator";
149 "Describe the grouping set of antenna calibration";
152 container antenna-calibration {
153 uses antenna-calibration;
155 "Describes the antenna calibration top node";
158 rpc start-antenna-calibration {
160 "The antenna calibration operation can start when NETCONF client sends a
161 calibration start command with resource allocation parameters.
162 These parameters indicate how the O-RU can perform the antenna
163 calibration operation; at which Symbol, Slot, and Frame.
164 This scheduling information can be generated by O-RU itself.
165 However, in a dynamic TDD environment, the DL and UL configuration
166 is only determined and known by O-DU. Consequently, only O-DU (NETCONF
167 client ) can determine and configure the scheduling and resource
168 allocation permitted for use by the antenna calibration operation";
170 leaf symbol-bitmask-dl {
177 "Bitmask indicating DL calibration symbol within a calibration slot.
178 First character in the string indicate first symbol,
179 next character in the string indicate second symbol and so on.
180 Value 1 indicates that the symbol may be used for calibration
181 and 0 means the symbol shall not be used for calibration.";
183 leaf symbol-bitmask-ul {
190 "Bitmask indicating UL calibration symbol within a calibration slot.
191 First character in the string indicate first symbol,
192 next character in the string indicate second symbol and so on.
193 Value 1 indicates that the symbol may be used for calibration
194 and 0 means the symbol shall not be used for calibration.";
196 leaf slot-bitmask-dl {
203 "Bitmask indicating DL calibration slot within a calibration frame.
204 First character in the string indicate first slot,
205 next character in the string indicate second slot and so on.
206 Value 1 indicates that the slot may be used for calibration
207 and 0 means the slot shall not be used for calibration.";
209 leaf slot-bitmask-ul {
216 "Bitmask indicating UL calibration slot within a calibration frame.
217 First character in the string indicate first slot,
218 next character in the string indicate second slot and so on.
219 Value 1 indicates that the slot may be used for calibration
220 and 0 means the slot shall not be used for calibration.";
222 leaf frame-bitmask-dl {
229 "Bitmask indicating DL calibration frame within a calibration step.
230 First character in the string indicate first radio frame equal to
231 the start-SFN, next character in the string indicate the next frame
234 Value 1 indicates that the frame may be used for calibration
235 and 0 means the frame shall not be used for calibration.";
237 leaf frame-bitmask-ul {
244 "Bitmask indicating UL calibration frame within a calibration step.
245 First character in the string indicate first radio frame equal to
246 the start-SFN, next character in the string indicate the next frame
249 Value 1 indicates that the frame is may be used for calibration
250 and 0 means the frame shall not be used for calibration.";
252 leaf calibration-step-size {
255 description " Number of frames within a calibration step";
257 leaf calibration-step-number {
260 description "Number of calibration steps";
267 description "start SFN number of the first calibration step";
275 "Status information to indicate that O-RU accepted RPC
276 antenna calibration start request";
280 "Status information to indicate that O-RU rejected RPC antenna
281 calibration start request";
286 "Status of whether antenna calibration trigger by RPC is accepted
290 when "../status='REJECTED'";
293 "Detailed error Message when the status is rejected, e.g.,
294 because O-RU can not start antenna calibration
295 such as already running antenna calibration,
296 resource mask mismatch with O-RU antenna calibration capability,
297 overlapped DL and UL masks, insufficient memory, O-RU internal reason";
303 notification antenna-calibration-required {
304 list dl-calibration-frequency-chunk {
305 leaf start-calibration-frequency-dl {
308 "lowest frequency value in Hz of the frequency range is required for
309 DL antenna calibration operation.";
311 leaf end-calibration-frequency-dl {
314 "highest frequency value in Hz of the frequency range is required for
315 DL antenna calibration operation.";
318 "min/max frequency of dl spectrum chunk affected by calibration process";
320 list ul-calibration-frequency-chunk {
321 leaf start-calibration-frequency-ul {
324 "lowest frequency value in Hz of the frequency range is required for
325 UL antenna calibration operation.";
327 leaf end-calibration-frequency-ul {
330 "highest frequency value in Hz of the frequency range is required for
331 UL antenna calibration operation.";
334 "min/max frequency of ul spectrum chunk affected by calibration process";
337 "this notification indicates that the antenna calibration is required in O-RU";
340 notification antenna-calibration-result {
344 description "O-RU has succeeded in calibrating its antenna";
348 "O-RU attemted to calibrate its antenna, but the procedure failed.";
353 "Status of the antenna calibration procedure which has been triggered
354 by accepting an start-antenna-calibration RPC.";
356 leaf detailed-reason {
357 when "../status='FAILURE'";
360 "Detailed reason when the status is FAILURE, e.g.,
361 O-RU cannot complete the antenna calibration
362 because of lack of memory, self-calibration failure, etc";
365 "This notification indicates the antenna calibration result";