Changes to the 'contributing' section with helpful hints. Add README.md to each layer and have a top-level README.md
Signed-off-by: Pawel Zalewski pzalewski@thegoodpenguin.co.uk --- README.md | 108 +++++++++---------------------- meta-morello-toolchain/README.md | 16 +++++ meta-morello/README.md | 88 +++++++++++++++++++++++++ 3 files changed, 134 insertions(+), 78 deletions(-) create mode 100644 meta-morello-toolchain/README.md create mode 100644 meta-morello/README.md
diff --git a/README.md b/README.md index f3f35a4..3e503de 100644 --- a/README.md +++ b/README.md @@ -1,98 +1,50 @@ meta-morello ============
-Meta-morello provides the layer required to build the firmware that lives on the SD card and a `Morello` enabled +Meta-morello provides the layers 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-soc for the actual hardware -- morello-fvp for running a `FVP` image using `runfvp` script @ `meta-arm` - -Building images ---------------- - -``` -$ kas build ./kas/morello-soc.yml -``` -or -``` -$ kas build ./kas/morello-fvp.yml -``` -FVP ---- - -To run the FVP model: -``` -$ cd poky -$ . oe-init-build-env ../build -$ ./../meta-arm/scripts/runfvp --console tmp-fvp/deploy/images/morello-fvp/rootfs-morello-fvp.fvpconf -``` -or -``` -$ cd poky -$ . oe-init-build-env ../build -$ ./../meta-arm/scripts/runfvp tmp-fvp/deploy/images/morello-fvp/rootfs-morello-fvp.fvpconf -``` -Then inspect the FVP console output for information on your uart_ap port: -``` -$ terminal_uart_ap: Listening for serial connection on port 5003 -``` -With that knowledge you can now run: -``` -$ telnet localhost 5003 -``` -For further instructions on how to run the image with `FVP` go here [4] - -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 the USB via DD - -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 - -Adding new recipes ------------------- +* meta-morello
-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. +This layer contains most of the code recipes: firmware, kernel, FVP etc.
-`.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` +* meta-morello-toolchain
-Whether to append or start a new recipe at this stage is up to the designer, whatever is the easiest. +This layer contains recipes for compilers (Morello LLVM and GCC) but also the C libraries.
-Mailing list +Contributing ------------
-https://op-lists.linaro.org/mailman3/lists/linux-morello-distros.op-lists.li... +We accept patches through the mailing list only. + +https://op-lists.linaro.org/mailman3/lists/linux-morello.op-lists.linaro.org... + +Check if the work is not already scheduled in the issues section. + +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 forks 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`, which is a bad practice but +it is acceptable for now. + +Whether to append or start a new recipe at this stage is up to the designer, whatever is the easiest. + +You should familiarize yourself with the following documents [2][3][4].
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 -[4] https://github.com/jonmason/meta-arm/blob/master/documentation/runfvp.md \ No newline at end of file +[2] https://www.openembedded.org/wiki/Commit_Patch_Message_Guidelines +[3] https://github.com/ARM-software/abi-aa/blob/main/aaelf64-morello/aaelf64-mor... +[4] https://git.morello-project.org/morello/kernel/linux/-/wikis/Transitional-Mo... + + +maintainer +---------- +* Pawel Zalewski pzalewski@thegoodpenguin.co.uk \ No newline at end of file diff --git a/meta-morello-toolchain/README.md b/meta-morello-toolchain/README.md new file mode 100644 index 0000000..8ce9f10 --- /dev/null +++ b/meta-morello-toolchain/README.md @@ -0,0 +1,16 @@ +meta-morello-toolchain +====================== + +This layer provides the Morello LLVM and GCC toolchains. +It also contains the C libraries. + +Contributing +------------ + +We accept patches through the mailing list only. + +https://op-lists.linaro.org/mailman3/lists/linux-morello.op-lists.linaro.org... + +maintainer +---------- +* Pawel Zalewski pzalewski@thegoodpenguin.co.uk \ No newline at end of file diff --git a/meta-morello/README.md b/meta-morello/README.md new file mode 100644 index 0000000..c87d84c --- /dev/null +++ b/meta-morello/README.md @@ -0,0 +1,88 @@ +meta-morello +============ + +Booting the hardware +-------------------- + +For information on how to boot the hardware and how the hardware is booting see [1] and [2]. + +Machines +-------- + +The machines have been split into: +- morello-soc for the actual hardware +- morello-fvp for running a `FVP` image using `runfvp` script @ `meta-arm` + +Building images +--------------- + +``` +$ kas build ./kas/morello-soc.yml +``` +or +``` +$ kas build ./kas/morello-fvp.yml +``` +FVP +--- + +To run the FVP model: +``` +$ cd poky +$ . oe-init-build-env ../build +$ ./../meta-arm/scripts/runfvp --console tmp-fvp/deploy/images/morello-fvp/rootfs-morello-fvp.fvpconf +``` +or +``` +$ cd poky +$ . oe-init-build-env ../build +$ ./../meta-arm/scripts/runfvp tmp-fvp/deploy/images/morello-fvp/rootfs-morello-fvp.fvpconf +``` +Then inspect the FVP console output for information on your uart_ap port: +``` +$ terminal_uart_ap: Listening for serial connection on port 5003 +``` +With that knowledge you can now run: +``` +$ telnet localhost 5003 +``` +For further instructions on how to run the image with `FVP` go here [3] + +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 the USB via DD + +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 + + +Contributing +------------ + +We accept patches hrough the mailing list only. + +https://op-lists.linaro.org/mailman3/lists/linux-morello.op-lists.linaro.org... + + +References +---------- + +[1] https://developer.arm.com/documentation/den0132/0100/Setting-up-the-Morello-... +[2] https://developer.arm.com/documentation/102278/0001/?lang=en +[3] https://github.com/jonmason/meta-arm/blob/master/documentation/runfvp.md + + +maintainer +---------- +* Pawel Zalewski pzalewski@thegoodpenguin.co.uk \ No newline at end of file