summaryrefslogtreecommitdiff
path: root/README.md
AgeCommit message (Collapse)Author
2026-05-09platform: Remove kendryte/k210 platformAnup Patel
The kendryte/k210 platform does not have MMU support in S-mode hence only NOMMU kernel which runs in M-mode can be used on this platform. As of now, there is no clear use-case of supporting OpenSBI for kendryte/k210 platform. Signed-off-by: Anup Patel <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Anup Patel <[email protected]>
2025-06-14Makefile: Make $(LLVM) more flexibleCharlie Jenkins
Introduce a way for developers to easily switch between LLVM versions with LLVM=/path/to/llvm/ and LLVM=-version. This is a useful addition to the existing LLVM=1 variable which will select the first clang and llvm binutils available on the path. Reviewed-by: Anup Patel <[email protected]> Tested-by: Anup Patel <[email protected]> Signed-off-by: Charlie Jenkins <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Anup Patel <[email protected]>
2025-02-18README: Remove comment about boolin toolchains being 64-bit onlyJoel Stanley
As of January 2025 they have riscv32-ilp32d and riscv64-lp64d: https://toolchains.bootlin.com/releases_riscv32-ilp32d.html https://toolchains.bootlin.com/releases_riscv64-lp64d.html Signed-off-by: Joel Stanley <[email protected]> Reviewed-by: Anup Patel <[email protected]>
2025-02-18README: Update toolchain section to mention PIE requirementJoel Stanley
Since commit 76d7e9b8ee72 ("firmware: remove copy-base relocation"), the Makefile enforces PIE support. Signed-off-by: Joel Stanley <[email protected]> Reviewed-by: Anup Patel <[email protected]>
2025-02-18README: Any arch host can be used to cross compileJoel Stanley
Verified by cross compiling from an arm64 host. Signed-off-by: Joel Stanley <[email protected]> Reviewed-by: Anup Patel <[email protected]>
2024-04-05firmware: remove copy-base relocationXiang W
Remove copy-base relocations that are no longer needed. Signed-off-by: Xiang W <[email protected]> Reviewed-by: Samuel Holland <[email protected]> Tested-by: Samuel Holland <[email protected]> Reviewed-by: Anup Patel <[email protected]>
2023-06-14README.md: Improve project copyright informationAnup Patel
Over-time a lot of organizations and individuals have contributed to the OpenSBI project so let us add copyright RISC-V International to respect the contributions from all RISC-V members. Signed-off-by: Anup Patel <[email protected]> Reviewed-by: Andrew Jones <[email protected]>
2023-06-14docs: Add OpenSBI logo and use it in the top-level README.mdAnup Patel
We do have an official OpenSBI logo which was designed few months ago and was also approved by RISC-V International. Lets add this logo under docs and also use it in the top-level README.md Signed-off-by: Anup Patel <[email protected]> Reviewed-by: Andrew Jones <[email protected]>
2023-03-01make: Add a command line option for debugging OpenSBIBin Meng
Add a new make command line option "make DEBUG=1" to prevent compiler optimizations using -O2. Signed-off-by: Bin Meng <[email protected]> Reviewed-by: Xiang W <[email protected]> Reviewed-by: Anup Patel <[email protected]>
2022-08-08docs: Update documentation for kconfig supportAnup Patel
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 <[email protected]> Reviewed-by: Andrew Jones <[email protected]> Tested-by: Andrew Jones <[email protected]> Acked-by: Atish Patra <[email protected]> Tested-by: Atish Patra <[email protected]>
2021-10-20Makefile: Add build time and compiler info stringWei Fu
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 <[email protected]> Reviewed-by: Anup Patel <[email protected]> Reviewed-by: Alistair Francis <[email protected]>
2021-07-17README: Update toolchain informationBin Meng
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 <[email protected]> Reviewed-by: Anup Patel <[email protected]>
2021-07-11Makefile: Support building with Clang and LLVM binutilsJessica Clarke
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 <[email protected]> Reviewed-by: Anup Patel <[email protected]> Tested-by: Anup Patel <[email protected]>
2020-10-21docs: Add initial documentation for domain supportAnup Patel
We add initial documentation for OpenSBI domain support to help RISC-V platform vendors achieve system-level partitioning. Signed-off-by: Anup Patel <[email protected]> Reviewed-by: Atish Patra <[email protected]>
2020-07-04README.md: fix markdown link formattingTobias Klauser
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 <[email protected]> Reviewed-by: Bin Meng <[email protected]> Reviewed-by: Anup Patel <[email protected]>
2020-06-08docs: Use doxygen config to mark the main pageAtish Patra
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 <[email protected]> Reviewed-by: Anup Patel <[email protected]>
2020-05-07docs: Fix ordering of pages in table of contentsAnup Patel
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 <[email protected]> Reviewed-by: Atish Patra <[email protected]>
2020-05-07docs: Add platform requirements documentAnup Patel
We add platform requirements document to clarify OpenSBI expectations from a RISC-V platform. Signed-off-by: Anup Patel <[email protected]> Reviewed-by: Atish Patra <[email protected]> Reviewed-by: Bin Meng <[email protected]>
2020-05-04platform: Remove qemu/virt directoryAnup Patel
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 <[email protected]> Reviewed-by: Bin Meng <[email protected]> Reviewed-by: Alistair Francis <[email protected]>
2020-04-17docs: Update README about supported SBI versionsAtish Patra
Signed-off-by: Atish Patra <[email protected]> Reviewed-by: Bin Meng <[email protected]> Reviewed-by: Anup Patel <[email protected]>
2019-09-05README: Update license informationDamien Le Moal
With the Kendryte K210 platform code cleanup, none of the code copied from Kendryte standalone SDK remains and this platform code is now entirely licensed under OpenSBI BSD-2-clause license. Update the README.md and ThirdPartyNotices.md files to reflect this. Signed-off-by: Damien Le Moal <[email protected]> Reviewed-by: Bin Meng <[email protected]> Reviewed-by: Anup Patel <[email protected]>
2019-07-25treewide: Use conventional names for 32-bit and 64-bitBin Meng
There are several places in the source tree that have: 32bit, 32 bit, 64bit, 64 bit Fix by using the conventional names with a hyphen. Signed-off-by: Bin Meng <[email protected]> Reviewed-by: Lukas Auer <[email protected]> Acked-by: Anup Patel <[email protected]>
2019-07-25README: Document 32-bit / 64-bit images buildBin Meng
At present the exact details of building 32-bit or 64-bit OpenSBI images are missing in the docs. This adds the missing part. Signed-off-by: Bin Meng <[email protected]> Reviewed-by: Lukas Auer <[email protected]> Acked-by: Anup Patel <[email protected]>
2019-05-06docs: miscellaneous documentation fixes and updatesKarsten Merker
- 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 <[email protected]> Reviewed-by: Atish Patra <[email protected]>
2019-04-15top: Add CONTRIBUTORS.md fileAnup Pate
We add CONTRIBUTORS.md file to provide a list of individuals and organizations actively contributing to the OpenSBI project. Signed-off-by: Anup Patel <[email protected]>
2019-04-03README: Update license informationDamien Le Moal
Add information regarding the Apache License Version 2.0 of some of the Kendryte/k210 platform files. Also repeat this information in a new ThirdPartyNotices.md file. Signed-off-by: Damien Le Moal <[email protected]>
2019-02-19docs: Add a payload section describing different payloads.Atish Patra
Signed-off-by: Atish Patra <[email protected]>
2019-02-19docs: Update about toolchain section.Atish Patra
Signed-off-by: Atish Patra <[email protected]>
2019-02-08top: README.md updatesDamien Le Moal
Clarify OpenSBI components explanation. Signed-off-by: Damien Le Moal <[email protected]>
2019-01-30top: Fix typo in README.mdAnup Patel
This patch renames <platform_sub_dir> to <platform_subdir> to be consistent everywhere. Signed-off-by: Anup Patel <[email protected]>
2019-01-24docs: README.md updateDamien Le Moal
Reformat to fit lines within 80 chars, fix hyperlinks, etc. Signed-off-by: Damien Le Moal <[email protected]>
2019-01-22docs: Typo fixes.Atish Patra
Signed-off-by: Atish Patra <[email protected]>
2019-01-22top: Fix broken links in top-level README.mdBin Meng
There are 2 markdown links that are currently broken in top-level README.md. Fix them so that github could render the URL correctly. This also fixes "No newline at end of file" warning. Signed-off-by: Bin Meng <[email protected]>
2019-01-18docs: Add licensing seciton for external projects.Atish Patra
Signed-off-by: Atish Patra <[email protected]>
2019-01-16top: Update top-level README.md to build/install documentation PDFAnup Patel
This patch updates top-level README.md for steps required to build and install documentation PDF. Signed-off-by: Anup Patel <[email protected]>
2018-12-31top: Minor typo fixes in top-level README.mdAnup Patel
This patch does minor typo fixes in top-level README.md. Signed-off-by: Anup Patel <[email protected]>
2018-12-26top: Rename back CROSS_COMPILE_PREFIX to CROSS_COMPILEAnup Patel
The name CROSS_COMPILE is an industry standard used across open-source project to specify cross-compiler prefix. In fact, distro build systems such as buildroot and yocto assume CROSS_COMPILE to be supported by projects added as packages to these build systems. This patch rename back CROSS_COMPILE_PREFIX to CROSS_COMPILE. Signed-off-by: Anup Patel <[email protected]>
2018-12-25README: UpdateDamien Le Moal
Some rewrite with a more formal style. Signed-off-by: Damien Le Moal <[email protected]>
2018-12-25Makefile: Rename CROSS_COMPILE to CROSS_COMPILE_PREFIXDamien Le Moal
Make it clear what this environment variable defines and update the README.md file to explain that. Signed-off-by: Damien Le Moal <[email protected]>
2018-12-22top: Typo fix in top-level README.mdAnup Patel
The platform specific options will be PLATFORM_<xyz> and not PLAT_<xyz> hence this patch fixes typo in top-level README.md. Signed-off-by: Anup Patel <[email protected]>
2018-12-21top: Rename "plat" to "platform" everywhereAnup Patel
This patch renames "plat" to "platform" everywhere for better readablility. Signed-off-by: Anup Patel <[email protected]>
2018-12-21top: Rename "blob" to "firmware" everywhereAnup Patel
This patch renames "blob" to "firmware" everywhere for better and intutive naming. Signed-off-by: Anup Patel <[email protected]>
2018-12-21top: More detailed top-level README.mdAnup Patel
This patch adds more details to top-level README.md based on current state of OpenSBI. Signed-off-by: Anup Patel <[email protected]>
2018-12-11Initial commit.Anup Patel
Signed-off-by: Anup Patel <[email protected]>
generated by cgit v1.3.1 (git 2.54.0) at 2026-08-13 14:19:32 +0000