hackrf

name: Build

on:
  push:
  pull_request:

  # Run automatically every monday
  schedule:
    - cron: 1 12 * * 1

env:

  # Override OSX architecture detection. Required for CMake versions < 3.19.2.
  CMAKE_OSX_ARCHITECTURES: arm64

jobs:
  host:
    strategy:
      matrix:
        os: ['macos', 'ubuntu', 'windows']
        cmake: ['3.10.0', '3.21.7', '4.2.6', 'latest']
        compiler: ['gcc', 'msvc']
        exclude:
          # MSVC only runs on Windows.
          - os: 'macos'
            compiler: 'msvc'
          - os: 'ubuntu'
            compiler: 'msvc'
          # We can't use the oldest CMake versions on Windows.
          - os: 'windows'
            cmake: '3.10.0'
          # The in-between CMake versions aren't so intersting with GCC.
          - compiler: 'gcc'
            cmake: '3.21.7'
          - compiler: 'gcc'
            cmake: '4.2.6'
        include:
          # Shell selection
          - os: 'macos'
            shell: 'bash'
          - os: 'ubuntu'
            shell: 'bash'
          - os: 'windows'
            compiler: 'msvc'
            shell: 'pwsh'
          - os: 'windows'
            compiler: 'gcc'
            shell: 'msys2'
          # MSVC version selection
          - cmake: '3.21.7'
            msvc: '17.14'
          - cmake: '4.2.6'
            msvc: 'latest'
          - cmake: 'latest'
            msvc: 'latest'
          # CMake generator selection
          - os: 'macos'
            generator: 'Unix Makefiles'
          - os: 'ubuntu'
            generator: 'Unix Makefiles'
          - compiler: 'msvc'
            cmake: '3.21.7'
            generator: 'Visual Studio 17 2022'
          - compiler: 'msvc'
            cmake: '4.2.6'
            generator: 'Visual Studio 18 2026'
          - compiler: 'msvc'
            cmake: 'latest'
            generator: 'Visual Studio 18 2026'
          - os: 'windows'
            compiler: 'gcc'
            generator: 'MSYS Makefiles'
          # Additional CMake arguments
          - os: 'windows'
            compiler: 'msvc'
            cmake_args: >-
              -DPKG_CONFIG_EXECUTABLE=C:/vcpkg/installed/x64-windows/tools/pkgconf/pkgconf.exe
              -DCMAKE_TOOLCHAIN_FILE=C:/vcpkg/scripts/buildsystems/vcpkg.cmake
              --install-prefix=$env:GITHUB_WORKSPACE/install
          - os: 'windows'
            compiler: 'gcc'
            cmake_args: >-
              --install-prefix=/usr/local
          # CMake 3.10 uses --build with --target install
          - cmake: '3.10.0'
            install_cmd: --build
            install_args: --target install
          # Later versions just use --install
          - cmake: '3.21.7'
            install_cmd: --install
          - cmake: '4.2.6'
            install_cmd: --install
          - cmake: 'latest'
            install_cmd: --install
          # We need sudo on MacOS and Ubuntu only
          - os: macos
            sudo: sudo
          - os: ubuntu
            sudo: sudo


      # Don't cancel all builds when one fails
      fail-fast: false
    runs-on: ${{ matrix.os }}-latest

    defaults:
      run:
        shell: '${{ matrix.shell }} {0}'

    steps:
    - uses: actions/checkout@v6

    - name: Setup cmake
      uses: lukka/get-cmake@latest
      with:
        cmakeVersion: ${{ matrix.cmake }}
      if: matrix.shell != 'msys2'

    - name: Install MSVC (Windows)
      uses: k3DW/setup-msvc@v1
      with:
        vs-version: ${{ matrix.msvc }}
      if: matrix.compiler == 'msvc' && matrix.msvc != 'latest'

    - name: Install dependencies (macOS)
      run: brew install fftw
      if: matrix.os == 'macos'

    - name: Install dependencies (Ubuntu)
      run: |
        sudo apt update
        sudo apt install libfftw3-dev libusb-1.0-0-dev
      if: matrix.os == 'ubuntu'

    - name: Install dependencies (Windows)
      run: vcpkg install --triplet=x64-windows libusb fftw3 pthreads pkgconf
      if: matrix.os == 'windows' && matrix.shell != 'msys2'

    - name: Setup MSYS (Windows)
      if: matrix.os == 'windows' && matrix.shell == 'msys2'
      uses: msys2/setup-msys2@v2
      with:
        msystem: UCRT64
        install: >-
          git
          make
          mingw-w64-ucrt-x86_64-cmake
          mingw-w64-ucrt-x86_64-toolchain
          mingw-w64-ucrt-x86_64-libusb
          mingw-w64-ucrt-x86_64-fftw

    # Build libhackrf and hackrf-tools together

    - name: Configure & Build
      run: |
        cmake -E make_directory host/build
        cd host/build
        cmake .. -G "${{ matrix.generator }}" -DCMAKE_BUILD_TYPE=Release ${{matrix.cmake_args}}
        cmake --build . --config Release

    # Build libhackrf ONLY

    - name: Configure & Build (libhackrf)
      run: |
        cmake -E make_directory host/libhackrf/build
        cd host/libhackrf/build
        cmake .. -G "${{ matrix.generator }}" -DCMAKE_BUILD_TYPE=Release ${{ matrix.cmake_args }}
        cmake --build . --config Release

    - name: Install (libhackrf)
      run: |
        ${{ matrix.sudo }} cmake ${{ matrix.install_cmd }} host/libhackrf/build ${{ matrix.install_args }} --config Release

    # Build hackrf-tools ONLY

    - name: Configure & Build (hackrf-tools)
      run: |
        cmake -E make_directory host/hackrf-tools/build
        cd host/hackrf-tools/build
        cmake .. -G "${{ matrix.generator }}" -DCMAKE_BUILD_TYPE=Release ${{ matrix.cmake_args }}
        cmake --build . --config Release

    - name: Install (hackrf-tools)
      run: |
        ${{ matrix.sudo }} cmake ${{ matrix.install_cmd }} host/hackrf-tools/build ${{ matrix.install_args }}

    # Publish the contents of install/bin (which should be the combination libhackrf and host-tools) for Windows
    - name: Publish Artifacts (Windows)
      uses: actions/upload-artifact@v4
      with:
        name: hackrf-tools-windows
        path: ${{github.workspace}}/install/bin
      if: matrix.os == 'windows' && matrix.cmake == 'latest' && matrix.shell == 'pwsh'

  firmware:
    strategy:
      matrix:
        os: ['macos', 'ubuntu', 'windows']
        board: ['HACKRF_ONE', 'JAWBREAKER', 'RAD1O', 'PRALINE', 'UNIVERSAL']
        cmake: ['3.12.0', 'latest']
        exclude:
          - os: 'windows'
            cmake: '3.12.0'
          # GitHub doesn't give us many macOS runners, so don't build for every board.
          # We just need to know that building firmware works on macOS. Use PRALINE
          # since that's the most complicated one due to FPGA bitstreams.
          - os: 'macos'
            board: 'HACKRF_ONE'
          - os: 'macos'
            board: 'JAWBREAKER'
          - os: 'macos'
            board: 'RAD1O'

      # Don't cancel all builds when one fails
      fail-fast: false
    runs-on: ${{ matrix.os }}-latest

    steps:
    - uses: actions/checkout@v6
      with:
        submodules: true

    - name: Setup cmake
      uses: lukka/get-cmake@latest
      with:
        cmakeVersion: ${{ matrix.cmake }}
      if: matrix.os != 'windows'

    - name: Install Arm GNU Toolchain
      uses: carlosperate/arm-none-eabi-gcc-action@v1
      if: matrix.os != 'windows'

    - name: Install dependencies (macOS)
      run: |
        brew install dfu-util
        python3 -m venv environment && source environment/bin/activate
        python3 -m pip install PyYAML
      if: matrix.os == 'macos'

    - name: Install dependencies (Ubuntu)
      run: |
        python3 -m venv environment && source environment/bin/activate
        python3 -m pip install PyYAML
        sudo apt install dfu-util
      if: matrix.os == 'ubuntu'

    - name: Build libopencm3
      shell: bash
      working-directory: ${{github.workspace}}/firmware/libopencm3/
      run: |
        source ../../environment/bin/activate
        make
      if: matrix.os != 'windows'

    - name: Create Build Environment
      run: cmake -E make_directory ${{github.workspace}}/firmware/build
      if: matrix.os != 'windows'

    - name: Configure CMake
      shell: bash
      working-directory: ${{github.workspace}}/firmware/build
      run: cmake $GITHUB_WORKSPACE/firmware/ -DCMAKE_BUILD_TYPE=Release -DBOARD=${{ matrix.board }}
      if: matrix.os != 'windows'

    - name: Build
      working-directory: ${{github.workspace}}/firmware/build
      shell: bash
      run: |
        source ../../environment/bin/activate
        cmake --build . --config Release
      if: matrix.os != 'windows'

    - name: Setup MSYS (Windows)
      if: matrix.os == 'windows'
      uses: msys2/setup-msys2@v2
      with:
        msystem: UCRT64
        update: true
        install: >-
          git
          make
          mingw-w64-ucrt-x86_64-arm-none-eabi-gcc
          mingw-w64-ucrt-x86_64-cmake
          mingw-w64-ucrt-x86_64-dfu-util
          mingw-w64-ucrt-x86_64-python-yaml

    - name: Downgrade ARM linker (Windows, temporary)
      if: matrix.os == 'windows'
      shell: msys2 {0}
      run: pacman -U --noconfirm https://repo.msys2.org/mingw/ucrt64/mingw-w64-ucrt-x86_64-arm-none-eabi-binutils-2.46.1-1-any.pkg.tar.zst

    - name: Build with MSYS (Windows)
      if: matrix.os == 'windows'
      shell: msys2 {0}
      run: |
        mkdir firmware/build
        cd firmware/build
        cmake -G "MSYS Makefiles" -DCMAKE_BUILD_TYPE=Release -DBOARD=${{ matrix.board }} ..
        make