diff options
Diffstat (limited to 'bsp/meta-sancloud/README.md')
| -rw-r--r-- | bsp/meta-sancloud/README.md | 86 |
1 files changed, 72 insertions, 14 deletions
diff --git a/bsp/meta-sancloud/README.md b/bsp/meta-sancloud/README.md index 4356460f..c0c080b0 100644 --- a/bsp/meta-sancloud/README.md +++ b/bsp/meta-sancloud/README.md @@ -1,14 +1,14 @@ -[<img align=right src="https://www.sancloud.co.uk/wp-content/uploads/2016/09/sancloud_and_address_web.png">](https://www.sancloud.co.uk/) - Yocto BSP layer for the SanCloud boards ======================================= Quick links ----------- +[<img align=right src="https://www.sancloud.co.uk/wp-content/uploads/2016/09/sancloud_and_address_web.png">](https://www.sancloud.co.uk/) + * [SanCloud website](https://www.sancloud.co.uk/) -* [BeagleBone Enhanced Description](https://www.sancloud.co.uk/?page_id=254) +* [BeagleBone Enhanced Description](https://www.sancloud.co.uk/beaglebone-enhanced-bbe) * [Sancloud repositories on GitHub](https://github.com/SanCloudLtd) @@ -21,19 +21,42 @@ Currently supported hardware with corresponding Yocto Project MACHINE names: * `bbe`: Sancloud BeagleBone Enhanced (BBE) -This BSP is layer is tested in two primary configurations: +This BSP is layer supports the following configurations: * Automotive Grade Linux (AGL) * Arago Distribution - -Additionally, this BSP layer should work with the distro-less configuration -included in openembedded-core as well as the Poky distribution. +* Poky Reference Distribution + +Getting started with Poky +------------------------- + +This BSP layer is listed in the +[OpenEmbedded Layer Index](http://layers.openembedded.org/) +which makes getting started very easy. Once your OpenEmbedded/Yocto Project +build environment is set up you can use the `bitbake-layers layerindex-fetch` +command to download this layer with all its dependencies and add these layers +to your bblayers.conf file automatically. + +If you do not have a Yocto Project build environment set up please first +follow the +[Yocto Project Quick Build Guide](https://www.yoctoproject.org/docs/3.1.1/brief-yoctoprojectqs/brief-yoctoprojectqs.html) +to ensure that your Linux system has the correct packages installed and that +a simple build succeeds. Once you know that your Linux system is set up +correctly you can download the appropriate Yocto Project version and build an +image for the BBE using the following commands: + + git clone -b dunfell git://git.yoctoproject.org/poky + cd poky + source oe-init-build-env + bitbake-layers layerindex-fetch meta-sancloud + echo 'MACHINE = "bbe"' >> conf/local.conf + bitbake core-image-base Getting Started with AGL ------------------------ -This BSP layer is included in the most recent stable branch of AGL, code-named -Grumpy Guppy. AGL sources can be downloaded by following the +This BSP layer is included in recent releases of AGL. AGL sources can be +downloaded by following the [upstream instructions](https://wiki.automotivelinux.org/agl-distro/source-code). Once the AGL sources have been downloaded and you're in the top-level AGL directory, run the following commands to build the AGL Demo image for the @@ -42,12 +65,47 @@ Sancloud BBE: source meta-agl/scripts/aglsetup.sh -m bbe agl-demo agl-devel bitbake agl-demo-platform -Getting started with Arago --------------------------- +Getting started with Arago/Poky using kas +----------------------------------------- + +This BSP layer includes build configuration files for use with the +[kas build tool](https://github.com/siemens/kas). This tool can fetch all +layer dependencies (including bitbake) and set up a build directory with +appropriate configuration for the BBE and the chosen distro. It can be +installed by running `pip install kas` as long as you have a recent Python +version. + +### Poky + +To use kas to build the Poky distro for the BBE, run the following command in +the top directory of this repository: + + kas build kas/bbe-poky.yml + +### Arago + +To build the Arago distro for the BBE the appropriate ARM toolchain first +needs to be installed. This typically requires commands to be ran as root or +via sudo. For the dunfell branch, download +[gcc-arm-9.2-2019.12-x86_64-arm-none-linux-gnueabihf.tar.xz](https://bit.ly/arm-none-linux-gnueabihf-2019-12) +and unpack into /opt. This can be done at the command line using the +following commands: + + wget 'https://bit.ly/arm-none-linux-gnueabihf-2019-12' -O gcc-arm-9.2-2019.12-x86_64-arm-none-linux-gnueabihf.tar.xz + sudo tar xf gcc-arm-9.2-2019.12-x86_64-arm-none-linux-gnueabihf.tar.xz -C /opt + +Once the toolchain is installed in the correct location, run the following +command in the top level of this repository: + + kas build kas/bbe-arago.yml + +### Customisation -A pre-integrated Arago Distribution repository is available at -https://github.com/SanCloudLtd/sancloud-arago. Please follow the instructions -in the README.md file in that repository to get started. +The build configuration files in the kas directory can be used as the basis of +further customisation and integration work. It's recommended to copy the build +configuration files into your own repository (adding a `url:` entry for the +meta-sancloud layer) and work there so that your changes can be tracked +separately from future BSP updates in this repository. Support ------- |