circuitpython/ports/esp32s2/common-hal/alarm/time/TimeAlarm.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.
 */

#include "esp_sleep.h"

#include "py/runtime.h"
#include "supervisor/esp_port.h"

#include "components/esp_timer/include/esp_timer.h"

#include "shared-bindings/alarm/time/TimeAlarm.h"
#include "shared-bindings/time/__init__.h"

void common_hal_alarm_time_time_alarm_construct(alarm_time_time_alarm_obj_t *self, mp_float_t monotonic_time) {
    self->monotonic_time = monotonic_time;
}

mp_float_t common_hal_alarm_time_time_alarm_get_monotonic_time(alarm_time_time_alarm_obj_t *self) {
    return self->monotonic_time;
}

mp_obj_t alarm_time_timealarm_get_wakeup_alarm(size_t n_alarms, const mp_obj_t *alarms) {
    // First, check to see if we match
    for (size_t i = 0; i < n_alarms; i++) {
        if (MP_OBJ_IS_TYPE(alarms[i], &alarm_time_time_alarm_type)) {
            return alarms[i];
        }
    }
    alarm_time_time_alarm_obj_t *timer = m_new_obj(alarm_time_time_alarm_obj_t);
    timer->base.type = &alarm_time_time_alarm_type;
    // TODO: Set monotonic_time based on the RTC state.
    return timer;
}

esp_timer_handle_t pretend_sleep_timer;
STATIC bool woke_up = false;

// This is run in the timer task. We use it to wake the main CircuitPython task.
void timer_callback(void *arg) {
    (void) arg;
    woke_up = true;
    if (sleeping_circuitpython_task) {
        xTaskNotifyGive(sleeping_circuitpython_task);
    }
}

bool alarm_time_timealarm_woke_us_up(void) {
    return woke_up;
}

void alarm_time_timealarm_reset(void) {
    esp_timer_stop(pretend_sleep_timer);
    esp_timer_delete(pretend_sleep_timer);
    pretend_sleep_timer = NULL;
    woke_up = false;
}

void alarm_time_timealarm_set_alarm(alarm_time_time_alarm_obj_t *self) {
    if (pretend_sleep_timer != NULL) {
        esp_timer_stop(pretend_sleep_timer);
    } else {
        // Configure the timer to use during pretend sleep.
        esp_timer_create_args_t args;
        args.callback = timer_callback;
        args.arg = NULL;
        args.dispatch_method = ESP_TIMER_TASK;
        args.name = "Pretend deep sleep";
        esp_timer_create(&args, &pretend_sleep_timer);
    }

    // Compute how long to actually sleep, considering the time now.
    mp_float_t now_secs = uint64_to_float(common_hal_time_monotonic_ms()) / 1000.0f;
    mp_float_t wakeup_in_secs = MAX(0.0f, self->monotonic_time - now_secs);
    const uint64_t sleep_for_us = (uint64_t) (wakeup_in_secs * 1000000);
    esp_sleep_enable_timer_wakeup(sleep_for_us);

    // Also set the RTC interrupt so it can wake our task. This will be wiped out
    // if we actually deep sleep.
    woke_up = false;
    esp_timer_start_once(pretend_sleep_timer, sleep_for_us);
}