README

A source xPack with the µOS++ semihosting support

This project provides support for semihosting.

Although initially an ARM solution, it is quite portable and can be used on other architectures too.

The project is hosted on GitHub as micro-os-plus/semihosting-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/semihosting-xpack

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

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

xpm install @micro-os-plus/semihosting@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/semihosting-xpack.git \
  xpacks/micro-os-plus-semihosting

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

Status

The ... are fully functional.

C++ API

The following functions are available:

namespace micro_os_plus
{
  namespace semihosting
  {
    int
    call_host (int reason, void* arg);
  }
}

C API

All C++ functions have C equivalents:

  static int
  micro_os_plus_semihosting_call_host (int reason, void* arg);

Implementation

The architecture should provide a definition of the following function:

  static inline __attribute__ ((always_inline)) int
  micro_os_plus_semihosting_call_host (int reason, void* arg);

Build & integration info

To include this package in a project, consider the following details.

Source folders

src

Include folders

include

TODO: list the available headeres

Preprocessor definitions

TBD

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

TBD

@micro-os-plus/semihosting

Usage no npm install needed!