From f3262d40745c4109f529e0456e011c85bf134917 Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Wed, 21 Apr 2021 09:19:27 +0200 Subject: c-user: Split up initialization manager This makes it easier to automatically generate parts of the module documentation in the future. Update #3993. --- c-user/initialization/directives.rst | 41 ++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 c-user/initialization/directives.rst (limited to 'c-user/initialization/directives.rst') 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. -- cgit v1.2.3