components/esp_hw_support/include/esp_private/rtc_ctrl.h (ESP-IDF)

/* * SPDX-FileCopyrightText: 2016-2021 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ #pragma once #include <stdint.h> #include "esp_err.h" #include "esp_intr_alloc.h" #ifdef __cplusplus extern "C" { #endif #define RTC_INTR_FLAG_IRAM (BIT(0)) /*< Some rtc interrupts can be called with cache disabled */ /** * @brief Register a handler for specific RTC_CNTL interrupts * * Multiple handlers can be registered using this function. Whenever an * RTC interrupt happens, all handlers with matching rtc_intr_mask values * will be called. * * @param handler handler function to call * @param handler_arg argument to be passed to the handler * @param rtc_intr_mask combination of RTC_CNTL_*_INT_ENA bits indicating the * sources to call the handler for * @param flags An ORred mask of the RTC_INTR_FLAG_* defines. You can pass different * flags to it to realize different purpose. If 0, the interrupt will * not handle anything special. If you pass `RTC_INTR_FLAG_IRAM`, means * the interrupt can be triggered with cache disabled. * @return * - ESP_OK on success * - ESP_ERR_NO_MEM not enough memory to allocate handler structure * - other errors returned by esp_intr_alloc */ esp_err_t rtc_isr_register(intr_handler_t handler, void* handler_arg, uint32_t rtc_intr_mask, uint32_t flags); /** * @brief Deregister the handler previously registered using rtc_isr_register * @param handler handler function to call (as passed to rtc_isr_register) * @param handler_arg argument of the handler (as passed to rtc_isr_register) * @return * - ESP_OK on success * - ESP_ERR_INVALID_STATE if a handler matching both handler and * handler_arg isn't registered */ esp_err_t rtc_isr_deregister(intr_handler_t handler, void* handler_arg); /** * @brief Disable the RTC interrupt that is allowed to be executed when cache is disabled. * cache disabled. Internal interrupt handle function will call this function in interrupt * handler function. Disable bits when `esp_intr_noniram_disable` is called. * * @param cpu CPU number. */ void rtc_isr_noniram_disable(uint32_t cpu); /** * @brief Enable the RTC interrupt that is allowed to be executed when cache is disabled. * cache disabled. Internal interrupt handle function will call this function in interrupt * handler function. Enable bits when `esp_intr_noniram_enable` is called. * * @param cpu CPU number. */ void rtc_isr_noniram_enable(uint32_t cpu); #ifdef __cplusplus } #endif