[SONiCBMC] Add updates for platform API's to support leak sensor and switch host power control (#634)

* Add updates for platform API's to support leak sensor and switch host power control
* Add MODULE_TYPE_SWITCH_HOST type to module_base
* Update the LeakSeverity as Enum
* Add an API is_bmc() from PR #647

Author: judyjoseph

sonic_platform_base/chassis_base.py

@@ -158,6 +158,16 @@ def is_modular_chassis(self):
         """
         return False
 
+    def is_bmc(self):
+        """
+        Retrieves whether the sonic instance is a BMC
+
+        Returns:
+            A bool value, should return False by default. BMC card instances
+            running SONiC should return True
+        """
+        return False
+
     def init_midplane_switch(self):
         """
         Initializes the midplane functionality of the modular chassis. For
@@ -247,6 +257,9 @@ def get_module(self, index):
         Retrieves module represented by (0-based) index <index>
         On a SmartSwitch index:0 will fetch DPU0 and so on
 
+        In case of a Switch modelled as a chassis with BMC card,
+        On BMC : index 0 will fetch SWITCH-HOST
+
         Args:
             index: An integer, the index (0-based) of the module to
             retrieve
@@ -273,6 +286,7 @@ def get_module_index(self, module_name):
             module_name: A string, prefixed by SUPERVISOR, LINE-CARD or FABRIC-CARD
             Ex. SUPERVISOR0, LINE-CARD1, FABRIC-CARD5
             SmartSwitch Example: DPU0, DPU1, DPU2 ... DPUX
+            In case of a Switch modelled as a chassis with BMC card: SWITCH-HOST
 
         Returns:
             An integer, the index of the ModuleBase object in the module_list

sonic_platform_base/liquid_cooling_base.py

@@ -5,33 +5,107 @@
     to interact with a liquid cooling module in SONiC
 """
 
+from enum import Enum
 from . import device_base
 from .sensor_base import SensorBase
 import sys
 
+
+class LeakSeverity(Enum):
+    MINOR    = "MINOR"
+    CRITICAL = "CRITICAL"
+
+
 class LeakageSensorBase(SensorBase):
+    # Keep string aliases for backwards compatibility
+    LEAK_SEVERITY_CRITICAL = LeakSeverity.CRITICAL
+    LEAK_SEVERITY_MINOR    = LeakSeverity.MINOR
+
     def __init__(self, name):
         self.name = name
         self.leaking = False
+        self.leak_sensor_ok = True
+        self.leak_type = None
+        self.leak_location = None
+        self.leak_severity = None
 
     def get_name(self):
         """
         Retrieves the name of the leakage sensor
 
         Returns:
-            tring: the name of the leakage sensor
-        """        
+            string: the name of the leakage sensor
+        """
         return self.name
 
     def is_leak(self):
         """
-        Retrieves the leak status of the sensor
+        Retrieves the leak status of the sensor.
+        The platform should apply debounce logic before reporting/clearing leak.
 
         Returns:
             bool: True if leak is detected, False if not
-        """        
+        """
         return self.leaking
 
+    def is_leak_sensor_ok(self):
+        """
+        Retrieves the state of leak sensor whether it is ok or faulty
+
+        Returns:
+            bool: True if leak sensor is ok, False if it is faulty
+        """
+        return self.leak_sensor_ok
+
+    def get_leak_sensor_type(self):
+        """
+        Retrieves the leak sensor type
+
+        Returns:
+            string: the type of the leakage sensor
+        """
+        return self.leak_type
+
+    def get_leak_sensor_location(self):
+        """
+        Retrieves the location of leak sensor
+
+        Returns:
+            string: the location of the leakage sensor
+        """
+        return self.leak_location
+
+    def get_leak_severity(self):
+        """
+        Retrieves the severity of leak
+
+        Returns:
+            LeakSeverity: LeakSeverity.CRITICAL or LeakSeverity.MINOR, or None if no leak
+        """
+        return self.leak_severity
+
+    def get_leak_profile(self):
+        """
+        Returns the leak sensor profile associated with this sensor.
+        """
+        raise NotImplementedError
+
+
+class LeakSensorProfileBase(object):
+    """
+    Platform-specific leak sensor profile, which defines APIs pre leaksensor type
+    """
+
+    def get_leak_max_minor_duration_sec(self):
+        """
+        Maximum time before a minor leak is marked critical.
+
+        Returns:
+            int: time in seconds
+        """
+        raise NotImplementedError
+
+
 class LiquidCoolingBase(device_base.DeviceBase):
     """
     Base class for implementing liquid cooling system

