ports/rp2: Per-board linker flash config.

Gadgetoid · Gadgetoid · commit c7b8241bc4f0 · 2022-08-04T12:51:50.000+01:00
Add per-board flash config to avoid silently
overwriting user code on vfs init.

Make linker FLASH section reflect board size.

Add linker APP section for user code.

Add linker FILESYSTEM section for vfs.

Add per-board config for FLASH + APP sizes:

* MICROPY_HW_FLASH_SIZE_BYTES
* MICROPY_HW_APP_SIZE_BYTES

CMake "configure_file" memmap_mp.ld.in.

Signed-off-by: Phil Howard &lt;phil@pimoroni.com&gt;
diff --git a/ports/rp2/CMakeLists.txt b/ports/rp2/CMakeLists.txt
@@ -390,26 +390,36 @@ target_compile_definitions(${MICROPY_TARGET} PRIVATE
     MICROPY_BUILD_TYPE="${CMAKE_C_COMPILER_ID} ${CMAKE_C_COMPILER_VERSION} ${CMAKE_BUILD_TYPE}"
     PICO_NO_BI_STDIO_UART=1 # we call it UART REPL
     PICO_RP2040_USB_DEVICE_ENUMERATION_FIX=1
+    MICROPY_HW_FLASH_SIZE_BYTES=${MICROPY_HW_FLASH_SIZE_BYTES}
+    MICROPY_HW_APP_SIZE_BYTES=${MICROPY_HW_APP_SIZE_BYTES}
 )
 
 target_link_libraries(${MICROPY_TARGET}
     ${PICO_SDK_COMPONENTS}
 )
 
+target_link_options(${MICROPY_TARGET} PRIVATE
+    -Wl,--print-memory-usage
+)
+
 if (MICROPY_HW_ENABLE_DOUBLE_TAP)
 # Enable double tap reset into bootrom.
 target_link_libraries(${MICROPY_TARGET}
     pico_bootsel_via_double_reset
 )
 endif()
 
+# parse the linker file, replacing ${MICROPY_HW_FLASH_SIZE_BYTES}, etc with their values
+configure_file(${CMAKE_CURRENT_LIST_DIR}/memmap_mp.ld.in ${CMAKE_CURRENT_BINARY_DIR}/memmap_mp.ld)
+
 # todo this is a bit brittle, but we want to move a few source files into RAM (which requires
 #  a linker script modification) until we explicitly add  macro calls around the function
 #  defs to move them into RAM.
 if (PICO_ON_DEVICE AND NOT PICO_NO_FLASH AND NOT PICO_COPY_TO_RAM)
-    pico_set_linker_script(${MICROPY_TARGET} ${CMAKE_CURRENT_LIST_DIR}/memmap_mp.ld)
+    pico_set_linker_script(${MICROPY_TARGET} ${CMAKE_CURRENT_BINARY_DIR}/memmap_mp.ld)
 endif()
 
