@typecad/framework-zephyr 1.0.0-alpha.14 → 1.0.0-alpha.16

package/src/toolchain/scaffold.ts

@@ -10,7 +10,9 @@
 import { writeFileSync, existsSync, mkdirSync, readFileSync, readdirSync } from 'node:fs';
 import { join } from 'node:path';
 import { resolveKconfigFragments, type KconfigUsage } from '../dt-config/kconfig.js';
+import { scanSensorParts } from './index.js';
 import { readCuttlefishLibrarySidecar } from '@typecad/cuttlefish/library-packages';
+import { SENSOR_PART_INFO } from '@typecad/hal';
 
 /** Write a file only if the content differs from the existing file.
  *  Returns true when the file was written (content changed or file was new). */
@@ -123,17 +125,28 @@ export function scaffoldZephyrProject(projectRoot: string, debug = false, userKc
     usesDac: uses('dac_') || uses('__tc_dac'),
     usesFS: uses('__tc_fs'),
     usesHwtimer: uses('counter_') || uses('__tc_hw'),
-    usesI2c: uses('i2c_'),
-    usesSpi: uses('spi_'),
-    usesUart: uses('uart_'),
+    // The __tc_<bus> alternative matches the shim's state block — a program
+    // that only calls begin() emits `(void)__tc_i2c1_dev;` (no driver API
+    // call yet), but the shim still declared DEVICE_DT_GET(DT_NODELABEL(...))
+    // so the overlay must enable the node or the device symbol is missing.
+    usesI2c: uses('i2c_') || uses('__tc_i2c'),
+    // DT-bound sensor parts: the __tc_sensor_* state references and the
+    // sensor_sample_fetch/sensor_channel_get calls both carry the token.
+    usesSensor: uses('sensor_') || uses('__tc_sensor'),
+    usesFloatFormat: /%[-0-9.]*[eEfFgG]/.test(src),
+    usesSpi: uses('spi_') || uses('__tc_spi'),
+    usesUart: uses('uart_') || uses('__tc_uart'),
+    // USB CDC serial: every usb.* lowering calls into the __tc_usb<N>_* shim
+    // (device + init helper emitted under usesUsb).
+    usesUsb: uses('__tc_usb'),
+    // STM32F4 DBGMCU keep-SWD-alive init present (emitted for stm32f4 socs).
+    usesStm32DebugSleep: uses('__tc_stm32_dbgmcu'),
     usesWdt: uses('wdt_'),
     usesBle: uses('bt_') || uses('bt_gatt') || uses('bt_le_'),
     usesDisplay: uses('display_write') || uses('display_init') || uses('display_fill_rect') || uses('__tc_display_dev') || uses('CuttlefishDisplayTarget'),
     usesTouch: uses('ft6336u') || uses('touch_'),
-    // Power tokens: k_sleep + pm_state_force / PM_STATE_* (what power.ts emits).
-    // The old `power_` token matched nothing the power HAL emits and collides
-    // with tx_power_dbm — removed.
-    usesPower: uses('pm_') || uses('k_sleep') || uses('PM_STATE_'),
+    // (The power HAL is removed; its former pm_/k_sleep token scan is gone —
+    // nothing here must match tx_power_dbm's `power` substring.)
     usesWifi: uses('wifi_') || uses('net_mgmt') || uses('conn_mgr'),
     // HTTP: the __tc_http_* shim + http_client_req + getaddrinfo. The '_'-anchored
     // 'http_' token matches __tc_http_* and http_client_req (the core HTTP lib
@@ -166,6 +179,12 @@ export function scaffoldZephyrProject(projectRoot: string, debug = false, userKc
     '# Auto-generated by @typecad/framework-zephyr from cuttlefish.config.ts.',
     'cmake_minimum_required(VERSION 3.20.0)',
     '',
+    '# The app is its own board root: MCU-only targets generate an out-of-tree',
+    '# custom board under boards/typecad/<name>/ that Zephyr must discover.',
+    '# Harmless when boards/ holds only .overlay files (BOARD_ROOT just needs',
+    '# the directory to exist).',
+    'list(APPEND BOARD_ROOT ${CMAKE_CURRENT_SOURCE_DIR})',
+    '',
     'find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})',
     '',
     'project(zephyr_app)',
@@ -248,6 +267,18 @@ export function scaffoldZephyrProject(projectRoot: string, debug = false, userKc
       }
     }
   }
