From 1c7d6584a7811b7785ae5c1e378f14b5ba0971cf Mon Sep 17 00:00:00 2001 From: takeshi_hoshina Date: Mon, 2 Nov 2020 11:07:33 +0900 Subject: basesystem-jj recipes --- bsp/meta-arm/meta-arm-autonomy/README.md | 92 ++++++++++++++++++++++++++++++++ 1 file changed, 92 insertions(+) create mode 100644 bsp/meta-arm/meta-arm-autonomy/README.md (limited to 'bsp/meta-arm/meta-arm-autonomy/README.md') diff --git a/bsp/meta-arm/meta-arm-autonomy/README.md b/bsp/meta-arm/meta-arm-autonomy/README.md new file mode 100644 index 00000000..785f278b --- /dev/null +++ b/bsp/meta-arm/meta-arm-autonomy/README.md @@ -0,0 +1,92 @@ +meta-arm-autonomy Yocto Layer +============================= + +Introduction +------------ +This layer provides an hypervisor based solution (currently based on Xen) for +autonomous system. It contains recipes and classes to build host and guests +systems. + +To start using this layer, please check the +[Quick Start Guide](documentation/arm-autonomy-quickstart.md). + +Dependencies +------------ +This layer depends on several other Yocto layers: +* meta-openembedded (https://git.openembedded.org/meta-openembedded) +* poky (https://git.yoctoproject.org/poky) +* meta-virtualization (https://git.yoctoproject.org/meta-virtualization) + +Distribution Features +--------------------- +This layer is adding the following Yocto DISTRO_FEATURES: + +* arm-autonomy-host: this feature activates functionalities required to build + an autonomy host system. It is doing the following: + - add 'xen' and 'ipv4' to DISTRO_FEATURES. + - add xen backend drivers to linux kernel configuration. + - To reduce the root filesystem image size the kernel image is not installed. + +* arm-autonomy-guest: this feature activates functionalities to run as guest + of an autonomy system. It is doing the following: + - add 'ipv4' to DISTRO_FEATURES. + - add xen frontend drivers to linux kernel configuration. + - add console on hvc0 during init. + +Bitbake variables +----------------- +Some recipes and classes in this layer are introducing variables which can be +modified by the user in local.conf. +Each recipe introducing such variables has a chapter "Bitbake parameters" in +its documentation. + +Those documentation files should be checked for variables: +- [xen-devicetree](documentation/xen-devicetree.md) +- [xenguest-manager](documentation/xenguest-manager.md) +- [xenguest-network-bridge](documentation/xenguest-network-bridge.md) + +BSPs +---- +This layer is adding the following machines: + +* arm64-autonomy-guest: this machines creates a minimal BSP suitable to be used + as an autonomy guest. It is in fact only activating ARM64 architecture and + SMP in the linux kernel and is enabling the DISTRO_FEATURE + arm-autonomy-guest. + +Images +------ +This layer is adding the following images: + +* arm-autonomy-host-image-minimal: this image includes all elements required + to create a minimal arm-autonomy-host system. This includes xen and tools to + manage xen guests. This image depends on 'arm-autonomy-host' distribution + feature. + +Recipes and classes +------------------- +This layer is adding the following recipes and classes: + +* [xen-devicetree](documentation/xen-devicetree.md): this is a recipe to modify + a device tree blob to add information required to boot xen and a Dom0 linux. + +* [xenguest-mkimage](documentation/xenguest-mkimage.md): this is a tool to + create and modify images to be used as Xen guests. + +* [xenguest-manager](documentation/xenguest-manager.md): this is a tool to + create/remove/start/stop xen guest generated using xenguest-mkimage. + +* [xenguest-network-bridge](documentation/xenguest-network-bridge.md): this + recipe add tools and init scripts to create a bridge connected to the + external network on the host and allow guests to be connected to it. + +Contributing +------------ +This project has not put in place a process for contributions currently. If you +would like to contribute, please contact the maintainers + + +Maintainer(s) +------------- +* Bertrand Marquis +* Filipe Rinaldi -- cgit 1.2.3-korg