@mikrojs/firmware 0.21.1-next.20260927212749 → 0.22.0

package/components/mikrojs/platform_esp32.cpp

@@ -1,9 +1,11 @@
 #include "mikrojs/platform.h"
 #include "mikrojs_esp32.h"
 
+#include <esp_attr.h>
 #include <esp_log.h>
 #include <esp_heap_caps.h>
 #include <esp_mac.h>
+#include <esp_netif.h>
 #include <nanocbor/nanocbor.h>
 #include <nvs.h>
 #include <esp_random.h>
@@ -64,13 +66,72 @@ static void esp32_feed_watchdog(void) {
 }
 #endif
 
+/* When the loop task last blocked. A wake already pending ends a wait at once,
+ * so a producer that wakes faster than a pass (a fast GPIO signal) could keep
+ * the task from blocking, and IDLE, which the task watchdog checks, would
+ * starve. Like mik__maybe_yield, sleep one tick per second of that. */
+static int64_t s_last_block_us = 0;
+
 static void esp32_yield(void) {
-    /* Every cooperative yield feeds the TWDT: between jobs, in the serve
-     * loop's wait, and while the app is paused. */
+    /* Every cooperative yield feeds the TWDT: between jobs and when the
+     * serve loop has work due now. */
 #if CONFIG_ESP_TASK_WDT_EN
     esp_task_wdt_reset();
 #endif
     vTaskDelay(1);
+    s_last_block_us = esp_timer_get_time();
+}
+
+/* The task that blocks in esp32_wait (the main task), bound on its first
+ * wait. Producers on other tasks and in ISRs notify it. */
+static TaskHandle_t s_loop_task = nullptr;
+
+/* Wakes use notification index 1. Index 0 is the one ulTaskNotifyTake, driver
+ * code and pthread_join use, and native code on the JS task may block on it. */
+#define MIK__WAKE_INDEX 1
+static_assert(configTASK_NOTIFICATION_ARRAY_ENTRIES > MIK__WAKE_INDEX,
+              "the loop's wake needs a second task notification: set "
+              "CONFIG_FREERTOS_TASK_NOTIFICATION_ARRAY_ENTRIES=2 in sdkconfig, or delete sdkconfig "
+              "and re-run `mikro idf set-target` so sdkconfig.defaults applies");
+
+static void esp32_wait(int64_t timeout_us) {
+    if (!s_loop_task) {
+        /* Bind and return: a wake that raced this first call is not lost. */
+        s_loop_task = xTaskGetCurrentTaskHandle();
+        return;
+    }
+#if CONFIG_ESP_TASK_WDT_EN
+    esp_task_wdt_reset();
+#endif
+    /* Whole ticks, rounded up; FreeRTOS counts from the current partial tick,
+     * so the wait can still end up to one tick early and the next pass waits
+     * the remainder. */
+    TickType_t ticks = (TickType_t)((timeout_us + portTICK_PERIOD_MS * 1000 - 1) /
+                                    (portTICK_PERIOD_MS * 1000));
+    if (ticks == 0) ticks = 1;
+    if (ulTaskNotifyTakeIndexed(MIK__WAKE_INDEX, pdTRUE, 0) == 0) {
+        ulTaskNotifyTakeIndexed(MIK__WAKE_INDEX, pdTRUE, ticks);
+        s_last_block_us = esp_timer_get_time();
+    } else if (esp_timer_get_time() - s_last_block_us >= 1000 * 1000) {
+        vTaskDelay(1);
+        s_last_block_us = esp_timer_get_time();
+    }
+#if CONFIG_ESP_TASK_WDT_EN
+    esp_task_wdt_reset();
+#endif
+}
+
+static void esp32_wake(void) {
+    if (s_loop_task) xTaskNotifyGiveIndexed(s_loop_task, MIK__WAKE_INDEX);
+}
+
+/* IRAM: called from handlers that run while the flash cache is off (the
+ * GPIO and UART ISRs are installed with ESP_INTR_FLAG_IRAM). */
+void IRAM_ATTR MIK_WakeFromISR(void) {
+    if (!s_loop_task) return;
+    BaseType_t woken = pdFALSE;
+    vTaskNotifyGiveIndexedFromISR(s_loop_task, MIK__WAKE_INDEX, &woken);
+    portYIELD_FROM_ISR(woken);
 }
 
 static size_t esp32_get_free_system_mem(void) {
@@ -330,6 +391,16 @@ static void esp32_log(int level, const char* tag, const char* fmt, ...) {
     mik__console_write(buf, total + 1);
 }
 
+/* Start lwip's tcpip thread. esp_netif_init is idempotent (INVALID_STATE
+ * on a second call); the wifi and http modules run it too and share the
+ * result. */
+static void esp32_net_init(void) {
+    esp_err_t err = esp_netif_init();
+    if (err != ESP_OK && err != ESP_ERR_INVALID_STATE) {
+        ESP_LOGE("mikrojs", "esp_netif_init failed: %s", esp_err_to_name(err));
+    }
+}
+
 static const MIKPlatform esp32_platform = {
     .get_boot_us = esp32_get_boot_us,
     .get_rtc_us = esp32_get_rtc_us,
@@ -337,6 +408,8 @@ static const MIKPlatform esp32_platform = {
     .restart = esp32_restart,
     .deep_sleep_us = esp32_deep_sleep_us,
     .yield = esp32_yield,
+    .wait = esp32_wait,
+    .wake = esp32_wake,
 #if CONFIG_ESP_TASK_WDT_EN
     .feed_watchdog = esp32_feed_watchdog,
 #else
@@ -361,6 +434,7 @@ static const MIKPlatform esp32_platform = {
     .get_device_name = esp32_get_device_name,
     .set_device_name = esp32_set_device_name,
     .get_reset_reason = esp32_get_reset_reason,
+    .net_init = esp32_net_init,
 };
 
 /*

package/dist/boards.d.ts

@@ -43,6 +43,18 @@ export interface FirmwareExport {
     target: string;
     file: string;
 }
+/** A board that runs one of the generic images, as its firmware.json says.
+ *  `mikro flash` flashes that image with the board's name written into it. */
+export interface GenericBoard {
+    name: string;
+    description?: string;
+    /** The generic board whose image it runs: `esp32-generic`. */
+    firmware: string;
+    specifier: string;
+    key: string;
+    packageName: string;
+    packageDir: string;
+}
 /** The full image's folder in the board's, and its name for `--features`. */
 export declare const FULL_IMAGE = "full";
 /** A board's name in file and artifact names: `@acme/pi` becomes `acme-pi`. */
@@ -52,31 +64,40 @@ export declare function boardFileName(name: string): string;
  * or `mikro-fw-<chip>` for firmware without a name. The chip is left out when
  * the name already ends with it (`seeed-xiao-esp32c6`) or is `<chip>-generic`,
  * so the chip is always the last word, or the one before `generic`.
- * `mikro fw pack` names archives this way, and `mikro flash --from` looks for
- * them; the CI artifact of a build has the same name.
+ * `mikro fw pack` names archives this way, and the CI artifact of a build has
+ * the same name.
  */
 export declare function archiveName(name: string | undefined, chip: string): string;
-/** Whether an archive name (without `.tar.gz`) is a full image for `chip`, by
- *  the place archiveName puts the chip. A board's other images (`+no-ble`)
- *  are only ever asked for by name. */
-export declare function isArchiveForChip(archive: string, chip: string): boolean;
 /** The package's `firmware` exports, and the ones that can't name a board. */
 export declare function firmwareExports(packageDir: string): {
     entries: FirmwareExport[];
     problems: BoardProblem[];
 };
-/** What a firmware.json says, or why it can't describe a board. */
+type ImageJson = Pick<BoardImage, 'name' | 'description' | 'chip' | 'version' | 'features'>;
+type GenericJson = Pick<GenericBoard, 'name' | 'description' | 'firmware'>;
+/** What an image's firmware.json says, or why it can't describe an image. */
 export declare function readFirmwareJson(file: string): {
     ok: true;
-    value: Pick<BoardImage, 'name' | 'description' | 'chip' | 'version' | 'features'>;
+    value: ImageJson;
 } | {
     ok: false;
     message: string;
 };
-/** The boards a package declares, and the `firmware` exports that aren't one
- *  (not built, or not a Mikro.js firmware.json). */
+/** What the firmware.json of a board that runs a generic image says, or why
+ *  it isn't one. */
+export declare function readGenericBoardJson(file: string): {
+    ok: true;
+    value: GenericJson;
+} | {
+    ok: false;
+    message: string;
+};
+/** The boards a package declares: those with an image of their own in
+ *  `boards`, those that run a generic image in `generic`, and the `firmware`
+ *  exports that are neither (not built, or not a Mikro.js firmware.json). */
 export declare function loadBoards(packageDir: string): {
     boards: BoardImage[];
+    generic: GenericBoard[];
     problems: BoardProblem[];
 };
 /**
@@ -130,6 +151,31 @@ export interface BoardConfig {
     /** Images to build besides the full one, each with features switched off
      *  or on: `[{ble: false}, {ble: false, wifi: false}]`. */
     images?: readonly ImageFeatures[];
+    /** Only for a board on the generic firmware (GenericBoardConfig). */
+    firmware?: never;
+}
+/** The generic boards, one per chip: the firmware a board on the generic
+ *  firmware runs. */
+declare const GENERIC_FIRMWARE: ("esp32-generic" | "esp32c3-generic" | "esp32c5-generic" | "esp32c6-generic" | "esp32s3-generic")[];
+export type GenericFirmware = (typeof GENERIC_FIRMWARE)[number];
+/** A board in boards.config.ts that runs one of the generic images, such as a
+ *  board whose drivers are all JavaScript. `mikro flash` writes its name into
+ *  the image. */
+export interface GenericBoardConfig {
+    /** The generic board whose image it runs: `esp32-generic`. */
+    firmware: GenericFirmware;
+    /** The name the device reports as sys.board.name. Default: the specifier of
+     *  the board's export. */
+    name?: string;
+    /** Shown when `mikro flash` asks which board to flash. Default: the
+     *  package's description. */
+    description?: string;
+    chip?: never;
+    sdkconfig?: never;
+    partitions?: never;
+    nativeModules?: never;
+    project?: never;
+    images?: never;
 }
 /** boards.config.ts: the boards a package builds, keyed by the export that
  *  declares each, `.` or `./<board>`. */
@@ -138,7 +184,7 @@ export interface BoardsConfig {
      *  board at `.`, `<dist>/<board>/full/` for the others, and each other image
      *  in a folder beside `full/`. Default: `dist-fw`. */
     dist?: string;
-    boards: Record<string, BoardConfig>;
+    boards: Record<string, BoardConfig | GenericBoardConfig>;
 }
 /** A board from boards.config.ts, with defaults filled in and paths resolved. */
 export interface ConfiguredBoard {
@@ -161,6 +207,19 @@ export interface ConfiguredBoard {
     /** The images besides the full one. */
     images: ConfiguredImage[];
 }
+/** A board from boards.config.ts that runs a generic image. `mikro fw build`
+ *  writes its firmware.json to `target`, which names the generic board. */
+export interface ConfiguredGenericBoard {
+    key: string;
+    specifier: string;
+    name: string;
+    description?: string;
+    firmware: GenericFirmware;
+    /** The generic board's chip. */
+    chip: Chip;
+    target: string;
+    boardDir: string;
+}
 /** An image from `images` in boards.config.ts. */
 export interface ConfiguredImage {
     /** `no-ble`: the image's folder in the board's, and its name everywhere else. */
@@ -175,10 +234,12 @@ export interface ConfiguredImage {
  * and everything wrong with it: fields that don't check out, files it names
  * that don't exist, names a device can't take, and `exports` that don't match
  * (a board without its `firmware` export, one pointing elsewhere, or a
- * `firmware` export the config doesn't have).
+ * `firmware` export the config doesn't have). Boards with an image of their own
+ * are in `boards`, boards that run a generic image in `generic`.
  */
 export declare function checkBoardsConfig(packageDir: string, config: unknown): {
     boards: ConfiguredBoard[];
+    generic: ConfiguredGenericBoard[];
     problems: BoardProblem[];
 };
 //# sourceMappingURL=boards.d.ts.map

package/dist/boards.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"boards.d.ts","sourceRoot":"","sources":["../src/boards.ts"],"names":[],"mappings":"AAyBA,OAAO,EAAC,KAAK,IAAI,EAAQ,MAAM,YAAY,CAAA;AAE3C,0DAA0D;AAC1D,MAAM,WAAW,UAAU;IACzB,0EAA0E;IAC1E,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,EAAE,MAAM,CAAA;IACZ,qDAAqD;IACrD,OAAO,EAAE,MAAM,CAAA;IACf,qFAAqF;IACrF,SAAS,EAAE,MAAM,CAAA;IACjB,6CAA6C;IAC7C,GAAG,EAAE,MAAM,CAAA;IACX,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,MAAM,CAAA;IAClB,iFAAiF;IACjF,GAAG,EAAE,MAAM,CAAA;IACX;4CACwC;IACxC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IACnB;+EAC2E;IAC3E,MAAM,CAAC,EAAE,SAAS,EAAE,CAAA;CACrB;AAED,oDAAoD;AACpD,MAAM,WAAW,SAAS;IACxB,8DAA8D;IAC9D,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,EAAE,CAAA;IAClB,GAAG,EAAE,MAAM,CAAA;CACZ;AAED,kEAAkE;AAClE,MAAM,WAAW,YAAY;IAC3B,8EAA8E;IAC9E,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,iDAAiD;AACjD,MAAM,WAAW,cAAc;IAC7B,GAAG,EAAE,MAAM,CAAA;IACX,SAAS,EAAE,MAAM,CAAA;IACjB,+DAA+D;IAC/D,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;CACb;AAoBD,6EAA6E;AAC7E,eAAO,MAAM,UAAU,SAAS,CAAA;AAUhC,+EAA+E;AAC/E,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAElD;AAED;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAM1E;AAED;;uCAEuC;AACvC,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAMvE;AAiCD,8EAA8E;AAC9E,wBAAgB,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG;IACnD,OAAO,EAAE,cAAc,EAAE,CAAA;IACzB,QAAQ,EAAE,YAAY,EAAE,CAAA;CACzB,CAqBA;AAED,mEAAmE;AACnE,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GACzC;IACE,EAAE,EAAE,IAAI,CAAA;IACR,KAAK,EAAE,IAAI,CAAC,UAAU,EAAE,MAAM,GAAG,aAAa,GAAG,MAAM,GAAG,SAAS,GAAG,UAAU,CAAC,CAAA;CAClF,GACD;IAAC,EAAE,EAAE,KAAK,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAC,CAoC/B;AAuBD;oDACoD;AACpD,wBAAgB,UAAU,CAAC,UAAU,EAAE,MAAM,GAAG;IAAC,MAAM,EAAE,UAAU,EAAE,CAAC;IAAC,QAAQ,EAAE,YAAY,EAAE,CAAA;CAAC,CAgB/F;AAcD;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,MAAM,GAAG,YAAY,EAAE,CAwEpE;AAED,0CAA0C;AAC1C,YAAY,EAAC,IAAI,EAAC,MAAM,YAAY,CAAA;AAEpC;qBACqB;AACrB,QAAA,MAAM,gBAAgB;;;CAAmE,CAAA;AAEzF,+CAA+C;AAC/C,MAAM,MAAM,OAAO,GAAG,MAAM,OAAO,gBAAgB,CAAA;AAEnD;mDACmD;AACnD,MAAM,MAAM,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAA;AAE7D;kEACkE;AAClE,wBAAgB,SAAS,CAAC,QAAQ,EAAE,aAAa,GAAG,MAAM,CAKzD;AAED;wBACwB;AACxB,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAMlD;AAED,sEAAsE;AACtE,MAAM,WAAW,WAAW;IAC1B,0CAA0C;IAC1C,IAAI,EAAE,IAAI,CAAA;IACV;8EAC0E;IAC1E,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;iCAC6B;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,gFAAgF;IAChF,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,MAAM,EAAE,CAAA;IACtC,gEAAgE;IAChE,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,mEAAmE;IACnE,aAAa,CAAC,EAAE,SAAS,MAAM,EAAE,CAAA;IACjC;;8CAE0C;IAC1C,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;8DAC0D;IAC1D,MAAM,CAAC,EAAE,SAAS,aAAa,EAAE,CAAA;CAClC;AAED;yCACyC;AACzC,MAAM,WAAW,YAAY;IAC3B;;0DAEsD;IACtD,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;CACpC;AAED,iFAAiF;AACjF,MAAM,WAAW,eAAe;IAC9B,0CAA0C;IAC1C,GAAG,EAAE,MAAM,CAAA;IACX,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,EAAE,IAAI,CAAA;IACV,sBAAsB;IACtB,SAAS,EAAE,MAAM,EAAE,CAAA;IACnB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,aAAa,EAAE,MAAM,EAAE,CAAA;IACvB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,oGAAoG;IACpG,MAAM,EAAE,MAAM,CAAA;IACd;8CAC0C;IAC1C,QAAQ,EAAE,MAAM,CAAA;IAChB,uCAAuC;IACvC,MAAM,EAAE,eAAe,EAAE,CAAA;CAC1B;AAED,kDAAkD;AAClD,MAAM,WAAW,eAAe;IAC9B,iFAAiF;IACjF,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,aAAa,CAAA;IACvB,oDAAoD;IACpD,QAAQ,EAAE,MAAM,EAAE,CAAA;IAClB,GAAG,EAAE,MAAM,CAAA;CACZ;AAyBD;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAC/B,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,OAAO,GACd;IAAC,MAAM,EAAE,eAAe,EAAE,CAAC;IAAC,QAAQ,EAAE,YAAY,EAAE,CAAA;CAAC,CA+MvD"}
+{"version":3,"file":"boards.d.ts","sourceRoot":"","sources":["../src/boards.ts"],"names":[],"mappings":"AAyBA,OAAO,EAAC,KAAK,IAAI,EAAe,MAAM,YAAY,CAAA;AAElD,0DAA0D;AAC1D,MAAM,WAAW,UAAU;IACzB,0EAA0E;IAC1E,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,EAAE,MAAM,CAAA;IACZ,qDAAqD;IACrD,OAAO,EAAE,MAAM,CAAA;IACf,qFAAqF;IACrF,SAAS,EAAE,MAAM,CAAA;IACjB,6CAA6C;IAC7C,GAAG,EAAE,MAAM,CAAA;IACX,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,MAAM,CAAA;IAClB,iFAAiF;IACjF,GAAG,EAAE,MAAM,CAAA;IACX;4CACwC;IACxC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IACnB;+EAC2E;IAC3E,MAAM,CAAC,EAAE,SAAS,EAAE,CAAA;CACrB;AAED,oDAAoD;AACpD,MAAM,WAAW,SAAS;IACxB,8DAA8D;IAC9D,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,EAAE,CAAA;IAClB,GAAG,EAAE,MAAM,CAAA;CACZ;AAED,kEAAkE;AAClE,MAAM,WAAW,YAAY;IAC3B,8EAA8E;IAC9E,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,iDAAiD;AACjD,MAAM,WAAW,cAAc;IAC7B,GAAG,EAAE,MAAM,CAAA;IACX,SAAS,EAAE,MAAM,CAAA;IACjB,+DAA+D;IAC/D,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;CACb;AAyBD;8EAC8E;AAC9E,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,8DAA8D;IAC9D,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,GAAG,EAAE,MAAM,CAAA;IACX,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,MAAM,CAAA;CACnB;AAKD,6EAA6E;AAC7E,eAAO,MAAM,UAAU,SAAS,CAAA;AAUhC,+EAA+E;AAC/E,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAElD;AAED;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAM1E;AAiCD,8EAA8E;AAC9E,wBAAgB,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG;IACnD,OAAO,EAAE,cAAc,EAAE,CAAA;IACzB,QAAQ,EAAE,YAAY,EAAE,CAAA;CACzB,CAqBA;AAED,KAAK,SAAS,GAAG,IAAI,CAAC,UAAU,EAAE,MAAM,GAAG,aAAa,GAAG,MAAM,GAAG,SAAS,GAAG,UAAU,CAAC,CAAA;AAC3F,KAAK,WAAW,GAAG,IAAI,CAAC,YAAY,EAAE,MAAM,GAAG,aAAa,GAAG,UAAU,CAAC,CAAA;AA6D1E,6EAA6E;AAC7E,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,MAAM,GACX;IAAC,EAAE,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,SAAS,CAAA;CAAC,GAAG;IAAC,EAAE,EAAE,KAAK,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAC,CAG7D;AAED;oBACoB;AACpB,wBAAgB,oBAAoB,CAClC,IAAI,EAAE,MAAM,GACX;IAAC,EAAE,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,WAAW,CAAA;CAAC,GAAG;IAAC,EAAE,EAAE,KAAK,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAC,CAG/D;AAuBD;;6EAE6E;AAC7E,wBAAgB,UAAU,CAAC,UAAU,EAAE,MAAM,GAAG;IAC9C,MAAM,EAAE,UAAU,EAAE,CAAA;IACpB,OAAO,EAAE,YAAY,EAAE,CAAA;IACvB,QAAQ,EAAE,YAAY,EAAE,CAAA;CACzB,CA0BA;AAcD;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,MAAM,GAAG,YAAY,EAAE,CAwEpE;AAED,0CAA0C;AAC1C,YAAY,EAAC,IAAI,EAAC,MAAM,YAAY,CAAA;AAEpC;qBACqB;AACrB,QAAA,MAAM,gBAAgB;;;CAAmE,CAAA;AAEzF,+CAA+C;AAC/C,MAAM,MAAM,OAAO,GAAG,MAAM,OAAO,gBAAgB,CAAA;AAEnD;mDACmD;AACnD,MAAM,MAAM,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAA;AAE7D;kEACkE;AAClE,wBAAgB,SAAS,CAAC,QAAQ,EAAE,aAAa,GAAG,MAAM,CAKzD;AAED;wBACwB;AACxB,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAMlD;AAED,sEAAsE;AACtE,MAAM,WAAW,WAAW;IAC1B,0CAA0C;IAC1C,IAAI,EAAE,IAAI,CAAA;IACV;8EAC0E;IAC1E,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;iCAC6B;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,gFAAgF;IAChF,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,MAAM,EAAE,CAAA;IACtC,gEAAgE;IAChE,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,mEAAmE;IACnE,aAAa,CAAC,EAAE,SAAS,MAAM,EAAE,CAAA;IACjC;;8CAE0C;IAC1C,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;8DAC0D;IAC1D,MAAM,CAAC,EAAE,SAAS,aAAa,EAAE,CAAA;IACjC,qEAAqE;IACrE,QAAQ,CAAC,EAAE,KAAK,CAAA;CACjB;AAED;qBACqB;AACrB,QAAA,MAAM,gBAAgB,qGAAkD,CAAA;AACxE,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAA;AAM/D;;iBAEiB;AACjB,MAAM,WAAW,kBAAkB;IACjC,8DAA8D;IAC9D,QAAQ,EAAE,eAAe,CAAA;IACzB;8BAC0B;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;iCAC6B;IAC7B,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB,IAAI,CAAC,EAAE,KAAK,CAAA;IACZ,SAAS,CAAC,EAAE,KAAK,CAAA;IACjB,UAAU,CAAC,EAAE,KAAK,CAAA;IAClB,aAAa,CAAC,EAAE,KAAK,CAAA;IACrB,OAAO,CAAC,EAAE,KAAK,CAAA;IACf,MAAM,CAAC,EAAE,KAAK,CAAA;CACf;AAED;yCACyC;AACzC,MAAM,WAAW,YAAY;IAC3B;;0DAEsD;IACtD,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,GAAG,kBAAkB,CAAC,CAAA;CACzD;AAED,iFAAiF;AACjF,MAAM,WAAW,eAAe;IAC9B,0CAA0C;IAC1C,GAAG,EAAE,MAAM,CAAA;IACX,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,EAAE,IAAI,CAAA;IACV,sBAAsB;IACtB,SAAS,EAAE,MAAM,EAAE,CAAA;IACnB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,aAAa,EAAE,MAAM,EAAE,CAAA;IACvB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,oGAAoG;IACpG,MAAM,EAAE,MAAM,CAAA;IACd;8CAC0C;IAC1C,QAAQ,EAAE,MAAM,CAAA;IAChB,uCAAuC;IACvC,MAAM,EAAE,eAAe,EAAE,CAAA;CAC1B;AAED;2EAC2E;AAC3E,MAAM,WAAW,sBAAsB;IACrC,GAAG,EAAE,MAAM,CAAA;IACX,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,EAAE,eAAe,CAAA;IACzB,gCAAgC;IAChC,IAAI,EAAE,IAAI,CAAA;IACV,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED,kDAAkD;AAClD,MAAM,WAAW,eAAe;IAC9B,iFAAiF;IACjF,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,aAAa,CAAA;IACvB,oDAAoD;IACpD,QAAQ,EAAE,MAAM,EAAE,CAAA;IAClB,GAAG,EAAE,MAAM,CAAA;CACZ;AA0BD;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAC/B,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,OAAO,GACd;IAAC,MAAM,EAAE,eAAe,EAAE,CAAC;IAAC,OAAO,EAAE,sBAAsB,EAAE,CAAC;IAAC,QAAQ,EAAE,YAAY,EAAE,CAAA;CAAC,CAiP1F"}

package/dist/boards.js

@@ -21,7 +21,7 @@
 import { existsSync, readdirSync, readFileSync } from 'node:fs';
 import { basename, dirname, isAbsolute, join, relative, resolve, sep } from 'node:path';
 import { array, enumOf, object, optional, string, validate } from '@mikrojs/schema';
-import { chips } from "./index.js";
+import { CHIPS, chips } from "./index.js";
 /** The form of a board name: a package name, optionally with /<board>. The
  *  device keeps it in a 64-byte buffer, and a registry checks the same form
  *  (docs/registry-spec.md, "Board names"). */
@@ -34,6 +34,13 @@ const FirmwareJson = object({
     version: string(),
     features: optional(array(string())),
 });
+/** The firmware.json of a board that runs a generic image: no image of its
+ *  own, the generic board's name in `firmware`. */
+const GenericFirmwareJson = object({
+    name: string(),
+    description: optional(string()),
+    firmware: string(),
+});
 /** An image name: what it leaves out (`no-ble`) or adds, joined with `+`. */
 const IMAGE_NAME_RE = /^(no-)?[a-z0-9]+(\+(no-)?[a-z0-9]+)*$/;
 /** The full image's folder in the board's, and its name for `--features`. */
@@ -47,8 +54,8 @@ export function boardFileName(name) {
  * or `mikro-fw-<chip>` for firmware without a name. The chip is left out when
  * the name already ends with it (`seeed-xiao-esp32c6`) or is `<chip>-generic`,
  * so the chip is always the last word, or the one before `generic`.
- * `mikro fw pack` names archives this way, and `mikro flash --from` looks for
- * them; the CI artifact of a build has the same name.
+ * `mikro fw pack` names archives this way, and the CI artifact of a build has
+ * the same name.
  */
 export function archiveName(name, chip) {
     if (name === undefined)
@@ -58,14 +65,6 @@ export function archiveName(name, chip) {
         ? `mikro-fw-${fileName}`
         : `mikro-fw-${fileName}-${chip}`;
 }
-/** Whether an archive name (without `.tar.gz`) is a full image for `chip`, by
- *  the place archiveName puts the chip. A board's other images (`+no-ble`)
- *  are only ever asked for by name. */
-export function isArchiveForChip(archive, chip) {
-    return (archive.startsWith('mikro-fw-') &&
-        !archive.includes('+') &&
-        (archive.endsWith(`-${chip}`) || archive === `mikro-fw-${chip}-generic`));
-}
 function readPackageJson(packageDir) {
     const file = join(packageDir, 'package.json');
     try {
@@ -120,18 +119,24 @@ export function firmwareExports(packageDir) {
     }
     return { entries, problems };
 }
-/** What a firmware.json says, or why it can't describe a board. */
-export function readFirmwareJson(file) {
+/** A firmware.json's content, or why it can't be read. */
+function readJson(file) {
     if (!existsSync(file))
         return { ok: false, message: `not built: ${file} does not exist` };
-    let json;
     try {
-        json = JSON.parse(readFileSync(file, 'utf8'));
+        return { ok: true, value: JSON.parse(readFileSync(file, 'utf8')) };
     }
     catch (e) {
         return { ok: false, message: `${file} is not valid JSON: ${e.message}` };
     }
-    const invalid = validate(FirmwareJson, json, '');
+}
+/** Whether a firmware.json is a generic board's: no image, a `firmware` instead. */
+function isGenericJson(json) {
+    return isObject(json) && Object.hasOwn(json, 'firmware');
+}
+/** `json` checked against `schema` and the board-name form, or why it isn't. */
+function checkedJson(schema, json, file) {
+    const invalid = validate(schema, json, '');
     if (invalid) {
         const { message, path } = invalid.error;
         return { ok: false, message: `${file}${path ? ` (${path.slice(1)})` : ''}: ${message}` };
@@ -143,16 +148,35 @@ export function readFirmwareJson(file) {
             message: `${file}: "${value.name}" is not a board name (at most ${MAX_BOARD_NAME_LENGTH} characters, the form of a package name with an optional /<board>)`,
         };
     }
-    return {
-        ok: true,
-        value: {
-            name: value.name,
-            description: value.description,
-            chip: value.chip,
-            version: value.version,
-            features: value.features,
-        },
-    };
+    return { ok: true, value };
+}
+function imageJson(json, file) {
+    if (isGenericJson(json)) {
+        return { ok: false, message: `${file} is a board that runs a generic image, not an image` };
+    }
+    const read = checkedJson(FirmwareJson, json, file);
+    if (!read.ok)
+        return read;
+    const { name, description, chip, version, features } = read.value;
+    return { ok: true, value: { name, description, chip, version, features } };
+}
+function genericJson(json, file) {
+    const read = checkedJson(GenericFirmwareJson, json, file);
+    if (!read.ok)
+        return read;
+    const { name, description, firmware } = read.value;
+    return { ok: true, value: { name, description, firmware } };
+}
+/** What an image's firmware.json says, or why it can't describe an image. */
+export function readFirmwareJson(file) {
+    const json = readJson(file);
+    return json.ok ? imageJson(json.value, file) : json;
+}
+/** What the firmware.json of a board that runs a generic image says, or why
+ *  it isn't one. */
+export function readGenericBoardJson(file) {
+    const json = readJson(file);
+    return json.ok ? genericJson(json.value, file) : json;
 }
 /** A board's other images: the folders beside its full image's `full/`
  *  folder, named like an image, that hold an image of the same board. */
@@ -176,25 +200,40 @@ function siblingImages(dir, name, chip) {
     }
     return images.sort((a, b) => a.name.localeCompare(b.name));
 }
-/** The boards a package declares, and the `firmware` exports that aren't one
- *  (not built, or not a Mikro.js firmware.json). */
+/** The boards a package declares: those with an image of their own in
+ *  `boards`, those that run a generic image in `generic`, and the `firmware`
+ *  exports that are neither (not built, or not a Mikro.js firmware.json). */
 export function loadBoards(packageDir) {
     const { entries, problems } = firmwareExports(packageDir);
-    const read = readPackageJson(packageDir);
-    const packageName = (read.ok ? read.value.name : undefined) ?? packageDir;
+    const pkg = readPackageJson(packageDir);
+    const packageName = (pkg.ok ? pkg.value.name : undefined) ?? packageDir;
     const boards = [];
+    const generic = [];
     for (const { key, specifier, file } of entries) {
-        const read = readFirmwareJson(file);
-        if (read.ok) {
-            const dir = dirname(file);
-            const images = siblingImages(dir, read.value.name, read.value.chip);
-            boards.push({ ...read.value, images, specifier, key, packageName, packageDir, dir });
+        const json = readJson(file);
+        if (!json.ok) {
+            problems.push({ specifier, message: json.message });
+        }
+        else if (isGenericJson(json.value)) {
+            const read = genericJson(json.value, file);
+            if (read.ok)
+                generic.push({ ...read.value, specifier, key, packageName, packageDir });
+            else
+                problems.push({ specifier, message: read.message });
         }
         else {
-            problems.push({ specifier, message: read.message });
+            const read = imageJson(json.value, file);
+            if (read.ok) {
+                const dir = dirname(file);
+                const images = siblingImages(dir, read.value.name, read.value.chip);
+                boards.push({ ...read.value, images, specifier, key, packageName, packageDir, dir });
+            }
+            else {
+                problems.push({ specifier, message: read.message });
+            }
         }
     }
-    return { boards, problems };
+    return { boards, generic, problems };
 }
 /** Whether npm publishes `path` (relative to the package) under this `files`
  *  list. Glob entries are taken as covering it: they need npm's matcher. */
@@ -224,7 +263,7 @@ export function checkBoardPackage(packageDir) {
         return [{ specifier: packageDir, message: read.message }];
     const pkg = read.value;
     const { entries } = firmwareExports(packageDir);
-    const { boards, problems } = loadBoards(packageDir);
+    const { boards, generic, problems } = loadBoards(packageDir);
     const packageName = pkg.name ?? packageDir;
     for (const { specifier, target, file } of entries) {
         const inPackage = relative(packageDir, dirname(file));
@@ -265,7 +304,7 @@ export function checkBoardPackage(packageDir) {
         }
     }
     const byName = new Map();
-    for (const board of boards) {
+    for (const board of [...boards, ...generic]) {
         const other = byName.get(board.name);
         if (other) {
             problems.push({
@@ -309,6 +348,12 @@ export function sortImageName(name) {
         .sort((a, b) => feature(a).localeCompare(feature(b)))
         .join('+');
 }
+/** The generic boards, one per chip: the firmware a board on the generic
+ *  firmware runs. */
+const GENERIC_FIRMWARE = CHIPS.map((chip) => `${chip}-generic`);
+function isGenericFirmware(name) {
+    return GENERIC_FIRMWARE.includes(name);
+}
 const DEFAULT_DIST = 'dist-fw';
 const BOARD_KEYS = [
     'chip',
@@ -320,6 +365,7 @@ const BOARD_KEYS = [
     'project',
     'images',
 ];
+const GENERIC_BOARD_KEYS = ['firmware', 'name', 'description'];
 /** `./<board>`: one segment, in the form of a board name's last part. */
 const SUBPATH_RE = /^\.\/[a-z0-9]([a-z0-9.-]*[a-z0-9])?$/;
 function isStringArray(value) {
@@ -334,18 +380,21 @@ function exportsSnippet(boards) {
  * and everything wrong with it: fields that don't check out, files it names
  * that don't exist, names a device can't take, and `exports` that don't match
  * (a board without its `firmware` export, one pointing elsewhere, or a
- * `firmware` export the config doesn't have).
+ * `firmware` export the config doesn't have). Boards with an image of their own
+ * are in `boards`, boards that run a generic image in `generic`.
  */
 export function checkBoardsConfig(packageDir, config) {
     const read = readPackageJson(packageDir);
-    if (!read.ok)
-        return { boards: [], problems: [{ specifier: packageDir, message: read.message }] };
+    if (!read.ok) {
+        return { boards: [], generic: [], problems: [{ specifier: packageDir, message: read.message }] };
+    }
     const pkg = read.value;
     const packageName = pkg.name ?? packageDir;
     const problems = [];
     // Stops at a problem that leaves nothing to check, keeping the ones found so far
     const fail = (message) => ({
         boards: [],
+        generic: [],
         problems: [...problems, { specifier: packageName, message }],
     });
     if (pkg.name === undefined)
@@ -375,6 +424,7 @@ export function checkBoardsConfig(packageDir, config) {
         return fail('boards.config.ts: a package has one board at "." or boards at "./<board>", not both');
     }
     const boards = [];
+    const generic = [];
     for (const [key, board] of Object.entries(config.boards)) {
         const sub = key.slice(2);
         const specifier = key === '.' ? packageName : `${packageName}/${sub}`;
@@ -388,20 +438,55 @@ export function checkBoardsConfig(packageDir, config) {
             problem('expected an object');
             continue;
         }
+        const { name, description } = board;
+        if (name !== undefined && typeof name !== 'string')
+            problem('"name" must be a string');
+        if (description !== undefined && typeof description !== 'string') {
+            problem('"description" must be a string');
+        }
+        const boardName = typeof name === 'string' ? name : specifier;
+        if (!BOARD_NAME_RE.test(boardName) || boardName.length > MAX_BOARD_NAME_LENGTH) {
+            problem(`"${boardName}" is not a board name (at most ${MAX_BOARD_NAME_LENGTH} characters, the ` +
+                'form of a package name with an optional /<board>)' +
+                (typeof name === 'string' ? '' : '; set "name"'));
+        }
+        const target = `./${distPath}/${key === '.' ? '' : `${sub}/`}${FULL_IMAGE}/firmware.json`;
+        const boardDir = key === '.' ? distDir : join(distDir, sub);
+        const boardDescription = typeof description === 'string' ? description : pkg.description;
+        if (Object.hasOwn(board, 'firmware')) {
+            const { firmware } = board;
+            for (const field of Object.keys(board)) {
+                if (GENERIC_BOARD_KEYS.includes(field))
+                    continue;
+                problem(BOARD_KEYS.includes(field)
+                    ? `a board that runs a generic image gets "${field}" from it; leave out "${field}"`
+                    : `unknown field "${field}"`);
+            }
+            if (!isGenericFirmware(firmware)) {
+                problem(`"firmware" must be one of ${GENERIC_FIRMWARE.join(', ')}`);
+                continue;
+            }
+            generic.push({
+                key,
+                specifier,
+                name: boardName,
+                description: boardDescription,
+                firmware,
+                chip: CHIPS[GENERIC_FIRMWARE.indexOf(firmware)],
+                target,
+                boardDir,
+            });
+            continue;
+        }
         for (const field of Object.keys(board)) {
             if (!BOARD_KEYS.includes(field))
                 problem(`unknown field "${field}"`);
         }
-        const { chip, name, description, sdkconfig, partitions, nativeModules, project, images } = board;
+        const { chip, sdkconfig, partitions, nativeModules, project, images } = board;
         if (typeof chip !== 'string' || !chips.includes(chip)) {
             problem(`"chip" must be one of ${chips.join(', ')}`);
             continue;
         }
-        if (name !== undefined && typeof name !== 'string')
-            problem('"name" must be a string');
-        if (description !== undefined && typeof description !== 'string') {
-            problem('"description" must be a string');
-        }
         if (sdkconfig !== undefined && typeof sdkconfig !== 'string' && !isStringArray(sdkconfig)) {
             problem('"sdkconfig" must be a path or a list of paths');
         }
@@ -458,19 +543,11 @@ export function checkBoardsConfig(packageDir, config) {
             if (!existsSync(resolve(packageDir, file)))
                 problem(`${file} does not exist`);
         }
-        const boardName = typeof name === 'string' ? name : specifier;
-        if (!BOARD_NAME_RE.test(boardName) || boardName.length > MAX_BOARD_NAME_LENGTH) {
-            problem(`"${boardName}" is not a board name (at most ${MAX_BOARD_NAME_LENGTH} characters, the ` +
-                'form of a package name with an optional /<board>)' +
-                (typeof name === 'string' ? '' : '; set "name"'));
-        }
-        const target = `./${distPath}/${key === '.' ? '' : `${sub}/`}${FULL_IMAGE}/firmware.json`;
-        const boardDir = key === '.' ? distDir : join(distDir, sub);
         boards.push({
             key,
             specifier,
             name: boardName,
-            description: typeof description === 'string' ? description : pkg.description,
+            description: boardDescription,
             chip: chip,
             sdkconfig: (typeof sdkconfig === 'string'
                 ? [sdkconfig]
@@ -486,7 +563,7 @@ export function checkBoardsConfig(packageDir, config) {
         });
     }
     const byName = new Map();
-    for (const board of boards) {
+    for (const board of [...boards, ...generic]) {
         const other = byName.get(board.name);
         if (other) {
             problems.push({
@@ -499,7 +576,7 @@ export function checkBoardsConfig(packageDir, config) {
     // The exports must declare exactly the configured boards, where the config
     // puts their images.
     const targets = firmwareTargets(pkg.exports);
-    const missing = boards.filter((board) => {
+    const missing = [...boards, ...generic].filter((board) => {
         const target = targets.get(board.key);
         return (typeof target !== 'string' ||
             resolve(packageDir, target) !== resolve(packageDir, board.target));
@@ -527,6 +604,6 @@ export function checkBoardsConfig(packageDir, config) {
             message: `add these to "exports" in package.json (next to any other conditions of the same export):\n${exportsSnippet(missing)}`,
         });
     }
-    return { boards, problems };
+    return { boards, generic, problems };
 }
 //# sourceMappingURL=boards.js.map