diff options
| author | Karsten Merker <merker@debian.org> | 2019-05-05 12:33:25 +0200 |
|---|---|---|
| committer | Anup Patel <anup@brainfault.org> | 2019-05-06 11:05:33 +0530 |
| commit | 0d33a981ec19181c7f6448f90599f31dfd082994 (patch) | |
| tree | 88be71dfc792b975e2dbe9d731415e7e91b76e3d /docs/platform_guide.md | |
| parent | 3bb2d25f448f4f5dd7d143617bc6eccf34f809e6 (diff) | |
docs: miscellaneous documentation fixes and updates
- fix some broken hyperlinks
- add additional hyperlinks to references to external documents
- reformat some paragraphs to keep lines under 80 characters
- unify the enumeration style between different parts of the
documentation
- fix spelling/grammar mistakes
- extend the copyright notice in README.md to be the same as the
one in COPYING.BSD
Signed-off-by: Karsten Merker <merker@debian.org>
Reviewed-by: Atish Patra <atish.patra@wdc.com>
Diffstat (limited to 'docs/platform_guide.md')
| -rw-r--r-- | docs/platform_guide.md | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/docs/platform_guide.md b/docs/platform_guide.md index 5eecf9b..53e9394 100644 --- a/docs/platform_guide.md +++ b/docs/platform_guide.md @@ -1,15 +1,15 @@ OpenSBI Platform Support Guideline ================================== -OpenSBI platform support allows an implementation to define a set of platform -specific hooks (hardware manipulation functions) in the form of a +The OpenSBI platform support allows an implementation to define a set of +platform-specific hooks (hardware manipulation functions) in the form of a *struct sbi_platform* data structure instance. This instance is required by -platform independent *libsbi.a* to execute platform specific operations. +the platform-independent *libsbi.a* to execute platform-specific operations. -Each of the reference platform support provided by OpenSBI define an instance +Each of the reference platform supports provided by OpenSBI defines an instance of the *struct sbi_platform* data structure. For each supported platform, -*libplatsbi.a* integrates this instance with *libsbi.a* to create a platform -specific OpenSBI static library. This library is installed +*libplatsbi.a* integrates this instance with *libsbi.a* to create a +platform-specific OpenSBI static library. This library is installed in *<install_directory>/platform/<platform_subdir>/lib/libplatsbi.a* OpenSBI also provides implementation examples of bootable runtime firmwares for @@ -22,21 +22,21 @@ for the legacy *riskv-pk* boot loader (BBL). A complete doxygen-style documentation of *struct sbi_platform* and related APIs is available in the file *include/sbi/sbi_platform.h*. -Adding a new platform support ------------------------------ +Adding support for a new platform +--------------------------------- Support for a new platform named *<xyz>* can be added as follows: -1. Create a directory named *<xyz>* under *platform/* directory -2. Create a platform configuration file named *config.mk* under +1. Create a directory named *<xyz>* under the *platform/* directory. +2. Create a platform configuration file named *config.mk* under the *platform/<xyz>/* directory. This configuration file will provide - compiler flags, select common drivers, and select firmware options -3. Create *platform/<xyz>/objects.mk* file for listing the platform - specific object files to be compiled -4. Create *platform/<xyz>/platform.c* file providing a *struct sbi_platform* - instance + compiler flags, select common drivers, and select firmware options. +3. Create a *platform/<xyz>/objects.mk* file for listing the + platform-specific object files to be compiled. +4. Create a *platform/<xyz>/platform.c* file providing a *struct sbi_platform* + instance. -A template platform support code is available under the *platform/template* +A platform support code template is available under the *platform/template* directory. Copying this directory and its content as a new directory named *<xyz>* under the *platform/* directory will create all the files mentioned above. |