This version (22 Sep 2023 11:49) was approved by Darius B.The Previously approved version (07 Sep 2023 13:45) is available.

No-OS Build Guide

NOTE: This build guide is valid for the projects found in the no-OS/projects folder. If your project resides elsewhere under the no-OS repository tree, it is a legacy project. A build guide for legacy projects can be found Build no-OS with GNU make.

Clone NO-OS with the --recursive flag:

git clone --recursive https://github.com/analogdevicesinc/no-OS

If however you've already cloned NO-OS without the --recursive flag, you may initialize all the submodules in an existing NO-OS clone with:

git submodule update --recursive --init

Build Prerequisites

Prior to building a no-OS project, it is required to set up some environment variables so that the build process may find the necessary tools (compiler, linker, SDK etc.).

Use the following commands to prepare your environment for building no-OS projects:

Linux (Click to expand)

Intel (Click to expand)

Assuming the SDK is installed at this path:

/path/to/intel
└── intelFPGA
    └── 18.1

Run:

$ source no-OS/tools/scripts/platform/intel/environment.sh /path/to/intel/intelFPGA 18.1

Xilinx (Click to expand)

Assuming the Vitis 2022.2 is installed at this path:

/path/to/xilinx
├── DocNav
├── Downloads
└── Vitis
    └── 2022.2

Run:

$ source /path/to/xilinx/Vitis/2022.2/settings64.sh

STM32 (Click to expand)

Install stm32cubeide to default location /opt/stm32cubeide. If you'd rather install it at a different location, run export STM32CUBEIDE=/path/to/your/stm32cubeide in the terminal used for building.
Install stm32cubemx to default location /opt/stm32cubemx. If you'd rather install it at a different location, run export STM32CUBEMX=/path/to/your/stm32cubemx in the terminal used for building.
Install java (openjdk-11), sed and head (if not already present, they normally are).

Maxim (Click to expand)

Install the Maxim Micros SDK.
Set the MAXIM_LIBRARIES environment variable to the MaximSDK/Libraries path (the default should be ~/MaximSDK/Libraries).
For visual debugging and building, install Visual Studio Code, and the Cortex-Debug extension.

Mbed (Click to expand)

Install Mbed CLI 1 as per guide here: https://os.mbed.com/docs/mbed-os/v6.15/build-tools/install-and-set-up.html .Usually the following steps should be sufficient: sudo apt install python3 python3-pip git mercurial and sudo python3 -m pip install mbed-cli pyelftools.
Configure the compiler location with Mbed CLI. This can be carried out by running the “mbed config -G GCC_ARM_PATH “path-to-your-gcc-compiler”” in Command Prompt.

Pico (Click to expand)

Clone the Raspberry Pico SDK.
Set the PICO_SDK_PATH environment variable to the pico-sdk cloned repository path.
Install the J-Link software
Set the JLINK_SERVER_PATH environment variable to the JLinkGDBServerCLExe path (the default path should be /opt/SEGGER/JLink/JLinkGDBServerCLExe).
For visual debugging and building, install Visual Studio Code, and the Cortex-Debug extension.

ADuCM3029 (Click to expand)

Install the CrossCore Embedded Studio 2.10 (refer to cces_setup_guide)
Manually Install ADuCM302x Device Family Pack (DFP3.2.0+) (refer to how_to_install_or_upgrade_packs_for_cces)
Manually Install ARM.CMSIS pack (5.7.0+) (refer to how_to_install_or_upgrade_packs_for_cces)

Please install all the necessary packs locally and then manually import them in CrossCore

Common Issues with environment setup:

Makefiles searches for the CCES_HOME in its default installation directory. It may happen that multiple version are installed and may not work. To select a CCES_HOME run export CCES_HOME=/opt/analog/cces/2.10.0

Windows (Click to expand)

Use Git Bash to run these commands.

Run the tools/scripts/git-bash.sh script to install make in the Git Bash environment.

Xilinx (Click to expand)

Assuming the Vitis 2022.2 is installed at this path:

C:\Xilinx
├── DocNav
├── Downloads
└── Vitis
    └── 2022.2

Run:

$ export PATH=/c/Xilinx/Vitis/2022.2/bin:/c/Xilinx/Vitis/2022.2/gnu/aarch32/nt/gcc-arm-none-eabi/bin/:$PATH

Maxim (Click to expand)

Install the Maxim Micros SDK to a path without whitespaces like C:\MaximSDK.
Set the MAXIM_LIBRARIES environment variable by running: export MAXIM_LIBRARIES=/c/MaximSDK/Libraries.
(Optional) For visual debugging and building, install Visual Studio Code, and the Cortex-Debug extension.

