aboutsummaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2020-02-18doc: coreboot: Fix doc stylesBin Meng
- put all URLs at the end of the doc - satisfy the 80 character per line rule as much as possible Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Anup Patel <anup.patel@wdc.com>
2020-02-17docs: platform: Add documentation for Spike platformAnup Patel
This patch adds documentation to build and run OpenSBI on Spike simulator and QEMU Spike machine. Signed-off-by: Anup Patel <anup.patel@wdc.com> Reviewed-by: Bin Meng <bmeng.cn@gmail.com>
2020-02-11doc: sifive: fu540: Update QEMU instruction when using U-Boot as the payloadBin Meng
Document that when U-Boot v2020.01 (or higher) is used as the payload, we need adjust the instructions a little bit when testing OpenSBI with QEMU 'sifive_u' machine. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Atish Patra <atish.patra@wdc.com>
2020-02-07platform: Drop qemu/sifive_u supportBin Meng
With QEMU v4.2 RISC-V changes to improve the emulation fidelity of 'sifive_u' machine, OpenSBI v0.4 / U-Boot v2019.10 / Linux kernel v5.3 images built for the SiFive HiFive Unleashed board can be used out of the box without any special hack. Hence there is no need for us to continue supporting such a special target in OpenSBI. Going forward, sifive/fu540 platform can be used on both real hardware and QEMU 'sifive_u' machine. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Anup Patel <anup.patel@wdc.com>
2020-01-10docs: platform: Update SiFive FU540 doc as-per U-Boot v2020.01Anup Patel
With U-Boot v2020.01, the SiFive FU540 DTB required by U-Boot is embedded in U-Boot binary itself so we don't need to do anything special for U-Boot v2020.01 as payload to OpenSBI firmware. This patch updates SiFive FU540 documenation assuming we use latest U-Boot v2020.01 release. Signed-off-by: Anup Patel <anup.patel@wdc.com> Reviewed-by: Bin Meng <bmeng.cn@gmail.com>
2020-01-09docs: Add description of using OPENSBI_EXTERNAL_SBI_TYPESAbner Chang
Add description of using OPENSBI_EXTERNAL_SBI_TYPES in external firmware code base. Signed-off-by: Abner Chang <abner.chang@hpe.com> Cc: Leif Lindholm <leif.lindholm@linaro.org> Reviewed-by: Anup Patel <anup.patel@wdc.com>
2020-01-02platform: Add T-head C910 initial supportLiu Yibin
This commit provides basic support for the Thead/C910 platform. Signed-off-by: Liu Yibin <yibin_liu@c-sky.com> Reviewed-by: Atish Patra <atish.patra@wdc.com> Reviewed-by: Anup Patel <anup.patel@wdc.com>
2019-12-30docs: Improve docs for FDT address passingLiu Yibin
This patch updates FW_JUMP and FW_PAYLOAD documentation for the case where FW_xyz_FDT_ADDR is not specified. Signed-off-by: Liu Yibin <yibin_liu@c-sky.com> Reviewed-by: Anup Patel <anup.patel@wdc.com>
2019-09-25docs: platform: Update descriptions for qemu/sifive_u supportBin Meng
With QEMU v4.2 release that has improved the emulation fidelity of 'sifive_u' machine, OpenSBI v0.4 / U-Boot v2019.10-rc1 / Linux kernel v5.3-rc2 images built for the SiFive HiFive Unleashed board can be used out of the box without any special hack. Update our documents to mention 'qemu/sifive_u' platform should only be used with QEMU v4.1 or before, and it will be dropped sometime in the future release. Going forward, 'sifive/fu540' platform can be used on both real hardware and QEMU v4.2+ 'sifive_u' machine. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Anup Patel <anup.patel@wdc.com>
2019-08-31docs: Update the fu540 platform guide as per U-Boot documents.Atish Patra
U-Boot readme for fu540 platform suggest that fdt_addr_r should be used as DT address after DT is copied via tftpboot. Update the OpenSBI docs to reflect that. Remove other stale informations as well. Signed-off-by: Atish Patra <atish.patra@wdc.com> Reviewed-by: Anup Patel <anup.patel@wdc.com>
2019-08-23platform: Add Andes AE350 initial supportNylon Chen
This commit provides basic support for the AE350 platform. Signed-off-by: Zong Li <zongbox@gmail.com> Signed-off-by: Nylon Chen <nylon7@andestech.com>
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 <bmeng.cn@gmail.com> Reviewed-by: Lukas Auer <lukas.auer@aisec.fraunhofer.de> Acked-by: Anup Patel <anup.patel@wdc.com>
2019-07-02platform: Remove the HiFive Unleashed expansion board DT.Atish Patra
The Linux kernel will maintain the device tree (DT) for HiFive Unleashed from release v5.2-rc6. This DT is incompatible with previous DT present for Microsemi expansion board in OpenSBI. Since, OpenSBI will directly load the pre-built DTB from kernel now onwards, no need to keep the out-of-date DT in openSBI. Remove this DT and it's related documentation. Signed-off-by: Atish Patra <atish.patra@wdc.com> Acked-by: Anup Patel <anup.patel@wdc.com>
2019-06-30docs: Update the fu540 platform guide for new DT.Atish Patra
With 5.2-rc6 release, Linux kernel hosts the DT for Unleashed board which is incompatible with the default DT from FSBL. Update the document to use the DT from kernel. Signed-off-by: Atish Patra <atish.patra@wdc.com> Acked-by: Anup Patel <anup.patel@wdc.com>
2019-06-29Add documentation for Ariane FPGA platformPanagiotis Peristerakis
Signed-off-by: Panagiotis Peristerakis <perister@ics.forth.gr>
2019-06-19docs: Update docs as per new static library.Atish Patra
Signed-off-by: Atish Patra <atish.patra@wdc.com> Acked-by: Anup Patel <anup.patel@wdc.com>
2019-05-30docs: qemu/sifive_u: miscellaneous documentation fixesBin Meng
- OpenSBI build target should be: qemu/sifive_u - U-Boot config name should be: sifive_fu540_defconfig Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Atish Patra <atish.patra@wdc.com>
2019-05-10docs: Add documentation about dynamic firmwareAnup Patel
This patch adds documenation about dynamic firmware. Signed-off-by: Anup Patel <anup.patel@wdc.com> Reviewed-by: Alistair Francis <alistair.francis@wdc.com> Reviewed-by: Atish Patra <atish.patra@wdc.com>
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 <merker@debian.org> Reviewed-by: Atish Patra <atish.patra@wdc.com>
2019-05-06Update sifive_fu540.mdLoys Ollivier
Fix typo on parenthesis.
2019-04-25docs: Add a payload section about coreboot support #116Shawn Chang
Signed-off-by: Shawn Chang <citypw@gmail.com>
2019-04-15doc: Update docs as per latest kernel/u-boot status.Atish Patra
All dependant patches are merged in U-Boot and Linux kernel now. Update the unleashed guide to reflect that and fix the documentation about tftp loading path as well. Signed-off-by: Atish Patra <atish.patra@wdc.com> Reviewed-by: Bin Meng <bmeng.cn@gmail.com>
2019-04-15docs: qemu/virt platform documentation fixes and updatesKarsten Merker
- Correct the payload address in the RV64 examples that use fw_jump.elf. - Change the qemu console configuration in the examples from "-display none -serial stdio" to "-nographic". This results in qemu handing down a CTRL-C on the emulated console to the VM instead of terminating the qemu process. - Provide examples for RV32. - Various text corrections. Signed-off-by: Karsten Merker <merker@debian.org> Reviewed-by: Alistair Francis <alistair.francis@wdc.com>
2019-04-03docs: Update mailing list details in contributing.mdAnup Patel
We now have an OpenSBI mailing list available for development and discussiong so update contributing.md accordingly. The Github PR based review and issue tracking will also continue to exist. Signed-off-by: Anup Patel <anup.patel@wdc.com>
2019-03-29lib: Disable the boot prints if SBI_SCRATCH_NO_BOOT_PRINTS is setBin Meng
Use the newly introduced "options" in "struct sbi_scratch" to conditionally disable the boot prints. Signed-off-by: Bin Meng <bmeng.cn@gmail.com>
2019-03-13docs: firmware: Fix spelling of U-BootBin Meng
It's U-Boot, not U-boot. Signed-off-by: Bin Meng <bmeng.cn@gmail.com>
2019-02-22doc: Fix root partition details for fu540.Atish Patra
Signed-off-by: Atish Patra <atish.patra@wdc.com>
2019-02-19docs: Update unleashed platform guide.Atish Patra
Following updates to fu540 platform guide. 1. Update a section about flashing the firmware binary to sdcard with correct partition identifier. 2. Refer the individual payload section. 3. Update uboot booting section. Signed-off-by: Atish Patra <atish.patra@wdc.com>
2019-02-19docs: Add a payload section describing different payloads.Atish Patra
Signed-off-by: Atish Patra <atish.patra@wdc.com>
2019-02-19docs: Wrap text to 80 columns.Atish Patra
Signed-off-by: Atish Patra <atish.patra@wdc.com>
2019-02-15docs: fu540: Add steps for the Microsemi Expansion boardAlistair Francis
Signed-off-by: Alistair Francis <alistair.francis@wdc.com>
2019-02-14docs: Use normal hyphen instead of non-breaking hyphenAtish Patra
Usage non-breaking hyphen breaks make docs as doxygen doesn't know how to handle this. Signed-off-by: Atish Patra <atish.patra@wdc.com>
2019-02-08docs: improve library usage documentDamien Le Moal
Clarify the libraries descriptions. Signed-off-by: Damien Le Moal <damien.lemoal@wdc.com>
2019-02-08docs: platform guide updatesDamien Le Moal
Clarify platform support description. Also fix some Typos, grammar and document style. Signed-off-by: Damien Le Moal <damien.lemoal@wdc.com>
2019-02-08platform: qemu/virt: Move kernel start address to 4MB allignedAlistair Francis
In order to support 32-bit guests move the start address to a 4MB allignment. As 64-bit kernels have a requirement on being 2MB alligned let's just make this the default for both 32 and 64 bit kernels. Signed-off-by: Alistair Francis <alistair.francis@wdc.com>
2019-01-30docs: Update doxygen config fileAnup Patel
This patch updates doxygen config file to include docs/platform_guide.md and docs/library_usage.md in generated PDF document. Signed-off-by: Anup Patel <anup.patel@wdc.com>
2019-01-30docs: Add library usage guideAnup Patel
This patch adds static library usage guide (i.e. docs/library_usage.md). Signed-off-by: Anup Patel <anup.patel@wdc.com>
2019-01-30docs: Add platform support guideAnup Patel
This patch adds initial platform support guide (i.e. docs/platform_guide.md). Signed-off-by: Anup Patel <anup.patel@wdc.com>
2019-01-29docs: Add a fu540 document.Atish Patra
Add a readme guide for fu540 with different types of build & booting steps. Signed-off-by: Atish Patra <atish.patra@wdc.com>
2019-01-29docs: Typo fixesAtish Patra
Signed-off-by: Atish Patra <atish.patra@wdc.com>
2019-01-24docs/platform: Update QEMU platforms documentationDamien Le Moal
Mostly reformating. Some minor edits. Signed-off-by: Damien Le Moal <damien.lemoal@wdc.com>
2019-01-24docs/platform: Add top level document fileDamien Le Moal
List supported platforms and point to the platform specific document. Signed-off-by: Damien Le Moal <damien.lemoal@wdc.com>
2019-01-24docs/firmware: Update FW_PAYLOAD documentationDamien Le Moal
Reformatting, typos, and various corrections. Signed-off-by: Damien Le Moal <damien.lemoal@wdc.com>
2019-01-24docs/firmware: Update FW_JUMP documentationDamien Le Moal
Reformatting, typos, and various corrections. Signed-off-by: Damien Le Moal <damien.lemoal@wdc.com>
2019-01-24docs/firmware: Add top level document fileDamien Le Moal
Provide an overview of all supported firmware files and point to each firmware type documentation file. Signed-off-by: Damien Le Moal <damien.lemoal@wdc.com>
2019-01-24docs: Contribution guideline updateDamien Le Moal
Explicitely mention that this project adheres to the Developer Certificate of Origin (DCO) and include this short text. Also reformat the file to have lines bounded at 80 chars and add some more details regarding the expected commit message format. Signed-off-by: Damien Le Moal <damien.lemoal@wdc.com>
2019-01-22docs: Typo fixes.Atish Patra
Signed-off-by: Atish Patra <atish.patra@wdc.com>
2019-01-22docs: Fix nits in firmware/fw_jump.mdBin Meng
Add a space before (FW_JUMP) to make it more readable. This also fixes "No newline at end of file" warning. Signed-off-by: Bin Meng <bmeng.cn@gmail.com>
2019-01-22docs: Add OpenSBI version to doxygen.cfgAnup Patel
The PDF document generated by doxygen should have OpenSBI version hence this patch adds OpenSBI version to doxygen.cfg. Signed-off-by: Anup Patel <anup.patel@wdc.com>
2019-01-21payload: rename dummy payload to test payloadDamien Le Moal
Use a more neutral term more representative of this payload intent. Signed-off-by: Damien Le Moal <damien.lemoal@wdc.com>
generated by cgit v1.2.3 (git 2.39.1) at 2025-04-05 13:24:30 +0000