README

A source xPack with µOS++ Cortex-M definitions

Due to the CMSIS design, some Cortex-M architecture definitions are available only via the vendor specific device headers, so they cannot be located in the architecture package.

The project is hosted on GitHub as micro-os-plus/devices-cortexm-xpack.

Maintainer info

This page is addressed to developers who plan to include this package into their own projects.

For maintainer infos, please see the README-MAINTAINER file.

Install

As a source 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.

Prerequisites

A recent xpm, which is a portable Node.js command line application.

For details please follow the instructions in the install page.

xpm

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-cortexm-xpack

When ready, this package will be available as @micro-os-plus/devices-cortexm from the npmjs.com registry:

cd my-project
xpm init # Unless a package.json is already present

xpm install @micro-os-plus/devices-cortexm@latest

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-cortexm-xpack.git \
  xpacks/micro-os-plus/devices-cortexm

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.

User info

TBD

Build & integration info

The project is written in C++, and the tests are expected to be written in C++ too (although there are no major reasons to prevent adding C wrappers).

On embedded platforms, the test applications should be built with Arm semihosting support.

To integrate this package into user projects, consider the following details:

Source folders

src

The source file to be added to user projects is: devices-cortexm.cpp.

Include folders

include

The header file to be included in user project is:

#include <micro-os-plus/devices-cortexm.h>

Preprocessor definitions

none required

Compiler options

-std=c++17 or higher for C++ sources
-std=c11 for C sources

C++ Namespaces

TBD

C++ Classes

TBD

Examples

TBD

Known problems

none

Tests

The project is fully tested via GitHub Actions on each push. The tests run on GNU/Linux, macOS and Windows, are compiled with GCC, clang and arm-none-eabi-gcc and run natively or via QEMU.

@micro-os-plus/devices-cortexm

Usage no npm install needed!