ADuCM3029 (Click to expand)

Install the CrossCore Embedded Studio (refer to cces_setup_guide) to a path without whitespaces such as C:\ADI\cces2.11.1.
Manually Install ADuCM302x Device Family Pack (DFP3.2.0+) (refer to how_to_install_or_upgrade_packs_for_cces)
Manually Install ARM.CMSIS pack (5.7.0+) (refer to how_to_install_or_upgrade_packs_for_cces)
Set the CCES_HOME environment variable to point to the CrossCore Embedded Studio installation directory: export CCES_HOME=/c/ADI/cces2.11.1.

Building a project

Go in the project directory that should be built.

Linux (Click to expand)

$ cd no-OS/projects/project_name/
$ tree
.
├── builds.json
├── Makefile
├── src
└── src.mk

Intel (Click to expand)

Copy the .sof and .sopcinfo to the project folder.

$ ls
Makefile  profiles  src  src.mk  system_bd.sopcinfo  adrv9009_a10gx.sof	
$ make

# Alternatively you may select a .sopcinfo file explicitly by:
$ make HARDWARE=path/to/system_bd.sopcinfo

Xilinx (Click to expand)

Copy the .xsa in the project folder.

$ ls
Makefile  profiles  src  src.mk system_top.xsa
$ make

# Alternatively you may select an .xsa file explicitly by:
$ make HARDWARE=path/to/file.xsa

Maxim (Click to expand)

To build a project, type:

make PLATFORM=maxim TARGET=...

The TARGET specifies the chip for which the project is built. If it is missing, max32660 will be used. At the moment, the available targets are: max32650, max32655, max32660, max32665, max32670, max32690 and max78000.

Mbed (Click to expand)

To build a project, type:

make PLATFORM=mbed

Pico (Click to expand)

To build a project, type:

make PLATFORM=pico

STM32 (Click to expand)

Make sure you have the .ioc file in the project directory, then type:

$ make

ADuCM3029 (Click to expand)

The ADuCM3029 projects also contain a pinmux_config.c file which contains pin configuration instructions.

# build an ADuCM3029-only project
$ make

# if the platform autodetection picks the wrong platform, explicitly specify the PLATFORM
$ make PLATFORM=aducm3029

Windows (Click to expand)

Use Git Bash to run these commands.

$ cd no-OS/projects/project_name

It should contain make-related files and source files:

./no-OS/projects/project_name
├── builds.json
├── Makefile
├── src
└── src.mk

Xilinx (Click to expand)

Copy the .xsa to the project folder and run:

./no-OS/projects/adrv9009
├── Makefile
├── profiles
├── src
├── src.mk
└── system_top.xsa

$ make

Maxim (Click to expand)

To build a project, type:

$ make PLATFORM=maxim TARGET=...

The TARGET specifies the chip for which the project is built. If it is missing, max32660 will be used. At the moment, the available targets are: max32650, max32655, max32660, max32665, max32670, max32690 and max78000.

ADuCM3029 (Click to expand)

$ export PLATFORM=aducm3029
$ make

The build process creates a build directory in the project folder:

build
├── app
├── bsp
├── obj
├── project_name.elf
└── tmp

Running/Debugging

Once the .elf, .hex or .bin file has been generated, make sure the board is powered on, JTAG cable connected and use the following commands to upload the program to the board or debug.

Uploading the binary to target is generically achieved with:

$ make run

Use the following command to launch the SDK associated to the used platform in order to be able to debug graphically by clicking the debug button:

$ make sdkopen

Fore more details about the available make rules, check out this page.

Running/Debugging in WSL

If you use WSL you can not test the boards on Linux because it does not support USB. If you will try to load the binary into the target with the command make run, you will encounter the following error:

no targets found with “name =~ “APU*” && jtag_cable_name =~ “*$::jtagtarget*””. available targets: none while executing “error “no targets found with \”$params(filter)\”. available targets:$target_list“”…

If you use WSL (Ubuntu) and want to connect to JTAG with a board, you have to switch the USB device from Windows to WSL. To do this, the following steps must be followed:

It is recommended to have a version of Windows 10 or 11.
You must have all updates installed in WSL.

To be able to see the kernel version, the WSL version, and other features, in WSL (Ubuntu) you can enter the command:

:~$ uname -a
Linux 5.15.90.1-microsoft-standard-WSL2 #1 SMP Fri Jan 27 02:56:13 UTC 2023 x86_64 x86_64 x86_64 GNU/Linux

WSL should have a kernel version of 5.10.60.1 or later. You also need to run WSL2.Testing was done on version 22.4 of Ubuntu.

