On this page:
- Building TI/Embedian’s Yocto BSP Distribution
- Introduction
- Generating SSH Keys
- Overview of the meta-smarct437x-sdk-03-00-00-04 Yocto Layer
- Setting Up the Tools and Build Environment
- Building the target platforms
- Setup SD Card
- Install Root File System and Kernel Modules
- Setup eMMC
- Install Root File System
- Feed Packages
- Writing Bitbake Recipes
Building TI/Embedian’s Yocto BSP Distribution
Eric Lee
version 1.0a, 8/24/2016
Introduction
This document describes how Embedian builds a customized version of TI's AM437X official BSP release for Embedian's SMARC-T4378 product platform. The approach is to pull from Embedian's public facing GIT repository and build that using bitbake. The reason why we use this approach is that it allows co-development. The build output is comprised of binary images, feed packages, and an SDK for SMARC-T4378 specific development.
TI makes their Processor-SDK-03.00.00.04 Arago build scripts available via the following GIT repository:
If you’re interested in TI’s overall Processor SDK build and test process you should analyze the following repository:
It is this repository that actually pulls in the oe-layersetup project to perform the Linux Processor-SDK builds for TI’s entire suite of ARM CortextA chips. In this document we are only concerned with the oe-layersetup project.
Generating SSH Keys
We recommend you use SSH keys to establish a secure connection between your computer and Embedian Gitlab server. The steps below will walk you through generating an SSH key and then adding the public key to our Gitlab account.
Step 1. Check for SSH keys
First, we need to check for existing ssh keys on your computer. Open up Git Bash and run:
Check the directory listing to see if you have a file named either id_rsa.pub
or id_dsa.pub
. If you don't have either of those files go to step 2. Otherwise, you already have an existing keypair, and you can skip to step 3.
Step 2. Generate a new SSH key
To generate a new SSH key, enter the code below. We want the default settings so when asked to enter a file in which to save the key, just press enter.
Now you need to enter a passphrase.
Which should give you something like this:
Step 3. Add your SSH key to Embedian Gitlab Server
Copy the key to your clipboard.
Go to Embedian Git Server. At Profile Setting --> SSH Keys --> Add SSH Key
Paste your public key and press "Add Key" and your are done.
Overview of the meta-smarct437x-sdk-03-00-00-04 Yocto Layer
The supplied meta-smarct437x-sdk-03-00-00-04 Yocto compliant layer has the following organization:
Notes on meta-smarct437x-sdk-03-00-00-04 layer content
conf/machine/*
This folder contains the machine definitions for the smarct437x platform and backup repository in Embedian. These select the associated kernel, kernel config, u-boot, u-boot config, and UBI image settings.
recipes-bsp/u-boot/*
This folder contains recipes used to build DAS U-boot for smarct437x platform.
recipes-connectivity/lftp/*
This folder adds lftp ftp client utility for smarct437x platform.
recipes-core/base-files/*
This recipe is used to amend the device hostname for the platform.
recipes-core/busybox/*
This recipe modifies TI’s BusyBox configuration to remove telnet from the image.
recipes-core/images/*
These recipes are used to create the final target images for the devices. When you run Bitbake one of these recipes would be specified. For example, to build the root file system for the smarct437x platform:
recipes-core/init-ifupdown*
This recipe is used to amend device network interfaces
recipes-devtools/nodejs/*
These recipes build the Node.js Javascript server execution environment.
recipes-kernel/linux/*
Contains the recipes needed to build the smarct437x Linux kernels.
recipes-support/boost/*
Adds Boost to the images. Boost provides various C++ libraries that encourage cross-platform development.
recipes-support/ntp/*
Network time protocol support.
recipes-tisdk/ti-tisdk-makefile/*
Add smarct437x device tree into Makefile.
Setting Up the Tools and Build Environment
To build the latest TI AM437X Processor-SDK-03.00.00.04, you first need an Ubuntu 14.04LTS or 16.04LTS installation. Because of support for 32-bit host is dropped as Linaro toolchain is available only for 64-bit machines., an x86_64 ubuntu 14.04 is highly recommended. Since bitbake does not accept building images using root privileges, please do not login as a root user when performing the instructions in this section.
Once you have Ubuntu 14.04LTS running, install the additional required support packages using the following console command:
If you are using a 64-bit Linux, then you'd also need to install 32-bit support libraries, needed by the pre-built Linaro toolchain and other binary tools.
You’ll also need to change the default shell to bash from Ubuntu’s default dash shell (select the <No> option):
To build TI’s am437x Processor-SDK-03.00.00.04 you will need to install the Linaro arm compiler that TI used for the release:
PATH
definition to the .bashrc
file in your $HOME
directory:
meta-smarct437x-sdk-03.00.00.04
layer to the build process.
Edit the ~/smarct4x-sdk-03.00.00.04/build/conf/bblayers.conf file to include the meta-smarct437x-sdk-03-00-00-04 layer in the layer list. It should look something like this (the example reflects the absolute paths on my machine):
Building the target platforms
To build the Embedian SMARC-T437X developer board images, respectively, use the following commands:
Once it done, you can find all required images under ~/smarct4x-sdk-03.00.00.04/build/arago-tmp-external-linaro-toolchain/deploy/images/smarct437x/
You may want to build programs that aren’t installed into a root file system so you can make them available via a feed site (described below.) To do this you can build the package directly and then build the package named package-index to add the new package to the feed site.
The following example builds the minicom program and makes it available on the feed site:
~/smarct4x-sdk-03.00.00.04/build/arago-tmp-external-linaro-toolchain/deploy/
deploy/images/smarct437x/*
This folder contains the binary images for the root file system and the Embedian SMARC-T437X specific version of the am437x SDK. Specifically the images are:
deploy/images/smarct437x/u-boot.img
This u-boot bootloader binary for SMARC T437X
deploy/images/smarct437x/MLO.byteswap
The "Stage 1 SPI NOR flash Boot Loader" for SMARC-T437X. Its purpose is load the Stage 2 Boot Loader (u-boot.img).
deploy/images/smarct437x/zImage
The kernel zImage for SMARC-T437X.
deploy/images/smarct437x/zImage-am437x-smarct437x.dtb
The device tree binary file for SMARC-T437X.
deploy/images/smarct437x/smarct437x-rootfs-image-smarct437x*
Embedian root file system images for software development on Embedian’s SMARC-T437X platforms.
deploy/ipk/*
This folder contains all the packages used to construct the root file system images. They are in opkg format (similar format to Debian packages) and can be dynamically installed on the target platform via a properly constructed feed file. Here is an example of the feed file (named base-feeds.conf) that is used internally at Embedian to install upgrades onto a smarct437x platform without reflashing the file system:
deploy/licenses/*
deploy/sdk/arago-2016.05-cortexa9-linux-gnueabi-tisdk.sh
Setup SD Card
For these instruction, we are assuming: DISK=/dev/mmcblk0, "lsblk" is very useful for determining the device id.
Erase SD card:
Create Partition Layout:
With util-linux v2.26, sfdisk was rewritten and is now based on libfdisk.
Create Partitions:
Format Partitions:
Mount Partitions:
On some systems, these partitions may be auto-mounted...
Install Bootloader
If SPI NOR Flash is not empty
The MLO.byteswap and u-boot.img is pre-installed in SPI NOR flash at factory default. SMARC-T4378 is designed to always boot upi from SPI NOR flash and to load zImage and root file systems based on the setting of BOOT_SEL. If users need to fuse their own u-boot or perform u-boot upgrade. This section will instruct you how to do that.
Copy MLO.byteswap/u-boot.img to the boot partition.
Fuse MLO.byteswap/u-boot.img to the SPI NOR flash.
Stop at U-Boot command prompt (Press any key when booting up).
If SPI NOR Flash is empty
In some cases, when SPI NOR flash is erased or the u-boot is under development, we need a way to boot from SD card first. Users need to shunt cross the TEST# pin to ground. In this way, SMARC-T437X will always boot up from SD card.
Copy MLO/u-boot.img to the boot partition
uEnv.txt based bootscript
Create "uEnv.txt" boot script: (vim uEnv.txt)
Install Kernel zImage
Copy zImage to the boot partition:
Install Kernel Device Tree Binary
Install Root File System and Kernel Modules
Remove SD card:
Setup eMMC
Setting up eMMC usually is the last step at development stage after the development work is done at your SD card or NFS environments. eMMC on module will be always emulated as /dev/mmcblk0. Setting up eMMC now is nothing but changing the device descriptor.
This section gives a step-by-step procedure to setup eMMC flash. Users can write a shell script your own at production to simplify the steps.
First, we need to backup the final firmware from your SD card or NFS.
Prepare for eMMC binaries from SD card (or NFS):
Insert SD card into your Linux PC. For these instructions, we are assuming: DISK=/dev/mmcblk0, "lsblk" is very useful for determining the device id.
For these instruction, we are assuming: DISK=/dev/mmcblk0, "lsblk" is very useful for determining the device id.
Mount Partitions:
On some systems, these partitions may be auto-mounted...
Copy zImage to rootfs partition:
Copy uEnv.txt to rootfs partition:
Copy and paste the following contents to /media/rootfs/home/root ($ sudo vim /media/rootfs/home/root/uEnv.txt)
Copy device tree blob to rootfs partition:
Copy final rootfs to rootfs partition:
Remove SD card:
Copy Binaries to eMMC from SD card:
Insert this SD card into your SMARC-T437X device (carrier board).
Now it will be almost the same as you did when setup your SD card, but the eMMC device descriptor is /dev/mmcblk0 now.
Erase SD card:
Create Partition Layout:
Format Partitions:
Mount Partitions:
Install binaries for partition 1
Copy uEnv.txt/zImage/*.dtb to the boot partition
Install Kernel Device Tree Binary
Install Root File System
Unmount eMMC:
Switch your Boot Select to eMMC and you will be able to boot up from SPI NOR flash and import u-boot environmental parameters and load kernel zImage and device tree blob from eMMC now.
Feed Packages
The following procedure can be used on a Embedian SMARC-T437X device to download and utilize the feed file show above to install the minicom terminal emulation program:
Writing Bitbake Recipes
In order to package your application and include it in the root filesystem image, you must write a BitBake recipe for it.
When starting from scratch, it is easiest to learn by example from existing recipes.
Example HelloWorld recipe using autotools
For software that uses autotools (./configure; make; make install), writing recipes can be very simple:
SRC_URI
specifies the location to download the source from. It can take the form of any standard URL using http://, ftp://, etc. It can also fetch from SCM systems, such as git in the example above.
PR
is the package revision variable. Any time a recipe is updated that should require the package to be rebuilt, this variable should be incremented.
inherit autotools
brings in support for the package to be built using autotools, and thus no other instructions on how to compile and install the software are needed unless something needs to be customized.
S
is the source directory variable. This specifies where the source code will exist after it is fetched from SRC_URI and unpacked. The default value is ${WORKDIR}/${PN}-${PV}
, where PN
is the package name and PV
is the package version. Both PN
and PV
are set by default using the filename of the recipe, where the filename has the format PN_PV.bb
.
Example HelloWorld recipe using a single source file
This example shows a simple case of building a helloworld.c file directly using the default compiler (gcc). Since it isn’t using autotools or make, we have to tell BitBake how to build it explicitly.
In this case, SRC_URI
specifies a file that must exist locally with the recipe. Since there is no code to download and unpack, we set S
to WORKDIR
since that is where helloworld.c will be copied to before it is built.
WORKDIR
is located at ${OETREE}/build/arago-tmp-external-linaro-toolchain/work/cortexa9hf-vfp-neon-linux-gnueabi/<package name and version>
for most packages. If the package is machine-specific (rather than generic for the armv7ahf architecture), it may be located in the smarct437x-linux-gnueabi subdirectory depending on your hardware (this applies to kernel packages, images, etc).
do_compile
defines how to compile the source. In this case, we just call gcc directly. If it isn’t defined, do_compile
runs make
in the source directory by default.
do_install
defines how to install the application. This example runs install
to create a bin directory where the application will be copied to and then copies the application there with permissions set to 755.
D
is the destination directory where the application is installed to before it is packaged.
${bindir}
is the directory where most binary applications are installed, typically /usr/bin
.
For a more in-depth explanation of BitBake recipes, syntax, and variables, see the Recipe Chapter of the OpenEmbedded User Manual.
-- End of Document --
version 1.0a, 8/24/2016
Last updated 2016-08-24