Merge branch 'blackmagic-debug:main' into pic32cm

Author: kinsamanka

.github/workflows/build-and-upload.yml

@@ -14,6 +14,10 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.job }}-${{ github.ref }}
   cancel-in-progress: true
 
+permissions:
+  contents: read
+  actions: write
+
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
   # This workflow contains a job for each supported OS in the form `build-<os>`
@@ -98,6 +102,12 @@ jobs:
           meson setup build --cross-file cross-file/${{ matrix.probe }}.ini
           meson compile -C build
           mkdir src/artefacts
+          case "${{ matrix.probe }}" in
+            native-*)
+              mv build/blackmagic_native_firmware.elf build/blackmagic_${{ matrix.probe }}_firmware.elf
+              mv build/blackmagic_native_firmware.bin build/blackmagic_${{ matrix.probe }}_firmware.bin
+              ;;
+          esac
           mv build/blackmagic_*_firmware.{elf,bin} src/artefacts
 
       # Package up the artefacts and upload them

.github/workflows/build-pr.yml

@@ -14,6 +14,10 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.job }}-${{ github.ref }}
   cancel-in-progress: true
 
+permissions:
+  contents: read
+  pull-requests: read
+
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
   # This workflow contains a job for each supported OS in the form `build-<os>`
@@ -80,7 +84,9 @@ jobs:
 
       # Install BMDA's deps (libftdi1, hidapi-hidraw)
       - name: Install BMDA dependencies
-        run: sudo apt-get -y install libftdi1-dev libhidapi-dev libudev-dev
+        run: |
+          sudo apt update
+          sudo apt-get -y install libftdi1-dev libhidapi-dev libudev-dev
 
       # Record the versions of all the tools used in the build
       - name: Version tools

.github/workflows/lint.yml

@@ -9,6 +9,10 @@ on:
 
   workflow_dispatch:
 
+permissions:
+  contents: read
+  pull-requests: read
+
 jobs:
   pre-commit:
     runs-on: ubuntu-latest

Makefile

@@ -1,5 +1,5 @@
 all:
-	@echo "Makefile build system is depricated."
+	@echo "Makefile build system is deprecated."
 	@echo ""
 	@echo "Please use Meson build system instead."
 	@echo ""

README.md

@@ -227,6 +227,15 @@ You should now see the resulting binaries in `build`, in this case:
 
 These are the binary files you will use to flash to your probe.
 
+#### Building the bootloader
+
+If your probe hardware does not already have a bootloader on it, after building firmware as described above
+you can build the appropriate bootloader with the following command:
+
+```sh
+meson compile -C build boot-bin
+```
+
 ##### region `rom' overflowed
 
 It may happen, while working with non default configurations or the project's latest version from Git,

meson.build

@@ -1,7 +1,8 @@
 # This file is part of the Black Magic Debug project.
 #
-# Copyright (C) 2023 1BitSquared <info@1bitsquared.com>
+# Copyright (C) 2023-2025 1BitSquared <info@1bitsquared.com>
 # Written by Rafael Silva <perigoso@riseup.net>
