wake.h

Go to the documentation of this file.

#pragma once
 
 
#include "esphome/core/defines.h"
#include "esphome/core/hal.h"
 
#if defined(USE_ESP32) || defined(USE_LIBRETINY)
#include "esphome/core/main_task.h"
#endif
#ifdef USE_ESP8266
#include <coredecls.h>
#elif defined(USE_RP2040)
#include <hardware/sync.h>
#include <pico/time.h>
#endif
 
namespace esphome {
 
// === Wake flag for ESP8266/RP2040 ===
#if defined(USE_ESP8266) || defined(USE_RP2040)
// NOLINTNEXTLINE(cppcoreguidelines-avoid-non-const-global-variables)
extern volatile bool g_main_loop_woke;
#endif
 
// === ESP32 / LibreTiny (FreeRTOS) ===
#if defined(USE_ESP32) || defined(USE_LIBRETINY)
 
__attribute__((always_inline)) inline void wake_main_task_any_context() {
  if (in_isr_context()) {
    BaseType_t px_higher_priority_task_woken = pdFALSE;
    esphome_main_task_notify_from_isr(&px_higher_priority_task_woken);
#ifdef portYIELD_FROM_ISR
    portYIELD_FROM_ISR(px_higher_priority_task_woken);
#else
    // ARM9 FreeRTOS port (BK72xx) does not define portYIELD_FROM_ISR; the IRQ
    // exit sequence performs the context switch if one was requested.
    (void) px_higher_priority_task_woken;
#endif
  } else {
    esphome_main_task_notify();
  }
}
 
void wake_loop_isrsafe(BaseType_t *px_higher_priority_task_woken);
void wake_loop_any_context();
 
inline void wake_loop_threadsafe() { esphome_main_task_notify(); }
 
namespace internal {
inline void wakeable_delay(uint32_t ms) {
  if (ms == 0) {
    yield();
    return;
  }
  ulTaskNotifyTake(pdTRUE, pdMS_TO_TICKS(ms));
}
}  // namespace internal
 
// === ESP8266 ===
#elif defined(USE_ESP8266)
 
inline void ESPHOME_ALWAYS_INLINE wake_loop_impl() {
  g_main_loop_woke = true;
  esp_schedule();
}
 
void wake_loop_any_context();
 
inline void wake_loop_threadsafe() { wake_loop_impl(); }
 
namespace internal {
inline void wakeable_delay(uint32_t ms) {
  if (ms == 0) {
    delay(0);
    return;
  }
  if (g_main_loop_woke) {
    g_main_loop_woke = false;
    return;
  }
  esp_delay(ms, []() { return !g_main_loop_woke; });
}
}  // namespace internal
 
// === RP2040 ===
#elif defined(USE_RP2040)
 
inline void wake_loop_any_context() {
  g_main_loop_woke = true;
  __sev();
}
 
inline void wake_loop_threadsafe() { wake_loop_any_context(); }
 
namespace internal {
void wakeable_delay(uint32_t ms);
}  // namespace internal
 
// === Host / Zephyr / other ===
#else
 
#ifdef USE_HOST
void wake_loop_threadsafe();
#else
inline void wake_loop_threadsafe() {}
#endif
 
inline void wake_loop_any_context() { wake_loop_threadsafe(); }
 
namespace internal {
inline void wakeable_delay(uint32_t ms) {
  if (ms == 0) {
    yield();
    return;
  }
  delay(ms);
}
}  // namespace internal
 
#endif
 
}  // namespace esphome