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 //checkAL added o-ran-transceiver: before interface-name
85 path "/if:interfaces/if:interface[if:name = current()/../o-ran-transceiver:interface-name]" + "/o-ran-int:port-reference/o-ran-int:port-number";
88 "A number which identifies a port. In case of SFP/SFP+
89 port, port number value is 0 to N-1 where N is number of ports
90 in the device. Numbers 0 to N-1 are assigned to ports in order
91 following order of labels on the device (labels for ports are
92 not necessarily numbers starting from zero)";
100 "A name that is unique across the O-RU that identifies a transceiver instance.
101 This name may be used in fault management to refer to a fault source
110 "Indicates if pluggable transceiver module is present.";
119 "Name of the transciever vendor Full name of transceiver vendor,
120 that contains ASCII characters, left-aligned with
121 any padding on the right with ASCII spaces (20h), or ASCII nul
122 (00h) removed, and ASCII less-than (3Ch) replaced with ASCII
123 open-brace (7Bh) and ASCII more-than (3Eh) replaced with ASCII
126 Optional node included when the NETCONF Server has determined
136 "Transceiver vendors part number, that contains ASCII characters,
137 left-aligned with any padding on the right with ASCII spaces
138 (20h), or ASCII nul (00h) removed, and ASCII less-than (3Ch)
139 replaced with ASCII open-brace (7Bh) and ASCII more-than (3Eh)
140 replaced with ASCII close-brace (7Dh).
142 Optional node included when the NETCONF Server has determined
143 the vendor part number.";
152 "Transceiver vendors revision number. 2-octet field that
153 contains ASCII characters.
155 Optional node included when the NETCONF Server has determined
156 the vendor revision number";
165 "Transceiver serial number encoded using ASCII characters,
166 left-aligned with any padding on the right with ASCII spaces
167 (20h), or ASCII nul (00h) removed, and ASCII less-than (3Ch)
168 replaced with ASCII open-brace (7Bh) and ASCII more-than (3Eh)
169 replaced with ASCII close-brace (7Dh).
171 Optional node included when the NETCONF Server has determined
175 leaf SFF8472-compliance-code {
177 enum diagnostics-undefined {
178 description "undefined compliance code";
180 enum rev9.3-diagnostics {
181 description "diagnostics published 08-01-02";
183 enum rev9.5-diagnostics{
184 description "diagnostics published 06-01-04";
186 enum rev10.2-diagnostics{
187 description "diagnostics published 06-01-07";
189 enum rev11.0-diagnostics{
190 description "diagnostics published 05-21-10";
192 enum rev11.3-diagnostics{
193 description "diagnostics published 06-11-13";
195 enum rev11.4-diagnostics{
196 description "diagnostics published 07-24-14";
198 enum rev12.0-diagnostics{
199 description "diagnostics published 08-28-14";
204 "Indication of which feature set(s) are
205 implemented in the transceiver from Byte 94 of address A0h
206 https://ta.snia.org/higherlogic/ws/public/download/294/SFF-8472.PDF
208 Optional node included when the NETCONF Server has determined
209 the compliance code.";
211 reference "https://ta.snia.org/higherlogic/ws/public/download/294/SFF-8472.PDF";
214 leaf connector-type {
217 description "encoded as 00h in Table 4-3 of SFF-8024";
219 enum subscrber-connector {
220 description "encoded as 01h in Table 4-3 of SFF-8024";
223 description "encoded as 06h in Table 4-3 of SFF-8024";
225 enum lucent-connector {
226 description "encoded as 07h in Table 4-3 of SFF-8024";
229 description "encoded as 08h in Table 4-3 of SFF-8024";
231 enum multiple-optical {
232 description "encoded as 09h in Table 4-3 of SFF-8024";
235 description "encoded as 0Ah in Table 4-3 of SFF-8024";
237 enum optical-pigtail {
238 description "encoded as 0Bh in Table 4-3 of SFF-8024";
240 enum multi-fiber-parralel-optic-1x12 {
241 description "encoded as 0Ch in Table 4-3 of SFF-8024";
243 enum multi-fiber-parralel-optic-2x16 {
244 description "encoded as 0Dh in Table 4-3 of SFF-8024";
247 description "encoded as 20h in Table 4-3 of SFF-8024";
250 description "encoded as 21h in Table 4-3 of SFF-8024";
253 description "encoded as 22h in Table 4-3 of SFF-8024";
255 enum no-separable-connector{
256 description "encoded as 23h in Table 4-3 of SFF-8024";
259 description "encoded as 24h in Table 4-3 of SFF-8024";
263 // TOCHECK: Remove any enumerations which are not applicable
265 "Connector-type indicates the external optical or electrical cable
266 connector provided as the media interface as defined in the connector
267 types derived from table 4-3 in SFF-8024.
269 Optional node included when the NETCONF Server has determined
270 the connector type.";
271 reference "https://ta.snia.org/higherlogic/ws/public/document?document_id=944";
277 description "encoded as 00h in Table 4-1 of SFF-8024";
280 description "encoded as 01h in Table 4-1 of SFF-8024";
283 description "encoded as 02h in Table 4-1 of SFF-8024";
286 description "encoded as 03h in Table 4-1 of SFF-8024";
289 description "encoded as 04h in Table 4-1 of SFF-8024";
292 description "encoded as 05h in Table 4-1 of SFF-8024";
295 description "encoded as 06h in Table 4-1 of SFF-8024";
298 description "encoded as 07h in Table 4-1 of SFF-8024";
301 description "encoded as 08h in Table 4-1 of SFF-8024";
304 description "encoded as 09h in Table 4-1 of SFF-8024";
307 description "encoded as 0Ah in Table 4-1 of SFF-8024";
310 description "encoded as 0Bh in Table 4-1 of SFF-8024";
313 description "encoded as 0Ch in Table 4-1 of SFF-8024";
316 description "encoded as 0Dh in Table 4-1 of SFF-8024";
321 "Connector identifier as defined in the identifer
322 types derived from table 4-1 in SFF-8024.
324 Optional node included when the NETCONF Server has determined
325 the identifier type.";
326 reference "https://members.snia.org/document/dl/26423";
329 leaf nominal-bitrate {
333 "Nominal bitrate in Mb/s (10^6 bits per second).
334 If needed actual value is rounded to nearest integer.
336 Optional node included when the NETCONF Server has determined
337 the nominal bit rate.";
340 leaf low-bitrate-margin {
344 "Minimum supported bitrate as percentage of nominal bitrate
345 below nominal bitrate.
347 Optional node included when the NETCONF Server has determined
348 the low bit rate margin";
351 leaf high-bitrate-margin {
355 "Maximum supported bitrate as percentage of nominal bitrate
356 above nominal bitrate.
358 Optional node included when the NETCONF Server has determined
359 the high bitrate margin.";
365 description "oma = optical modulation amplitude";
368 description "avp = average power";
373 "Receieved power measurement type
374 oma = optical modulation amplitude
377 Optional node included when the NETCONF Server has determined
387 "Measured RX input power in mW.
389 Optional node included when the NETCONF Server has determined
390 the measured RX power.
392 If operating with QSFP, this power corresponds to that of
402 "Measured coupled TX output power in mW.
404 Optional node included when the NETCONF Server has determined
405 the measured coupled TX power.";
408 leaf tx-bias-current {
414 "Measured transmitter laser bias current in mA.
416 Optional node included when the NETCONF Server has determined
419 If operating with QSFP, this bias current corresponds to that of
429 "Internally measured supply voltage in mV.
431 Optional node included when the NETCONF Server has determined
432 the internally measured voltage.";
441 "Internally measured module temperature in degrees Celcius.
443 Optional node included when the NETCONF Server has determined
447 list additional-multi-lane-reporting {
448 when "(../identifier ='qsfp')or(../identifier ='qsfp+')";
451 "Additional reporting according to SFF8436 which specifies real time
452 channel monitoring for each transmit and receive channel and includes
453 optical input power and Tx bias current. ";
460 "the specific lane/channel associated with the report parameters";
468 "Measured RX input power in mW.
470 Optional node included when the NETCONF Server has determined
471 the measured RX power for a particular lane/channel
472 - see tabel 7-10 of SFF-8636.";
474 leaf tx-bias-current {
480 "Measured transmitter laser bias current in mA.
482 Optional node included when the NETCONF Server has determined
483 the tx bias current for a particular lane/channel
484 - see tabel 7-10 of SFF-8636.";
492 "Measured coupled TX output power in mW.
494 Optional node included when the NETCONF Server has determined
495 the measured coupled TX power or a particular lane/channel
496 - see tabel 7010 of SFF-8636.";
503 // Top Level Container
505 container port-transceivers {
507 "Container for Port transceiver information.
508 Leaf nodes providing parameters status and diagnostic
509 information for pluggable transceiver module (like SFP,
512 uses transceiver-group;