2.5. Build a Board Support Package (BSP)¶
You installed the tool suite in your installation prefix, made ready the source
for two RTEMS source packages and if you are using a Git clone bootstrapped the
RTEMS sources in the previous sections. We installed the tool suite in
$HOME/quick-start/rtems/6
and unpacked the source in
$HOME/quick-start/src
.
You are now able to build Board Support Packages (BSPs) for all
architectures you have an installed RTEMS tool suite. To build applications on
top of RTEMS, you have to build and install a BSP for your target hardware. To
select a proper BSP for your target hardware consult the BSPs
chapter. We select the erc32 BSP. The erc32
BSP uses approximately 2.3G
bytes of disk space when the testsuite is built and 44M bytes of space when
installed.
We will first show how to build the BSP using the RSB and then we will show how to build the same BSP manually. You only need to use one of the listed methods to build the BSP.
In the output in this section the base directory $HOME/quick-start
was
replaced by $BASE
.
2.5.1. RSB BSP Build¶
The RSB build of RTEMS does not use the RTEMS source we made ready. It uses the RSB source you downloaded in a previous section. If you are using a release RSB source archive the BSP built is the released kernel image. If you are using a Git clone of the RSB the BSP will be version referenced in the RSB clone.
To build the BSP with all the tests run this command:
cd $HOME/quick-start/src/rsb/rtems
../source-builder/sb-set-builder --prefix=$HOME/quick-start/rtems/6 \
--target=sparc-rtems6 --with-rtems-bsp=sparc/erc32 --with-rtems-tests=yes 6/rtems-kernel
This command should output something like:
RTEMS Source Builder - Set Builder, @rtems-ver-majminver@
Build Set: 6/rtems-kernel
config: tools/rtems-kernel-6.cfg
package: sparc-rtems6-kernel-erc32-1
building: sparc-rtems6-kernel-erc32-1
sizes: sparc-rtems6-kernel-erc32-1: 2.279GB (installed: 44.612MB)
cleaning: sparc-rtems6-kernel-erc32-1
reporting: tools/rtems-kernel-6.cfg -> sparc-rtems6-kernel-erc32-1.txt
reporting: tools/rtems-kernel-6.cfg -> sparc-rtems6-kernel-erc32-1.xml
installing: sparc-rtems6-kernel-erc32-1 -> $BASE/
cleaning: sparc-rtems6-kernel-erc32-1
Build Set: Time 0:03:09.896961
The RSB BSP build can be customised with following RSB command line options:
--with-rtems-tests
:Build the test suite. If
yes
is provided all tests in the testsuite are build. Ifno
is provided no tests are built and ifsamples
is provided only the sample executables are built, e.g.--with-rtems-tests=yes
. The test executables are install under the BSP in thetests
directory and you can execute them with the tester and run command.--with-rtems-smp
:Build with SMP support. The BSP has to have SMP support or this option will fail with an error.
--with-rtems-legacy-network
:Build the legacy network software. We recommend you use the current network support in the RTEMS BSP Library (libbsd) unless you need to maintain a legacy product. Do not use the legacy networking software for new developments.
--with-rtems-bspopts
:Build the BSP with BSP specific options. This is an advanced option. Please refer to the BSP specific details in the Board Support Packages (BSPs) of this manual or the BSP source code in the RTEMS source directory. To supply a list of options quote then list with
"
, e.g.--with-rtems-bspopts="BSP_POWER_DOWN_AT_FATAL_HALT=1"
If you have built a BSP with the RSB, you can move on to Test a Board Support Package (BSP).
2.5.2. Manual BSP Build¶
We manually build the BSP in four steps. The first step is to set your path.
Prepend the RTEMS tool suite binary directory to your $PATH
throughout the
remaining steps. Run the command:
export PATH=$HOME/quick-start/rtems/6/bin:"$PATH"
Check your installed tools can be found by running:
command -v sparc-rtems6-gcc && echo "found" || echo "not found"
The output should be:
found
If not found
is printed the tools are not correctly installed or the path
has not been correctly set. Check the contents of the path
$HOME/quick-start/rtems/6/bin
manually and if
sparc-rtems6-gcc
is present the path is wrong. If the
file cannot be found return to Install the Tool Suite and install the tools
again.
The second step is to configure the BSP. There are various BSP build
configuration options available. Some options are BSP-specific. Each section
in the INI-style configuration file config.ini
instructs the build system to
build a particular BSP variant (sparc/erc32 in our case). We enable the build
of the tests with the BUILD_TESTS = True
option and use default values for
everything else. For detailed information about the BSP build system, see
BSP Build System.
cd $HOME/quick-start/src/rtems
echo "[sparc/erc32]" > config.ini
echo "BUILD_TESTS = True" >> config.ini
./waf configure --prefix=$HOME/quick-start/rtems/6
The first invocation of ./waf
needs a bit of time (e.g. 10 seconds) since an
internal cache file is populated. This command should output something like
this. In this output the base directory $HOME/quick-start
was replaced
by $BASE
.
Setting top to : $BASE/quick-start/src/rtems
Setting out to : $BASE/quick-start/src/rtems/build
Configure board support package (BSP) : sparc/erc32
Checking for program 'sparc-rtems6-gcc' : $BASE/quick-start/rtems/6/bin/sparc-rtems6-gcc
Checking for program 'sparc-rtems6-g++' : $BASE/quick-start/rtems/6/bin/sparc-rtems6-g++
Checking for program 'sparc-rtems6-ar' : $BASE/quick-start/rtems/6/bin/sparc-rtems6-ar
Checking for program 'sparc-rtems6-ld' : $BASE/quick-start/rtems/6/bin/sparc-rtems6-ld
Checking for program 'ar' : $BASE/quick-start/rtems/6/bin/sparc-rtems6-ar
Checking for program 'g++, c++' : $BASE/quick-start/rtems/6/bin/sparc-rtems6-g++
Checking for program 'ar' : $BASE/quick-start/rtems/6/bin/sparc-rtems6-ar
Checking for program 'gas, gcc' : $BASE/quick-start/rtems/6/bin/sparc-rtems6-gcc
Checking for program 'ar' : $BASE/quick-start/rtems/6/bin/sparc-rtems6-ar
Checking for program 'gcc, cc' : $BASE/quick-start/rtems/6/bin/sparc-rtems6-gcc
Checking for program 'ar' : $BASE/quick-start/rtems/6/bin/sparc-rtems6-ar
Checking for asm flags '-MMD' : yes
Checking for c flags '-MMD' : yes
Checking for cxx flags '-MMD' : yes
Checking for program 'rtems-bin2c' : $BASE/quick-start/rtems/6/bin/rtems-bin2c
Checking for program 'gzip' : /usr/bin/gzip
Checking for program 'rtems-ld' : $BASE/quick-start/rtems/6/bin/rtems-ld
Checking for program 'rtems-syms' : $BASE/quick-start/rtems/6/bin/rtems-syms
Checking for program 'xz' : $BASE/anaconda3/bin/xz
'configure' finished successfully (0.414s)
Building the BSP is the third step.
cd $HOME/quick-start/src/rtems
./waf
This command should output something like this (omitted lines are denoted by …).
Waf: Entering directory `$BASE/quick-start/src/rtems/build'
Waf: Leaving directory `$BASE/quick-start/src/rtems/build'
'build' finished successfully (0.085s)
Waf: Entering directory `$BASE/quick-start/src/rtems/build/sparc/erc32'
[ 1/4093] Compiling bsps/shared/dev/serial/mc68681_reg2.c
[ 2/4093] Compiling bsps/shared/dev/rtc/mc146818a_ioreg.c
[ 3/4093] Compiling bsps/shared/dev/flash/am29lv160.c
...
[4093/4093] Processing link: build/sparc/erc32/testsuites/libtests/dl01/dl01-tar.o build/sparc/erc32/testsuites/libtests/dl01/init.o build/sparc/erc32/testsuites/libtests/dl01/dl-load.o build/sparc/erc32/testsuites/libtests/dl01/dl01-sym.o -> build/sparc/erc32/testsuites/libtests/dl01.exe
Waf: Leaving directory `$BASE/quick-start/src/rtems/build/sparc/erc32'
'build_sparc/erc32' finished successfully (2m14.111s)
The last step is to install the BSP.
cd $HOME/quick-start/src/rtems
./waf install
This command should output something like this (omitted lines are denoted by
…). In this output the base directory $HOME/quick-start
was replaced
by $BASE
.
Waf: Entering directory `$BASE/quick-start/src/rtems/build'
Waf: Leaving directory `$BASE/quick-start/src/rtems/build'
'install' finished successfully (0.081s)
Waf: Entering directory `$BASE/quick-start/src/rtems/build/sparc/erc32'
+ install $BASE/quick-start/rtems/6/sparc-rtems6/erc32/lib/include/libchip/am29lv16.h (from bsps/include/libchip/am29lv1.h)
+ install $BASE/quick-start/rtems/6/sparc-rtems6/erc32/lib/include/libchip/mc146818a.h (from bsps/include/libchip/mc146818a.h)
+ install $BASE/quick-start/rtems/6/sparc-rtems6/erc32/lib/include/libchip/mc68681.h (from bsps/include/libchip/mc68681.h))
...
+ install $BASE/quick-start/rtems/6/sparc-rtems6/erc32/lib/include/rtems/score/watchdogticks.h (from cpukit/include/rtems/score/watchdogticks.h)
+ install $BASE/quick-start/rtems/6/sparc-rtems6/erc32/lib/include/rtems/score/wkspace.h (from cpukit/include/rtems/score/wkspace.h)
+ install $BASE/quick-start/rtems/6/sparc-rtems6/erc32/lib/include/rtems/score/wkspacedata.h (from cpukit/include/rtems/score/wkspacedata.h)
Waf: Leaving directory `$BASE/quick-start/src/rtems/build/sparc/erc32'
'install_sparc/erc32' finished successfully (1.834s))