debug.sh

#!/usr/bin/env bash

set -euo pipefail

SPEED=""
PROBE=""
PROFILE="debug"
CONNECT_UNDER_RESET=0
NO_BUILD=0
NO_FLASH=0
MODE=""

extract_serial() {
    local probe="$1"
    if [[ "$probe" == *:*:* ]]; then
        printf '%s\n' "${probe##*:}"
    else
        printf '%s\n' "$probe"
    fi
}

usage() {
    cat <<'EOF'
Usage:
  ./debug.sh server
  ./debug.sh gdb
  ./debug.sh --release server
  ./debug.sh --release gdb
  ./debug.sh --no-build --no-flash server
  ./debug.sh --no-build --no-flash gdb
  ./debug.sh --probe <SERIAL|VID:PID:SERIAL> --speed <kHz> server

Modes:
  server   Build/flash if requested, then start openocd with GDB port 3333
  gdb      Start gdb-multiarch preconfigured for the secure ELF and NS symbols

Notes:
  - Typical workflow is to run './debug.sh server' in one terminal and
    './debug.sh gdb' in another.
  - The GDB mode does not flash the target. Use the server mode first, or flash
    separately with ./flash.sh.
EOF
}

while [[ $# -gt 0 ]]; do
    case "$1" in
        server|gdb)
            if [[ -n "$MODE" ]]; then
                echo "mode already specified: $MODE" >&2
                exit 1
            fi
            MODE="$1"
            shift
            ;;
        --release)
            PROFILE="release"
            shift
            ;;
        --probe)
            PROBE="${2:?missing value for --probe}"
            shift 2
            ;;
        --speed)
            SPEED="${2:?missing value for --speed}"
            shift 2
            ;;
        --connect-under-reset)
            CONNECT_UNDER_RESET=1
            shift
            ;;
        --no-build)
            NO_BUILD=1
            shift
            ;;
        --no-flash)
            NO_FLASH=1
            shift
            ;;
        -h|--help)
            usage
            exit 0
            ;;
        *)
            echo "unknown argument: $1" >&2
            usage >&2
            exit 1
            ;;
    esac
done

if [[ -z "$MODE" ]]; then
    usage >&2
    exit 1
fi

SECURE_ELF="target/thumbv8m.main-none-eabihf/${PROFILE}/secure"
NONSECURE_ELF="target/thumbv8m.main-none-eabihf/${PROFILE}/nonsecure"

if [[ "$MODE" == "server" ]]; then
    if [[ "$NO_BUILD" -eq 0 ]]; then
        if [[ "$PROFILE" == "release" ]]; then
            ./build.sh --release
        else
            ./build.sh
        fi
    fi

    if [[ "$NO_FLASH" -eq 0 ]]; then
        flash_args=()
        if [[ "$PROFILE" == "release" ]]; then
            flash_args+=(--release)
        fi
        if [[ "$NO_BUILD" -eq 1 ]]; then
            flash_args+=(--no-build)
        fi
        if [[ -n "$PROBE" ]]; then
            flash_args+=(--probe "$PROBE")
        fi
        if [[ -n "$SPEED" ]]; then
            flash_args+=(--speed "$SPEED")
        fi
        if [[ "$CONNECT_UNDER_RESET" -eq 1 ]]; then
            flash_args+=(--connect-under-reset)
        fi
        ./flash.sh "${flash_args[@]}"
    fi

    openocd_args=(
        -f interface/stlink.cfg
        -f target/stm32l5x.cfg
        -c "transport select hla_swd"
        -c "tcl_port disabled"
        -c "telnet_port disabled"
    )

    if [[ -n "$PROBE" ]]; then
        openocd_args+=(-c "hla_serial $(extract_serial "$PROBE")")
    fi

    if [[ -n "$SPEED" ]]; then
        openocd_args+=(-c "adapter speed $SPEED")
    fi

    if [[ "$CONNECT_UNDER_RESET" -eq 1 ]]; then
        openocd_args+=(-c "reset_config connect_assert_srst")
    fi

    echo "Starting openocd GDB server on :3333"
    exec openocd \
        "${openocd_args[@]}" \
        -c "init" \
        -c "reset halt"
fi

if ! command -v gdb-multiarch >/dev/null 2>&1; then
    echo "gdb-multiarch not found on PATH" >&2
    exit 1
fi

if [[ ! -f "$SECURE_ELF" ]]; then
    echo "missing secure image: $SECURE_ELF" >&2
    echo "run './build.sh' or './debug.sh server' first" >&2
    exit 1
fi

if [[ ! -f "$NONSECURE_ELF" ]]; then
    echo "missing non-secure image: $NONSECURE_ELF" >&2
    echo "run './build.sh' or './debug.sh server' first" >&2
    exit 1
fi

exec gdb-multiarch \
    "$SECURE_ELF" \
    -ex "target extended-remote :3333" \
    -ex "add-symbol-file $NONSECURE_ELF 0x08040000" \
    -ex "monitor reset halt"