Add `board_deinit` for use with sleep

This changes lots of files to unify `board.h` across ports. It adds
`board_deinit` when CIRCUITPY_ALARM is set. `main.c` uses it to
deinit the board before deep sleeping (even when pretending.)

Deep sleep is now a two step process for the port. First, the
port should prepare to deep sleep based on the given alarms. It
should set alarms for both deep and pretend sleep. In particular,
the pretend versions should be set immediately so that we don't
miss an alarm as we shutdown. These alarms should also wake from
`port_idle_until_interrupt` which is used when pretending to deep
sleep.

Second, when real deep sleeping, `alarm_enter_deep_sleep` is called.
The port should set any alarms it didn't during prepare based on
data it saved internally during prepare.

ESP32-S2 sleep is a bit reorganized to locate more logic with
TimeAlarm. This will help it scale to more alarm types.

Fixes #3786

39 files changed, 40 insertions, 85 deletions

diff --git a/ports/nrf/boards/ADM_B_NRF52840_1/board.c b/ports/nrf/boards/ADM_B_NRF52840_1/board.c
index 4421970ee..781793328 100644
--- a/ports/nrf/boards/ADM_B_NRF52840_1/board.c
+++ b/ports/nrf/boards/ADM_B_NRF52840_1/board.c
@@ -24,7 +24,7 @@
  * THE SOFTWARE.
  */
 
-#include "boards/board.h"
+#include "supervisor/board.h"
 
 void board_init(void) {
 }
diff --git a/ports/nrf/boards/TG-Watch02A/board.c b/ports/nrf/boards/TG-Watch02A/board.c
index 4421970ee..781793328 100644
--- a/ports/nrf/boards/TG-Watch02A/board.c
+++ b/ports/nrf/boards/TG-Watch02A/board.c
@@ -24,7 +24,7 @@
  * THE SOFTWARE.
  */
 
-#include "boards/board.h"
+#include "supervisor/board.h"
 
 void board_init(void) {
 }
diff --git a/ports/nrf/boards/aramcon_badge_2019/board.c b/ports/nrf/boards/aramcon_badge_2019/board.c
index efb449285..8f3830b00 100644
--- a/ports/nrf/boards/aramcon_badge_2019/board.c
+++ b/ports/nrf/boards/aramcon_badge_2019/board.c
@@ -25,7 +25,7 @@
  * THE SOFTWARE.
  */
 
