summaryrefslogtreecommitdiffstats
path: root/c-user/initialization/directives.rst
diff options
context:
space:
mode:
Diffstat (limited to 'c-user/initialization/directives.rst')
-rw-r--r--c-user/initialization/directives.rst41
1 files changed, 41 insertions, 0 deletions
diff --git a/c-user/initialization/directives.rst b/c-user/initialization/directives.rst
new file mode 100644
index 0000000..97dea46
--- /dev/null
+++ b/c-user/initialization/directives.rst
@@ -0,0 +1,41 @@
+.. SPDX-License-Identifier: CC-BY-SA-4.0
+
+.. Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+
+Directives
+==========
+
+This section details the Initialization Manager's directives. A subsection is
+dedicated to each of this manager's directives and describes the calling
+sequence, related constants, usage, and status codes.
+
+.. raw:: latex
+
+ \clearpage
+
+.. index:: initialize RTEMS
+.. index:: start multitasking
+.. index:: rtems_initialize_executive
+
+.. _rtems_initialize_executive:
+
+INITIALIZE_EXECUTIVE - Initialize RTEMS
+---------------------------------------
+
+CALLING SEQUENCE:
+ .. code-block:: c
+
+ void rtems_initialize_executive(void);
+
+DIRECTIVE STATUS CODES:
+ NONE - This function will not return to the caller.
+
+DESCRIPTION:
+ Iterates through the system initialization linker set and invokes the
+ registered handlers. The final step is to start multitasking.
+
+NOTES:
+ This directive should be called by :c:func:`boot_card()` only.
+
+ This directive *does not return* to the caller. Errors in the
+ initialization sequence are usually fatal and lead to a system termination.