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-wg4-features@2022-12-05.yang
1 module o-ran-wg4-features {
2   yang-version 1.1;
3   namespace "urn:o-ran:wg4feat:1.0";
4   prefix "o-ran-feat";
5
6
7   organization "O-RAN Alliance";
8
9   contact
10     "www.o-ran.org";
11
12   description
13     "This module defines the set of re-usable type definitions for WG4 specific
14     features.
15
16     Copyright 2021 the O-RAN Alliance.
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 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.";
41
42   revision "2022-12-05" {
43     description
44       "version 11.0.0
45       new features:
46
47       1) UPLANE-ONLY-DL-MODE-ENABLE
48       2) SUPERVISION-WITH-SESSION-ID
49       3) INTEGRITY-CHECK-AT-SW-DOWNLOAD
50       4) ST4-SLOT-CONFIG-MSG-SUPPORT";
51
52     reference "ORAN-WG4.M.0-v11.00";
53   }
54
55
56   revision "2022-08-15" {
57     description
58       "version 10.0.0
59       new features:
60       1) SHARED-ORU-MULTI-ODU
61       2) SHARED-ORU-MULTI-OPERATOR";
62     reference "ORAN-WG4.M.0-v10.00";
63   }
64
65   revision "2021-12-01" {
66     description
67       "version 8.0.0
68       new features:
69       1) Typographical corrections in descriptions
70       2) Add new features:
71          BEAM-UPDATE-CONTENTION-CONTROL
72          MULTIPLE-SCS-IN-EAXC
73          ENHANCED-T-COMBINE
74          CHANNEL-INFORMATION-COMPRESSION
75          CHANNEL-INFORMATION-PRB-GROUP
76          MULTIPLE-TRANSPORT-SESSION-TYPE";
77     reference "ORAN-WG4.M.0-v08.00";
78   }
79
80   revision "2021-07-26" {
81     description
82       "version 7.0.0
83
84       new features:
85       1) EXT-ANT-DELAY-CONTRO
86       2) CPLANE-MESSAGE-PROCESSING-LIMITS";
87
88     reference "ORAN-WG4.M.0-v07.00";
89   }
90
91   revision "2021-03-22" {
92     description
93       "version 6.0.0
94
95       1) Features added to handle updated transmission window control:
96       STATIC-TRANSMISSION-WINDOW-CONTROL
97       DYNAMIC-TRANSMISSION-WINDOW-CONTROL
98       UNIFORMLY-DISTRIBUTED-TRANSMISSION
99       ORDERED-TRANSMISSION
100       INDEPENDENT-TRANSMISSION-WINDOW-CONTROL
101       ";
102
103     reference "ORAN-WG4.M.0-v06.00";
104   }
105
106   revision "2020-12-10" {
107     description
108       "version 5.0.0
109
110       1) initial version.";
111
112     reference "ORAN-WG4.M.0-v05.00";
113   }
114
115   feature NON-PERSISTENT-MPLANE {
116     description
117       "Indicates that the Radio Unit supports the optional
118       capability to improve the operation with a SMO using a non-
119       persistent NETCONF session.";
120   }
121
122   feature STATIC-TRANSMISSION-WINDOW-CONTROL {
123     description
124       "O-RU supports U-plane transmission window control (scheduled transmission
125        and optionally uniformly distributed transmission) configuration over M-plane";
126   }
127
128   feature DYNAMIC-TRANSMISSION-WINDOW-CONTROL {
129     description
130       "O-RU supports U-plane transmission window control (scheduled transmission
131        and optionally uniformly distributed transmission) configuration over C-plane";
132   }
133
134   feature UNIFORMLY-DISTRIBUTED-TRANSMISSION {
135     if-feature "STATIC-TRANSMISSION-WINDOW-CONTROL or DYNAMIC-TRANSMISSION-WINDOW-CONTROL";
136     description
137       "O-RU supports transmission of UL U-plane messages distributed uniformly over transmission window.";
138   }
139
140   feature ORDERED-TRANSMISSION {
141     description
142       "O-RU supports ordered transmission";
143   }
144
145   feature INDEPENDENT-TRANSMISSION-WINDOW-CONTROL {
146     if-feature "STATIC-TRANSMISSION-WINDOW-CONTROL or DYNAMIC-TRANSMISSION-WINDOW-CONTROL";
147     description
148       "O-RU supports independent U-plane transmission window per endpoint.
149
150        If this feature is not supported then for all endpoints with transmission control enabled
151        (see u-plane-transmission-control/transmission-window-control) must be configured for transmission
152        window offsets and window sizes that coincide for each symbol.
153
154        If INDEPENDENT-TRANSMISSION-WINDOW-CONTROL feature is not supported then all endpoints with
155        transmission control enabled that handle the same carrier type and SCS must be configured
156        (via M-plane or C-plane) with parameter values resulting in transmission windows that coincide
157        between the endpoints. That is, for every symbol N, the effective transmission window for symbol N
158        must be shared (start at the same time and end at the same time) by all the endpoints handling
159        same carrier type and SCS. This restriction applies only to endpoints that have transmission
160        control enabled.
161
162        If INDEPENDENT-TRANSMISSION-WINDOW-CONTROL feature is supported then restriction described
163        above does not apply and a different transmission window (window offset and window size)
164        can be used for every endpoint capable of transmission window control.";
165   }
166
167   feature EXT-ANT-DELAY-CONTROL {
168     description
169       "This feature indicates that the O-RU supports external antenna delay control";
170   }
171
172   feature CPLANE-MESSAGE-PROCESSING-LIMITS {
173     description
174       "Feature to indicate O-RU limitation of C-Plane message processing. Refer CUS-Plane specification
175       section 'O-RU C-Plane message limits' for more details on this feature.";
176   }
177
178   feature CHANNEL-INFORMATION-COMPRESSION {
179     description
180       "This feature indicates that the O-RU supports channel information compression.";
181   }
182
183   feature CHANNEL-INFORMATION-PRB-GROUP {
184     description
185       "Feature to indicate O-RU supports receiving and processing channel
186        information (e.g., ST6) with PRB group size greater than one PRB";
187   }
188
189   feature BEAM-UPDATE-CONTENTION-CONTROL {
190     description
191       "Feature to indicate O-RU requirements for beam weight update for a given beamId, to avoid beam update contentions.
192       Refer CUS-Plane specification section 'Weight-based dynamic beamforming' for more details on this feature.";
193   }
194
195   feature MULTIPLE-SCS-IN-EAXC {
196     description
197       "Presence of feature indicates that FHM supports combining for multiple SCS
198       or multiple c-plane-types/frameStructure in a single eAxC-id in UL direction.";
199   }
200
201   feature MULTIPLE-TRANSPORT-SESSION-TYPE {
202     description
203       "Feature to indicate O-RU supports to be configured with multiple transport-session-type
204       (Ethernet, ALIASMAC, UDP/IP)";
205   }
206
207   feature ENHANCED-T-COMBINE {
208       description
209       "Presence of feature indicates that FHM/Cascade O-RU can support t-combine-net and tx-duration";
210   }
211
212   feature SHARED-ORU-MULTI-OPERATOR {
213     description
214       "Feature to indicate the O-RU supports shared operation with one or more shared
215       resouce operators (i.e., multiple MNOs) and implements enhanced NACM privileges per shared
216       resource operator.
217
218       Note, there is no linkage or dependency between the SHARED-CELL feature and the SHARED-ORU feature.";
219   }
220
221   feature SHARED-ORU-MULTI-ODU {
222     description
223       "Feature to indicate the O-RU supports independent supervision qualified based on odu-id, where
224       loss of supervision triggers selective carrier deactivation of carriers associated with odu-id.";
225   }
226
227   feature INTEGRITY-CHECK-AT-SW-DOWNLOAD {
228    description "Feature indicates that radio unit support performing integrity check at software download";
229   }
230
231    feature SUPERVISION-WITH-SESSION-ID {
232     description
233       "O-RUs supporting this feature reuse the session-id generated for each NETCONF
234       session in supervision-notification. The session-id is defined in RFC 6241.
235       For these O-RUs, the O-RU controller participating in the NETCONF supervision
236       procedure can subscribe to supervision-notification notification events,
237       filtering for the supervision-notification/session-id matching
238       session-id in the Hello Message received from NETCONF Server earlier.";
239   }
240
241   feature UPLANE-ONLY-DL-MODE {
242     description
243       "Presence of feature indicates that O-RU supports U-Plane-only DL mode.";
244   }
245   
246   feature ST4-SLOT-CONFIG-MSG-SUPPORT {
247     description
248     "Feature to indicate O-RU support for Section Type 4 slot configuration message";
249   }
250
251 }
The repo contains infromation (UML) and data models (yang, ves) used by O-RAN SC.