Add README.md with references and instructions of usage.
Signed-off-by: Pawel Zalewski pzalewski@thegoodpenguin.co.uk Reviewed-by:Andrew Murray amurray@thegoodpenguin.co.uk --- README.md | 90 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 90 insertions(+) create mode 100644 README.md
diff --git a/README.md b/README.md new file mode 100644 index 0000000..352946a --- /dev/null +++ b/README.md @@ -0,0 +1,90 @@ +meta-morello +============== + +Meta-morello provides the layer required to build the firmware that lives on the SD card and a Morello enabled +Linux kernel for the Morello System Development Platform. + +Use the provided kas scripts to get all of the dependencies. +Read on how to get and use kas here [1] + +Booting the hardware +-------------------- + +For information on how to boot the hardware and how the hardware is booting see [2] and [3]. + +Machines +-------- + +The machines have been split into: +- morello-bsp for the SD card +- morello-linux-musl for the Linux image with busybox initramfs and musl being the only libc +- morello-linux-glibc for the Linux image with an arbitrary Yocto image as the rootfs + with purecap app linked staticaly + +Building images +-------------------- +$ cd poky +$ TEMPLATECONF=meta-morello/conf . oe-init-build-env build +$ MACHINE=morello-bsp bitbake board-firmware-image + +then: + +$ TEMPLATECONF=meta-morello/conf . oe-init-build-env build +$ MACHINE=morello-linux-musl bitbake morello-linux-image + +or (mutually exclusive) + +$ TEMPLATECONF=meta-morello/conf . oe-init-build-env build +$ MACHINE=morello-linux-glibc bitbake morello-linux-image + +Alternatively one can use the kas scrips: + +kas build ./kas/morello-linux-glibc.yml + +or + +kas build ./kas/morello-linux-musl.yml + +Images +------ + +The outputs can be found under build/temp/deploy/images: +- board-firmware-sd-image.img goes on the SD card via DD +- morello-linux-image-...img goes on a drive (USB or other) via DD +- if not using kas you do need to build the board-firmware-image to be able to build the morello-linux-image + +Linux and musl-libc +------------------- + +The linux kernel and musl-libc are locked in sync so that the release tags from upstream always match. + +Known limitations +----------------- + +- the current state of this layer is meant to be just a starting point and foundation for further development, the main aim was to have working Linux images ASAP for the community, do not expect elegant Yocto solutions yet +- Yocto packaging is disabled for the Morello apps due to not fully implemented toolchain (llvm-morello is an overrride bootstrap of the env variables), one of the packaging classes will drop an error as it expects a target_prefix-objcopy being available for example (in theory only applies to linux-morello-musl machine, have not tested if one can package Morello apps onto standard Yocto rootfs images) +- it follows that the final image is assembled manually +- the rtl_nic driver is missing from the musl image + +Adding new recipes +------------------ + +Follow the coding style found in other layers, the aim here is to keep them consistent where possible +and very easy to read. Follow the order found in the "headers" of each recipe and in general. + +.bb recipes that come from Morello gitlab and are Morello "edits"" of upstream inherit the name Morello in the recipe: package-name-morello +.bbappends do not need to do this even if they come from Morello gitlab as they would only change SRC_URI + +Whether to append or start a new recipe is up to the designer, whatever is the easiest. + +Mailing list +------------ + +https://op-lists.linaro.org/mailman3/lists/linux-morello-distros.op-lists.li... + +References +---------- + +[1] https://kas.readthedocs.io/en/latest/ \ +[2] https://developer.arm.com/documentation/den0132/0100/Setting-up-the-Morello-... \ +[3] https://developer.arm.com/documentation/102278/0001/?lang=en