add storage extension python api

Author: microdev1

locale/circuitpython.pot

@@ -152,14 +152,6 @@ msgstr ""
 msgid "%q must be >= %d"
 msgstr ""
 
-#: py/argcheck.c
-msgid "%q must be >= 0"
-msgstr ""
-
-#: shared-bindings/vectorio/Circle.c shared-bindings/vectorio/Rectangle.c
-msgid "%q must be >= 1"
-msgstr ""
-
 #: shared-bindings/analogbufio/BufferedIn.c
 #: shared-bindings/audiocore/RawSample.c
 msgid "%q must be a bytearray or array of type 'h', 'H', 'b', or 'B'"
@@ -910,8 +902,7 @@ msgstr ""
 msgid "Error: Failure to bind"
 msgstr ""
 
-#: ports/raspberrypi/bindings/rp2pio/StateMachine.c py/enum.c
-#: shared-bindings/_bleio/__init__.c shared-bindings/aesio/aes.c
+#: py/enum.c shared-bindings/_bleio/__init__.c shared-bindings/aesio/aes.c
 #: shared-bindings/alarm/__init__.c shared-bindings/busio/SPI.c
 #: shared-bindings/microcontroller/Pin.c
 #: shared-bindings/neopixel_write/__init__.c
@@ -1569,10 +1560,12 @@ msgid "Only 8 or 16 bit mono with "
 msgstr ""
 
 #: ports/espressif/common-hal/wifi/__init__.c
+#: ports/raspberrypi/common-hal/wifi/__init__.c
 msgid "Only IPv4 addresses supported"
 msgstr ""
 
 #: ports/espressif/common-hal/socketpool/Socket.c
+#: ports/raspberrypi/common-hal/socketpool/Socket.c
 msgid "Only IPv4 sockets supported"
 msgstr ""
 
@@ -1642,6 +1635,7 @@ msgid "Out of memory"
 msgstr ""
 
 #: ports/espressif/common-hal/socketpool/Socket.c
+#: ports/raspberrypi/common-hal/socketpool/Socket.c
 msgid "Out of sockets"
 msgstr ""
 
@@ -1696,7 +1690,6 @@ msgid "Pin interrupt already in use"
 msgstr ""
 
 #: shared-bindings/adafruit_bus_device/spi_device/SPIDevice.c
-#: shared-bindings/digitalio/DigitalInOut.c
 msgid "Pin is input only"
 msgstr ""
 
@@ -1916,6 +1909,7 @@ msgid "Slices not supported"
 msgstr ""
 
 #: ports/espressif/common-hal/socketpool/SocketPool.c
+#: ports/raspberrypi/common-hal/socketpool/SocketPool.c
 msgid "SocketPool can only be used with wifi.radio"
 msgstr ""
 
@@ -2341,10 +2335,6 @@ msgstr ""
 msgid "a bytes-like object is required"
 msgstr ""
 
-#: shared-bindings/i2ctarget/I2CTarget.c
-msgid "address out of bounds"
-msgstr ""
-
 #: shared-bindings/i2ctarget/I2CTarget.c
 msgid "addresses is empty"
 msgstr ""
@@ -2814,10 +2804,6 @@ msgstr ""
 msgid "destination buffer must be an array of type 'H' for bit_depth = 16"
 msgstr ""
 
-#: shared-bindings/audiobusio/PDMIn.c
-msgid "destination_length must be an int >= 0"
-msgstr ""
-
 #: py/objdict.c
 msgid "dict update sequence has wrong length"
 msgstr ""
@@ -3986,6 +3972,10 @@ msgstr ""
 msgid "stop not reachable from start"
 msgstr ""
 
+#: ports/espressif/common-hal/dualbank/__init__.c
+msgid "storage is extended"
+msgstr ""
+
 #: py/stream.c shared-bindings/getpass/__init__.c
 msgid "stream operation not supported"
 msgstr ""

ports/espressif/common-hal/dualbank/__init__.c

@@ -32,6 +32,8 @@
 #include "esp_log.h"
 #include "esp_ota_ops.h"
 
+#include "supervisor/flash.h"
+
 static const esp_partition_t *update_partition = NULL;
 static esp_ota_handle_t update_handle = 0;
 
@@ -119,11 +121,18 @@ void common_hal_dualbank_flash(const void *buf, const size_t len, const size_t o
     }
 }
 
