Skip to content

Commit

Permalink
[component]: Extend docstrings for firmware management API.
Browse files Browse the repository at this point in the history
Signed-off-by: Nazarii Hnydyn <nazariig@mellanox.com>
  • Loading branch information
nazariig committed Apr 24, 2020
1 parent 777901f commit b066ec7
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions sonic_platform_base/component_base.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,13 @@ def get_firmware_update_notification(self, image_path):
def install_firmware(self, image_path):
"""
Installs firmware to the component.
It's user's responsibility to complete firmware update
in case some extra steps are required (e.g., reboot, power cycle, etc.)
This API performs firmware installation only: this may/may not be the same as firmware update.
In case platform component requires some extra steps (apart from calling Low Level Utility)
to load the installed firmware (e.g, reboot, power cycle, etc.) - this must be done manually by user.
Note: in case immediate actions are required to complete the component firmware update
(e.g., reboot, power cycle, etc.) - will be done automatically by API and no return value provided
Args:
image_path: A string, path to firmware image
Expand All @@ -82,8 +87,10 @@ def install_firmware(self, image_path):
def update_firmware(self, image_path):
"""
Updates firmware of the component.
It's API's responsibility to complete firmware update
in case some extra steps are required (e.g., reboot, power cycle, etc.)
This API performs firmware update: it assumes firmware installation and loading in a single call.
In case platform componet requires some extra steps (apart from calling Low Level Utility)
to load the installed firmware (e.g, reboot, power cycle, etc.) - this will be done automatically by API.
Args:
image_path: A string, path to firmware image
Expand Down

0 comments on commit b066ec7

Please sign in to comment.