@@ -68,8 +68,13 @@ def get_firmware_update_notification(self, image_path):
6868 def install_firmware (self , image_path ):
6969 """
7070 Installs firmware to the component.
71- It's user's responsibility to complete firmware update
72- in case some extra steps are required (e.g., reboot, power cycle, etc.)
71+
72+ This API performs firmware installation only: this may/may not be the same as firmware update.
73+ In case platform component requires some extra steps (apart from calling Low Level Utility)
74+ to load the installed firmware (e.g, reboot, power cycle, etc.) - this must be done manually by user.
75+
76+ Note: in case immediate actions are required to complete the component firmware update
77+ (e.g., reboot, power cycle, etc.) - will be done automatically by API and no return value provided
7378
7479 Args:
7580 image_path: A string, path to firmware image
@@ -82,8 +87,10 @@ def install_firmware(self, image_path):
8287 def update_firmware (self , image_path ):
8388 """
8489 Updates firmware of the component.
85- It's API's responsibility to complete firmware update
86- in case some extra steps are required (e.g., reboot, power cycle, etc.)
90+
91+ This API performs firmware update: it assumes firmware installation and loading in a single call.
92+ In case platform componet requires some extra steps (apart from calling Low Level Utility)
93+ to load the installed firmware (e.g, reboot, power cycle, etc.) - this will be done automatically by API.
8794
8895 Args:
8996 image_path: A string, path to firmware image
0 commit comments