In this exercise we will build a Linux distribution for Raspberry Pi using the Yocto Project. We will begin by setting up our build host environment, we will then build Poky (a reference distribution) as it is and then we will run it with QEMU (Quick Emulator). After that we will begin to customize Poky by adding a layer that will contain our own images and recipe. Then as a final step we will add the Raspberry Pi layer which will provide board support and using that we will create a custom bootable image for Raspberry Pi.
Please feel free to contact me if you find any mistakes. All feedback is welcome.
##Prerequisites
The Yocto Project documentation recommends that you have at least 50 gb of hard disk space available but more is better.
In the examples I will work from a folder called yocto in my home directory. Therefore if you see the following path
/home/oscar/yocto
Please make sure to change it.
###A supported distribution: In order to use Yocto you need to install a supported Linux distribution. You can find the full list here: http://www.yoctoproject.org/docs/current/ref-manual/ref-manual.html#detailed-supported-distros
In the examples I will use Ubuntu 14.04 LTS.
###Install required packages The following packages are required for Ubuntu 14.04 LTS:
sudo apt-get install gawk wget git-core diffstat unzip texinfo gcc-multilib \
build-essential chrpath socat libsdl1.2-dev xterm
If you are using any other supported distribution you’ll find the required packages here: http://www.yoctoproject.org/docs/current/ref-manual/ref-manual.html#required-packages-for-the-host-development-system
##Step 1: Building Poky and using QEMU First we need to get the reference distribution (Poky).
git clone --branch krogoth git://git.yoctoproject.org/poky
cd poky
We then have to initialize the build environment.
source oe-init-build-env qemu-build
If you happen to close your terminal you will have to initialize your build enviroment again. We are now ready to build an image.
bitbake core-image-minimal
It might take hours to build everything (depending on how fast your machine is).
When it's completed we're ready to run our image.
runqemu qemux86
Note If you're running on a system without display you may have to use: runqemu qemux86 nographic
You may have to provide your password when starting qemu. If that is the case you will see something like this:
[sudo] password for oscar:
Wait for the system to boot and then login as root
qemux86 login: root
root@qemux86:~# uname -a
Linux qemux86 4.1.17-yocto-standard #1 SMP PREEMPT Sun Apr 17 11:00:20 CEST 2016 i686 GNU/Linux
Congratulations! You have now built Poky and run it in QEMU!
##Step 2: Making our own layer and recipe In the previous part we built Poky without making any changes. In this step we're going to customize it by adding a layer that will contain an example recipe and our custom image.
Make sure that you're in the poky folder (for me that's /home/oscar/yocto/poky)
We will now generate our layer and example recipe. In the example I will call the layer squeed and the the recipe for helloSqueed. Please feel free to name yours whatever you like, but don't forget to change the name everywhere if you do!
yocto-layer create squeed
Please enter the layer priority you'd like to use for the layer: [default: 6] 10
Would you like to have an example recipe created? (y/n) [default: n] y
Please enter the name you'd like to use for your example recipe: [default: example] helloSqueed
Would you like to have an example bbappend file created? (y/n) [default: n] n
New layer created in meta-squeed.
Don't forget to add it to your BBLAYERS (for details see meta-squeed\README).
You will notice that a folder meta-squeed has been created. The meta- is added to the layer name by convention.
After adding the layer you should have folder with the following structure:
tree meta-squeed/
meta-squeed/
├── conf
│ └── layer.conf
├── COPYING.MIT
├── README
└── recipes-example
└── example
├── helloSqueed-0.1
│ ├── example.patch
│ └── helloworld.c
└── helloSqueed_0.1.bb
You will now have a generated recipe helloSqueed_0.1.bb with the source code: helloworld.c and example.patch
Lets edit helloworld.c to add a custom greeting
nano meta-squeed/recipes-example/example/helloSqueed-0.1/helloworld.c
I changed my helloworld example to print Live long and prosper.\n instead.
We also need an image that we will add our recipe to
mkdir -p meta-squeed/recipes-core/images
Using nano (or your favorit editor) create the following image recipe
nano meta-squeed/recipes-core/images/qemu-squeed-image.bb
Enter the following:
require recipes-core/images/core-image-minimal.bb
IMAGE_INSTALL += "helloSqueed"
Go back to the qemu-build directory. For me that's /home/oscar/yocto/poky/qemu-build
cd qemu-build
Now as a final step we need to add our new layer meta-squeed to our configuration file conf/bblayers.conf.
bitbake-layers add-layer $HOME/yocto/poky/meta-squeed/
The last argument is the path to our created layer. Make sure that it reflects the path that you have.
If we take a look at conf/bblayers.conf you should see something like this:
BBLAYERS ?= " \
/home/oscar/yocto/poky/meta \
/home/oscar/yocto/poky/meta-yocto \
/home/oscar/yocto/poky/meta-yocto-bsp \
/home/oscar/yocto/poky/meta-squeed \
"
Alternatively we could also use bitbake-layers show-layers to inspect what layers we have added.
layer path priority
==========================================================================
meta /home/oscar/yocto/poky/meta 5
meta-yocto /home/oscar/yocto/poky/meta-yocto 5
meta-yocto-bsp /home/oscar/yocto/poky/meta-yocto-bsp 5
meta-squeed /home/oscar/yocto/poky/meta-squeed 10
Now we can build our custom image by running:
bitbake qemu-squeed-image
When the build has completed we can run it with QEMU as before.
runqemu qemux86
When startup is completed you will see the following:
Poky (Yocto Project Reference Distro) 2.0.1 qemux86 /dev/ttyS0
qemux86 login: root
root@qemux86:~# helloworld
Live long and prosper.
##Step 3: Building our distribution for Raspberry Pi
In this final part we will now get our Linux distribution running on actual Raspberry Pi hardware. In order to do this we need a Board Support Package to provide hardware support. We can find this in the meta-raspberryp layer. We will also create another image to make our distribution run on hardware.
Hint You can search for available layers here
Go back to the poky directory (for me that's /home/oscar/yocto/poky/)
cd ..
Then we need to clone the meta-raspberryp layer.
git clone --branch krogoth git://git.yoctoproject.org/meta-raspberrypi
If we look inside the meta-raspberrypi layer we will see that it comes with three standard images.
ls meta-raspberrypi/recipes-core/images/
rpi-basic-image.bb rpi-hwup-image.bb rpi-test-image.bb
We will base our new image on the rpi-basic-image
nano meta-squeed/recipes-core/images/rpi-squeed-image.bb
Make sure the file contains:
require recipes-core/images/rpi-basic-image.bb
IMAGE_INSTALL += "helloSqueed"
Since we're changing target we'll setup a new build environment.
source oe-init-build-env build
We then need to add both our own layer meta-squeed and the meta-raspberrypi layer to the local configuration.
bitbake-layers add-layer $HOME/yocto/poky/meta-raspberrypi/
bitbake-layers add-layer $HOME/yocto/poky/meta-squeed/
conf/bblayers.conf should now contain both these layers and look something this:
BBLAYERS ?= " \
/home/oscar/yocto/poky/meta \
/home/oscar/yocto/poky/meta-yocto \
/home/oscar/yocto/poky/meta-yocto-bsp \
/home/oscar/yocto/poky/meta-raspberrypi \
/home/oscar/yocto/poky/meta-squeed \
"
We are now ready to build our new image!
If you have a Raspberry Pi 1 use the following command
MACHINE=raspberrypi bitbake rpi-squeed-image
Otherwise if you have Raspberry Pi 2:
MACHINE=raspberrypi2 bitbake rpi-squeed-image
While running bitbake you should notice that the Build Configuration has changed. For example:
Build Configuration:
...
MACHINE = "raspberrypi"
...
meta
meta-yocto
meta-yocto-bsp = "krogoth:40f4a6d075236265086cc79400dea3c14720383a"
meta-raspberrypi = "krogoth:a5f9b07a820d50ae5fb62e07306cd4e72d8638a9"
meta-squeed = "krogoth:40f4a6d075236265086cc79400dea3c14720383a"
Once the build has completed you'll find the image here (assuming you're in the build directory)
tmp/deploy/images/raspberrypi/rpi-squeed-image-raspberrypi.rpi-sdimg
Advice how to write this image to an SD Card can be found here
Now you should be ready to go. You can now for example connect a monitor and keyboard to your Raspberry Pi and start using it. You can also use ssh to connect to it. In my case:
ssh root@192.168.0.17
root@raspberrypi:~# helloworld
Live long and prosper.
Success! This is the final step of our excersice, but we have only scratched the surface of what is possible. You could for example add more applications, write a kernel module, run your distribution on some other hardware or investigate booting from TFTP. There are lots of more things to discover and I hope you'll have fun while doing so!
For more information I can warmly recommend reading the following resources.
[BitBake User Manual: Hello World Example] (www.yoctoproject.org/docs/current/bitbake-user-manual/bitbake-user-manual.html#hello-world-example)