A source code library with the µOS++ QEMU AArch64 board support files
This project provides the device-qemu-aarch64 source library as an xPack dependency and includes the initialization code required to build applications running on the QEMU AArch64 boards.
It is intended to be included in unit tests, which generally do not need peripherals.
The project is hosted on GitHub as micro-os-plus/devices-qemu-aarch64-xpack.
Maintainer info
This page is addressed to developers who plan to include this source library into their own projects.
For maintainer info, please see the README-MAINTAINER file.
Install
As a source library xPack, the easiest way to add it to a project is via xpm, but it can also be used as any Git project, for example as a submodule.
Prerequisites
A recent xpm, which is a portable Node.js command line application.
It is recommended to update to the latest version with:
npm install --global xpm@latest
For details please follow the instructions in the xPack install page.
xpm
This package is available as
@micro-os-plus/devices-qemu-aarch64
from the npmjs.com
registry:
cd my-project
xpm init # Unless a package.json is already present
xpm install @micro-os-plus/devices-qemu-aarch64@latest
ls -l xpacks/@micro-os-plus/devices-qemu-aarch64
Git submodule
If, for any reason, xpm is not available, the next recommended
solution is to link it as a Git submodule below an xpacks
folder.
cd my-project
git init # Unless already a Git project
mkdir -p xpacks
git submodule add https://github.com/micro-os-plus/devices-qemu-aarch64-xpack.git \
xpacks/@micro-os-plus/devices-qemu-aarch64-xpack
Branches
Apart from the unused master
branch, there are two active branches:
-
xpack
, with the latest stable version (default) -
xpack-develop
, with the current development version
All development is done in the xpack-develop
branch, and contributions via
Pull Requests should be directed to this branch.
When new releases are published, the xpack-develop
branch is merged
into xpack
.
Developer info
Overview
QEMU implements several AArch64 boards, which can be used for running tests.
- https://www.qemu.org/docs/master/system/target-arm.html
- https://www.qemu.org/docs/master/system/arm/virt.html
This project provides the initialization code required to build applications running on these boards.
Status
The devices-qemu-aarch64 source library is fully functional, but minimalistic, for running semihosted tests.
Limitations
The emulated boards provide a limited range of peripherals, but for running unit tests these peripherals are not necessary.
The current initialisation code does not touch them.
Build & integration info
The project is written in C++ and assembly and it is expected to be used in C and C++ projects.
The source code was compiled with aarch64-none-elf-gcc 11 and should be warning free.
To ease the integration of this package into user projects, there are already made CMake and meson configuration files (see below).
For other build systems, consider the following details:
Include folders
The following folders should be passed to the compiler during the build:
include
The header files to be included in user project are:
#include <micro-os-plus/device.h>
Source files
The source files to be added to user projects are:
src/reset-handler.S
src/interrupt-vectors.S
src/exception-handlers.cpp
Preprocessor definitions
- none
Compiler options
-
-std=c++20
or higher for C++ sources -
-std=c11
for C sources
Interrupt handlers
Only the standard AArch64 trap handlers are used.
C++ Namespaces
- none
C++ Classes
- none
Dependencies
- none
CMake
To integrate the devices-qemu-aarch64 source library into a CMake application, add this folder to the build:
add_subdirectory("xpacks/@micro-os-plus/devices-qemu-aarch64")`
The result is an interface library that can be added as an application dependency with:
target_link_libraries(your-target PRIVATE
micro-os-plus::devices-qemu-aarch64
)
meson
To integrate the devices-qemu-aarch64 source library into a meson application, add this folder to the build:
subdir('xpacks/@micro-os-plus/devices-qemu-aarch64')
The result is a dependency object that can be added to an application with:
exe = executable(
your-target,
link_with: [
# Nothing, not static.
],
dependencies: [
micro_os_plus_devices_qemu_aarch64_dependency,
]
)
Examples
TBD
Known problems
- none
Tests
TBD
Change log - incompatible changes
According to semver rules:
Major version X (X.y.z | X > 0) MUST be incremented if any backwards incompatible changes are introduced to the public API.
The incompatible changes, in reverse chronological order, are:
- v4.x: use full name MICRO_OS_PLUS_DEVICE_QEMU_CORTEX_A72 macro
- v3.x: rework as aarch64
- v2.x: interrupt-vectors & exception-handlers moved here; Reset_Handler renamed with capital letters
- v1.x: initial release
License
Unless otherwise stated, the content is released under the terms of the MIT License, with all rights reserved to Liviu Ionescu.