1 module o-ran-common-yang-types {
3 namespace "urn:o-ran:common-yang-types:1.0";
6 import ietf-inet-types {
10 organization "O-RAN Alliance";
18 "This module defines ORAN common YANG types.
20 Copyright 2020 the O-RAN Alliance.
22 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS'
23 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
26 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32 POSSIBILITY OF SUCH DAMAGE.
34 Redistribution and use in source and binary forms, with or without
35 modification, are permitted provided that the following conditions are met:
37 * Redistributions of source code must retain the above copyright notice,
38 this list of conditions and the above disclaimer.
39 * Redistributions in binary form must reproduce the above copyright notice,
40 this list of conditions and the above disclaimer in the documentation
41 and/or other materials provided with the distribution.
42 * Neither the Members of the O-RAN Alliance nor the names of its
43 contributors may be used to endorse or promote products derived from
44 this software without specific prior written permission.";
46 revision "2022-08-15" {
50 1) style guide corrections";
52 reference "ORAN-WG1.IM.0-v01.00";
55 revision "2020-10-10" {
61 reference "ORAN-WG1.IM.0-v01.00";
66 pattern '[0-9]+(\.[0-9]+){1,2}';
69 "Definition used to represent a version of an interface.";
72 typedef timezone-name {
75 "A time zone name as used by the Time Zone Database,
76 sometimes referred to as the 'Olson Database'.
78 The complete set of valid values is defined in
79 https://www.iana.org/time-zones.
81 The exact set of supported values is an
82 implementation-specific matter.";
85 "RFC 6557: Procedures for Maintaining the Time Zone Database
86 IANA Time Zone Database https://www.iana.org/time-zones ";
93 "Indicates that an O-RU supports the ecpri header format
98 "Indicates that an O-RU supports the 1914.3 header format
102 description "the type of C/U plane protocol";
105 typedef duplex-scheme {
117 "Type of duplex scheme O-RU supports.";
124 "Carrier does not provide signal - transmission is disabled";
128 "Carrier is fully configured and was active but is energy saving mode";
132 "Carrier is fully configured and properly providing the signal";
135 description "the active status of a carrier";
142 "Array carrier is not active - transmission of signal is disabled.";
146 "Array carrier is processing an operation requested by change of active parameter.
147 When array carriers is BUSY the transmission of signal is not guaranteed.";
151 "Array carrier had completed activation operation - is active and transmission of signal is ongoing.";
154 description "the state on an array carrier";
157 typedef transport-session {
160 description "VLAN based CUS Transport ";
163 // if-feature o-ran-int:UDPIP-BASED-CU-PLANE; How to handle enum value constrained by feature defined in o-ran-interface.yang?
164 description "UDP/IP based CUS Transport ";
167 // if-feature o-ran-int:ALIASMAC-BASED-CU-PLANE; How to handle enum value constrained by feature defined in o-ran-interface.yang?
168 description "Alias MAC address based CUS Transport ";
171 // if-feature o-ran-elements:SHARED_CELL; How to handle enum value constrained by feature defined in o-ran-processing-element.yang?
172 description "VLAN based CUS Transport used for Shared Cell scenario";
175 description "the transport session type";
178 typedef netconf-client-id {
180 type inet:ip-address;
183 description "A NETCONF client identifier";
186 typedef ca-ra-server-id {
188 type inet:ip-address;
191 description "A CA/RA Server identifier";
196 type inet:ip-address;
199 description "A SeGW identifier";
207 "Priority Code Point. PCP is a 3-bit field that refers to the
208 class of service applied to a VLAN tagged frame. The
209 field specifies a priority value between 0 and 7, these values
210 can be used by quality of service (QoS) to prioritize
211 different classes of traffic.";
213 "IEEE 802.1Q-2014: Virtual Bridged Local Area Networks";
221 "The VLAN-ID that uniquely identifies a VLAN. This is the 12-bit VLAN-ID
222 used in the VLAN Tag header.";
223 reference "[802.1q] 9.6";
226 typedef geographic-coordinate-degree {
231 "Decimal degree (DD) used to express latitude and longitude
232 geographic coordinates.";
235 typedef prach-preamble-format {
239 "LTE PRACH Preamble format 0";
243 "LTE PRACH Preamble format 1";
247 "LTE PRACH Preamble format 2";
251 "LTE PRACH Preamble format 3";
255 "LTE PRACH Preamble format 4";
259 "LTE Narrowband PRACH format 0";
263 "LTE Narrowband PRACH format 1";
267 "5GNR PRACH Preamble format 0";
271 "5GNR PRACH Preamble format 1";
275 "5GNR PRACH Preamble format 2";
279 "5GNR PRACH Preamble format 3";
283 "5GNR PRACH Preamble format A1";
287 "5GNR PRACH Preamble format A2";
291 "5GNR PRACH Preamble format A3";
295 "5GNR PRACH Preamble format B1";
299 "5GNR PRACH Preamble format B2";
303 "5GNR PRACH Preamble format B3";
307 "5GNR PRACH Preamble format B4";
311 "5GNR PRACH Preamble format C0";
315 "5GNR PRACH Preamble format C2";
319 "LTE Narrowband PRACH format 0-a";
323 "LTE Narrowband PRACH format 1-a";
327 "LTE Narrowband PRACH format 2";
332 "PRACH preamble format definition";
335 typedef polarisation_type {
338 description "MINUS_45";
344 description "PLUS_45";
347 description "PLUS_90";
350 description "Type definition for polarisations";
355 range "200 | 1400 | 3000 | 5000 | 10000 | 15000 | 20000 | 25000 |
356 30000 | 40000 | 50000 | 60000 | 70000 | 80000 | 90000 | 100000
361 "transmission bandwidth configuration in units of kHz -
362 covering NBIoT through to New Radio - see 38.104";
365 typedef scs-config-type {
370 "15kHz sub carrier spacing";
375 "30kHz sub carrier spacing";
380 "60kHz sub carrier spacing";
385 "120kHz sub carrier spacing";
390 "240kHz sub carrier spacing";
395 "1,25kHz sub carrier spacing";
400 "3.75kHz sub carrier spacing";
405 "5kHz sub carrier spacing";
410 "7.5kHz sub carrier spacing";
415 "Scs configuration type definition";