[sfp-refactor] Add new sonic_xcvr package for common transceiver logic (

#201)

First-cut changes to provide platform independent support for different transceivers in SONiC platforms.

setup.py

@@ -20,6 +20,14 @@
         'sonic_platform_base.sonic_ssd',
         'sonic_platform_base.sonic_pcie',
         'sonic_platform_base.sonic_thermal_control',
+        'sonic_platform_base.sonic_xcvr',
+        'sonic_platform_base.sonic_xcvr.fields',
+        'sonic_platform_base.sonic_xcvr.mem_maps',
+        'sonic_platform_base.sonic_xcvr.mem_maps.public',
+        'sonic_platform_base.sonic_xcvr.api',
+        'sonic_platform_base.sonic_xcvr.api.public',
+        'sonic_platform_base.sonic_xcvr.codes',
+        'sonic_platform_base.sonic_xcvr.codes.public',
         'sonic_psu',
         'sonic_sfp',
         'sonic_thermal',

sonic_platform_base/sfp_base.py

@@ -8,6 +8,7 @@
 import sys
 from . import device_base
 
+from .sonic_xcvr.xcvr_api_factory import XcvrApiFactory
 
 class SfpBase(device_base.DeviceBase):
     """
@@ -55,6 +56,8 @@ def __init__(self):
         # List of ThermalBase-derived objects representing all thermals
         # available on the SFP
         self._thermal_list = []
+        self._xcvr_api_factory = XcvrApiFactory(self.read_eeprom, self.write_eeprom)
+        self._xcvr_api = None
 
     def get_num_thermals(self):
         """
@@ -429,3 +432,20 @@ def get_error_description(self):
             like: "Bad EEPROM|Unsupported cable"
         """
         raise NotImplementedError
+
+    def refresh_xcvr_api(self):
+        """
+        Updates the XcvrApi associated with this SFP
+        """
+        self._xcvr_api = self._xcvr_api_factory.create_xcvr_api()
+
+    def get_xcvr_api(self):
+        """
+        Retrieves the XcvrApi associated with this SFP
+
+        Returns:
+            An object derived from XcvrApi that corresponds to the SFP
+        """
+        if self._xcvr_api is None:
+            self.refresh_xcvr_api()
+        return self._xcvr_api

sonic_platform_base/sonic_xcvr/api/public/cmis.py

@@ -0,0 +1,20 @@
+"""
+    cmis.py
+
+    Implementation of XcvrApi that corresponds to CMIS
+"""
+
+from ...fields import consts
+from ..xcvr_api import XcvrApi
+
+class CmisApi(XcvrApi):
+    NUM_CHANNELS = 8
+
+    def __init__(self, xcvr_eeprom):
+        super(CmisApi, self).__init__(xcvr_eeprom)
+
+    def get_model(self):
+        return self.xcvr_eeprom.read(consts.VENDOR_PART_NO_FIELD)
+
+    # TODO: other XcvrApi methods
+

sonic_platform_base/sonic_xcvr/api/xcvr_api.py

@@ -0,0 +1,285 @@
+"""
+    xcvr_api.py
+
+    Abstract base class for platform-independent APIs used to interact with
+    xcvrs in SONiC
+"""
+
+class XcvrApi(object):
+    def __init__(self, xcvr_eeprom):
+        self.xcvr_eeprom = xcvr_eeprom
+
+    def get_model(self):
+        """
+        Retrieves the model (part number) of the xcvr
+
+        Returns:
+            A string, the model/part number of the xcvr
+        """
+        raise NotImplementedError
+
+    def get_serial(self):
+        """
+        Retrieves the serial number of the xcvr
+
+        Returns:
+            A string, the serial number of the xcvr
+        """
+        raise NotImplementedError
+
+    def get_transceiver_info(self):
+        """
+        Retrieves general info about this xcvr
+
+        Returns:
+            A dict containing the following keys/values :
+        ================================================================================
+        keys                       |Value Format   |Information
+        ---------------------------|---------------|----------------------------
+        type                       |string         |type of xcvr
+        type_abbrv_name            |string         |type of SFP, abbreviated
+        hardware_rev               |string         |hardware version of xcvr
+        serial                     |string         |serial number of the xcvr
+        manufacturer               |string         |xcvr vendor name
+        model                      |string         |xcvr model name
+        connector                  |string         |connector information
+        encoding                   |string         |encoding information
+        ext_identifier             |string         |extend identifier
+        ext_rateselect_compliance  |string         |extended rateSelect compliance
+        cable_length               |int            |cable length in m
+        nominal_bit_rate           |int            |nominal bit rate by 100Mbs
+        specification_compliance   |string         |specification compliance
+        vendor_date                |string         |vendor date
+        vendor_oui                 |string         |vendor OUI
+        application_advertisement  |string         |supported applications advertisement
+        ================================================================================
+        """
+        raise NotImplementedError
+
+    def get_transceiver_bulk_status(self):
+        """
+        Retrieves bulk status info for this xcvr
+
+        Returns:
+            A dict containing the following keys/values :
+        ========================================================================
+        keys                       |Value Format   |Information
+        ---------------------------|---------------|----------------------------
+        rx_los                     |bool           |RX loss-of-signal status, True if has RX los, False if not.
+        tx_fault                   |bool           |TX fault status, True if has TX fault, False if not.
+        tx_disable                 |bool           |TX disable status, True TX disabled, False if not.
+        tx_disabled_channel        |int            |disabled TX channels in hex, bits 0 to 3 represent channel 0
+                                   |               |to channel 3 (for example).
+        temperature                |float          |module temperature in Celsius
+        voltage                    |float          |supply voltage in mV
+        tx<n>bias                  |float          |TX Bias Current in mA, n is the channel number,
+                                   |               |for example, tx2bias stands for tx bias of channel 2.
+        rx<n>power                 |float          |received optical power in mW, n is the channel number,
+                                   |               |for example, rx2power stands for rx power of channel 2.
+        tx<n>power                 |float          |TX output power in mW, n is the channel number,
+                                   |               |for example, tx2power stands for tx power of channel 2.
+        ========================================================================
+        """
+        raise NotImplementedError
+
+    def get_transceiver_threshold_info(self):
+        """
+        Retrieves threshold info for this xcvr
+
+        Returns:
+            A dict containing the following keys/values :
+        ========================================================================
+        keys                       |Value Format   |Information
+        ---------------------------|---------------|----------------------------
+        temphighalarm              |FLOAT          |High Alarm Threshold value of temperature in Celsius.
+        templowalarm               |FLOAT          |Low Alarm Threshold value of temperature in Celsius.
+        temphighwarning            |FLOAT          |High Warning Threshold value of temperature in Celsius.
+        templowwarning             |FLOAT          |Low Warning Threshold value of temperature in Celsius.
+        vcchighalarm               |FLOAT          |High Alarm Threshold value of supply voltage in mV.
+        vcclowalarm                |FLOAT          |Low Alarm Threshold value of supply voltage in mV.
+        vcchighwarning             |FLOAT          |High Warning Threshold value of supply voltage in mV.
+        vcclowwarning              |FLOAT          |Low Warning Threshold value of supply voltage in mV.
+        rxpowerhighalarm           |FLOAT          |High Alarm Threshold value of received power in dBm.
+        rxpowerlowalarm            |FLOAT          |Low Alarm Threshold value of received power in dBm.
+        rxpowerhighwarning         |FLOAT          |High Warning Threshold value of received power in dBm.
+        rxpowerlowwarning          |FLOAT          |Low Warning Threshold value of received power in dBm.
+        txpowerhighalarm           |FLOAT          |High Alarm Threshold value of transmit power in dBm.
+        txpowerlowalarm            |FLOAT          |Low Alarm Threshold value of transmit power in dBm.
+        txpowerhighwarning         |FLOAT          |High Warning Threshold value of transmit power in dBm.
+        txpowerlowwarning          |FLOAT          |Low Warning Threshold value of transmit power in dBm.
+        txbiashighalarm            |FLOAT          |High Alarm Threshold value of tx Bias Current in mA.
+        txbiaslowalarm             |FLOAT          |Low Alarm Threshold value of tx Bias Current in mA.
+        txbiashighwarning          |FLOAT          |High Warning Threshold value of tx Bias Current in mA.
+        txbiaslowwarning           |FLOAT          |Low Warning Threshold value of tx Bias Current in mA.
+        ========================================================================
+        """
+        raise NotImplementedError
+
+    def get_rx_los(self):
+        """
+        Retrieves the RX LOS (loss-of-signal) status of this xcvr
+
+        Returns:
+            A list of boolean values, representing the RX LOS status
+            of each available channel, value is True if xcvr channel
+            has RX LOS, False if not.
+            E.g., for a tranceiver with four channels: [False, False, True, False]
+
+            If Rx LOS status is unsupported on the xcvr, each list element should be "N/A" instead.
+        """
+        raise NotImplementedError
+
+    def get_tx_fault(self):
+        """
+        Retrieves the TX fault status of this xcvr
+
+        Returns:
+            A list of boolean values, representing the TX fault status
+            of each available channel, value is True if xcvr channel
+            has TX fault, False if not.
+            E.g., for a tranceiver with four channels: [False, False, True, False]
+
+            If TX fault status is unsupported on the xcvr, each list element should be "N/A" instead.
+        """
+        raise NotImplementedError
+
+    def get_tx_disable(self):
+        """
+        Retrieves the TX disabled channels in this xcvr
+
+        Returns:
+            A hex of 4 bits (bit 0 to bit 3 as channel 0 to channel 3) to represent
+            TX channels which have been disabled in this xcvr.
+            As an example, a returned value of 0x5 indicates that channel 0
+            and channel 2 have been disabled.
+        """
+        raise NotImplementedError
+
+    def get_tx_disable_channel(self):
+        """
+        Retrieves the TX disabled channels in this xcvr
+
+        Returns:
+            A hex of 4 bits (bit 0 to bit 3 as channel 0 to channel 3) to represent
+            TX channels which have been disabled in this xcvr.
+            As an example, a returned value of 0x5 indicates that channel 0
+            and channel 2 have been disabled.
+        """
+        raise NotImplementedError
+
+    def get_temperature(self):
+        """
+        Retrieves the temperature of this xcvr
+
+        Returns:
+            A float representing the current temperature in Celsius, or "N/A" if temperature
+            measurements are unsupported on the xcvr.
+        """
+        raise NotImplementedError
+
+    def get_voltage(self):
+        """
+        Retrieves the supply voltage of this xcvr
+
+        Returns:
+            A float representing the supply voltage in mV, or "N/A" if voltage measurements are
+            unsupported on the xcvr.
+        """
+        raise NotImplementedError
+
+    def get_tx_bias(self):
+        """
+        Retrieves the TX bias current of all xcvr channels
+
+        Returns:
+            A list of floats, representing TX bias in mA
+            for each available channel
+            E.g., for a tranceiver with four channels: ['110.09', '111.12', '108.21', '112.09']
+
+            If TX bias is unsupported on the xcvr, each list element should be "N/A" instead.
+        """
+        raise NotImplementedError
+
+    def get_rx_power(self):
+        """
+        Retrieves the received optical power of all xcvr channels
+
+        Returns:
+            A list of floats, representing received optical
+            power in mW for each available channel
+            E.g., for a tranceiver with four channels: ['1.77', '1.71', '1.68', '1.70']
+
+            If RX power is unsupported on the xcvr, each list element should be "N/A" instead.
+        """
+        raise NotImplementedError
+
+    def get_tx_power(self):
+        """
+        Retrieves the TX power of all xcvr channels
+
+        Returns:
+            A list of floats, representing TX power in mW
+            for each available channel
+            E.g., for a tranceiver with four channels: ['1.86', '1.86', '1.86', '1.86']
+
+            If TX power is unsupported on the xcvr, each list element should be "N/A" instead.
+        """
+        raise NotImplementedError
+
+    def tx_disable(self, tx_disable):
+        """
+        Disable xcvr TX for all channels
+
+        Args:
+            tx_disable : A Boolean, True to enable tx_disable mode, False to disable
+                         tx_disable mode.
+
+        Returns:
+            A boolean, True if tx_disable is set successfully, False if not
+        """
+        raise NotImplementedError
+
+    def tx_disable_channel(self, channel, disable):
+        """
+        Sets the tx_disable for specified xcvr channels
+
+        Args:
+            channel : A hex of 4 bits (bit 0 to bit 3) which represent channel 0 to 3,
+                      e.g. 0x5 for channel 0 and channel 2.
+            disable : A boolean, True to disable TX channels specified in channel,
+                      False to enable
+
+        Returns:
+            A boolean, True if successful, False if not
+        """
+        raise NotImplementedError
+
+    def get_power_override(self):
+        """
+        Retrieves the power-override status of this xcvr
+
+        Returns:
+            A boolean, True if power-override is enabled, False if disabled
+        """
+        raise NotImplementedError
+
+    def set_power_override(self, power_override, power_set):
+        """
+        Sets xcvr power level using power_override and power_set
+
+        Args:
+            power_override :
+                    A Boolean, True to override set_lpmode and use power_set
+                    to control xcvr power, False to disable xcvr power control
+                    through power_override/power_set and use set_lpmode
+                    to control xcvr power.
+            power_set :
+                    Only valid when power_override is True.
+                    A Boolean, True to set xcvr to low power mode, False to set
+                    xcvr to high power mode.
+
+        Returns:
+            A boolean, True if power-override and power_set are set successfully,
+            False if not
+        """
+        raise NotImplementedError