How To Add A Custom App To A Yocto Build
This page is a walk-through to show you how to add your own code/app to a custom Linux build that uses Yocto.
Making A Basic Hello, World App (Binary)
Firstly, we need a basic application that we can then add to a Yocto build. Let’s create a simple application that prints
Hello, World to
stdout and then exits.
We need to create the following files:
These will be added to a git repository and pushed to GitHub (no folder structure, all these files will be added to the root repository directory).
Let’s create a
And a matching
We also need a
LICENSE file. Yocto is quite particular about licenses, to ensure that users can specify exactly what licensing restrictions are present in a particular build (e.g. make sure this build ONLY contains open-source code). Create a
LICENSE file, we will use the MIT license for this one:
We need a
Finally, make a
Notice in the
Makefile.am file that we add
helloworld to the
bin_PROGRAMS variable. This makes Yocto create a binary executable of your example “Hello, World” application and places it in
/usr/bin, making it executable from the command-line. We will use this feature to test it in QEMU once we have built the image below.
Commit all these files into a git repository. If you want the Yocto layer to download the files automatically, this repository needs to be placed on a server, so I used GitHub.
The code for this example app is located at https://github.com/gbmhunter/YoctoHelloWorldApp.
Make A Layer To Hold The App
The application needs to be added to a Yocto layer before it can be included in a build. It can either be added to an existing layer, or added to a new one. We will create a new layer to keep the development environment “clean”. All layers are contained with a
meta-<layer name> folder.
We will create a layer called
meta-example. Create a new directory called meta-example in the main Yocto directory (called
poky in our case).
cd into this new directory and create a new folder called
The config folder holds configuration data about the layer.
cd into this directory and create a new file called
Add the standard config code to
layer.conf as shown below. This
layer.conf file tells Yocto where the BitBake files are located in this package. We won’t go into any more detail about this file, as this is beyond the scope of this tutorial.
We have finished with the
conf folder. We now need to create a recipe for this layer of ours.
cd into the parent directory, and create a new directory called
recipes-example, and create a new folder called
HelloWorld folder is going to contain a file which says that the HelloWorld app that we created above should be part of this recipe.
cd into the
HelloWorld directory, and create a new file called
HelloWorld_1.0.bb is a BitBake file which points to the location that the HelloWorld app is stored (in our case, GitHub). It contains the following code:
The first thing to note is
SRC_URL. This points to where the HelloWorld application lives. Notice the
git:// at the start, this is slightly different to the URL you would use to push/pull using SSH or HTML.
SRCREV. This points to the SHA of the commit you wish to use when building. Remember to update this if you push new commits to the repo!
LIC_FILES_CHKSUM. This tells Yocto where the license file is in the HelloWorld repo, and what the MD5 checksum of that file is. Yocto checks to make sure this file exists and the checksum is still the same, to make sure the licensing hasn’t changed.
If you want to calculate the MD5 checksum of your own
LICENSE file, you can use the
md5sum UNIX command:
Use the number, but ignore the filename which is printed afterwards!
The code for this example layer is located at https://github.com/gbmhunter/YoctoMetaExample.
Adding The Layer To The Build
The final step is to add the newly created layer to your build. Layers are not automatically included in each build, the layers used is determined by the file at
bblayers.conf file might look something like this:
We want to add our new layer to the
BBLAYERS variable as shown below:
cd back to
~/poky/build/. We can now start the build process by running:
This should take a few hours to complete when running it the first time!
Run Linux Build And Test Custom App
Now you have built a Linux image with your custom application added, lets run the Linux image in QEMU and test that the application is present and runs correctly.
Use the following command to start QEMU:
Login as root (no password needed). You should now be at the command prompt inside your Linux build. You can now make sure your “Hello, World” application is present by using the command:
All done! You have added your own custom app to a Yocto build!
This work is licensed under a Creative Commons Attribution 4.0 International License .
- April 2017 Updates
- Building Linux For The Zynq ZC702 Eval Kit Using Yocto
- rm (remove)
- How To Change The IO Scheduling Class And Priority In Linux