-void common_hal_dualbank_switch(void) {
+void common_hal_dualbank_switch(bool both_bootable) {
     if (esp_ota_end(update_handle) == ESP_OK) {
         update_handle = 0;
         update_partition = NULL;
     }
+
+    #if CIRCUITPY_STORAGE_EXTEND
+    if (both_bootable && supervisor_flash_get_extended()) {
+        mp_raise_RuntimeError(translate("storage is extended"));
+    }
+    #endif
+
     esp_err_t err = esp_ota_set_boot_partition(esp_ota_get_next_update_partition(NULL));
     if (err != ESP_OK) {
         if (err == ESP_ERR_OTA_VALIDATE_FAILED) {

shared-bindings/dualbank/__init__.c

@@ -85,19 +85,31 @@ STATIC mp_obj_t dualbank_flash(size_t n_args, const mp_obj_t *pos_args, mp_map_t
 }
 STATIC MP_DEFINE_CONST_FUN_OBJ_KW(dualbank_flash_obj, 0, dualbank_flash);
 
-//| def switch() -> None:
+//| def switch(both_bootable: Optional[bool] = False) -> None:
 //|     """Switches the boot partition.
 //|
 //|     On next reset, firmware will be loaded from the partition
 //|     just switched over to.
+//|
+//|     :param bool both_bootable: If `False`, the other partition
+//|         will be used to extend the ``CIRCUITPY`` storage.
 //|     """
 //|     ...
 //|
-STATIC mp_obj_t dualbank_switch(void) {
-    common_hal_dualbank_switch();
+STATIC mp_obj_t dualbank_switch(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
+    enum { ARG_both_bootable };
+    static const mp_arg_t allowed_args[] = {
+        { MP_QSTR_both_bootable, MP_ARG_KW_ONLY | MP_ARG_BOOL, {.u_bool = false} },
+    };
+
+    mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
+    mp_arg_parse_all(n_args, pos_args, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
+
+    common_hal_dualbank_switch(args[ARG_both_bootable].u_bool);
+
     return mp_const_none;
 }
-STATIC MP_DEFINE_CONST_FUN_OBJ_0(dualbank_switch_obj, dualbank_switch);
+STATIC MP_DEFINE_CONST_FUN_OBJ_KW(dualbank_switch_obj, 0, dualbank_switch);
 
 STATIC const mp_rom_map_elem_t dualbank_module_globals_table[] = {
     // module name

shared-bindings/dualbank/__init__.h

@@ -29,7 +29,7 @@
 
 #include "py/runtime.h"
 
-extern void common_hal_dualbank_switch(void);
+extern void common_hal_dualbank_switch(bool both_bootable);
 extern void common_hal_dualbank_flash(const void *buf, const size_t len, const size_t offset);
 
 #endif  // MICROPY_INCLUDED_SHARED_BINDINGS_DUALBANK___INIT___H

shared-bindings/storage/__init__.c

@@ -150,7 +150,7 @@ STATIC mp_obj_t storage_getmount(const mp_obj_t mnt_in) {
 }
 MP_DEFINE_CONST_FUN_OBJ_1(storage_getmount_obj, storage_getmount);
 
-//| def erase_filesystem() -> None:
+//| def erase_filesystem(extended: Optional[bool] = True) -> None:
 //|     """Erase and re-create the ``CIRCUITPY`` filesystem.
 //|
 //|     On boards that present USB-visible ``CIRCUITPY`` drive (e.g., SAMD21 and SAMD51),
@@ -160,16 +160,29 @@ MP_DEFINE_CONST_FUN_OBJ_1(storage_getmount_obj, storage_getmount);
 //|     This function can be called from the REPL when ``CIRCUITPY``
 //|     has become corrupted.
 //|
+//|     :param bool extended: On boards that support ``CIRCUITPY_DUALBANK``
+//|         and ``CIRCUITPY_STORAGE_EXTEND``, the ``CIRCUITPY`` storage can be
+//|         extended by setting this to `True`.
+//|
 //|     .. warning:: All the data on ``CIRCUITPY`` will be lost, and
 //|          CircuitPython will restart on certain boards."""
 //|     ...
 //|
 
-STATIC mp_obj_t storage_erase_filesystem(void) {
-    common_hal_storage_erase_filesystem();
+STATIC mp_obj_t storage_erase_filesystem(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
+    enum { ARG_extended };
+    static const mp_arg_t allowed_args[] = {
+        { MP_QSTR_extended, MP_ARG_KW_ONLY | MP_ARG_BOOL, {.u_bool = true} },
+    };
+
+    mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
+    mp_arg_parse_all(n_args, pos_args, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
+
+    common_hal_storage_erase_filesystem(args[ARG_extended].u_bool);
+
     return mp_const_none;
 }
-MP_DEFINE_CONST_FUN_OBJ_0(storage_erase_filesystem_obj, storage_erase_filesystem);
+MP_DEFINE_CONST_FUN_OBJ_KW(storage_erase_filesystem_obj, 0, storage_erase_filesystem);
 
 //| def disable_usb_drive() -> None:
 //|     """Disable presenting ``CIRCUITPY`` as a USB mass storage device.

shared-bindings/storage/__init__.h

@@ -37,7 +37,7 @@ void common_hal_storage_umount_path(const char *path);
 void common_hal_storage_umount_object(mp_obj_t vfs_obj);
 void common_hal_storage_remount(const char *path, bool readonly, bool disable_concurrent_write_protection);
 mp_obj_t common_hal_storage_getmount(const char *path);
-void common_hal_storage_erase_filesystem(void);
+void common_hal_storage_erase_filesystem(bool extended);
 
 bool common_hal_storage_disable_usb_drive(void);
 bool common_hal_storage_enable_usb_drive(void);

shared-module/storage/__init__.c

@@ -267,11 +267,14 @@ void common_hal_storage_remount(const char *mount_path, bool readonly, bool disa
     filesystem_set_internal_concurrent_write_protection(!disable_concurrent_write_protection);
 }
 
-void common_hal_storage_erase_filesystem(void) {
+void common_hal_storage_erase_filesystem(bool extended) {
     #if CIRCUITPY_USB
     usb_disconnect();
     #endif
     mp_hal_delay_ms(1000);
+    #if CIRCUITPY_STORAGE_EXTEND
+    supervisor_flash_set_extended(extended);
+    #endif
     (void)filesystem_init(false, true);  // Force a re-format. Ignore failure.
     common_hal_mcu_reset();
     // We won't actually get here, since we're resetting.