[sonic_platform_base/chassis_base]: Add firmware management interface

[mudsut4ke]

Add base class for firmware management API
(sonic-net/sonic-buildimage#3013)

Signed-off-by: Wirut Getbamrung wgetbumr@celestica.com

[jleveque]

These new functions will need to be added to ChassisBase in addition to ModuleBase.

In SONiC platform API terminology, a "Module" is a removable device in a modular chassis, such as a line card, supervisor card, etc.).

Also, ChassisBase already has a function, get_component_versions() to retrieve all platform-specific firmware versions (the number of which could vary between platforms: BIOS, CPLD, FPGA, etc.). How do you see these functions working with a platform which has multiple components which require firmware?

[mudsut4ke]

Sorry, maybe I don't understand the purpose of your suggestion in #30 for ModuleBase

To move it to ChassisBase and working with a platform which has multiple components
Can I add update get_component_versions() to support component type ?

    def get_component_versions(self, type):
        """
        Retrieves platform-specific hardware/firmware versions for chassis
        componenets such as BIOS, CPLD, FPGA, etc.
        Args:
            type: A string, component type

        Returns:
            A string containing platform-specific component versions
        """
        raise NotImplementedError


    def install_component_firmware(self, type, image_path)
        """
        Install firmware to module
        Args:
            type: A string, component type.
            image_path: A string, path to firmware image.

        Returns:
            A boolean, True if install successfully, False if not
        """
        raise NotImplementedError

[jleveque]

Another option is to replace get_component_versions() with get_firmware_version(), and the latter could take a component name as a parameter, e.g., get_firmware_version(self, component). Then the definition of install_component_firmware() could be updated to match, e.g., install_component_firmware(self, component, image_path). The component type strings should also be defined as constants.

[mudsut4ke]

OK, I think so.

1. Remove get_component_versions()
2. Add get_firmware_version(self, component)
3. Add install_component_firmware(self, component, image_path)

but for component type , is that necessary to defined as constants ?
I think just use component name is enough.

[jleveque]

but for component type , is that necessary to defined as constants ?
I think just use component name is enough.

I guess they don't have to be defined as constants in the base class, as they will only be used by the vendor. This will allow for vendors to define their own component names, and allows for more flexibility for different hardware configurations.

[mudsut4ke]

@jleveque , Please review latest change and sonic-net/sonic-buildimage#2446

[jleveque]

@mudsut4ke: I think the functions now look good, however, they should be present in both ChassisBase and ModuleBase. This will allow vendors to implement firmware updates for components on the chassis as well as components on a module (e.g., CPLD or FPGA on a line card).

[mudsut4ke]

@jleveque , I will add these function to ModuleBase too

[jleveque]

As comments. Note that my I made my comments in chassis_base.py, but they also apply to mondule_base.py, since the code is the same in both..

[mudsut4ke]

OK

[mudsut4ke]

@jleveque Comment updated as your request on 2754d94