-#include "boards/board.h"
+#include "supervisor/board.h"
 #include "common-hal/microcontroller/Pin.h"
 
 void board_init(void) {
diff --git a/ports/nrf/boards/arduino_nano_33_ble/board.c b/ports/nrf/boards/arduino_nano_33_ble/board.c
index ddfcde284..d1689e9dd 100644
--- a/ports/nrf/boards/arduino_nano_33_ble/board.c
+++ b/ports/nrf/boards/arduino_nano_33_ble/board.c
@@ -24,7 +24,7 @@
  * THE SOFTWARE.
  */
 
-#include "boards/board.h"
+#include "supervisor/board.h"
 #include "nrf.h"
 #include "nrf_rtc.h"
 
diff --git a/ports/nrf/boards/bless_dev_board_multi_sensor/board.c b/ports/nrf/boards/bless_dev_board_multi_sensor/board.c
index 71b9a0657..6970294ec 100644
--- a/ports/nrf/boards/bless_dev_board_multi_sensor/board.c
+++ b/ports/nrf/boards/bless_dev_board_multi_sensor/board.c
@@ -1,4 +1,4 @@
-#include "boards/board.h"
+#include "supervisor/board.h"
 
 void board_init(void) {
 }
diff --git a/ports/nrf/boards/board.h b/ports/nrf/boards/board.h
deleted file mode 100644
index ec98f04fb..000000000
--- a/ports/nrf/boards/board.h
+++ /dev/null
@@ -1,45 +0,0 @@
-/*
- * This file is part of the MicroPython project, http://micropython.org/
- *
- * The MIT License (MIT)
- *
- * Copyright (c) 2017 Scott Shawcroft for Adafruit Industries
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- * THE SOFTWARE.
- */
-
-// This file defines board specific functions.
-
-#ifndef MICROPY_INCLUDED_NRF_BOARDS_BOARD_H
-#define MICROPY_INCLUDED_NRF_BOARDS_BOARD_H
-
-#include <stdbool.h>
-
-// Initializes board related state once on start up.
-void board_init(void);
-
-// Returns true if the user initiates safe mode in a board specific way.
-// Also add BOARD_USER_SAFE_MODE in mpconfigboard.h to explain the board specific
-// way.
-bool board_requests_safe_mode(void);
-
-// Reset the state of off MCU components such as neopixels.
-void reset_board(void);
-
-#endif  // MICROPY_INCLUDED_NRF_BOARDS_BOARD_H
diff --git a/ports/nrf/boards/circuitplayground_bluefruit/board.c b/ports/nrf/boards/circuitplayground_bluefruit/board.c
index 3aa6857da..ff731d8f9 100644
--- a/ports/nrf/boards/circuitplayground_bluefruit/board.c
+++ b/ports/nrf/boards/circuitplayground_bluefruit/board.c
@@ -24,7 +24,7 @@
  * THE SOFTWARE.
  */
 
-#include "boards/board.h"
+#include "supervisor/board.h"
 #include "mpconfigboard.h"
 #include "py/obj.h"
 #include "peripherals/nrf/pins.h"
@@ -49,5 +49,5 @@ void reset_board(void) {
                  NRF_GPIO_PIN_NOSENSE);
     nrf_gpio_pin_write(POWER_SWITCH_PIN->number, false);
 
-    board_reset_user_neopixels();
+    board_reset_user_neopixels(&pin_P0_13, 10);
 }
diff --git a/ports/nrf/boards/clue_nrf52840_express/board.c b/ports/nrf/boards/clue_nrf52840_express/board.c
index 523bd7677..cd46ce75d 100644
--- a/ports/nrf/boards/clue_nrf52840_express/board.c
+++ b/ports/nrf/boards/clue_nrf52840_express/board.c
@@ -24,7 +24,7 @@
  * THE SOFTWARE.
  */
 
-#include "boards/board.h"
+#include "supervisor/board.h"
 #include "mpconfigboard.h"
 
 #include "shared-bindings/busio/SPI.h"
diff --git a/ports/nrf/boards/clue_nrf52840_express/pins.c b/ports/nrf/boards/clue_nrf52840_express/pins.c
index ab0738893..61d77cedc 100644
--- a/ports/nrf/boards/clue_nrf52840_express/pins.c
+++ b/ports/nrf/boards/clue_nrf52840_express/pins.c
@@ -1,6 +1,6 @@
 #include "shared-bindings/board/__init__.h"
 
