1
0
Fork 0
mirror of https://github.com/u-boot/u-boot.git synced 2025-04-14 00:44:35 +00:00
u-boot/include/interrupt.h
Heinrich Schuchardt 7082c9e656 common: clean up setjmp.h
Separate setjmp.h into an architecture independent part and an architecture
specific part. This simplifies moving from using struct jmp_buf_data
directly to using type jmp_buf in our code which is the C compliant way.

Reviewed-by: Jerome Forissier <jerome.forissier@linaro.org>
Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2025-03-10 07:41:16 +01:00

45 lines
1.3 KiB
C

/* SPDX-License-Identifier: GPL-2.0-or-later */
#include <setjmp.h>
/**
* struct resume_data - data for resume after interrupt
*/
struct resume_data {
/** @jump: longjmp buffer */
jmp_buf jump;
/** @code: exception code */
ulong code;
};
/**
* set_resume() - set longjmp buffer for resuming after exception
*
* By calling this function it is possible to use a long jump to catch an
* exception. The caller sets the long jump buffer with set_resume() and then
* executes setjmp(). If an exception occurs, the code will return to the
* setjmp caller(). The exception code will be returned in @data->code.
*
* After the critical operation call set_resume(NULL) so that an exception in
* another part of the code will not accidently invoke the long jump.
*
* .. code-block:: c
*
* // This example shows how to use set_resume().
*
* struct resume_data resume;
* int ret;
*
* set_resume(&resume);
* ret = setjmp(resume.jump);
* if (ret) {
* printf("An exception %ld occurred\n", resume.code);
* } else {
* // Do what might raise an exception here.
* }
* set_resume(NULL);
*
* @data: pointer to structure with longjmp address
* Return: 0 before an exception, 1 after an exception occurred
*/
void set_resume(struct resume_data *data);