40118bcf57
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
53 lines
2.4 KiB
C
53 lines
2.4 KiB
C
/*
|
|
* This file is part of the MicroPython project, http://micropython.org/
|
|
*
|
|
* The MIT License (MIT)
|
|
*
|
|
* Copyright (c) 2020 Dan Halbert 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.
|
|
*/
|
|
|
|
#ifndef MICROPY_INCLUDED_SHARED_BINDINGS_ALARM___INIT___H
|
|
#define MICROPY_INCLUDED_SHARED_BINDINGS_ALARM___INIT___H
|
|
|
|
#include "py/obj.h"
|
|
|
|
#include "common-hal/alarm/__init__.h"
|
|
|
|
extern mp_obj_t common_hal_alarm_light_sleep_until_alarms(size_t n_alarms, const mp_obj_t *alarms);
|
|
|
|
// Deep sleep is a two step process. Alarms are set when the VM is valid but
|
|
// everything is reset before entering deep sleep. Furthermore, deep sleep may
|
|
// not actually happen if the user is connected to the device. In this case, the
|
|
// supervisor will idle using `port_wait_for_interrupt`. After each call, it will
|
|
// call alarm_woken_from_sleep to see if we've been woken by an alarm and if so,
|
|
// it will exit idle as if deep sleep was exited.
|
|
extern void common_hal_alarm_set_deep_sleep_alarms(size_t n_alarms, const mp_obj_t *alarms);
|
|
// Deep sleep is entered outside of the VM so we omit the `common_hal_` prefix.
|
|
extern NORETURN void alarm_enter_deep_sleep(void);
|
|
|
|
// Used by wake-up code.
|
|
extern void common_hal_alarm_set_wake_alarm(mp_obj_t alarm);
|
|
|
|
// True if an alarm is alerting. This is most useful for pretend deep sleep.
|
|
extern bool alarm_woken_from_sleep(void);
|
|
|
|
#endif // MICROPY_INCLUDED_SHARED_BINDINGS_ALARM___INIT___H
|