Files
libretiny/cores/common/base/api/lt_sleep.h
devgs e1c5761df9 [beken-72xx] Allow setting deep sleep wake-up pins as floating (#275)
According to guide `gpio_stay_*_map` are specifically there to prevent
pulling pins to a specific level and let them float during deep sleep.

https://docs.bekencorp.com/sdk_3.0.x/bk7238/build/en/latest/developer-guide/power_save/sleep_test.html

This allows any external low-power circuitry to change a pin level, as
required, to trigger the wake up

This requires changes in BDK and was implemented via fixup. Also, exposed
`gpio_stay_lo_map` parameter via `lt_deep_sleep_keep_floating_gpio` to
manage this configuration for pins in range P0-P31.
2024-09-05 14:45:48 +02:00

47 lines
1.4 KiB
C

/* Copyright (c) Peter Sarkozi 2023-06-17. */
#pragma once
#include <libretiny.h>
/**
* @brief Enable GPIO Wakeup from Deep Sleep.
*
* @param gpio_index_map bitMap of the pins we should wake up on
* @param on_high whether to wake up on High or Low state
*/
void lt_deep_sleep_config_gpio(uint32_t gpio_index_map, bool on_high);
/**
* @brief Disable GPIO Wakeup on given pins
*
* @param gpio_index_map bitMap of the pins we should disable wake up on
*/
void lt_deep_sleep_unset_gpio(uint32_t gpio_index_map);
/**
* @brief Configure GPIO pins to be kept floating
*
* This prevents pins from being configured as pullup/pulldown, based on
* the configured wake-up mode (low/high), upon entering deep sleep.
* This is important, as some-low power devices may be unable to ever
* overcome the internal pull strength and change the level. One example
* of such device is a magnetic door sensor that must be able to wake on
* level change in both directions.
*
* @param gpio_index_map bitMap of the pins to set/unset as floating
* @param enabled whether to set pins to floating or roll back to default mode
*/
void lt_deep_sleep_keep_floating_gpio(uint32_t gpio_index_map, bool enabled);
/**
* @brief Set a sleep timer to wake up the device
* @param sleep_duration the time in milliseconds to sleep
*/
void lt_deep_sleep_config_timer(uint32_t sleep_duration);
/**
* @brief Start deep sleep
*/
void lt_deep_sleep_enter();