Merge pull request #747 from dhalbert/reformat3.0.0-alpha.4

add storage.erase_filesystem() to erase and reformat CIRCUITPY

1 files changed, 21 insertions, 0 deletions

diff --git a/shared-bindings/storage/__init__.c b/shared-bindings/storage/__init__.c
index 734cabcc1..ca9281a18 100644
--- a/shared-bindings/storage/__init__.c
+++ b/shared-bindings/storage/__init__.c
@@ -131,6 +131,26 @@ mp_obj_t storage_getmount(const mp_obj_t mnt_in) {
 }
 MP_DEFINE_CONST_FUN_OBJ_1(storage_getmount_obj, storage_getmount);
 
+//| .. function:: erase_filesystem()
+//|
+//|   Erase and re-create the ``CIRCUITPY`` filesystem.
+//|
+//|   On boards that present USB-visible ``CIRCUITPY`` drive (e.g., SAMD21 and SAMD51),
+//|   then call `microcontroller.reset()` to restart CircuitPython and have the
+//|   host computer remount CIRCUITPY.
+//|
+//|   This function can be called from the REPL when ``CIRCUITPY``
+//|   has become corrupted.
+//|
+//|   .. warning:: All the data on ``CIRCUITPY`` will be lost, and
+//|        CircuitPython will restart on certain boards.
+
+mp_obj_t storage_erase_filesystem(void) {
+    common_hal_storage_erase_filesystem();
+    return mp_const_none;
+}
+MP_DEFINE_CONST_FUN_OBJ_0(storage_erase_filesystem_obj, storage_erase_filesystem);
+
 STATIC const mp_rom_map_elem_t storage_module_globals_table[] = {
     { MP_ROM_QSTR(MP_QSTR___name__), MP_ROM_QSTR(MP_QSTR_storage) },
 
@@ -138,6 +158,7 @@ STATIC const mp_rom_map_elem_t storage_module_globals_table[] = {
     { MP_ROM_QSTR(MP_QSTR_umount), MP_ROM_PTR(&storage_umount_obj) },
     { MP_ROM_QSTR(MP_QSTR_remount), MP_ROM_PTR(&storage_remount_obj) },
     { MP_ROM_QSTR(MP_QSTR_getmount), MP_ROM_PTR(&storage_getmount_obj) },
+    { MP_ROM_QSTR(MP_QSTR_erase_filesystem), MP_ROM_PTR(&storage_erase_filesystem_obj) },
 
     //| .. class:: VfsFat(block_device)
     //|