+
 pico_add_extra_outputs(${MICROPY_TARGET})
 
 add_custom_command(TARGET ${MICROPY_TARGET}
diff --git a/ports/rp2/boards/ADAFRUIT_FEATHER_RP2040/mpconfigboard.cmake b/ports/rp2/boards/ADAFRUIT_FEATHER_RP2040/mpconfigboard.cmake
@@ -1 +1,3 @@
 # cmake file for Adafruit Feather RP2040
+set(MICROPY_HW_FLASH_SIZE_BYTES "8 * 1024 * 1024")
+set(MICROPY_HW_APP_SIZE_BYTES   "1 * 1024 * 1024")
diff --git a/ports/rp2/boards/ADAFRUIT_FEATHER_RP2040/mpconfigboard.h b/ports/rp2/boards/ADAFRUIT_FEATHER_RP2040/mpconfigboard.h
@@ -2,7 +2,6 @@
 // https://learn.adafruit.com/adafruit-feather-rp2040-pico/pinouts
 
 #define MICROPY_HW_BOARD_NAME          "Adafruit Feather RP2040"
-#define MICROPY_HW_FLASH_STORAGE_BYTES (7 * 1024 * 1024)
 
 #define MICROPY_HW_USB_VID (0x239A)
 #define MICROPY_HW_USB_PID (0x80F2)
diff --git a/ports/rp2/boards/ADAFRUIT_ITSYBITSY_RP2040/mpconfigboard.cmake b/ports/rp2/boards/ADAFRUIT_ITSYBITSY_RP2040/mpconfigboard.cmake
@@ -1 +1,4 @@
 # cmake file for Adafruit ItsyBitsy RP2040
+set(MICROPY_HW_FLASH_SIZE_BYTES "8 * 1024 * 1024")
+set(MICROPY_HW_APP_SIZE_BYTES   "1 * 1024 * 1024")
+
diff --git a/ports/rp2/boards/ADAFRUIT_ITSYBITSY_RP2040/mpconfigboard.h b/ports/rp2/boards/ADAFRUIT_ITSYBITSY_RP2040/mpconfigboard.h
@@ -2,7 +2,6 @@
 // https://learn.adafruit.com/adafruit-itsybitsy-rp2040/pinouts
 
 #define MICROPY_HW_BOARD_NAME          "Adafruit ItsyBitsy RP2040"
-#define MICROPY_HW_FLASH_STORAGE_BYTES (7 * 1024 * 1024)
 
 #define MICROPY_HW_USB_VID (0x239A)
 #define MICROPY_HW_USB_PID (0x80FE)
diff --git a/ports/rp2/boards/ADAFRUIT_QTPY_RP2040/mpconfigboard.cmake b/ports/rp2/boards/ADAFRUIT_QTPY_RP2040/mpconfigboard.cmake
@@ -1 +1,4 @@
 # cmake file for Adafruit QT Py RP2040
+set(MICROPY_HW_FLASH_SIZE_BYTES "8 * 1024 * 1024")
+set(MICROPY_HW_APP_SIZE_BYTES   "1 * 1024 * 1024")
+
diff --git a/ports/rp2/boards/ADAFRUIT_QTPY_RP2040/mpconfigboard.h b/ports/rp2/boards/ADAFRUIT_QTPY_RP2040/mpconfigboard.h
@@ -2,7 +2,6 @@
 // https://learn.adafruit.com/adafruit-qt-py-2040/pinouts
 
 #define MICROPY_HW_BOARD_NAME          "Adafruit QT Py RP2040"
-#define MICROPY_HW_FLASH_STORAGE_BYTES (7 * 1024 * 1024)
 
 #define MICROPY_HW_USB_VID (0x239A)
 #define MICROPY_HW_USB_PID (0x80F8)
diff --git a/ports/rp2/boards/ARDUINO_NANO_RP2040_CONNECT/mpconfigboard.cmake b/ports/rp2/boards/ARDUINO_NANO_RP2040_CONNECT/mpconfigboard.cmake
@@ -1,4 +1,10 @@
 # cmake file for Arduino Nano RP2040 Connect.
+
+# This is a 16MB board? Was an 8MB firmware size intentional?
+# https://github.com/raspberrypi/pico-sdk/blob/master/src/boards/include/boards/arduino_nano_rp2040_connect.h#L76
+set(MICROPY_HW_FLASH_SIZE_BYTES "16 * 1024 * 1024")
+set(MICROPY_HW_APP_SIZE_BYTES    "8 * 1024 * 1024")
+
 set(MICROPY_PY_BLUETOOTH  1)
 set(MICROPY_BLUETOOTH_NIMBLE  1)
 set(MICROPY_PY_NETWORK_NINAW10 1)
diff --git a/ports/rp2/boards/ARDUINO_NANO_RP2040_CONNECT/mpconfigboard.h b/ports/rp2/boards/ARDUINO_NANO_RP2040_CONNECT/mpconfigboard.h
@@ -2,7 +2,6 @@
 
 // Board and hardware specific configuration
 #define MICROPY_HW_BOARD_NAME           "Arduino Nano RP2040 Connect"
-#define MICROPY_HW_FLASH_STORAGE_BYTES  (8 * 1024 * 1024)
 
 // Enable networking.
 #define MICROPY_PY_NETWORK              (1)
diff --git a/ports/rp2/boards/GARATRONIC_PYBSTICK26_RP2040/mpconfigboard.cmake b/ports/rp2/boards/GARATRONIC_PYBSTICK26_RP2040/mpconfigboard.cmake
@@ -1,3 +1,5 @@
 # cmake file
 
+set(MICROPY_HW_FLASH_SIZE_BYTES "1 * 1024 * 1024")
+set(MICROPY_HW_APP_SIZE_BYTES        "384 * 1024")
 set(PICO_BOARD garatronic_pybstick26_rp2040)
diff --git a/ports/rp2/boards/GARATRONIC_PYBSTICK26_RP2040/mpconfigboard.h b/ports/rp2/boards/GARATRONIC_PYBSTICK26_RP2040/mpconfigboard.h
@@ -1,3 +1,2 @@
 // Board and hardware specific configuration
 #define MICROPY_HW_BOARD_NAME                   "GARATRONIC_PYBSTICK26_RP2040"
-#define MICROPY_HW_FLASH_STORAGE_BYTES          (384 * 1024)
diff --git a/ports/rp2/boards/PICO/mpconfigboard.cmake b/ports/rp2/boards/PICO/mpconfigboard.cmake
@@ -1 +1,3 @@
 # cmake file for Raspberry Pi Pico
+set(MICROPY_HW_FLASH_SIZE_BYTES "2 * 1024 * 1024")
+set(MICROPY_HW_APP_SIZE_BYTES        "640 * 1024")
diff --git a/ports/rp2/boards/PICO/mpconfigboard.h b/ports/rp2/boards/PICO/mpconfigboard.h
@@ -1,6 +1,5 @@
 // Board and hardware specific configuration
 #define MICROPY_HW_BOARD_NAME                   "Raspberry Pi Pico"
-#define MICROPY_HW_FLASH_STORAGE_BYTES          (1408 * 1024)
 
 // Enable USB Mass Storage with FatFS filesystem.
 // #define MICROPY_HW_USB_MSC  (1)
diff --git a/ports/rp2/boards/PIMORONI_PICOLIPO_16MB/mpconfigboard.cmake b/ports/rp2/boards/PIMORONI_PICOLIPO_16MB/mpconfigboard.cmake
@@ -1 +1,3 @@
 # cmake file for Pimoroni Pico LiPo 16MB
+set(MICROPY_HW_FLASH_SIZE_BYTES "16 * 1024 * 1024")
+set(MICROPY_HW_APP_SIZE_BYTES    "1 * 1024 * 1024")
diff --git a/ports/rp2/boards/PIMORONI_PICOLIPO_16MB/mpconfigboard.h b/ports/rp2/boards/PIMORONI_PICOLIPO_16MB/mpconfigboard.h
@@ -1,7 +1,6 @@
 // https://shop.pimoroni.com/products/pimoroni-pico-lipo?variant=39335427080275
 
 #define MICROPY_HW_BOARD_NAME          "Pimoroni Pico LiPo 16MB"
-#define MICROPY_HW_FLASH_STORAGE_BYTES (15 * 1024 * 1024)
 
 #define MICROPY_HW_USB_VID (0x2E8A)
 #define MICROPY_HW_USB_PID (0x1003)
diff --git a/ports/rp2/boards/PIMORONI_PICOLIPO_4MB/mpconfigboard.cmake b/ports/rp2/boards/PIMORONI_PICOLIPO_4MB/mpconfigboard.cmake
@@ -1 +1,3 @@
 # cmake file for Pimoroni Pico LiPo 4MB
+set(MICROPY_HW_FLASH_SIZE_BYTES "4 * 1024 * 1024")
+set(MICROPY_HW_APP_SIZE_BYTES   "1 * 1024 * 1024")
diff --git a/ports/rp2/boards/PIMORONI_PICOLIPO_4MB/mpconfigboard.h b/ports/rp2/boards/PIMORONI_PICOLIPO_4MB/mpconfigboard.h
@@ -1,7 +1,6 @@
 // https://shop.pimoroni.com/products/pimoroni-pico-lipo?variant=39386149093459
 
 #define MICROPY_HW_BOARD_NAME          "Pimoroni Pico LiPo 4MB"
-#define MICROPY_HW_FLASH_STORAGE_BYTES (3 * 1024 * 1024)
 
 #define MICROPY_HW_USB_VID (0x2E8A)
 #define MICROPY_HW_USB_PID (0x1002)
diff --git a/ports/rp2/boards/PIMORONI_TINY2040/mpconfigboard.cmake b/ports/rp2/boards/PIMORONI_TINY2040/mpconfigboard.cmake
@@ -1 +1,3 @@
 # cmake file for Pimoroni Tiny 2040
+set(MICROPY_HW_FLASH_SIZE_BYTES "8 * 1024 * 1024")
+set(MICROPY_HW_APP_SIZE_BYTES   "1 * 1024 * 1024")
diff --git a/ports/rp2/boards/PIMORONI_TINY2040/mpconfigboard.h b/ports/rp2/boards/PIMORONI_TINY2040/mpconfigboard.h
@@ -1,7 +1,6 @@
 // https://shop.pimoroni.com/products/tiny-2040
 
 #define MICROPY_HW_BOARD_NAME          "Pimoroni Tiny 2040"
-#define MICROPY_HW_FLASH_STORAGE_BYTES (7 * 1024 * 1024)
 
 #define MICROPY_HW_USB_VID (0x16D0)
 #define MICROPY_HW_USB_PID (0x08C7)
diff --git a/ports/rp2/boards/SPARKFUN_PROMICRO/mpconfigboard.cmake b/ports/rp2/boards/SPARKFUN_PROMICRO/mpconfigboard.cmake
@@ -1 +1,3 @@
 # cmake file for SparkFun Pro Micro RP2040
+set(MICROPY_HW_FLASH_SIZE_BYTES "16 * 1024 * 1024")
+set(MICROPY_HW_APP_SIZE_BYTES    "1 * 1024 * 1024")
diff --git a/ports/rp2/boards/SPARKFUN_PROMICRO/mpconfigboard.h b/ports/rp2/boards/SPARKFUN_PROMICRO/mpconfigboard.h
@@ -1,7 +1,6 @@
 // https://www.sparkfun.com/products/17717
 
 #define MICROPY_HW_BOARD_NAME          "SparkFun Pro Micro RP2040"
-#define MICROPY_HW_FLASH_STORAGE_BYTES (15 * 1024 * 1024)
 
 #define MICROPY_HW_USB_VID (0x1B4F)
 #define MICROPY_HW_USB_PID (0x0026)
diff --git a/ports/rp2/boards/SPARKFUN_THINGPLUS/mpconfigboard.cmake b/ports/rp2/boards/SPARKFUN_THINGPLUS/mpconfigboard.cmake
@@ -1 +1,3 @@
 # cmake file for SparkFun Thing Plus RP2040
+set(MICROPY_HW_FLASH_SIZE_BYTES "16 * 1024 * 1024")
+set(MICROPY_HW_APP_SIZE_BYTES    "1 * 1024 * 1024")
diff --git a/ports/rp2/boards/SPARKFUN_THINGPLUS/mpconfigboard.h b/ports/rp2/boards/SPARKFUN_THINGPLUS/mpconfigboard.h
@@ -1,7 +1,6 @@
 // https://www.sparkfun.com/products/17745
 
 #define MICROPY_HW_BOARD_NAME          "SparkFun Thing Plus RP2040"
-#define MICROPY_HW_FLASH_STORAGE_BYTES (15 * 1024 * 1024)
 
 #define MICROPY_HW_USB_VID (0x1B4F)
 #define MICROPY_HW_USB_PID (0x0025)
diff --git a/ports/rp2/boards/W5100S_EVB_PICO/mpconfigboard.cmake b/ports/rp2/boards/W5100S_EVB_PICO/mpconfigboard.cmake
@@ -1,4 +1,6 @@
 # cmake file for Wiznet W5100S-EVB-Pico.
+set(MICROPY_HW_FLASH_SIZE_BYTES "2 * 1024 * 1024")
+set(MICROPY_HW_APP_SIZE_BYTES        "640 * 1024")
 set(PICO_BOARD pico)
 set(MICROPY_PY_NETWORK_WIZNET5K W5100S)
 set(MICROPY_PY_LWIP 1)
diff --git a/ports/rp2/boards/W5100S_EVB_PICO/mpconfigboard.h b/ports/rp2/boards/W5100S_EVB_PICO/mpconfigboard.h
@@ -2,7 +2,6 @@
 
 // Board and hardware specific configuration
 #define MICROPY_HW_BOARD_NAME             "W5100S-EVB-Pico"
-#define MICROPY_HW_FLASH_STORAGE_BYTES    (1408 * 1024)
 
 // Enable networking.
 #define MICROPY_PY_NETWORK                (1)
diff --git a/ports/rp2/memmap_mp.ld.in b/ports/rp2/memmap_mp.ld.in
@@ -21,12 +21,23 @@
     __stack (== StackTop)
 */
 
+
+/* Default RP2 flash size. Assumes no user filesystem. */
+_flash_start    = 0x10000000;
+_flash_size     = ${MICROPY_HW_FLASH_SIZE_BYTES};
+_flash_app_size = ${MICROPY_HW_APP_SIZE_BYTES};
+_flash_fs_size  = _flash_size - _flash_app_size;
+_flash_fs_start = _flash_start + _flash_app_size;
+
+
 MEMORY
 {
-    FLASH(rx) : ORIGIN = 0x10000000, LENGTH = 2048k
-    RAM(rwx) : ORIGIN =  0x20000000, LENGTH = 256k
-    SCRATCH_X(rwx) : ORIGIN = 0x20040000, LENGTH = 4k
-    SCRATCH_Y(rwx) : ORIGIN = 0x20041000, LENGTH = 4k
+    FLASH(rx)      : ORIGIN = _flash_start,    LENGTH = _flash_size
+    APP(rx)        : ORIGIN = _flash_start,    LENGTH = _flash_app_size
+    FILESYSTEM(r)  : ORIGIN = _flash_fs_start, LENGTH = _flash_fs_size
+    RAM(rwx)       : ORIGIN = 0x20000000,      LENGTH = 256k
+    SCRATCH_X(rwx) : ORIGIN = 0x20040000,      LENGTH = 4k
+    SCRATCH_Y(rwx) : ORIGIN = 0x20041000,      LENGTH = 4k
 }
 
 ENTRY(_entry_point)
@@ -38,15 +49,19 @@ SECTIONS
        in the Raspberry Pi Pico SDK
     */
 
+    __vfs_start = ORIGIN(FILESYSTEM);
+    __vfs_end = __vfs_start + LENGTH(FILESYSTEM);
+    __flash_start = _flash_start;
+
     .flash_begin : {
         __flash_binary_start = .;
-    } > FLASH
+    } > APP
 
     .boot2 : {
         __boot2_start__ = .;
         KEEP (*(.boot2))
         __boot2_end__ = .;
-    } > FLASH
+    } > APP
 
     ASSERT(__boot2_end__ - __boot2_start__ == 256,
         "ERROR: Pico second stage bootloader must be 256 bytes in size")
