summaryrefslogtreecommitdiffstats
path: root/cpukit/score/inline/rtems/score/address.inl
blob: f1a0dd6cc7b930ce3fb824b4b0ebf74309799a7a (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
/** 
 *  @file  rtems/score/address.inl
 *
 *  This include file contains the bodies of the routines
 *  about addresses which are inlined.
 */

/*
 *  COPYRIGHT (c) 1989-2006.
 *  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.com/license/LICENSE.
 *
 *  $Id$
 */

#ifndef _RTEMS_SCORE_ADDRESS_H
# error "Never use <rtems/score/address.inl> directly; include <rtems/score/address.h> instead."
#endif

#ifndef _RTEMS_SCORE_ADDRESS_INL
#define _RTEMS_SCORE_ADDRESS_INL

/**
 *  @addtogroup ScoreAddress 
 *  @{
 */

/** @brief Add Offset to 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[in] base is the base address.
 *  @param[in] offset is the offset to add to @a base.
 *
 *  @return This method returns the resulting address.
 */
RTEMS_INLINE_ROUTINE void *_Addresses_Add_offset (
  void       *base,
  uint32_t    offset
)
{
  return (void *)((char *)base + offset);
}

/** @brief Subtract Offset from Offset
 *
 *  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[in] base is the base address.
 *  @param[in] offset is the offset to subtract to @a base.
 *
 *  @return This method returns the resulting address.
 */

RTEMS_INLINE_ROUTINE void *_Addresses_Subtract_offset (
  void       *base,
  uint32_t    offset
)
{
  return (void *)((char *)base - offset);
}

/** @brief Subtract Two Offsets
 *
 *  This function is used to subtract two addresses.  It returns the
 *  resulting offset.
 *
 *  @param[in] left is the address on the left hand side of the subtraction.
 *  @param[in] right is the address on the right hand side of the subtraction.
 *
 *  @return This method returns the resulting address.
 *
 *  @note  The cast of an address to an uint32_t makes this code
 *         dependent on an addresses being thirty two bits.
 */
RTEMS_INLINE_ROUTINE uint32_t   _Addresses_Subtract (
  void *left,
  void *right
)
{
  return ((char *) left - (char *) right);
}

/** @brief Is Address 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[in] address is the address being checked for alignment.
 *
 *  @return This method returns TRUE if the address is aligned and
 *          FALSE otherwise.
 */
RTEMS_INLINE_ROUTINE boolean _Addresses_Is_aligned (
  void *address
)
{
#if (CPU_ALIGNMENT == 0)
    return TRUE;
#else
    return (((uintptr_t)address % CPU_ALIGNMENT) == 0);
#endif
}

/** @brief Is Address In Range
 *
 *  This function returns TRUE if the given address is within the
 *  memory range specified and FALSE otherwise.  base is the address
 *  of the first byte in the memory range and 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[in] address is the address to check.
 *  @param[in] base is the lowest address of the range to check against.
 *  @param[in] limit is the highest address of the range to check against.
 *
 *  @return This method returns TRUE if the given @a address is within the
 *  memory range specified and FALSE otherwise.
 */
RTEMS_INLINE_ROUTINE boolean _Addresses_Is_in_range (
  void *address,
  void *base,
  void *limit
)
{
  return (address >= base && address <= limit);
}

/**@}*/

#endif
/* end of include file */