sonic_platform_base/module_base.py

@@ -36,6 +36,9 @@ class ModuleBase(device_base.DeviceBase):
     MODULE_TYPE_FABRIC  = "FABRIC-CARD"
     MODULE_TYPE_DPU  = "DPU"
 
+    # Module Type for Switch on a device having BMC(which controls switch power state)
+    MODULE_TYPE_SWITCH_HOST = "SWITCH-HOST"
+
     # Possible card status for modular chassis
     # Module state is Empty if no module is inserted in the slot
     MODULE_STATUS_EMPTY   = "Empty"
@@ -173,6 +176,8 @@ def get_name(self):
         Retrieves the name of the module prefixed by SUPERVISOR, LINE-CARD,
         FABRIC-CARD, DPU0, DPUX
 
+        It can return name 'SWITCH-HOST' for module type MODULE_TYPE_SWITCH_HOST
+
         Returns:
             A string, the module name prefixed by one of MODULE_TYPE_SUPERVISOR,
             MODULE_TYPE_LINE or MODULE_TYPE_FABRIC or MODULE_TYPE_DPU and followed
@@ -209,8 +214,8 @@ def get_type(self):
 
         Returns:
             A string, the module-type from one of the predefined types:
-            MODULE_TYPE_SUPERVISOR, MODULE_TYPE_LINE or MODULE_TYPE_FABRIC
-            or MODULE_TYPE_DPU
+            MODULE_TYPE_SUPERVISOR, MODULE_TYPE_LINE, MODULE_TYPE_FABRIC,
+            MODULE_TYPE_DPU, or MODULE_TYPE_SWITCH_HOST
         """
         raise NotImplementedError
 
@@ -260,6 +265,15 @@ def set_admin_state(self, up):
         """
         raise NotImplementedError
 
+    def do_power_cycle(self):
+        """
+        Request to do a powercycle of the module.
+
+        Returns:
+            bool: True if the request has been issued successfully, False if not
+        """
+        raise NotImplementedError
+
     def get_maximum_consumed_power(self):
         """
         Retrives the maximum power drawn by this module

tests/chassis_base_test.py

@@ -65,3 +65,34 @@ def test_get_bmc(self):
         mock_bmc = "mock_bmc_instance"
         chassis._bmc = mock_bmc
         assert(chassis.get_bmc() == mock_bmc)
+
+    def test_is_bmc(self):
+        chassis = ChassisBase()
+        assert chassis.is_bmc() is False
+
+        class BmcChassis(ChassisBase):
+            def is_bmc(self):
+                return True
+
+        bmc = BmcChassis()
+        assert bmc.is_bmc() is True
+
+    def test_switch_host_module_at_index_zero(self):
+        '''
+        On a BMC chassis, only the Switch-Host is modelled as a module.
+        get_all_modules() returns [switch_host] and index 0 fetches it.
+        get_module_index() maps the Switch-Host name back to index 0.
+        '''
+        from sonic_platform_base.module_base import ModuleBase
+
+        class SwitchHostModule(ModuleBase):
+            def get_name(self):
+                return ModuleBase.MODULE_TYPE_SWITCH_HOST
+
+        switch_host = SwitchHostModule()
+        chassis = ChassisBase()
+        chassis._module_list = [switch_host]
+
+        assert chassis.get_num_modules() == 1
+        assert chassis.get_all_modules() == [switch_host]
+        assert chassis.get_module(0) is switch_host