Code Review / scp / oam / modeling.git / blob
? search:
summary | shortlog | log | commit | commitdiff | review | tree
history | raw | HEAD
Support of WG4 OpenFronthaul Management-Plane VES
[scp/oam/modeling.git] / data-model / yang / published / o-ran / ru-fh / o-ran-laa-operations@2021-12-01.yang
1 module o-ran-laa-operations {
2   yang-version 1.1;
3   namespace "urn:o-ran:laa-operations:1.0";
4   prefix "o-ran-laa-operations";
5
6   import o-ran-module-cap {
7     prefix "mcap";
8   }
9
10   organization "O-RAN Alliance";
11
12   contact
13     "www.o-ran.org";
14
15   description
16     "This module defines the operations for DFS measurement.
17
18     Copyright 2021 the O-RAN Alliance.
19
20     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS'
21     AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22     IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23     ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
24     LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25     CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26     SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27     INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29     ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30     POSSIBILITY OF SUCH DAMAGE.
31
32     Redistribution and use in source and binary forms, with or without
33     modification, are permitted provided that the following conditions are met:
34
35     * Redistributions of source code must retain the above copyright notice,
36     this list of conditions and the above disclaimer.
37     * Redistributions in binary form must reproduce the above copyright notice,
38     this list of conditions and the above disclaimer in the documentation
39     and/or other materials provided with the distribution.
40     * Neither the Members of the O-RAN Alliance nor the names of its
41     contributors may be used to endorse or promote products derived from
42     this software without specific prior written permission.";
43
44   revision "2021-12-01" {
45     description
46       "version 1.3.0
47
48       1) typographical corrections in descriptions.";
49
50     reference "ORAN-WG4.M.0-v01.00";
51   }
52
53   revision "2021-03-22" {
54     description
55       "version 1.2.0
56
57       1) removing non-ASCII characters from model";
58
59     reference "ORAN-WG4.M.0-v01.00";
60   }
61
62
63   revision "2019-07-03" {
64     description
65       "version 1.1.0
66
67       1) corrected error in module reference for LAA feature";
68
69     reference "ORAN-WG4.M.0-v01.00";
70   }
71
72   revision "2019-02-04" {
73     description
74       "version 1.0.0
75
76       1) imported model from xRAN
77       2) changed namespace and reference from xran to o-ran";
78
79     reference "ORAN-WG4.M.0-v01.00";
80   }
81
82   typedef band-num {
83     type enumeration {
84       enum BAND_46_SUBBAND_A {
85         description
86           "46a: 5150 MHz - 5250 MHz";
87       }
88       enum BAND_46_SUBBAND_B {
89         description
90           "46b: 5250 MHz - 5350 MHz";
91       }
92       enum BAND_46_SUBBAND_C {
93         description
94           "46c: 5470 MHz - 5725 MHz";
95       }
96       enum BAND_46_SUBBAND_D1 {
97         description
98           "46d1: 5725 MHz - 5850 MHz";
99       }
100       enum BAND_46_SUBBAND_D2 {
101         description
102           "46d2: 5850 MHz - 5925 MHz";
103       }
104     }
105     description
106       "This value indicates the list of bands supported as per the document,
107       3GPP TS 36.104 V14.2.0 (2016-12), 'Section 5.5 Operation bands'.";
108   }
109
110   grouping band-configuration {
111     description
112       "Grouping for band configuration";
113
114     leaf band-number {
115       type band-num;
116       description
117         "This value indicates the list of bands supported as per the document,
118         3GPP TS 36.104 V14.2.0 (2016-12), 'Section 5.5 Operation bands'.";
119     }
120     leaf-list channel-center-frequency {
121       type uint16;
122       units kilohertz;
123       description
124         "This value indicates carrier centre frequency in KHz";
125     }
126   }
127
128   grouping measurement-parameters {
129     description
130       "Grouping for measurement parameters";
131
132     leaf duration-per-channel {
133       type uint16;
134       units milliseconds;
135       description
136         "This value indicates measurement duration per channel in milliseconds.";
137     }
138
139     leaf maximum-response-time {
140       type uint16;
141       units seconds;
142       description
143         "This value indicates maximum response time (i.e., timer) in seconds.";
144     }
145   }
146
147   grouping channel-result-element {
148     description
149       "Grouping for channel result element";
150
151     leaf measured-channel {
152       type uint16;
153       units kilohertz;
154       description
155         "This value indicates carrier centre frequency for which the result is computed in KHz.";
156     }
157
158     leaf occupancy-ratio {
159       type uint8;
160       units percent;
161       description
162         "This value indicates occupancy ratio in percentage.";
163     }
164
165     leaf average-rssi {
166       type int8;
167       units dBm;
168       description
169         "This value indicates average RSSI in dBm";
170     }
171   }
172
173   grouping band-result-element {
174     description
175       "Grouping for band result element";
176
177     leaf band-number {
178       type band-num;
179       description
180         "This value indicates the band for which the result is computed.";
181     }
182
183     leaf measurement-success {
184       type boolean;
185       description
186         "This value indicates whether the measurement is successful for the given band.";
187     }
188     leaf failure-message {
189       when "../measurement-success='false'";
190       type enumeration {
191         enum TIMEOUT {
192           description "Timed out waiting for measurement completion.";
193         }
194       }
195       description "This value indicates the detailed error message for failure of the measurement at O-RU.";
196     }
197
198     list channel-result {
199       when "../measurement-success='true'";
200       key "measured-channel";
201       description "Results for a particular channel";
202
203       uses channel-result-element;
204     }
205   }
206
207   //rpc definitions
208   rpc start-measurements {
209     if-feature mcap:LAA;
210     description "Measurements for Carrier-Selection and Dynamic Frequency Selection (DFS)";
211     input {
212       list band-config {
213         key "band-number";
214         description "Per band configuration for measurements.";
215
216         uses band-configuration;
217       }
218
219       uses measurement-parameters;
220     }
221
222     output {
223       list band-config {
224         key "band-number";
225         description "Output list for all the bands requested for measurements.";
226
227         leaf band-number {
228           type band-num;
229           description
230             "This value indicates the list of bands supported as per the document,
231             3GPP TS 36.104 V14.2.0 (2016-12), 'Section 5.5 Operation bands'.";
232         }
233         leaf-list carrier-center-frequency {
234           type uint16;
235           units kilohertz;
236           description
237             "This value indicates carrier centre frequency in KHz";
238         }
239         leaf status {
240           type enumeration {
241             enum ACCEPTED {
242               description "This indicates the measurements for particular sub band is accepted at O-RU.";
243             }
244             enum REJECTED {
245               description "This indicates the measurements for particular sub band is rejected at O-RU.";
246             }
247           }
248           description "This value indicates the status of the measurement acceptance at O-RU.";
249         }
250
251         leaf error-message {
252           when "../status='REJECTED'";
253           type string;
254           description
255             "This value indicates the detailed error message for the measurement being rejected at O-RU.";
256         }
257       }
258     }
259   }
260
261   // notifications
262   notification measurement-result {
263     if-feature mcap:LAA;
264     description "Notification to provide the results of carrier selection and DFS.";
265     list band-result {
266       key "band-number";
267       description "Results for a particular sub band under band 46.";
268
269       uses band-result-element;
270     }
271   }
272 }
The repo contains infromation (UML) and data models (yang, ves) used by O-RAN SC.