Quick Start Guide#

Software Requirements#

  • CMake (minimum version 3.21)

  • Git (minimum version 2.25)

  • XTC Tools (minimum version 15.2.1)

Setup#

Note

This step is only required with XMOS XTC Tools prior to 15.3, as XCommon CMake was not distributed with XTC Tools.

Before using XCommon CMake, the environment variable XMOS_CMAKE_PATH must be set to the location of the xcommon_cmake directory. For example:

# MacOS and Linux
export XMOS_CMAKE_PATH=/home/user/xcommon_cmake

# Windows
set XMOS_CMAKE_PATH=C:\Users\user\xcommon_cmake

Hello World Example#

This example is a simple “Hello world” application to demonstrate a minimal project using XCommon CMake.

Create the following file structure, with the contents shown below:

app_hello_world/
               |-- CMakeLists.txt
               |-- src/
                      |-- main.c

app_hello_world/CMakeLists.txt

cmake_minimum_required(VERSION 3.21)
include($ENV{XMOS_CMAKE_PATH}/xcommon.cmake)
project(hello_world)

set(APP_HW_TARGET XCORE-AI-EXPLORER)

XMOS_REGISTER_APP()

app_hello_world/src/main.c

#include <stdio.h>

int main() {
    printf("Hello world!\n");
    return 0;
}

Build the executable and run it using the simulator:

cmake -G "Unix Makefiles" -B build
cd build
xmake
cd ..
xsim bin/hello_world.xe

The message “Hello world!” is displayed.

Note

xmake is a build of GNU Make (https://www.gnu.org/software/make/) provided with the XMOS XTC tools for convenience.

Note

xsim provides a near cycle-accurate model of systems built from one of more xcore devices. It is supplied with the XMOS XTC tools.