diff options
Diffstat (limited to '')
| -rw-r--r-- | c/src/exec/score/inline/rtems/score/address.inl | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/c/src/exec/score/inline/rtems/score/address.inl b/c/src/exec/score/inline/rtems/score/address.inl index c1bb098577..343123c981 100644 --- a/c/src/exec/score/inline/rtems/score/address.inl +++ b/c/src/exec/score/inline/rtems/score/address.inl @@ -21,6 +21,11 @@ * * _Addresses_Add_offset * + * DESCRIPTION: + * + * This function is used to add an offset to a base address. + * It returns the resulting address. This address is typically + * converted to an access type before being used further. */ STATIC INLINE void *_Addresses_Add_offset ( @@ -35,6 +40,11 @@ STATIC INLINE void *_Addresses_Add_offset ( * * _Addresses_Subtract_offset * + * DESCRIPTION: + * + * This function is used to subtract an offset from a base + * address. It returns the resulting address. This address is + * typically converted to an access type before being used further. */ STATIC INLINE void *_Addresses_Subtract_offset ( @@ -49,6 +59,11 @@ STATIC INLINE void *_Addresses_Subtract_offset ( * * _Addresses_Subtract * + * DESCRIPTION: + * + * This function is used to subtract two addresses. It returns the + * resulting offset. + * * NOTE: The cast of an address to an unsigned32 makes this code * dependent on an addresses being thirty two bits. */ @@ -65,6 +80,11 @@ STATIC INLINE unsigned32 _Addresses_Subtract ( * * _Addresses_Is_aligned * + * DESCRIPTION: + * + * 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. */ STATIC INLINE boolean _Addresses_Is_aligned ( @@ -78,6 +98,13 @@ STATIC INLINE boolean _Addresses_Is_aligned ( * * _Addresses_Is_in_range * + * DESCRIPTION: + * + * 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. */ STATIC INLINE boolean _Addresses_Is_in_range ( |