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
|
/**
* @file
*
* @defgroup ClassicRTEMSWorkspace Workspace
*
* @ingroup ClassicRTEMS
* @brief Classic API support.
*/
/* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.org/license/LICENSE.
*/
#ifndef _RTEMS_RTEMS_SUPPORT_H
#define _RTEMS_RTEMS_SUPPORT_H
#include <rtems/rtems/types.h>
#include <rtems/config.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* @addtogroup ClassicRTEMS
*/
/**@{**/
/**
* @brief Returns the number of micro seconds for the milli seconds value @a _ms.
*/
#define RTEMS_MILLISECONDS_TO_MICROSECONDS(_ms) ((_ms) * 1000UL)
/**
* @brief Returns the number of ticks for the milli seconds value @a _ms.
*/
#define RTEMS_MILLISECONDS_TO_TICKS(_ms) \
(RTEMS_MILLISECONDS_TO_MICROSECONDS(_ms) / \
rtems_configuration_get_microseconds_per_tick())
/**
* @brief Returns the number of ticks for the micro seconds value @a _us.
*/
#define RTEMS_MICROSECONDS_TO_TICKS(_us) \
((_us) / rtems_configuration_get_microseconds_per_tick())
/**
* @brief Returns @c true if the name is valid, and @c false otherwise.
*/
RTEMS_INLINE_ROUTINE bool rtems_is_name_valid (
rtems_name name
)
{
return ( name != 0 );
}
/**
* @brief Breaks the object name into the four component characters @a c1,
* @a c2, @a c3, and @a c4.
*/
RTEMS_INLINE_ROUTINE void rtems_name_to_characters(
rtems_name name,
char *c1,
char *c2,
char *c3,
char *c4
)
{
*c1 = (char) ((name >> 24) & 0xff);
*c2 = (char) ((name >> 16) & 0xff);
*c3 = (char) ((name >> 8) & 0xff);
*c4 = (char) ( name & 0xff);
}
/** @} */
/**
* @defgroup ClassicRTEMSWorkspace Workspace
*
* @ingroup ClassicRTEMS
*
* Workspace definitions.
*/
/**@{**/
/**
* @brief Gets Workspace Information
*
* Returns information about the heap that is used as the RTEMS Executive
* Workspace in @a the_info.
*
* Returns @c true if successful, and @a false otherwise.
*/
bool rtems_workspace_get_information(
Heap_Information_block *the_info
);
/**
* @brief Allocates Memory from the Workspace
*
* A number of @a bytes bytes will be allocated from the RTEMS Executive
* Workspace and returned in @a pointer.
*
* Returns @c true if successful, and @a false otherwise.
*/
bool rtems_workspace_allocate(
size_t bytes,
void **pointer
);
/**
* @brief Frees Memory Allocated from the Workspace
*
* This frees the memory indicated by @a pointer that was allocated from the
* RTEMS Executive Workspace.
*
* Returns @c true if successful, and @a false otherwise.
*/
bool rtems_workspace_free(
void *pointer
);
/**
* @brief Greedy allocate that empties the workspace.
*
* Afterwards the heap has at most @a block_count allocatable blocks of sizes
* specified by @a block_sizes. The @a block_sizes must point to an array with
* @a block_count members. All other blocks are used.
*
* @see rtems_workspace_greedy_free().
*/
void *rtems_workspace_greedy_allocate(
const uintptr_t *block_sizes,
size_t block_count
);
/**
* @brief Greedy allocate all blocks except the largest free block.
*
* Afterwards the heap has at most one allocatable block. This block is the
* largest free block if it exists. The allocatable size of this block is
* stored in @a allocatable_size. All other blocks are used.
*
* @see rtems_workspace_greedy_free().
*/
void *rtems_workspace_greedy_allocate_all_except_largest(
uintptr_t *allocatable_size
);
/**
* @brief Frees space of a greedy allocation.
*
* The @a opaque argument must be the return value of
* rtems_workspace_greedy_allocate() or
* rtems_workspace_greedy_allocate_all_except_largest().
*/
void rtems_workspace_greedy_free( void *opaque );
/** @} */
#ifdef __cplusplus
}
#endif
#endif
/* end of include file */
|
