summaryrefslogtreecommitdiff
path: root/cpukit/include/rtems/extension.h
blob: 870fa5b215339b835096a6a437c079b2076a2e0e (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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
/* SPDX-License-Identifier: BSD-2-Clause */

/**
 * @file
 *
 * @ingroup RTEMSAPIClassicUserext
 *
 * @brief This header file defines the User Extensions Manager API.
 */

/*
 * Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 * Copyright (C) 1988, 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 was automatically generated.  Do not edit it manually.
 * Please have a look at
 *
 * https://docs.rtems.org/branches/master/eng/req/howto.html
 *
 * for information how to maintain and re-generate this file.
 */

#ifndef _RTEMS_EXTENSION_H
#define _RTEMS_EXTENSION_H

#include <rtems/rtems/status.h>
#include <rtems/rtems/types.h>
#include <rtems/score/interr.h>
#include <rtems/score/userextdata.h>

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @defgroup RTEMSAPIClassicUserext User Extensions Manager
 *
 * @ingroup RTEMSAPIClassic
 *
 * @brief The User Extensions Manager allows the application developer to
 *   augment the executive by allowing them to supply extension routines which
 *   are invoked at critical system events.
 */

/**
 * @ingroup RTEMSAPIClassicUserext
 *
 * @brief %
 */
typedef User_extensions_Table rtems_extensions_table;

/**
 * @ingroup RTEMSAPIClassicUserext
 *
 * @brief %
 *
 * @param name %
 *
 * @param extension_table %
 *
 * @param id %
 */
rtems_status_code rtems_extension_create(
  rtems_name                    name,
  const rtems_extensions_table *extension_table,
  rtems_id                     *id
);

/**
 * @ingroup RTEMSAPIClassicUserext
 *
 * @brief %
 *
 * @param id %
 */
rtems_status_code rtems_extension_delete( rtems_id id );

/**
 * @ingroup RTEMSAPIClassicUserext
 *
 * @brief %
 */
typedef User_extensions_fatal_extension rtems_fatal_extension;

/**
 * @ingroup RTEMSAPIClassicUserext
 *
 * @brief %
 */
typedef Internal_errors_t rtems_fatal_code;

/**
 * @ingroup RTEMSAPIClassicUserext
 *
 * @brief %
 */
typedef Internal_errors_Source rtems_fatal_source;

/**
 * @ingroup RTEMSAPIClassicUserext
 *
 * @brief %
 *
 * @param name %
 *
 * @param id %
 */
rtems_status_code rtems_extension_ident( rtems_name name, rtems_id *id );

/**
 * @ingroup RTEMSAPIClassicUserext
 *
 * @brief %
 */
typedef User_extensions_thread_begin_extension rtems_task_begin_extension;

/**
 * @ingroup RTEMSAPIClassicUserext
 *
 * @brief %
 */
typedef User_extensions_thread_create_extension rtems_task_create_extension;

/**
 * @ingroup RTEMSAPIClassicUserext
 *
 * @brief %
 */
typedef User_extensions_thread_delete_extension rtems_task_delete_extension;

/**
 * @ingroup RTEMSAPIClassicUserext
 *
 * @brief %
 */
typedef User_extensions_thread_exitted_extension rtems_task_exitted_extension;

/**
 * @ingroup RTEMSAPIClassicUserext
 *
 * @brief %
 */
typedef User_extensions_thread_restart_extension rtems_task_restart_extension;

/**
 * @ingroup RTEMSAPIClassicUserext
 *
 * @brief %
 */
typedef User_extensions_thread_start_extension rtems_task_start_extension;

/**
 * @ingroup RTEMSAPIClassicUserext
 *
 * @brief %
 */
typedef User_extensions_thread_switch_extension rtems_task_switch_extension;

/**
 * @ingroup RTEMSAPIClassicUserext
 *
 * @brief %
 */
typedef User_extensions_thread_terminate_extension rtems_task_terminate_extension;

#ifdef __cplusplus
}
#endif

#endif /* _RTEMS_EXTENSION_H */