-#include "boards/board.h"
+#include "supervisor/board.h"
 #include "shared-module/displayio/__init__.h"
 
 STATIC const mp_rom_map_elem_t board_module_globals_table[] = {
diff --git a/ports/nrf/boards/electronut_labs_blip/board.c b/ports/nrf/boards/electronut_labs_blip/board.c
index 4421970ee..781793328 100644
--- a/ports/nrf/boards/electronut_labs_blip/board.c
+++ b/ports/nrf/boards/electronut_labs_blip/board.c
@@ -24,7 +24,7 @@
  * THE SOFTWARE.
  */
 
-#include "boards/board.h"
+#include "supervisor/board.h"
 
 void board_init(void) {
 }
diff --git a/ports/nrf/boards/electronut_labs_papyr/board.c b/ports/nrf/boards/electronut_labs_papyr/board.c
index 4421970ee..781793328 100644
--- a/ports/nrf/boards/electronut_labs_papyr/board.c
+++ b/ports/nrf/boards/electronut_labs_papyr/board.c
@@ -24,7 +24,7 @@
  * THE SOFTWARE.
  */
 
-#include "boards/board.h"
+#include "supervisor/board.h"
 
 void board_init(void) {
 }
diff --git a/ports/nrf/boards/feather_bluefruit_sense/board.c b/ports/nrf/boards/feather_bluefruit_sense/board.c
index 4421970ee..781793328 100644
--- a/ports/nrf/boards/feather_bluefruit_sense/board.c
+++ b/ports/nrf/boards/feather_bluefruit_sense/board.c
@@ -24,7 +24,7 @@
  * THE SOFTWARE.
  */
 
-#include "boards/board.h"
+#include "supervisor/board.h"
 
 void board_init(void) {
 }
diff --git a/ports/nrf/boards/feather_nrf52840_express/board.c b/ports/nrf/boards/feather_nrf52840_express/board.c
index 4421970ee..781793328 100644
--- a/ports/nrf/boards/feather_nrf52840_express/board.c
+++ b/ports/nrf/boards/feather_nrf52840_express/board.c
@@ -24,7 +24,7 @@
  * THE SOFTWARE.
  */
 
-#include "boards/board.h"
+#include "supervisor/board.h"
 
 void board_init(void) {
 }
diff --git a/ports/nrf/boards/hiibot_bluefi/board.c b/ports/nrf/boards/hiibot_bluefi/board.c
index 93e31aef0..a3fd5cf12 100644
--- a/ports/nrf/boards/hiibot_bluefi/board.c
+++ b/ports/nrf/boards/hiibot_bluefi/board.c
@@ -24,7 +24,7 @@
  * THE SOFTWARE.
  */
 
-#include "boards/board.h"
+#include "supervisor/board.h"
 #include "mpconfigboard.h"
 
 #include "shared-bindings/busio/SPI.h"
diff --git a/ports/nrf/boards/hiibot_bluefi/pins.c b/ports/nrf/boards/hiibot_bluefi/pins.c
index bce4ee52d..c7879c4c2 100644
--- a/ports/nrf/boards/hiibot_bluefi/pins.c
+++ b/ports/nrf/boards/hiibot_bluefi/pins.c
@@ -1,6 +1,6 @@
 #include "shared-bindings/board/__init__.h"
 
-#include "boards/board.h"
+#include "supervisor/board.h"
 #include "shared-module/displayio/__init__.h"
 
 STATIC const mp_rom_map_elem_t board_module_globals_table[] = {
diff --git a/ports/nrf/boards/ikigaisense_vita/board.c b/ports/nrf/boards/ikigaisense_vita/board.c
index 4421970ee..781793328 100644
--- a/ports/nrf/boards/ikigaisense_vita/board.c
+++ b/ports/nrf/boards/ikigaisense_vita/board.c
@@ -24,7 +24,7 @@
  * THE SOFTWARE.
  */
 
-#include "boards/board.h"
+#include "supervisor/board.h"
 
 void board_init(void) {
 }
diff --git a/ports/nrf/boards/itsybitsy_nrf52840_express/board.c b/ports/nrf/boards/itsybitsy_nrf52840_express/board.c
index 4421970ee..781793328 100644
--- a/ports/nrf/boards/itsybitsy_nrf52840_express/board.c
+++ b/ports/nrf/boards/itsybitsy_nrf52840_express/board.c
@@ -24,7 +24,7 @@
  * THE SOFTWARE.
  */
 
-#include "boards/board.h"
+#include "supervisor/board.h"
 
 void board_init(void) {
 }
diff --git a/ports/nrf/boards/makerdiary_m60_keyboard/board.c b/ports/nrf/boards/makerdiary_m60_keyboard/board.c
index 4421970ee..781793328 100644
--- a/ports/nrf/boards/makerdiary_m60_keyboard/board.c
+++ b/ports/nrf/boards/makerdiary_m60_keyboard/board.c
@@ -24,7 +24,7 @@
  * THE SOFTWARE.
  */
 
-#include "boards/board.h"
+#include "supervisor/board.h"
 
 void board_init(void) {
 }
diff --git a/ports/nrf/boards/makerdiary_m60_keyboard/pins.c b/ports/nrf/boards/makerdiary_m60_keyboard/pins.c
index 63c3ad171..fc85fa24b 100644
--- a/ports/nrf/boards/makerdiary_m60_keyboard/pins.c
+++ b/ports/nrf/boards/makerdiary_m60_keyboard/pins.c
@@ -1,6 +1,6 @@
 #include "shared-bindings/board/__init__.h"
 
-#include "boards/board.h"
+#include "supervisor/board.h"
 #include "shared-module/displayio/__init__.h"
 
 STATIC const mp_rom_map_elem_t board_module_globals_table[] = {
diff --git a/ports/nrf/boards/makerdiary_nrf52840_m2_devkit/board.c b/ports/nrf/boards/makerdiary_nrf52840_m2_devkit/board.c
index e08d00dac..569106ec2 100644
--- a/ports/nrf/boards/makerdiary_nrf52840_m2_devkit/board.c
+++ b/ports/nrf/boards/makerdiary_nrf52840_m2_devkit/board.c
@@ -25,7 +25,7 @@
  * THE SOFTWARE.
  */
 
-#include "boards/board.h"
+#include "supervisor/board.h"
 #include "mpconfigboard.h"
 
 #include "shared-bindings/busio/SPI.h"
diff --git a/ports/nrf/boards/makerdiary_nrf52840_m2_devkit/pins.c b/ports/nrf/boards/makerdiary_nrf52840_m2_devkit/pins.c
index 7dc6db18f..189286833 100644
--- a/ports/nrf/boards/makerdiary_nrf52840_m2_devkit/pins.c
+++ b/ports/nrf/boards/makerdiary_nrf52840_m2_devkit/pins.c
@@ -1,6 +1,6 @@
 #include "shared-bindings/board/__init__.h"
 
-#include "boards/board.h"
+#include "supervisor/board.h"
 #include "shared-module/displayio/__init__.h"
 
 STATIC const mp_rom_map_elem_t board_module_globals_table[] = {
diff --git a/ports/nrf/boards/makerdiary_nrf52840_mdk/board.c b/ports/nrf/boards/makerdiary_nrf52840_mdk/board.c
index 4421970ee..781793328 100644
--- a/ports/nrf/boards/makerdiary_nrf52840_mdk/board.c
+++ b/ports/nrf/boards/makerdiary_nrf52840_mdk/board.c
@@ -24,7 +24,7 @@
  * THE SOFTWARE.
  */
 
-#include "boards/board.h"
+#include "supervisor/board.h"
 
 void board_init(void) {
 }
diff --git a/ports/nrf/boards/makerdiary_nrf52840_mdk_usb_dongle/board.c b/ports/nrf/boards/makerdiary_nrf52840_mdk_usb_dongle/board.c
index 4421970ee..781793328 100644
--- a/ports/nrf/boards/makerdiary_nrf52840_mdk_usb_dongle/board.c
+++ b/ports/nrf/boards/makerdiary_nrf52840_mdk_usb_dongle/board.c
@@ -24,7 +24,7 @@
  * THE SOFTWARE.
  */
 
-#include "boards/board.h"
+#include "supervisor/board.h"
 
 void board_init(void) {
 }
diff --git a/ports/nrf/boards/metro_nrf52840_express/board.c b/ports/nrf/boards/metro_nrf52840_express/board.c
index 4421970ee..781793328 100644
--- a/ports/nrf/boards/metro_nrf52840_express/board.c
+++ b/ports/nrf/boards/metro_nrf52840_express/board.c
@@ -24,7 +24,7 @@
  * THE SOFTWARE.
  */
 
-#include "boards/board.h"
+#include "supervisor/board.h"
 
 void board_init(void) {
 }
diff --git a/ports/nrf/boards/nice_nano/board.c b/ports/nrf/boards/nice_nano/board.c
index 4421970ee..781793328 100644
--- a/ports/nrf/boards/nice_nano/board.c
+++ b/ports/nrf/boards/nice_nano/board.c
@@ -24,7 +24,7 @@
  * THE SOFTWARE.
  */
 
-#include "boards/board.h"
+#include "supervisor/board.h"
 
 void board_init(void) {
 }
diff --git a/ports/nrf/boards/ohs2020_badge/board.c b/ports/nrf/boards/ohs2020_badge/board.c
index ec52690ce..20abf4e2a 100644
--- a/ports/nrf/boards/ohs2020_badge/board.c
+++ b/ports/nrf/boards/ohs2020_badge/board.c
@@ -24,7 +24,7 @@
  * THE SOFTWARE.
  */
 
-#include "boards/board.h"
+#include "supervisor/board.h"
 #include "mpconfigboard.h"
 
 #include "shared-bindings/busio/SPI.h"
diff --git a/ports/nrf/boards/particle_argon/board.c b/ports/nrf/boards/particle_argon/board.c
index f891f54a1..a41f0ae06 100644
--- a/ports/nrf/boards/particle_argon/board.c
+++ b/ports/nrf/boards/particle_argon/board.c
@@ -24,7 +24,7 @@
  * THE SOFTWARE.
  */
 
-#include "boards/board.h"
+#include "supervisor/board.h"
 
 void board_init(void) {
 }
diff --git a/ports/nrf/boards/particle_boron/board.c b/ports/nrf/boards/particle_boron/board.c
index f891f54a1..a41f0ae06 100644
--- a/ports/nrf/boards/particle_boron/board.c
+++ b/ports/nrf/boards/particle_boron/board.c
@@ -24,7 +24,7 @@
  * THE SOFTWARE.
  */
 
-#include "boards/board.h"
+#include "supervisor/board.h"
 
 void board_init(void) {
 }
diff --git a/ports/nrf/boards/particle_xenon/board.c b/ports/nrf/boards/particle_xenon/board.c
index f891f54a1..a41f0ae06 100644
--- a/ports/nrf/boards/particle_xenon/board.c
+++ b/ports/nrf/boards/particle_xenon/board.c
@@ -24,7 +24,7 @@
  * THE SOFTWARE.
  */
 
-#include "boards/board.h"
+#include "supervisor/board.h"
 
 void board_init(void) {
 }
diff --git a/ports/nrf/boards/pca10056/board.c b/ports/nrf/boards/pca10056/board.c
index 4421970ee..781793328 100644
--- a/ports/nrf/boards/pca10056/board.c
+++ b/ports/nrf/boards/pca10056/board.c
@@ -24,7 +24,7 @@
  * THE SOFTWARE.
  */
 
-#include "boards/board.h"
+#include "supervisor/board.h"
 
 void board_init(void) {
 }
diff --git a/ports/nrf/boards/pca10059/board.c b/ports/nrf/boards/pca10059/board.c
index 4421970ee..781793328 100644
--- a/ports/nrf/boards/pca10059/board.c
+++ b/ports/nrf/boards/pca10059/board.c
@@ -24,7 +24,7 @@
  * THE SOFTWARE.
  */
 
-#include "boards/board.h"
+#include "supervisor/board.h"
 
 void board_init(void) {
 }
diff --git a/ports/nrf/boards/pca10100/board.c b/ports/nrf/boards/pca10100/board.c
index f891f54a1..a41f0ae06 100644
--- a/ports/nrf/boards/pca10100/board.c
+++ b/ports/nrf/boards/pca10100/board.c
@@ -24,7 +24,7 @@
  * THE SOFTWARE.
  */
 
-#include "boards/board.h"
+#include "supervisor/board.h"
 
 void board_init(void) {
 }
diff --git a/ports/nrf/boards/pitaya_go/board.c b/ports/nrf/boards/pitaya_go/board.c
index 4421970ee..781793328 100644
--- a/ports/nrf/boards/pitaya_go/board.c
+++ b/ports/nrf/boards/pitaya_go/board.c
@@ -24,7 +24,7 @@
  * THE SOFTWARE.
  */
 
-#include "boards/board.h"
+#include "supervisor/board.h"
 
 void board_init(void) {
 }
diff --git a/ports/nrf/boards/raytac_mdbt50q-db-40/board.c b/ports/nrf/boards/raytac_mdbt50q-db-40/board.c
index 4421970ee..781793328 100644
--- a/ports/nrf/boards/raytac_mdbt50q-db-40/board.c
+++ b/ports/nrf/boards/raytac_mdbt50q-db-40/board.c
@@ -24,7 +24,7 @@
  * THE SOFTWARE.
  */
 
-#include "boards/board.h"
+#include "supervisor/board.h"
 
 void board_init(void) {
 }
diff --git a/ports/nrf/boards/simmel/board.c b/ports/nrf/boards/simmel/board.c
index f891f54a1..a41f0ae06 100644
--- a/ports/nrf/boards/simmel/board.c
+++ b/ports/nrf/boards/simmel/board.c
@@ -24,7 +24,7 @@
  * THE SOFTWARE.
  */
 
-#include "boards/board.h"
+#include "supervisor/board.h"
 
 void board_init(void) {
 }
diff --git a/ports/nrf/boards/sparkfun_nrf52840_mini/board.c b/ports/nrf/boards/sparkfun_nrf52840_mini/board.c
index 4421970ee..781793328 100644
--- a/ports/nrf/boards/sparkfun_nrf52840_mini/board.c
+++ b/ports/nrf/boards/sparkfun_nrf52840_mini/board.c
@@ -24,7 +24,7 @@
  * THE SOFTWARE.
  */
 
-#include "boards/board.h"
+#include "supervisor/board.h"
 
 void board_init(void) {
 }
diff --git a/ports/nrf/boards/teknikio_bluebird/board.c b/ports/nrf/boards/teknikio_bluebird/board.c
index 4421970ee..781793328 100644
--- a/ports/nrf/boards/teknikio_bluebird/board.c
+++ b/ports/nrf/boards/teknikio_bluebird/board.c
@@ -24,7 +24,7 @@
  * THE SOFTWARE.
  */
 
-#include "boards/board.h"
+#include "supervisor/board.h"
 
 void board_init(void) {
 }
diff --git a/ports/nrf/boards/tinkeringtech_scoutmakes_azul/board.c b/ports/nrf/boards/tinkeringtech_scoutmakes_azul/board.c
index 4421970ee..781793328 100644
--- a/ports/nrf/boards/tinkeringtech_scoutmakes_azul/board.c
+++ b/ports/nrf/boards/tinkeringtech_scoutmakes_azul/board.c
@@ -24,7 +24,7 @@
  * THE SOFTWARE.
  */
 
-#include "boards/board.h"
+#include "supervisor/board.h"
 
 void board_init(void) {
 }
diff --git a/ports/nrf/supervisor/port.c b/ports/nrf/supervisor/port.c
index 5f1c9f1ba..00485d858 100644
--- a/ports/nrf/supervisor/port.c
+++ b/ports/nrf/supervisor/port.c
@@ -26,7 +26,7 @@
 
 #include <stdint.h>
 #include "supervisor/port.h"
-#include "boards/board.h"
+#include "supervisor/board.h"
 
 #include "nrfx/hal/nrf_clock.h"
 #include "nrfx/hal/nrf_power.h"
@@ -307,7 +307,7 @@ void port_interrupt_after_ticks(uint32_t ticks) {
     nrfx_rtc_cc_set(&rtc_instance, 0, current_ticks + diff, true);
 }
 
-void port_sleep_until_interrupt(void) {
+void port_idle_until_interrupt(void) {
 #if defined(MICROPY_QSPI_CS)
     qspi_disable();
 #endif