-
Notifications
You must be signed in to change notification settings - Fork 175
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[sonic_fw]: Add firmware management api base #30
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
#!/usr/bin/env python | ||
# | ||
# fw_manage_base.py | ||
# | ||
# Abstract base class for implementing platform-specific | ||
# Firmware management functionality for SONiC | ||
# | ||
|
||
try: | ||
import abc | ||
except ImportError as e: | ||
raise ImportError(str(e) + " - required module not found") | ||
|
||
|
||
class FwBase(object): | ||
__metaclass__ = abc.ABCMeta | ||
|
||
@abc.abstractmethod | ||
def get_module_list(self): | ||
""" | ||
Retrieves the list of module that available on the device | ||
|
||
:return: A list : the list of module that available on the device | ||
""" | ||
return [] | ||
|
||
@abc.abstractmethod | ||
def get_fw_version(self, module_name): | ||
""" | ||
Retrieves the firmware version of module | ||
|
||
:param module_name: A string, module name | ||
:return: A Dict, firmware version object | ||
- Example of return object of module that doesn't have sub modules | ||
{ | ||
"module_name": "BIOS", | ||
"fw_version": "1.0.0" | ||
"has_submodule" = False | ||
} | ||
- Example of return object of module that have sub modules | ||
{ | ||
"module_name": "CPLD", | ||
"fw_version": { | ||
"CPLD1" : "1.0.0", | ||
"CPLD2" : "1.1.0" | ||
} | ||
"has_submodule" = True | ||
} | ||
""" | ||
return {} | ||
|
||
@abc.abstractmethod | ||
def install(self, module_name, image_path): | ||
""" | ||
Install firmware to module | ||
|
||
:param module_name: A string, name of module that need to install new firmware | ||
:param image_path: A string, path to firmware image | ||
:return: Boolean, | ||
- True if install process is finished without error | ||
- False if install process is failed | ||
""" | ||
return False |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
in this case, i feel we should have CPLD1, CPLD2 as module name, each module will have only one version.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In that case,the list of supported module will be ["BIOS", "CPLD1", "CPLD2"] instead of ["BIOS", "CPLD"] and get_fw_version function should return only version string
Is that good?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can you update the comments?