sonic-buildimage/device/celestica/x86_64-cel_e1031-r0/sonic_platform/thermal.py

#############################################################################
# Celestica
#
# Thermal contains an implementation of SONiC Platform Base API and
# provides the thermal device status which are available in the platform
#
#############################################################################

try:
    import os
    from sonic_platform_base.thermal_base import ThermalBase
    from .common import Common
except ImportError as e:
    raise ImportError(str(e) + "- required module not found")


THERMAL_INFO = {
    0: {
        "F2B_max": 55.000,
        "F2B_max_crit": 58.000,
        "B2F_max": 55.000,
        "B2F_max_crit": 58.000,
        "postion": "asic",
        "name": "Inlet ambient sensor (Rear to Front)",
        "ss_index": 1,
        "i2c_path": "i2c-11/11-001a/hwmon",    # U7273
    },
    1: {
        "F2B_max": 85.000,
        "F2B_max_crit": 90.000,
        "B2F_max": 85.000,
        "B2F_max_crit": 90.000,
        "postion": "asic",
        "name": "Helix shutdown sensor (Rear to Front)",
        "ss_index": 2,
        "i2c_path": "i2c-11/11-001a/hwmon",    # Q7000
    },
    2: {
        "F2B_max": 55.000,
        "F2B_max_crit": 58.000,
        "B2F_max": 55.000,
        "B2F_max_crit": 58.000,
        "postion": "asic",
        "name": "Inlet ambient sensor (Front to Rear, right)",
        "ss_index": 3,
        "i2c_path": "i2c-11/11-001a/hwmon",    # Q7001
    },
    3: {
        "F2B_max": 85.000,
        "F2B_max_crit": 90.000,
        "B2F_max": 85.000,
        "B2F_max_crit": 90.000,
        "postion": "asic",
        "name": "Helix shutdown sensor (Front to Rear)",
        "ss_index": 4,
        "i2c_path": "i2c-11/11-001a/hwmon",  # Q7751
    },
    4: {
        "F2B_max": 55.000,
        "F2B_max_crit": 58.000,
        "B2F_max": 55.000,
        "B2F_max_crit": 58.000,
        "postion": "cpu",
        "name": "Inlet ambient sensor (Front to Rear, left)",
        "ss_index": 5,
        "i2c_path": "i2c-11/11-001a/hwmon"   # Q7752
    },
    5: {
        "F2B_max": 90.000,
        "F2B_max_crit": 95.000,
        "B2F_max": 90.000,
        "B2F_max_crit": 95.000,
        "postion": "cpu",
        "name": "CPU errata sensor (Front to Rear)",
        "ss_index": 2,
        "i2c_path": "i2c-3/3-001a/hwmon"   # Q5
    },
    6: {
        "F2B_max": 90.000,
        "F2B_max_crit": 95.000,
        "B2F_max": 90.000,
        "B2F_max_crit": 95.000,
        "postion": "cpu",
        "name": "CPU errata sensor (Rear to Front)",
        "ss_index": 3,
        "i2c_path": "i2c-3/3-001a/hwmon"   # Q6
    }
}
NULL_VAL = "N/A"
I2C_ADAPTER_PATH = "/sys/class/i2c-adapter"


