From 82b1e019a5072617a87ffa728088e9c9c338ca68 Mon Sep 17 00:00:00 2001 From: Patrick Rudolph Date: Sun, 28 Oct 2018 13:12:46 +0100 Subject: [PATCH] Documentation: Improve payload fit MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Convert '' to ` * Add example how to use mkimage Change-Id: Id83db3db51582cb0d6ded7f3152b5549fba1f2e7 Signed-off-by: Patrick Rudolph Reviewed-on: https://review.coreboot.org/29319 Tested-by: build bot (Jenkins) Reviewed-by: Jonathan Neuschäfer Reviewed-by: Philipp Deppenwiese --- Documentation/lib/payloads/fit.md | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/Documentation/lib/payloads/fit.md b/Documentation/lib/payloads/fit.md index ac7b3e6068..53be92ecf7 100644 --- a/Documentation/lib/payloads/fit.md +++ b/Documentation/lib/payloads/fit.md @@ -25,7 +25,7 @@ The section must be named in order to be found by the FIT parser: The FIT parser needs architecure support. ### aarch64 -The source code can be found in ''src/arch/arm64/fit.c''. +The source code can be found in `src/arch/arm64/fit.c`. On aarch64 the kernel (a section named 'kernel') must be in **Image** format and it needs a devicetree (a section named 'fdt') to boot. @@ -83,7 +83,7 @@ If no matching compat string is found, the default config is chosen. ## Building FIT image -The FIT image has to be built by calling ''mkimage''. You can use +The FIT image has to be built by calling `mkimage`. You can use the following example configuration: ``` @@ -148,9 +148,20 @@ the following example configuration: }; ``` -It includes a compressed initrd **initramfs.cpio.xz**, which will be -decompressed by the Linux kernel, a compressed kernel **Image.lzma**, which will -be decompressed by the FIT loader and an uncompressed devicetree blob. +Save it as ITS file `config.its` along with the other files defined here: +* target.dtb +* initramfs.cpio.xz +* Image.lzma + +Generate the `uImage` that will be included into the CBFS by calling + +```bash +mkimage -f config.its uImage +``` + +The generated file includes a compressed initrd **initramfs.cpio.xz**, which +will be decompressed by the Linux kernel, a compressed kernel **Image.lzma**, +which will be decompressed by the FIT loader and an uncompressed devicetree blob. [uImage.FIT]: https://raw.githubusercontent.com/u-boot/u-boot/master/doc/uImage.FIT/howto.txt [U-Boot]: https://www.denx.de/wiki/U-Boot