QEMU implements several Cortex-M boards, which can be used for running tests.
This project provides the initialization code required to build applications running on these boards.
It is intended to be included in unit tests, which generally do not need peripherals.
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.
As a source library xPacks, 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.
A recent xpm, which is a portable Node.js command line application.
For details please follow the instructions in the xPack install page.
Note: the package will be available from npmjs.com at a later date.
For now, it can be installed from GitHub:
cd my-project
xpm init # Unless a package.json is already present
xpm install github:micro-os-plus/devices-qemu-cortexm-xpack
When ready, this package will be available as
@micro-os-plus/devices-qemu-cortexm
from the npmjs.com
registry:
cd my-project
xpm init # Unless a package.json is already present
xpm install @micro-os-plus/devices-qemu-cortexm@latest
ls -l xpacks/micro-os-plus-devices-qemu-cortexm
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-cortexm-xpack.git \
xpacks/micro-os-plus-devices-qemu-cortexm-xpack
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
.
This project can be used as-is for simple tests or blinky projects.
It can also be copied into the user project, the configuration updated, and content regenerated, at any time.
The QEMU Cortex-M support is work in progress.
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.
To integrate this package into user projects, consider the following details:
The following folders should be passed to the compiler during the build:
include
include/cmsis-core
The header files to be included in user project are:
#include <micro-os-plus/device.h>
The source files to be added to user projects are:
src/system_cortexm.c
src/vectors_cortexm.c
MICRO_OS_PLUS_INCLUDE_MICRO_OS_PLUS_DIAG_TRACE
to enable thetrace_printf()
calls inError_Handler()
andassert_failed()
.
-std=c++20
or higher for C++ sources-std=c11
for C sources
Only the standard Cortex-M trap handlers are used.
- none
- none
TBD
- none
TBD
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: rename mem-mps2-*.ld; non-weak Reset_Handler
- v3.x: rename MICRO_OS_PLUS_DEBUG
- v2.x: rename devices-qemu-cortexm
The original content is released under the MIT License, with all rights reserved to Liviu Ionescu.