Firmware/opensbi
8
0
Fork 0
forked from Mirrors/opensbi
Code Pull Requests Activity
Files
f19611e1e4918ca19d0278f7494965c3083fd8d0
opensbi/docs/platform_guide.md
Karsten Merker 0d33a981ec 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>
2019-05-06 11:05:33 +05:30

2.1 KiB
Raw Blame History

OpenSBI Platform Support Guideline

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 the platform-independent libsbi.a to execute platform-specific operations.

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 in <install_directory>/platform/<platform_subdir>/lib/libplatsbi.a

OpenSBI also provides implementation examples of bootable runtime firmwares for the supported platforms. These firmwares are linked against libplatsbi.a. Firmware binaries are installed in <install_directory>/platform/<platform_subdir>/bin. These firmwares can be used as executable runtime firmwares on the supported platforms as a replacement 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 support for a new platform

Support for a new platform named can be added as follows:

  1. Create a directory named under the platform/ directory.
  2. Create a platform configuration file named config.mk under the platform// directory. This configuration file will provide compiler flags, select common drivers, and select firmware options.
  3. Create a platform//objects.mk file for listing the platform-specific object files to be compiled.
  4. Create a platform//platform.c file providing a struct sbi_platform instance.

A platform support code template is available under the platform/template directory. Copying this directory and its content as a new directory named under the platform/ directory will create all the files mentioned above.