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 "2022-12-05" {
53 1) enable more than one interface to be accessible through a transceiver";
55 reference "ORAN-WG4.M.0-v11.00";
59 revision "2022-08-15" {
63 1) introduced new SFP compliance codes and updated references";
65 reference "ORAN-WG4.M.0-v10.00";
68 revision "2021-12-01" {
72 1) typographical corrections in descriptions
73 2) clarifying vendor name follows SFF 8472";
75 reference "ORAN-WG4.M.0-v02.00";
79 revision "2019-07-03" {
83 1) introduction of reporting for QSFP.
84 2) backward compatible changes to introduce groupings.";
86 reference "ORAN-WG4.M.0-v02.00";
89 revision "2019-02-04" {
93 1) imported model from xRAN
94 2) changed namespace and reference from xran to o-ran";
96 reference "ORAN-WG4.M.0-v01.00";
102 grouping transceiver-group {
103 description "a transceiver grouping";
104 list port-transceiver-data {
105 key "interface-name port-number";
107 "Data recovered from port transceivers.
108 A single entry in the list is created per transceiver.";
109 leaf interface-name {
111 path "/if:interfaces/if:interface/if:name";
114 "Name of an interface accessible through the transceiver.
116 If operating with a QSFP, then the interface corresponds
117 to an interface accessible through the lane/channel 1 of the QSFP.
119 If more than one interface is accessible through the transceiver
120 or the lane/channel 1 of the QSFP, then O-RU arbitrarily chooses
121 the referenced interface instance.";
126 path "/if:interfaces/if:interface[if:name = current()/../interface-name]" + "/o-ran-int:port-reference/o-ran-int:port-number";
129 "A number which identifies a port. In case of SFP/SFP+
130 port, port number value is 0 to N-1 where N is number of ports
131 in the device. Numbers 0 to N-1 are assigned to ports in order
132 following order of labels on the device (labels for ports are
133 not necessarily numbers starting from zero)";
136 leaf-list interface-names {
138 path "/if:interfaces/if:interface/if:name";
141 "Names of all interfaces accessible through the transceiver.
143 If operating with a QSFP, then the interfaces correspond
144 to all interfaces accessible through the lane/channel 1 of the QSFP.
146 O-RU provides the values only if more than one interface is
147 accessible through the transceiver or the lane/channel 1 of the QSFP.";
155 "A name that is unique across the O-RU that identifies a transceiver instance.
156 This name may be used in fault management to refer to a fault source
165 "Indicates if pluggable transceiver module is present.";
174 "Name of the transceiver vendor Full name of transceiver vendor,
175 that contains ASCII characters, left-aligned with
176 any padding on the right with ASCII spaces (20h), or ASCII nul
177 (00h) removed, and ASCII less-than (3Ch) replaced with ASCII
178 open-brace (7Bh) and ASCII more-than (3Eh) replaced with ASCII
181 Optional node included when the NETCONF Server has determined
182 the vendor ID. When used, the content of this schema node
183 follows the definition of Vendor name field in SFF-8472.";
192 "Transceiver vendors part number, that contains ASCII characters,
193 left-aligned with any padding on the right with ASCII spaces
194 (20h), or ASCII nul (00h) removed, and ASCII less-than (3Ch)
195 replaced with ASCII open-brace (7Bh) and ASCII more-than (3Eh)
196 replaced with ASCII close-brace (7Dh).
198 Optional node included when the NETCONF Server has determined
199 the vendor part number. When used, the content of this schema node
200 follows the definition of Vendor PN field in SFF-8472.";
209 "Transceiver vendors revision number. 2-octet field that
210 contains ASCII characters.
212 Optional node included when the NETCONF Server has determined
213 the vendor revision number. When used, the content of this schema
214 node follows the definition of Vendor Rev field in SFF-8472.";
223 "Transceiver serial number encoded using ASCII characters,
224 left-aligned with any padding on the right with ASCII spaces
225 (20h), or ASCII nul (00h) removed, and ASCII less-than (3Ch)
226 replaced with ASCII open-brace (7Bh) and ASCII more-than (3Eh)
227 replaced with ASCII close-brace (7Dh).
229 Optional node included when the NETCONF Server has determined
233 leaf SFF8472-compliance-code {
235 enum diagnostics-undefined {
236 description "undefined compliance code";
238 enum rev9.3-diagnostics {
239 description "diagnostics published 08-01-02";
241 enum rev9.5-diagnostics{
242 description "diagnostics published 06-01-04";
244 enum rev10.2-diagnostics{
245 description "diagnostics published 06-01-07";
247 enum rev11.0-diagnostics{
248 description "diagnostics published 05-21-10";
250 enum rev11.3-diagnostics{
251 description "diagnostics published 06-11-13";
253 enum rev11.4-diagnostics{
254 description "diagnostics published 07-24-14";
256 enum rev12.0-diagnostics{
259 "diagnostics published 08-28-14
260 Note: Deprecated as it does not exists in SFF-8472 v12.4";
262 enum rev10.4-diagnostics{
263 description "diagnostics published 30-01-09";
265 enum rev12.3-diagnostics{
266 description "diagnostics published 29-07-18";
268 enum rev12.4-diagnostics{
269 description "diagnostics published 31-03-21";
274 "Indication of which feature set(s) are
275 implemented in the transceiver from Byte 94 of address A0h
276 https://members.snia.org/document/dl/25916 v12.4
278 Optional node included when the NETCONF Server has determined
279 the compliance code.";
281 reference "https://members.snia.org/document/dl/25916";
284 leaf connector-type {
287 description "encoded as 00h in Table 4-3 of SFF-8024";
289 enum subscrber-connector {
290 description "encoded as 01h in Table 4-3 of SFF-8024";
293 description "encoded as 06h in Table 4-3 of SFF-8024";
295 enum lucent-connector {
296 description "encoded as 07h in Table 4-3 of SFF-8024";
299 description "encoded as 08h in Table 4-3 of SFF-8024";
301 enum multiple-optical {
302 description "encoded as 09h in Table 4-3 of SFF-8024";
305 description "encoded as 0Ah in Table 4-3 of SFF-8024";
307 enum optical-pigtail {
308 description "encoded as 0Bh in Table 4-3 of SFF-8024";
310 enum multi-fiber-parralel-optic-1x12 {
311 description "encoded as 0Ch in Table 4-3 of SFF-8024";
313 enum multi-fiber-parralel-optic-2x16 {
314 description "encoded as 0Dh in Table 4-3 of SFF-8024";
317 description "encoded as 20h in Table 4-3 of SFF-8024";
320 description "encoded as 21h in Table 4-3 of SFF-8024";
323 description "encoded as 22h in Table 4-3 of SFF-8024";
325 enum no-separable-connector{
326 description "encoded as 23h in Table 4-3 of SFF-8024";
329 description "encoded as 24h in Table 4-3 of SFF-8024";
333 // TOCHECK: Remove any enumerations which are not applicable
335 "Connector-type indicates the external optical or electrical cable
336 connector provided as the media interface as defined in the connector
337 types derived from table 4-3 in SFF-8024.
339 Optional node included when the NETCONF Server has determined
340 the connector type.";
341 reference "https://ta.snia.org/higherlogic/ws/public/document?document_id=944";
347 description "encoded as 00h in Table 4-1 of SFF-8024";
350 description "encoded as 01h in Table 4-1 of SFF-8024";
353 description "encoded as 02h in Table 4-1 of SFF-8024";
356 description "encoded as 03h in Table 4-1 of SFF-8024";
359 description "encoded as 04h in Table 4-1 of SFF-8024";
362 description "encoded as 05h in Table 4-1 of SFF-8024";
365 description "encoded as 06h in Table 4-1 of SFF-8024";
368 description "encoded as 07h in Table 4-1 of SFF-8024";
371 description "encoded as 08h in Table 4-1 of SFF-8024";
374 description "encoded as 09h in Table 4-1 of SFF-8024";
377 description "encoded as 0Ah in Table 4-1 of SFF-8024";
380 description "encoded as 0Bh in Table 4-1 of SFF-8024";
383 description "encoded as 0Ch in Table 4-1 of SFF-8024";
386 description "encoded as 0Dh in Table 4-1 of SFF-8024";
391 "Connector identifier as defined in the identifier
392 types derived from table 4-1 in SFF-8024.
394 Optional node included when the NETCONF Server has determined
395 the identifier type.";
396 reference "https://members.snia.org/document/dl/26423";
399 leaf nominal-bitrate {
403 "Nominal bitrate in Mb/s (10^6 bits per second).
404 If needed actual value is rounded to the nearest integer.
406 Optional node included when the NETCONF Server has determined
407 the nominal bit rate.";
410 leaf low-bitrate-margin {
414 "Minimum supported bitrate as percentage of nominal bitrate
415 below nominal bitrate.
417 Optional node included when the NETCONF Server has determined
418 the low bit rate margin";
421 leaf high-bitrate-margin {
425 "Maximum supported bitrate as percentage of nominal bitrate
426 above nominal bitrate.
428 Optional node included when the NETCONF Server has determined
429 the high bitrate margin.";
435 description "oma = optical modulation amplitude";
438 description "avp = average power";
443 "Received power measurement type
444 oma = optical modulation amplitude
447 Optional node included when the NETCONF Server has determined
457 "Measured RX input power in mW.
459 Optional node included when the NETCONF Server has determined
460 the measured RX power.
462 If operating with QSFP, this power corresponds to that of
472 "Measured coupled TX output power in mW.
474 Optional node included when the NETCONF Server has determined
475 the measured coupled TX power.";
478 leaf tx-bias-current {
484 "Measured transmitter laser bias current in mA.
486 Optional node included when the NETCONF Server has determined
489 If operating with QSFP, this bias current corresponds to that of
499 "Internally measured supply voltage in mV.
501 Optional node included when the NETCONF Server has determined
502 the internally measured voltage.";
511 "Internally measured module temperature in degrees Celsius.
513 Optional node included when the NETCONF Server has determined
517 list additional-multi-lane-reporting {
518 when "(../identifier ='qsfp')or(../identifier ='qsfp+')";
522 "Additional reporting according to SFF8436 which specifies real time
523 channel monitoring for each transmit and receive channel and includes
524 optical input power and Tx bias current. ";
531 "the specific lane/channel associated with the report parameters";
533 leaf-list interface-names {
535 path "/if:interfaces/if:interface/if:name";
538 "Names of all interfaces accessible through a particular lane/channel.";
546 "Measured RX input power in mW.
548 Optional node included when the NETCONF Server has determined
549 the measured RX power for a particular lane/channel
550 - see tabel 7-10 of SFF-8636.";
552 leaf tx-bias-current {
558 "Measured transmitter laser bias current in mA.
560 Optional node included when the NETCONF Server has determined
561 the tx bias current for a particular lane/channel
562 - see tabel 7-10 of SFF-8636.";
570 "Measured coupled TX output power in mW.
572 Optional node included when the NETCONF Server has determined
573 the measured coupled TX power or a particular lane/channel
574 - see tabel 7010 of SFF-8636.";
581 // Top Level Container
583 container port-transceivers {
585 "Container for Port transceiver information.
586 Leaf nodes providing parameters status and diagnostic
587 information for pluggable transceiver module (like SFP,
590 uses transceiver-group;