Toyomasa Watarai / Mbed OS armcc_info

Describes predefine macros for mbed online compiler (armcc)

mbed/platform/mbed_toolchain.h@6:40e873bbc5f7, 2017-03-16 (annotated)

Committer:
MACRUM
Date:
Thu Mar 16 21:58:09 2017 +0900
Revision:
6:40e873bbc5f7
Add licence header info

Who changed what in which revision?

UserRevisionLine numberNew contents of line
MACRUM 6:40e873bbc5f7 1
MACRUM 6:40e873bbc5f7 2 /** \addtogroup platform */
MACRUM 6:40e873bbc5f7 3 /** @{*/
MACRUM 6:40e873bbc5f7 4 /* mbed Microcontroller Library
MACRUM 6:40e873bbc5f7 5 * Copyright (c) 2006-2013 ARM Limited
MACRUM 6:40e873bbc5f7 6 *
MACRUM 6:40e873bbc5f7 7 * Licensed under the Apache License, Version 2.0 (the "License");
MACRUM 6:40e873bbc5f7 8 * you may not use this file except in compliance with the License.
MACRUM 6:40e873bbc5f7 9 * You may obtain a copy of the License at
MACRUM 6:40e873bbc5f7 10 *
MACRUM 6:40e873bbc5f7 11 * http://www.apache.org/licenses/LICENSE-2.0
MACRUM 6:40e873bbc5f7 12 *
MACRUM 6:40e873bbc5f7 13 * Unless required by applicable law or agreed to in writing, software
MACRUM 6:40e873bbc5f7 14 * distributed under the License is distributed on an "AS IS" BASIS,
MACRUM 6:40e873bbc5f7 15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
MACRUM 6:40e873bbc5f7 16 * See the License for the specific language governing permissions and
MACRUM 6:40e873bbc5f7 17 * limitations under the License.
MACRUM 6:40e873bbc5f7 18 */
MACRUM 6:40e873bbc5f7 19 #ifndef MBED_TOOLCHAIN_H
MACRUM 6:40e873bbc5f7 20 #define MBED_TOOLCHAIN_H
MACRUM 6:40e873bbc5f7 21
MACRUM 6:40e873bbc5f7 22 #include "mbed_preprocessor.h"
MACRUM 6:40e873bbc5f7 23
MACRUM 6:40e873bbc5f7 24
MACRUM 6:40e873bbc5f7 25 // Warning for unsupported compilers
MACRUM 6:40e873bbc5f7 26 #if !defined(__GNUC__) /* GCC */ \
MACRUM 6:40e873bbc5f7 27 && !defined(__CC_ARM) /* ARMCC */ \
MACRUM 6:40e873bbc5f7 28 && !defined(__clang__) /* LLVM/Clang */ \
MACRUM 6:40e873bbc5f7 29 && !defined(__ICCARM__) /* IAR */
MACRUM 6:40e873bbc5f7 30 #warning "This compiler is not yet supported."
MACRUM 6:40e873bbc5f7 31 #endif
MACRUM 6:40e873bbc5f7 32
MACRUM 6:40e873bbc5f7 33
MACRUM 6:40e873bbc5f7 34 // Attributes
MACRUM 6:40e873bbc5f7 35
MACRUM 6:40e873bbc5f7 36 /** MBED_PACKED
MACRUM 6:40e873bbc5f7 37 * Pack a structure, preventing any padding from being added between fields.
MACRUM 6:40e873bbc5f7 38 *
MACRUM 6:40e873bbc5f7 39 * @code
MACRUM 6:40e873bbc5f7 40 * #include "mbed_toolchain.h"
MACRUM 6:40e873bbc5f7 41 *
MACRUM 6:40e873bbc5f7 42 * MBED_PACKED(struct) foo {
MACRUM 6:40e873bbc5f7 43 * char x;
MACRUM 6:40e873bbc5f7 44 * int y;
MACRUM 6:40e873bbc5f7 45 * };
MACRUM 6:40e873bbc5f7 46 * @endcode
MACRUM 6:40e873bbc5f7 47 */
MACRUM 6:40e873bbc5f7 48 #ifndef MBED_PACKED
MACRUM 6:40e873bbc5f7 49 #if defined(__ICCARM__)
MACRUM 6:40e873bbc5f7 50 #define MBED_PACKED(struct) __packed struct
MACRUM 6:40e873bbc5f7 51 #else
MACRUM 6:40e873bbc5f7 52 #define MBED_PACKED(struct) struct __attribute__((packed))
MACRUM 6:40e873bbc5f7 53 #endif
MACRUM 6:40e873bbc5f7 54 #endif
MACRUM 6:40e873bbc5f7 55
MACRUM 6:40e873bbc5f7 56 /** MBED_ALIGN(N)
MACRUM 6:40e873bbc5f7 57 * Declare a variable to be aligned on an N-byte boundary.
MACRUM 6:40e873bbc5f7 58 *
MACRUM 6:40e873bbc5f7 59 * @note
MACRUM 6:40e873bbc5f7 60 * IAR does not support alignment greater than word size on the stack
MACRUM 6:40e873bbc5f7 61 *
MACRUM 6:40e873bbc5f7 62 * @code
MACRUM 6:40e873bbc5f7 63 * #include "mbed_toolchain.h"
MACRUM 6:40e873bbc5f7 64 *
MACRUM 6:40e873bbc5f7 65 * MBED_ALIGN(16) char a;
MACRUM 6:40e873bbc5f7 66 * @endcode
MACRUM 6:40e873bbc5f7 67 */
MACRUM 6:40e873bbc5f7 68 #ifndef MBED_ALIGN
MACRUM 6:40e873bbc5f7 69 #if defined(__ICCARM__)
MACRUM 6:40e873bbc5f7 70 #define MBED_ALIGN(N) _Pragma(MBED_STRINGIFY(data_alignment=N))
MACRUM 6:40e873bbc5f7 71 #else
MACRUM 6:40e873bbc5f7 72 #define MBED_ALIGN(N) __attribute__((aligned(N)))
MACRUM 6:40e873bbc5f7 73 #endif
MACRUM 6:40e873bbc5f7 74 #endif
MACRUM 6:40e873bbc5f7 75
MACRUM 6:40e873bbc5f7 76 /** MBED_UNUSED
MACRUM 6:40e873bbc5f7 77 * Declare a function argument to be unused, suppressing compiler warnings
MACRUM 6:40e873bbc5f7 78 *
MACRUM 6:40e873bbc5f7 79 * @code
MACRUM 6:40e873bbc5f7 80 * #include "mbed_toolchain.h"
MACRUM 6:40e873bbc5f7 81 *
MACRUM 6:40e873bbc5f7 82 * void foo(MBED_UNUSED int arg) {
MACRUM 6:40e873bbc5f7 83 *
MACRUM 6:40e873bbc5f7 84 * }
MACRUM 6:40e873bbc5f7 85 * @endcode
MACRUM 6:40e873bbc5f7 86 */
MACRUM 6:40e873bbc5f7 87 #ifndef MBED_UNUSED
MACRUM 6:40e873bbc5f7 88 #if defined(__GNUC__) || defined(__clang__) || defined(__CC_ARM)
MACRUM 6:40e873bbc5f7 89 #define MBED_UNUSED __attribute__((__unused__))
MACRUM 6:40e873bbc5f7 90 #else
MACRUM 6:40e873bbc5f7 91 #define MBED_UNUSED
MACRUM 6:40e873bbc5f7 92 #endif
MACRUM 6:40e873bbc5f7 93 #endif
MACRUM 6:40e873bbc5f7 94
MACRUM 6:40e873bbc5f7 95 /** MBED_WEAK
MACRUM 6:40e873bbc5f7 96 * Mark a function as being weak.
MACRUM 6:40e873bbc5f7 97 *
MACRUM 6:40e873bbc5f7 98 * @note
MACRUM 6:40e873bbc5f7 99 * weak functions are not friendly to making code re-usable, as they can only
MACRUM 6:40e873bbc5f7 100 * be overridden once (and if they are multiply overridden the linker will emit
MACRUM 6:40e873bbc5f7 101 * no warning). You should not normally use weak symbols as part of the API to
MACRUM 6:40e873bbc5f7 102 * re-usable modules.
MACRUM 6:40e873bbc5f7 103 *
MACRUM 6:40e873bbc5f7 104 * @code
MACRUM 6:40e873bbc5f7 105 * #include "mbed_toolchain.h"
MACRUM 6:40e873bbc5f7 106 *
MACRUM 6:40e873bbc5f7 107 * MBED_WEAK void foo() {
MACRUM 6:40e873bbc5f7 108 * // a weak implementation of foo that can be overriden by a definition
MACRUM 6:40e873bbc5f7 109 * // without __weak
MACRUM 6:40e873bbc5f7 110 * }
MACRUM 6:40e873bbc5f7 111 * @endcode
MACRUM 6:40e873bbc5f7 112 */
MACRUM 6:40e873bbc5f7 113 #ifndef MBED_WEAK
MACRUM 6:40e873bbc5f7 114 #if defined(__ICCARM__)
MACRUM 6:40e873bbc5f7 115 #define MBED_WEAK __weak
MACRUM 6:40e873bbc5f7 116 #else
MACRUM 6:40e873bbc5f7 117 #define MBED_WEAK __attribute__((weak))
MACRUM 6:40e873bbc5f7 118 #endif
MACRUM 6:40e873bbc5f7 119 #endif
MACRUM 6:40e873bbc5f7 120
MACRUM 6:40e873bbc5f7 121 /** MBED_PURE
MACRUM 6:40e873bbc5f7 122 * Hint to the compiler that a function depends only on parameters
MACRUM 6:40e873bbc5f7 123 *
MACRUM 6:40e873bbc5f7 124 * @code
MACRUM 6:40e873bbc5f7 125 * #include "mbed_toolchain.h"
MACRUM 6:40e873bbc5f7 126 *
MACRUM 6:40e873bbc5f7 127 * MBED_PURE int foo(int arg){
MACRUM 6:40e873bbc5f7 128 * // no access to global variables
MACRUM 6:40e873bbc5f7 129 * }
MACRUM 6:40e873bbc5f7 130 * @endcode
MACRUM 6:40e873bbc5f7 131 */
MACRUM 6:40e873bbc5f7 132 #ifndef MBED_PURE
MACRUM 6:40e873bbc5f7 133 #if defined(__GNUC__) || defined(__clang__) || defined(__CC_ARM)
MACRUM 6:40e873bbc5f7 134 #define MBED_PURE __attribute__((const))
MACRUM 6:40e873bbc5f7 135 #else
MACRUM 6:40e873bbc5f7 136 #define MBED_PURE
MACRUM 6:40e873bbc5f7 137 #endif
MACRUM 6:40e873bbc5f7 138 #endif
MACRUM 6:40e873bbc5f7 139
MACRUM 6:40e873bbc5f7 140 /** MBED_FORCEINLINE
MACRUM 6:40e873bbc5f7 141 * Declare a function that must always be inlined. Failure to inline
MACRUM 6:40e873bbc5f7 142 * such a function will result in an error.
MACRUM 6:40e873bbc5f7 143 *
MACRUM 6:40e873bbc5f7 144 * @code
MACRUM 6:40e873bbc5f7 145 * #include "mbed_toolchain.h"
MACRUM 6:40e873bbc5f7 146 *
MACRUM 6:40e873bbc5f7 147 * MBED_FORCEINLINE void foo() {
MACRUM 6:40e873bbc5f7 148 *
MACRUM 6:40e873bbc5f7 149 * }
MACRUM 6:40e873bbc5f7 150 * @endcode
MACRUM 6:40e873bbc5f7 151 */
MACRUM 6:40e873bbc5f7 152 #ifndef MBED_FORCEINLINE
MACRUM 6:40e873bbc5f7 153 #if defined(__GNUC__) || defined(__clang__) || defined(__CC_ARM)
MACRUM 6:40e873bbc5f7 154 #define MBED_FORCEINLINE static inline __attribute__((always_inline))
MACRUM 6:40e873bbc5f7 155 #elif defined(__ICCARM__)
MACRUM 6:40e873bbc5f7 156 #define MBED_FORCEINLINE _Pragma("inline=forced") static
MACRUM 6:40e873bbc5f7 157 #else
MACRUM 6:40e873bbc5f7 158 #define MBED_FORCEINLINE static inline
MACRUM 6:40e873bbc5f7 159 #endif
MACRUM 6:40e873bbc5f7 160 #endif
MACRUM 6:40e873bbc5f7 161
MACRUM 6:40e873bbc5f7 162 /** MBED_NORETURN
MACRUM 6:40e873bbc5f7 163 * Declare a function that will never return.
MACRUM 6:40e873bbc5f7 164 *
MACRUM 6:40e873bbc5f7 165 * @code
MACRUM 6:40e873bbc5f7 166 * #include "mbed_toolchain.h"
MACRUM 6:40e873bbc5f7 167 *
MACRUM 6:40e873bbc5f7 168 * MBED_NORETURN void foo() {
MACRUM 6:40e873bbc5f7 169 * // must never return
MACRUM 6:40e873bbc5f7 170 * while (1) {}
MACRUM 6:40e873bbc5f7 171 * }
MACRUM 6:40e873bbc5f7 172 * @endcode
MACRUM 6:40e873bbc5f7 173 */
MACRUM 6:40e873bbc5f7 174 #ifndef MBED_NORETURN
MACRUM 6:40e873bbc5f7 175 #if defined(__GNUC__) || defined(__clang__) || defined(__CC_ARM)
MACRUM 6:40e873bbc5f7 176 #define MBED_NORETURN __attribute__((noreturn))
MACRUM 6:40e873bbc5f7 177 #elif defined(__ICCARM__)
MACRUM 6:40e873bbc5f7 178 #define MBED_NORETURN __noreturn
MACRUM 6:40e873bbc5f7 179 #else
MACRUM 6:40e873bbc5f7 180 #define MBED_NORETURN
MACRUM 6:40e873bbc5f7 181 #endif
MACRUM 6:40e873bbc5f7 182 #endif
MACRUM 6:40e873bbc5f7 183
MACRUM 6:40e873bbc5f7 184 /** MBED_UNREACHABLE
MACRUM 6:40e873bbc5f7 185 * An unreachable statement. If the statement is reached,
MACRUM 6:40e873bbc5f7 186 * behaviour is undefined. Useful in situations where the compiler
MACRUM 6:40e873bbc5f7 187 * cannot deduce the unreachability of code.
MACRUM 6:40e873bbc5f7 188 *
MACRUM 6:40e873bbc5f7 189 * @code
MACRUM 6:40e873bbc5f7 190 * #include "mbed_toolchain.h"
MACRUM 6:40e873bbc5f7 191 *
MACRUM 6:40e873bbc5f7 192 * void foo(int arg) {
MACRUM 6:40e873bbc5f7 193 * switch (arg) {
MACRUM 6:40e873bbc5f7 194 * case 1: return 1;
MACRUM 6:40e873bbc5f7 195 * case 2: return 2;
MACRUM 6:40e873bbc5f7 196 * ...
MACRUM 6:40e873bbc5f7 197 * }
MACRUM 6:40e873bbc5f7 198 * MBED_UNREACHABLE;
MACRUM 6:40e873bbc5f7 199 * }
MACRUM 6:40e873bbc5f7 200 * @endcode
MACRUM 6:40e873bbc5f7 201 */
MACRUM 6:40e873bbc5f7 202 #ifndef MBED_UNREACHABLE
MACRUM 6:40e873bbc5f7 203 #if (defined(__GNUC__) || defined(__clang__)) && !defined(__CC_ARM)
MACRUM 6:40e873bbc5f7 204 #define MBED_UNREACHABLE __builtin_unreachable()
MACRUM 6:40e873bbc5f7 205 #else
MACRUM 6:40e873bbc5f7 206 #define MBED_UNREACHABLE while (1)
MACRUM 6:40e873bbc5f7 207 #endif
MACRUM 6:40e873bbc5f7 208 #endif
MACRUM 6:40e873bbc5f7 209
MACRUM 6:40e873bbc5f7 210 /** MBED_DEPRECATED("message string")
MACRUM 6:40e873bbc5f7 211 * Mark a function declaration as deprecated, if it used then a warning will be
MACRUM 6:40e873bbc5f7 212 * issued by the compiler possibly including the provided message. Note that not
MACRUM 6:40e873bbc5f7 213 * all compilers are able to display the message.
MACRUM 6:40e873bbc5f7 214 *
MACRUM 6:40e873bbc5f7 215 * @code
MACRUM 6:40e873bbc5f7 216 * #include "mbed_toolchain.h"
MACRUM 6:40e873bbc5f7 217 *
MACRUM 6:40e873bbc5f7 218 * MBED_DEPRECATED("don't foo any more, bar instead")
MACRUM 6:40e873bbc5f7 219 * void foo(int arg);
MACRUM 6:40e873bbc5f7 220 * @endcode
MACRUM 6:40e873bbc5f7 221 */
MACRUM 6:40e873bbc5f7 222 #ifndef MBED_DEPRECATED
MACRUM 6:40e873bbc5f7 223 #if defined(__CC_ARM)
MACRUM 6:40e873bbc5f7 224 #define MBED_DEPRECATED(M) __attribute__((deprecated))
MACRUM 6:40e873bbc5f7 225 #elif defined(__GNUC__) || defined(__clang__)
MACRUM 6:40e873bbc5f7 226 #define MBED_DEPRECATED(M) __attribute__((deprecated(M)))
MACRUM 6:40e873bbc5f7 227 #else
MACRUM 6:40e873bbc5f7 228 #define MBED_DEPRECATED(M)
MACRUM 6:40e873bbc5f7 229 #endif
MACRUM 6:40e873bbc5f7 230 #endif
MACRUM 6:40e873bbc5f7 231
MACRUM 6:40e873bbc5f7 232 /** MBED_DEPRECATED_SINCE("version", "message string")
MACRUM 6:40e873bbc5f7 233 * Mark a function declaration as deprecated, noting that the declaration was
MACRUM 6:40e873bbc5f7 234 * deprecated on the specified version. If the function is used then a warning
MACRUM 6:40e873bbc5f7 235 * will be issued by the compiler possibly including the provided message.
MACRUM 6:40e873bbc5f7 236 * Note that not all compilers are able to display this message.
MACRUM 6:40e873bbc5f7 237 *
MACRUM 6:40e873bbc5f7 238 * @code
MACRUM 6:40e873bbc5f7 239 * #include "mbed_toolchain.h"
MACRUM 6:40e873bbc5f7 240 *
MACRUM 6:40e873bbc5f7 241 * MBED_DEPRECATED_SINCE("mbed-os-5.1", "don't foo any more, bar instead")
MACRUM 6:40e873bbc5f7 242 * void foo(int arg);
MACRUM 6:40e873bbc5f7 243 * @endcode
MACRUM 6:40e873bbc5f7 244 */
MACRUM 6:40e873bbc5f7 245 #define MBED_DEPRECATED_SINCE(D, M) MBED_DEPRECATED(M " [since " D "]")
MACRUM 6:40e873bbc5f7 246
MACRUM 6:40e873bbc5f7 247 /** MBED_CALLER_ADDR()
MACRUM 6:40e873bbc5f7 248 * Returns the caller of the current function.
MACRUM 6:40e873bbc5f7 249 *
MACRUM 6:40e873bbc5f7 250 * @note
MACRUM 6:40e873bbc5f7 251 * This macro is only implemented for GCC and ARMCC.
MACRUM 6:40e873bbc5f7 252 *
MACRUM 6:40e873bbc5f7 253 * @code
MACRUM 6:40e873bbc5f7 254 * #include "mbed_toolchain.h"
MACRUM 6:40e873bbc5f7 255 *
MACRUM 6:40e873bbc5f7 256 * printf("This function was called from %p", MBED_CALLER_ADDR());
MACRUM 6:40e873bbc5f7 257 * @endcode
MACRUM 6:40e873bbc5f7 258 *
MACRUM 6:40e873bbc5f7 259 * @return Address of the calling function
MACRUM 6:40e873bbc5f7 260 */
MACRUM 6:40e873bbc5f7 261 #ifndef MBED_CALLER_ADDR
MACRUM 6:40e873bbc5f7 262 #if (defined(__GNUC__) || defined(__clang__)) && !defined(__CC_ARM)
MACRUM 6:40e873bbc5f7 263 #define MBED_CALLER_ADDR() __builtin_extract_return_addr(__builtin_return_address(0))
MACRUM 6:40e873bbc5f7 264 #elif defined(__CC_ARM)
MACRUM 6:40e873bbc5f7 265 #define MBED_CALLER_ADDR() __builtin_return_address(0)
MACRUM 6:40e873bbc5f7 266 #else
MACRUM 6:40e873bbc5f7 267 #define MBED_CALLER_ADDR() (NULL)
MACRUM 6:40e873bbc5f7 268 #endif
MACRUM 6:40e873bbc5f7 269 #endif
MACRUM 6:40e873bbc5f7 270
MACRUM 6:40e873bbc5f7 271 #ifndef MBED_SECTION
MACRUM 6:40e873bbc5f7 272 #if (defined(__GNUC__) || defined(__clang__)) || defined(__CC_ARM)
MACRUM 6:40e873bbc5f7 273 #define MBED_SECTION(name) __attribute__ ((section (name)))
MACRUM 6:40e873bbc5f7 274 #elif defined(__ICCARM__)
MACRUM 6:40e873bbc5f7 275 #define MBED_SECTION(name) _Pragma(MBED_STRINGIFY(location=name))
MACRUM 6:40e873bbc5f7 276 #else
MACRUM 6:40e873bbc5f7 277 #error "Missing MBED_SECTION directive"
MACRUM 6:40e873bbc5f7 278 #endif
MACRUM 6:40e873bbc5f7 279 #endif
MACRUM 6:40e873bbc5f7 280
MACRUM 6:40e873bbc5f7 281 // FILEHANDLE declaration
MACRUM 6:40e873bbc5f7 282 #if defined(TOOLCHAIN_ARM)
MACRUM 6:40e873bbc5f7 283 #include <rt_sys.h>
MACRUM 6:40e873bbc5f7 284 #endif
MACRUM 6:40e873bbc5f7 285
MACRUM 6:40e873bbc5f7 286 #ifndef FILEHANDLE
MACRUM 6:40e873bbc5f7 287 typedef int FILEHANDLE;
MACRUM 6:40e873bbc5f7 288 #endif
MACRUM 6:40e873bbc5f7 289
MACRUM 6:40e873bbc5f7 290 // Backwards compatibility
MACRUM 6:40e873bbc5f7 291 #ifndef WEAK
MACRUM 6:40e873bbc5f7 292 #define WEAK MBED_WEAK
MACRUM 6:40e873bbc5f7 293 #endif
MACRUM 6:40e873bbc5f7 294
MACRUM 6:40e873bbc5f7 295 #ifndef PACKED
MACRUM 6:40e873bbc5f7 296 #define PACKED MBED_PACKED()
MACRUM 6:40e873bbc5f7 297 #endif
MACRUM 6:40e873bbc5f7 298
MACRUM 6:40e873bbc5f7 299 #ifndef EXTERN
MACRUM 6:40e873bbc5f7 300 #define EXTERN extern
MACRUM 6:40e873bbc5f7 301 #endif
MACRUM 6:40e873bbc5f7 302
MACRUM 6:40e873bbc5f7 303 #endif
MACRUM 6:40e873bbc5f7 304
MACRUM 6:40e873bbc5f7 305 /** @}*/