Skip to content

Commit 305bed6

Browse files
committed
Added esp32s2 safe_mode & fixed user_safe_mode
1 parent 9256e6b commit 305bed6

File tree

4 files changed

+96
-71
lines changed

4 files changed

+96
-71
lines changed

ports/esp32s2/boards/espressif_saola_1_wroom/mpconfigboard.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,8 @@
3131

3232
#define MICROPY_HW_NEOPIXEL (&pin_GPIO18)
3333

34+
#define CIRCUITPY_BOOT_BUTTON (&pin_GPIO0)
35+
36+
#define BOARD_USER_SAFE_MODE_ACTION "pressing boot button at start up."
37+
3438
#define AUTORESET_DELAY_MS 500

ports/esp32s2/boards/espressif_saola_1_wrover/mpconfigboard.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,8 @@
3131

3232
#define MICROPY_HW_NEOPIXEL (&pin_GPIO18)
3333

34+
#define CIRCUITPY_BOOT_BUTTON (&pin_GPIO0)
35+
36+
#define BOARD_USER_SAFE_MODE_ACTION "pressing boot button at start up."
37+
3438
#define AUTORESET_DELAY_MS 500

ports/esp32s2/boards/microdev_micro_s2/mpconfigboard.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,8 @@
3232
#define MICROPY_HW_LED (&pin_GPIO21)
3333
#define MICROPY_HW_NEOPIXEL (&pin_GPIO33)
3434

35+
#define CIRCUITPY_BOOT_BUTTON (&pin_GPIO0)
36+
37+
#define BOARD_USER_SAFE_MODE_ACTION "pressing boot button at start up."
38+
3539
#define AUTORESET_DELAY_MS 500

supervisor/shared/safe_mode.c