+# Modified by Rachel Mant <git@dragonmux.network>
 #
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
@@ -31,7 +32,7 @@
 project(
 	'Black Magic Debug',
 	'c',
-	version: '1.10.0',
+	version: '2.0.0',
 	license: 'GPL-3.0-or-later OR BSD-3-Clause OR MIT',
 	# license_files: ['COPYING', 'COPYING-BSD', 'COPYING-MIT'], # Only available in meson 1.1.0
 	default_options: [
@@ -258,17 +259,31 @@ If you did not touch the build system this is not your fault, please report it
 	## Utility targets
 	## _______________
 
-	# Black Magic Probe Firmware Manager
-	bmputil = find_program('bmputil', required: false)
+	# Black Magic Probe companion utility
+	bmputil = find_program('bmputil-cli', required: false)
 	if bmputil.found()
 		message('Adding target for firmware update')
 
 		# Firmware update target
 		run_target(
 			'flash',
-			command: [bmputil, 'flash', bmf_elf.full_path()],
+			command: [bmputil, 'probe', 'update', bmf_elf.full_path()],
 			depends: bmf_elf,
 		)
+	# If we couldn't find the utility, look for the older pre-v1.0 version of it
+	else
+		# Black Magic Probe Firmware Manager
+		bmputil = find_program('bmputil', required: false)
+		if bmputil.found()
+			message('Adding target for firmware update')
+
+			# Firmware update target
+			run_target(
+				'flash',
+				command: [bmputil, 'flash', bmf_elf.full_path()],
+				depends: bmf_elf,
+			)
+		endif
 	endif
 endif
 

src/command.c

@@ -4,7 +4,7 @@
  * Copyright (C) 2011 Black Sphere Technologies Ltd.
  * Written by Gareth McMullin <gareth@blacksphere.co.nz>
  * Copyright (C) 2021 Uwe Bonnes (bon@elektron.ikp.physik.tu-darmstadt.de)
- * Copyright (C) 2023 1BitSquared <info@1bitsquared.com>
+ * Copyright (C) 2023-2025 1BitSquared <info@1bitsquared.com>
  * Modified by Rachel Mant <git@dragonmux.network>
  *
  * This program is free software: you can redistribute it and/or modify
@@ -70,6 +70,9 @@ static bool cmd_target_power(target_s *target, int argc, const char **argv);
 #ifdef PLATFORM_HAS_BATTERY
 static bool cmd_target_battery(target_s *t, int argc, const char **argv);
 #endif
+#ifdef PLATFORM_HAS_WIFI
+static bool cmd_wifi(target_s *t, int argc, const char **argv);
+#endif
 #ifdef PLATFORM_HAS_TRACESWO
 static bool cmd_swo(target_s *target, int argc, const char **argv);
 #endif
@@ -109,6 +112,9 @@ const command_s cmd_list[] = {
 #ifdef PLATFORM_HAS_BATTERY
 	{"battery", cmd_target_battery, "Reads the battery state"},
 #endif
+#ifdef PLATFORM_HAS_WIFI
+	{"wifi", cmd_wifi, "Show/Set Wi-Fi connection [AP name,passphrase]"},
+#endif
 #ifdef ENABLE_RTT
 	{"rtt", cmd_rtt,
 		"[enable|disable|status|channel [0..15 ...]|ident [STR]|cblock|ram [RAM_START RAM_END]|poll [MAXMS MINMS "
@@ -202,7 +208,7 @@ bool cmd_version(target_s *target, int argc, const char **argv)
 #endif
 	gdb_outf(", Hardware Version %d\n", platform_hwversion());
 #endif
-	gdb_out("Copyright (C) 2010-2024 Black Magic Debug Project\n");
+	gdb_out("Copyright (C) 2010-2025 Black Magic Debug Project\n");
 	gdb_out("License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\n\n");
 
 	return true;
@@ -541,6 +547,15 @@ static bool cmd_target_battery(target_s *t, int argc, const char **argv)
 	return true;
 }
 #endif
+#ifdef PLATFORM_HAS_WIFI
+static bool cmd_wifi(target_s *t, int argc, const char **argv)
+{
+	(void)t;
+	gdb_out(platform_wifi_state(argc, argv));
+	return true;
+}
+#endif
+
 #ifdef ENABLE_RTT
 static const char *on_or_off(const bool value)
 {

src/gdb_main.c

@@ -133,7 +133,7 @@ int32_t gdb_main_loop(target_controller_s *const tc, const gdb_packet_s *const p
 			/**
 			 * Register data is unavailable
 			 * See: https://sourceware.org/gdb/current/onlinedocs/gdb.html/Packets.html#read-registers-packet
-			 * 
+			 *
 			 * ... the stub may also return a string of literal ‘x’ in place of the register data digits,
 			 * to indicate that the corresponding register’s value is unavailable.
 			 */
@@ -258,7 +258,7 @@ int32_t gdb_main_loop(target_controller_s *const tc, const gdb_packet_s *const p
 			/**
 			 * Register data is unavailable
 			 * See: https://sourceware.org/gdb/current/onlinedocs/gdb.html/Packets.html#read-registers-packet
-			 * 
+			 *
 			 * ... the stub may also return a string of literal ‘x’ in place of the register data digits,
 			 * to indicate that the corresponding register’s value is unavailable.
 			 */
@@ -466,7 +466,7 @@ static void exec_q_supported(const char *packet, const size_t length)
 	 * This might be the first packet of a GDB connection, If NoAckMode is enabled it might
 	 * be because the previous session was terminated abruptly, and we need to acknowledge
 	 * the first packet of the new session.
-	 * 
+	 *
 	 * If NoAckMode was intentionally enabled before (e.g. LLDB enables NoAckMode first),
 	 * the acknowledgment should be safely ignored.
 	 */
@@ -773,7 +773,7 @@ static void exec_v_cont(const char *packet, const size_t length)
 		 *
 		 * TODO: Support the 't' (stop) action needed for non-stop debug so GDB can request a halt.
 		 */
-		gdb_put_packet_str("vCont;c;C;s;t");
+		gdb_put_packet_str("vCont;c;C;s;S;t");
 		return;
 	}
 

src/include/buffer_utils.h

@@ -61,27 +61,32 @@ static inline void write_be4(uint8_t *const buffer, const size_t offset, const u
 
 static inline uint16_t read_le2(const uint8_t *const buffer, const size_t offset)
 {
-	return buffer[offset + 0U] | ((uint16_t)buffer[offset + 1U] << 8U);
+	uint8_t data[2U];
+	memcpy(data, buffer + offset, 2U);
+	return data[0U] | ((uint16_t)data[1U] << 8U);
 }
 
 static inline uint32_t read_le4(const uint8_t *const buffer, const size_t offset)
 {
-	return buffer[offset + 0U] | ((uint32_t)buffer[offset + 1U] << 8U) | ((uint32_t)buffer[offset + 2U] << 16U) |
-		((uint32_t)buffer[offset + 3U] << 24U);
+	uint8_t data[4U];
+	memcpy(data, buffer + offset, 4U);
+	return data[0U] | ((uint32_t)data[1U] << 8U) | ((uint32_t)data[2U] << 16U) | ((uint32_t)data[3U] << 24U);
 }
 
 static inline uint32_t read_be4(const uint8_t *const buffer, const size_t offset)
 {
-	return ((uint32_t)buffer[offset + 0U] << 24U) | ((uint32_t)buffer[offset + 1U] << 16U) |
-		((uint32_t)buffer[offset + 2U] << 8U) | buffer[offset + 3U];
+	uint8_t data[4U];
+	memcpy(data, buffer + offset, 4U);
+	return ((uint32_t)data[0U] << 24U) | ((uint32_t)data[1U] << 16U) | ((uint32_t)data[2U] << 8U) | data[3U];
 }
 
 static inline uint64_t read_be8(const uint8_t *const buffer, const size_t offset)
 {
-	return ((uint64_t)buffer[offset + 0] << 56U) | ((uint64_t)buffer[offset + 1] << 48U) |
-		((uint64_t)buffer[offset + 2] << 40U) | ((uint64_t)buffer[offset + 3] << 32U) |
-		((uint64_t)buffer[offset + 4] << 24U) | ((uint64_t)buffer[offset + 5] << 16U) |
-		((uint64_t)buffer[offset + 6] << 8U) | buffer[offset + 7];
+	uint8_t data[8U];
+	memcpy(data, buffer + offset, 8U);
+	return ((uint64_t)data[0] << 56U) | ((uint64_t)data[1] << 48U) | ((uint64_t)data[2] << 40U) |
+		((uint64_t)data[3] << 32U) | ((uint64_t)data[4] << 24U) | ((uint64_t)data[5] << 16U) |
+		((uint64_t)data[6] << 8U) | data[7];
 }
 
 static inline size_t write_char(char *const buffer, const size_t buffer_size, const size_t offset, const char c)

src/include/platform_support.h

@@ -70,6 +70,7 @@ void platform_max_frequency_set(uint32_t frequency);
 uint32_t platform_max_frequency_get(void);
 
 void platform_target_clk_output_enable(bool enable);
+void platform_ospeed_update(uint32_t frequency);
 
 #if CONFIG_BMDA == 0
 bool platform_spi_init(spi_bus_e bus);