Firmware/opensbi
8
0
Fork 0
forked from Mirrors/opensbi
Code Pull Requests Activity

docs: Update docs as per new static library.

Browse Source 
Signed-off-by: Atish Patra <atish.patra@wdc.com>
Acked-by: Anup Patel <anup.patel@wdc.com>
This commit is contained in:
Atish Patra
2019-06-18 14:54:07 -07:00
committed by Anup Patel
parent 5dd93e88fe
commit cd2dfdc870
3 changed files with 8 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/contributing.md
View File

@@ -24,7 +24,8 @@ Every submitted patch must have this tag.
followed by a description of the patch content. A blank line and the author followed by a description of the patch content. A blank line and the author
Signed-off-by tag must follow this description. Signed-off-by tag must follow this description.
4. A commit subject line must start with a prefix followed by a ":". Common 4. A commit subject line must start with a prefix followed by a ":". Common
prefixes are for example "lib:", "platform:", "firmware:", "docs:" and "top:". prefixes are for example "lib:", "platform:", "firmware:", "docs:", "utils:"
and "top:".
5. Maintainers should use "Rebase and Merge" when using GitHub to merge pull 5. Maintainers should use "Rebase and Merge" when using GitHub to merge pull
requests to avoid creating unnecessary merge commits. requests to avoid creating unnecessary merge commits.
6. Maintainers should avoid creating branches directly in the main 6. Maintainers should avoid creating branches directly in the main

6
docs/library_usage.md
View File

@@ -8,7 +8,11 @@ OpenSBI provides two types of static libraries:
hooks for the execution of this interface must be provided by the firmware or hooks for the execution of this interface must be provided by the firmware or
bootloader linking with this library. This library is installed as bootloader linking with this library. This library is installed as
*<install_directory>/lib/libsbi.a* *<install_directory>/lib/libsbi.a*
2. *libplatsbi.a* - An example platform-specific static library integrating 2. *libsbiutils.a* - A static library that will contain all common code required
by any platform supported in OpenSBI. It will be built by default and included
in libplatsbi.a. This library is installed as
*<install_directory>/lib/libsbiutils.a*.
3. *libplatsbi.a* - An example platform-specific static library integrating
*libsbi.a* with platform-specific hooks. This library is available only for *libsbi.a* with platform-specific hooks. This library is available only for
the platforms supported by OpenSBI. This library is installed as the platforms supported by OpenSBI. This library is installed as
*<install_directory>/platform/<platform_subdir>/lib/libplatsbi.a* *<install_directory>/platform/<platform_subdir>/lib/libplatsbi.a*

2
docs/platform_guide.md
View File

@@ -30,7 +30,7 @@ Support for a new platform named *<xyz>* can be added as follows:
1. Create a directory named *<xyz>* under the *platform/* directory. 1. Create a directory named *<xyz>* under the *platform/* directory.
2. Create a platform configuration file named *config.mk* under the 2. Create a platform configuration file named *config.mk* under the
*platform/<xyz>/* directory. This configuration file will provide *platform/<xyz>/* directory. This configuration file will provide
compiler flags, select common drivers, and select firmware options. compiler flags, and select firmware options.
3. Create a *platform/<xyz>/objects.mk* file for listing the 3. Create a *platform/<xyz>/objects.mk* file for listing the
platform-specific object files to be compiled. platform-specific object files to be compiled.
4. Create a *platform/<xyz>/platform.c* file providing a *struct sbi_platform* 4. Create a *platform/<xyz>/platform.c* file providing a *struct sbi_platform*