summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
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 <[email protected]> Acked-by: Anup Patel <[email protected]>
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 <[email protected]> Acked-by: Anup Patel <[email protected]>
2019-06-29Add documentation for Ariane FPGA platformPanagiotis Peristerakis
Signed-off-by: Panagiotis Peristerakis <[email protected]>
2019-06-19docs: Update docs as per new static library.Atish Patra
Signed-off-by: Atish Patra <[email protected]> Acked-by: Anup Patel <[email protected]>
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 <[email protected]> Reviewed-by: Atish Patra <[email protected]>
2019-05-10docs: Add documentation about dynamic firmwareAnup Patel
This patch adds documenation about dynamic firmware. Signed-off-by: Anup Patel <[email protected]> Reviewed-by: Alistair Francis <[email protected]> Reviewed-by: Atish Patra <[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-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 <[email protected]>
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 <[email protected]> Reviewed-by: Bin Meng <[email protected]>
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 <[email protected]> Reviewed-by: Alistair Francis <[email protected]>
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 <[email protected]>
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 <[email protected]>
2019-03-13docs: firmware: Fix spelling of U-BootBin Meng
It's U-Boot, not U-boot. Signed-off-by: Bin Meng <[email protected]>
2019-02-22doc: Fix root partition details for fu540.Atish Patra
Signed-off-by: Atish Patra <[email protected]>
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 <[email protected]>
2019-02-19docs: Add a payload section describing different payloads.Atish Patra
Signed-off-by: Atish Patra <[email protected]>
2019-02-19docs: Wrap text to 80 columns.Atish Patra
Signed-off-by: Atish Patra <[email protected]>
2019-02-15docs: fu540: Add steps for the Microsemi Expansion boardAlistair Francis
Signed-off-by: Alistair Francis <[email protected]>
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 <[email protected]>
2019-02-08docs: improve library usage documentDamien Le Moal
Clarify the libraries descriptions. Signed-off-by: Damien Le Moal <[email protected]>
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 <[email protected]>
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 <[email protected]>
2019-01-30docs: Update doxygen config filev0.1Anup 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 <[email protected]>
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 <[email protected]>
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 <[email protected]>
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 <[email protected]>
2019-01-29docs: Typo fixesAtish Patra
Signed-off-by: Atish Patra <[email protected]>
2019-01-24docs/platform: Update QEMU platforms documentationDamien Le Moal
Mostly reformating. Some minor edits. Signed-off-by: Damien Le Moal <[email protected]>
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 <[email protected]>
2019-01-24docs/firmware: Update FW_PAYLOAD documentationDamien Le Moal
Reformatting, typos, and various corrections. Signed-off-by: Damien Le Moal <[email protected]>
2019-01-24docs/firmware: Update FW_JUMP documentationDamien Le Moal
Reformatting, typos, and various corrections. Signed-off-by: Damien Le Moal <[email protected]>
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 <[email protected]>
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 <[email protected]>
2019-01-22docs: Typo fixes.Atish Patra
Signed-off-by: Atish Patra <[email protected]>
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 <[email protected]>
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 <[email protected]>
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 <[email protected]>
2019-01-21Makefile: Add support for device tree compilationDamien Le Moal
Add rules to compile dts files into dtb files using the device tree compiler (dtc). A platform can specify the DTS file to compile using the platform-dtb-y variable. The flattened device tree binary file to be used for building the final polatform firmware can be specified using the new FW_PAYLOAD_FDT firmware configuration option to point to the automatically compiled FDT file. Using the existing FW_PAYLOAD_FDT_PATH configuration option is still possible and will take precedence over the FW_PAYLOAD_FDT definition. Signed-off-by: Damien Le Moal <[email protected]>
2019-01-21build: Introduce FW_PAYLOAD_ALIGNDamien Le Moal
The firmware payload offset defined by FW_PAYLOAD_OFFSET must specify a value large enough so the the payload does not overlap with the base firmware data, bss and text. For platforms without any strong requirement on the payload address, introduce the FW_PAYLOAD_ALIGN build parameter to automatically place the payload right after the base firmware at an address aligned with the defined value. Either FW_PAYLOAD_OFFSET or FW_PAYLOAD_ALIGN should be defined by a platform configuration. If both FW_PAYLOAD_OFFSET and FW_PAYLOAD_ALIGN are defined by a platform, FW_PAYLOAD_OFFSET has precedence and is used for building the final firmawre image. Using FW_PAYLOAD_ALIGN=4096 with the Kendryte platform rather than the abitrary FW_PAYLOAD_OFFSET=0x10000 value reduces the final firmware image size by about 20KB. Add a description of the FW_PAYLOAD_ALIGN configuration parameter in the fw_payload documentation file as well. And while at it, also fix various grammar and style issues in that file.. Signed-off-by: Damien Le Moal <[email protected]>
2019-01-16docs: Update title in contributing.mdAnup Patel
The patch updates title in contributing.md to match other .md files under docs/ directory. Signed-off-by: Anup Patel <[email protected]>
2019-01-16Makefile: Add make targets to build and install documentationAnup Patel
This patch extends top-level makefile to build and install documentation. The 'docs' make target is for building the documentation PDF whereas 'install_docs' make target is for installing the documentation PDF. Signed-off-by: Anup Patel <[email protected]>
2019-01-04docs: Add a contributing documentAlistair Francis
Signed-off-by: Alistair Francis <[email protected]>
2018-12-31docs: Add documenation for QEMU platformsAnup Patel
This patch adds documentation for qemu/virt and qemu/sifive_u platform supports. 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-21docs: Add documentation for firmware blobsAnup Patel
This patch adds documentation for fw_jump and fw_payload firmware blobs. Signed-off-by: Anup Patel <[email protected]>