Refactor folder structure.
[sim/o1-interface.git] / ntsimulator / yang / x-ran / xran-delay-management.yang
1 module xran-delay-management {
2   yang-version 1.1;
3   namespace "urn:xran:delay:1.0";
4   prefix "xran-delay";
5
6   organization "xRAN Forum";
7
8   contact
9     "www.xran.org";
10
11   description
12     "This module covers off aspects of lls-CU to RU delay management,
13     including config data related to RU transmission and reception
14     windows.
15
16     Copyright 2018 the xRAN Forum.
17
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.
29
30     Redistribution and use in source and binary forms, with or without
31     modification, are permitted provided that the following conditions are met:
32
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 xRAN Forum 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.";
41
42   revision "2018-07-20" {
43     description
44       "version 1.0.0 - First release of the xRAN YANG M-Plane models.
45
46       This version of the model supports v01.00 of the corrsponding xRAN
47       M-Plane Specification.";
48     reference "XRAN-FH.MP.0-v01.00";
49   }
50
51   feature ADAPTIVE-RU-PROFILE {
52     description
53       "This feature indicates that the RU supports adaptive RU delay profile
54       based on information provided by the NETCONF client.";
55   }
56
57   container delay-management {
58     description "top level tree covering off lls-CU to RU delay management";
59
60     list bandwidth-scs-delay-state {
61       key "bandwidth subcarrier-spacing";
62       description
63         "Array of structures containing sets of parameters for delay management.";
64
65       leaf bandwidth {
66         type uint32 {
67           range "200 | 1400 | 3000 | 5000 | 10000 | 15000 | 20000 | 25000 |
68                 30000 | 40000 | 50000 | 60000 | 70000 | 80000 | 90000 | 100000
69                 | 200000 | 400000" ;
70         }
71         units kilohertz;
72         description
73           "transmission bandwidth configuration in units of kHz -
74           covering NBIoT through to New Radio - see 38.104";
75       }
76       leaf subcarrier-spacing {
77         type uint32 {
78           range "0 .. 240000 ";
79         }
80         units Hertz;
81         description "subcarrier spacing in Hz";
82       }
83
84       container ru-delay-profile {
85         config false;
86         description "container for RU delay parameters";
87         leaf t2a-min-up {
88           type uint32;
89           units nanoseconds;
90           mandatory true;
91           description
92             "the minimum RU data processing delay between receiving IQ data
93             message over the fronthaul interface and transmitting
94             the corresponding first IQ sample at the antenna";
95         }
96         leaf t2a-max-up {
97           type uint32;
98           units nanoseconds;
99           mandatory true;
100           description
101             "the earliest allowable time when a data packet is received before
102             the corresponding first IQ sample is transmitted at the antenna";
103         }
104         leaf t2a-min-cp-dl {
105           type uint32;
106           units nanoseconds;
107           mandatory true;
108           description
109             "the minimum RU data processing delay between receiving downlink
110             real time control plane message over the fronthaul interface and
111             transmitting the corresponding first IQ sample at the antenna";
112         }
113         leaf t2a-max-cp-dl {
114           type uint32;
115           units nanoseconds;
116           mandatory true;
117           description
118             "the earliest allowable time when a downlink real time control message
119             is received before the corresponding first IQ sample is transmitted at
120             the antenna";
121         }
122         leaf tadv-cp-dl {
123           type uint32;
124           units nanoseconds;
125           mandatory true;
126           description
127             "the time difference (advance) between the reception window for
128             downlink real time Control messages and reception window for the
129             corresponding IQ data messages.";
130         }
131         leaf ta3-min {
132           type uint32;
133           units nanoseconds;
134           mandatory true;
135           description
136             "the minimum RU data processing delay between receiving an IQ sample
137             at the antenna and transmitting the last data sample over the
138             fronthaul interface";
139         }
140         leaf ta3-max {
141           type uint32;
142           units nanoseconds;
143           mandatory true;
144           description
145             "the maximum RU data processing delay between receiving an IQ sample
146             at the antenna and transmitting the first data sample over the
147             fronthaul interface";
148         }
149         leaf t2a-min-cp-ul {
150           type uint32;
151           units nanoseconds;
152           mandatory true;
153           description
154             "the minimum RU data processing delay between receiving real time
155             up-link control plane message over the fronthaul interface and
156             recieving the first IQ sample at the antenna";
157         }
158         leaf t2a-max-cp-ul {
159           type uint32;
160           units nanoseconds;
161           mandatory true;
162           description
163             "the earliest allowable time when a real time up-link control message
164             is received before the corresponding first IQ sample is received  at
165             the antenna";
166         }
167       }
168     }
169
170     container adaptive-delay-configuration {
171       if-feature ADAPTIVE-RU-PROFILE;
172       description "container for adaptive delay parameters";
173       list bandwidth-scs-delay-state {
174         key "bandwidth subcarrier-spacing";
175         description
176           "Array of structures containing sets of parameters for delay management.";
177
178         leaf bandwidth {
179           type uint32 {
180             range "200 | 1400 | 3000 | 5000 | 10000 | 15000 | 20000 | 25000 |
181                   30000 | 40000 | 50000 | 60000 | 70000 | 80000 | 90000 | 100000
182                   | 200000 | 400000" ;
183           }
184           units kilohertz;
185           description
186             "transmission bandwidth configuration in units of kHz -
187             covering NBIoT through to New Radio - see 38.104";
188         }
189         leaf subcarrier-spacing {
190           type uint32 {
191             range "0 .. 240000 ";
192           }
193           units Hertz;
194           description "subcarrier spacing in Hz";
195         }
196         container lls-cu-delay-profile {
197           description
198             "lls-CU provided delay profile for adaptive delay configuration";
199           leaf t1a-max-up-lls-cu {
200             type uint32;
201             units nanoseconds;
202             description
203               "the earliest possible time which the lls-CU can support transmiting
204               an IQ data message prior to transmission of the corresponding IQ
205               samples at the antenna";
206           }
207           leaf tx-max-lls-cu {
208             type uint32;
209             units nanoseconds;
210             description
211               "The maximum amount of time which the lls-CU requires to transmit
212               all downlink user plane IQ data message for a symbol";
213           }
214           leaf ta4-max-lls-cu {
215             type uint32;
216             units nanoseconds;
217             description
218               "the latest possible time which the lls-CU can support receiving the
219               last uplink user plane IQ data message for a symbol.";
220           }
221           leaf rx-max-lls-cu {
222             type uint32;
223             units nanoseconds;
224             description
225               "The maximum time difference the lls-CU can support between
226               receiving the first user plane IQ data message for a symbol and
227               receiving the last user plane IQ data message for the same symbol";
228           }
229         }
230       }
231
232       container transport-delay {
233         description
234           "lls-CU provided transport-delay parameters";
235         leaf t12-min {
236           type uint32;
237           units nanoseconds;
238           description
239             "the minimum measured delay between CU port-ID and RU port-ID";
240         }
241         leaf t34-min {
242           type uint32;
243           units nanoseconds;
244           description
245             "the minimum measured delay between RU port-ID and CU port-ID";
246         }
247 // additional leaf added by Samsung
248         leaf t12-max {
249           type uint32;
250           units nanoseconds;
251           description
252             "the maximum measured delay between CU port-ID and RU port-ID";
253         }
254 // additional leaf added by Samsung
255         leaf t34-max {
256           type uint32;
257           units nanoseconds;
258           description
259             "the maximum measured delay between RU port-ID and CU port-ID";
260         }
261       }
262     }
263   }
264 }