ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
hal.h
Go to the documentation of this file.
1#pragma once
2
3#ifdef USE_LIBRETINY
4
5#include <cstdint>
6
7// For the inline millis() fast paths (xTaskGetTickCount, portTICK_PERIOD_MS).
8#include <FreeRTOS.h>
9#include <task.h>
10
13
14// IRAM_ATTR places a function in executable RAM so it is callable from an
15// ISR even while flash is busy (XIP stall, OTA, logger flash write). All
16// LibreTiny families that need it share the same .sram.text input section
17// name; how that section is routed into RAM differs per family:
18// RTL8720C: stock linker consumes *(.sram.text*) into .ram.code_text.
19// RTL8710B: patch_linker.py.script injects KEEP(*(.sram.text*)) at the
20// top of .ram_image2.data (which IS in ltchiptool's
21// sections_ram). The stock linker has KEEP(*(.image2.ram.text*))
22// in .ram_image2.text but that output section is NOT in
23// ltchiptool's AmebaZ elf2bin sections_ram list, so code routed
24// there is dropped from the flashed binary.
25// LN882H: patch_linker.py.script injects KEEP(*(.sram.text*)) into
26// .flash_copysection (> RAM0 AT> FLASH), after KEEP(*(.vectors))
27// so the Cortex-M4 vector table stays 512-byte-aligned for VTOR.
28//
29// BK72xx (all variants) are left as a no-op: their SDK wraps flash
30// operations in GLOBAL_INT_DISABLE() which masks FIQ + IRQ at the CPU for
31// the duration of every write, so no ISR fires while flash is stalled and
32// the race IRAM_ATTR guards against cannot occur. The trade-off is that
33// interrupts are delayed (not dropped) by up to ~20 ms during a sector
34// erase, but that is an SDK-level choice and cannot be changed from this
35// layer.
36#if defined(USE_BK72XX)
37#define IRAM_ATTR
38#else
39#define IRAM_ATTR __attribute__((noinline, section(".sram.text")))
40#endif
41#define PROGMEM
42
43#ifdef USE_BK72XX
44// Declared in the Beken FreeRTOS port (portmacro.h) and built in ARM mode so
45// it is callable from Thumb code via interworking. The MRS CPSR instruction
46// is ARM-only and user code here may be built in Thumb, so in_isr_context()
47// defers to this port helper on BK72xx instead of reading CPSR inline.
48// NOLINTNEXTLINE(readability-redundant-declaration)
50#endif
51
52// Forward decls from Arduino's <Arduino.h> for the inline wrappers below.
53// NOLINTBEGIN(google-runtime-int,readability-identifier-naming,readability-redundant-declaration)
54extern "C" void yield(void);
55extern "C" void delay(unsigned long ms);
56extern "C" unsigned long micros(void);
57extern "C" unsigned long millis(void);
58extern "C" void delayMicroseconds(unsigned int us);
59// NOLINTEND(google-runtime-int,readability-identifier-naming,readability-redundant-declaration)
60
61// Forward decls from libretiny's <lt_api.h> family for the inline arch_*
62// wrappers below. Pulling the full header would drag in the rest of the
63// LibreTiny C API.
64// NOLINTBEGIN(readability-redundant-declaration)
65extern "C" void lt_wdt_feed(void);
67extern "C" uint32_t lt_cpu_get_freq(void);
68// NOLINTEND(readability-redundant-declaration)
69
70namespace esphome::libretiny {}
71
72namespace esphome {
73
75__attribute__((always_inline)) inline bool in_isr_context() {
76#if defined(USE_BK72XX)
77 // BK72xx is ARM968E-S (ARM9); see extern declaration above.
79#else
80 // Cortex-M (AmebaZ, AmebaZ2, LN882H). IPSR is the active exception number;
81 // non-zero means we're in a handler.
82 uint32_t ipsr;
83 __asm__ volatile("mrs %0, ipsr" : "=r"(ipsr));
84 return ipsr != 0;
85#endif
86}
87
89__attribute__((always_inline)) inline bool is_main_loop_thread() {
90 return xTaskGetCurrentTaskHandle() == esphome_main_task_handle;
91}
92__attribute__((always_inline)) inline void yield() { ::yield(); }
93#if defined(USE_LIBRETINY_VARIANT_RTL8710B)
94// Already sleeps to a deadline (rtl8710b_micros.c)
95__attribute__((always_inline)) inline void delay(uint32_t ms) { ::delay(ms); }
96#else
97// vTaskDelay() counts the partial tick, so one more tick makes the wait at least ms
98__attribute__((always_inline)) inline void delay(uint32_t ms) {
99 vTaskDelay(ms == 0 ? 0 : (ms + portTICK_PERIOD_MS - 1) / portTICK_PERIOD_MS + 1);
100}
101#endif
102__attribute__((always_inline)) inline uint32_t micros() { return static_cast<uint32_t>(::micros()); }
103
104// Per-variant millis() fast path — matches MillisInternal::get().
105#if defined(USE_LIBRETINY_VARIANT_RTL8710B)
106// The RTL8710B tick is 976.6 us; millis() comes from the system timer instead (rtl8710b_micros.c)
107__attribute__((always_inline)) inline uint32_t millis() { return static_cast<uint32_t>(::millis()); }
108#elif defined(USE_RTL87XX) || defined(USE_LN882X)
109static_assert(configTICK_RATE_HZ == 1000, "millis() fast path requires 1 kHz FreeRTOS tick");
110__attribute__((always_inline)) inline uint32_t millis() {
111 // xTaskGetTickCountFromISR is mandatory in interrupt context per the FreeRTOS API contract.
112 return in_isr_context() ? xTaskGetTickCountFromISR() : xTaskGetTickCount();
113}
114#elif defined(USE_BK72XX)
115static_assert(configTICK_RATE_HZ == 500, "BK72xx millis() fast path assumes 500 Hz FreeRTOS tick");
116__attribute__((always_inline)) inline uint32_t millis() { return xTaskGetTickCount() * portTICK_PERIOD_MS; }
117#else
118__attribute__((always_inline)) inline uint32_t millis() { return static_cast<uint32_t>(::millis()); }
119#endif
120__attribute__((always_inline)) inline uint64_t millis_64() { return Millis64Impl::compute(millis()); }
121
122// NOLINTNEXTLINE(readability-identifier-naming)
123__attribute__((always_inline)) inline void delayMicroseconds(uint32_t us) { ::delayMicroseconds(us); }
124__attribute__((hot, always_inline)) inline void arch_feed_wdt() { lt_wdt_feed(); }
125__attribute__((always_inline)) inline uint32_t arch_get_cpu_cycle_count() { return lt_cpu_get_cycle_count(); }
126__attribute__((always_inline)) inline uint32_t arch_get_cpu_freq_hz() { return lt_cpu_get_freq(); }
127
128void arch_init();
129
130} // namespace esphome
131
132#endif // USE_LIBRETINY
struct @66::@67 __attribute__
Wake the main loop task from an ISR. ISR-safe.
Definition main_task.h:45
unsigned long millis(void)
void delay(unsigned long ms)
unsigned long micros(void)
void yield(void)
uint32_t platform_is_in_interrupt_context(void)
uint32_t lt_cpu_get_freq(void)
void delayMicroseconds(unsigned int us)
uint32_t lt_cpu_get_cycle_count(void)
void lt_wdt_feed(void)
TaskHandle_t esphome_main_task_handle
Main loop task handle and wake helpers — shared between wake.h (C++) and lwip_fast_select....
Definition main_task.c:4
uint32_t arch_get_cpu_cycle_count()
Definition hal.cpp:71
void arch_init()
Definition hal.cpp:44
void IRAM_ATTR HOT delayMicroseconds(uint32_t us)
Definition hal.cpp:48
uint32_t arch_get_cpu_freq_hz()
Definition hal.cpp:55
uint64_t millis_64()
Definition hal.cpp:29
uint32_t IRAM_ATTR HOT micros()
Definition hal.cpp:43
void arch_feed_wdt()
Definition hal.cpp:115
void HOT delay(uint32_t ms)
Definition hal.cpp:85
uint32_t IRAM_ATTR HOT millis()
Definition hal.cpp:25
static void uint32_t