2. Getting a working Environment¶
2.1. Download Software Components¶
In order to follow this manual, some software archives are needed. There are several possibilities how to get these: either as part of an evaluation board package or by downloading them from the Pengutronix web site.
The central place for OSELAS related documentation is http://www.ptxdist.org. This website provides all required packages and documentation (at least for software components which are available to the public).
In order to build OSELAS.BSP-Pengutronix-Example, the following source archives have to be available on the development host:
- OSELAS.BSP-Pengutronix-Example.tar.bz2 (or a similar source)
Main Parts of PTXdist¶
The most important software component which is necessary to build an
OSELAS.BSP() board support package is the
ptxdist tool. So before
starting any work we’ll have to install PTXdist on the development host.
PTXdist consists of the following parts:
ptxdistis installed on the development host during the installation process.
ptxdistis called to trigger any action, like building a software packet, cleaning up the tree etc. Usually the
ptxdistprogram is used in a workspace directory, which contains all project relevant files.
- A Configuration System:
- The config system is used to customize a configuration, which contains information about which packages have to be built and which options are selected.
- Due to the fact that some upstream packages are not bug free – especially with regard to cross compilation – it is often necessary to patch the original software. PTXdist contains a mechanism to automatically apply patches to packages. The patches are bundled into a separate archive. Nevertheless, they are necessary to build a working system.
- Package Descriptions:
- For each software component there is a “recipe” file, specifying which actions have to be done to prepare and compile the software. Additionally, packages contain their configuration sniplet for the config system.
PTXdist does not come with a pre-built binary toolchain. Nevertheless, PTXdist itself is able to build toolchains, which are provided by the OSELAS.Toolchain() project. The different OSELAS toolchains can be found at https://www.pengutronix.de/en/software/toolchain.html.
Refer to the section Building a Toolchain for more information.
- Board Support Package:
- This is an optional component, mostly shipped aside with a piece of hardware. There are various BSPs available, some are generic, some are intended for a specific hardware.
Extracting the Sources¶
Do the following steps at best in your own home directory ($HOME).
You need root permissions only in the
make install step, and nowhere
To install PTXdist, the archive Pengutronix provides has to be extracted:
- The PTXdist software itself
The PTXdist archive has to be extracted into some temporary directory in
order to be built before the installation, for example the
directory in the user’s home. If this directory does not exist, we have
to create it and change into it:
$ cd $ mkdir local $ cd local
Next step is to extract the archive:
$ tar -xjf ptxdist-2023.03.0.tar.bz2
If everything goes well, we now have a
directory, so we can change into it:
$ cd ptxdist-2023.03.0 $ ls -lF total 396 -rw-r--r-- 1 jbe ptx 18446 Apr 29 09:36 COPYING -rw-r--r-- 1 jbe ptx 3933 Apr 29 09:36 CREDITS -rw-r--r-- 1 jbe ptx 57 Apr 29 09:36 INSTALL -rw-r--r-- 1 jbe ptx 4483 Apr 29 09:36 Makefile.in -rw-r--r-- 1 jbe ptx 3501 Apr 29 09:36 README -rw-r--r-- 1 jbe ptx 2324 Apr 29 09:36 README.devel -rwxr-xr-x 1 jbe ptx 28 Apr 29 09:36 autogen.sh* drwxr-xr-x 2 jbe ptx 4096 Apr 29 09:36 bin/ drwxr-xr-x 16 jbe ptx 4096 Apr 29 09:36 config/ -rwxr-xr-x 1 jbe ptx 214583 Apr 29 15:55 configure* -rw-r--r-- 1 jbe ptx 12570 Apr 29 09:36 configure.ac drwxr-xr-x 4 jbe ptx 4096 Apr 29 09:36 doc/ drwxr-xr-x 2 jbe ptx 4096 Jun 21 09:52 man/ drwxr-xr-x 263 jbe ptx 12288 Apr 29 09:36 patches/ drwxr-xr-x 2 jbe ptx 4096 Apr 29 09:36 platforms/ drwxr-xr-x 4 jbe ptx 4096 Apr 29 09:36 plugins/ drwxr-xr-x 11 jbe ptx 4096 Apr 29 09:36 projectroot/ drwxr-xr-x 6 jbe ptx 69632 Apr 29 09:36 rules/ drwxr-xr-x 9 jbe ptx 4096 Apr 29 09:36 scripts/ drwxr-xr-x 2 jbe ptx 4096 Apr 29 09:36 tests/
Before PTXdist can be installed it has to check if all necessary
programs are installed on the development host (e.g. external dependencies).
configure script will stop if it discovers that something is missing.
The PTXdist installation is based on GNU autotools, so the first thing to be done now is to configure the package:
This will check your system for required components PTXdist relies on. If all required components are found, the output ends with:
[...] checking whether Python development files are present... yes checking for patch... /usr/bin/patch checking whether /usr/bin/patch will work... yes configure: creating ./config.status config.status: creating Makefile ptxdist version 2023.03.0 configured. Using '/usr/local' for installation prefix. Report bugs to email@example.com
Without further arguments, PTXdist is configured to be installed into
/usr/local, which is the standard location for user installed
programs. To change the installation path to anything non-standard, we
--prefix argument to the
configure script. The
--help option offers more information about what else can be changed
for the installation process.
The installation paths are configured in a way that several PTXdist versions can be installed in parallel. So if an old version of PTXdist is already installed, there is no need to remove it.
One of the most important tasks for the
configure script is to find
out whether all the programs PTXdist depends on are already present on the
development host. The script will stop with an error message in case
something is missing. If this happens, the missing tools have to be
installed from the distribution before re-running the
configure script is finished successfully, we can now run
All program parts are being compiled, and if there are no errors, we can
now install PTXdist into it’s final location. In order to write to
/usr/local, this step has to be performed as user root:
$ sudo make install [enter password] [...]
If we don’t have root access to the machine, it is also possible to
install PTXdist into some different directory with the
We need to take care that the
bin/ directory below the new
installation dir is added to our
$PATH environment variable (for
example by exporting it in
The installation is now done, so the temporary folder may now be removed:
$ cd ../../ $ rm -fr local
When using PTXdist for the first time, some setup properties have to be configured. Two settings are the most important ones: where to store the source archives and whether a proxy must be used to gain access to the world wide web.
Run PTXdist’s setup:
$ ptxdist setup
Due to the fact that PTXdist is working with sources only, it needs various source archives from the world wide web. If these archives are not present on our host, PTXdist will download them on demand.
To do so, internet access is required. If this access is managed by a
proxy, PTXdist can be configured to use it: navigate to
entry Proxies and enter the required addresses and ports to access the
proxy in the form:
Source Archive Location¶
Whenever PTXdist downloads source archives, it stores these archives locally in the project folder. This is the default behaviour. If we are working with more than one PTXdist based project, every project would download its own required archives in this case. To share all source archives between all projects, PTXdist can be configured to share only one archive directory for all projects it handles: navigate to menu entry Source Directory and enter the path to the directory where PTXdist should store archives to share between its projects.
Before we can start building our first userland, we need a cross
toolchain. On Linux, toolchains are no monolithic beasts. Most parts of
what we need to cross compile code for the embedded target comes from
the GNU Compiler Collection,
gcc. The gcc package includes the
gcc, plus several backend tools (
etc.) which actually perform the different stages of the compile
gcc does not contain the assembler, so we also need the
GNU Binutils package which provides lowlevel stuff.
Cross compilers and tools are usually named like the corresponding host
tool, but with a prefix – the GNU target. For example, the cross
compilers for ARM and powerpc may look like
With these compiler frontends we can convert e.g. a C program into binary code for specific machines. So for example if a C program is to be compiled natively, it works like this:
$ gcc test.c -o test
To build the same binary for the ARM architecture we have to use the cross compiler instead of the native one:
$ arm-softfloat-linux-gnu-gcc test.c -o test
Also part of what we consider to be the “toolchain” is the run-time library (libc, dynamic linker). All programs running on the embedded system are linked against the libc, which also offers the interface from user space functions to the kernel.
The compiler and libc are very tightly coupled components: the second stage compiler, which is used to build normal user space code, is being built against the libc itself. For example, if the target does not contain a hardware floating point unit, but the toolchain generates floating point code, it will fail. This is also the case when the toolchain builds code for i686 CPUs, but the target is i586.
So in order to make things working consistently it is necessary that the run-time libc is identical with the libc that the compiler was built against.
PTXdist doesn’t contain a pre-built binary toolchain. Remember that it’s not a distribution, but a development tool. But it can be used to build a toolchain for our target. Building the toolchain usually has only to be done once. It may be a good idea to do that over night, because it may take several hours, depending on the target architecture and development host power.
Using Existing Toolchains from Different Vendors¶
If a toolchain from a different vendor than OSELAS is already installed and is known to be working, building the toolchain with PTXdist may be omitted.
The OSELAS.BSP() packages shipped for PTXdist have been tested with the OSELAS.Toolchains() built with the same PTXdist version. So if an external toolchain is being used which isn’t known to be stable, a target may fail. Note that not all compiler versions and combinations work properly in a cross environment.
Every OSELAS.BSP() checks for the OSELAS.Toolchain() it was tested against, so using a toolchain from a different vendor than OSELAS requires an additional step:
Open the OSELAS.BSP() menu with:
$ ptxdist platformconfig
and navigate to architecture → toolchain → check for specific toolchain vendor. Clear this entry to disable the toolchain vendor check.
Toolchains from a different vendor must meet some preconditions:
- it must be built with the configure option
--with-sysrootpointing to its own C libraries.
- it should not support the multilib feature as this may confuse PTXdist as to which libraries are to be copied to the root filesystem
If we want to check whether our toolchain was built with the
--with-sysroot option, we just run this simple command:
$ mytoolchain-gcc -v 2>&1 | grep with-sysroot
If this command does not output anything, this toolchain was not
built with the
--with-sysroot option and cannot be used with
Using a Pre-Built Toolchain¶
Pengutronix also provides ready-to-use binary toolchains. These toolchains are built from the OSELAS.Toolchain() bundle, so they comply with all of Pengutronix’s board support packages and we can use them instead of building our own.
The binary OSELAS toolchains are provided as Debian Distribution Packages, but the contents of those packages are usable on non-Debian distributions as well.
In order to install the OSELAS binary toolchains on a Debian based system the following steps are required:
Add the Pengutronix Debian Archive¶
To make the package repository known to the package manager, apt, we create a
new file named
pengutronix.list in the directory
(The basename of this file isn’t important, but the extension
The contents of this new file describe the Pengutronix server as an available package source. It is defined via one text line:
deb https://debian.pengutronix.de/debian/ sid main contrib non-free
Replace “sid” with the correct release name.
If the directory
/etc/apt/sources.list.d/ does not exist, the
text line mentioned above must be added to the file
The package manager must now update its packages list with the following command:
$ apt-get update
To avoid warnings about untrusted package sources we can install the Pengutronix archive keyring with the following command:
$ apt-get install pengutronix-archive-keyring
Install the Binary OSELAS Toolchain¶
Now everything is in place to install the binary OSELAS toolchain for the board support package:
$ apt-get install oselas.toolchain-2019.09.1-arm-v5te-linux-gnueabi-<ptxdistCompilerVersion>
These package names are very long and hard to type without making typos. An easier way is to ask the package manager for available toolchains and just copy and paste the name.
$ apt-cache search "oselas.toolchain-.*-arm.*v5te.*" oselas.toolchain-2019.09.1-arm-v5te-linux-gnueabi-<ptxdistCompilerVersion>
The Binary OSELAS Toolchain Package for non-Debian Distributions¶
You can also use the Debian packages for non-Debian Linux distributions.
The Debian packages can be found on our server at http://debian.pengutronix.de/debian/pool/main/o/oselas.toolchain
Here you can download the package named
Package filenames for 32-bit host machines end with
for 64-bit host machines the filenames end with
You can simply unpack the Debian packages with
$ ar x oselas.toolchain-2019.09.1-arm-v5te-linux-gnueabi-gcc-9.2.1-glibc-2.30-binutils-2.32-kernel-5.0-sanitized_2019.09.1_*.deb
This will create the files
data.tar.xz. Ignore the first two, and unpack
data.tar.xz into your
root file system:
$ sudo tar xf data.tar.xz -C /
The toolchain can now be found in
Building a Toolchain¶
If there is no different toolchain available yet, the next step is to build one at least for the desired target architecture.
PTXdist handles toolchain building as a simple project, like all other projects, too. So we can download the OSELAS.Toolchain() bundle and build the required toolchain for the OSELAS.BSP() project.
Building any toolchain of the OSELAS.Toolchain-2019.09.1 family is tested with PTXdist-2019.09.0. Pengutronix recommends to use this specific PTXdist to build the toolchain. So, it might be essential to install more than one PTXdist revision to build the toolchain and later on the Board Support Package if the latter one is made for a different PTXdist revision.
A PTXdist project generally allows building into some project defined directory; all OSELAS.Toolchain() projects that come with PTXdist are configured to use the standard installation paths mentioned below, and install their result into /opt/OSELAS.Toolchain-2019.09.1/.
/opt directory is not world writeable. So in order to
build our OSELAS.Toolchain() into that directory we need to use a root
account to change the permissions. PTXdist detects this case and asks
if we want to run
sudo to do the job for us. Alternatively we can
$ mkdir /opt/OSELAS.Toolchain-2019.09.1 $ chown <username> /opt/OSELAS.Toolchain-2019.09.1 $ chmod a+rwx /opt/OSELAS.Toolchain-2019.09.1
We recommend to keep this installation path as PTXdist expects the
/opt. Whenever we go to select a platform in a
project, PTXdist tries to find the right toolchain from data read from
the platform configuration settings and a toolchain at
matches to these settings. But that’s for our convenience only. If we
decide to install the toolchains at a different location, we can still
use the toolchain parameter to define the toolchain to be used on a
per project base.
Building the OSELAS.Toolchain for OSELAS.BSP-Pengutronix-Example¶
Do the following steps in your own home directory (
$HOME). The final
OSELAS.Toolchain gets installed to
opt/, but must never be
compiled in the
opt/ directory. You will get many funny error
messages if you try to compile the OSELAS-Toolchain in
To compile and install an OSELAS.Toolchain we have to extract the OSELAS.Toolchain archive, change into the new folder, configure the compiler in question and start the build.
The required compiler to build the board support package is
Please ensure the ’current directory’ (the
. entry) is not part of
your PATH environment variable. PTXdist tries to sort out this entry,
but might not be successful in doing so. Check by running
ptxdist print PATH if the output still contains any kind of ’current
directory’ as a component. If yes, remove it first.
So the steps to build this toolchain are:
$ tar xf OSELAS.Toolchain-2019.09.1.tar.bz2 $ cd OSELAS.Toolchain-2019.09.1 $ ptxdist-2019.09.0 select ptxconfigs/arm-v5te-linux-gnueabi_gcc-9.2.1_glibc-2.30_binutils-2.32_kernel-5.0-sanitized.ptxconfig $ ptxdist-2019.09.0 go
At this stage we have to go to our boss and tell him that it’s probably time to go home for the day. Even on reasonably fast machines the time to build an OSELAS.Toolchain is something like around 30 minutes up to a few hours.
Measured times on different machines:
|Single Pentium 2.5 GHz, 2 GiB RAM||about 2 hours|
|Turion ML-34, 2 GiB RAM||about 1 hour 30 minutes|
|Dual Athlon 2.1 GHz, 2 GiB RAM||about 1 hour 20 minutes|
|Dual Quad-Core-Pentium 1.8 GHz, 8 GiB RAM||about 25 minutes|
|24 Xeon cores 2.54 GHz, 96 GiB RAM||about 22 minutes|
Another possibility is to read the next chapters of this manual, to find out how to start a new project.
When the OSELAS.Toolchain() project build is finished, PTXdist is ready for prime time and we can continue with our first project.
Protecting the Toolchain¶
This step is only relevant for older toolchain version including OSELAS.Toolchain-2018.12.0. For later versions, see the next section.
All toolchain components are built with regular user permissions. In order to avoid accidental changes in the toolchain, the files should be set to read-only permissions after the installation has finished successfully. It is also possible to set the file ownership to root. This is an important step for reliability, so it is highly recommended.
Installing the Toolchain¶
Starting with OSELAS.Toolchain-2019.09.0, the toolchain is not directly installed during the build process. Instead additional steps are needed. There are two possibilities:
$ ptxdist-2019.09.0 images
This creates a tarball in dir
dist/ subdirectory. It contains the
toolchain with the full path, excluding the
/opt prefix, so it should
be extracted there.
This is a convenient way to build the toolchain once and install it on multiple hosts. The host applications and libraries in the tarball are stripped to reduce the used disk space. So it cannot be used to debug the toolchain itself (e.g. when an ICE (internal compiler error) occurs). The target libraries (e.g. glibc) are not touched so debugging target applications works as usual.
$ ptxdist-2019.09.0 make install
This will install the toolchain to
/opt. The toolchain is not stripped,
so it will require quite a bit more disk space compared to the tarball.
DESTDIR=/some/path to the command-line, an additional
installation prefix can be added.
If additional privileges are needed to write to the installation path, then
sudo is automatically invoked and the toolchain files will be owned by
Building additional Toolchains¶
The OSELAS.Toolchain- bundle comes with various predefined toolchains.
ptxconfigs/ folder for other definitions. To build
additional toolchains we only have to clean our current toolchain
project, remove the current
selected_ptxconfig link and create a
$ ptxdist clean $ rm selected_ptxconfig $ ptxdist select ptxconfigs/any_other_toolchain_def.ptxconfig $ ptxdist go
This is then followed of course by any additional steps needed to protect or install the toolchain depending on the version.
All toolchains will be installed side by side into architecture dependent directories named
Different toolchains for the same architecture will be installed side by side into version dependent directories named