@@ -66,7 +81,7 @@ SECTIONS
         KEEP (*(.reset))
         /* TODO revisit this now memset/memcpy/float in ROM */
         /* bit of a hack right now to exclude all floating point and time critical (e.g. memset, memcpy) code from
-         * FLASH ... we will include any thing excluded here in .data below by default */
+         * APP ... we will include any thing excluded here in .data below by default */
         *(.init)
         /* Change for MicroPython... excluse gc.c, parse.c, vm.c from flash */
         *(EXCLUDE_FILE(*libgcc.a: *libc.a: *lib_a-mem*.o *libm.a: *gc.c.obj *vm.c.obj *parse.c.obj) .text*)
@@ -86,25 +101,25 @@ SECTIONS
 
         *(.eh_frame*)
         . = ALIGN(4);
-    } > FLASH
+    } > APP
 
     .rodata : {
         *(EXCLUDE_FILE(*libgcc.a: *libc.a:*lib_a-mem*.o *libm.a:) .rodata*)
         . = ALIGN(4);
         *(SORT_BY_ALIGNMENT(SORT_BY_NAME(.flashdata*)))
         . = ALIGN(4);
-    } > FLASH
+    } > APP
 
     .ARM.extab :
     {
         *(.ARM.extab* .gnu.linkonce.armextab.*)
-    } > FLASH
+    } > APP
 
     __exidx_start = .;
     .ARM.exidx :
     {
         *(.ARM.exidx* .gnu.linkonce.armexidx.*)
-    } > FLASH
+    } > APP
     __exidx_end = .;
 
     /* Machine inspectable binary information */