You need to install the usbipd-win project. Installation can be done manually, with a few clicks.
You need to install from WSL, the user space tools for USB/IP and a database of USB hardware identifiers:

:~$ sudo apt upgrade
:~$ sudo apt update
:~$ sudo apt install linux-tools-virtual hwdata
:~$ sudo update-alternatives --install /usr/local/bin/usbip usbip $(command -v ls /usr/lib/linux-tools/*/usbip | tail -n1) 20

If the last command does not work, try:

:~$ sudo update-alternatives --install /usr/local/bin/usbip usbip `ls /usr/lib/linux-tools/*/usbip | tail -n1` 20

If there is a device connected to the USB port, it can be checked from the Device Manager. When connecting via JTAG, in Device Manager, the device will appear in the Universal serial Bus controllers section as USB Serial Converter.

To attach the JTAG (or any USB device) from Windows to WSL we must do the following:

Open Command Prompt in Administrator mode and enter the command:

C:\Windows\system32> usbipd wsl list
BUSID  VID:PID    DEVICE                                                        STATE
2-6    0c45:6732  Integrated Webcam, Integrated IR Webcam                       Not attached
2-9    27c6:63ac  Goodix MOC Fingerprint                                        Not attached
2-10   8087:0033  Intel(R) Wireless Bluetooth(R)                                Not attached
5-4    0bda:8153  Realtek USB GbE Family Controller #2                          Not attached
7-1    413c:4503  USB Input Device                                              Not attached
7-2    413c:b080  Dell DA20 Adapter                                             Not attached
9-5    413c:b06e  USB Input Device                                              Not attached
10-1   0403:6014  USB Serial Converter                                          Not attached
10-2   045e:0837  Microsoft Modern USB Headset, USB Input Device                Not attached
10-3   04b4:0008  USB Serial Device (COM17)                                     Not attached
10-5   413c:b06f  USB Input Device                                              Not attached

For this command, a list of all connected USB devices will be displayed in Windows, a brief description of them and their status: If they are/are not attached to the WSL instance. The JTAG appears in the cmd list but is not attached to a WSL instance.

In WSL enter the following command:

:~$ lsusb
Bus 002 Device 001: ID 1d6b:0003 Linux Foundation 3.0 root hub
Bus 001 Device 001: ID 1d6b:0002 Linux Foundation 2.0 root hub

A list of all attached USB devices will be displayed here. At this moment we will only see roots hubs.

To attach a USB device to WSL enter the following command in Command Prompt:

> usbipd wsl attach -b <BUSID>

BUSID represents the ID for the USB device for which we want to attach it in WSL.

> usbipd wsl attach -b 10-1

C:\Windows\system32> usbipd wsl list
BUSID  VID:PID    DEVICE                                                        STATE
2-6    0c45:6732  Integrated Webcam, Integrated IR Webcam                       Not attached
2-9    27c6:63ac  Goodix MOC Fingerprint                                        Not attached
2-10   8087:0033  Intel(R) Wireless Bluetooth(R)                                Not attached
5-4    0bda:8153  Realtek USB GbE Family Controller #2                          Not attached
7-1    413c:4503  USB Input Device                                              Not attached
7-2    413c:b080  Dell DA20 Adapter                                             Not attached
9-5    413c:b06e  USB Input Device                                              Not attached
10-1   0403:6014  USB Serial Converter                                          Attached - Ubuntu
10-2   045e:0837  Microsoft Modern USB Headset, USB Input Device                Not attached
10-3   04b4:0008  USB Serial Device (COM17)                                     Not attached
10-5   413c:b06f  USB Input Device                                              Not attached

After running usbipd wsl list, it can be seen that the JTAG is now attached in WSL.

In WSL if you run: lsusb we have:

Bus 002 Device 001: ID 1d6b:0003 Linux Foundation 3.0 root hub
Bus 001 Device 005: ID 0403:6014 Future Technology Devices International, Ltd FT232H Single HS USB-UART/FIFO IC
Bus 001 Device 001: ID 1d6b:0002 Linux Foundation 2.0 root hub\

If Device Manager checks the USB device attached in WSL, it will no longer appear in the list of devices.

If you want to return to the initial settings (the USB device must be attached to Windows): The USB device must be disconnected and connected to the computer or in Command Prompt, run the following command:

> usbipd wsl detach -b <BUSID>

For more information you can access the links: USB_devices_to_WSL , USB/IP_client_tools

Wiki

Analog Devices Wiki

Table of Contents

No-OS Build Guide

Build Prerequisites

Building a project

Running/Debugging

Analog Devices Wiki

Table of Contents

No-OS Build Guide

Build Prerequisites

Building a project

Running/Debugging

Page Tools