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
|
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSScoreAddress
*
* @brief This header file provides the interfaces of the
* @ref RTEMSScoreAddress.
*/
/*
* COPYRIGHT (c) 1989-2006.
* 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.
*/
#ifndef _RTEMS_SCORE_ADDRESS_H
#define _RTEMS_SCORE_ADDRESS_H
#include <rtems/score/cpu.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* @defgroup RTEMSScoreAddress Address Handler
*
* @ingroup RTEMSScore
*
* @brief This group contains the Address Handler implementation.
*
* This handler encapsulates functionality which abstracts address
* manipulation in a portable manner.
*
* @{
*/
/**
* @brief Adds offset to an address.
*
* This function is used to add an @a offset to a @a base address.
* It returns the resulting address. This address is typically
* converted to an access type before being used further.
*
* @param base The base address to add the offset to.
* @param offset The offset to add to @a base.
*
* @return This method returns the resulting address.
*/
static inline void *_Addresses_Add_offset (
const void *base,
uintptr_t offset
)
{
return (void *)((uintptr_t)base + offset);
}
/**
* @brief Subtracts offset from an address.
*
* This function is used to subtract an @a offset from a @a base
* address. It returns the resulting address. This address is
* typically converted to an access type before being used further.
*
* @param base The base address to subtract the offset from.
* @param offset The offset to subtract from @a base.
*
* @return This method returns the resulting address.
*/
static inline void *_Addresses_Subtract_offset (
const void *base,
uintptr_t offset
)
{
return (void *)((uintptr_t)base - offset);
}
/**
* @brief Subtracts two addresses.
*
* This function is used to subtract two addresses. It returns the
* resulting offset.
*
* @param left The address on the left hand side of the subtraction.
* @param right The address on the right hand side of the subtraction.
*
* @return This method returns the resulting address.
*/
static inline intptr_t _Addresses_Subtract(
const void *left,
const void *right
)
{
return (intptr_t) ( (const char *) left - (const char *) right );
}
/**
* @brief Checks if address is aligned.
*
* This function returns true if the given address is correctly
* aligned for this processor and false otherwise. Proper alignment
* is based on correctness and efficiency.
*
* @param address The address being checked for alignment.
*
* @retval true The @a address is aligned.
* @retval false The @a address is not aligned.
*/
static inline bool _Addresses_Is_aligned(
const void *address
)
{
return ( (uintptr_t) address % CPU_ALIGNMENT ) == 0;
}
/**
* @brief Checks if address is in range.
*
* This function returns true if the given address is within the
* memory range specified and false otherwise. @a base is the address
* of the first byte in the memory range and @a limit is the address
* of the last byte in the memory range. The base address is
* assumed to be lower than the limit address.
*
* @param address The address to check if it is in the given range.
* @param base The lowest address of the range to check against.
* @param limit The highest address of the range to check against.
*
* @retval true The @a address is within the memory range specified
* @retval false The @a address is not within the memory range specified.
*/
static inline bool _Addresses_Is_in_range (
const void *address,
const void *base,
const void *limit
)
{
return (address >= base && address <= limit);
}
/**
* @brief Aligns address to nearest multiple of alignment, rounding up.
*
* This function returns the given address aligned to the given alignment.
* If the address already is aligned, or if alignment is 0, the address is
* returned as is. The returned address is greater than or equal to the
* given address.
*
* @param address The address to align to the given alignment.
* @param alignment The desired alignment for the address. It must be a power of two.
*
* @return Returns the aligned address.
*/
static inline void *_Addresses_Align_up(
void *address,
size_t alignment
)
{
uintptr_t mask = alignment - (uintptr_t)1;
return (void*)(((uintptr_t)address + mask) & ~mask);
}
/**
* @brief Aligns address to nearest multiple of alignment, truncating.
*
* This function returns the given address aligned to the given alignment.
* If the address already is aligned, or if alignment is 0, the address is
* returned as is. The returned address is less than or equal to the
* given address.
*
* @param address The address to align to the given alignment.
* @param alignment The desired alignment for the address. It must be a power of two.
*
* @return Returns the aligned address.
*/
static inline void *_Addresses_Align_down(
void *address,
size_t alignment
)
{
uintptr_t mask = alignment - (uintptr_t)1;
return (void*)((uintptr_t)address & ~mask);
}
/** @} */
#ifdef __cplusplus
}
#endif
#endif
/* end of include file */
|