@@ -114,7 +129,7 @@ SECTIONS
     {
         KEEP(*(.binary_info.keep.*))
         *(.binary_info.*)
-    } > FLASH
+    } > APP
     __binary_info_end = .;
     . = ALIGN(4);
 
@@ -173,7 +188,7 @@ SECTIONS
         . = ALIGN(4);
         /* All data end */
         __data_end__ = .;
-    } > RAM AT> FLASH
+    } > RAM AT> APP
 
     .uninitialized_data (COPY): {
         . = ALIGN(4);
@@ -186,15 +201,15 @@ SECTIONS
         *(.scratch_x.*)
         . = ALIGN(4);
         __scratch_x_end__ = .;
-    } > SCRATCH_X AT > FLASH
+    } > SCRATCH_X AT > APP
     __scratch_x_source__ = LOADADDR(.scratch_x);
 
     .scratch_y : {
         __scratch_y_start__ = .;
         *(.scratch_y.*)
         . = ALIGN(4);
         __scratch_y_end__ = .;
-    } > SCRATCH_Y AT > FLASH
+    } > SCRATCH_Y AT > APP
     __scratch_y_source__ = LOADADDR(.scratch_y);
 
     .bss  : {
@@ -234,7 +249,7 @@ SECTIONS
 
     .flash_end : {
         __flash_binary_end = .;
-    } > FLASH
+    } > APP
 
     /* stack limit is poorly named, but historically is maximum heap ptr */
     __StackLimit = ORIGIN(RAM) + LENGTH(RAM);
