opensbi.git/README.md, branch v1.2

docs: Update documentation for kconfig support

2022-08-08T04:04:31Z

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 Reviewed-by: Andrew Jones Tested-by: Andrew Jones Acked-by: Atish Patra Tested-by: Atish Patra

Makefile: Add build time and compiler info string

2021-10-20T09:40:52Z

When we are doing opensbi development, we want to know the build time and compiler info for debug purpose. To enable this message, please add "BUILD_INFO=y", like: ``` make BUILD_INFO=y ``` NOTE: Using `BUILD_INFO=y` without specifying SOURCE_DATE_EPOCH will violate "reproducible builds". So it's ONLY for development and debug purpose, and should NOT be used in a product which follows "reproducible builds". Signed-off-by: Wei Fu Reviewed-by: Anup Patel Reviewed-by: Alistair Francis

README: Update toolchain information

2021-07-17T13:02:20Z

Recent FW_PIC=y changes actually require toolchains with PIE support and it is on by default. Existing doc uses a GNU bare-metal toolchain as examples but it does not support PIE. Replace references of bare-metal toolchain prefix with Linux toolchain prefix everywhere in documentation. Also indicate that "riscv64-unknown-freebsd-" as an alternative to "riscv64-linux-" GNU toolchain. Signed-off-by: Bin Meng Reviewed-by: Anup Patel

Makefile: Support building with Clang and LLVM binutils

2021-07-11T14:52:55Z

This is intended to mirror the Linux kernel. Building with CC=clang will use Clang as the compiler but default to using the existing binutils. Building with LLVM=1 will default to using Clang and LLVM binutils. Whilst GCC will accept the -N linker option and forward it on to the linker, Clang will not, and so in order to support both compilers we must use -Wl, to forward it to the linker as is required for most other linker options. Note that there is currently a bug when using Clang as the compiler and riscv64-linux-gnu-ld as the linker for FW_PIC=y. At first glance this appears to be a bug in GNU binutils, but this could also be Clang or OpenSBI at fault in some subtle way. Thus, for now, advise that this combination be avoided. Signed-off-by: Jessica Clarke Reviewed-by: Anup Patel Tested-by: Anup Patel

docs: Add initial documentation for domain support

2020-10-21T06:59:36Z

We add initial documentation for OpenSBI domain support to help RISC-V platform vendors achieve system-level partitioning. Signed-off-by: Anup Patel Reviewed-by: Atish Patra

README.md: fix markdown link formatting

2020-07-04T04:28:03Z

Consistently use reference-style markdown links in the README. This won't show the URL next to the linked text for the [Github] and [U-Boot] links and link the text "Bootlin toolchain repository" instead of showing it verbatim with the URL next to it. Signed-off-by: Tobias Klauser Reviewed-by: Bin Meng Reviewed-by: Anup Patel

docs: Use doxygen config to mark the main page

2020-06-08T11:32:41Z

The doxygen config option "USE_MDFILE_AS_MAINPAGE" can be used to set the main page in doxygen generated pdf. This allows us to remove the "#mainpage" from the README file which markdown doesn't parse. Signed-off-by: Atish Patra Reviewed-by: Anup Patel

docs: Fix ordering of pages in table of contents

2020-05-07T04:16:22Z

Currently, all markdown pages are randomly arranged in table of contents so to fix this we treat top-level README.md as mainpage and enable Doxygen TREEVIEW. Also, there should not be any text before title of a markdown page so we move project copyright as separate section in top-level README.md. Signed-off-by: Anup Patel Reviewed-by: Atish Patra

docs: Add platform requirements document

2020-05-07T04:15:52Z

We add platform requirements document to clarify OpenSBI expectations from a RISC-V platform. Signed-off-by: Anup Patel Reviewed-by: Atish Patra Reviewed-by: Bin Meng

platform: Remove qemu/virt directory

2020-05-04T04:39:23Z

The OpenSBI generic platform works perfectly fine on the QEMU virt machine so let's remove dedicated QEMU virt machine platform from OpenSBI. All QEMU virt machine related documentation in OpenSBI will now suggest using OpenSBI generic platform. Signed-off-by: Anup Patel Reviewed-by: Bin Meng Reviewed-by: Alistair Francis