For Developers - rvt/openace GitHub Wiki

This guide describes how to modify the GA/TAS codebase and create a new UF2 file for flashing onto the device.

For small changes or bug fixes, using the Docker container is often the easiest method. While compilation is slower and the resulting gatas.uf2 file must be manually copied to your Pico, this approach requires only Docker and no other toolchain setup. The Docker build chain is daily tested Github Action of GA/TAS

🚨 Regardless of your build method, you must have the source repository cloned locally.

Getting the Source

Clone the repository and initialize all submodules:

git clone --recurse-submodules https://github.com/rvt/openace

Building with Docker

Step 1: Build the Docker Image

From the src directory:

cd src
docker build -t openace-build-image .

Step 2: Build the Firmware

Still within the src directory:

docker run --rm -e PICO_PLATFORM=rp2040 -e PICO_BOARD=pico_w -v $(pwd):/opt/src openace-build-image

The first build may take a while, but subsequent builds will be significantly faster since Docker caches the build environment and reuses compiled modules. In addition only changed sourcesfiles will be compiled. The resulting uf2 can be found in: src/pico/release_build_docker/gatas.uf2

Setting Up a Native Development Environment (macOS)

⚠️ This setup has not been tested recently. Please report any issues you encounter.

References

SDK Installation

Assume all installations are done in /opt/pico:

cd /opt/pico
git clone -b master --recurse-submodules https://github.com/raspberrypi/pico-sdk.git

Add to your shell profile (e.g., .zshrc or .bash_profile):

export PICO_SDK_PATH="/opt/pico/pico-sdk"

FreeRTOS

cd /opt/pico
git clone -b master --recurse-submodules https://github.com/FreeRTOS/FreeRTOS-Kernel

Add to shell profile:

export FREERTOS_KERNEL_PATH="/opt/pico/FreeRTOS-Kernel"

Toolchain

Do not use Homebrew. Instead:

export PATH="/Applications/ARM/bin:$PATH"
export PICO_TOOLCHAIN_PATH="/Applications/ARM"

The Toolchain is daily tested in github: Github Action of GA/TAS

Visual Studio Code Setup

  1. Install CMake Tools extension.
  2. Open the root folder in VSC by using 'Add Folder To Workspace'
  3. Open the src/pico folder in VSC 'Add Folder To Workspace'
  4. Allow VSC to configure the project.
  5. Choose the GCC for arm-none-eabi kit when asked

Debugging with OpenOCD

I installed it under: /opt/pico/openocd

VSCode Launch Configuration

In .vscode/launch.json:

{
  "name": "Pico Debug",
  "type": "cortex-debug",
  "request": "launch",
  "servertype": "openocd",
  "device": "RP2040",
  "cwd": "${workspaceRoot}",
  "executable": "${command:cmake.launchTargetPath}",
  "gdbPath": "arm-none-eabi-gdb",
  "configFiles": [
    "interface/cmsis-dap.cfg",
    "target/rp2040.cfg"
  ],
  "svdFile": "${env:PICO_SDK_PATH}/src/rp2040/hardware_regs/rp2040.svd",
  "runToEntryPoint": "",
  "showDevDebugOutput": "raw",
  "postRestartCommands": [
    "break main",
    "continue"
  ]
}

If you encounter adapter speed errors, add the following to /opt/pico/openocd/openocd/scripts/target/rp2040.cfg:

adapter speed 12000

Opening the Project in VS Code

  1. Launch a new VS Code window and open the root GA/TAS directory.
  2. Use "Add Folder to Workspace" to include the Pico directory.

Your workspace should now contain the base and Pico folders.

Your screen should look like this: vsc-compile.png

Debugging and Monitoring

To start a debug session:

  • Click the debug icon in the left panel
  • Select Pico Debug configuration
  • Click the green play icon

If everything is set up correctly, GDB and OpenOCD will start, flash your firmware, and begin debugging.

vsc-compile.png To monitor GA/TAS output via serial:

minicom -D /dev/cu.usbmodem14102

vsc-compile.png

Replace the device path as needed.