mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
c8791f30c0
* noreturn may be replaced by third-party macros, rendering it ineffective * Closes https://github.com/espressif/esp-idf/issues/11339
123 lines
3.5 KiB
C
123 lines
3.5 KiB
C
/*
|
|
* SPDX-FileCopyrightText: 2015-2022 Espressif Systems (Shanghai) CO LTD
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
#ifndef __ESP_SYSTEM_H__
|
|
#define __ESP_SYSTEM_H__
|
|
|
|
#include <stdint.h>
|
|
#include <stdbool.h>
|
|
#include "esp_err.h"
|
|
#include "esp_attr.h"
|
|
#include "esp_bit_defs.h"
|
|
#include "esp_idf_version.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @brief Reset reasons
|
|
*/
|
|
typedef enum {
|
|
ESP_RST_UNKNOWN, //!< Reset reason can not be determined
|
|
ESP_RST_POWERON, //!< Reset due to power-on event
|
|
ESP_RST_EXT, //!< Reset by external pin (not applicable for ESP32)
|
|
ESP_RST_SW, //!< Software reset via esp_restart
|
|
ESP_RST_PANIC, //!< Software reset due to exception/panic
|
|
ESP_RST_INT_WDT, //!< Reset (software or hardware) due to interrupt watchdog
|
|
ESP_RST_TASK_WDT, //!< Reset due to task watchdog
|
|
ESP_RST_WDT, //!< Reset due to other watchdogs
|
|
ESP_RST_DEEPSLEEP, //!< Reset after exiting deep sleep mode
|
|
ESP_RST_BROWNOUT, //!< Brownout reset (software or hardware)
|
|
ESP_RST_SDIO, //!< Reset over SDIO
|
|
ESP_RST_USB, //!< Reset by USB peripheral
|
|
} esp_reset_reason_t;
|
|
|
|
/**
|
|
* Shutdown handler type
|
|
*/
|
|
typedef void (*shutdown_handler_t)(void);
|
|
|
|
/**
|
|
* @brief Register shutdown handler
|
|
*
|
|
* This function allows you to register a handler that gets invoked before
|
|
* the application is restarted using esp_restart function.
|
|
* @param handle function to execute on restart
|
|
* @return
|
|
* - ESP_OK on success
|
|
* - ESP_ERR_INVALID_STATE if the handler has already been registered
|
|
* - ESP_ERR_NO_MEM if no more shutdown handler slots are available
|
|
*/
|
|
esp_err_t esp_register_shutdown_handler(shutdown_handler_t handle);
|
|
|
|
/**
|
|
* @brief Unregister shutdown handler
|
|
*
|
|
* This function allows you to unregister a handler which was previously
|
|
* registered using esp_register_shutdown_handler function.
|
|
* - ESP_OK on success
|
|
* - ESP_ERR_INVALID_STATE if the given handler hasn't been registered before
|
|
*/
|
|
esp_err_t esp_unregister_shutdown_handler(shutdown_handler_t handle);
|
|
|
|
|
|
/**
|
|
* @brief Restart PRO and APP CPUs.
|
|
*
|
|
* This function can be called both from PRO and APP CPUs.
|
|
* After successful restart, CPU reset reason will be SW_CPU_RESET.
|
|
* Peripherals (except for Wi-Fi, BT, UART0, SPI1, and legacy timers) are not reset.
|
|
* This function does not return.
|
|
*/
|
|
void esp_restart(void) __attribute__ ((__noreturn__));
|
|
|
|
/**
|
|
* @brief Get reason of last reset
|
|
* @return See description of esp_reset_reason_t for explanation of each value.
|
|
*/
|
|
esp_reset_reason_t esp_reset_reason(void);
|
|
|
|
/**
|
|
* @brief Get the size of available heap.
|
|
*
|
|
* @note Note that the returned value may be larger than the maximum contiguous block
|
|
* which can be allocated.
|
|
*
|
|
* @return Available heap size, in bytes.
|
|
*/
|
|
uint32_t esp_get_free_heap_size(void);
|
|
|
|
/**
|
|
* @brief Get the size of available internal heap.
|
|
*
|
|
* @note Note that the returned value may be larger than the maximum contiguous block
|
|
* which can be allocated.
|
|
*
|
|
* @return Available internal heap size, in bytes.
|
|
*/
|
|
uint32_t esp_get_free_internal_heap_size(void);
|
|
|
|
/**
|
|
* @brief Get the minimum heap that has ever been available
|
|
*
|
|
* @return Minimum free heap ever available
|
|
*/
|
|
uint32_t esp_get_minimum_free_heap_size( void );
|
|
|
|
/**
|
|
* @brief Trigger a software abort
|
|
*
|
|
* @param details Details that will be displayed during panic handling.
|
|
*/
|
|
void __attribute__((__noreturn__)) esp_system_abort(const char* details);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __ESP_SYSTEM_H__ */
|