Amit Gandhi / sensen_copy_2

t

Fork of mbed-dev by mbed official

targets/TARGET_Atmel/TARGET_SAM_CortexM4/utils/compiler.h@178:c26431f84b0d, 2017-11-09 (annotated)

Committer:
amithy
Date:
Thu Nov 09 22:14:37 2017 +0000
Revision:
178:c26431f84b0d
Parent:
149:156823d33999 
test export

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 107:414e9c822e99 1 /**
mbed_official 107:414e9c822e99 2 * \file
mbed_official 107:414e9c822e99 3 *
mbed_official 107:414e9c822e99 4 * \brief Commonly used includes, types and macros.
mbed_official 107:414e9c822e99 5 *
mbed_official 107:414e9c822e99 6 * Copyright (c) 2010-2015 Atmel Corporation. All rights reserved.
mbed_official 107:414e9c822e99 7 *
mbed_official 107:414e9c822e99 8 * \asf_license_start
mbed_official 107:414e9c822e99 9 *
mbed_official 107:414e9c822e99 10 * \page License
mbed_official 107:414e9c822e99 11 *
mbed_official 107:414e9c822e99 12 * Redistribution and use in source and binary forms, with or without
mbed_official 107:414e9c822e99 13 * modification, are permitted provided that the following conditions are met:
mbed_official 107:414e9c822e99 14 *
mbed_official 107:414e9c822e99 15 * 1. Redistributions of source code must retain the above copyright notice,
mbed_official 107:414e9c822e99 16 * this list of conditions and the following disclaimer.
mbed_official 107:414e9c822e99 17 *
mbed_official 107:414e9c822e99 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
mbed_official 107:414e9c822e99 19 * this list of conditions and the following disclaimer in the documentation
mbed_official 107:414e9c822e99 20 * and/or other materials provided with the distribution.
mbed_official 107:414e9c822e99 21 *
mbed_official 107:414e9c822e99 22 * 3. The name of Atmel may not be used to endorse or promote products derived
mbed_official 107:414e9c822e99 23 * from this software without specific prior written permission.
mbed_official 107:414e9c822e99 24 *
mbed_official 107:414e9c822e99 25 * 4. This software may only be redistributed and used in connection with an
mbed_official 107:414e9c822e99 26 * Atmel microcontroller product.
mbed_official 107:414e9c822e99 27 *
mbed_official 107:414e9c822e99 28 * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
mbed_official 107:414e9c822e99 29 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
mbed_official 107:414e9c822e99 30 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
mbed_official 107:414e9c822e99 31 * EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR
mbed_official 107:414e9c822e99 32 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
mbed_official 107:414e9c822e99 33 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
mbed_official 107:414e9c822e99 34 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
mbed_official 107:414e9c822e99 35 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
mbed_official 107:414e9c822e99 36 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
mbed_official 107:414e9c822e99 37 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
mbed_official 107:414e9c822e99 38 * POSSIBILITY OF SUCH DAMAGE.
mbed_official 107:414e9c822e99 39 *
mbed_official 107:414e9c822e99 40 * \asf_license_stop
mbed_official 107:414e9c822e99 41 *
mbed_official 107:414e9c822e99 42 */
mbed_official 107:414e9c822e99 43 /*
mbed_official 107:414e9c822e99 44 * Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel Support</a>
mbed_official 107:414e9c822e99 45 */
mbed_official 107:414e9c822e99 46
mbed_official 107:414e9c822e99 47 #ifndef UTILS_COMPILER_H
mbed_official 107:414e9c822e99 48 #define UTILS_COMPILER_H
mbed_official 107:414e9c822e99 49
mbed_official 107:414e9c822e99 50 /**
mbed_official 107:414e9c822e99 51 * \defgroup group_sam_utils Compiler abstraction layer and code utilities
mbed_official 107:414e9c822e99 52 *
mbed_official 107:414e9c822e99 53 * Compiler abstraction layer and code utilities for AT91SAM.
mbed_official 107:414e9c822e99 54 * This module provides various abstraction layers and utilities to make code compatible between different compilers.
mbed_official 107:414e9c822e99 55 *
mbed_official 107:414e9c822e99 56 * \{
mbed_official 107:414e9c822e99 57 */
mbed_official 107:414e9c822e99 58 #include <stddef.h>
mbed_official 107:414e9c822e99 59
mbed_official 107:414e9c822e99 60 #if (defined __ICCARM__)
mbed_official 107:414e9c822e99 61 # include <intrinsics.h>
mbed_official 107:414e9c822e99 62 #endif
mbed_official 107:414e9c822e99 63
mbed_official 107:414e9c822e99 64 #include <parts.h>
mbed_official 107:414e9c822e99 65 #include "preprocessor.h"
mbed_official 107:414e9c822e99 66
mbed_official 107:414e9c822e99 67 #include <io.h>
mbed_official 107:414e9c822e99 68
mbed_official 107:414e9c822e99 69 //_____ D E C L A R A T I O N S ____________________________________________
mbed_official 107:414e9c822e99 70
mbed_official 107:414e9c822e99 71 #ifndef __ASSEMBLY__ // Not defined for assembling.
mbed_official 107:414e9c822e99 72
mbed_official 107:414e9c822e99 73 #include <stdio.h>
mbed_official 107:414e9c822e99 74 #include <stdbool.h>
mbed_official 107:414e9c822e99 75 #include <stdint.h>
mbed_official 107:414e9c822e99 76 #include <stdlib.h>
mbed_official 107:414e9c822e99 77
mbed_official 107:414e9c822e99 78 #ifdef __ICCARM__
mbed_official 107:414e9c822e99 79 /*! \name Compiler Keywords
mbed_official 107:414e9c822e99 80 *
mbed_official 107:414e9c822e99 81 * Port of some keywords from GCC to IAR Embedded Workbench.
mbed_official 107:414e9c822e99 82 */
mbed_official 107:414e9c822e99 83 //! @{
mbed_official 107:414e9c822e99 84 #define __asm__ asm
mbed_official 107:414e9c822e99 85 #define __inline__ inline
mbed_official 107:414e9c822e99 86 #define __volatile__
mbed_official 107:414e9c822e99 87 //! @}
mbed_official 107:414e9c822e99 88
mbed_official 107:414e9c822e99 89 #endif
mbed_official 107:414e9c822e99 90
mbed_official 107:414e9c822e99 91 #define FUNC_PTR void *
mbed_official 107:414e9c822e99 92 /**
mbed_official 107:414e9c822e99 93 * \def UNUSED
mbed_official 107:414e9c822e99 94 * \brief Marking \a v as a unused parameter or value.
mbed_official 107:414e9c822e99 95 */
mbed_official 107:414e9c822e99 96 #define UNUSED(v) (void)(v)
mbed_official 107:414e9c822e99 97
mbed_official 107:414e9c822e99 98 /**
mbed_official 107:414e9c822e99 99 * \def unused
mbed_official 107:414e9c822e99 100 * \brief Marking \a v as a unused parameter or value.
mbed_official 107:414e9c822e99 101 */
mbed_official 107:414e9c822e99 102 #define unused(v) do { (void)(v); } while(0)
mbed_official 107:414e9c822e99 103
mbed_official 107:414e9c822e99 104 /**
mbed_official 107:414e9c822e99 105 * \def barrier
mbed_official 107:414e9c822e99 106 * \brief Memory barrier
mbed_official 107:414e9c822e99 107 */
mbed_official 107:414e9c822e99 108 #define barrier() __DMB()
mbed_official 107:414e9c822e99 109
mbed_official 107:414e9c822e99 110 /**
mbed_official 107:414e9c822e99 111 * \brief Emit the compiler pragma \a arg.
mbed_official 107:414e9c822e99 112 *
mbed_official 107:414e9c822e99 113 * \param arg The pragma directive as it would appear after \e \#pragma
mbed_official 107:414e9c822e99 114 * (i.e. not stringified).
mbed_official 107:414e9c822e99 115 */
mbed_official 107:414e9c822e99 116 #define COMPILER_PRAGMA(arg) _Pragma(#arg)
mbed_official 107:414e9c822e99 117
mbed_official 107:414e9c822e99 118 /**
mbed_official 107:414e9c822e99 119 * \def COMPILER_PACK_SET(alignment)
mbed_official 107:414e9c822e99 120 * \brief Set maximum alignment for subsequent struct and union
mbed_official 107:414e9c822e99 121 * definitions to \a alignment.
mbed_official 107:414e9c822e99 122 */
mbed_official 107:414e9c822e99 123 #define COMPILER_PACK_SET(alignment) COMPILER_PRAGMA(pack(alignment))
mbed_official 107:414e9c822e99 124
mbed_official 107:414e9c822e99 125 /**
mbed_official 107:414e9c822e99 126 * \def COMPILER_PACK_RESET()
mbed_official 107:414e9c822e99 127 * \brief Set default alignment for subsequent struct and union
mbed_official 107:414e9c822e99 128 * definitions.
mbed_official 107:414e9c822e99 129 */
mbed_official 107:414e9c822e99 130 #define COMPILER_PACK_RESET() COMPILER_PRAGMA(pack())
mbed_official 107:414e9c822e99 131
mbed_official 107:414e9c822e99 132
mbed_official 107:414e9c822e99 133 /**
mbed_official 107:414e9c822e99 134 * \brief Set aligned boundary.
mbed_official 107:414e9c822e99 135 */
mbed_official 107:414e9c822e99 136 #if (defined __GNUC__) || (defined __CC_ARM)
mbed_official 107:414e9c822e99 137 # define COMPILER_ALIGNED(a) __attribute__((__aligned__(a)))
mbed_official 107:414e9c822e99 138 #elif (defined __ICCARM__)
mbed_official 107:414e9c822e99 139 # define COMPILER_ALIGNED(a) COMPILER_PRAGMA(data_alignment = a)
mbed_official 107:414e9c822e99 140 #endif
mbed_official 107:414e9c822e99 141
mbed_official 107:414e9c822e99 142 /**
mbed_official 107:414e9c822e99 143 * \brief Set word-aligned boundary.
mbed_official 107:414e9c822e99 144 */
mbed_official 107:414e9c822e99 145 #if (defined __GNUC__) || defined(__CC_ARM)
mbed_official 107:414e9c822e99 146 #define COMPILER_WORD_ALIGNED __attribute__((__aligned__(4)))
mbed_official 107:414e9c822e99 147 #elif (defined __ICCARM__)
mbed_official 107:414e9c822e99 148 #define COMPILER_WORD_ALIGNED COMPILER_PRAGMA(data_alignment = 4)
mbed_official 107:414e9c822e99 149 #endif
mbed_official 107:414e9c822e99 150
mbed_official 107:414e9c822e99 151 /**
mbed_official 107:414e9c822e99 152 * \def __always_inline
mbed_official 107:414e9c822e99 153 * \brief The function should always be inlined.
mbed_official 107:414e9c822e99 154 *
mbed_official 107:414e9c822e99 155 * This annotation instructs the compiler to ignore its inlining
mbed_official 107:414e9c822e99 156 * heuristics and inline the function no matter how big it thinks it
mbed_official 107:414e9c822e99 157 * becomes.
mbed_official 107:414e9c822e99 158 */
mbed_official 107:414e9c822e99 159 #if defined(__CC_ARM)
mbed_official 107:414e9c822e99 160 # define __always_inline __forceinline
mbed_official 107:414e9c822e99 161 #elif (defined __GNUC__)
mbed_official 107:414e9c822e99 162 # define __always_inline inline __attribute__((__always_inline__))
mbed_official 107:414e9c822e99 163 #elif (defined __ICCARM__)
mbed_official 107:414e9c822e99 164 # define __always_inline _Pragma("inline=forced")
mbed_official 107:414e9c822e99 165 #endif
mbed_official 107:414e9c822e99 166
mbed_official 107:414e9c822e99 167 /**
mbed_official 107:414e9c822e99 168 * \def __no_inline
mbed_official 107:414e9c822e99 169 * \brief The function should not be inlined.
mbed_official 107:414e9c822e99 170 *
mbed_official 107:414e9c822e99 171 * This annotation instructs the compiler to ignore its inlining
mbed_official 107:414e9c822e99 172 * heuristics and not inline the function.
mbed_official 107:414e9c822e99 173 */
mbed_official 107:414e9c822e99 174 #if defined(__CC_ARM)
mbed_official 107:414e9c822e99 175 # define __no_inline __attribute__((noinline))
mbed_official 107:414e9c822e99 176 #elif (defined __GNUC__)
mbed_official 107:414e9c822e99 177 # define __no_inline __attribute__((__noinline__))
mbed_official 107:414e9c822e99 178 #elif (defined __ICCARM__)
mbed_official 107:414e9c822e99 179 # define __no_inline _Pragma("inline=never")
mbed_official 107:414e9c822e99 180 #endif
mbed_official 107:414e9c822e99 181
mbed_official 107:414e9c822e99 182 /*! \brief This macro is used to test fatal errors.
mbed_official 107:414e9c822e99 183 *
mbed_official 107:414e9c822e99 184 * The macro tests if the expression is false. If it is, a fatal error is
mbed_official 107:414e9c822e99 185 * detected and the application hangs up. If TEST_SUITE_DEFINE_ASSERT_MACRO
mbed_official 107:414e9c822e99 186 * is defined, a unit test version of the macro is used, to allow execution
mbed_official 107:414e9c822e99 187 * of further tests after a false expression.
mbed_official 107:414e9c822e99 188 *
mbed_official 107:414e9c822e99 189 * \param expr Expression to evaluate and supposed to be nonzero.
mbed_official 107:414e9c822e99 190 */
mbed_official 107:414e9c822e99 191 #if defined(_ASSERT_ENABLE_)
mbed_official 107:414e9c822e99 192 # if defined(TEST_SUITE_DEFINE_ASSERT_MACRO)
mbed_official 107:414e9c822e99 193 // Assert() is defined in unit_test/suite.h
mbed_official 107:414e9c822e99 194 # include "unit_test/suite.h"
mbed_official 107:414e9c822e99 195 # else
mbed_official 107:414e9c822e99 196 #undef TEST_SUITE_DEFINE_ASSERT_MACRO
mbed_official 107:414e9c822e99 197 # define Assert(expr) \
mbed_official 107:414e9c822e99 198 {\
mbed_official 107:414e9c822e99 199 if (!(expr)) while (true);\
mbed_official 107:414e9c822e99 200 }
mbed_official 107:414e9c822e99 201 # endif
mbed_official 107:414e9c822e99 202 #else
mbed_official 107:414e9c822e99 203 # define Assert(expr) ((void) 0)
mbed_official 107:414e9c822e99 204 #endif
mbed_official 107:414e9c822e99 205
mbed_official 107:414e9c822e99 206 /* Define WEAK attribute */
mbed_official 107:414e9c822e99 207 #if defined ( __CC_ARM ) /* Keil µVision 4 */
mbed_official 107:414e9c822e99 208 # define WEAK __attribute__ ((weak))
mbed_official 107:414e9c822e99 209 #elif defined ( __ICCARM__ ) /* IAR Ewarm 5.41+ */
mbed_official 107:414e9c822e99 210 # define WEAK __weak
mbed_official 107:414e9c822e99 211 #elif defined ( __GNUC__ ) /* GCC CS3 2009q3-68 */
mbed_official 107:414e9c822e99 212 # define WEAK __attribute__ ((weak))
mbed_official 107:414e9c822e99 213 #endif
mbed_official 107:414e9c822e99 214
mbed_official 107:414e9c822e99 215 /* Define NO_INIT attribute */
mbed_official 107:414e9c822e99 216 #if defined ( __CC_ARM )
mbed_official 107:414e9c822e99 217 # define NO_INIT __attribute__((zero_init))
mbed_official 107:414e9c822e99 218 #elif defined ( __ICCARM__ )
mbed_official 107:414e9c822e99 219 # define NO_INIT __no_init
mbed_official 107:414e9c822e99 220 #elif defined ( __GNUC__ )
mbed_official 107:414e9c822e99 221 # define NO_INIT __attribute__((section(".no_init")))
mbed_official 107:414e9c822e99 222 #endif
mbed_official 107:414e9c822e99 223
mbed_official 107:414e9c822e99 224 /* Define RAMFUNC attribute */
mbed_official 107:414e9c822e99 225 #if defined ( __CC_ARM ) /* Keil µVision 4 */
mbed_official 107:414e9c822e99 226 # define RAMFUNC __attribute__ ((section(".ramfunc")))
mbed_official 107:414e9c822e99 227 #elif defined ( __ICCARM__ ) /* IAR Ewarm 5.41+ */
mbed_official 107:414e9c822e99 228 # define RAMFUNC __ramfunc
mbed_official 107:414e9c822e99 229 #elif defined ( __GNUC__ ) /* GCC CS3 2009q3-68 */
mbed_official 107:414e9c822e99 230 # define RAMFUNC __attribute__ ((section(".ramfunc")))
mbed_official 107:414e9c822e99 231 #endif
mbed_official 107:414e9c822e99 232
mbed_official 107:414e9c822e99 233 /* Define OPTIMIZE_HIGH attribute */
mbed_official 107:414e9c822e99 234 #if defined ( __CC_ARM ) /* Keil µVision 4 */
mbed_official 107:414e9c822e99 235 # define OPTIMIZE_HIGH _Pragma("O3")
mbed_official 107:414e9c822e99 236 #elif defined ( __ICCARM__ ) /* IAR Ewarm 5.41+ */
mbed_official 107:414e9c822e99 237 # define OPTIMIZE_HIGH _Pragma("optimize=high")
mbed_official 107:414e9c822e99 238 #elif defined ( __GNUC__ ) /* GCC CS3 2009q3-68 */
mbed_official 107:414e9c822e99 239 # define OPTIMIZE_HIGH __attribute__((optimize(s)))
mbed_official 107:414e9c822e99 240 #endif
mbed_official 107:414e9c822e99 241
mbed_official 107:414e9c822e99 242 #include "interrupt.h"
mbed_official 107:414e9c822e99 243
mbed_official 107:414e9c822e99 244 /*! \name Usual Types
mbed_official 107:414e9c822e99 245 */
mbed_official 107:414e9c822e99 246 //! @{
mbed_official 107:414e9c822e99 247 typedef unsigned char Bool; //!< Boolean.
mbed_official 107:414e9c822e99 248 #ifndef __cplusplus
mbed_official 107:414e9c822e99 249 #if !defined(__bool_true_false_are_defined)
mbed_official 107:414e9c822e99 250 typedef unsigned char bool; //!< Boolean.
mbed_official 107:414e9c822e99 251 #endif
mbed_official 107:414e9c822e99 252 #endif
mbed_official 107:414e9c822e99 253 typedef int8_t S8 ; //!< 8-bit signed integer.
mbed_official 107:414e9c822e99 254 typedef uint8_t U8 ; //!< 8-bit unsigned integer.
mbed_official 107:414e9c822e99 255 typedef int16_t S16; //!< 16-bit signed integer.
mbed_official 107:414e9c822e99 256 typedef uint16_t U16; //!< 16-bit unsigned integer.
mbed_official 107:414e9c822e99 257 typedef uint16_t le16_t;
mbed_official 107:414e9c822e99 258 typedef uint16_t be16_t;
mbed_official 107:414e9c822e99 259 typedef int32_t S32; //!< 32-bit signed integer.
mbed_official 107:414e9c822e99 260 typedef uint32_t U32; //!< 32-bit unsigned integer.
mbed_official 107:414e9c822e99 261 typedef uint32_t le32_t;
mbed_official 107:414e9c822e99 262 typedef uint32_t be32_t;
mbed_official 107:414e9c822e99 263 typedef int64_t S64; //!< 64-bit signed integer.
mbed_official 107:414e9c822e99 264 typedef uint64_t U64; //!< 64-bit unsigned integer.
mbed_official 107:414e9c822e99 265 typedef float F32; //!< 32-bit floating-point number.
mbed_official 107:414e9c822e99 266 typedef double F64; //!< 64-bit floating-point number.
mbed_official 107:414e9c822e99 267 typedef uint32_t iram_size_t;
mbed_official 107:414e9c822e99 268 //! @}
mbed_official 107:414e9c822e99 269
mbed_official 107:414e9c822e99 270
mbed_official 107:414e9c822e99 271 /*! \name Status Types
mbed_official 107:414e9c822e99 272 */
mbed_official 107:414e9c822e99 273 //! @{
mbed_official 107:414e9c822e99 274 typedef bool Status_bool_t; //!< Boolean status.
mbed_official 107:414e9c822e99 275 typedef U8 Status_t; //!< 8-bit-coded status.
mbed_official 107:414e9c822e99 276 //! @}
mbed_official 107:414e9c822e99 277
mbed_official 107:414e9c822e99 278
mbed_official 107:414e9c822e99 279 /*! \name Aliasing Aggregate Types
mbed_official 107:414e9c822e99 280 */
mbed_official 107:414e9c822e99 281 //! @{
mbed_official 107:414e9c822e99 282
mbed_official 107:414e9c822e99 283 //! 16-bit union.
mbed_official 107:414e9c822e99 284 typedef union {
mbed_official 107:414e9c822e99 285 S16 s16 ;
mbed_official 107:414e9c822e99 286 U16 u16 ;
mbed_official 107:414e9c822e99 287 S8 s8 [2];
mbed_official 107:414e9c822e99 288 U8 u8 [2];
mbed_official 107:414e9c822e99 289 } Union16;
mbed_official 107:414e9c822e99 290
mbed_official 107:414e9c822e99 291 //! 32-bit union.
mbed_official 107:414e9c822e99 292 typedef union {
mbed_official 107:414e9c822e99 293 S32 s32 ;
mbed_official 107:414e9c822e99 294 U32 u32 ;
mbed_official 107:414e9c822e99 295 S16 s16[2];
mbed_official 107:414e9c822e99 296 U16 u16[2];
mbed_official 107:414e9c822e99 297 S8 s8 [4];
mbed_official 107:414e9c822e99 298 U8 u8 [4];
mbed_official 107:414e9c822e99 299 } Union32;
mbed_official 107:414e9c822e99 300
mbed_official 107:414e9c822e99 301 //! 64-bit union.
mbed_official 107:414e9c822e99 302 typedef union {
mbed_official 107:414e9c822e99 303 S64 s64 ;
mbed_official 107:414e9c822e99 304 U64 u64 ;
mbed_official 107:414e9c822e99 305 S32 s32[2];
mbed_official 107:414e9c822e99 306 U32 u32[2];
mbed_official 107:414e9c822e99 307 S16 s16[4];
mbed_official 107:414e9c822e99 308 U16 u16[4];
mbed_official 107:414e9c822e99 309 S8 s8 [8];
mbed_official 107:414e9c822e99 310 U8 u8 [8];
mbed_official 107:414e9c822e99 311 } Union64;
mbed_official 107:414e9c822e99 312
mbed_official 107:414e9c822e99 313 //! Union of pointers to 64-, 32-, 16- and 8-bit unsigned integers.
mbed_official 107:414e9c822e99 314 typedef union {
mbed_official 107:414e9c822e99 315 S64 *s64ptr;
mbed_official 107:414e9c822e99 316 U64 *u64ptr;
mbed_official 107:414e9c822e99 317 S32 *s32ptr;
mbed_official 107:414e9c822e99 318 U32 *u32ptr;
mbed_official 107:414e9c822e99 319 S16 *s16ptr;
mbed_official 107:414e9c822e99 320 U16 *u16ptr;
mbed_official 107:414e9c822e99 321 S8 *s8ptr ;
mbed_official 107:414e9c822e99 322 U8 *u8ptr ;
mbed_official 107:414e9c822e99 323 } UnionPtr;
mbed_official 107:414e9c822e99 324
mbed_official 107:414e9c822e99 325 //! Union of pointers to volatile 64-, 32-, 16- and 8-bit unsigned integers.
mbed_official 107:414e9c822e99 326 typedef union {
mbed_official 107:414e9c822e99 327 volatile S64 *s64ptr;
mbed_official 107:414e9c822e99 328 volatile U64 *u64ptr;
mbed_official 107:414e9c822e99 329 volatile S32 *s32ptr;
mbed_official 107:414e9c822e99 330 volatile U32 *u32ptr;
mbed_official 107:414e9c822e99 331 volatile S16 *s16ptr;
mbed_official 107:414e9c822e99 332 volatile U16 *u16ptr;
mbed_official 107:414e9c822e99 333 volatile S8 *s8ptr ;
mbed_official 107:414e9c822e99 334 volatile U8 *u8ptr ;
mbed_official 107:414e9c822e99 335 } UnionVPtr;
mbed_official 107:414e9c822e99 336
mbed_official 107:414e9c822e99 337 //! Union of pointers to constant 64-, 32-, 16- and 8-bit unsigned integers.
mbed_official 107:414e9c822e99 338 typedef union {
mbed_official 107:414e9c822e99 339 const S64 *s64ptr;
mbed_official 107:414e9c822e99 340 const U64 *u64ptr;
mbed_official 107:414e9c822e99 341 const S32 *s32ptr;
mbed_official 107:414e9c822e99 342 const U32 *u32ptr;
mbed_official 107:414e9c822e99 343 const S16 *s16ptr;
mbed_official 107:414e9c822e99 344 const U16 *u16ptr;
mbed_official 107:414e9c822e99 345 const S8 *s8ptr ;
mbed_official 107:414e9c822e99 346 const U8 *u8ptr ;
mbed_official 107:414e9c822e99 347 } UnionCPtr;
mbed_official 107:414e9c822e99 348
mbed_official 107:414e9c822e99 349 //! Union of pointers to constant volatile 64-, 32-, 16- and 8-bit unsigned integers.
mbed_official 107:414e9c822e99 350 typedef union {
mbed_official 107:414e9c822e99 351 const volatile S64 *s64ptr;
mbed_official 107:414e9c822e99 352 const volatile U64 *u64ptr;
mbed_official 107:414e9c822e99 353 const volatile S32 *s32ptr;
mbed_official 107:414e9c822e99 354 const volatile U32 *u32ptr;
mbed_official 107:414e9c822e99 355 const volatile S16 *s16ptr;
mbed_official 107:414e9c822e99 356 const volatile U16 *u16ptr;
mbed_official 107:414e9c822e99 357 const volatile S8 *s8ptr ;
mbed_official 107:414e9c822e99 358 const volatile U8 *u8ptr ;
mbed_official 107:414e9c822e99 359 } UnionCVPtr;
mbed_official 107:414e9c822e99 360
mbed_official 107:414e9c822e99 361 //! Structure of pointers to 64-, 32-, 16- and 8-bit unsigned integers.
mbed_official 107:414e9c822e99 362 typedef struct {
mbed_official 107:414e9c822e99 363 S64 *s64ptr;
mbed_official 107:414e9c822e99 364 U64 *u64ptr;
mbed_official 107:414e9c822e99 365 S32 *s32ptr;
mbed_official 107:414e9c822e99 366 U32 *u32ptr;
mbed_official 107:414e9c822e99 367 S16 *s16ptr;
mbed_official 107:414e9c822e99 368 U16 *u16ptr;
mbed_official 107:414e9c822e99 369 S8 *s8ptr ;
mbed_official 107:414e9c822e99 370 U8 *u8ptr ;
mbed_official 107:414e9c822e99 371 } StructPtr;
mbed_official 107:414e9c822e99 372
mbed_official 107:414e9c822e99 373 //! Structure of pointers to volatile 64-, 32-, 16- and 8-bit unsigned integers.
mbed_official 107:414e9c822e99 374 typedef struct {
mbed_official 107:414e9c822e99 375 volatile S64 *s64ptr;
mbed_official 107:414e9c822e99 376 volatile U64 *u64ptr;
mbed_official 107:414e9c822e99 377 volatile S32 *s32ptr;
mbed_official 107:414e9c822e99 378 volatile U32 *u32ptr;
mbed_official 107:414e9c822e99 379 volatile S16 *s16ptr;
mbed_official 107:414e9c822e99 380 volatile U16 *u16ptr;
mbed_official 107:414e9c822e99 381 volatile S8 *s8ptr ;
mbed_official 107:414e9c822e99 382 volatile U8 *u8ptr ;
mbed_official 107:414e9c822e99 383 } StructVPtr;
mbed_official 107:414e9c822e99 384
mbed_official 107:414e9c822e99 385 //! Structure of pointers to constant 64-, 32-, 16- and 8-bit unsigned integers.
mbed_official 107:414e9c822e99 386 typedef struct {
mbed_official 107:414e9c822e99 387 const S64 *s64ptr;
mbed_official 107:414e9c822e99 388 const U64 *u64ptr;
mbed_official 107:414e9c822e99 389 const S32 *s32ptr;
mbed_official 107:414e9c822e99 390 const U32 *u32ptr;
mbed_official 107:414e9c822e99 391 const S16 *s16ptr;
mbed_official 107:414e9c822e99 392 const U16 *u16ptr;
mbed_official 107:414e9c822e99 393 const S8 *s8ptr ;
mbed_official 107:414e9c822e99 394 const U8 *u8ptr ;
mbed_official 107:414e9c822e99 395 } StructCPtr;
mbed_official 107:414e9c822e99 396
mbed_official 107:414e9c822e99 397 //! Structure of pointers to constant volatile 64-, 32-, 16- and 8-bit unsigned integers.
mbed_official 107:414e9c822e99 398 typedef struct {
mbed_official 107:414e9c822e99 399 const volatile S64 *s64ptr;
mbed_official 107:414e9c822e99 400 const volatile U64 *u64ptr;
mbed_official 107:414e9c822e99 401 const volatile S32 *s32ptr;
mbed_official 107:414e9c822e99 402 const volatile U32 *u32ptr;
mbed_official 107:414e9c822e99 403 const volatile S16 *s16ptr;
mbed_official 107:414e9c822e99 404 const volatile U16 *u16ptr;
mbed_official 107:414e9c822e99 405 const volatile S8 *s8ptr ;
mbed_official 107:414e9c822e99 406 const volatile U8 *u8ptr ;
mbed_official 107:414e9c822e99 407 } StructCVPtr;
mbed_official 107:414e9c822e99 408
mbed_official 107:414e9c822e99 409 //! @}
mbed_official 107:414e9c822e99 410
mbed_official 107:414e9c822e99 411 #endif // #ifndef __ASSEMBLY__
mbed_official 107:414e9c822e99 412
mbed_official 107:414e9c822e99 413 /*! \name Usual Constants
mbed_official 107:414e9c822e99 414 */
mbed_official 107:414e9c822e99 415 //! @{
mbed_official 107:414e9c822e99 416 #define DISABLE 0
mbed_official 107:414e9c822e99 417 #define ENABLE 1
mbed_official 107:414e9c822e99 418 #ifndef __cplusplus
mbed_official 107:414e9c822e99 419 #if !defined(__bool_true_false_are_defined)
mbed_official 107:414e9c822e99 420 #define false 0
mbed_official 107:414e9c822e99 421 #define true 1
mbed_official 107:414e9c822e99 422 #endif
mbed_official 107:414e9c822e99 423 #endif
mbed_official 107:414e9c822e99 424 #define PASS 0
mbed_official 107:414e9c822e99 425 #define FAIL 1
mbed_official 107:414e9c822e99 426 #define LOW 0
mbed_official 107:414e9c822e99 427 #define HIGH 1
mbed_official 107:414e9c822e99 428 //! @}
mbed_official 107:414e9c822e99 429
mbed_official 107:414e9c822e99 430
mbed_official 107:414e9c822e99 431 #ifndef __ASSEMBLY__ // not for assembling.
mbed_official 107:414e9c822e99 432
mbed_official 107:414e9c822e99 433 //! \name Optimization Control
mbed_official 107:414e9c822e99 434 //@{
mbed_official 107:414e9c822e99 435
mbed_official 107:414e9c822e99 436 /**
mbed_official 107:414e9c822e99 437 * \def likely(exp)
mbed_official 107:414e9c822e99 438 * \brief The expression \a exp is likely to be true
mbed_official 107:414e9c822e99 439 */
mbed_official 107:414e9c822e99 440 #ifndef likely
mbed_official 107:414e9c822e99 441 # define likely(exp) (exp)
mbed_official 107:414e9c822e99 442 #endif
mbed_official 107:414e9c822e99 443
mbed_official 107:414e9c822e99 444 /**
mbed_official 107:414e9c822e99 445 * \def unlikely(exp)
mbed_official 107:414e9c822e99 446 * \brief The expression \a exp is unlikely to be true
mbed_official 107:414e9c822e99 447 */
mbed_official 107:414e9c822e99 448 #ifndef unlikely
mbed_official 107:414e9c822e99 449 # define unlikely(exp) (exp)
mbed_official 107:414e9c822e99 450 #endif
mbed_official 107:414e9c822e99 451
mbed_official 107:414e9c822e99 452 /**
mbed_official 107:414e9c822e99 453 * \def is_constant(exp)
mbed_official 107:414e9c822e99 454 * \brief Determine if an expression evaluates to a constant value.
mbed_official 107:414e9c822e99 455 *
mbed_official 107:414e9c822e99 456 * \param exp Any expression
mbed_official 107:414e9c822e99 457 *
mbed_official 107:414e9c822e99 458 * \return true if \a exp is constant, false otherwise.
mbed_official 107:414e9c822e99 459 */
mbed_official 107:414e9c822e99 460 #if (defined __GNUC__) || (defined __CC_ARM)
mbed_official 107:414e9c822e99 461 # define is_constant(exp) __builtin_constant_p(exp)
mbed_official 107:414e9c822e99 462 #else
mbed_official 107:414e9c822e99 463 # define is_constant(exp) (0)
mbed_official 107:414e9c822e99 464 #endif
mbed_official 107:414e9c822e99 465
mbed_official 107:414e9c822e99 466 //! @}
mbed_official 107:414e9c822e99 467
mbed_official 107:414e9c822e99 468 /*! \name Bit-Field Handling
mbed_official 107:414e9c822e99 469 */
mbed_official 107:414e9c822e99 470 //! @{
mbed_official 107:414e9c822e99 471
mbed_official 107:414e9c822e99 472 /*! \brief Reads the bits of a value specified by a given bit-mask.
mbed_official 107:414e9c822e99 473 *
mbed_official 107:414e9c822e99 474 * \param value Value to read bits from.
mbed_official 107:414e9c822e99 475 * \param mask Bit-mask indicating bits to read.
mbed_official 107:414e9c822e99 476 *
mbed_official 107:414e9c822e99 477 * \return Read bits.
mbed_official 107:414e9c822e99 478 */
mbed_official 107:414e9c822e99 479 #define Rd_bits( value, mask) ((value) & (mask))
mbed_official 107:414e9c822e99 480
mbed_official 107:414e9c822e99 481 /*! \brief Writes the bits of a C lvalue specified by a given bit-mask.
mbed_official 107:414e9c822e99 482 *
mbed_official 107:414e9c822e99 483 * \param lvalue C lvalue to write bits to.
mbed_official 107:414e9c822e99 484 * \param mask Bit-mask indicating bits to write.
mbed_official 107:414e9c822e99 485 * \param bits Bits to write.
mbed_official 107:414e9c822e99 486 *
mbed_official 107:414e9c822e99 487 * \return Resulting value with written bits.
mbed_official 107:414e9c822e99 488 */
mbed_official 107:414e9c822e99 489 #define Wr_bits(lvalue, mask, bits) ((lvalue) = ((lvalue) & ~(mask)) |\
mbed_official 107:414e9c822e99 490 ((bits ) & (mask)))
mbed_official 107:414e9c822e99 491
mbed_official 107:414e9c822e99 492 /*! \brief Tests the bits of a value specified by a given bit-mask.
mbed_official 107:414e9c822e99 493 *
mbed_official 107:414e9c822e99 494 * \param value Value of which to test bits.
mbed_official 107:414e9c822e99 495 * \param mask Bit-mask indicating bits to test.
mbed_official 107:414e9c822e99 496 *
mbed_official 107:414e9c822e99 497 * \return \c 1 if at least one of the tested bits is set, else \c 0.
mbed_official 107:414e9c822e99 498 */
mbed_official 107:414e9c822e99 499 #define Tst_bits( value, mask) (Rd_bits(value, mask) != 0)
mbed_official 107:414e9c822e99 500
mbed_official 107:414e9c822e99 501 /*! \brief Clears the bits of a C lvalue specified by a given bit-mask.
mbed_official 107:414e9c822e99 502 *
mbed_official 107:414e9c822e99 503 * \param lvalue C lvalue of which to clear bits.
mbed_official 107:414e9c822e99 504 * \param mask Bit-mask indicating bits to clear.
mbed_official 107:414e9c822e99 505 *
mbed_official 107:414e9c822e99 506 * \return Resulting value with cleared bits.
mbed_official 107:414e9c822e99 507 */
mbed_official 107:414e9c822e99 508 #define Clr_bits(lvalue, mask) ((lvalue) &= ~(mask))
mbed_official 107:414e9c822e99 509
mbed_official 107:414e9c822e99 510 /*! \brief Sets the bits of a C lvalue specified by a given bit-mask.
mbed_official 107:414e9c822e99 511 *
mbed_official 107:414e9c822e99 512 * \param lvalue C lvalue of which to set bits.
mbed_official 107:414e9c822e99 513 * \param mask Bit-mask indicating bits to set.
mbed_official 107:414e9c822e99 514 *
mbed_official 107:414e9c822e99 515 * \return Resulting value with set bits.
mbed_official 107:414e9c822e99 516 */
mbed_official 107:414e9c822e99 517 #define Set_bits(lvalue, mask) ((lvalue) |= (mask))
mbed_official 107:414e9c822e99 518
mbed_official 107:414e9c822e99 519 /*! \brief Toggles the bits of a C lvalue specified by a given bit-mask.
mbed_official 107:414e9c822e99 520 *
mbed_official 107:414e9c822e99 521 * \param lvalue C lvalue of which to toggle bits.
mbed_official 107:414e9c822e99 522 * \param mask Bit-mask indicating bits to toggle.
mbed_official 107:414e9c822e99 523 *
mbed_official 107:414e9c822e99 524 * \return Resulting value with toggled bits.
mbed_official 107:414e9c822e99 525 */
mbed_official 107:414e9c822e99 526 #define Tgl_bits(lvalue, mask) ((lvalue) ^= (mask))
mbed_official 107:414e9c822e99 527
mbed_official 107:414e9c822e99 528 /*! \brief Reads the bit-field of a value specified by a given bit-mask.
mbed_official 107:414e9c822e99 529 *
mbed_official 107:414e9c822e99 530 * \param value Value to read a bit-field from.
mbed_official 107:414e9c822e99 531 * \param mask Bit-mask indicating the bit-field to read.
mbed_official 107:414e9c822e99 532 *
mbed_official 107:414e9c822e99 533 * \return Read bit-field.
mbed_official 107:414e9c822e99 534 */
mbed_official 107:414e9c822e99 535 #define Rd_bitfield( value, mask) (Rd_bits( value, mask) >> ctz(mask))
mbed_official 107:414e9c822e99 536
mbed_official 107:414e9c822e99 537 /*! \brief Writes the bit-field of a C lvalue specified by a given bit-mask.
mbed_official 107:414e9c822e99 538 *
mbed_official 107:414e9c822e99 539 * \param lvalue C lvalue to write a bit-field to.
mbed_official 107:414e9c822e99 540 * \param mask Bit-mask indicating the bit-field to write.
mbed_official 107:414e9c822e99 541 * \param bitfield Bit-field to write.
mbed_official 107:414e9c822e99 542 *
mbed_official 107:414e9c822e99 543 * \return Resulting value with written bit-field.
mbed_official 107:414e9c822e99 544 */
mbed_official 107:414e9c822e99 545 #define Wr_bitfield(lvalue, mask, bitfield) (Wr_bits(lvalue, mask, (U32)(bitfield) << ctz(mask)))
mbed_official 107:414e9c822e99 546
mbed_official 107:414e9c822e99 547 //! @}
mbed_official 107:414e9c822e99 548
mbed_official 107:414e9c822e99 549
mbed_official 107:414e9c822e99 550 /*! \name Zero-Bit Counting
mbed_official 107:414e9c822e99 551 *
mbed_official 107:414e9c822e99 552 * Under GCC, __builtin_clz and __builtin_ctz behave like macros when
mbed_official 107:414e9c822e99 553 * applied to constant expressions (values known at compile time), so they are
mbed_official 107:414e9c822e99 554 * more optimized than the use of the corresponding assembly instructions and
mbed_official 107:414e9c822e99 555 * they can be used as constant expressions e.g. to initialize objects having
mbed_official 107:414e9c822e99 556 * static storage duration, and like the corresponding assembly instructions
mbed_official 107:414e9c822e99 557 * when applied to non-constant expressions (values unknown at compile time), so
mbed_official 107:414e9c822e99 558 * they are more optimized than an assembly periphrasis. Hence, clz and ctz
mbed_official 107:414e9c822e99 559 * ensure a possible and optimized behavior for both constant and non-constant
mbed_official 107:414e9c822e99 560 * expressions.
mbed_official 107:414e9c822e99 561 */
mbed_official 107:414e9c822e99 562 //! @{
mbed_official 107:414e9c822e99 563
mbed_official 107:414e9c822e99 564 /*! \brief Counts the leading zero bits of the given value considered as a 32-bit integer.
mbed_official 107:414e9c822e99 565 *
mbed_official 107:414e9c822e99 566 * \param u Value of which to count the leading zero bits.
mbed_official 107:414e9c822e99 567 *
mbed_official 107:414e9c822e99 568 * \return The count of leading zero bits in \a u.
mbed_official 107:414e9c822e99 569 */
mbed_official 107:414e9c822e99 570 #if (defined __GNUC__) || (defined __CC_ARM)
mbed_official 107:414e9c822e99 571 # define clz(u) __builtin_clz(u)
mbed_official 107:414e9c822e99 572 #elif (defined __ICCARM__)
mbed_official 107:414e9c822e99 573 # define clz(u) __CLZ(u)
mbed_official 107:414e9c822e99 574 #else
mbed_official 107:414e9c822e99 575 # define clz(u) (((u) == 0) ? 32 : \
mbed_official 107:414e9c822e99 576 ((u) & (1ul << 31)) ? 0 : \
mbed_official 107:414e9c822e99 577 ((u) & (1ul << 30)) ? 1 : \
mbed_official 107:414e9c822e99 578 ((u) & (1ul << 29)) ? 2 : \
mbed_official 107:414e9c822e99 579 ((u) & (1ul << 28)) ? 3 : \
mbed_official 107:414e9c822e99 580 ((u) & (1ul << 27)) ? 4 : \
mbed_official 107:414e9c822e99 581 ((u) & (1ul << 26)) ? 5 : \
mbed_official 107:414e9c822e99 582 ((u) & (1ul << 25)) ? 6 : \
mbed_official 107:414e9c822e99 583 ((u) & (1ul << 24)) ? 7 : \
mbed_official 107:414e9c822e99 584 ((u) & (1ul << 23)) ? 8 : \
mbed_official 107:414e9c822e99 585 ((u) & (1ul << 22)) ? 9 : \
mbed_official 107:414e9c822e99 586 ((u) & (1ul << 21)) ? 10 : \
mbed_official 107:414e9c822e99 587 ((u) & (1ul << 20)) ? 11 : \
mbed_official 107:414e9c822e99 588 ((u) & (1ul << 19)) ? 12 : \
mbed_official 107:414e9c822e99 589 ((u) & (1ul << 18)) ? 13 : \
mbed_official 107:414e9c822e99 590 ((u) & (1ul << 17)) ? 14 : \
mbed_official 107:414e9c822e99 591 ((u) & (1ul << 16)) ? 15 : \
mbed_official 107:414e9c822e99 592 ((u) & (1ul << 15)) ? 16 : \
mbed_official 107:414e9c822e99 593 ((u) & (1ul << 14)) ? 17 : \
mbed_official 107:414e9c822e99 594 ((u) & (1ul << 13)) ? 18 : \
mbed_official 107:414e9c822e99 595 ((u) & (1ul << 12)) ? 19 : \
mbed_official 107:414e9c822e99 596 ((u) & (1ul << 11)) ? 20 : \
mbed_official 107:414e9c822e99 597 ((u) & (1ul << 10)) ? 21 : \
mbed_official 107:414e9c822e99 598 ((u) & (1ul << 9)) ? 22 : \
mbed_official 107:414e9c822e99 599 ((u) & (1ul << 8)) ? 23 : \
mbed_official 107:414e9c822e99 600 ((u) & (1ul << 7)) ? 24 : \
mbed_official 107:414e9c822e99 601 ((u) & (1ul << 6)) ? 25 : \
mbed_official 107:414e9c822e99 602 ((u) & (1ul << 5)) ? 26 : \
mbed_official 107:414e9c822e99 603 ((u) & (1ul << 4)) ? 27 : \
mbed_official 107:414e9c822e99 604 ((u) & (1ul << 3)) ? 28 : \
mbed_official 107:414e9c822e99 605 ((u) & (1ul << 2)) ? 29 : \
mbed_official 107:414e9c822e99 606 ((u) & (1ul << 1)) ? 30 : \
mbed_official 107:414e9c822e99 607 31)
mbed_official 107:414e9c822e99 608 #endif
mbed_official 107:414e9c822e99 609
mbed_official 107:414e9c822e99 610 /*! \brief Counts the trailing zero bits of the given value considered as a 32-bit integer.
mbed_official 107:414e9c822e99 611 *
mbed_official 107:414e9c822e99 612 * \param u Value of which to count the trailing zero bits.
mbed_official 107:414e9c822e99 613 *
mbed_official 107:414e9c822e99 614 * \return The count of trailing zero bits in \a u.
mbed_official 107:414e9c822e99 615 */
mbed_official 107:414e9c822e99 616 #if (defined __GNUC__) || (defined __CC_ARM)
mbed_official 107:414e9c822e99 617 # define ctz(u) __builtin_ctz(u)
mbed_official 107:414e9c822e99 618 #else
mbed_official 107:414e9c822e99 619 # define ctz(u) ((u) & (1ul << 0) ? 0 : \
mbed_official 107:414e9c822e99 620 (u) & (1ul << 1) ? 1 : \
mbed_official 107:414e9c822e99 621 (u) & (1ul << 2) ? 2 : \
mbed_official 107:414e9c822e99 622 (u) & (1ul << 3) ? 3 : \
mbed_official 107:414e9c822e99 623 (u) & (1ul << 4) ? 4 : \
mbed_official 107:414e9c822e99 624 (u) & (1ul << 5) ? 5 : \
mbed_official 107:414e9c822e99 625 (u) & (1ul << 6) ? 6 : \
mbed_official 107:414e9c822e99 626 (u) & (1ul << 7) ? 7 : \
mbed_official 107:414e9c822e99 627 (u) & (1ul << 8) ? 8 : \
mbed_official 107:414e9c822e99 628 (u) & (1ul << 9) ? 9 : \
mbed_official 107:414e9c822e99 629 (u) & (1ul << 10) ? 10 : \
mbed_official 107:414e9c822e99 630 (u) & (1ul << 11) ? 11 : \
mbed_official 107:414e9c822e99 631 (u) & (1ul << 12) ? 12 : \
mbed_official 107:414e9c822e99 632 (u) & (1ul << 13) ? 13 : \
mbed_official 107:414e9c822e99 633 (u) & (1ul << 14) ? 14 : \
mbed_official 107:414e9c822e99 634 (u) & (1ul << 15) ? 15 : \
mbed_official 107:414e9c822e99 635 (u) & (1ul << 16) ? 16 : \
mbed_official 107:414e9c822e99 636 (u) & (1ul << 17) ? 17 : \
mbed_official 107:414e9c822e99 637 (u) & (1ul << 18) ? 18 : \
mbed_official 107:414e9c822e99 638 (u) & (1ul << 19) ? 19 : \
mbed_official 107:414e9c822e99 639 (u) & (1ul << 20) ? 20 : \
mbed_official 107:414e9c822e99 640 (u) & (1ul << 21) ? 21 : \
mbed_official 107:414e9c822e99 641 (u) & (1ul << 22) ? 22 : \
mbed_official 107:414e9c822e99 642 (u) & (1ul << 23) ? 23 : \
mbed_official 107:414e9c822e99 643 (u) & (1ul << 24) ? 24 : \
mbed_official 107:414e9c822e99 644 (u) & (1ul << 25) ? 25 : \
mbed_official 107:414e9c822e99 645 (u) & (1ul << 26) ? 26 : \
mbed_official 107:414e9c822e99 646 (u) & (1ul << 27) ? 27 : \
mbed_official 107:414e9c822e99 647 (u) & (1ul << 28) ? 28 : \
mbed_official 107:414e9c822e99 648 (u) & (1ul << 29) ? 29 : \
mbed_official 107:414e9c822e99 649 (u) & (1ul << 30) ? 30 : \
mbed_official 107:414e9c822e99 650 (u) & (1ul << 31) ? 31 : \
mbed_official 107:414e9c822e99 651 32)
mbed_official 107:414e9c822e99 652 #endif
mbed_official 107:414e9c822e99 653
mbed_official 107:414e9c822e99 654 //! @}
mbed_official 107:414e9c822e99 655
mbed_official 107:414e9c822e99 656
mbed_official 107:414e9c822e99 657 /*! \name Bit Reversing
mbed_official 107:414e9c822e99 658 */
mbed_official 107:414e9c822e99 659 //! @{
mbed_official 107:414e9c822e99 660
mbed_official 107:414e9c822e99 661 /*! \brief Reverses the bits of \a u8.
mbed_official 107:414e9c822e99 662 *
mbed_official 107:414e9c822e99 663 * \param u8 U8 of which to reverse the bits.
mbed_official 107:414e9c822e99 664 *
mbed_official 107:414e9c822e99 665 * \return Value resulting from \a u8 with reversed bits.
mbed_official 107:414e9c822e99 666 */
mbed_official 107:414e9c822e99 667 #define bit_reverse8(u8) ((U8)(bit_reverse32((U8)(u8)) >> 24))
mbed_official 107:414e9c822e99 668
mbed_official 107:414e9c822e99 669 /*! \brief Reverses the bits of \a u16.
mbed_official 107:414e9c822e99 670 *
mbed_official 107:414e9c822e99 671 * \param u16 U16 of which to reverse the bits.
mbed_official 107:414e9c822e99 672 *
mbed_official 107:414e9c822e99 673 * \return Value resulting from \a u16 with reversed bits.
mbed_official 107:414e9c822e99 674 */
mbed_official 107:414e9c822e99 675 #define bit_reverse16(u16) ((U16)(bit_reverse32((U16)(u16)) >> 16))
mbed_official 107:414e9c822e99 676
mbed_official 107:414e9c822e99 677 /*! \brief Reverses the bits of \a u32.
mbed_official 107:414e9c822e99 678 *
mbed_official 107:414e9c822e99 679 * \param u32 U32 of which to reverse the bits.
mbed_official 107:414e9c822e99 680 *
mbed_official 107:414e9c822e99 681 * \return Value resulting from \a u32 with reversed bits.
mbed_official 107:414e9c822e99 682 */
mbed_official 107:414e9c822e99 683 #define bit_reverse32(u32) __RBIT(u32)
mbed_official 107:414e9c822e99 684
mbed_official 107:414e9c822e99 685 /*! \brief Reverses the bits of \a u64.
mbed_official 107:414e9c822e99 686 *
mbed_official 107:414e9c822e99 687 * \param u64 U64 of which to reverse the bits.
mbed_official 107:414e9c822e99 688 *
mbed_official 107:414e9c822e99 689 * \return Value resulting from \a u64 with reversed bits.
mbed_official 107:414e9c822e99 690 */
mbed_official 107:414e9c822e99 691 #define bit_reverse64(u64) ((U64)(((U64)bit_reverse32((U64)(u64) >> 32)) |\
mbed_official 107:414e9c822e99 692 ((U64)bit_reverse32((U64)(u64)) << 32)))
mbed_official 107:414e9c822e99 693
mbed_official 107:414e9c822e99 694 //! @}
mbed_official 107:414e9c822e99 695
mbed_official 107:414e9c822e99 696
mbed_official 107:414e9c822e99 697 /*! \name Alignment
mbed_official 107:414e9c822e99 698 */
mbed_official 107:414e9c822e99 699 //! @{
mbed_official 107:414e9c822e99 700
mbed_official 107:414e9c822e99 701 /*! \brief Tests alignment of the number \a val with the \a n boundary.
mbed_official 107:414e9c822e99 702 *
mbed_official 107:414e9c822e99 703 * \param val Input value.
mbed_official 107:414e9c822e99 704 * \param n Boundary.
mbed_official 107:414e9c822e99 705 *
mbed_official 107:414e9c822e99 706 * \return \c 1 if the number \a val is aligned with the \a n boundary, else \c 0.
mbed_official 107:414e9c822e99 707 */
mbed_official 107:414e9c822e99 708 #define Test_align(val, n ) (!Tst_bits( val, (n) - 1 ) )
mbed_official 107:414e9c822e99 709
mbed_official 107:414e9c822e99 710 /*! \brief Gets alignment of the number \a val with respect to the \a n boundary.
mbed_official 107:414e9c822e99 711 *
mbed_official 107:414e9c822e99 712 * \param val Input value.
mbed_official 107:414e9c822e99 713 * \param n Boundary.
mbed_official 107:414e9c822e99 714 *
mbed_official 107:414e9c822e99 715 * \return Alignment of the number \a val with respect to the \a n boundary.
mbed_official 107:414e9c822e99 716 */
mbed_official 107:414e9c822e99 717 #define Get_align( val, n ) ( Rd_bits( val, (n) - 1 ) )
mbed_official 107:414e9c822e99 718
mbed_official 107:414e9c822e99 719 /*! \brief Sets alignment of the lvalue number \a lval to \a alg with respect to the \a n boundary.
mbed_official 107:414e9c822e99 720 *
mbed_official 107:414e9c822e99 721 * \param lval Input/output lvalue.
mbed_official 107:414e9c822e99 722 * \param n Boundary.
mbed_official 107:414e9c822e99 723 * \param alg Alignment.
mbed_official 107:414e9c822e99 724 *
mbed_official 107:414e9c822e99 725 * \return New value of \a lval resulting from its alignment set to \a alg with respect to the \a n boundary.
mbed_official 107:414e9c822e99 726 */
mbed_official 107:414e9c822e99 727 #define Set_align(lval, n, alg) ( Wr_bits(lval, (n) - 1, alg) )
mbed_official 107:414e9c822e99 728
mbed_official 107:414e9c822e99 729 /*! \brief Aligns the number \a val with the upper \a n boundary.
mbed_official 107:414e9c822e99 730 *
mbed_official 107:414e9c822e99 731 * \param val Input value.
mbed_official 107:414e9c822e99 732 * \param n Boundary.
mbed_official 107:414e9c822e99 733 *
mbed_official 107:414e9c822e99 734 * \return Value resulting from the number \a val aligned with the upper \a n boundary.
mbed_official 107:414e9c822e99 735 */
mbed_official 107:414e9c822e99 736 #define Align_up( val, n ) (((val) + ((n) - 1)) & ~((n) - 1))
mbed_official 107:414e9c822e99 737
mbed_official 107:414e9c822e99 738 /*! \brief Aligns the number \a val with the lower \a n boundary.
mbed_official 107:414e9c822e99 739 *
mbed_official 107:414e9c822e99 740 * \param val Input value.
mbed_official 107:414e9c822e99 741 * \param n Boundary.
mbed_official 107:414e9c822e99 742 *
mbed_official 107:414e9c822e99 743 * \return Value resulting from the number \a val aligned with the lower \a n boundary.
mbed_official 107:414e9c822e99 744 */
mbed_official 107:414e9c822e99 745 #define Align_down(val, n ) ( (val) & ~((n) - 1))
mbed_official 107:414e9c822e99 746
mbed_official 107:414e9c822e99 747 //! @}
mbed_official 107:414e9c822e99 748
mbed_official 107:414e9c822e99 749
mbed_official 107:414e9c822e99 750 /*! \name Mathematics
mbed_official 107:414e9c822e99 751 *
mbed_official 107:414e9c822e99 752 * The same considerations as for clz and ctz apply here but GCC does not
mbed_official 107:414e9c822e99 753 * provide built-in functions to access the assembly instructions abs, min and
mbed_official 107:414e9c822e99 754 * max and it does not produce them by itself in most cases, so two sets of
mbed_official 107:414e9c822e99 755 * macros are defined here:
mbed_official 107:414e9c822e99 756 * - Abs, Min and Max to apply to constant expressions (values known at
mbed_official 107:414e9c822e99 757 * compile time);
mbed_official 107:414e9c822e99 758 * - abs, min and max to apply to non-constant expressions (values unknown at
mbed_official 107:414e9c822e99 759 * compile time), abs is found in stdlib.h.
mbed_official 107:414e9c822e99 760 */
mbed_official 107:414e9c822e99 761 //! @{
mbed_official 107:414e9c822e99 762
mbed_official 107:414e9c822e99 763 /*! \brief Takes the absolute value of \a a.
mbed_official 107:414e9c822e99 764 *
mbed_official 107:414e9c822e99 765 * \param a Input value.
mbed_official 107:414e9c822e99 766 *
mbed_official 107:414e9c822e99 767 * \return Absolute value of \a a.
mbed_official 107:414e9c822e99 768 *
mbed_official 107:414e9c822e99 769 * \note More optimized if only used with values known at compile time.
mbed_official 107:414e9c822e99 770 */
mbed_official 107:414e9c822e99 771 #define Abs(a) (((a) < 0 ) ? -(a) : (a))
mbed_official 107:414e9c822e99 772
mbed_official 107:414e9c822e99 773 /*! \brief Takes the minimal value of \a a and \a b.
mbed_official 107:414e9c822e99 774 *
mbed_official 107:414e9c822e99 775 * \param a Input value.
mbed_official 107:414e9c822e99 776 * \param b Input value.
mbed_official 107:414e9c822e99 777 *
mbed_official 107:414e9c822e99 778 * \return Minimal value of \a a and \a b.
mbed_official 107:414e9c822e99 779 *
mbed_official 107:414e9c822e99 780 * \note More optimized if only used with values known at compile time.
mbed_official 107:414e9c822e99 781 */
mbed_official 107:414e9c822e99 782 #define Min(a, b) (((a) < (b)) ? (a) : (b))
mbed_official 107:414e9c822e99 783
mbed_official 107:414e9c822e99 784 /*! \brief Takes the maximal value of \a a and \a b.
mbed_official 107:414e9c822e99 785 *
mbed_official 107:414e9c822e99 786 * \param a Input value.
mbed_official 107:414e9c822e99 787 * \param b Input value.
mbed_official 107:414e9c822e99 788 *
mbed_official 107:414e9c822e99 789 * \return Maximal value of \a a and \a b.
mbed_official 107:414e9c822e99 790 *
mbed_official 107:414e9c822e99 791 * \note More optimized if only used with values known at compile time.
mbed_official 107:414e9c822e99 792 */
mbed_official 107:414e9c822e99 793 #define Max(a, b) (((a) > (b)) ? (a) : (b))
mbed_official 107:414e9c822e99 794
mbed_official 107:414e9c822e99 795 // abs() is already defined by stdlib.h
mbed_official 107:414e9c822e99 796
mbed_official 107:414e9c822e99 797 /*! \brief Takes the minimal value of \a a and \a b.
mbed_official 107:414e9c822e99 798 *
mbed_official 107:414e9c822e99 799 * \param a Input value.
mbed_official 107:414e9c822e99 800 * \param b Input value.
mbed_official 107:414e9c822e99 801 *
mbed_official 107:414e9c822e99 802 * \return Minimal value of \a a and \a b.
mbed_official 107:414e9c822e99 803 *
mbed_official 107:414e9c822e99 804 * \note More optimized if only used with values unknown at compile time.
mbed_official 107:414e9c822e99 805 */
mbed_official 107:414e9c822e99 806 #define min(a, b) Min(a, b)
mbed_official 107:414e9c822e99 807
mbed_official 107:414e9c822e99 808 /*! \brief Takes the maximal value of \a a and \a b.
mbed_official 107:414e9c822e99 809 *
mbed_official 107:414e9c822e99 810 * \param a Input value.
mbed_official 107:414e9c822e99 811 * \param b Input value.
mbed_official 107:414e9c822e99 812 *
mbed_official 107:414e9c822e99 813 * \return Maximal value of \a a and \a b.
mbed_official 107:414e9c822e99 814 *
mbed_official 107:414e9c822e99 815 * \note More optimized if only used with values unknown at compile time.
mbed_official 107:414e9c822e99 816 */
mbed_official 107:414e9c822e99 817 #define max(a, b) Max(a, b)
mbed_official 107:414e9c822e99 818
mbed_official 107:414e9c822e99 819 //! @}
mbed_official 107:414e9c822e99 820
mbed_official 107:414e9c822e99 821
mbed_official 107:414e9c822e99 822 /*! \brief Calls the routine at address \a addr.
mbed_official 107:414e9c822e99 823 *
mbed_official 107:414e9c822e99 824 * It generates a long call opcode.
mbed_official 107:414e9c822e99 825 *
mbed_official 107:414e9c822e99 826 * For example, `Long_call(0x80000000)' generates a software reset on a UC3 if
mbed_official 107:414e9c822e99 827 * it is invoked from the CPU supervisor mode.
mbed_official 107:414e9c822e99 828 *
mbed_official 107:414e9c822e99 829 * \param addr Address of the routine to call.
mbed_official 107:414e9c822e99 830 *
mbed_official 107:414e9c822e99 831 * \note It may be used as a long jump opcode in some special cases.
mbed_official 107:414e9c822e99 832 */
mbed_official 107:414e9c822e99 833 #define Long_call(addr) ((*(void (*)(void))(addr))())
mbed_official 107:414e9c822e99 834
mbed_official 107:414e9c822e99 835
mbed_official 107:414e9c822e99 836 /*! \name MCU Endianism Handling
mbed_official 107:414e9c822e99 837 * ARM is MCU little endianism.
mbed_official 107:414e9c822e99 838 */
mbed_official 107:414e9c822e99 839 //! @{
mbed_official 107:414e9c822e99 840 #define MSB(u16) (((U8 *)&(u16))[1]) //!< Most significant byte of \a u16.
mbed_official 107:414e9c822e99 841 #define LSB(u16) (((U8 *)&(u16))[0]) //!< Least significant byte of \a u16.
mbed_official 107:414e9c822e99 842
mbed_official 107:414e9c822e99 843 #define MSH(u32) (((U16 *)&(u32))[1]) //!< Most significant half-word of \a u32.
mbed_official 107:414e9c822e99 844 #define LSH(u32) (((U16 *)&(u32))[0]) //!< Least significant half-word of \a u32.
mbed_official 107:414e9c822e99 845 #define MSB0W(u32) (((U8 *)&(u32))[3]) //!< Most significant byte of 1st rank of \a u32.
mbed_official 107:414e9c822e99 846 #define MSB1W(u32) (((U8 *)&(u32))[2]) //!< Most significant byte of 2nd rank of \a u32.
mbed_official 107:414e9c822e99 847 #define MSB2W(u32) (((U8 *)&(u32))[1]) //!< Most significant byte of 3rd rank of \a u32.
mbed_official 107:414e9c822e99 848 #define MSB3W(u32) (((U8 *)&(u32))[0]) //!< Most significant byte of 4th rank of \a u32.
mbed_official 107:414e9c822e99 849 #define LSB3W(u32) MSB0W(u32) //!< Least significant byte of 4th rank of \a u32.
mbed_official 107:414e9c822e99 850 #define LSB2W(u32) MSB1W(u32) //!< Least significant byte of 3rd rank of \a u32.
mbed_official 107:414e9c822e99 851 #define LSB1W(u32) MSB2W(u32) //!< Least significant byte of 2nd rank of \a u32.
mbed_official 107:414e9c822e99 852 #define LSB0W(u32) MSB3W(u32) //!< Least significant byte of 1st rank of \a u32.
mbed_official 107:414e9c822e99 853
mbed_official 107:414e9c822e99 854 #define MSW(u64) (((U32 *)&(u64))[1]) //!< Most significant word of \a u64.
mbed_official 107:414e9c822e99 855 #define LSW(u64) (((U32 *)&(u64))[0]) //!< Least significant word of \a u64.
mbed_official 107:414e9c822e99 856 #define MSH0(u64) (((U16 *)&(u64))[3]) //!< Most significant half-word of 1st rank of \a u64.
mbed_official 107:414e9c822e99 857 #define MSH1(u64) (((U16 *)&(u64))[2]) //!< Most significant half-word of 2nd rank of \a u64.
mbed_official 107:414e9c822e99 858 #define MSH2(u64) (((U16 *)&(u64))[1]) //!< Most significant half-word of 3rd rank of \a u64.
mbed_official 107:414e9c822e99 859 #define MSH3(u64) (((U16 *)&(u64))[0]) //!< Most significant half-word of 4th rank of \a u64.
mbed_official 107:414e9c822e99 860 #define LSH3(u64) MSH0(u64) //!< Least significant half-word of 4th rank of \a u64.
mbed_official 107:414e9c822e99 861 #define LSH2(u64) MSH1(u64) //!< Least significant half-word of 3rd rank of \a u64.
mbed_official 107:414e9c822e99 862 #define LSH1(u64) MSH2(u64) //!< Least significant half-word of 2nd rank of \a u64.
mbed_official 107:414e9c822e99 863 #define LSH0(u64) MSH3(u64) //!< Least significant half-word of 1st rank of \a u64.
mbed_official 107:414e9c822e99 864 #define MSB0D(u64) (((U8 *)&(u64))[7]) //!< Most significant byte of 1st rank of \a u64.
mbed_official 107:414e9c822e99 865 #define MSB1D(u64) (((U8 *)&(u64))[6]) //!< Most significant byte of 2nd rank of \a u64.
mbed_official 107:414e9c822e99 866 #define MSB2D(u64) (((U8 *)&(u64))[5]) //!< Most significant byte of 3rd rank of \a u64.
mbed_official 107:414e9c822e99 867 #define MSB3D(u64) (((U8 *)&(u64))[4]) //!< Most significant byte of 4th rank of \a u64.
mbed_official 107:414e9c822e99 868 #define MSB4D(u64) (((U8 *)&(u64))[3]) //!< Most significant byte of 5th rank of \a u64.
mbed_official 107:414e9c822e99 869 #define MSB5D(u64) (((U8 *)&(u64))[2]) //!< Most significant byte of 6th rank of \a u64.
mbed_official 107:414e9c822e99 870 #define MSB6D(u64) (((U8 *)&(u64))[1]) //!< Most significant byte of 7th rank of \a u64.
mbed_official 107:414e9c822e99 871 #define MSB7D(u64) (((U8 *)&(u64))[0]) //!< Most significant byte of 8th rank of \a u64.
mbed_official 107:414e9c822e99 872 #define LSB7D(u64) MSB0D(u64) //!< Least significant byte of 8th rank of \a u64.
mbed_official 107:414e9c822e99 873 #define LSB6D(u64) MSB1D(u64) //!< Least significant byte of 7th rank of \a u64.
mbed_official 107:414e9c822e99 874 #define LSB5D(u64) MSB2D(u64) //!< Least significant byte of 6th rank of \a u64.
mbed_official 107:414e9c822e99 875 #define LSB4D(u64) MSB3D(u64) //!< Least significant byte of 5th rank of \a u64.
mbed_official 107:414e9c822e99 876 #define LSB3D(u64) MSB4D(u64) //!< Least significant byte of 4th rank of \a u64.
mbed_official 107:414e9c822e99 877 #define LSB2D(u64) MSB5D(u64) //!< Least significant byte of 3rd rank of \a u64.
mbed_official 107:414e9c822e99 878 #define LSB1D(u64) MSB6D(u64) //!< Least significant byte of 2nd rank of \a u64.
mbed_official 107:414e9c822e99 879 #define LSB0D(u64) MSB7D(u64) //!< Least significant byte of 1st rank of \a u64.
mbed_official 107:414e9c822e99 880
mbed_official 107:414e9c822e99 881 #define BE16(x) Swap16(x)
mbed_official 107:414e9c822e99 882 #define LE16(x) (x)
mbed_official 107:414e9c822e99 883
mbed_official 107:414e9c822e99 884 #define le16_to_cpu(x) (x)
mbed_official 107:414e9c822e99 885 #define cpu_to_le16(x) (x)
mbed_official 107:414e9c822e99 886 #define LE16_TO_CPU(x) (x)
mbed_official 107:414e9c822e99 887 #define CPU_TO_LE16(x) (x)
mbed_official 107:414e9c822e99 888
mbed_official 107:414e9c822e99 889 #define be16_to_cpu(x) Swap16(x)
mbed_official 107:414e9c822e99 890 #define cpu_to_be16(x) Swap16(x)
mbed_official 107:414e9c822e99 891 #define BE16_TO_CPU(x) Swap16(x)
mbed_official 107:414e9c822e99 892 #define CPU_TO_BE16(x) Swap16(x)
mbed_official 107:414e9c822e99 893
mbed_official 107:414e9c822e99 894 #define le32_to_cpu(x) (x)
mbed_official 107:414e9c822e99 895 #define cpu_to_le32(x) (x)
mbed_official 107:414e9c822e99 896 #define LE32_TO_CPU(x) (x)
mbed_official 107:414e9c822e99 897 #define CPU_TO_LE32(x) (x)
mbed_official 107:414e9c822e99 898
mbed_official 107:414e9c822e99 899 #define be32_to_cpu(x) swap32(x)
mbed_official 107:414e9c822e99 900 #define cpu_to_be32(x) swap32(x)
mbed_official 107:414e9c822e99 901 #define BE32_TO_CPU(x) swap32(x)
mbed_official 107:414e9c822e99 902 #define CPU_TO_BE32(x) swap32(x)
mbed_official 107:414e9c822e99 903 //! @}
mbed_official 107:414e9c822e99 904
mbed_official 107:414e9c822e99 905
mbed_official 107:414e9c822e99 906 /*! \name Endianism Conversion
mbed_official 107:414e9c822e99 907 *
mbed_official 107:414e9c822e99 908 * The same considerations as for clz and ctz apply here but GCC's
mbed_official 107:414e9c822e99 909 * __builtin_bswap_32 and __builtin_bswap_64 do not behave like macros when
mbed_official 107:414e9c822e99 910 * applied to constant expressions, so two sets of macros are defined here:
mbed_official 107:414e9c822e99 911 * - Swap16, Swap32 and Swap64 to apply to constant expressions (values known
mbed_official 107:414e9c822e99 912 * at compile time);
mbed_official 107:414e9c822e99 913 * - swap16, swap32 and swap64 to apply to non-constant expressions (values
mbed_official 107:414e9c822e99 914 * unknown at compile time).
mbed_official 107:414e9c822e99 915 */
mbed_official 107:414e9c822e99 916 //! @{
mbed_official 107:414e9c822e99 917
mbed_official 107:414e9c822e99 918 /*! \brief Toggles the endianism of \a u16 (by swapping its bytes).
mbed_official 107:414e9c822e99 919 *
mbed_official 107:414e9c822e99 920 * \param u16 U16 of which to toggle the endianism.
mbed_official 107:414e9c822e99 921 *
mbed_official 107:414e9c822e99 922 * \return Value resulting from \a u16 with toggled endianism.
mbed_official 107:414e9c822e99 923 *
mbed_official 107:414e9c822e99 924 * \note More optimized if only used with values known at compile time.
mbed_official 107:414e9c822e99 925 */
mbed_official 107:414e9c822e99 926 #define Swap16(u16) ((U16)(((U16)(u16) >> 8) |\
mbed_official 107:414e9c822e99 927 ((U16)(u16) << 8)))
mbed_official 107:414e9c822e99 928
mbed_official 107:414e9c822e99 929 /*! \brief Toggles the endianism of \a u32 (by swapping its bytes).
mbed_official 107:414e9c822e99 930 *
mbed_official 107:414e9c822e99 931 * \param u32 U32 of which to toggle the endianism.
mbed_official 107:414e9c822e99 932 *
mbed_official 107:414e9c822e99 933 * \return Value resulting from \a u32 with toggled endianism.
mbed_official 107:414e9c822e99 934 *
mbed_official 107:414e9c822e99 935 * \note More optimized if only used with values known at compile time.
mbed_official 107:414e9c822e99 936 */
mbed_official 107:414e9c822e99 937 #define Swap32(u32) ((U32)(((U32)Swap16((U32)(u32) >> 16)) |\
mbed_official 107:414e9c822e99 938 ((U32)Swap16((U32)(u32)) << 16)))
mbed_official 107:414e9c822e99 939
mbed_official 107:414e9c822e99 940 /*! \brief Toggles the endianism of \a u64 (by swapping its bytes).
mbed_official 107:414e9c822e99 941 *
mbed_official 107:414e9c822e99 942 * \param u64 U64 of which to toggle the endianism.
mbed_official 107:414e9c822e99 943 *
mbed_official 107:414e9c822e99 944 * \return Value resulting from \a u64 with toggled endianism.
mbed_official 107:414e9c822e99 945 *
mbed_official 107:414e9c822e99 946 * \note More optimized if only used with values known at compile time.
mbed_official 107:414e9c822e99 947 */
mbed_official 107:414e9c822e99 948 #define Swap64(u64) ((U64)(((U64)Swap32((U64)(u64) >> 32)) |\
mbed_official 107:414e9c822e99 949 ((U64)Swap32((U64)(u64)) << 32)))
mbed_official 107:414e9c822e99 950
mbed_official 107:414e9c822e99 951 /*! \brief Toggles the endianism of \a u16 (by swapping its bytes).
mbed_official 107:414e9c822e99 952 *
mbed_official 107:414e9c822e99 953 * \param u16 U16 of which to toggle the endianism.
mbed_official 107:414e9c822e99 954 *
mbed_official 107:414e9c822e99 955 * \return Value resulting from \a u16 with toggled endianism.
mbed_official 107:414e9c822e99 956 *
mbed_official 107:414e9c822e99 957 * \note More optimized if only used with values unknown at compile time.
mbed_official 107:414e9c822e99 958 */
mbed_official 107:414e9c822e99 959 #define swap16(u16) Swap16(u16)
mbed_official 107:414e9c822e99 960
mbed_official 107:414e9c822e99 961 /*! \brief Toggles the endianism of \a u32 (by swapping its bytes).
mbed_official 107:414e9c822e99 962 *
mbed_official 107:414e9c822e99 963 * \param u32 U32 of which to toggle the endianism.
mbed_official 107:414e9c822e99 964 *
mbed_official 107:414e9c822e99 965 * \return Value resulting from \a u32 with toggled endianism.
mbed_official 107:414e9c822e99 966 *
mbed_official 107:414e9c822e99 967 * \note More optimized if only used with values unknown at compile time.
mbed_official 107:414e9c822e99 968 */
mbed_official 107:414e9c822e99 969 #if (defined __GNUC__)
mbed_official 107:414e9c822e99 970 # define swap32(u32) ((U32)__builtin_bswap32((U32)(u32)))
mbed_official 107:414e9c822e99 971 #else
mbed_official 107:414e9c822e99 972 # define swap32(u32) Swap32(u32)
mbed_official 107:414e9c822e99 973 #endif
mbed_official 107:414e9c822e99 974
mbed_official 107:414e9c822e99 975 /*! \brief Toggles the endianism of \a u64 (by swapping its bytes).
mbed_official 107:414e9c822e99 976 *
mbed_official 107:414e9c822e99 977 * \param u64 U64 of which to toggle the endianism.
mbed_official 107:414e9c822e99 978 *
mbed_official 107:414e9c822e99 979 * \return Value resulting from \a u64 with toggled endianism.
mbed_official 107:414e9c822e99 980 *
mbed_official 107:414e9c822e99 981 * \note More optimized if only used with values unknown at compile time.
mbed_official 107:414e9c822e99 982 */
mbed_official 107:414e9c822e99 983 #if (defined __GNUC__)
mbed_official 107:414e9c822e99 984 # define swap64(u64) ((U64)__builtin_bswap64((U64)(u64)))
mbed_official 107:414e9c822e99 985 #else
mbed_official 107:414e9c822e99 986 # define swap64(u64) ((U64)(((U64)swap32((U64)(u64) >> 32)) |\
mbed_official 107:414e9c822e99 987 ((U64)swap32((U64)(u64)) << 32)))
mbed_official 107:414e9c822e99 988 #endif
mbed_official 107:414e9c822e99 989
mbed_official 107:414e9c822e99 990 //! @}
mbed_official 107:414e9c822e99 991
mbed_official 107:414e9c822e99 992
mbed_official 107:414e9c822e99 993 /*! \name Target Abstraction
mbed_official 107:414e9c822e99 994 */
mbed_official 107:414e9c822e99 995 //! @{
mbed_official 107:414e9c822e99 996
mbed_official 107:414e9c822e99 997 #define _GLOBEXT_ extern //!< extern storage-class specifier.
mbed_official 107:414e9c822e99 998 #define _CONST_TYPE_ const //!< const type qualifier.
mbed_official 107:414e9c822e99 999 #define _MEM_TYPE_SLOW_ //!< Slow memory type.
mbed_official 107:414e9c822e99 1000 #define _MEM_TYPE_MEDFAST_ //!< Fairly fast memory type.
mbed_official 107:414e9c822e99 1001 #define _MEM_TYPE_FAST_ //!< Fast memory type.
mbed_official 107:414e9c822e99 1002
mbed_official 107:414e9c822e99 1003 typedef U8 Byte; //!< 8-bit unsigned integer.
mbed_official 107:414e9c822e99 1004
mbed_official 107:414e9c822e99 1005 #define memcmp_ram2ram memcmp //!< Target-specific memcmp of RAM to RAM.
mbed_official 107:414e9c822e99 1006 #define memcmp_code2ram memcmp //!< Target-specific memcmp of RAM to NVRAM.
mbed_official 107:414e9c822e99 1007 #define memcpy_ram2ram memcpy //!< Target-specific memcpy from RAM to RAM.
mbed_official 107:414e9c822e99 1008 #define memcpy_code2ram memcpy //!< Target-specific memcpy from NVRAM to RAM.
mbed_official 107:414e9c822e99 1009
mbed_official 107:414e9c822e99 1010 #define LSB0(u32) LSB0W(u32) //!< Least significant byte of 1st rank of \a u32.
mbed_official 107:414e9c822e99 1011 #define LSB1(u32) LSB1W(u32) //!< Least significant byte of 2nd rank of \a u32.
mbed_official 107:414e9c822e99 1012 #define LSB2(u32) LSB2W(u32) //!< Least significant byte of 3rd rank of \a u32.
mbed_official 107:414e9c822e99 1013 #define LSB3(u32) LSB3W(u32) //!< Least significant byte of 4th rank of \a u32.
mbed_official 107:414e9c822e99 1014 #define MSB3(u32) MSB3W(u32) //!< Most significant byte of 4th rank of \a u32.
mbed_official 107:414e9c822e99 1015 #define MSB2(u32) MSB2W(u32) //!< Most significant byte of 3rd rank of \a u32.
mbed_official 107:414e9c822e99 1016 #define MSB1(u32) MSB1W(u32) //!< Most significant byte of 2nd rank of \a u32.
mbed_official 107:414e9c822e99 1017 #define MSB0(u32) MSB0W(u32) //!< Most significant byte of 1st rank of \a u32.
mbed_official 107:414e9c822e99 1018
mbed_official 107:414e9c822e99 1019 //! @}
mbed_official 107:414e9c822e99 1020
mbed_official 107:414e9c822e99 1021 /**
mbed_official 107:414e9c822e99 1022 * \brief Calculate \f$ \left\lceil \frac{a}{b} \right\rceil \f$ using
mbed_official 107:414e9c822e99 1023 * integer arithmetic.
mbed_official 107:414e9c822e99 1024 *
mbed_official 107:414e9c822e99 1025 * \param a An integer
mbed_official 107:414e9c822e99 1026 * \param b Another integer
mbed_official 107:414e9c822e99 1027 *
mbed_official 107:414e9c822e99 1028 * \return (\a a / \a b) rounded up to the nearest integer.
mbed_official 107:414e9c822e99 1029 */
mbed_official 107:414e9c822e99 1030 #define div_ceil(a, b) (((a) + (b) - 1) / (b))
mbed_official 107:414e9c822e99 1031
mbed_official 107:414e9c822e99 1032 #endif // #ifndef __ASSEMBLY__
mbed_official 107:414e9c822e99 1033
mbed_official 107:414e9c822e99 1034
mbed_official 107:414e9c822e99 1035 #if defined(__ICCARM__)
mbed_official 107:414e9c822e99 1036 #define SHORTENUM __packed
mbed_official 107:414e9c822e99 1037 #elif defined(__GNUC__)
mbed_official 107:414e9c822e99 1038 #define SHORTENUM __attribute__((packed))
mbed_official 107:414e9c822e99 1039 #endif
mbed_official 107:414e9c822e99 1040
mbed_official 107:414e9c822e99 1041 /* No operation */
mbed_official 107:414e9c822e99 1042 #if defined(__ICCARM__)
mbed_official 107:414e9c822e99 1043 #define nop() __no_operation()
mbed_official 107:414e9c822e99 1044 #elif defined(__GNUC__)
mbed_official 107:414e9c822e99 1045 #define nop() (__NOP())
mbed_official 107:414e9c822e99 1046 #endif
mbed_official 107:414e9c822e99 1047
mbed_official 107:414e9c822e99 1048 #define FLASH_DECLARE(x) const x
mbed_official 107:414e9c822e99 1049 #define FLASH_EXTERN(x) extern const x
mbed_official 107:414e9c822e99 1050 #define PGM_READ_BYTE(x) *(x)
mbed_official 107:414e9c822e99 1051 #define PGM_READ_WORD(x) *(x)
mbed_official 107:414e9c822e99 1052 #define PGM_READ_DWORD(x) *(x)
mbed_official 107:414e9c822e99 1053 #define MEMCPY_ENDIAN memcpy
mbed_official 107:414e9c822e99 1054 #define PGM_READ_BLOCK(dst, src, len) memcpy((dst), (src), (len))
mbed_official 107:414e9c822e99 1055
mbed_official 107:414e9c822e99 1056 /*Defines the Flash Storage for the request and response of MAC*/
mbed_official 107:414e9c822e99 1057 #define CMD_ID_OCTET (0)
mbed_official 107:414e9c822e99 1058
mbed_official 107:414e9c822e99 1059 /* Converting of values from CPU endian to little endian. */
mbed_official 107:414e9c822e99 1060 #define CPU_ENDIAN_TO_LE16(x) (x)
mbed_official 107:414e9c822e99 1061 #define CPU_ENDIAN_TO_LE32(x) (x)
mbed_official 107:414e9c822e99 1062 #define CPU_ENDIAN_TO_LE64(x) (x)
mbed_official 107:414e9c822e99 1063
mbed_official 107:414e9c822e99 1064 /* Converting of values from little endian to CPU endian. */
mbed_official 107:414e9c822e99 1065 #define LE16_TO_CPU_ENDIAN(x) (x)
mbed_official 107:414e9c822e99 1066 #define LE32_TO_CPU_ENDIAN(x) (x)
mbed_official 107:414e9c822e99 1067 #define LE64_TO_CPU_ENDIAN(x) (x)
mbed_official 107:414e9c822e99 1068
mbed_official 107:414e9c822e99 1069 /* Converting of constants from little endian to CPU endian. */
mbed_official 107:414e9c822e99 1070 #define CLE16_TO_CPU_ENDIAN(x) (x)
mbed_official 107:414e9c822e99 1071 #define CLE32_TO_CPU_ENDIAN(x) (x)
mbed_official 107:414e9c822e99 1072 #define CLE64_TO_CPU_ENDIAN(x) (x)
mbed_official 107:414e9c822e99 1073
mbed_official 107:414e9c822e99 1074 /* Converting of constants from CPU endian to little endian. */
mbed_official 107:414e9c822e99 1075 #define CCPU_ENDIAN_TO_LE16(x) (x)
mbed_official 107:414e9c822e99 1076 #define CCPU_ENDIAN_TO_LE32(x) (x)
mbed_official 107:414e9c822e99 1077 #define CCPU_ENDIAN_TO_LE64(x) (x)
mbed_official 107:414e9c822e99 1078
mbed_official 107:414e9c822e99 1079 #define ADDR_COPY_DST_SRC_16(dst, src) ((dst) = (src))
mbed_official 107:414e9c822e99 1080 #define ADDR_COPY_DST_SRC_64(dst, src) ((dst) = (src))
mbed_official 107:414e9c822e99 1081
mbed_official 107:414e9c822e99 1082 /**
mbed_official 107:414e9c822e99 1083 * @brief Converts a 64-Bit value into a 8 Byte array
mbed_official 107:414e9c822e99 1084 *
mbed_official 107:414e9c822e99 1085 * @param[in] value 64-Bit value
mbed_official 107:414e9c822e99 1086 * @param[out] data Pointer to the 8 Byte array to be updated with 64-Bit value
mbed_official 107:414e9c822e99 1087 * @ingroup apiPalApi
mbed_official 107:414e9c822e99 1088 */
mbed_official 107:414e9c822e99 1089 static inline void convert_64_bit_to_byte_array(uint64_t value, uint8_t *data)
mbed_official 107:414e9c822e99 1090 {
mbed_official 107:414e9c822e99 1091 uint8_t val_index = 0;
mbed_official 107:414e9c822e99 1092
mbed_official 107:414e9c822e99 1093 while (val_index < 8) {
mbed_official 107:414e9c822e99 1094 data[val_index++] = value & 0xFF;
mbed_official 107:414e9c822e99 1095 value = value >> 8;
mbed_official 107:414e9c822e99 1096 }
mbed_official 107:414e9c822e99 1097 }
mbed_official 107:414e9c822e99 1098
mbed_official 107:414e9c822e99 1099 /**
mbed_official 107:414e9c822e99 1100 * @brief Converts a 16-Bit value into a 2 Byte array
mbed_official 107:414e9c822e99 1101 *
mbed_official 107:414e9c822e99 1102 * @param[in] value 16-Bit value
mbed_official 107:414e9c822e99 1103 * @param[out] data Pointer to the 2 Byte array to be updated with 16-Bit value
mbed_official 107:414e9c822e99 1104 * @ingroup apiPalApi
mbed_official 107:414e9c822e99 1105 */
mbed_official 107:414e9c822e99 1106 static inline void convert_16_bit_to_byte_array(uint16_t value, uint8_t *data)
mbed_official 107:414e9c822e99 1107 {
mbed_official 107:414e9c822e99 1108 data[0] = value & 0xFF;
mbed_official 107:414e9c822e99 1109 data[1] = (value >> 8) & 0xFF;
mbed_official 107:414e9c822e99 1110 }
mbed_official 107:414e9c822e99 1111
mbed_official 107:414e9c822e99 1112 /* Converts a 16-Bit value into a 2 Byte array */
mbed_official 107:414e9c822e99 1113 static inline void convert_spec_16_bit_to_byte_array(uint16_t value, uint8_t *data)
mbed_official 107:414e9c822e99 1114 {
mbed_official 107:414e9c822e99 1115 data[0] = value & 0xFF;
mbed_official 107:414e9c822e99 1116 data[1] = (value >> 8) & 0xFF;
mbed_official 107:414e9c822e99 1117 }
mbed_official 107:414e9c822e99 1118
mbed_official 107:414e9c822e99 1119 /* Converts a 16-Bit value into a 2 Byte array */
mbed_official 107:414e9c822e99 1120 static inline void convert_16_bit_to_byte_address(uint16_t value, uint8_t *data)
mbed_official 107:414e9c822e99 1121 {
mbed_official 107:414e9c822e99 1122 data[0] = value & 0xFF;
mbed_official 107:414e9c822e99 1123 data[1] = (value >> 8) & 0xFF;
mbed_official 107:414e9c822e99 1124 }
mbed_official 107:414e9c822e99 1125
mbed_official 107:414e9c822e99 1126 /*
mbed_official 107:414e9c822e99 1127 * @brief Converts a 2 Byte array into a 16-Bit value
mbed_official 107:414e9c822e99 1128 *
mbed_official 107:414e9c822e99 1129 * @param data Specifies the pointer to the 2 Byte array
mbed_official 107:414e9c822e99 1130 *
mbed_official 107:414e9c822e99 1131 * @return 16-Bit value
mbed_official 107:414e9c822e99 1132 * @ingroup apiPalApi
mbed_official 107:414e9c822e99 1133 */
mbed_official 107:414e9c822e99 1134 static inline uint16_t convert_byte_array_to_16_bit(uint8_t *data)
mbed_official 107:414e9c822e99 1135 {
mbed_official 107:414e9c822e99 1136 return (data[0] | ((uint16_t)data[1] << 8));
mbed_official 107:414e9c822e99 1137 }
mbed_official 107:414e9c822e99 1138
mbed_official 107:414e9c822e99 1139 /* Converts a 8 Byte array into a 32-Bit value */
mbed_official 107:414e9c822e99 1140 static inline uint32_t convert_byte_array_to_32_bit(uint8_t *data)
mbed_official 107:414e9c822e99 1141 {
mbed_official 107:414e9c822e99 1142 union {
mbed_official 107:414e9c822e99 1143 uint32_t u32;
mbed_official 107:414e9c822e99 1144 uint8_t u8[8];
mbed_official 107:414e9c822e99 1145 } long_addr;
mbed_official 107:414e9c822e99 1146 uint8_t index;
mbed_official 107:414e9c822e99 1147 for (index = 0; index < 4; index++) {
mbed_official 107:414e9c822e99 1148 long_addr.u8[index] = *data++;
mbed_official 107:414e9c822e99 1149 }
mbed_official 107:414e9c822e99 1150 return long_addr.u32;
mbed_official 107:414e9c822e99 1151 }
mbed_official 107:414e9c822e99 1152
mbed_official 107:414e9c822e99 1153 /**
mbed_official 107:414e9c822e99 1154 * @brief Converts a 8 Byte array into a 64-Bit value
mbed_official 107:414e9c822e99 1155 *
mbed_official 107:414e9c822e99 1156 * @param data Specifies the pointer to the 8 Byte array
mbed_official 107:414e9c822e99 1157 *
mbed_official 107:414e9c822e99 1158 * @return 64-Bit value
mbed_official 107:414e9c822e99 1159 * @ingroup apiPalApi
mbed_official 107:414e9c822e99 1160 */
mbed_official 107:414e9c822e99 1161 static inline uint64_t convert_byte_array_to_64_bit(uint8_t *data)
mbed_official 107:414e9c822e99 1162 {
mbed_official 107:414e9c822e99 1163 union {
mbed_official 107:414e9c822e99 1164 uint64_t u64;
mbed_official 107:414e9c822e99 1165 uint8_t u8[8];
mbed_official 107:414e9c822e99 1166 } long_addr;
mbed_official 107:414e9c822e99 1167
mbed_official 107:414e9c822e99 1168 uint8_t val_index;
mbed_official 107:414e9c822e99 1169
mbed_official 107:414e9c822e99 1170 for (val_index = 0; val_index < 8; val_index++) {
mbed_official 107:414e9c822e99 1171 long_addr.u8[val_index] = *data++;
mbed_official 107:414e9c822e99 1172 }
mbed_official 107:414e9c822e99 1173
mbed_official 107:414e9c822e99 1174 return long_addr.u64;
mbed_official 107:414e9c822e99 1175 }
mbed_official 107:414e9c822e99 1176 /**
mbed_official 107:414e9c822e99 1177 * \}
mbed_official 107:414e9c822e99 1178 */
mbed_official 107:414e9c822e99 1179
mbed_official 107:414e9c822e99 1180 #endif /* UTILS_COMPILER_H */