Feature: experimental meson buildsystem

.github/PULL_REQUEST_TEMPLATE.md

@@ -15,8 +15,8 @@ Information embedded in the description part of the commits doesn't count.
 
 * [ ] I've read the [Code of Conduct](https://github.com/blackmagic-debug/blackmagic/blob/main/CODE_OF_CONDUCT.md)
 * [ ] I've read the [guidelines for contributing](https://github.com/blackmagic-debug/blackmagic/blob/main/CONTRIBUTING.md) to this repository
-* [ ] It builds for hardware native (`make PROBE_HOST=native`)
-* [ ] It builds as BMDA (`make PROBE_HOST=hosted`)
+* [ ] It builds for hardware native (see [Building the firmware](https://github.com/blackmagic-debug/blackmagic?tab=readme-ov-file#building-black-magic-debug-firmware))
+* [ ] It builds as BMDA (see [Building the BMDA](https://github.com/blackmagic-debug/blackmagic?tab=readme-ov-file#building-black-magic-debug-app))
 * [ ] I've tested it to the best of my ability
 * [ ] My commit messages provide a useful short description of what the commits do
 

.github/workflows/build-pr.yml

@@ -223,8 +223,85 @@ jobs:
       - name: Build full BMDA
         run: make PROBE_HOST=hosted HOSTED_BMP_ONLY=0
 
+  # This workflow tests the experimental Meson build system
+  build-linux-meson:
+    # Name the job more appropriately so we can tell which windows and which MinGW ABI is in use
+    name: 'build-linux (${{ matrix.os.name }}, ${{ matrix.probe }}'
+    # The type of runner that the job will run on
+    runs-on: ${{ matrix.os.id }}
+
+    # We define a matrix of GCCs and OSes to build against so we can cover a variety of
+    # suitable compilation environments and early discover issues. The `build-and-upload`
+    # workflow contains an extended set.
+    strategy:
+      matrix:
+        os:
+          - {id: ubuntu-20.04, name: focal}
+        arm-compiler:
+          - '12.2.Rel1'
+        probe:
+          - '96b_carbon'
+          - 'bluepill'
+          - 'f072'
+          - 'f3'
+          - 'f4discovery'
+          - 'hydrabus'
+          - 'launchpad-icdi'
+          - 'native'
+          - 'stlink'
+          - 'stlinkv3'
+          - 'swlink'
+      fail-fast: false
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Build a suitable runtime environment
+      - name: Runtime environment
+        shell: bash
+        env:
+          WORKSPACE: ${{ github.workspace }}
+        # The GITHUB_WORKSPACE step here fixes https://github.com/actions/runner/issues/2058 which is an ongoing issue.
+        run: |
+          echo "$GITHUB_WORKSPACE=`pwd`" >> $GITHUB_ENV
+
+      # Setup and use a suitable ARM GCC for the firmware
+      - name: Setup ARM GCC
+        uses: carlosperate/arm-none-eabi-gcc-action@v1
+        with:
+          release: ${{ matrix.arm-compiler }}
+
+      # Install and setup a suitable Meson + Ninja
+      - name: Setup Meson + Ninja
+        run: |
+          sudo python3 -m pip install --upgrade pip setuptools wheel
+          sudo python3 -m pip install meson ninja
+        working-directory: ${{ runner.temp }}
+
+      # Install BMDA's deps (libftdi1, hidapi-hidraw)
+      - name: Install BMDA dependencies
+        run: sudo apt-get -y install libftdi1-dev libhidapi-dev
+
+      # Record the versions of all the tools used in the build
+      - name: Version tools
+        run: |
+          arm-none-eabi-gcc --version
+          meson --version
+          ninja --version
+
+      # Checkout the repository and branch to build under the default location
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          submodules: true
+
+      # Build the firmware for all platform variants (currently available)
+      - name: Build
+        run: |
+          meson setup build --cross-file cross-file/${{ matrix.probe }}.ini
+          meson compile -C build
+
   size-diff:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
 
     steps:
       # Setup and use a suitable ARM GCC for the firmware

.gitmodules

@@ -1,5 +1,5 @@
 [submodule "libopencm3"]
-	path = libopencm3
+	path = deps/libopencm3
 	url = https://github.com/blackmagic-debug/libopencm3
 	branch = main
 	ignore = dirty

CONTRIBUTING.md

@@ -10,24 +10,22 @@ By participating in this project you agree to abide by its terms.
 
 ## Development and Testing
 
-When developing this project, the following tools are necessary:
+When developing this project some tools are necessary, take a look at the **Requirements** section of the
+[README](README.md#requirements).
 
-* Git
-* One of either:
-  * GCC or Clang (Clang is not strictly officially supported)
-  * [`arm-none-eabi-gcc`](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/downloads) (from ARM, self-built and distro-supplied is currently broken)
-* GNU Make or compatible `make` tool
+For instructions on how to build the project, please follow the **Building** section of the
+[README](README.md#building).
 
-Which of the compilers you pick depends on if you're going to work on the firwmare or Black Magic Debug App (BMDA) respectively.
-If you wish to use the older [gnu-rm](https://developer.arm.com/downloads/-/gnu-rm) ARM toolchain, this is fine and works well.
+## Reporting issues
 
-## Common tasks
+### Before reporting issues
 
-These are to be run at the root of your clone of Black Magic Probe.
+ 1. Check against the latest version (`main` branch).
+ 2. If possible, and applicable, test against another target and/or debug probe.
+ 3. Consider broken USB cables and connectors.
+ 4. Try to reproduce with BMDA with at least output verbosity bit 1 (INFO) set (`blackmagic -v 1 ...`), as debug messages will be dumped to the starting console.
 
-* Building the firmware: `make PROBE_HOST=native` (or whichever probe you want to build for)
-* Building BMDA: `make PROBE_HOST=hosted`
-* Build testing all platforms: `make all_platforms`
+When reporting issues, be as specific as possible!
 
 ## Submitting a pull request
 

Makefile

@@ -12,12 +12,11 @@ endif
 
 all:
 ifndef NO_LIBOPENCM3
-	$(Q)if [ ! -f libopencm3/Makefile ]; then \
+	$(Q)if [ ! -f deps/libopencm3/Makefile ]; then \
 		echo "Initialising git submodules..." ;\
-		git submodule init ;\
-		git submodule update ;\
+		git submodule update --init ;\
 	fi
-	$(Q)$(MAKE) $(MFLAGS) -C libopencm3 lib/stm32/f1 lib/stm32/f4 lib/lm4f
+	$(Q)$(MAKE) $(MFLAGS) -C deps/libopencm3 lib/stm32/f1 lib/stm32/f4 lib/stm32/f7 lib/lm4f
 endif
 	$(Q)$(MAKE) $(MFLAGS) -C src
 
@@ -26,7 +25,7 @@ all_platforms:
 
 clean:
 ifndef NO_LIBOPENCM3
-	$(Q)$(MAKE) $(MFLAGS) -C libopencm3 $@
+	$(Q)$(MAKE) $(MFLAGS) -C deps/libopencm3 $@
 endif
 	$(Q)$(MAKE) $(MFLAGS) -C src $@