1 | /* address.h |
---|
2 | * |
---|
3 | * This include file contains the information required to manipulate |
---|
4 | * physical addresses. |
---|
5 | * |
---|
6 | * COPYRIGHT (c) 1989, 1990, 1991, 1992, 1993, 1994. |
---|
7 | * On-Line Applications Research Corporation (OAR). |
---|
8 | * All rights assigned to U.S. Government, 1994. |
---|
9 | * |
---|
10 | * This material may be reproduced by or for the U.S. Government pursuant |
---|
11 | * to the copyright license under the clause at DFARS 252.227-7013. This |
---|
12 | * notice must appear in all copies of this file and its derivatives. |
---|
13 | * |
---|
14 | * $Id$ |
---|
15 | */ |
---|
16 | |
---|
17 | #ifndef __RTEMS_ADDRESSES_h |
---|
18 | #define __RTEMS_ADDRESSES_h |
---|
19 | |
---|
20 | #ifdef __cplusplus |
---|
21 | extern "C" { |
---|
22 | #endif |
---|
23 | |
---|
24 | /* |
---|
25 | * _Addresses_Add_offset |
---|
26 | * |
---|
27 | * DESCRIPTION: |
---|
28 | * |
---|
29 | * This function is used to add an offset to a base address. |
---|
30 | * It returns the resulting address. This address is typically |
---|
31 | * converted to an access type before being used further. |
---|
32 | */ |
---|
33 | |
---|
34 | STATIC INLINE void *_Addresses_Add_offset ( |
---|
35 | void *base, |
---|
36 | unsigned32 offset |
---|
37 | ); |
---|
38 | |
---|
39 | /* |
---|
40 | * _Addresses_Subtract_offset |
---|
41 | * |
---|
42 | * DESCRIPTION: |
---|
43 | * |
---|
44 | * This function is used to subtract an offset from a base |
---|
45 | * address. It returns the resulting address. This address is |
---|
46 | * typically converted to an access type before being used further. |
---|
47 | */ |
---|
48 | |
---|
49 | STATIC INLINE void *_Addresses_Subtract_offset( |
---|
50 | void *base, |
---|
51 | unsigned32 offset |
---|
52 | ); |
---|
53 | |
---|
54 | /* |
---|
55 | * _Addresses_Add |
---|
56 | * |
---|
57 | * DESCRIPTION: |
---|
58 | * |
---|
59 | * This function is used to add two addresses. It returns the |
---|
60 | * resulting address. This address is typically converted to an |
---|
61 | * access type before being used further. |
---|
62 | */ |
---|
63 | |
---|
64 | STATIC INLINE void *_Addresses_Add ( |
---|
65 | void *left, |
---|
66 | void *right |
---|
67 | ); |
---|
68 | |
---|
69 | /* |
---|
70 | * _Addresses_Subtract |
---|
71 | * |
---|
72 | * DESCRIPTION: |
---|
73 | * |
---|
74 | * This function is used to subtract two addresses. It returns the |
---|
75 | * resulting offset. |
---|
76 | */ |
---|
77 | |
---|
78 | STATIC INLINE unsigned32 _Addresses_Subtract ( |
---|
79 | void *left, |
---|
80 | void *right |
---|
81 | ); |
---|
82 | |
---|
83 | /* |
---|
84 | * _Addresses_Is_aligned |
---|
85 | * |
---|
86 | * DESCRIPTION: |
---|
87 | * |
---|
88 | * This function returns TRUE if the given address is correctly |
---|
89 | * aligned for this processor and FALSE otherwise. Proper alignment |
---|
90 | * is based on correctness and efficiency. |
---|
91 | */ |
---|
92 | |
---|
93 | STATIC INLINE boolean _Addresses_Is_aligned ( |
---|
94 | void *address |
---|
95 | ); |
---|
96 | |
---|
97 | /* |
---|
98 | * _Addresses_Is_in_range |
---|
99 | * |
---|
100 | * DESCRIPTION: |
---|
101 | * |
---|
102 | * This function returns TRUE if the given address is within the |
---|
103 | * memory range specified and FALSE otherwise. base is the address |
---|
104 | * of the first byte in the memory range and limit is the address |
---|
105 | * of the last byte in the memory range. The base address is |
---|
106 | * assumed to be lower than the limit address. |
---|
107 | */ |
---|
108 | |
---|
109 | STATIC INLINE boolean _Addresses_Is_in_range ( |
---|
110 | void *address, |
---|
111 | void *base, |
---|
112 | void *limit |
---|
113 | ); |
---|
114 | |
---|
115 | #include <rtems/address.inl> |
---|
116 | |
---|
117 | #ifdef __cplusplus |
---|
118 | } |
---|
119 | #endif |
---|
120 | |
---|
121 | #endif |
---|
122 | /* end of include file */ |
---|