micropython · dpgeorge · Jan 3, 2025 · Nov 15, 2024 · Mar 3, 2022 · Dec 18, 2024
diff --git a/extmod/modvfs.c b/extmod/modvfs.c
@@ -38,6 +38,10 @@
 #error "MICROPY_PY_VFS requires MICROPY_VFS"
 #endif
 
+#if MICROPY_VFS_ROM
+static MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(mp_vfs_rom_ioctl_obj, 1, 4, mp_vfs_rom_ioctl);
+#endif
+
 static const mp_rom_map_elem_t vfs_module_globals_table[] = {
     { MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_vfs) },
 
@@ -53,6 +57,7 @@ static const mp_rom_map_elem_t vfs_module_globals_table[] = {
     { MP_ROM_QSTR(MP_QSTR_VfsLfs2), MP_ROM_PTR(&mp_type_vfs_lfs2) },
     #endif
     #if MICROPY_VFS_ROM
+    { MP_ROM_QSTR(MP_QSTR_rom_ioctl), MP_ROM_PTR(&mp_vfs_rom_ioctl_obj) },
     { MP_ROM_QSTR(MP_QSTR_VfsRom), MP_ROM_PTR(&mp_type_vfs_rom) },
     #endif
     #if MICROPY_VFS_POSIX

diff --git a/extmod/vfs.h b/extmod/vfs.h
@@ -52,6 +52,13 @@
 #define MP_BLOCKDEV_IOCTL_BLOCK_SIZE    (5)
 #define MP_BLOCKDEV_IOCTL_BLOCK_ERASE   (6)
 
+// Constants for vfs.rom_ioctl() function.
+#define MP_VFS_ROM_IOCTL_GET_NUMBER_OF_SEGMENTS     (1) // rom_ioctl(1)
+#define MP_VFS_ROM_IOCTL_GET_SEGMENT                (2) // rom_ioctl(2, <id>)
+#define MP_VFS_ROM_IOCTL_WRITE_PREPARE              (3) // rom_ioctl(3, <id>, <len>)
+#define MP_VFS_ROM_IOCTL_WRITE                      (4) // rom_ioctl(4, <id>, <offset>, <buf>)
+#define MP_VFS_ROM_IOCTL_WRITE_COMPLETE             (5) // rom_ioctl(5, <id>)
+
 // At the moment the VFS protocol just has import_stat, but could be extended to other methods
 typedef struct _mp_vfs_proto_t {
     mp_import_stat_t (*import_stat)(void *self, const char *path);
@@ -122,4 +129,9 @@ MP_DECLARE_CONST_FUN_OBJ_1(mp_vfs_rmdir_obj);
 MP_DECLARE_CONST_FUN_OBJ_1(mp_vfs_stat_obj);
 MP_DECLARE_CONST_FUN_OBJ_1(mp_vfs_statvfs_obj);
 
+#if MICROPY_VFS_ROM
+// A port must define this.
+mp_obj_t mp_vfs_rom_ioctl(size_t n_args, const mp_obj_t *args);
+#endif
+
 #endif // MICROPY_INCLUDED_EXTMOD_VFS_H
diff --git a/ports/esp32/esp32_partition.c b/ports/esp32/esp32_partition.c
@@ -53,6 +53,20 @@ typedef struct _esp32_partition_obj_t {
     uint16_t block_size;
 } esp32_partition_obj_t;
 
+#if MICROPY_VFS_ROM
+
+static esp32_partition_obj_t esp32_partition_romfs_obj = {
+    .base = { .type = NULL },
+    .part = NULL,
+    .cache = NULL,
+    .block_size = NATIVE_BLOCK_SIZE_BYTES,
+};
+
+static const void *esp32_partition_romfs_ptr = NULL;
+static esp_partition_mmap_handle_t esp32_partition_romfs_handle;
+
+#endif
+
 static esp32_partition_obj_t *esp32_partition_new(const esp_partition_t *part, uint16_t block_size) {
     if (part == NULL) {
         mp_raise_OSError(MP_ENOENT);
@@ -114,6 +128,24 @@ static mp_obj_t esp32_partition_make_new(const mp_obj_type_t *type, size_t n_arg
     return MP_OBJ_FROM_PTR(esp32_partition_new(part, block_size));
 }
 
+#if MICROPY_VFS_ROM
+static mp_int_t esp32_partition_get_buffer(mp_obj_t self_in, mp_buffer_info_t *bufinfo, mp_uint_t flags) {
+    esp32_partition_obj_t *self = MP_OBJ_TO_PTR(self_in);
+    if (self == &esp32_partition_romfs_obj && flags == MP_BUFFER_READ) {
+        if (esp32_partition_romfs_ptr == NULL) {
+            check_esp_err(esp_partition_mmap(self->part, 0, self->part->size, ESP_PARTITION_MMAP_DATA, &esp32_partition_romfs_ptr, &esp32_partition_romfs_handle));
+        }
+        bufinfo->buf = (void *)esp32_partition_romfs_ptr;
+        bufinfo->len = self->part->size;
+        bufinfo->typecode = 'B';
+        return 0;
+    } else {
+        // Unsupported.
+        return 1;
+    }
+}
+#endif
+
 static mp_obj_t esp32_partition_find(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
     // Parse args
     enum { ARG_type, ARG_subtype, ARG_label, ARG_block_size };
@@ -284,11 +316,51 @@ static const mp_rom_map_elem_t esp32_partition_locals_dict_table[] = {
 };
 static MP_DEFINE_CONST_DICT(esp32_partition_locals_dict, esp32_partition_locals_dict_table);
 
+#if MICROPY_VFS_ROM
+#define ESP32_PARTITION_GET_BUFFER buffer, esp32_partition_get_buffer,
+#else
+#define ESP32_PARTITION_GET_BUFFER
+#endif
+
 MP_DEFINE_CONST_OBJ_TYPE(
     esp32_partition_type,
     MP_QSTR_Partition,
     MP_TYPE_FLAG_NONE,
     make_new, esp32_partition_make_new,
     print, esp32_partition_print,
+    ESP32_PARTITION_GET_BUFFER
    locals_dict, &esp32_partition_locals_dict
     );
+
+/******************************************************************************/
+// romfs partition
+
+#if MICROPY_VFS_ROM
+
+mp_obj_t mp_vfs_rom_ioctl(size_t n_args, const mp_obj_t *args) {
+    if (esp32_partition_romfs_obj.base.type == NULL) {
+        esp32_partition_romfs_obj.base.type = &esp32_partition_type;
+        // Get the romfs partition.
+        // TODO: number of segments ioctl can be used if there is more than one romfs.
+        esp_partition_iterator_t iter = esp_partition_find(ESP_PARTITION_TYPE_DATA, ESP_PARTITION_SUBTYPE_ANY, "romfs");
+        if (iter != NULL) {
+            esp32_partition_romfs_obj.part = esp_partition_get(iter);
+        }
+        esp_partition_iterator_release(iter);
+    }
+
+    if (esp32_partition_romfs_obj.part == NULL) {
+        return MP_OBJ_NEW_SMALL_INT(-MP_ENODEV);
+    }
+
+    switch (mp_obj_get_int(args[0])) {
+        case MP_VFS_ROM_IOCTL_GET_NUMBER_OF_SEGMENTS:
+            return MP_OBJ_NEW_SMALL_INT(1);
+        case MP_VFS_ROM_IOCTL_GET_SEGMENT:
+            return MP_OBJ_FROM_PTR(&esp32_partition_romfs_obj);
+        default:
+            return MP_OBJ_NEW_SMALL_INT(-MP_EINVAL);
+    }
+}
+
+#endif // MICROPY_VFS_ROM
diff --git a/ports/esp32/modules/_boot.py b/ports/esp32/modules/_boot.py
@@ -1,7 +1,14 @@
 import gc
 import vfs
+import sys
 from flashbdev import bdev
 
+try:
+    vfs.mount(vfs.VfsRom(vfs.rom_ioctl(2)), "/rom")
+    sys.path.insert(0, "/rom")
+except:
+    pass
+
 try:
     if bdev:
         vfs.mount(bdev, "/")
@@ -11,3 +18,5 @@
     inisetup.setup()
 
 gc.collect()
+
+del sys
diff --git a/ports/esp32/mpconfigport.h b/ports/esp32/mpconfigport.h
@@ -70,6 +70,7 @@
 #define MICROPY_USE_INTERNAL_PRINTF         (0) // ESP32 SDK requires its own printf
 #define MICROPY_SCHEDULER_DEPTH             (8)
 #define MICROPY_VFS                         (1)
+#define MICROPY_VFS_ROM                     (1)
 
 // control over Python builtins
 #define MICROPY_PY_STR_BYTES_CMP_WARN       (1)

diff --git a/ports/esp32/partitions-4MiB.csv b/ports/esp32/partitions-4MiB.csv
@@ -3,5 +3,6 @@
 # Name,   Type, SubType, Offset,  Size, Flags
 nvs,      data, nvs,     0x9000,  0x6000,
 phy_init, data, phy,     0xf000,  0x1000,
-factory,  app,  factory, 0x10000, 0x1F0000,
+factory,  app,  factory, 0x10000, 0x1D0000,
+romfs,    data, 0x8f,    0x1E0000, 0x20000,
 vfs,      data, fat,     0x200000, 0x200000,
diff --git a/ports/esp8266/boards/ESP8266_GENERIC/_boot.py b/ports/esp8266/boards/ESP8266_GENERIC/_boot.py
@@ -1,6 +1,13 @@
 # Minimal _boot.py for the 512kiB variant. Does not set up a block device or
 # filesystem. Other variants use esp8266/modules/_boot.py.
 
-import gc
+import gc, vfs
 
 gc.threshold((gc.mem_free() + gc.mem_alloc()) // 4)
+
+# Try to mount the ROMFS.
+try:
+    vfs.mount(vfs.VfsRom(vfs.rom_ioctl(2)), "/")
+except:
+    pass
+
diff --git a/ports/esp8266/boards/ESP8266_GENERIC/manifest_512kiB.py b/ports/esp8266/boards/ESP8266_GENERIC/manifest_512kiB.py
@@ -1,9 +1,9 @@
 module("_boot.py", opt=3)
37BFmodule("apa102.py", base_path="$(PORT_DIR)/modules", opt=3)
-module("port_diag.py", base_path="$(PORT_DIR)/modules", opt=3)
-require("ntptime")
-require("dht")
-require("onewire")
-require("ds18x20")
-require("webrepl")
-require("neopixel")
+# module("apa102.py", base_path="$(PORT_DIR)/modules", opt=3)
+# module("port_diag.py", base_path="$(PORT_DIR)/modules", opt=3)
+# require("ntptime")
+# require("dht")
+# require("onewire")
+# require("ds18x20")
+# require("webrepl")
+# require("neopixel")
diff --git a/ports/esp8266/boards/ESP8266_GENERIC/mpconfigboard.h b/ports/esp8266/boards/ESP8266_GENERIC/mpconfigboard.h
@@ -3,32 +3,23 @@
 #define MICROPY_HW_BOARD_NAME "ESP module"
 #define MICROPY_HW_MCU_NAME "ESP8266"
 
-#define MICROPY_PERSISTENT_CODE_LOAD    (1)
 #define MICROPY_EMIT_XTENSA             (1)
 #define MICROPY_EMIT_INLINE_XTENSA      (1)
 
 #define MICROPY_ERROR_REPORTING         (MICROPY_ERROR_REPORTING_NORMAL)
 
-#define MICROPY_READER_VFS              (MICROPY_VFS)
-#define MICROPY_VFS                     (1)
-
 #define MICROPY_PY_CRYPTOLIB            (1)
 
 #elif defined(MICROPY_ESP8266_1M)
 
 #define MICROPY_HW_BOARD_NAME "ESP module (1M)"
 #define MICROPY_HW_MCU_NAME "ESP8266"
 
-#define MICROPY_PERSISTENT_CODE_LOAD    (1)
 #define MICROPY_EMIT_XTENSA             (1)
 #define MICROPY_EMIT_INLINE_XTENSA      (1)
 
 #define MICROPY_ERROR_REPORTING         (MICROPY_ERROR_REPORTING_NORMAL)
 
-#define MICROPY_READER_VFS              (MICROPY_VFS)
-#define MICROPY_VFS                     (1)
-
-
 #define MICROPY_PY_CRYPTOLIB            (1)
 
 #elif defined(MICROPY_ESP8266_512K)
@@ -46,5 +37,18 @@
 #define MICROPY_PY_ASYNCIO              (0)
 #define MICROPY_PY_RE_SUB               (0)
 #define MICROPY_PY_FRAMEBUF             (0)
+#define MICROPY_PY_HEAPQ                (0)
+
+#define MICROPY_VFS_WRITABLE            (0)
+
+#define MICROPY_PY_ESP_FLASH_FUNCS      (0)
+#define MICROPY_PY_ESP_EXTRA_FUNCS      (0)
 
 #endif
+
+// Configuration common to all variants.
+
+#define MICROPY_PERSISTENT_CODE_LOAD    (1)
+#define MICROPY_READER_VFS              (MICROPY_VFS)
+#define MICROPY_VFS                     (1)
+#define MICROPY_VFS_ROM                 (1)
diff --git a/ports/esp8266/boards/esp8266_1MiB.ld b/ports/esp8266/boards/esp8266_1MiB.ld
@@ -2,7 +2,8 @@
 
    Flash layout:
     0x40200000 36k  header + iram/dram init
-    0x40209000 572k firmware (irom0)
+    0x40209000 556k firmware (irom0)
+    0x40294000 16k  ROMFS
     0x40298000 396k filesystem
     0x402fb000 20k  SDK parameters
 */
@@ -12,7 +13,8 @@ MEMORY
     dport0_0_seg : org = 0x3ff00000, len = 16
     dram0_0_seg :  org = 0x3ffe8000, len = 80K
     iram1_0_seg :  org = 0x40100000, len = 32K
-    irom0_0_seg :  org = 0x40209000, len = 572K
+    irom0_0_seg :  org = 0x40209000, len = 556K
+    FLASH_ROMFS :  org = 0x40294000, len = 16K
 }
 
 /* define common sections and symbols */

diff --git a/ports/esp8266/boards/esp8266_2MiB.ld b/ports/esp8266/boards/esp8266_2MiB.ld
@@ -2,7 +2,8 @@
 
    Flash layout:
     0x40200000 36k  header + iram/dram init
-    0x40209000 988k firmware (irom0)
+    0x40209000 732k firmware (irom0)
+    0x402c0000 256k ROMFS
     0x40300000 1M+  filesystem (not memory mapped)
 *
10000
/
 
@@ -11,7 +12,8 @@ MEMORY
     dport0_0_seg : org = 0x3ff00000, len = 16
     dram0_0_seg :  org = 0x3ffe8000, len = 80K
     iram1_0_seg :  org = 0x40100000, len = 32K
-    irom0_0_seg :  org = 0x40209000, len = 1M - 36K
+    irom0_0_seg :  org = 0x40209000, len = 1M - 36K - 256K
+    FLASH_ROMFS :  org = 0x402c0000, len = 256K
 }
 
 /* define common sections and symbols */

diff --git a/ports/esp8266/boards/esp8266_512kiB.ld b/ports/esp8266/boards/esp8266_512kiB.ld
@@ -2,7 +2,8 @@
 
    Flash layout:
     0x40200000 36k  header + iram/dram init
-    0x40209000 456k firmware (irom0)
+    0x40209000 448k firmware (irom0)
+    0x40279000 8k   ROMFS
     0x4027b000 20k  SDK parameters
 */
 
@@ -11,7 +12,8 @@ MEMORY
     dport0_0_seg : org = 0x3ff00000, len = 16
     dram0_0_seg :  org = 0x3ffe8000, len = 80K
     iram1_0_seg :  org = 0x40100000, len = 32K
-    irom0_0_seg :  org = 0x40209000, len = 512K - 36K - 20K
+    irom0_0_seg :  org = 0x40209000, len = 512K - 36K - 20K - 8K
+    FLASH_ROMFS :  org = 0x4027a000, len = 8K
 }
 
 /* define common sections and symbols */

diff --git a/ports/esp8266/boards/esp8266_common.ld b/ports/esp8266/boards/esp8266_common.ld
@@ -3,6 +3,10 @@
 /* define the top of RAM */
 _heap_end = ORIGIN(dram0_0_seg) + LENGTH(dram0_0_seg);
 
+/* define ROMFS extents */
+_micropy_hw_romfs_start = ORIGIN(FLASH_ROMFS);
+_micropy_hw_romfs_size = LENGTH(FLASH_ROMFS);
+
 PHDRS
 {
     dport0_0_phdr PT_LOAD;

diff --git a/ports/esp8266/boards/esp8266_ota.ld b/ports/esp8266/boards/esp8266_ota.ld
@@ -6,7 +6,8 @@ MEMORY
     dram0_0_seg :  org = 0x3ffe8000, len = 0x14000
     iram1_0_seg :  org = 0x40100000, len = 0x8000
     /* 0x3c000 is size of bootloader, 0x9000 is size of packed RAM segments */
-    irom0_0_seg :  org = 0x40200000 + 0x3c000 + 0x9000, len = 0x8f000
+    irom0_0_seg :  org = 0x40200000 + 0x3c000 + 0x9000, len = 0x8f000 - 8K
+    FLASH_ROMFS :  org = 0x402d2000, len = 8K
 }
 
 /* define common sections and symbols */