581e5375ff
This allows enum values to be referenced in architecture `arch.h` files without circular dependencies. Signed-off-by: Jordan Yates <jordan.yates@data61.csiro.au>
92 lines
2.7 KiB
C
92 lines
2.7 KiB
C
/*
|
|
* Copyright (c) 2019 Intel Corporation.
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/** @file
|
|
* @brief Fatal error functions
|
|
*/
|
|
|
|
#ifndef ZEPHYR_INCLUDE_FATAL_H
|
|
#define ZEPHYR_INCLUDE_FATAL_H
|
|
|
|
#include <zephyr/arch/cpu.h>
|
|
#include <zephyr/toolchain.h>
|
|
#include <zephyr/fatal_types.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @defgroup fatal_apis Fatal error APIs
|
|
* @ingroup kernel_apis
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @brief Halt the system on a fatal error
|
|
*
|
|
* Invokes architecture-specific code to power off or halt the system in
|
|
* a low power state. Lacking that, lock interrupts and sit in an idle loop.
|
|
*
|
|
* @param reason Fatal exception reason code
|
|
*/
|
|
FUNC_NORETURN void k_fatal_halt(unsigned int reason);
|
|
|
|
/**
|
|
* @brief Fatal error policy handler
|
|
*
|
|
* This function is not invoked by application code, but is declared as a
|
|
* weak symbol so that applications may introduce their own policy.
|
|
*
|
|
* The default implementation of this function halts the system
|
|
* unconditionally. Depending on architecture support, this may be
|
|
* a simple infinite loop, power off the hardware, or exit an emulator.
|
|
*
|
|
* If this function returns, then the currently executing thread will be
|
|
* aborted.
|
|
*
|
|
* A few notes for custom implementations:
|
|
*
|
|
* - If the error is determined to be unrecoverable, LOG_PANIC() should be
|
|
* invoked to flush any pending logging buffers.
|
|
* - K_ERR_KERNEL_PANIC indicates a severe unrecoverable error in the kernel
|
|
* itself, and should not be considered recoverable. There is an assertion
|
|
* in z_fatal_error() to enforce this.
|
|
* - Even outside of a kernel panic, unless the fault occurred in user mode,
|
|
* the kernel itself may be in an inconsistent state, with API calls to
|
|
* kernel objects possibly exhibiting undefined behavior or triggering
|
|
* another exception.
|
|
*
|
|
* @param reason The reason for the fatal error
|
|
* @param esf Exception context, with details and partial or full register
|
|
* state when the error occurred. May in some cases be NULL.
|
|
*/
|
|
void k_sys_fatal_error_handler(unsigned int reason, const z_arch_esf_t *esf);
|
|
|
|
/**
|
|
* Called by architecture code upon a fatal error.
|
|
*
|
|
* This function dumps out architecture-agnostic information about the error
|
|
* and then makes a policy decision on what to do by invoking
|
|
* k_sys_fatal_error_handler().
|
|
*
|
|
* On architectures where k_thread_abort() never returns, this function
|
|
* never returns either.
|
|
*
|
|
* @param reason The reason for the fatal error
|
|
* @param esf Exception context, with details and partial or full register
|
|
* state when the error occurred. May in some cases be NULL.
|
|
*/
|
|
void z_fatal_error(unsigned int reason, const z_arch_esf_t *esf);
|
|
|
|
/** @} */
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* ZEPHYR_INCLUDE_FATAL_H */
|