build.sh

#!/usr/bin/env bash

# Build Marvin firmware
# Usage: ./build.sh [target]
# Examples:
#   ./build.sh              # build all targets
#   ./build.sh beanzee      # build beanzee only
#
# Each target produces two builds:
#   marvin.bin     - combined firmware (Marvin + BBC BASIC)
#   marvin_minimal.bin - minimal firmware (Marvin monitor only)
#
# Requires: z88dk (z88dk-z80asm, z88dk-appmake)

set -e

REPO_DIR="$(cd "$(dirname "$0")" && pwd)"
MARVIN_ASM="$REPO_DIR/asm"
RA8875_DIR="$REPO_DIR/ra8875-z80-repo"
BASIC_SRC="$REPO_DIR/BBCZ80-repo/src"
BBCZ80_DIR="$REPO_DIR/asm/BBCZ80"

CODE_ORG="0x0000"
DATA_ORG="0x8000"
OUTPUT_NAME="marvin"
MINIMAL_NAME="marvin_minimal"

BASIC_MODULES="EXEC EVAL ASMB MATH DATA"

# Returns true if obj does not exist or src is newer
needs_rebuild() {
    local obj=$1 src=$2
    [ ! -f "$obj" ] || [ "$src" -nt "$obj" ]
}

# ---- Per-target module lists ----
# Used by both combined and minimal builds.
# Non-RA8875 module paths are relative to $MARVIN_ASM; drivers use drivers/ prefix.

modules_for_target() {
    INCLUDE_BDFS=""
    case $1 in
        beanzee)
            COMBINED_ENTRY="entry_beanzee"
            MARVIN_MODULES="system console_beanzee drivers/um245r monitor string messages"
            RA8875_MODULES=""
            LCD_MODULES=""
            BASIC_MAIN="MAIN"
            MINIMAL_ENTRY="entry_beanzee_minimal"
            MINIMAL_MODULES="system console_beanzee drivers/um245r monitor string messages"
            MINIMAL_RA8875_MODULES=""
            MINIMAL_LCD_MODULES=""
            ;;
        beanboard)
            COMBINED_ENTRY="entry_beanboard"
            MARVIN_MODULES="system console_beanboard console_select drivers/um245r drivers/hd44780 drivers/keymatrix monitor string messages_beanboard"
            RA8875_MODULES=""
            LCD_MODULES="1"
            BASIC_MAIN="MAIN_SM_DSP"
            MINIMAL_ENTRY="entry_beanboard_minimal"
            MINIMAL_MODULES="system console_beanboard console_select drivers/um245r drivers/hd44780 drivers/keymatrix monitor string messages_beanboard"
            MINIMAL_RA8875_MODULES=""
            MINIMAL_LCD_MODULES="1"
            ;;
        beandeck)
            COMBINED_ENTRY="entry_beandeck"
            # TODO: reconsider how the active SPI channel is specified per target
            MARVIN_MODULES="system console_beandeck console_select drivers/um245r drivers/keymatrix drivers/spi_beanboardspi_revb drivers/ra8875_beanboardspi drivers/w25q bdfs monitor_bdfs string monitor messages"
            RA8875_MODULES="asm/ra8875 asm/console"
            LCD_MODULES=""
            BASIC_MAIN="MAIN"
            MINIMAL_ENTRY="entry_beandeck_minimal"
            MINIMAL_MODULES="system console_beandeck console_select drivers/um245r drivers/keymatrix drivers/spi_beanboardspi_revb drivers/ra8875_beanboardspi drivers/w25q bdfs monitor_bdfs string monitor messages"
            MINIMAL_RA8875_MODULES="asm/ra8875 asm/console"
            MINIMAL_LCD_MODULES=""
            INCLUDE_BDFS=1
            ;;
        beandeck_reva)
            COMBINED_ENTRY="entry_beandeck"
            # TODO: reconsider how the active SPI channel is specified per target
            MARVIN_MODULES="system console_beandeck console_select drivers/um245r drivers/keymatrix drivers/spi_beanboardspi_reva drivers/ra8875_beanboardspi drivers/w25q bdfs monitor_bdfs string monitor messages"
            RA8875_MODULES="asm/ra8875 asm/console"
            LCD_MODULES=""
            BASIC_MAIN="MAIN"
            MINIMAL_ENTRY="entry_beandeck_minimal"
            MINIMAL_MODULES="system console_beandeck console_select drivers/um245r drivers/keymatrix drivers/spi_beanboardspi_reva drivers/ra8875_beanboardspi drivers/w25q bdfs monitor_bdfs string monitor messages"
            MINIMAL_RA8875_MODULES="asm/ra8875 asm/console"
            MINIMAL_LCD_MODULES=""
            INCLUDE_BDFS=1
            ;;
        *)
            echo "Error: unknown target '$1'"
            echo "Valid targets: beanzee, beanboard, beandeck, beandeck_reva"
            exit 1
            ;;
    esac
}

