summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2019-05-06docs: miscellaneous documentation fixes and updatesKarsten Merker9-91/+93
- 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 Ollivier1-1/+1
Fix typo on parenthesis.
2019-04-25docs: Add a payload section about coreboot support #116Shawn Chang1-0/+24
Signed-off-by: Shawn Chang <citypw@gmail.com>
2019-04-15doc: Update docs as per latest kernel/u-boot status.Atish Patra1-10/+12
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 Merker1-11/+80
- 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 Patel1-3/+11
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 Meng1-0/+15
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 Meng1-2/+2
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 Patra1-1/+5
Signed-off-by: Atish Patra <atish.patra@wdc.com>
2019-02-19docs: Update unleashed platform guide.Atish Patra1-35/+116
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 Patra3-1/+67
Signed-off-by: Atish Patra <atish.patra@wdc.com>
2019-02-19docs: Wrap text to 80 columns.Atish Patra1-3/+8
Signed-off-by: Atish Patra <atish.patra@wdc.com>
2019-02-15docs: fu540: Add steps for the Microsemi Expansion boardAlistair Francis1-0/+10
Signed-off-by: Alistair Francis <alistair.francis@wdc.com>
2019-02-14docs: Use normal hyphen instead of non-breaking hyphenAtish Patra1-1/+1
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 Moal1-22/+30
Clarify the libraries descriptions. Signed-off-by: Damien Le Moal <damien.lemoal@wdc.com>
2019-02-08docs: platform guide updatesDamien Le Moal1-12/+22
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 Francis1-2/+2
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 filev0.1Anup Patel1-0/+2
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 Patel1-0/+57
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 Patel1-0/+32
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 Patra1-0/+102
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 Patra4-9/+10
Signed-off-by: Atish Patra <atish.patra@wdc.com>
2019-01-24docs/platform: Update QEMU platforms documentationDamien Le Moal2-55/+89
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 Moal1-0/+29
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 Moal1-63/+78
Reformatting, typos, and various corrections. Signed-off-by: Damien Le Moal <damien.lemoal@wdc.com>
2019-01-24docs/firmware: Update FW_JUMP documentationDamien Le Moal1-28/+41
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 Moal1-0/+60
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 Moal1-13/+74
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 Patra3-16/+18
Signed-off-by: Atish Patra <atish.patra@wdc.com>
2019-01-22docs: Fix nits in firmware/fw_jump.mdBin Meng1-3/+3
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 Patel1-1/+1
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 Moal1-0/+1
Use a more neutral term more representative of this payload intent. Signed-off-by: Damien Le Moal <damien.lemoal@wdc.com>
2019-01-21Makefile: Add support for device tree compilationDamien Le Moal1-0/+8
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 <damien.lemoal@wdc.com>
2019-01-21build: Introduce FW_PAYLOAD_ALIGNDamien Le Moal1-38/+53
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 <damien.lemoal@wdc.com>
2019-01-16docs: Update title in contributing.mdAnup Patel1-2/+2
The patch updates title in contributing.md to match other .md files under docs/ directory. Signed-off-by: Anup Patel <anup.pate@wdc.com>
2019-01-16Makefile: Add make targets to build and install documentationAnup Patel1-0/+2458
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 <anup.patel@wdc.com>
2019-01-04docs: Add a contributing documentAlistair Francis1-0/+13
Signed-off-by: Alistair Francis <alistair.francis@wdc.com>
2018-12-31docs: Add documenation for QEMU platformsAnup Patel2-0/+101
This patch adds documentation for qemu/virt and qemu/sifive_u platform supports. Signed-off-by: Anup Patel <anup.patel@wdc.com>
2018-12-21top: Rename "blob" to "firmware" everywhereAnup Patel2-0/+0
This patch renames "blob" to "firmware" everywhere for better and intutive naming. Signed-off-by: Anup Patel <anup@brainfault.org>
2018-12-21docs: Add documentation for firmware blobsAnup Patel2-0/+88
This patch adds documentation for fw_jump and fw_payload firmware blobs. Signed-off-by: Anup Patel <anup.patel@wdc.com>
generated by cgit v1.2.3 (git 2.39.0) at 2026-09-14 14:40:29 +0300