summaryrefslogtreecommitdiffstats
path: root/c/src/exec/score/headers/userext.h
blob: 56fae9b7db74b69c5af4d1c3ae42854b2d98fd4e (plain) (blame)
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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
/*  userext.h
 *
 *  This include file contains all information about user extensions.  This
 *  Handler provides mechanisms which can be used to initialize and manipulate
 *  all RTEMS user extensions.
 *
 *  COPYRIGHT (c) 1989, 1990, 1991, 1992, 1993, 1994.
 *  On-Line Applications Research Corporation (OAR).
 *  All rights assigned to U.S. Government, 1994.
 *
 *  This material may be reproduced by or for the U.S. Government pursuant
 *  to the copyright license under the clause at DFARS 252.227-7013.  This
 *  notice must appear in all copies of this file and its derivatives.
 *
 *  $Id$
 */

#ifndef __RTEMS_USER_EXTENSIONS_h
#define __RTEMS_USER_EXTENSIONS_h

#ifdef __cplusplus
extern "C" {
#endif

#include <rtems/config.h>
#include <rtems/thread.h>

/*
 *  The following is used to manage each user extension set.
 */

typedef struct {
  Chain_Node                     Node;
  rtems_extensions_table  Callouts;
}   User_extensions_Control;

/*
 *  The following contains the static extension set which may be
 *  configured by the application.
 */

EXTERN User_extensions_Control _User_extensions_Initial;

/*
 *  The following is used to manage the list of active extensions.
 */

EXTERN Chain_Control _User_extensions_List;


/*
 *  _User_extensions_Handler_initialization
 *
 *  DESCRIPTION:
 *
 *  This routine performs the initialization necessary for this handler.
 */

STATIC INLINE void _User_extensions_Handler_initialization (
    rtems_extensions_table *initial_extensions
);

/*
 *  _User_extensions_Add_set
 *
 *  DESCRIPTION:
 *
 *  This routine is used to add a user extension set to the active list.
 */

STATIC INLINE void _User_extensions_Add_set (
  User_extensions_Control  *the_extension,
  rtems_extensions_table   *extension_table
);

/*
 *  _User_extensions_Remove_set
 *
 *  DESCRIPTION:
 *
 *  This routine is used to remove a user extension set from the active list.
 */

STATIC INLINE void _User_extensions_Remove_set (
  User_extensions_Control  *the_extension
);

/*
 *  _User_extensions_Task_create
 *
 *  DESCRIPTION:
 *
 *  This routine is used to invoke the user extension for
 *  the rtems_task_create directive.
 */

STATIC INLINE void _User_extensions_Task_create (
  Thread_Control *the_thread
);

/*
 *  _User_extensions_Task_delete
 *
 *  DESCRIPTION:
 *
 *  This routine is used to invoke the user extension for
 *  the rtems_task_delete directive.
 */

STATIC INLINE void _User_extensions_Task_delete (
  Thread_Control *the_thread
);

/*
 *  _User_extensions_Task_start
 *
 *  DESCRIPTION:
 *
 *  This routine is used to invoke the user extension for
 *  the rtems_task_start directive.
 */

STATIC INLINE void _User_extensions_Task_start (
  Thread_Control *the_thread
);

/*
 *  _User_extensions_Task_restart
 *
 *  DESCRIPTION:
 *
 *  This routine is used to invoke the user extension for
 *  the rtems_task_restart directive.
 */

STATIC INLINE void _User_extensions_Task_restart (
  Thread_Control *the_thread
);

/*
 *  _User_extensions_Task_switch
 *
 *  DESCRIPTION:
 *
 *  This routine is used to invoke the user extension which
 *  is invoked when a context switch occurs.
 */

STATIC INLINE void _User_extensions_Task_switch (
  Thread_Control *executing,
  Thread_Control *heir
);

/*
 *  _User_extensions_Task_begin
 *
 *  DESCRIPTION:
 *
 *  This routine is used to invoke the user extension which
 *  is invoked when a task begins.
 */

STATIC INLINE void _User_extensions_Task_begin (
  Thread_Control *executing
);

/*
 *  _User_extensions_Task_exitted
 *
 *  DESCRIPTION:
 *
 *  This routine is used to invoke the user extension which
 *  is invoked when a task exits.
 */

STATIC INLINE void _User_extensions_Task_exitted (
  Thread_Control *executing
);

/*
 *  _User_extensions_Task_exitted
 *
 *  DESCRIPTION:
 *
 *  This routine is used to invoke the user extension which
 *  is invoked when a task exits.
 */

STATIC INLINE void _User_extensions_Task_exitted (
  Thread_Control *executing
);

/*
 *  _User_extensions_Fatal
 *
 *  DESCRIPTION:
 *
 *  This routine is used to invoke the user extension for
 *  the rtems_fatal_error_occurred directive.
 */

STATIC INLINE void _User_extensions_Fatal (
  unsigned32 the_error
);

#include <rtems/userext.inl>

#ifdef __cplusplus
}
#endif

#endif
/* end of include file */