mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
108 lines
2.6 KiB
C
108 lines
2.6 KiB
C
/*
|
|
* SPDX-FileCopyrightText: 2015-2022 Espressif Systems (Shanghai) CO LTD
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include <stdint.h>
|
|
#include "ulp_riscv_register_ops.h"
|
|
|
|
/**
|
|
* @brief Wakeup main CPU from sleep or deep sleep.
|
|
*
|
|
* This raises a software interrupt signal, if the
|
|
* main CPU is configured the ULP as a wakeup source
|
|
* calling this function will make the main CPU to
|
|
* exit from sleep or deep sleep.
|
|
*/
|
|
void ulp_riscv_wakeup_main_processor(void);
|
|
|
|
/**
|
|
* @brief Rescues the cpu from monitor mode
|
|
*
|
|
* This function cancels the low power mode
|
|
* of the ULP-RISC-V, should be called
|
|
* every time the co-processor starts.
|
|
*
|
|
* @note by convenience this function is
|
|
* automatically called in startup code.
|
|
*/
|
|
void ulp_riscv_rescue_from_monitor(void);
|
|
|
|
/**
|
|
* @brief Finishes the ULP program and powers down the ULP
|
|
* until next wakeup.
|
|
*
|
|
* @note This function does not return. After called it will
|
|
* fully reset the ULP.
|
|
*
|
|
* @note Returning from main() in the ULP program results on
|
|
* calling this function.
|
|
*
|
|
* @note To stop the ULP from waking up, call ulp_riscv_timer_stop()
|
|
* before halting.
|
|
*
|
|
* This function should be called after the ULP program Finishes
|
|
* its processing, it will trigger the timer for the next wakeup,
|
|
* put the ULP in monitor mode and triggers a reset.
|
|
*
|
|
*/
|
|
void __attribute__((noreturn)) ulp_riscv_halt(void);
|
|
|
|
#define ulp_riscv_shutdown ulp_riscv_halt
|
|
|
|
/**
|
|
* @brief Stop the ULP timer
|
|
*
|
|
* @note This will stop the ULP from waking up if halted, but will not abort any program
|
|
* currently executing on the ULP.
|
|
*/
|
|
void ulp_riscv_timer_stop(void);
|
|
|
|
|
|
/**
|
|
* @brief Resumes the ULP timer
|
|
*
|
|
* @note This will resume an already configured timer, but does no other configuration
|
|
*
|
|
*/
|
|
void ulp_riscv_timer_resume(void);
|
|
|
|
#define ULP_RISCV_GET_CCOUNT() ({ int __ccount; \
|
|
asm volatile("rdcycle %0;" : "=r"(__ccount)); \
|
|
__ccount; })
|
|
|
|
|
|
#if CONFIG_IDF_TARGET_ESP32S2
|
|
/* These are only approximate default numbers, the default frequency
|
|
of the 8M oscillator is 8.5MHz +/- 5%, at the default DCAP setting
|
|
*/
|
|
#define ULP_RISCV_CYCLES_PER_US 8.5
|
|
#elif CONFIG_IDF_TARGET_ESP32S3
|
|
#define ULP_RISCV_CYCLES_PER_US 17.5
|
|
#endif
|
|
#define ULP_RISCV_CYCLES_PER_MS ULP_RISCV_CYCLES_PER_US*1000
|
|
|
|
/**
|
|
* @brief Makes the co-processor busy wait for a certain number of cycles
|
|
*
|
|
* @param cycles Number of cycles to busy wait
|
|
*/
|
|
void ulp_riscv_delay_cycles(uint32_t cycles);
|
|
|
|
/**
|
|
* @brief Clears the GPIO wakeup interrupt bit
|
|
*
|
|
*/
|
|
void ulp_riscv_gpio_wakeup_clear(void);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|