View source for Building the Yocto BSP (XELK)

{{InfoBoxTop}}
{{AppliesToAxel}}
{{AppliesToAxelLite}}
{{AppliesToAxelEsatta}}
{{Applies To Yocto}}
{{InfoBoxBottom}}

{{ImportantMessage|text=As the XELK kit is based on Yocto, the implementation of the MVM follows the approach described [[Managed_Virtual_Machine_(MVM)#Yocto-based_Linux_distribution|here]]. As such, the reading of [[Managed_Virtual_Machine_(MVM)#Yocto-based_Linux_distribution|this section]] is highly recommended.
}}
== History ==

{| class="wikitable" border="1"
!Version
!Date
!XELK version
!Notes
|-
|1.0.0
|Nov 2013
|[[Axel_Embedded_Linux_Kit_(XELK)#XELK 1.0.0 | XELK 1.0.0]]
|
|-
|1.2.0
|May 2014
|[[Axel_Embedded_Linux_Kit_(XELK)#XELK 1.2.0 | XELK 1.2.0]]
|
|-
|2.0.0
|Nov 2014
|[[Axel_Embedded_Linux_Kit_(XELK)#XELK 2.0.0 | XELK 2.0.0]]
|
|-
|2.1.0
|May 2015
|[[Axel_Embedded_Linux_Kit_(XELK)#XELK 2.1.0 | XELK 2.1.0]]
|
|-
|2.2.0
|Feb 2016
|[[Axel_Embedded_Linux_Kit_(XELK)#XELK 2.2.0 | XELK 2.2.0]]
|
|-
|2.3.1
|Oct 2016
|[[Axel_Embedded_Linux_Kit_(XELK)#XELK 2.3.1 | XELK 2.3.1]]
|
|-
|3.0.1
|Nov 2017
|[[Axel_Embedded_Linux_Kit_(XELK)#XELK 3.0.1 | XELK 3.0.1]]
|
|-
|}

== Quick reference ==

{| class="wikitable" border="1"
|+Repository Information
|-
! Repository
| BSP Manifest
| Yocto BSP Layer
| BSP Manifest
| Yocto BSP Layer
|-
! URL
| git@git.dave.eu:axel/axel-bsp.git
| git@git.dave.eu:axel/meta-axel.git
| git@git.dave.eu:axel/axel-bsp.git
| git@git.dave.eu:axel/meta-axel.git
|-
! stable branch
| axel-dora
| axel-dora
| axel-krogoth
| axel-krogoth
|-
! stable tag
| xelk-2.3.2
| xelk-2.3.2
| xelk-3.0.0
| xelk-3.0.0
|-
|}

{| class="wikitable" border="1"
|+Build targets
! Name
! Description
|-
| axel-image-x11
| standard image with X11 backend
|-
| axel-image-qt5
| QT5 based root file system with eglfs backend
|-
| fsl-image-qt5
| QT5 based root file system with Weston backend
|}

==Introduction==
This is a quickstart guide to build Yocto BSP for Axel SOMs, to rebuild the binaries (U-Boot, Linux kernel, root file system) provided with XELK releases.

For more information regarding Yocto build system, go to its [[:Category:Yocto|dedicated category page]]

== Build System prerequisites ==

XELK MVM is already configured to build this Yocto version/configuration, however, users typically don't use a VirtualBox VM for Yocto builds for performance reasons.

You can refer to [http://www.yoctoproject.org/docs/1.8/mega-manual/mega-manual.html#yp-resources Yocto manual setup section] for a list of supported Linux distribution and their configuration to create your own build environment on your favorite distribution.

== Build the XELK Yocto BSP ==

=== Initialize the build environment ===

XELK Yocto BSP uses [https://code.google.com/p/git-repo/ git-repo] tool to fetch all the required git repositories to build 

<pre class="workstation-terminal">
dvdk@dvdk-vm:~/axel$ curl http://commondatastorage.googleapis.com/git-repo-downloads/repo > repo
dvdk@dvdk-vm:~/axel$ chmod a+x repo
dvdk@dvdk-vm:~/axel$ ./repo init -u git@git.dave.eu:axel/axel-bsp.git -b axel-krogoth
dvdk@dvdk-vm:~/axel$ ./repo sync
</pre>

=== Build the Yocto BSP image ===

Please note that even the basic root file system requires a few hours to build on a mid/hi range desktop (4-6 cores, 8-12 GiB RAM) also depending on your Internet connection speed (all sources are fetched from the network). Nearly 20GiB of disk space is required for the build. Moreover, building inside the DVDK adds some overhead, since the performances of a virtual machine are reduced if compared to the physical hardware. Thus, it's recommended to check the hardware capabilities of the host system and, when building with Yocto is required, developers should consider the following options: 
* migrating the build system to a physical machine
* assuming that the host system has the required resources, extending the hardware capabilities of the default DVDK (eg: adding more cores and disk space)

Once completed the initialization phase, developers can launch the Yocto image build process with the following commands:

<pre class="workstation-terminal">
dvdk@dvdk-vm:~/axel$ DISTRO=fsl-imx-x11 MACHINE=imx6qxelk source axel-setup-release.sh -b build-x11
dvdk@dvdk-vm:~/axel/build$ bitbake axel-image-x11
</pre>

The resulting files (kernel, devicetree and u-boot binaries, plus .tar.gz root file system) will then be available inside ''build/tmp/deploy/images/axel''.

===Generating the SDKs===
After creating an image as described above, the corresponding SDK can be generated by issuing the following command:
<pre class="workstation-terminal">
bitbake <target-image-name> -c populate-sdk
</pre>
Again, replace <code><target-image-name></code> with one of the images listed in [[#Quick reference|here]].

=== Build additional packages ===

To build additional packages the user must first enter the directory where the axel-bsp-init-env.sh is placed and source it

<pre class="workstation-terminal">
dvdk@dvdk-vm:~/axel$ DISTRO=fsl-imx-x11 MACHINE=imx6qxelk source axel-setup-release.sh -b build-x11
dvdk@dvdk-vm:~/axel/build$
</pre>

And then he can run any of the [http://www.yoctoproject.org/docs/latest/mega-manual/mega-manual.html#usingpoky-components-bitbake bitbake] commands.

<pre class="workstation-terminal">
dvdk@dvdk-vm:~/xelk/build$ bitbake memtester
</pre>

The resulting packages (the default format is ipk) can be found inside ''build/tmp/deploy/rpm''.

<pre class="workstation-terminal">
dvdk@dvdk-vm:~/xelk/build$ ls -l tmp/deploy/ipk/armv7a-vfp-neon/memtester*
-rw-r--r-- 2 dvdk dvdk  7102 Aug 26 16:33 tmp/deploy/ipk/armv7a-vfp-neon/memtester_4.1.3-r0_armv7a-vfp-neon.ipk
-rw-r--r-- 2 dvdk dvdk 21720 Aug 26 16:33 tmp/deploy/ipk/armv7a-vfp-neon/memtester-dbg_4.1.3-r0_armv7a-vfp-neon.ipk
-rw-r--r-- 2 dvdk dvdk   792 Aug 26 16:33 tmp/deploy/ipk/armv7a-vfp-neon/memtester-dev_4.1.3-r0_armv7a-vfp-neon.ipk
-rw-r--r-- 2 dvdk dvdk  2748 Aug 26 16:33 tmp/deploy/ipk/armv7a-vfp-neon/memtester-doc_4.1.3-r0_armv7a-vfp-neon.ipk
</pre>