Lines changed: 84 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -60,13 +60,23 @@ safe_mode_t wait_for_safe_mode_reset(void) {
6060
common_hal_digitalio_digitalinout_construct(&status_led, MICROPY_HW_LED_STATUS);
6161
common_hal_digitalio_digitalinout_switch_to_output(&status_led, true, DRIVE_MODE_PUSH_PULL);
6262
#endif
63+
#ifdef CIRCUITPY_BOOT_BUTTON
64+
digitalio_digitalinout_obj_t boot_button;
65+
common_hal_digitalio_digitalinout_construct(&boot_button, CIRCUITPY_BOOT_BUTTON);
66+
common_hal_digitalio_digitalinout_switch_to_input(&boot_button, PULL_UP);
67+
#endif
6368
uint64_t start_ticks = supervisor_ticks_ms64();
6469
uint64_t diff = 0;
6570
while (diff < 700) {
6671
#ifdef MICROPY_HW_LED_STATUS
6772
// Blink on for 100, off for 100, on for 100, off for 100 and on for 200
6873
common_hal_digitalio_digitalinout_set_value(&status_led, diff > 100 && diff / 100 != 2 && diff / 100 != 4);
6974
#endif
75+
#ifdef CIRCUITPY_BOOT_BUTTON
76+
if (!common_hal_digitalio_digitalinout_get_value(&boot_button)) {
77+
return USER_SAFE_MODE;
78+
}
79+
#endif
7080
diff = supervisor_ticks_ms64() - start_ticks;
7181
}
7282
#ifdef MICROPY_HW_LED_STATUS
@@ -103,77 +113,80 @@ void print_safe_mode_message(safe_mode_t reason) {
103113
return;
104114
}
105115
serial_write("\n");
106-
// Output a user safe mode string if it's set.
107-
#ifdef BOARD_USER_SAFE_MODE
108-
if (reason == USER_SAFE_MODE) {
109-
serial_write_compressed(translate("You requested starting safe mode by "));
110-
serial_write(BOARD_USER_SAFE_MODE_ACTION);
111-
serial_write_compressed(translate("\nTo exit, please reset the board without "));
112-
serial_write(BOARD_USER_SAFE_MODE_ACTION);
113-
serial_write("\n");
114-
} else
115-
#endif
116-
switch (reason) {
117-
case MANUAL_SAFE_MODE:
118-
serial_write_compressed(translate("CircuitPython is in safe mode because you pressed the reset button during boot. Press again to exit safe mode.\n"));
119-
return;
120-
case PROGRAMMATIC_SAFE_MODE:
121-
serial_write_compressed(translate("The `microcontroller` module was used to boot into safe mode. Press reset to exit safe mode.\n"));
122-
return;
123-
default:
124-
break;
125-
}
126116

127-
serial_write_compressed(translate("You are in safe mode: something unanticipated happened.\n"));
128-
switch (reason) {
129-
case BROWNOUT:
130-
serial_write_compressed(translate("The microcontroller's power dipped. Make sure your power supply provides\nenough power for the whole circuit and press reset (after ejecting CIRCUITPY).\n"));
131-
return;
132-
case HEAP_OVERWRITTEN:
133-
serial_write_compressed(translate("The CircuitPython heap was corrupted because the stack was too small.\nPlease increase the stack size if you know how, or if not:"));
134-
serial_write_compressed(FILE_AN_ISSUE);
135-
return;
136-
case NO_HEAP:
137-
serial_write_compressed(translate("CircuitPython was unable to allocate the heap.\n"));
138-
serial_write_compressed(FILE_AN_ISSUE);
139-
return;
140-
default:
141-
break;
142-
}
117+
switch (reason) {
118+
case USER_SAFE_MODE:
119+
#ifdef BOARD_USER_SAFE_MODE_ACTION
120+
// Output a user safe mode string if it's set.
121+
serial_write_compressed(translate("You requested starting safe mode by "));
122+
serial_write_compressed(translate(BOARD_USER_SAFE_MODE_ACTION));
123+
serial_write_compressed(translate("\nTo exit, please reset the board without "));
124+
serial_write_compressed(translate(BOARD_USER_SAFE_MODE_ACTION));
125+
serial_write("\n");
126+
#else
127+
// fallthrough
128+
#endif
129+
return;
130+
case MANUAL_SAFE_MODE:
131+
serial_write_compressed(translate("CircuitPython is in safe mode because you pressed the reset button during boot. Press again to exit safe mode.\n"));
132+
return;
133+
case PROGRAMMATIC_SAFE_MODE:
134+
serial_write_compressed(translate("The `microcontroller` module was used to boot into safe mode. Press reset to exit safe mode.\n"));
135+
return;
136+
default:
137+
break;
138+
}
143139

144-
serial_write_compressed(translate("CircuitPython core code crashed hard. Whoops!\n"));
145-
switch (reason) {
146-
case HARD_CRASH:
147-
serial_write_compressed(translate("Crash into the HardFault_Handler."));
148-
return;
149-
case MICROPY_NLR_JUMP_FAIL:
150-
serial_write_compressed(translate("MicroPython NLR jump failed. Likely memory corruption."));
151-
return;
152-
case MICROPY_FATAL_ERROR:
153-
serial_write_compressed(translate("MicroPython fatal error."));
154-
break;
155-
case GC_ALLOC_OUTSIDE_VM:
156-
serial_write_compressed(translate("Attempted heap allocation when MicroPython VM not running."));
157-
break;
158-
#ifdef SOFTDEVICE_PRESENT
159-
// defined in ports/nrf/bluetooth/bluetooth_common.mk
160-
// will print "Unknown reason" if somehow encountered on other ports
161-
case NORDIC_SOFT_DEVICE_ASSERT:
162-
serial_write_compressed(translate("Nordic Soft Device failure assertion."));
163-
break;
164-
#endif
165-
case FLASH_WRITE_FAIL:
166-
serial_write_compressed(translate("Failed to write internal flash."));
167-
break;
168-
case MEM_MANAGE:
169-
serial_write_compressed(translate("Invalid memory access."));
170-
break;
171-
case WATCHDOG_RESET:
172-
serial_write_compressed(translate("Watchdog timer expired."));
173-
break;
174-
default:
175-
serial_write_compressed(translate("Unknown reason."));
176-
break;
177-
}
178-
serial_write_compressed(FILE_AN_ISSUE);
140+
serial_write_compressed(translate("You are in safe mode: something unanticipated happened.\n"));
141+
switch (reason) {
142+
case BROWNOUT:
143+
serial_write_compressed(translate("The microcontroller's power dipped. Make sure your power supply provides\nenough power for the whole circuit and press reset (after ejecting CIRCUITPY).\n"));
144+
return;
145+
case HEAP_OVERWRITTEN:
146+
serial_write_compressed(translate("The CircuitPython heap was corrupted because the stack was too small.\nPlease increase the stack size if you know how, or if not:"));
147+
serial_write_compressed(FILE_AN_ISSUE);
148+
return;
149+
case NO_HEAP:
150+
serial_write_compressed(translate("CircuitPython was unable to allocate the heap.\n"));
151+
serial_write_compressed(FILE_AN_ISSUE);
152+
return;
153+
default:
154+
break;
155+
}
156+
157+
serial_write_compressed(translate("CircuitPython core code crashed hard. Whoops!\n"));
158+
switch (reason) {
159+
case HARD_CRASH:
160+
serial_write_compressed(translate("Crash into the HardFault_Handler."));
161+
return;
162+
case MICROPY_NLR_JUMP_FAIL:
163+
serial_write_compressed(translate("MicroPython NLR jump failed. Likely memory corruption."));
164+
return;
165+
case MICROPY_FATAL_ERROR:
166+
serial_write_compressed(translate("MicroPython fatal error."));
167+
break;
168+
case GC_ALLOC_OUTSIDE_VM:
169+
serial_write_compressed(translate("Attempted heap allocation when MicroPython VM not running."));
170+
break;
171+
#ifdef SOFTDEVICE_PRESENT
172+
// defined in ports/nrf/bluetooth/bluetooth_common.mk
173+
// will print "Unknown reason" if somehow encountered on other ports
174+
case NORDIC_SOFT_DEVICE_ASSERT:
175+
serial_write_compressed(translate("Nordic Soft Device failure assertion."));
176+
break;
177+
#endif
178+
case FLASH_WRITE_FAIL:
179+
serial_write_compressed(translate("Failed to write internal flash."));
180+
break;
181+
case MEM_MANAGE:
182+
serial_write_compressed(translate("Invalid memory access."));
183+
break;
184+
case WATCHDOG_RESET:
185+
serial_write_compressed(translate("Watchdog timer expired."));
186+
break;
187+
default:
188+
serial_write_compressed(translate("Unknown reason."));
189+
break;
190+
}
191+
serial_write_compressed(FILE_AN_ISSUE);
179192
}

0 commit comments

Comments
 (0)