Merge pull request #15 from pimoroni/patch-multicore

CI: HACK: Add multicore lockout patch backport.

boards/multicore_lockout.patch

@@ -0,0 +1,103 @@
+From c51bb5124feb6a3afa9a7612a65b6bab5774e63e Mon Sep 17 00:00:00 2001
+From: graham sanderson <graham.sanderson@raspberrypi.com>
+Date: Sun, 2 Feb 2025 12:14:31 -0600
+Subject: [PATCH 1/2] add multicore_lockout_victim_deinit. clear lockedout_flag
+ for core1 during core1 reset
+
+---
+ .../pico_multicore/include/pico/multicore.h   |  7 +++++
+ src/rp2_common/pico_multicore/multicore.c     | 26 ++++++++++++++-----
+ 2 files changed, 27 insertions(+), 6 deletions(-)
+
+diff --git a/src/rp2_common/pico_multicore/include/pico/multicore.h b/src/rp2_common/pico_multicore/include/pico/multicore.h
+index c452b9822..20eba780d 100644
+--- a/src/rp2_common/pico_multicore/include/pico/multicore.h
++++ b/src/rp2_common/pico_multicore/include/pico/multicore.h
+@@ -449,6 +449,13 @@ static inline uint multicore_doorbell_irq_num(uint doorbell_num) {
+  */
+ void multicore_lockout_victim_init(void);
+
++/*! \brief Stop the current core being able to be a "victim" of lockout (i.e. forced to pause in a known state by the other core)
++ *  \ingroup multicore_lockout
++ *
++ * This code unhooks the intercore FIFO IRQ, and the FIFO mayt be used for any other purpose after this.
++ */
++void multicore_lockout_victim_deinit(void);
++
+ /*! \brief Determine if \ref multicore_lockout_victim_init() has been called on the specified core.
+  *  \ingroup multicore_lockout
+  *
+diff --git a/src/rp2_common/pico_multicore/multicore.c b/src/rp2_common/pico_multicore/multicore.c
+index c495b4ae3..f8f5660db 100644
+--- a/src/rp2_common/pico_multicore/multicore.c
++++ b/src/rp2_common/pico_multicore/multicore.c
+@@ -23,12 +23,11 @@
+ #endif
+ #endif
+
+-// note that these are not reset by core reset, however for now, I think people resetting cores
+-// and then relying on multicore_lockout for that core without re-initializing, is probably
+-// something we can live with breaking.
+-//
+-// whilst we could clear this in core 1 reset path, that doesn't necessarily catch all,
+-// and means pulling in this array even if multicore_lockout is not used.
++// Note that there is no automatic way for us to clear these flags when a particular core is reset, and yet
++// we DO ideally want to clear them, as the `multicore_lockout_victim_init()` checks the flag for the current core
++// and is a no-op if set. We DO have a new `multicore_lockout_victim_deinit()` method, which can be called in a pinch after
++// the reset before calling `multicore_lockout_victim_init()` again, so that is good. We will reset the flag
++// for core1 in `multicore_reset_core1()` though as a convenience since most people will use that to reset core 1.
+ static bool lockout_victim_initialized[NUM_CORES];
+
+ void multicore_fifo_push_blocking(uint32_t data) {
+@@ -118,6 +117,9 @@ void multicore_reset_core1(void) {
+     bool enabled = irq_is_enabled(irq_num);
+     irq_set_enabled(irq_num, false);
+
++    // Core 1 will be in un-initialized state
++    lockout_victim_initialized[1] = false;
++
+     // Bring core 1 back out of reset. It will drain its own mailbox FIFO, then push
+     // a 0 to our mailbox to tell us it has done this.
+     *power_off_clr = PSM_FRCE_OFF_PROC1_BITS;
+@@ -243,6 +245,18 @@ void multicore_lockout_victim_init(void) {
+     lockout_victim_initialized[core_num] = true;
+ }
+
++void multicore_lockout_victim_deinit(void) {
++    uint core_num = get_core_num();
++    if (lockout_victim_initialized[core_num]) {
++        // On platforms other than RP2040, these are actually the same IRQ number
++        // (each core only sees its own IRQ, always at the same IRQ number).
++        uint fifo_irq_this_core = SIO_FIFO_IRQ_NUM(core_num);
++        irq_remove_handler(fifo_irq_this_core, multicore_lockout_handler);
++        irq_set_enabled(fifo_irq_this_core, false);
++        lockout_victim_initialized[core_num] = false;
++    }
++}
++
+ static bool multicore_lockout_handshake(uint32_t magic, absolute_time_t until) {
+     uint irq_num = SIO_FIFO_IRQ_NUM(get_core_num());
+     bool enabled = irq_is_enabled(irq_num);
+
+From cd9ee9704228d839057b623426ca5b1aa741c0a1 Mon Sep 17 00:00:00 2001
+From: graham sanderson <graham.sanderson@raspberrypi.com>
+Date: Mon, 3 Feb 2025 12:08:22 -0600
+Subject: [PATCH 2/2] typo
+
+---
+ src/rp2_common/pico_multicore/include/pico/multicore.h | 2 +-
+ 1 file changed, 1 insertion(+), 1 deletion(-)
+
+diff --git a/src/rp2_common/pico_multicore/include/pico/multicore.h b/src/rp2_common/pico_multicore/include/pico/multicore.h
+index 20eba780d..5eb49ddce 100644
+--- a/src/rp2_common/pico_multicore/include/pico/multicore.h
++++ b/src/rp2_common/pico_multicore/include/pico/multicore.h
+@@ -452,7 +452,7 @@ void multicore_lockout_victim_init(void);
+ /*! \brief Stop the current core being able to be a "victim" of lockout (i.e. forced to pause in a known state by the other core)
+  *  \ingroup multicore_lockout
+  *
+- * This code unhooks the intercore FIFO IRQ, and the FIFO mayt be used for any other purpose after this.
++ * This code unhooks the intercore FIFO IRQ, and the FIFO may be used for any other purpose after this.
+  */
+ void multicore_lockout_victim_deinit(void);
+

ci/micropython.sh

@@ -53,9 +53,11 @@ function ci_micropython_clone {
     git submodule update --init lib/tinyusb
     git submodule update --init lib/btstack
     cd "$CI_BUILD_ROOT"
-    log_inform "HACK: cyw43 stability backport for Pico2 W. See: https://github.com/raspberrypi/pico-sdk/pull/2209"
     cd "$CI_BUILD_ROOT/micropython/lib/pico-sdk"
+    log_inform "HACK: cyw43 stability backport for Pico2 W. See: https://github.com/raspberrypi/pico-sdk/pull/2209"
     git apply "$CI_PROJECT_ROOT/boards/pico2_w_cyw43.patch"
+    log_inform "HACK: backport multicore lockout fix. See: https://github.com/raspberrypi/pico-sdk/pull/2223"
+    git apply "$CI_PROJECT_ROOT/boards/multicore_lockout.patch"
     cd "$CI_BUILD_ROOT"
 }