summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
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]>