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.

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.

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.

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

For details please follow the instructions in the 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/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

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

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.

TBD

The ... are fully functional.

The following functions are available:

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

All C++ functions have C equivalents:

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

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);

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

• src

• include

TODO: list the available headeres

TBD

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

TBD

TBD

TBD

• none

TBD

The original content is released under the MIT License, with all rights reserved to Liviu Ionescu.