Fix FreeRTOS CoreMutex shim to handle ISRs (earlephilhower#1442)

earlephilhower · web-flow · commit 652f9f9eda0d · 2023-05-23T10:12:52.000-07:00
* Fix FreeRTOS CoreMutex shim to handle ISRs Automatically check, when in FreeRTOS, if we're in an ISR and if so call the correct mutex grab. Thanks to @caveman99 for finding and proposing a solution! Fixes earlephilhower#1441 * Fix the CoreMutex destructor, too
diff --git a/cores/rp2040/CoreMutex.cpp b/cores/rp2040/CoreMutex.cpp
@@ -30,7 +30,7 @@ CoreMutex::CoreMutex(mutex_t *mutex, uint8_t option) {
     _option = option;
     if (__isFreeRTOS) {
         auto m = __get_freertos_mutex_for_ptr(mutex);
-        if (_option & FromISR) {
+        if (__freertos_check_if_in_isr()) {
             __freertos_mutex_take_from_isr(m);
         } else {
             if (!__freertos_mutex_try_take(m)) {
@@ -56,7 +56,7 @@ CoreMutex::~CoreMutex() {
     if (_acquired) {
         if (__isFreeRTOS) {
             auto m = __get_freertos_mutex_for_ptr(_mutex);
-            if (_option & FromISR) {
+            if (__freertos_check_if_in_isr()) {
                 __freertos_mutex_give_from_isr(m);
             } else {
                 __freertos_mutex_give(m);
diff --git a/cores/rp2040/CoreMutex.h b/cores/rp2040/CoreMutex.h
@@ -27,8 +27,7 @@
 #include "_freertos.h"
 
 enum {
-    DebugEnable = 1,
-    FromISR = 1 << 1,
+    DebugEnable = 1
 };
 
 class CoreMutex {
diff --git a/cores/rp2040/_freertos.h b/cores/rp2040/_freertos.h
@@ -37,6 +37,8 @@ extern "C" {
     typedef QueueHandle_t SemaphoreHandle_t;
 #endif
 
+    extern bool __freertos_check_if_in_isr() __attribute__((weak));
+
     extern SemaphoreHandle_t __freertos_mutex_create() __attribute__((weak));
     extern SemaphoreHandle_t _freertos_recursive_mutex_create() __attribute__((weak));
 
diff --git a/cores/rp2040/wiring_private.cpp b/cores/rp2040/wiring_private.cpp
@@ -77,7 +77,7 @@ static std::map<pin_size_t, CBInfo> _map;
 void _gpioInterruptDispatcher(uint gpio, uint32_t events) {
     (void) events;
     // Only need to lock around the std::map check, not the whole IRQ callback
-    CoreMutex m(&_irqMutex, (FromISR | DebugEnable));
+    CoreMutex m(&_irqMutex);
     if (m) {
         auto irq = _map.find(gpio);
         if (irq != _map.end()) {
diff --git a/libraries/FreeRTOS/src/variantHooks.cpp b/libraries/FreeRTOS/src/variantHooks.cpp
@@ -85,6 +85,10 @@ extern "C" {
     void __freertos_recursive_mutex_give(SemaphoreHandle_t mtx) {
         xSemaphoreGiveRecursive(mtx);
     }
+
+    bool __freertos_check_if_in_isr() {
+        return portCHECK_IF_IN_ISR();
+    }
 }
 
 
@@ -488,5 +492,3 @@ void __USBStart() {
     xTaskCreate(__usb, "USB", 256, 0, configMAX_PRIORITIES - 2, &__usbTask);
     vTaskCoreAffinitySet(__usbTask, 1 << 0);
 }
-
-

Original file line number	Diff line number	Diff line change
`@@ -85,6 +85,10 @@ extern "C" {`
`85`	`85`	`void __freertos_recursive_mutex_give(SemaphoreHandle_t mtx) {`
`86`	`86`	`xSemaphoreGiveRecursive(mtx);`
`87`	`87`	`}`
	`88`	`+`
	`89`	`+ bool __freertos_check_if_in_isr() {`
	`90`	`+ return portCHECK_IF_IN_ISR();`
	`91`	`+ }`
`88`	`92`	`}`
`89`	`93`
`90`	`94`
`@@ -488,5 +492,3 @@ void __USBStart() {`
`488`	`492`	`xTaskCreate(__usb, "USB", 256, 0, configMAX_PRIORITIES - 2, &__usbTask);`
`489`	`493`	`vTaskCoreAffinitySet(__usbTask, 1 << 0);`
`490`	`494`	`}`
`491`		`-`
`492`		`-`