baremetal-test-example

This project provides a guide on running tests and obtaining code coverage data specifically for embedded systems.

Prerequisites

You need to download an ARM cross toolchain using the following command:

$ wget -O gcc-arm-none-eabi-10.3-2021.10-x86_64-linux.tar.bz2 https://developer.arm.com/-/media/Files/downloads/gnu-rm/10.3-2021.10/gcc-arm-none-eabi-10.3-2021.10-x86_64-linux.tar.bz2?rev=78196d3461ba4c9089a67b5f33edf82a&hash=D484B37FF37D6FC3597EBE2877FB666A41D5253B

Then, you need to create a Docker image using the following command:

$ docker build . -t baremetal-dev

Once the Docker image is created, you can run a new Docker container with the current directory mounted to the /test/ directory inside the container using the following command:

$ docker run --rm -it -v `pwd`:/test -u `id -u`:`id -g` baremetal-dev

How to build and run

You can build and run the baremetal application on QEMU inside the container using the following command:

$ cd /test
$ cmake .
$ make run

Then, you will see the following output on screen:

Hello world!

How to create gcda files

After running the program, you need to copy the lines starting from 'Emitting' and ending with 'Gcov End' on the screen to create a file Then, convert the file to gcda files by the following command:

$ cd external/embedded-gcov/scripts
$ ./gcov_convert.sh <path to file>

How to measure code coverage

You can use well-known code coverage program, such as gcov, lcov, gcovr, etc, to measure the code coverage after generating gcda files.

$ gcovr .

How to exit the QEMU emulator

To exit the QEMU system, press Ctrl + A and then X.

References

You may find more information about baremetal application and testing on QEMU from the following links.

• https://balau82.wordpress.com/2010/02/28/hello-world-for-bare-metal-arm-using-qemu/
• https://technfoblog.wordpress.com/2016/11/05/code-coverage-using-eclipse-gnu-arm-toolchain-and-gcov-for-embedded-systems/
• https://mcuoneclipse.com/2023/11/21/gnu-coverage-gcov-for-an-embedded-target-with-vs-code/
• https://dzone.com/articles/code-coverage-embedded-target
• https://github.com/balau/arm-sandbox
• https://github.com/winksaville/baremetal-hi
• https://github.com/ahcbb6/baremetal-helloqemu

You may find more information about the ARM GNU toolchain from the following link.

• https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads

Licenses

This project source code is available under MIT license. See LICENSE.

Please refer to the individual licenses for more details on the permissions and restrictions imposed by each library.