Add the ESP8266 linker-script surgery and board build metadata

2026-10-04 02:05:59 +00:00 · 2026-08-24 18:46:47 -05:00
parent b3d9aa2d84
commit cdd8a16cb9
4 changed files with 293 additions and 0 deletions
@@ -0,0 +1,87 @@
+"""Tests for the linker-script surgery shared with the native toolchain."""
+
+from __future__ import annotations
+
+import pytest
+
+from esphome.components.esp8266.build_surgery import (
+    RATETABLE_RULE,
+    apply_testing_memory_patches,
+    relocate_ratetable,
+)
+
+_COMMON_LD_SNIPPET = """\
+  .dport0.data : ALIGN(4)
+  {
+    _dport0_data_start = ABSOLUTE(.);
+  } >dport0_0_seg :dport0_0_phdr
+  .data : ALIGN(4)
+  {
+    _data_start = ABSOLUTE(.);
+    *(.data)
+  } >dram0_0_seg :dram0_0_phdr
+"""
+
+_FLASH_LD_SNIPPET = """\
+MEMORY
+{
+  dport0_0_seg :                        org = 0x3FF00000, len = 0x10
+  dram0_0_seg :                         org = 0x3FFE8000, len = 0x14000
+  iram1_0_seg :                         org = 0x40100000, len = 0x8000
+  irom0_0_seg :                         org = 0x40201010, len = 0xfeff0
+}
+"""
+
+
+def test_relocate_ratetable_inserts_after_data_start() -> None:
+    patched = relocate_ratetable(_COMMON_LD_SNIPPET)
+    assert RATETABLE_RULE in patched
+    # Inserted after the .data section's anchor, not the .dport0.data one
+    assert patched.index("_data_start = ABSOLUTE(.);") < patched.index(RATETABLE_RULE)
+    assert patched.index(RATETABLE_RULE) < patched.index("*(.data)")
+    # Idempotent on an already-patched script
+    assert relocate_ratetable(patched) == patched
+
+
+def test_relocate_ratetable_requires_anchor() -> None:
+    with pytest.raises(RuntimeError, match="_data_start"):
+        relocate_ratetable("SECTIONS { }")
+
+
+def test_testing_memory_patches_enlarge_segments() -> None:
+    patched = apply_testing_memory_patches(_FLASH_LD_SNIPPET, require=())
+    assert (
+        "iram1_0_seg :                         org = 0x40100000, len = 0x200000"
+        in patched
+    )
+    assert (
+        "dram0_0_seg :                         org = 0x3FFE8000, len = 0x200000"
+        in patched
+    )
+    assert (
+        "irom0_0_seg :                         org = 0x40201010, len = 0x2000000"
+        in patched
+    )
+
+
+def test_segment_length() -> None:
+    from esphome.components.esp8266.build_surgery import segment_length
+
+    assert segment_length(_FLASH_LD_SNIPPET, "irom0_0_seg") == 0xFEFF0
+    assert segment_length(_FLASH_LD_SNIPPET, "missing_seg") is None
+
+
+def test_testing_memory_patches_require() -> None:
+    """A required segment the patch could not find raises instead of
+    silently keeping the real memory limits."""
+    patched = apply_testing_memory_patches(
+        _FLASH_LD_SNIPPET, require=("dram0_0_seg", "irom0_0_seg")
+    )
+    assert "0x2000000" in patched
+    with pytest.raises(RuntimeError, match="dram0_0_seg, irom0_0_seg"):
+        apply_testing_memory_patches(
+            "MEMORY { }", require=("dram0_0_seg", "irom0_0_seg")
+        )
+    # Segments a file does not require are patched opportunistically only
+    # With nothing required, unmatched content passes through unchanged
+    assert apply_testing_memory_patches("MEMORY { }", require=()) == "MEMORY { }"