+  // Per-part Kconfig exceptions: catalog parts whose driver is NOT default-y
+  // on its DT node carry extra lines here (empty today — every in-tree sensor
+  // driver lights up from the node; the path exists so the first exception
+  // found by the generator has somewhere to go).
+  const sensorParts = scanSensorParts(src);
+  if (sensorParts.length > 0) {
+    const extra = [...new Set(sensorParts.flatMap((sp) => SENSOR_PART_INFO[sp.part]?.kconfig ?? []))];
+    if (extra.length > 0) {
+      prjConf.push('', '# Sensor part Kconfig (catalog exceptions).');
+      for (const line of extra) prjConf.push(line);
+    }
+  }
   // Emit user-specified Kconfig from cuttlefish.config.ts zephyr.kconfig.
   // These override any matching auto-detected symbol (skipped above).
   if (userKconfig) {

package/src/toolchain/west-discover.ts

@@ -46,13 +46,14 @@ function pythonRunsWest(exe: string): boolean {
   }
 }
 
-/** True if `cmd` runs `west --version` successfully. */
+/** True if `cmd` runs `west --version` successfully. `cmd` comes from
+ * `where`/`which` output — a venv launcher (west.exe) or script path, spawned
+ * without a shell like every other command in this module. */
 function westOnPath(cmd: string): boolean {
   try {
     const r = spawnSync(cmd, ['--version'], {
       encoding: 'utf8',
       timeout: 15_000,
-      shell: IS_WIN,
       windowsHide: true,
     });
     return r.status === 0;
@@ -100,12 +101,11 @@ export function isZephyrBase(dir: string): boolean {
 // ── Strategy 1: `west` on PATH ──────────────────────────────────────────────
 
 export function discoverFromPath(): WestInstall | null {
-  // shell only on Windows (where.exe resolution through cmd) — an args array
-  // with shell: true triggers Node's DEP0190 deprecation warning on Linux/
-  // macOS, where `which` is a plain executable that needs no shell.
+  // No shell: `where`/`which` are plain executables Node resolves from PATH
+  // (where.exe is a real PE, not a cmd builtin), and an args array with a
+  // truthy shell triggers Node's DEP0190 deprecation warning.
   const which = spawnSync(IS_WIN ? 'where' : 'which', ['west'], {
     encoding: 'utf8',
-    shell: IS_WIN,
     windowsHide: true,
   });
   if (which.status !== 0) return null;
@@ -190,6 +190,19 @@ function readMicromambaEnvVar(envDir: string, varName: string): string | undefin
   return undefined;
 }
 
+/** The installer-written ZEPHYR_BASE of the micromamba env, fs-only (no
+ *  spawn) — the cheap probe shared by board-catalog overlay discovery.
+ *  Undefined when the installer env or its env-vars file is absent. */
+export function micromambaZephyrBase(
+  envName: string = process.env.TYPECAD_ZEPHYR_ENV || 'zephyr',
+): string | undefined {
+  const mm = findMicromamba();
+  if (!mm) return undefined;
+  const envDir = join(mm.rootPrefix, 'envs', envName);
+  const zb = readMicromambaEnvVar(envDir, 'TYPECAD_ZEPHYR_BASE');
+  return zb && isZephyrBase(zb) ? zb : undefined;
+}
+
 export function discoverFromMicromamba(
   envName: string = process.env.TYPECAD_ZEPHYR_ENV || 'zephyr',
 ): WestInstall | null {

package/src/async/timer-polyfill.ts

@@ -1,107 +0,0 @@
-// ---------------------------------------------------------------------------
-// Timer methods polyfill — Zephyr k_timer + k_work (heap-free)
-//
-// setInterval / setTimeout / clearInterval / clearTimeout backed by a fixed
-// pool of k_timer + k_work pairs. The timer's expiry function (ISR context)
-// submits a k_work item to the system workqueue; the work handler runs the
-// user callback in thread context. This split keeps the ISR cheap and lets the
-// callback run on a real thread (so it can do real work — but must not block,
-// since the system workqueue is shared).
-//
-// EMIT BOUNDARY: emitted bytes land in user firmware. Covered by the TypeCAD
-// Runtime Exception (RUNTIME_EXCEPTION.md at the repo root).
-// ---------------------------------------------------------------------------
-
-import type { RuntimePolyfillIR } from '@typecad/cuttlefish/api/shared';
-
-const MIN_TIMERS = 1;
-const MAX_TIMERS_CAP = 16;
-
-export interface TimerPolyfillIR extends RuntimePolyfillIR {
-  /** The clamped pool size the C++ was generated with. */
-  maxTimers: number;
-}
-
-/**
- * Build the timer_methods polyfill IR. `requestedTimers` is sized from
- * ctx.analysis.timerCallCount; it is clamped to [1, 16].
- */
-export function buildTimerPolyfill(requestedTimers: number): TimerPolyfillIR {
-  const maxTimers = Math.min(MAX_TIMERS_CAP, Math.max(MIN_TIMERS, requestedTimers));
-
-  const helperStructs = [`
-// cuttlefish timer runtime — k_timer + k_work pool (heap-free).
-struct __tc_TimerSlot {
-    struct k_timer timer;
-    struct k_work work;
-    void (*callback)(void);
-    bool active;
-};
-
-static struct __tc_TimerSlot __tc_timer_slots[${maxTimers}];
-
-static void __tc_timer_work_handler(struct k_work* w) {
-    // Runs on the system workqueue thread (NOT ISR). Find the owning slot by
-    // address and invoke the callback. Must not block.
-    for (int32_t i = 0; i < ${maxTimers}; i++) {
-        if (&__tc_timer_slots[i].work == w) {
-            if (__tc_timer_slots[i].callback != nullptr) { __tc_timer_slots[i].callback(); }
-            return;
-        }
-    }
-}
-
-static void __tc_timer_expiry_fn(struct k_timer* t) {
-    // ISR context: submit the work item, do NOT run the callback here.
-    for (int32_t i = 0; i < ${maxTimers}; i++) {
-        if (&__tc_timer_slots[i].timer == t) {
-            (void)k_work_submit(&__tc_timer_slots[i].work);
-            return;
-        }
-    }
-}
-
-static int32_t __tc_timer_add(void (*cb)(void), int32_t ms, bool repeat) {
-    for (int32_t i = 0; i < ${maxTimers}; i++) {
-        if (!__tc_timer_slots[i].active) {
-            __tc_timer_slots[i].callback = cb;
-            __tc_timer_slots[i].active = true;
-            k_timer_init(&__tc_timer_slots[i].timer, __tc_timer_expiry_fn, nullptr);
-            k_work_init(&__tc_timer_slots[i].work, __tc_timer_work_handler);
-            k_timer_start(&__tc_timer_slots[i].timer, K_MSEC(ms), repeat ? K_MSEC(ms) : K_FOREVER);
-            return i + 1;  // 1-based id (Arduino parity)
-        }
-    }
-    return 0;  // pool full
-}
-
-static void __tc_timer_clear(int32_t id) {
-    if (id > 0 && id <= ${maxTimers}) {
-        int32_t i = id - 1;
-        k_timer_stop(&__tc_timer_slots[i].timer);
-        __tc_timer_slots[i].active = false;
-        __tc_timer_slots[i].callback = nullptr;
-    }
-}
-`];
-
-  const helperFunctions = [`
-int32_t __tc_setInterval(void (*cb)(), int32_t ms) { return __tc_timer_add(cb, ms, true); }
-int32_t __tc_setTimeout(void (*cb)(), int32_t ms) { return __tc_timer_add(cb, ms, false); }
-void __tc_clearInterval(int32_t id) { __tc_timer_clear(id); }
-void __tc_clearTimeout(int32_t id) { __tc_timer_clear(id); }
-`];
-
-  return {
-    kind: 'polyfill',
-    id: 'timer_methods',
-    domain: 'embedded',
-    requiredIncludes: [],
-    forwardDeclarations: [],
-    helperStructs,
-    helperFunctions,
-    shimMacros: [],
-    dependencies: [],
-    maxTimers,
-  };
-}

package/src/chips/esp32.ts

@@ -1,74 +0,0 @@
-// ---------------------------------------------------------------------------
-// Espressif ESP32 (esp32_devkitc) — Zephyr board descriptor
-//
-// Board target: `esp32_devkitc` (mainline Zephyr,
-// boards/espressif/esp32_devkitc). Programmed over USB via the esptool runner
-// (see toolchain/index.ts), the same flash path as the ESP32-S3.
-//
-// GPIO is split across TWO devicetree controllers — `gpio0` (pins 0–31) and
-// `gpio1` (pins 32–39) — so this descriptor lists both in `gpioControllers`.
-// The lowering routes each HAL pin to its owning controller at runtime; see
-// chips/controllers.ts. (Same shape as the S3, but the ESP32's highest GPIO is
-// 39, not 48 — `gpio1` has ngpios=8, not 17.)
-//
-// Minimal-by-design: the only DT facts carried here are the ones a compile-time
-// DT macro cannot reach — the runtime pin→controller split, plus the `sw0`
-// alias for the BOOT button (used by the devicetree-spec GPIO path). Every other
-// DT fact (UART/I2C/SPI/`wdt` nodelabels) is resolved by Zephyr's own
-// devicetree via emitted DT_NODELABEL macros, not hand-copied here.
-//
-// Verified against the Zephyr board DTS:
-//   boards/espressif/esp32_devkitc/esp32_devkitc_procpu.dts
-//   aliases { sw0 = &button0; } → button_0: pin 0 on gpio0, active-low + pull-up
-//   &gpio0/&gpio1 { status = "okay" }   (esp32_devkitc_procpu.dts:64-70)
-//   &wifi { status = "okay" }            (esp32_devkitc_procpu.dts:143-145)
-// GPIO controller coverage:
-//   dts/xtensa/espressif/esp32/esp32_common.dtsi:314-337
-//   gpio0: ngpios = <32>  (pins 0–31)
-//   gpio1: ngpios = <8>   (pins 32–39)
-//
-// Note: GPIO 34–39 are input-only pads on ESP32 silicon (not modeled here —
-// the DT does not encode output restrictions per pin; an output config on those
-// pins fails at runtime against the raw controller, which is the expected
-// silicon-accurate behavior).
-// ---------------------------------------------------------------------------
-
-import type { ZephyrChipDescriptor } from './types.js';
-
-export const ESP32_DEVKITC: ZephyrChipDescriptor = {
-  id: 'esp32_devkitc',
-  soc: 'esp32',
-  gpioController: 'gpio0',
-  gpioControllers: [
-    { nodelabel: 'gpio0', minPin: 0, maxPin: 31 },
-    { nodelabel: 'gpio1', minPin: 32, maxPin: 39 },
-  ],
-  gpio: {
-    // The BOOT button (GPIO0) is the board's only DT-aliased GPIO. Listed so a
-    // program reading/interrupting pin 0 goes through the polarity-correct
-    // devicetree-spec path (GPIO_ACTIVE_LOW honored by the DT flags).
-    dtSpecs: [
-      { pin: 0, dtSpec: 'sw0' },  // BOOT button (GPIO0)
-    ],
-    interruptPins: [
-      { pin: 0, dtSpec: 'sw0' },  // BOOT button (GPIO0)
-    ],
-  },
-  // WiFi: the ESP32 has a 2.4GHz radio; conn_mgr + the esp32 wifi driver
-  // (CONFIG_WIFI_ESP32) provide connectivity. WIFI_ESP32 depends on !SMP, and
-  // the ESP32 is AMP (dual-image procpu/appcpu), not SMP, by default — so the
-  // dependency is satisfied. Omitted on radioless targets.
-  wifi: { supported: true },
-  // DAC: the ESP32 has two 8-bit DAC channels on GPIO25 (channel 1) and GPIO26
-  // (channel 2). The Zephyr esp32 DAC driver (drivers/dac/dac_esp32.c) exposes
-  // them via the `dac0` node; the lowering emits dac_channel_setup +
-  // dac_write_value against DEVICE_DT_GET(DT_NODELABEL(dac0)). The overlay
-  // enables the node when the program uses dac.*. ESP32-S3 has no DAC.
-  dac: {
-    device: 'dac0',
-    channels: [
-      { pin: 25, channel: 1, resolution: 8 },
-      { pin: 26, channel: 2, resolution: 8 },
-    ],
-  },
-};

package/src/chips/esp32s3.ts

@@ -1,57 +0,0 @@
-// ---------------------------------------------------------------------------
-// Espressif ESP32-S3 (esp32s3_devkitc) — Zephyr board descriptor
-//
-// Board target: `esp32s3_devkitc` (mainline Zephyr,
-// boards/espressif/esp32s3_devkitc). Programmed over USB via the esptool
-// runner (see toolchain/index.ts), unlike the J-Link/nrfjprog path used for
-// the XIAO nRF52840.
-//
-// GPIO is split across TWO devicetree controllers — `gpio0` (pins 0–31) and
-// `gpio1` (pins 32–48) — so this descriptor lists both in `gpioControllers`.
-// The lowering routes each HAL pin to its owning controller at runtime; see
-// chips/controllers.ts.
-//
-// Minimal-by-design: the only DT facts carried here are the ones a
-// compile-time DT macro cannot reach — the runtime pin→controller split, plus
-// the `sw0` alias for the BOOT button (used by the devicetree-spec GPIO path).
-// Every other DT fact (UART/I2C/SPI/`wdt` nodelabels) is resolved by Zephyr's
-// own devicetree via emitted DT_NODELABEL macros, not hand-copied here.
-//
-// Verified against the Zephyr board DTS:
-//   boards/espressif/esp32s3_devkitc/esp32s3_devkitc_procpu.dts
-//   aliases { sw0 = &button0; } → button_0: pin 0 on gpio0, active-low + pull-up
-//   (the DevKitC board DTS defines no led0 alias — the onboard RGB is a WS2812
-//   on GPIO38, not a plain GPIO LED, so it is intentionally NOT listed here.)
-// ---------------------------------------------------------------------------
-
-import type { ZephyrChipDescriptor } from './types.js';
-
-export const ESP32S3_DEVKITC: ZephyrChipDescriptor = {
-  id: 'esp32s3_devkitc',
-  soc: 'esp32s3',
-  gpioController: 'gpio0',
-  gpioControllers: [
-    { nodelabel: 'gpio0', minPin: 0, maxPin: 31 },
-    { nodelabel: 'gpio1', minPin: 32, maxPin: 48 },
-  ],
-  gpio: {
-    // The BOOT button (GPIO0) is the board's only DT-aliased GPIO. Listed so a
-    // program reading/interrupting pin 0 goes through the polarity-correct
-    // devicetree-spec path (GPIO_ACTIVE_LOW honored by the DT flags). Every
-    // other GPIO pin uses the raw-controller path against its owning controller.
-    dtSpecs: [
-      { pin: 0, dtSpec: 'sw0' },  // BOOT button (GPIO0)
-    ],
-    interruptPins: [
-      { pin: 0, dtSpec: 'sw0' },  // BOOT button (GPIO0)
-    ],
-  },
-  // UART/I2C/SPI/`wdt` are intentionally omitted: their devicetree nodelabels
-  // (uart0/uart1/uart2, i2c0/i2c1, spi2/spi3, wdt0) are resolved by Zephyr's
-  // devicetree at compile time and don't need to be carried as data here. ADC is
-  // omitted as well — added when a demo needs analog reads, with the verified
-  // ESP32-S3 ADC1/ADC2 pin→channel map.
-  // WiFi: the ESP32-S3 has a 2.4GHz radio; conn_mgr + the esp32 wifi driver
-  // (CONFIG_WIFI_ESP32) provide connectivity. Omitted on radioless targets.
-  wifi: { supported: true },
-};

package/src/chips/xiao-ble.ts

@@ -1,82 +0,0 @@
-// ---------------------------------------------------------------------------
-// Seeed Studio XIAO nRF52840 — Zephyr board descriptor
-//
-// Board target: `xiao_ble` (mainline Zephyr, boards/seeed/xiao_ble).
-// The onboard user LED is active-low and exposed as the DT alias `led0`.
-// ---------------------------------------------------------------------------
-
-import type { ZephyrChipDescriptor } from './types.js';
-
-export const XIAO_BLE: ZephyrChipDescriptor = {
-  id: 'xiao_ble',
-  soc: 'nrf52840',
-  gpioController: 'gpio0',
-    // GPIO is split across two devicetree controllers: gpio0 (P0.00–P0.31)
-    // and gpio1 (P1.00–P1.15, HAL pins 32–47). Declaring the split makes the
-    // raw path emit the port-relative index against gpio1 (P1.11 = raw 11),
-    // which NRF_GPIO_PIN_MAP(1, 11) resolves to absolute pin 43 — the same
-    // physical pin the old single-controller form reached only by accident:
-    // gpio0 + global 43 also maps to 43 (MAP(0, 43) = 43), but that form
-    // trips the generic layer's port_pin_mask __ASSERT ("Unsupported pin",
-    // gpio0's mask covers 0–31) on any assert-enabled build.
-  gpioControllers: [
-    { nodelabel: 'gpio0', minPin: 0, maxPin: 31 },
-    { nodelabel: 'gpio1', minPin: 32, maxPin: 47 },
-  ],
-  gpio: {
-    dtSpecs: [
-      // Onboard RGB LEDs — active-low (GPIO_ACTIVE_LOW in xiao_ble_common.dtsi).
-      // Verified against the board's `aliases { led0 = &led0; led1 = &led1; led2 = &led2; }`.
-      { pin: 26, dtSpec: 'led0' },  // Red   (P0.26)
-      { pin: 30, dtSpec: 'led1' },  // Green (P0.30)
-      { pin: 6, dtSpec: 'led2' },   // Blue  (P0.06)
-    ],
-    // The XIAO nRF52840 has a user button on P0.04, but mainline Zephyr's
-    // xiao_ble board (verified against Zephyr 4.3.99) does NOT expose it as a
-    // DT `sw0` alias — there is no gpio-keys node in xiao_ble.dts. Emitting
-    // GPIO_DT_SPEC_GET(DT_ALIAS(sw0), gpios) therefore fails to compile
-    // ('DT_N_ALIAS_sw0_... was not declared'). Until a button node + alias is
-    // added (via an overlay or an upstream board update), interruptPins stays
-    // empty: attachInterrupt on this board lowers to the no-DT-spec comment
-    // fallback rather than a hard compile error.
-    interruptPins: [],
-  },
-  // The XIAO connector wiring (from seeed_xiao_connector.dtsi + xiao_ble-pinctrl.dtsi):
-  //   xiao_i2c     → i2c1  (SDA P0.04/D4, SCL P0.05/D5)
-  //   xiao_spi     → spi2  (SCK P1.13/D8, MOSI P1.15/D10, MISO P1.14/D9)
-  //   xiao_serial  → uart0 (TX P1.11/D6, RX P1.12/D7)
-  // The board DTS leaves i2c0/spi0/spi1 disabled (shared instances).
-  i2c: {
-    controllers: [{ nodeLabel: 'i2c1' }],
-  },
-  spi: {
-    controllers: [{ nodeLabel: 'spi2' }],
-  },
-  uart: {
-    controllers: [{ nodeLabel: 'uart0' }],
-  },
-  pwm: {
-    // pwm-led0 drives the board PWM LED (PWM_OUT0 on P0.17, inverted).
-    specs: [{ pin: 17, dtSpec: 'pwm-led0' }],
-  },
-  adc: {
-    // SAADC node is `adc`; no pre-declared channels. XIAO D0–D3 = AIN0–AIN3
-    // (P0.02/P0.03/P0.28/P0.29). Internal VREF ~0.6V with VDD/4 gain ⇒ 3000mV.
-    nodeLabel: 'adc',
-    resolution: 12,
-    vrefMv: 3000,
-    channels: [
-      { pin: 2, channel: 0 },   // P0.02 / D0 / AIN0
-      { pin: 3, channel: 1 },   // P0.03 / D1 / AIN1
-      { pin: 28, channel: 2 },  // P0.28 / D2 / AIN2
-      { pin: 29, channel: 3 },  // P0.29 / D3 / AIN3
-    ],
-  },
-  wdt: { nodeLabel: 'wdt0' },
-  // Hardware timer: nRF RTC1 is the free counter (RTC0 is kernel-owned by the
-  // softdevice/clock driver). The hwtimer lowering drives it as a Zephyr
-  // counter device (counter_start/stop + a top-value alarm for set_frequency).
-  // Verified against the nRF52840 SoC dtsi (rtc0/rtc1 nodes). The kernel uses
-  // RTC0 for the system tick; RTC1 is available for application use.
-  hwtimer: { controllers: [{ nodeLabel: 'rtc1' }] },
-};

package/src/lowering/power.ts

@@ -1,70 +0,0 @@
-// ---------------------------------------------------------------------------
-// Power lowering — Zephyr power management
-//
-// Zephyr enters low-power states from the idle thread per policy. The app-facing
-// controls are pm_state_force (override policy to force a state on next idle)
-// and k_sleep (block the calling thread, allowing the system to idle into a
-// low-power state). "Deep sleep" maps to k_sleep (the SoC picks its deepest
-// allowed state); "light sleep" best-effort forces SUSPEND_TO_IDLE.
-//
-// deep_sleep_pin configures the wake GPIO as an interrupt source then k_sleeps
-// (the interrupt wakes the SoC). CPU frequency is SoC-specific (nRF52 has a
-// fixed 64 MHz HFXO with no portable dynamic scaling) and stays a documented
-// no-op. deep_sleep_pin targets gpio0 (single-controller nRF52840 case);
-// multi-controller SoC routing is a documented follow-on.
-// ---------------------------------------------------------------------------
-
-import type { HALOpIR } from '@typecad/cuttlefish/api/shared';
-
-/**
- * Resolve a HAL power.* op to Zephyr C++.
- * Returns `{ code }` for statement ops, `{ expression }` for value-returning ops.
- */
-export function lowerPower(op: HALOpIR): { code?: string; expression?: string } {
-  const o = op as any;
-
-  switch (op.operation) {
-    case 'power.deep_sleep':
-      // Block for the requested duration; the idle thread + PM policy will enter
-      // the deepest state the SoC allows during the sleep.
-      return { code: `k_sleep(K_MSEC(${o.ms}));` };
-    case 'power.light_sleep':
-      // Best-effort: force a shallow suspend on the next idle. pm_state_force
-      // requires a pm_state_info; SUSPEND_TO_IDLE is a common shallow state.
-      return { code: `pm_state_force(0, &(const struct pm_state_info){ .state = PM_STATE_SUSPEND_TO_IDLE, .substate_id = 0 });` };
-    case 'power.set_cpu_frequency':
-      // nRF52 has a fixed 64 MHz HFXO; no portable dynamic scaling from C++.
-      // Documented no-op (best-effort), matching Arduino's approach.
-      return { code: `/* power.set_cpu_frequency(${o.mhz}): nRF52 fixed 64 MHz HFXO — no portable scaling */` };
-    case 'power.deep_sleep_pin': {
-      // Configure the pin as a GPIO wake source (level interrupt), then k_sleep
-      // until the interrupt fires. A static gpio_callback + a no-op handler (the
-      // wake just needs the interrupt enabled; the handler does nothing). level:
-      // 1=high, 0=low. Targets gpio0 (single-controller nRF52840); multi-
-      // controller SoC routing is a documented follow-on.
-      const pin = o.pin;
-      const level = o.level;
-      const flags = level ? 'GPIO_INT_LEVEL_HIGH' : 'GPIO_INT_LEVEL_LOW';
-      return {
-        code: [
-          '{',
-          `    static struct gpio_callback __tc_wake_cb;`,
-          `    const struct device* __dev = DEVICE_DT_GET(DT_NODELABEL(gpio0));`,
-          `    gpio_pin_configure(__dev, ${pin}, GPIO_INPUT);`,
-          `    gpio_init_callback(&__tc_wake_cb, [](const struct device*, struct gpio_callback*, gpio_port_pins_t) { (void)0; }, BIT(${pin}));`,
-          `    gpio_add_callback(__dev, &__tc_wake_cb);`,
-          `    gpio_pin_interrupt_configure(__dev, ${pin}, ${flags});`,
-          `    k_sleep(K_FOREVER);`,
-          `    gpio_pin_interrupt_configure(__dev, ${pin}, GPIO_INT_DISABLE);`,
-          `    gpio_remove_callback(__dev, &__tc_wake_cb);`,
-          '}',
-        ].join(' '),
-      };
-    }
-    default:
-      throw new Error(
-        `framework-zephyr does not yet support HAL op \`${op.operation}\`. ` +
-          `Open an issue or use rawCpp() to emit it manually.`,
-      );
-  }
-}

package/src/lowering/pulse.ts

@@ -1,93 +0,0 @@
-// ---------------------------------------------------------------------------
-// Pulse + shift lowering — bit-bang via GPIO + timing
-//
-// pulse.in measures the duration of a pulse (HIGH or LOW) on a GPIO pin by
-// edge-polling with k_uptime_get. shift.out/in bit-bang a byte through a data
-// + clock pin pair using gpio_pin_set + k_busy_wait. These are software
-// implementations (no hardware pulse capture on nRF for the HAL surface); they
-// are correct but not high-precision.
-// ---------------------------------------------------------------------------
-
-import type { HALOpIR } from '@typecad/cuttlefish/api/shared';
-import type { ZephyrChipDescriptor } from '../chips/types.js';
-import { controllerNodelabelForPin, controllerRawPinForPin } from '../chips/controllers.js';
-
-/** `DEVICE_DT_GET(DT_NODELABEL(<owning-controller>))` for a HAL pin. */
-function devForPin(chip: ZephyrChipDescriptor, pin: number): string {
-  return `DEVICE_DT_GET(DT_NODELABEL(${controllerNodelabelForPin(chip, pin)}))`;
-}
-
-/** Resolve a HAL pulse.* or shift.* op to Zephyr C++ (bit-bang). */
-export function lowerPulseOrShift(
-  op: HALOpIR,
-  chip: ZephyrChipDescriptor,
-): { code?: string; expression?: string } {
-  const o = op as any;
-
-  switch (op.operation) {
-    case 'pulse.in': {
-      // Wait for the pin to reach `value`, then measure until it changes.
-      // Edge-poll with k_uptime_get() (ms granularity — coarse but correct,
-      // and 64-bit so it cannot wrap mid-measurement over ~49 days). The wait
-      // for the start edge is bounded by the timeout; the measurement of the
-      // pulse itself is intentionally unbounded (that IS the pulse length).
-      // Returns -1 (0) if the start edge never arrives within the timeout.
-      const pin = controllerRawPinForPin(chip, o.pin);
-      const want = o.value;
-      const dev = devForPin(chip, o.pin);
-      const timeout = o.timeout ?? 1_000_000; // default 1s in us
-      return {
-        expression: `({ int64_t __max = static_cast<int64_t>(${timeout} / 1000); int64_t __t0 = k_uptime_get(); bool __ok = true; while (gpio_pin_get_raw(${dev}, ${pin}) != ${want}) { if ((k_uptime_get() - __t0) > __max) { __ok = false; break; } } int32_t __ret = 0; if (__ok) { int64_t __start = k_uptime_get(); while (gpio_pin_get_raw(${dev}, ${pin}) == ${want}) { } __ret = static_cast<int32_t>((k_uptime_get() - __start) * 1000); } __ret; })`,
-      };
-    }
-    case 'pulse.in_long': {
-      // Same as pulse.in but for long pulses. Previously this spun forever
-      // with NO timeout (the comment claimed "no overflow concern" but the
-      // real risk was hanging the thread on a stuck pin). Apply the same
-      // timeout-bounded start-edge wait as pulse.in (bug Q5).
-      const pin = controllerRawPinForPin(chip, o.pin);
-      const want = o.value;
-      const dev = devForPin(chip, o.pin);
-      const timeout = o.timeout ?? 3_000_000; // default 3s in us (long pulses)
-      return {
-        expression: `({ int64_t __max = static_cast<int64_t>(${timeout} / 1000); int64_t __t0 = k_uptime_get(); bool __ok = true; while (gpio_pin_get_raw(${dev}, ${pin}) != ${want}) { if ((k_uptime_get() - __t0) > __max) { __ok = false; break; } } int32_t __ret = 0; if (__ok) { int64_t __start = k_uptime_get(); while (gpio_pin_get_raw(${dev}, ${pin}) == ${want}) { } __ret = static_cast<int32_t>((k_uptime_get() - __start) * 1000); } __ret; })`,
-      };
-    }
-    case 'shift.out': {
-      // Bit-bang `value` (MSB or LSB first) via dataPin + clockPin. The two
-      // pins may sit on different GPIO controllers on multi-controller SoCs
-      // (ESP32-S3), so each is resolved to its own owning controller.
-      const dataPin = o.dataPin;
-      const clockPin = o.clockPin;
-      const dataDev = devForPin(chip, dataPin);
-      const clockDev = devForPin(chip, clockPin);
-      const msbFirst = o.bitOrder === 'msb';
-      const init = msbFirst ? '7' : '0';
-      const test = msbFirst ? '(__i >= 0)' : '(__i < 8)';
-      const step = msbFirst ? '__i--' : '__i++';
-      return {
-        code: `for (int __i = ${init}; ${test}; ${step}) { gpio_pin_set_raw(${dataDev}, ${controllerRawPinForPin(chip, dataPin)}, (${o.value} >> __i) & 1); gpio_pin_set_raw(${clockDev}, ${controllerRawPinForPin(chip, clockPin)}, 1); k_busy_wait(1); gpio_pin_set_raw(${clockDev}, ${controllerRawPinForPin(chip, clockPin)}, 0); }`,
-      };
-    }
-    case 'shift.in': {
-      // Read 8 bits (MSB or LSB first) from dataPin, clocking on clockPin.
-      const dataPin = o.dataPin;
-      const clockPin = o.clockPin;
-      const dataDev = devForPin(chip, dataPin);
-      const clockDev = devForPin(chip, clockPin);
-      const msbFirst = o.bitOrder === 'msb';
-      const init = msbFirst ? '7' : '0';
-      const test = msbFirst ? '(__i >= 0)' : '(__i < 8)';
-      const step = msbFirst ? '__i--' : '__i++';
-      const accum = msbFirst ? '__v = (__v << 1)' : '__v |= (bit << __i)';
-      return {
-        expression: `({ uint8_t __v = 0; for (int __i = ${init}; ${test}; ${step}) { gpio_pin_set_raw(${clockDev}, ${controllerRawPinForPin(chip, clockPin)}, 1); k_busy_wait(1); int bit = gpio_pin_get_raw(${dataDev}, ${controllerRawPinForPin(chip, dataPin)}); gpio_pin_set_raw(${clockDev}, ${controllerRawPinForPin(chip, clockPin)}, 0); ${accum}; } __v; })`,
-      };
-    }
-    default:
-      throw new Error(
-        `framework-zephyr does not yet support HAL op \`${op.operation}\`. ` +
-          `Open an issue or use rawCpp() to emit it manually.`,
-      );
-  }
-}