1 module o-ran-transceiver {
3 namespace "urn:o-ran:transceiver:1.0";
4 prefix "o-ran-transceiver";
6 import o-ran-interfaces {
10 import ietf-interfaces {
14 organization "O-RAN Alliance";
20 "This module defines the operational state data for SFP transceivers used in
23 Copyright 2019 the O-RAN Alliance.
25 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS'
26 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
29 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35 POSSIBILITY OF SUCH DAMAGE.
37 Redistribution and use in source and binary forms, with or without
38 modification, are permitted provided that the following conditions are met:
40 * Redistributions of source code must retain the above copyright notice,
41 this list of conditions and the above disclaimer.
42 * Redistributions in binary form must reproduce the above copyright notice,
43 this list of conditions and the above disclaimer in the documentation
44 and/or other materials provided with the distribution.
45 * Neither the Members of the O-RAN Alliance nor the names of its
46 contributors may be used to endorse or promote products derived from
47 this software without specific prior written permission.";
49 revision "2019-07-03" {
53 1) introduction of reporting for QSFP.
54 2) backward compatible changes to introduce groupings.";
56 reference "ORAN-WG4.M.0-v02.00";
59 revision "2019-02-04" {
63 1) imported model from xRAN
64 2) changed namespace and reference from xran to o-ran";
66 reference "ORAN-WG4.M.0-v01.00";
72 grouping transceiver-group {
73 list port-transceiver-data {
74 key "interface-name port-number";
75 description "data recovered from port transceivers";
78 path "/if:interfaces/if:interface/if:name";
80 description "Name of interface";
84 path "/if:interfaces/if:interface[if:name = current()/../interface-name]" + "/o-ran-int:port-reference/o-ran-int:port-number";
87 "A number which identifies a port. In case of SFP/SFP+
88 port, port number value is 0 to N-1 where N is number of ports
89 in the device. Numbers 0 to N-1 are assigned to ports in order
90 following order of labels on the device (labels for ports are
91 not necessarily numbers starting from zero)";
99 "A name that is unique across the O-RU that identifies a transceiver instance.
100 This name may be used in fault management to refer to a fault source
109 "Indicates if pluggable transceiver module is present.";
118 "Name of the transciever vendor Full name of transceiver vendor,
119 that contains ASCII characters, left-aligned with
120 any padding on the right with ASCII spaces (20h), or ASCII nul
121 (00h) removed, and ASCII less-than (3Ch) replaced with ASCII
122 open-brace (7Bh) and ASCII more-than (3Eh) replaced with ASCII
125 Optional node included when the NETCONF Server has determined
135 "Transceiver vendors part number, that contains ASCII characters,
136 left-aligned with any padding on the right with ASCII spaces
137 (20h), or ASCII nul (00h) removed, and ASCII less-than (3Ch)
138 replaced with ASCII open-brace (7Bh) and ASCII more-than (3Eh)
139 replaced with ASCII close-brace (7Dh).
141 Optional node included when the NETCONF Server has determined
142 the vendor part number.";
151 "Transceiver vendors revision number. 2-octet field that
152 contains ASCII characters.
154 Optional node included when the NETCONF Server has determined
155 the vendor revision number";
164 "Transceiver serial number encoded using ASCII characters,
165 left-aligned with any padding on the right with ASCII spaces
166 (20h), or ASCII nul (00h) removed, and ASCII less-than (3Ch)
167 replaced with ASCII open-brace (7Bh) and ASCII more-than (3Eh)
168 replaced with ASCII close-brace (7Dh).
170 Optional node included when the NETCONF Server has determined
174 leaf SFF8472-compliance-code {
176 enum diagnostics-undefined {
177 description "undefined compliance code";
179 enum rev9.3-diagnostics {
180 description "diagnostics published 08-01-02";
182 enum rev9.5-diagnostics{
183 description "diagnostics published 06-01-04";
185 enum rev10.2-diagnostics{
186 description "diagnostics published 06-01-07";
188 enum rev11.0-diagnostics{
189 description "diagnostics published 05-21-10";
191 enum rev11.3-diagnostics{
192 description "diagnostics published 06-11-13";
194 enum rev11.4-diagnostics{
195 description "diagnostics published 07-24-14";
197 enum rev12.0-diagnostics{
198 description "diagnostics published 08-28-14";
203 "Indication of which feature set(s) are
204 implemented in the transceiver from Byte 94 of address A0h
205 https://ta.snia.org/higherlogic/ws/public/download/294/SFF-8472.PDF
207 Optional node included when the NETCONF Server has determined
208 the compliance code.";
210 reference "https://ta.snia.org/higherlogic/ws/public/download/294/SFF-8472.PDF";
213 leaf connector-type {
216 description "encoded as 00h in Table 4-3 of SFF-8024";
218 enum subscrber-connector {
219 description "encoded as 01h in Table 4-3 of SFF-8024";
222 description "encoded as 06h in Table 4-3 of SFF-8024";
224 enum lucent-connector {
225 description "encoded as 07h in Table 4-3 of SFF-8024";
228 description "encoded as 08h in Table 4-3 of SFF-8024";
230 enum multiple-optical {
231 description "encoded as 09h in Table 4-3 of SFF-8024";
234 description "encoded as 0Ah in Table 4-3 of SFF-8024";
236 enum optical-pigtail {
237 description "encoded as 0Bh in Table 4-3 of SFF-8024";
239 enum multi-fiber-parralel-optic-1x12 {
240 description "encoded as 0Ch in Table 4-3 of SFF-8024";
242 enum multi-fiber-parralel-optic-2x16 {
243 description "encoded as 0Dh in Table 4-3 of SFF-8024";
246 description "encoded as 20h in Table 4-3 of SFF-8024";
249 description "encoded as 21h in Table 4-3 of SFF-8024";
252 description "encoded as 22h in Table 4-3 of SFF-8024";
254 enum no-separable-connector{
255 description "encoded as 23h in Table 4-3 of SFF-8024";
258 description "encoded as 24h in Table 4-3 of SFF-8024";
262 // TOCHECK: Remove any enumerations which are not applicable
264 "Connector-type indicates the external optical or electrical cable
265 connector provided as the media interface as defined in the connector
266 types derived from table 4-3 in SFF-8024.
268 Optional node included when the NETCONF Server has determined
269 the connector type.";
270 reference "https://ta.snia.org/higherlogic/ws/public/document?document_id=944";
276 description "encoded as 00h in Table 4-1 of SFF-8024";
279 description "encoded as 01h in Table 4-1 of SFF-8024";
282 description "encoded as 02h in Table 4-1 of SFF-8024";
285 description "encoded as 03h in Table 4-1 of SFF-8024";
288 description "encoded as 04h in Table 4-1 of SFF-8024";
291 description "encoded as 05h in Table 4-1 of SFF-8024";
294 description "encoded as 06h in Table 4-1 of SFF-8024";
297 description "encoded as 07h in Table 4-1 of SFF-8024";
300 description "encoded as 08h in Table 4-1 of SFF-8024";
303 description "encoded as 09h in Table 4-1 of SFF-8024";
306 description "encoded as 0Ah in Table 4-1 of SFF-8024";
309 description "encoded as 0Bh in Table 4-1 of SFF-8024";
312 description "encoded as 0Ch in Table 4-1 of SFF-8024";
315 description "encoded as 0Dh in Table 4-1 of SFF-8024";
320 "Connector identifier as defined in the identifer
321 types derived from table 4-1 in SFF-8024.
323 Optional node included when the NETCONF Server has determined
324 the identifier type.";
325 reference "https://members.snia.org/document/dl/26423";
328 leaf nominal-bitrate {
332 "Nominal bitrate in Mb/s (10^6 bits per second).
333 If needed actual value is rounded to nearest integer.
335 Optional node included when the NETCONF Server has determined
336 the nominal bit rate.";
339 leaf low-bitrate-margin {
343 "Minimum supported bitrate as percentage of nominal bitrate
344 below nominal bitrate.
346 Optional node included when the NETCONF Server has determined
347 the low bit rate margin";
350 leaf high-bitrate-margin {
354 "Maximum supported bitrate as percentage of nominal bitrate
355 above nominal bitrate.
357 Optional node included when the NETCONF Server has determined
358 the high bitrate margin.";
364 description "oma = optical modulation amplitude";
367 description "avp = average power";
372 "Receieved power measurement type
373 oma = optical modulation amplitude
376 Optional node included when the NETCONF Server has determined
386 "Measured RX input power in mW.
388 Optional node included when the NETCONF Server has determined
389 the measured RX power.
391 If operating with QSFP, this power corresponds to that of
401 "Measured coupled TX output power in mW.
403 Optional node included when the NETCONF Server has determined
404 the measured coupled TX power.";
407 leaf tx-bias-current {
413 "Measured transmitter laser bias current in mA.
415 Optional node included when the NETCONF Server has determined
418 If operating with QSFP, this bias current corresponds to that of
428 "Internally measured supply voltage in mV.
430 Optional node included when the NETCONF Server has determined
431 the internally measured voltage.";
440 "Internally measured module temperature in degrees Celcius.
442 Optional node included when the NETCONF Server has determined
446 list additional-multi-lane-reporting {
447 when "(../identifier ='qsfp')or(../identifier ='qsfp+')";
450 "Additional reporting according to SFF8436 which specifies real time
451 channel monitoring for each transmit and receive channel and includes
452 optical input power and Tx bias current. ";
459 "the specific lane/channel associated with the report parameters";
467 "Measured RX input power in mW.
469 Optional node included when the NETCONF Server has determined
470 the measured RX power for a particular lane/channel
471 - see tabel 7-10 of SFF-8636.";
473 leaf tx-bias-current {
479 "Measured transmitter laser bias current in mA.
481 Optional node included when the NETCONF Server has determined
482 the tx bias current for a particular lane/channel
483 - see tabel 7-10 of SFF-8636.";
491 "Measured coupled TX output power in mW.
493 Optional node included when the NETCONF Server has determined
494 the measured coupled TX power or a particular lane/channel
495 - see tabel 7010 of SFF-8636.";
502 // Top Level Container
504 container port-transceivers {
506 "Container for Port transceiver information.
507 Leaf nodes providing parameters status and diagnostic
508 information for pluggable transceiver module (like SFP,
511 uses transceiver-group;