# ---- Build combined firmware (Marvin + BBC BASIC) ----

build_target() {
    local target=$1
    local TARGET_DIR="$REPO_DIR/targets/$target"
    local OUTDIR="$TARGET_DIR/output"

    modules_for_target "$target"

    echo "Building Marvin ($target)"
    echo "==========================="

    mkdir -p "$OUTDIR"
    rm -f "$OUTDIR"/*.lis

    # ---- Boot module ----

    echo ""
    echo "Assembling boot module..."
    echo "  $COMBINED_ENTRY.asm"
    z88dk-z80asm -l -m -I"$REPO_DIR" -o"$OUTDIR/$COMBINED_ENTRY.o" "$MARVIN_ASM/$COMBINED_ENTRY.asm"

    # ---- Marvin modules ----

    RA8875_FLAG=""
    [ -n "$RA8875_MODULES" ] && RA8875_FLAG="-DHAS_RA8875"
    LCD_FLAG=""
    [ -n "$LCD_MODULES" ] && LCD_FLAG="-DHAS_LCD"
    BDFS_FLAG=""
    [ -n "$INCLUDE_BDFS" ] && BDFS_FLAG="-DINCLUDE_BDFS"

    echo ""
    echo "Assembling Marvin modules..."
    for module in $MARVIN_MODULES; do
        local obj_name=$(basename "$module")
        echo "  $module.asm"
        z88dk-z80asm -l -m -DINCLUDE_BASIC $RA8875_FLAG $LCD_FLAG $BDFS_FLAG -I"$REPO_DIR" -I"$RA8875_DIR" \
            -o"$OUTDIR/$obj_name.o" "$MARVIN_ASM/$module.asm"
    done

    if [ -n "$RA8875_MODULES" ]; then
        echo ""
        echo "Assembling RA8875 modules..."
        for module in $RA8875_MODULES; do
            local obj_name=$(basename "$module")
            if needs_rebuild "$OUTDIR/$obj_name.o" "$RA8875_DIR/$module.asm"; then
                echo "  $module.asm"
                z88dk-z80asm -l -m -I"$RA8875_DIR" \
                    -o"$OUTDIR/$obj_name.o" "$RA8875_DIR/$module.asm"
            else
                echo "  $module.asm (cached)"
            fi
        done
    fi

    # ---- BBC BASIC core modules ----

    echo ""
    echo "Assembling BBC BASIC modules..."
    if needs_rebuild "$OUTDIR/$BASIC_MAIN.o" "$BASIC_SRC/$BASIC_MAIN.asm"; then
        echo "  $BASIC_MAIN.asm"
        z88dk-z80asm -l -m -o"$OUTDIR/$BASIC_MAIN.o" "$BASIC_SRC/$BASIC_MAIN.asm"
    else
        echo "  $BASIC_MAIN.asm (cached)"
    fi
    for module in $BASIC_MODULES; do
        EXTRA_FLAGS=""
        if [ "$module" = "DATA" ]; then
            EXTRA_FLAGS="-DDATA_ORG=$DATA_ORG"
        fi
        if needs_rebuild "$OUTDIR/$module.o" "$BASIC_SRC/$module.asm"; then
            echo "  $module.asm"
            z88dk-z80asm -l -m $EXTRA_FLAGS -o"$OUTDIR/$module.o" "$BASIC_SRC/$module.asm"
        else
            echo "  $module.asm (cached)"
        fi
    done

    if needs_rebuild "$OUTDIR/HOOK.o" "$BBCZ80_DIR/HOOK.asm"; then
        echo "  HOOK.asm"
        z88dk-z80asm -l -m -o"$OUTDIR/HOOK.o" "$BBCZ80_DIR/HOOK.asm"
    else
        echo "  HOOK.asm (cached)"
    fi

    if needs_rebuild "$OUTDIR/MOS.o" "$BBCZ80_DIR/MOS.asm"; then
        echo "  MOS.asm"
        z88dk-z80asm -l -m -I"$REPO_DIR" $BDFS_FLAG -o"$OUTDIR/MOS.o" "$BBCZ80_DIR/MOS.asm"
    else
        echo "  MOS.asm (cached)"
    fi

    # ---- Shared BBC BASIC entry point ----

    echo ""
    echo "Assembling BBC BASIC entry point..."
    if needs_rebuild "$OUTDIR/ENTRY.o" "$BBCZ80_DIR/ENTRY.asm"; then
        echo "  ENTRY.asm"
        z88dk-z80asm -l -m -I"$REPO_DIR" -o"$OUTDIR/ENTRY.o" "$BBCZ80_DIR/ENTRY.asm"
    else
        echo "  ENTRY.asm (cached)"
    fi

    # ---- Link ----
    # Boot module must be first (contains ORG 0x0000 and jump table)

    ALL_OBJS="$OUTDIR/$COMBINED_ENTRY.o $OUTDIR/ENTRY.o"
    for module in $MARVIN_MODULES; do
        ALL_OBJS="$ALL_OBJS $OUTDIR/$(basename $module).o"
    done
    for module in $RA8875_MODULES; do
        ALL_OBJS="$ALL_OBJS $OUTDIR/$(basename $module).o"
    done
    ALL_OBJS="$ALL_OBJS $OUTDIR/$BASIC_MAIN.o"
    for module in $BASIC_MODULES; do
        ALL_OBJS="$ALL_OBJS $OUTDIR/$module.o"
    done
    ALL_OBJS="$ALL_OBJS $OUTDIR/HOOK.o"
    ALL_OBJS="$ALL_OBJS $OUTDIR/MOS.o"

    echo ""
    echo "Linking all modules at $CODE_ORG..."
    z88dk-z80asm -b -m \
        -o"$OUTDIR/$OUTPUT_NAME.bin" \
        -r$CODE_ORG \
        $ALL_OBJS

    # Remove DATA section binary - it lives in RAM, not ROM
    rm -f "$OUTDIR/${OUTPUT_NAME}_data.bin"

    BIN_SIZE=$(wc -c < "$OUTDIR/$OUTPUT_NAME.bin" | tr -d ' ')

    xxd "$OUTDIR/$OUTPUT_NAME.bin" > "$OUTDIR/$OUTPUT_NAME.hex"
    z88dk-appmake +hex --org $CODE_ORG \
        -b "$OUTDIR/$OUTPUT_NAME.bin" \
        -o "$OUTDIR/$OUTPUT_NAME.ihx"

    echo ""
    echo "Build complete:"
    echo "  ROM image:   output/$OUTPUT_NAME.bin ($BIN_SIZE bytes at $CODE_ORG)"
    echo "  Hex dump:    output/$OUTPUT_NAME.hex"
    echo "  Intel HEX:   output/$OUTPUT_NAME.ihx"
    echo "  Map file:    output/$OUTPUT_NAME.map"
    echo ""
    echo "Memory layout:"
    echo "  ROM: $CODE_ORG - code ($BIN_SIZE bytes)"
    echo "  RAM: $DATA_ORG - data segment (initialised at runtime)"
}

# ---- Build minimal firmware (Marvin monitor only, no BBC BASIC) ----

build_minimal() {
    local target=$1
    local TARGET_DIR="$REPO_DIR/targets/$target"
    local OUTDIR="$TARGET_DIR/output"

    modules_for_target "$target"

    echo "Building Marvin minimal ($target)"
    echo "==========================="

    mkdir -p "$OUTDIR"

    # ---- Entry module ----

    echo ""
    echo "Assembling entry module..."
    echo "  $MINIMAL_ENTRY.asm"
    z88dk-z80asm -l -m -DMARVINORG=$CODE_ORG -I"$REPO_DIR" \
        -o"$OUTDIR/$MINIMAL_ENTRY.o" "$MARVIN_ASM/$MINIMAL_ENTRY.asm"

    # ---- Marvin and driver modules ----

    RA8875_FLAG=""
    [ -n "$MINIMAL_RA8875_MODULES" ] && RA8875_FLAG="-DHAS_RA8875"
    LCD_FLAG=""
    [ -n "$MINIMAL_LCD_MODULES" ] && LCD_FLAG="-DHAS_LCD"
    BDFS_FLAG=""
    [ -n "$INCLUDE_BDFS" ] && BDFS_FLAG="-DINCLUDE_BDFS"

    echo ""
    echo "Assembling modules..."
    for module in $MINIMAL_MODULES; do
        local obj_name=$(basename "$module")
        echo "  $module.asm"
        z88dk-z80asm -l -m $RA8875_FLAG $LCD_FLAG $BDFS_FLAG -I"$REPO_DIR" -I"$RA8875_DIR" -o"$OUTDIR/$obj_name.o" "$MARVIN_ASM/$module.asm"
    done

    if [ -n "$MINIMAL_RA8875_MODULES" ]; then
        echo ""
        echo "Assembling RA8875 modules..."
        for module in $MINIMAL_RA8875_MODULES; do
            local obj_name=$(basename "$module")
            if needs_rebuild "$OUTDIR/$obj_name.o" "$RA8875_DIR/$module.asm"; then
                echo "  $module.asm"
                z88dk-z80asm -l -m -I"$RA8875_DIR" \
                    -o"$OUTDIR/$obj_name.o" "$RA8875_DIR/$module.asm"
            else
                echo "  $module.asm (cached)"
            fi
        done
    fi

    # ---- Link ----
    # Entry module must be first (contains ORG and jump table)
    # Link order: entry, MINIMAL_MODULES, MINIMAL_RA8875_MODULES

    ALL_OBJS="$OUTDIR/$MINIMAL_ENTRY.o"
    for module in $MINIMAL_MODULES; do
        local obj_name=$(basename "$module")
        ALL_OBJS="$ALL_OBJS $OUTDIR/$obj_name.o"
    done
    for module in $MINIMAL_RA8875_MODULES; do
        ALL_OBJS="$ALL_OBJS $OUTDIR/$(basename $module).o"
    done
    echo ""
    echo "Linking minimal modules at $CODE_ORG..."
    z88dk-z80asm -b -m \
        -o"$OUTDIR/$MINIMAL_NAME.bin" \
        -r$CODE_ORG \
        $ALL_OBJS

    BIN_SIZE=$(wc -c < "$OUTDIR/$MINIMAL_NAME.bin" | tr -d ' ')

    xxd "$OUTDIR/$MINIMAL_NAME.bin" > "$OUTDIR/$MINIMAL_NAME.hex"
    z88dk-appmake +hex --org $CODE_ORG \
        -b "$OUTDIR/$MINIMAL_NAME.bin" \
        -o "$OUTDIR/$MINIMAL_NAME.ihx"

    echo ""
    echo "Minimal build complete:"
    echo "  ROM image:   output/$MINIMAL_NAME.bin ($BIN_SIZE bytes at $CODE_ORG)"
    echo "  Hex dump:    output/$MINIMAL_NAME.hex"
    echo "  Intel HEX:   output/$MINIMAL_NAME.ihx"
    echo "  Map file:    output/$MINIMAL_NAME.map"
}

# ---- Main ----

# Generate version include from VERSION.txt
VERSION=$(cat "$REPO_DIR/VERSION.txt")
echo "defm \"$VERSION\"" > "$MARVIN_ASM/version.inc"

# Check submodules are initialised
if [ ! -f "$REPO_DIR/BBCZ80-repo/build.sh" ]; then
    echo "Error: BBCZ80 submodule not initialised."
    echo "Run: git submodule update --init"
    exit 1
fi

if [ ! -f "$RA8875_DIR/asm/ra8875.asm" ]; then
    echo "Error: ra8875 submodule not initialised."
    echo "Run: git submodule update --init"
    exit 1
fi

# Convert BBC BASIC sources if not already done
if [ ! -f "$BASIC_SRC/MAIN.asm" ]; then
    echo "=== Converting BBC BASIC sources ==="
    cd "$REPO_DIR/BBCZ80-repo"
    ./convert.sh
    cd "$REPO_DIR"
    echo ""
fi

if [ $# -gt 0 ]; then
    build_target "$1"
    echo ""
    build_minimal "$1"
else
    for target in beanzee beanboard beandeck beandeck_reva; do
        build_target "$target"
        echo ""
        build_minimal "$target"
        echo ""
    done
fi