rom/kernel/displayalert.c

   1 /*
   2     Copyright © 1995-2013, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc:
   6 */
   7
   8 #include <aros/kernel.h>
   9 #include <aros/libcall.h>
  10
  11 #include <kernel_base.h>
  12 #include <kernel_debug.h>
  13
  14 /*****************************************************************************
  15
  16     NAME */
  17 #include <proto/kernel.h>
  18
  19         AROS_LH2(void, KrnDisplayAlert,
  20
  21 /*  SYNOPSIS */
  22         AROS_LHA(uint32_t, code, D0),
  23         AROS_LHA(const char *, text, A0),
  24
  25 /*  LOCATION */
  26         struct KernelBase *, KernelBase, 35, Kernel)
  27
  28 /*  FUNCTION
  29         Inform the user about critical system failure.
  30
  31     INPUTS
  32         code - Corresponding alert code.
  33         text - A NULL-terminated text to print out.
  34
  35         First three lines are assumed to be a header. Some implementations
  36         may print them centered inside a frame.
  37
  38     RESULT
  39         None. This function is not guaranteed to return.
  40
  41     NOTES
  42         This function exists for system internal purposes. Please do not
  43         call it from within regular applications! In 99% of cases this function
  44         will halt or reboot the machine. Certain structures in RAM, as well as
  45         video hardware state, will be irreversibly destroyed.
  46
  47         'code' parameter is passed for convenience. Based on it, the system
  48         can make a decision to log the alert in debug output and continue,
  49         instead of displaying a message and halting.
  50
  51         This function is currently experimental. Its definition may change.
  52
  53     EXAMPLE
  54
  55     BUGS
  56
  57     SEE ALSO
  58
  59     INTERNALS
  60
  61 ******************************************************************************/
  62 {
  63     AROS_LIBFUNC_INIT
  64
  65     /*
  66      * This is a generic version that simply formats the text into debug log.
  67      * It can be replaced with machine-specific implementation which can do more.
  68      */
  69     krnDisplayAlert(text, KernelBase);
  70
  71     AROS_LIBFUNC_EXIT
  72 }