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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
|
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @brief This header file defines support services of the 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 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/support/if/header */
#ifndef _RTEMS_RTEMS_SUPPORT_H
#define _RTEMS_RTEMS_SUPPORT_H
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <rtems/config.h>
#include <rtems/rtems/types.h>
#include <rtems/score/heapinfo.h>
#ifdef __cplusplus
extern "C" {
#endif
/* Generated from spec:/rtems/support/if/group */
/**
* @defgroup RTEMSAPIClassicSupport Support Services
*
* @ingroup RTEMSAPIClassic
*
* @brief Items of this group should move to other groups.
*/
/* Generated from spec:/rtems/support/if/is-name-valid */
/**
* @ingroup RTEMSAPIClassicSupport
*
* @brief Returns true, if the specified object name is valid, otherwise
* returns false.
*
* @param name is the object name to check.
*
* @retval true The specified object name is valid.
*
* @retval false Otherwise.
*/
static inline bool rtems_is_name_valid( rtems_name name )
{
return name != 0;
}
/* Generated from spec:/rtems/support/if/microseconds-to-ticks */
/**
* @ingroup RTEMSAPIClassicSupport
*
* @brief Returns the number of clock ticks for the specified microseconds
* value.
*
* @param _us is the microseconds value to convert to clock ticks.
*
* @return The number of clock ticks for the specified microseconds value is
* returned.
*
* @par Notes
* The number of clock ticks per second is defined by the
* #CONFIGURE_MICROSECONDS_PER_TICK application configuration option.
*/
#define RTEMS_MICROSECONDS_TO_TICKS( _us ) \
( ( _us ) / rtems_configuration_get_microseconds_per_tick() )
/* Generated from spec:/rtems/support/if/milliseconds-to-microseconds */
/**
* @ingroup RTEMSAPIClassicSupport
*
* @brief Returns the number of microseconds for the specified milliseconds
* value.
*
* @param _ms is the milliseconds value to convert to microseconds.
*
* @return The number of microseconds for the specified milliseconds value is
* returned.
*/
#define RTEMS_MILLISECONDS_TO_MICROSECONDS( _ms ) ( ( _ms ) * 1000UL )
/* Generated from spec:/rtems/support/if/milliseconds-to-ticks */
/**
* @ingroup RTEMSAPIClassicSupport
*
* @brief Returns the number of clock ticks for the specified milliseconds
* value.
*
* @param _ms is the milliseconds value to convert to clock ticks.
*
* @return The number of clock ticks for the specified milliseconds value is
* returned.
*
* @par Notes
* The number of clock ticks per second is defined by the
* #CONFIGURE_MICROSECONDS_PER_TICK application configuration option.
*/
#define RTEMS_MILLISECONDS_TO_TICKS( _ms ) \
RTEMS_MICROSECONDS_TO_TICKS( RTEMS_MILLISECONDS_TO_MICROSECONDS( _ms ) )
/* Generated from spec:/rtems/support/if/name-to-characters */
/**
* @ingroup RTEMSAPIClassicSupport
*
* @brief Breaks the object name into the four component characters.
*
* @param name is the object name to break into four component characters.
*
* @param[out] c1 is the first character of the object name.
*
* @param[out] c2 is the second character of the object name.
*
* @param[out] c3 is the third character of the object name.
*
* @param[out] c4 is the fourth character of the object name.
*/
static inline void rtems_name_to_characters(
rtems_name name,
char *c1,
char *c2,
char *c3,
char *c4
)
{
*c1 = (char) ( name >> 24 );
*c2 = (char) ( name >> 16 );
*c3 = (char) ( name >> 8 );
*c4 = (char) name;
}
/* Generated from spec:/rtems/support/if/workspace-allocate */
/**
* @ingroup RTEMSAPIClassicSupport
*
* @brief %
*
* @param bytes %
*
* @param pointer %
*/
bool rtems_workspace_allocate( size_t bytes, void **pointer );
/* Generated from spec:/rtems/support/if/workspace-free */
/**
* @ingroup RTEMSAPIClassicSupport
*
* @brief %
*
* @param pointer %
*/
bool rtems_workspace_free( void *pointer );
/* Generated from spec:/rtems/support/if/workspace-get-information */
/**
* @ingroup RTEMSAPIClassicSupport
*
* @brief %
*
* @param the_info %
*/
bool rtems_workspace_get_information( Heap_Information_block *the_info );
/* Generated from spec:/rtems/support/if/workspace-greedy-allocate */
/**
* @ingroup RTEMSAPIClassicSupport
*
* @brief %
*
* @param block_sizes %
*
* @param block_count %
*/
void *rtems_workspace_greedy_allocate(
const uintptr_t *block_sizes,
size_t block_count
);
/* Generated from spec:/rtems/support/if/workspace-greedy-allocate-all-except-largest */
/**
* @ingroup RTEMSAPIClassicSupport
*
* @brief %
*
* @param allocatable_size %
*/
void *rtems_workspace_greedy_allocate_all_except_largest(
uintptr_t *allocatable_size
);
/* Generated from spec:/rtems/support/if/workspace-greedy-free */
/**
* @ingroup RTEMSAPIClassicSupport
*
* @brief %
*
* @param opaque %
*/
void rtems_workspace_greedy_free( void *opaque );
#ifdef __cplusplus
}
#endif
#endif /* _RTEMS_RTEMS_SUPPORT_H */
|
