3 namespace "urn:xran:sync:1.0";
7 organization "xRAN Forum";
13 "This module defines synchronization mechanism for the xRAN Radio Unit.
15 Copyright 2018 the xRAN Forum.
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 xRAN Forum 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.";
41 revision "2018-07-20" {
43 "version 1.0.0 - First release of the xRAN YANG M-Plane models.
45 This version of the model supports v01.00 of the corrsponding xRAN
46 M-Plane Specification.";
47 reference "XRAN-FH.MP.0-v01.00";
50 typedef geographic-coordinate-degree {
55 "Decimal degree (DD) used to express latitude and longitude
56 geographic coordinates.";
61 "This feature indicates that the RU supports integrated GNSS functionality.";
66 "Main containter for sync related parameters";
68 container sync-status {
72 "Object of this class provides synchronization state of the module.";
78 "RU is in the locked mode, as defined in ITU-T G.810";
82 "RU clock is in holdover mode";
86 "RU clock isn’t locked to an input reference, and is not in the holdover mode";
91 "State of DU synchronization";
94 list supported-reference-types {
98 "Type of a synchronization supported source.";
103 "GPS can be taken as a synchronization source";
107 "Precision Time Protocol can be taken as a synchronization source";
111 "Synchronous Ethernet can be taken as a synchronization source";
117 "supported reference-type";
122 container sync-capability {
126 "Object of this class provides synchronization capabilities of the module.";
132 "Standard accuracy for synchronization is supported by the device";
136 "Enchanced accuracy for synchronization is supported by the device";
141 "This will provide information about T-TSC capability";
143 reference "T-TSC: ITU-T G.8275.1/Y.1369.1";
147 container ptp-config {
149 "This MO defines configuration of Precise Time Protocol.";
154 "This parameter indicates Domain Number for PTP announce messages.";
157 leaf multicast-mac-address {
161 "means, that PTP shall use 01-80-C2-00-00-0E destination MAC address";
163 enum NONFORWARDABLE {
165 "means, that PTP shall use 01-1B-19-00-00-00 destination MAC address";
170 "The parameter defines destination MAC address, used by the DU in the egress PTP messages.";
173 list accepted-clock-classes {
178 "PTP Clock Class accepted by the RU";
181 "Contains list of PTP acceptable Clock Classes, sorted in the descending order.";
184 leaf delay-asymmetry {
190 "Defines static phase error in the recovered PTP timing signal to be compensated at the RU.
191 The error is defined in units of nanoseconds in the range ±10 000 ns.";
195 container ptp-status {
197 "ptp status container";
198 leaf reporting-period {
202 "This parameter defines minimum period in seconds between reports,
203 sent by the NETCONF Client, for parameters in this container.";
209 "The integrated ordinary clock is synchronizing to the reference, recovered from PTP flow";
213 "The integrated ordinary clock is not synchronizing to the reference, recovered from PTP flow";
218 "This parameter indicates, whether the integrated ordinary clock is
219 synchronizing to the reference, recovered from PTP signal.
220 The exact definition when to indicate locked or unlocked is up to specific
228 "This parameter contains the clock class of the clock, controlled by the RU";
231 leaf clock-identity {
234 pattern "0[xX][0-9a-fA-F]";
238 "This parameter contains identity of the clock,
239 according to IEEE 1588-2008 defintion, controlled by the RU.
240 The string shall be formatted as an 8-octet hex value with the “0x” prefix.";
243 leaf partial-timing-supported {
247 "Provides information wheter G.8275.2 (partial timing support from network) is supported.";
251 key local-port-number;
255 "Synchronisation sources";
257 leaf local-port-number {
259 // fixme - change to a leafref once interface design is agreed
261 "This is reference to portNumber of ExternalEthernetPort to identify the port,
262 where the PTP signal is located.";
269 "Indicates that this source is the current master clock, i.e. the clock,
270 which the clock, controlled by the Netconf Server, is synchronized to";
274 "Indicates that this source is an alternate master, which the clock,
275 controlled by the Netconf Server, can potentially synchronize to,
276 i.e. clock class and priority, announced by the master clock is lower,
277 compared to those of the clock, controlled by the Netconf Server,
278 and and the clock class is accepted";
282 "Indicates that this source is an alternate master, which the clock,
283 controlled by the Netconf Server, has an operational connection to,
284 but the class or priority of the master clock is higher or equal
285 to those of the clock, controlled by the Netconf Server,
286 or the clock class is not accepted";
290 "Indicates that this source is an alternate master, which the clock,
291 controlled by the Netconf Server, has no operational connection to";
295 "This parameter indicates status of the PTP source";
301 "This parameter reflects status of the twoStepFlag attribute in Sync messages,
302 received from the PTP source.";
308 "This parameter reflects status of the leap61 flag in Announce messages,
309 received from the PTP source.
310 When true, the last minute of the current UTC day contains 61 seconds.";
316 "This parameter reflects status of the leap59 flag in Announce messages,
317 received from the PTP source.
318 When true, the last minute of the current UTC day contains 59 seconds.";
321 leaf current-utc-offset-valid {
324 "This parameter reflects status of the currentUtcOffsetValid flag in
325 Announce messages, received from the PTP source.
326 When true, the current UTC offset is valid.";
332 "This parameter reflects status of the ptpTimescale flag in Announce
333 messages, received from the PTP source.
335 When set, the clock timescale of the grandmaster clock is PTP;
336 otherwise, the timescale is ARB (arbitrary)";
339 leaf time-traceable {
342 "This parameter reflects status of the timeTraceable flag in Announce
343 messages, received from the PTP source.
345 When true, the timescale and the currentUtcOffset are traceable to a
349 leaf frequency-traceable {
352 "This parameter reflects status of the frequencyTraceable flag in
353 Announce messages, received from the PTP source.
355 When true, the frequency determining the timescale is traceable to a
359 leaf source-clock-identity {
362 pattern "0[xX][0-9a-fA-F]";
365 "This parameter reflects value of the sourceClockIdentity attribute in
366 Announce messages, received from the PTP source.
368 The string shall be formatted as an 8-octet hex value with the “0x”
372 leaf source-port-number {
375 "This parameter reflects value of the sourcePortNumber attribute in
376 Announce messages, received from the PTP source.";
379 leaf current-utc-offset {
382 "The offset between TAI and UTC when the epoch of the PTP system is
383 the PTP epoch, i.e., when ptp-timescale is TRUE; otherwise, the value
390 "This parameter reflects value of the priority1 attribute in Announce
391 messages, received from the PTP source.";
397 "This parameter reflects value of the clockClass attribute in
398 Announce messages, received from the PTP source.";
401 leaf clock-accuracy {
404 "This parameter reflects value of the clockAccuracy attribute in
405 Announce messages, received from the PTP source.";
408 leaf offset-scaled-log-variance {
411 "This parameter reflects value of the offsetScaledLogVariance
412 attribute in Announce messages, received from the PTP source.";
418 "This parameter reflects value of the priority2 attribute in Announce
419 messages, received from the PTP source.";
422 leaf grandmaster-clock-identity {
425 "This parameter reflects value of the grandmasterClockIdentity
426 attribute in Announce messages, received from the PTP source.
428 The string shall be formatted as an 8-octet hex value with the “0x”
435 "This parameter reflects value of the stepsRemoved attribute in
436 Announce messages, received from the PTP source.
438 It indicates the number of communication paths traversed
439 between the local clock and the grandmaster clock.";
445 "This parameter reflects value of the timeSource attribute in
446 Announce messages, received from the PTP source.";
451 container synce-status {
453 "SyncE status container";
455 leaf reporting-period {
459 "This parameter defines minimum period in seconds between reports,
460 sent by the NETCONF client, for parameters in this container.";
467 "The integrated ordinary clock is synchronizing to the reference, recovered from SyncE signal";
471 "The integrated ordinary clock is not synchronizing to the reference, recovered from SyncE signal";
476 "This parameter indicates, whether the integrated ordinary clock is
477 synchronizing to the reference, recovered from SyncE signal.
479 The exact definition when to indicate locked or unlocked is up to
480 specific implementation.";
484 key local-port-number;
486 leaf local-port-number {
488 //fixme - change to leafref once interfaces ae agreed
490 "This is reference to portNumber of ExternalEthernetPort to identify
491 the port, where the SyncE signal is located.";
498 "Indicates that this source is the current master clock, i.e. the clock,
499 which the clock, controlled by the Netconf Server, is synchronized to";
503 "Indicates that this source is an alternate master, which the clock,
504 controlled by the Netconf Server, can potentially synchronize to,
505 i.e. clock class and priority, announced by the master clock is lower,
506 compared to those of the clock, controlled by the Netconf Server,
507 and and the clock class is accepted";
511 "Indicates that this source is an alternate master, which the clock,
512 controlled by the Netconf Server, has an operational connection to,
513 but the class or priority of the master clock is higher or equal
514 to those of the clock, controlled by the Netconf Server,
515 or the clock class is not accepted";
519 "Indicates that this source is an alternate master, which the clock,
520 controlled by the Netconf Server, has no operational connection to";
524 "This parameter indicates status of the SyncE source";
532 "This parameter contains value of the SSM clock quality level,
533 received in SSM messages from the SyncE source.";
537 "This parameter contains characteristics of SyncE sources of the clock, controlled by the RU.";
540 container gnss-state {
544 "Provides information about state of gps receiver";
550 "A name that is unique across the RU that identifies a GNSS instance.
551 This name may be used in fault management to refer to a
552 fault source or affected object";
557 description "GNSS functionality is synchronized";
559 enum ACQUIRING-SYNC {
560 description "GNSS functionality is acquiring sync";
562 enum ANTENNA-DISCONNECTED {
563 description "GNSS functionality has its antenna disconnected";
566 description "GNSS functionality is booting";
568 enum ANTENNA-SHORT-CIRCUIT {
569 description "GNSS functionality has an antenna short circuit";
572 description "when available, indicates the status of the gnss receiver.";
574 container gnss-data {
575 when "../gnss-status='SYNCHRONIZED'";
577 "GPS data contained";
578 leaf satellites-tracked {
580 description "Number of satellites tracked";
584 "Containes information about geo location";
589 "Distance above the sea level.";
592 type geographic-coordinate-degree {
596 "Relative position north or south on the Earth's surface.";
599 type geographic-coordinate-degree {
603 "Angular distance east or west on the Earth's surface.";
610 //notification statement
611 notification synchronization-state-change {
613 "Notification used to inform about synchronization state change";
617 path "/sync/sync-status/sync-state";
620 "State of RU synchronization is notified at state change";
624 notification ptp-state-change {
626 "Notification used to inform about ptp synchronization state change";
630 path "/sync/ptp-status/lock-state";
633 "ptp-state-change notification is signalled from RU at state change";
636 notification synce-state-change {
638 "Notification used to inform about synce synchronization state change";
642 path "/sync/synce-status/lock-state";
645 "synce-state change notification is signalled from RU at state change";
648 notification gnss-state-change {
651 "Notification used to inform about gnss synchronization state change";
655 path "/sync/gnss-state/gnss-status";
658 "gnss-state-change notification is signalled from RU at state change";