summaryrefslogtreecommitdiff
path: root/cpukit/include/rtems/init.h
blob: b48197be55612c065c4931795a9573732d5e5dbb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
/* SPDX-License-Identifier: BSD-2-Clause */

/**
 * @file
 *
 * @brief This header file defines the Initialization Manager API.
 */

/*
 * Copyright (C) 2015, 2020 embedded brains GmbH (http://www.embedded-brains.de)
 * Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

/*
 * This file is part of the RTEMS quality process and was automatically
 * generated.  If you find something that needs to be fixed or
 * worded better please post a report or patch to an RTEMS mailing list
 * or raise a bug report:
 *
 * https://www.rtems.org/bugs.html
 *
 * For information on updating and regenerating please refer to the How-To
 * section in the Software Requirements Engineering chapter of the
 * RTEMS Software Engineering manual.  The manual is provided as a part of
 * a release.  For development sources please refer to the online
 * documentation at:
 *
 * https://docs.rtems.org
 */

/* Generated from spec:/rtems/init/if/header */

#ifndef _RTEMS_INIT_H
#define _RTEMS_INIT_H

#include <stdint.h>
#include <rtems/score/basedefs.h>

#ifdef __cplusplus
extern "C" {
#endif

/* Generated from spec:/rtems/init/if/group */

/**
 * @defgroup RTEMSAPIClassicInit Initialization and Shutdown
 *
 * @ingroup RTEMSAPIClassic
 *
 * @brief This group contains directives to initialize and shutdown the RTEMS
 *   executive.
 */

/* Generated from spec:/rtems/init/if/initialize-executive */

/**
 * @ingroup RTEMSAPIClassicInit
 *
 * @brief Initializes the system and starts multitasking.
 *
 * Iterates through the system initialization linker set and invokes the
 * registered handlers.  The final step is to start multitasking.
 *
 * @par Notes
 * @parblock
 * This directive should be called by 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.
 * @endparblock
 */
RTEMS_NO_RETURN void rtems_initialize_executive( void );

/* Generated from spec:/rtems/init/if/shutdown-executive */

/**
 * @ingroup RTEMSAPIClassicInit
 *
 * @brief Shuts down the RTEMS environment.
 *
 * @param result is the result code.
 *
 * The invocation of this directive results in the RTEMS environment being
 * shutdown and multitasking halted.  The system is terminated with a fatal
 * source of RTEMS_FATAL_SOURCE_EXIT and the specified result code.
 *
 * @par Notes
 * This directive does not return to the caller.
 */
RTEMS_NO_RETURN void rtems_shutdown_executive( uint32_t result );

#ifdef __cplusplus
}
#endif

#endif /* _RTEMS_INIT_H */