diff --git a/ports/rp2/rp2_flash.c b/ports/rp2/rp2_flash.c
@@ -34,15 +34,24 @@
 
 #define BLOCK_SIZE_BYTES (FLASH_SECTOR_SIZE)
 
+#ifndef MICROPY_HW_FLASH_SIZE_BYTES
+#define MICROPY_HW_FLASH_SIZE_BYTES (2 * 1024 * 1024)
+#endif
+
+#ifndef MICROPY_HW_APP_SIZE_BYTES
+#define MICROPY_HW_APP_SIZE_BYTES (640 * 1024)
+#endif
+
 #ifndef MICROPY_HW_FLASH_STORAGE_BYTES
-#define MICROPY_HW_FLASH_STORAGE_BYTES (1408 * 1024)
+#define MICROPY_HW_FLASH_STORAGE_BYTES (MICROPY_HW_FLASH_SIZE_BYTES - MICROPY_HW_APP_SIZE_BYTES)
 #endif
 static_assert(MICROPY_HW_FLASH_STORAGE_BYTES % 4096 == 0, "Flash storage size must be a multiple of 4K");
 
 #ifndef MICROPY_HW_FLASH_STORAGE_BASE
-#define MICROPY_HW_FLASH_STORAGE_BASE (PICO_FLASH_SIZE_BYTES - MICROPY_HW_FLASH_STORAGE_BYTES)
+#define MICROPY_HW_FLASH_STORAGE_BASE (MICROPY_HW_APP_SIZE_BYTES)
 #endif
 
+static_assert(PICO_FLASH_SIZE_BYTES == MICROPY_HW_FLASH_SIZE_BYTES, "MICROPY_HW_FLASH_SIZE_BYTES does not match PICO_FLASH_SIZE_BYTES");
 static_assert(MICROPY_HW_FLASH_STORAGE_BYTES <= PICO_FLASH_SIZE_BYTES, "MICROPY_HW_FLASH_STORAGE_BYTES too big");
 static_assert(MICROPY_HW_FLASH_STORAGE_BASE + MICROPY_HW_FLASH_STORAGE_BYTES <= PICO_FLASH_SIZE_BYTES, "MICROPY_HW_FLASH_STORAGE_BYTES too big");
 

Original file line number	Diff line number	Diff line change
`@@ -1 +1,3 @@`
`1`	`1`	`# cmake file for Adafruit Feather RP2040`
	`2`	`+set(MICROPY_HW_FLASH_SIZE_BYTES "8 * 1024 * 1024")`
	`3`	`+set(MICROPY_HW_APP_SIZE_BYTES "1 * 1024 * 1024")`