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
54 lines
2.0 KiB
C
54 lines
2.0 KiB
C
/*
|
|
* This file is part of the MicroPython project, http://micropython.org/
|
|
*
|
|
* The MIT License (MIT)
|
|
*
|
|
* Copyright (c) 2020 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.
|
|
*/
|
|
|
|
#ifndef MICROPY_INCLUDED_SUPERVISOR_BOARD_H
|
|
#define MICROPY_INCLUDED_SUPERVISOR_BOARD_H
|
|
|
|
#include <stdbool.h>
|
|
|
|
#include "supervisor/shared/safe_mode.h"
|
|
|
|
// 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);
|
|
|
|
// Initializes board related state once on start up.
|
|
void board_init(void);
|
|
|
|
// Reset the state of off MCU components such as neopixels.
|
|
void reset_board(void);
|
|
|
|
#if CIRCUITPY_ALARM
|
|
// Deinit the board. This should put the board in deep sleep durable, low power
|
|
// state. It should not prevent the user access method from working (such as
|
|
// disabling USB, BLE or flash) because CircuitPython may continue to run.
|
|
void board_deinit(void);
|
|
#endif
|
|
|
|
|
|
#endif // MICROPY_INCLUDED_SUPERVISOR_BOARD_H
|