probe: correct SWCLK calculations

Use the actual clk_sys frequency and Round divisors up, otherwise high
swclk speeds get significantly overclocked.

CMakeLists.txt

@@ -51,12 +51,20 @@ target_compile_definitions (debugprobe PRIVATE
 
 option (DEBUG_ON_PICO "Compile firmware for the Pico instead of Debug Probe" OFF)
 if (DEBUG_ON_PICO)
-    target_compile_definitions (debugprobe PRIVATE 
+    target_compile_definitions (debugprobe PRIVATE
 	DEBUG_ON_PICO=1
     )
-    set_target_properties(debugprobe PROPERTIES 
-        OUTPUT_NAME "debugprobe_on_pico"
-    )
+    if (PICO_BOARD STREQUAL "pico")
+        set_target_properties(debugprobe PROPERTIES
+            OUTPUT_NAME "debugprobe_on_pico"
+        )
+    elseif (PICO_BOARD STREQUAL "pico2")
+        set_target_properties(debugprobe PROPERTIES
+            OUTPUT_NAME "debugprobe_on_pico2"
+        )
+    else ()
+        message(SEND_ERROR "Unsupported board ${PICO_BOARD}")
+    endif ()
 endif ()
 
 

README.md

@@ -9,7 +9,7 @@ Firmware source for the Raspberry Pi Debug Probe SWD/UART accessory. Can also be
 
 # Documentation
 
-Debug Probe documentation can be found in the [Pico Getting Started Guide](https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf). See "Appendix A: Using the Debug Probe".
+Debug Probe documentation can be found at the [Raspberry Pi Microcontroller Documentation portal](https://www.raspberrypi.com/documentation/microcontrollers/debug-probe.html#about-the-debug-probe).
 
 # Hacking
 
@@ -22,7 +22,7 @@ cd debugprobe
 ```
 Initialize and update the submodules:
 ```
- git submodule update --init
+ git submodule update --init --recursive
 ```
 Then create and switch to the build directory:
 ```

blah.patch

@@ -0,0 +1,23 @@
+diff --git a/include/DAP_config.h b/include/DAP_config.h
+index fb02fb1..88c11d9 100755
+--- a/include/DAP_config.h
++++ b/include/DAP_config.h
+@@ -44,6 +44,7 @@ This information includes:
+  - Optional information about a connected Target Device (for Evaluation Boards).
+ */
+ #include <pico/stdlib.h>
++#include <hardware/clocks.h>
+ #include <hardware/gpio.h>
+
+ #include "cmsis_compiler.h"
+@@ -52,8 +53,8 @@ This information includes:
+
+ /// Processor Clock of the Cortex-M MCU used in the Debug Unit.
+ /// This value is used to calculate the SWD/JTAG clock speed.
+-/* Debugprobe actually uses kHz rather than Hz, so just lie about it here */
+-#define CPU_CLOCK               125000000U      ///< Specifies the CPU Clock in Hz.
++/* Debugprobe uses PIO for clock generation, so return the current system clock. */
++#define CPU_CLOCK               clock_get_hz(clk_sys)
+
+ /// Number of processor cycles for I/O Port write operations.
+ /// This value is used to calculate the SWD/JTAG clock speed that is generated with I/O

include/DAP_config.h

@@ -44,6 +44,7 @@ This information includes:
  - Optional information about a connected Target Device (for Evaluation Boards).
 */
 #include <pico/stdlib.h>
+#include <hardware/clocks.h>
 #include <hardware/gpio.h>
 
 #include "cmsis_compiler.h"
@@ -52,8 +53,8 @@ This information includes:
 
 /// Processor Clock of the Cortex-M MCU used in the Debug Unit.
 /// This value is used to calculate the SWD/JTAG clock speed.
-/* Debugprobe actually uses kHz rather than Hz, so just lie about it here */
-#define CPU_CLOCK               125000000U      ///< Specifies the CPU Clock in Hz.
+/* Debugprobe uses PIO for clock generation, so return the current system clock. */
+#define CPU_CLOCK               clock_get_hz(clk_sys)
 
 /// Number of processor cycles for I/O Port write operations.
 /// This value is used to calculate the SWD/JTAG clock speed that is generated with I/O

src/main.c

@@ -60,6 +60,8 @@ static uint8_t RxDataBuffer[CFG_TUD_HID_EP_BUFSIZE];
 
 TaskHandle_t dap_taskhandle, tud_taskhandle, mon_taskhandle;
 
+static int was_configured;
+
 void dev_mon(void *ptr)
 {
     uint32_t sof[3];
@@ -224,17 +226,21 @@ bool tud_vendor_control_xfer_cb(uint8_t rhport, uint8_t stage, tusb_control_requ
 void tud_suspend_cb(bool remote_wakeup_en)
 {
   probe_info("Suspended\n");
-  /* Join DAP and UART threads? Or just suspend them, for transparency */
-  vTaskSuspend(uart_taskhandle);
-  vTaskSuspend(dap_taskhandle);
+  /* Were we actually configured? If not, threads don't exist */
+  if (was_configured) {
+	  vTaskSuspend(uart_taskhandle);
+	  vTaskSuspend(dap_taskhandle);
+  }
   /* slow down clk_sys for power saving ? */
 }
 
 void tud_resume_cb(void)
 {
   probe_info("Resumed\n");
-  vTaskResume(uart_taskhandle);
-  vTaskResume(dap_taskhandle);
+  if (was_configured) {
+	  vTaskResume(uart_taskhandle);
+	  vTaskResume(dap_taskhandle);
+  }
 }
 
 void tud_unmount_cb(void)
@@ -244,15 +250,19 @@ void tud_unmount_cb(void)
   vTaskSuspend(dap_taskhandle);
   vTaskDelete(uart_taskhandle);
   vTaskDelete(dap_taskhandle);
+  was_configured = 0;
 }
 
 void tud_mount_cb(void)
 {
   probe_info("Connected, Configured\n");
-  /* UART needs to preempt USB as if we don't, characters get lost */
-  xTaskCreate(cdc_thread, "UART", configMINIMAL_STACK_SIZE, NULL, UART_TASK_PRIO, &uart_taskhandle);
-  /* Lowest priority thread is debug - need to shuffle buffers before we can toggle swd... */
-  xTaskCreate(dap_thread, "DAP", configMINIMAL_STACK_SIZE, NULL, DAP_TASK_PRIO, &dap_taskhandle);
+  if (!was_configured) {
+    /* UART needs to preempt USB as if we don't, characters get lost */
+    xTaskCreate(cdc_thread, "UART", configMINIMAL_STACK_SIZE, NULL, UART_TASK_PRIO, &uart_taskhandle);
+    /* Lowest priority thread is debug - need to shuffle buffers before we can toggle swd... */
+    xTaskCreate(dap_thread, "DAP", configMINIMAL_STACK_SIZE, NULL, DAP_TASK_PRIO, &dap_taskhandle);
+    was_configured = 1;
+  }
 }
 
 void vApplicationTickHook (void)

src/probe.c

@@ -61,9 +61,13 @@ static struct _probe probe;
 void probe_set_swclk_freq(uint freq_khz) {
         uint clk_sys_freq_khz = clock_get_hz(clk_sys) / 1000;
         probe_info("Set swclk freq %dKHz sysclk %dkHz\n", freq_khz, clk_sys_freq_khz);
-        uint32_t divider = clk_sys_freq_khz / freq_khz / 4;
+        // Round up (otherwise fast swclks get faster)
+        uint32_t divider = (((clk_sys_freq_khz + freq_khz - 1)/ freq_khz) + 3) / 4;
         if (divider == 0)
             divider = 1;
+        if (divider > 65535)
+            divider = 65535;
+
         pio_sm_set_clkdiv_int_frac(pio0, PROBE_SM, divider, 0);
 }
 

src/tusb_config.h

@@ -75,7 +75,7 @@
  * is issued. At high datarates this leads to huge variation in instantaneous
  * throughput on USB, so a large runway is needed.
  */
-#define CFG_TUD_CDC_RX_BUFSIZE 128
+#define CFG_TUD_CDC_RX_BUFSIZE 64
 #define CFG_TUD_CDC_TX_BUFSIZE 4096
 
 #define CFG_TUD_VENDOR_RX_BUFSIZE 8192

src/usb_descriptors.c

@@ -48,7 +48,7 @@ tusb_desc_device_t const desc_device =
 
     .idVendor           = 0x2E8A, // Pi
     .idProduct          = 0x000c, // CMSIS-DAP Debug Probe
-    .bcdDevice          = 0x0210, // Version 02.10
+    .bcdDevice          = 0x0222, // Version 02.22
     .iManufacturer      = 0x01,
     .iProduct           = 0x02,
     .iSerialNumber      = 0x03,
@@ -244,4 +244,4 @@ TU_VERIFY_STATIC(sizeof(desc_ms_os_20) == MS_OS_20_DESC_LEN, "Incorrect size");
 uint8_t const * tud_descriptor_bos_cb(void)
 {
   return desc_bos;
-}
+}