class Thermal(ThermalBase):
    """Platform-specific Thermal class"""

    MAINBOARD_SS_PATH = "/sys/class/i2c-adapter/i2c-11/11-001a/hwmon/hwmon2"
    CPUBOARD_SS_PATH = "/sys/class/i2c-adapter/i2c-3/3-001a/hwmon/hwmon1"
    SS_CONFIG_PATH = "/usr/share/sonic/device/x86_64-cel_e1031-r0/sensors.conf"

    def __init__(self, thermal_index, airflow):
        ThermalBase.__init__(self)
        self.index = thermal_index
        self._api_common = Common()

        self._airflow = airflow
        self._thermal_info = THERMAL_INFO[self.index]
        self._hwmon_path = self._get_hwmon_path()
        self._ss_index = self._thermal_info["ss_index"]

        self.name = self.get_name()
        self.postion = self._thermal_info["postion"]
        self.minimum_thermal = self.get_temperature()
        self.maximum_thermal = self.get_temperature()

    def _get_hwmon_path(self):
        hwmon_path = os.path.join(
            I2C_ADAPTER_PATH, self._thermal_info["i2c_path"])
        hwmon_dir = os.listdir(hwmon_path)[0]
        return os.path.join(hwmon_path, hwmon_dir)

    def _get_temp(self, temp_file):
        temp_file_path = os.path.join(self._hwmon_path, temp_file)
        raw_temp = self._api_common.read_txt_file(temp_file_path)
        temp = float(raw_temp)/1000
        return float("{:.3f}".format(temp))

    def _set_threshold(self, file_name, temperature):
        temp_file_path = os.path.join(self._hwmon_path, file_name)
        return self._api_common.write_txt_file(temp_file_path, str(temperature))

    def _get_threshold(self, file_name):
        temp_file_path = os.path.join(self._hwmon_path, file_name)
        data = self._api_common.read_txt_file(temp_file_path)
        if data:
            try:
                threshold = float(data)
                return round(threshold/1000, 3)
            except Exception:
                pass
        return None

    def get_temperature(self):
        """
        Retrieves current temperature reading from thermal
        Returns:
            A float number of current temperature in Celsius up to nearest thousandth
            of one degree Celsius, e.g. 30.125
        """
        temp_file = "temp{}_input".format(self._ss_index)
        return self._get_temp(temp_file)

    def get_high_threshold(self):
        """
        Retrieves the high threshold temperature of thermal
        Returns:
            A float number, the high threshold temperature of thermal in Celsius
            up to nearest thousandth of one degree Celsius, e.g. 30.125
        """
        max_crit_key = '{}_max'.format(self._airflow)
        high_threshold_file = "temp{}_max".format(self._ss_index)
        return self._get_threshold(high_threshold_file) or self._thermal_info.get(max_crit_key, None)

    def get_low_threshold(self):
        """
        Retrieves the low threshold temperature of thermal
        Returns:
            A float number, the low threshold temperature of thermal in Celsius
            up to nearest thousandth of one degree Celsius, e.g. 30.125
        """
        return 0.001

    def set_high_threshold(self, temperature):
        """
        Sets the high threshold temperature of thermal
        Args :
            temperature: A float number up to nearest thousandth of one degree Celsius,
            e.g. 30.125
        Returns:
            A boolean, True if threshold is set successfully, False if not
        """
        temp_file = "temp{}_max".format(self._ss_index)
        is_set = self._set_threshold(temp_file, int(temperature*1000))
        file_set = True
        if is_set and self._api_common.is_host():
            try:
                with open(self.SS_CONFIG_PATH, 'r+') as f:
                    content = f.readlines()
                    f.seek(0)
                    ss_found = False
                    for idx, val in enumerate(content):
                        if self.name in val:
                            ss_found = True
                        elif ss_found and temp_file in val:
                            content[idx] = "        set {} {}\n".format(
                                temp_file, temperature)
                            f.writelines(content)
                            file_set = True
                            break
            except IOError:
                file_set = False

        return is_set & file_set

    def set_low_threshold(self, temperature):
        """
        Sets the low threshold temperature of thermal
        Args : 
            temperature: A float number up to nearest thousandth of one degree Celsius,
            e.g. 30.125
        Returns:
            A boolean, True if threshold is set successfully, False if not
        """
        return False

    def get_high_critical_threshold(self):
        """
        Retrieves the high critical threshold temperature of thermal
        Returns:
            A float number, the high critical threshold temperature of thermal in Celsius
            up to nearest thousandth of one degree Celsius, e.g. 30.125
        """
        max_crit_key = '{}_max_crit'.format(self._airflow)
        return self._thermal_info.get(max_crit_key, None)

    def get_low_critical_threshold(self):
        """
        Retrieves the low critical threshold temperature of thermal
        Returns:
            A float number, the low critical threshold temperature of thermal in Celsius
            up to nearest thousandth of one degree Celsius, e.g. 30.125
        """
        return 0.001

    def get_minimum_recorded(self):
        """
        Retrieves the minimum recorded temperature of thermal
        Returns:
            A float number, the minimum recorded temperature of thermal in Celsius
            up to nearest thousandth of one degree Celsius, e.g. 30.125
        """
        tmp = self.get_temperature()
        if tmp < self.minimum_thermal:
            self.minimum_thermal = tmp
        return self.minimum_thermal

    def get_maximum_recorded(self):
        """
        Retrieves the maximum recorded temperature of thermal
        Returns:
            A float number, the maximum recorded temperature of thermal in Celsius
            up to nearest thousandth of one degree Celsius, e.g. 30.125
        """
        tmp = self.get_temperature()
        if tmp > self.maximum_thermal:
            self.maximum_thermal = tmp
        return self.maximum_thermal

    ##############################################################
    ###################### Device methods ########################
    ##############################################################

    def get_name(self):
        """
        Retrieves the name of the thermal device
            Returns:
            string: The name of the thermal device
        """
        return self._thermal_info["name"]

    def get_presence(self):
        """
        Retrieves the presence of the PSU
        Returns:
            bool: True if PSU is present, False if not
        """
        temp_file = "temp{}_input".format(self._ss_index)
        temp_file_path = os.path.join(self._hwmon_path, temp_file)
        return os.path.isfile(temp_file_path)

    def get_model(self):
        """
        Retrieves the model number (or part number) of the device
        Returns:
            string: Model/part number of device
        """
        return NULL_VAL

    def get_serial(self):
        """
        Retrieves the serial number of the device
        Returns:
            string: Serial number of device
        """
        return NULL_VAL

    def get_status(self):
        """
        Retrieves the operational status of the device
        Returns:
            A boolean value, True if device is operating properly, False if not
        """
        if not self.get_presence():
            return False

        fault_file = "temp{}_fault".format(self._ss_index)
        fault_file_path = os.path.join(self._hwmon_path, fault_file)
        if not os.path.isfile(fault_file_path):
            return True

        raw_txt = self._api_common.read_txt_file(fault_file_path)
        return int(raw_txt) == 0

    def is_replaceable(self):
        """
        Retrieves whether thermal module is replaceable
        Returns:
            A boolean value, True if replaceable, False if not
        """
        return False

    def get_position_in_parent(self):
        """
        Retrieves the thermal position information
        Returns:
            A int value, 0 represent ASIC thermal, 1 represent CPU thermal info
        """
        if self.postion == "cpu":
            return 1
        return 0