.gitignore: Update
[AROS.git] / rom / kernel / displayalert.c
blob04ffb42f107a0b0c4b592eec70fea947c6163599
1 #include <aros/kernel.h>
2 #include <aros/libcall.h>
4 #include <kernel_base.h>
5 #include <kernel_debug.h>
7 /*****************************************************************************
9 NAME */
10 #include <proto/kernel.h>
12 AROS_LH2(void, KrnDisplayAlert,
14 /* SYNOPSIS */
15 AROS_LHA(uint32_t, code, D0),
16 AROS_LHA(const char *, text, A0),
18 /* LOCATION */
19 struct KernelBase *, KernelBase, 35, Kernel)
21 /* FUNCTION
22 Inform the user about critical system failure.
24 INPUTS
25 code - Corresponding alert code.
26 text - A NULL-terminated text to print out.
28 First three lines are assumed to be a header. Some implementations
29 may print them centered inside a frame.
31 RESULT
32 None. This function is not guaranteed to return.
34 NOTES
35 This function exists for system internal purposes. Please do not
36 call it from within regular applications! In 99% of cases this function
37 will halt or reboot the machine. Certain structures in RAM, as well as
38 video hardware state, will be irreversibly destroyed.
40 'code' parameter is passed for convenience. Based on it, the system
41 can make a decision to log the alert in debug output and continue,
42 instead of displaying a message and halting.
44 This function is currently experimental. Its definition may change.
46 EXAMPLE
48 BUGS
50 SEE ALSO
52 INTERNALS
54 ******************************************************************************/
56 AROS_LIBFUNC_INIT
59 * This is a generic version that simply formats the text into debug log.
60 * It can be replaced with machine-specific implementation which can do more.
62 krnDisplayAlert(text, KernelBase);
64 AROS_LIBFUNC_EXIT