diff options
| author | Anup Patel <apatel@ventanamicro.com> | 2022-08-08 07:04:31 +0300 |
|---|---|---|
| committer | Anup Patel <anup@brainfault.org> | 2022-08-08 07:04:31 +0300 |
| commit | 0723bab8fe073ccbbb45e85e0d50ec1d2055d34a (patch) | |
| tree | 2f47e2327c85fbca589be4528419ea9aa9dcfd78 /README.md | |
| parent | eccb9df5cf402dd910efc5f3b926db5161a318bf (diff) | |
| download | opensbi-0723bab8fe073ccbbb45e85e0d50ec1d2055d34a.tar.xz | |
docs: Update documentation for kconfig support
We update all documentation files to:
1) Remove references to platform specific config.mk file since it is
has been removed.
2) Add details about platform specific configs/defconfig and Kconfig
files mandatory for each platform.
3) Add required packages in top-level README.md
4) Fix typo releated to object.mk in docs/platform/platform.md
Signed-off-by: Anup Patel <apatel@ventanamicro.com>
Reviewed-by: Andrew Jones <ajones@ventanamicro.com>
Tested-by: Andrew Jones <ajones@ventanamicro.com>
Acked-by: Atish Patra <atishp@rivosinc.com>
Tested-by: Atish Patra <atishp@rivosinc.com>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 25 |
1 files changed, 23 insertions, 2 deletions
@@ -92,8 +92,8 @@ N.B. Any S-mode boot loader (i.e. U-Boot) doesn't need to support HSM extension, as it doesn't need to boot all the harts. The operating system should be capable enough to bring up all other non-booting harts using HSM extension. -Required Toolchain ------------------- +Required Toolchain and Packages +------------------------------- OpenSBI can be compiled natively or cross-compiled on a x86 host. For cross-compilation, you can build your own toolchain, download a prebuilt one @@ -115,6 +115,14 @@ triple is used (e.g. *-target riscv64-unknown-elf*). Please note that only a 64-bit version of the toolchain is available in the Bootlin toolchain repository for now. +In addition to a toolchain, OpenSBI also requires the following packages on +the host: + +1. device-tree-compiler: The device tree compiler for compiling device + tree sources (DTS files). +2. python3: The python 3.0 (or compatible) language support for various + scripts. + Building and Installing the OpenSBI Platform-Independent Library ---------------------------------------------------------------- @@ -196,6 +204,19 @@ top-level make command line. These options, such as *PLATFORM_<xyz>* or *docs/platform/<platform_name>.md* files and *docs/firmware/<firmware_name>.md* files. +All OpenSBI platforms support Kconfig style build-time configuration. Users +can change the build-time configuration of a platform using a graphical +interface as follows: +``` +make PLATFORM=<platform_subdir> menuconfig +``` + +Alternately, an OpenSBI platform can have multiple default configurations +and users can select a custom default configuration as follows: +``` +make PLATFORM=<platform_subdir> PLATFORM_DEFCONFIG=<platform_custom_defconfig> +``` + Building 32-bit / 64-bit OpenSBI Images --------------------------------------- By default, building OpenSBI generates 32-bit or 64-bit images based on the |