mbed-os
Dependents: cobaLCDJoyMotor_Thread odometry_omni_3roda_v3 odometry_omni_3roda_v1 odometry_omni_3roda_v2 ... more
platform/mbed_toolchain.h@0:b74591d5ab33, 2017-12-11 (annotated)
- Committer:
- be_bryan
- Date:
- Mon Dec 11 17:54:04 2017 +0000
- Revision:
- 0:b74591d5ab33
motor ++
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
be_bryan | 0:b74591d5ab33 | 1 | |
be_bryan | 0:b74591d5ab33 | 2 | /** \addtogroup platform */ |
be_bryan | 0:b74591d5ab33 | 3 | /** @{*/ |
be_bryan | 0:b74591d5ab33 | 4 | /** |
be_bryan | 0:b74591d5ab33 | 5 | * \defgroup platform_toolchain Toolchain functions |
be_bryan | 0:b74591d5ab33 | 6 | * @{ |
be_bryan | 0:b74591d5ab33 | 7 | */ |
be_bryan | 0:b74591d5ab33 | 8 | |
be_bryan | 0:b74591d5ab33 | 9 | /* mbed Microcontroller Library |
be_bryan | 0:b74591d5ab33 | 10 | * Copyright (c) 2006-2013 ARM Limited |
be_bryan | 0:b74591d5ab33 | 11 | * |
be_bryan | 0:b74591d5ab33 | 12 | * Licensed under the Apache License, Version 2.0 (the "License"); |
be_bryan | 0:b74591d5ab33 | 13 | * you may not use this file except in compliance with the License. |
be_bryan | 0:b74591d5ab33 | 14 | * You may obtain a copy of the License at |
be_bryan | 0:b74591d5ab33 | 15 | * |
be_bryan | 0:b74591d5ab33 | 16 | * http://www.apache.org/licenses/LICENSE-2.0 |
be_bryan | 0:b74591d5ab33 | 17 | * |
be_bryan | 0:b74591d5ab33 | 18 | * Unless required by applicable law or agreed to in writing, software |
be_bryan | 0:b74591d5ab33 | 19 | * distributed under the License is distributed on an "AS IS" BASIS, |
be_bryan | 0:b74591d5ab33 | 20 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
be_bryan | 0:b74591d5ab33 | 21 | * See the License for the specific language governing permissions and |
be_bryan | 0:b74591d5ab33 | 22 | * limitations under the License. |
be_bryan | 0:b74591d5ab33 | 23 | */ |
be_bryan | 0:b74591d5ab33 | 24 | #ifndef MBED_TOOLCHAIN_H |
be_bryan | 0:b74591d5ab33 | 25 | #define MBED_TOOLCHAIN_H |
be_bryan | 0:b74591d5ab33 | 26 | |
be_bryan | 0:b74591d5ab33 | 27 | #include "mbed_preprocessor.h" |
be_bryan | 0:b74591d5ab33 | 28 | |
be_bryan | 0:b74591d5ab33 | 29 | |
be_bryan | 0:b74591d5ab33 | 30 | // Warning for unsupported compilers |
be_bryan | 0:b74591d5ab33 | 31 | #if !defined(__GNUC__) /* GCC */ \ |
be_bryan | 0:b74591d5ab33 | 32 | && !defined(__CC_ARM) /* ARMCC */ \ |
be_bryan | 0:b74591d5ab33 | 33 | && !defined(__clang__) /* LLVM/Clang */ \ |
be_bryan | 0:b74591d5ab33 | 34 | && !defined(__ICCARM__) /* IAR */ |
be_bryan | 0:b74591d5ab33 | 35 | #warning "This compiler is not yet supported." |
be_bryan | 0:b74591d5ab33 | 36 | #endif |
be_bryan | 0:b74591d5ab33 | 37 | |
be_bryan | 0:b74591d5ab33 | 38 | |
be_bryan | 0:b74591d5ab33 | 39 | // Attributes |
be_bryan | 0:b74591d5ab33 | 40 | |
be_bryan | 0:b74591d5ab33 | 41 | /** MBED_PACKED |
be_bryan | 0:b74591d5ab33 | 42 | * Pack a structure, preventing any padding from being added between fields. |
be_bryan | 0:b74591d5ab33 | 43 | * |
be_bryan | 0:b74591d5ab33 | 44 | * @code |
be_bryan | 0:b74591d5ab33 | 45 | * #include "mbed_toolchain.h" |
be_bryan | 0:b74591d5ab33 | 46 | * |
be_bryan | 0:b74591d5ab33 | 47 | * MBED_PACKED(struct) foo { |
be_bryan | 0:b74591d5ab33 | 48 | * char x; |
be_bryan | 0:b74591d5ab33 | 49 | * int y; |
be_bryan | 0:b74591d5ab33 | 50 | * }; |
be_bryan | 0:b74591d5ab33 | 51 | * @endcode |
be_bryan | 0:b74591d5ab33 | 52 | */ |
be_bryan | 0:b74591d5ab33 | 53 | #ifndef MBED_PACKED |
be_bryan | 0:b74591d5ab33 | 54 | #if defined(__ICCARM__) |
be_bryan | 0:b74591d5ab33 | 55 | #define MBED_PACKED(struct) __packed struct |
be_bryan | 0:b74591d5ab33 | 56 | #else |
be_bryan | 0:b74591d5ab33 | 57 | #define MBED_PACKED(struct) struct __attribute__((packed)) |
be_bryan | 0:b74591d5ab33 | 58 | #endif |
be_bryan | 0:b74591d5ab33 | 59 | #endif |
be_bryan | 0:b74591d5ab33 | 60 | |
be_bryan | 0:b74591d5ab33 | 61 | /** MBED_ALIGN(N) |
be_bryan | 0:b74591d5ab33 | 62 | * Declare a variable to be aligned on an N-byte boundary. |
be_bryan | 0:b74591d5ab33 | 63 | * |
be_bryan | 0:b74591d5ab33 | 64 | * @note |
be_bryan | 0:b74591d5ab33 | 65 | * IAR does not support alignment greater than word size on the stack |
be_bryan | 0:b74591d5ab33 | 66 | * |
be_bryan | 0:b74591d5ab33 | 67 | * @code |
be_bryan | 0:b74591d5ab33 | 68 | * #include "mbed_toolchain.h" |
be_bryan | 0:b74591d5ab33 | 69 | * |
be_bryan | 0:b74591d5ab33 | 70 | * MBED_ALIGN(16) char a; |
be_bryan | 0:b74591d5ab33 | 71 | * @endcode |
be_bryan | 0:b74591d5ab33 | 72 | */ |
be_bryan | 0:b74591d5ab33 | 73 | #ifndef MBED_ALIGN |
be_bryan | 0:b74591d5ab33 | 74 | #if defined(__ICCARM__) |
be_bryan | 0:b74591d5ab33 | 75 | #define MBED_ALIGN(N) _Pragma(MBED_STRINGIFY(data_alignment=N)) |
be_bryan | 0:b74591d5ab33 | 76 | #else |
be_bryan | 0:b74591d5ab33 | 77 | #define MBED_ALIGN(N) __attribute__((aligned(N))) |
be_bryan | 0:b74591d5ab33 | 78 | #endif |
be_bryan | 0:b74591d5ab33 | 79 | #endif |
be_bryan | 0:b74591d5ab33 | 80 | |
be_bryan | 0:b74591d5ab33 | 81 | /** MBED_UNUSED |
be_bryan | 0:b74591d5ab33 | 82 | * Declare a function argument to be unused, suppressing compiler warnings |
be_bryan | 0:b74591d5ab33 | 83 | * |
be_bryan | 0:b74591d5ab33 | 84 | * @code |
be_bryan | 0:b74591d5ab33 | 85 | * #include "mbed_toolchain.h" |
be_bryan | 0:b74591d5ab33 | 86 | * |
be_bryan | 0:b74591d5ab33 | 87 | * void foo(MBED_UNUSED int arg) { |
be_bryan | 0:b74591d5ab33 | 88 | * |
be_bryan | 0:b74591d5ab33 | 89 | * } |
be_bryan | 0:b74591d5ab33 | 90 | * @endcode |
be_bryan | 0:b74591d5ab33 | 91 | */ |
be_bryan | 0:b74591d5ab33 | 92 | #ifndef MBED_UNUSED |
be_bryan | 0:b74591d5ab33 | 93 | #if defined(__GNUC__) || defined(__clang__) || defined(__CC_ARM) |
be_bryan | 0:b74591d5ab33 | 94 | #define MBED_UNUSED __attribute__((__unused__)) |
be_bryan | 0:b74591d5ab33 | 95 | #else |
be_bryan | 0:b74591d5ab33 | 96 | #define MBED_UNUSED |
be_bryan | 0:b74591d5ab33 | 97 | #endif |
be_bryan | 0:b74591d5ab33 | 98 | #endif |
be_bryan | 0:b74591d5ab33 | 99 | |
be_bryan | 0:b74591d5ab33 | 100 | /** MBED_USED |
be_bryan | 0:b74591d5ab33 | 101 | * Inform the compiler that a static variable is to be retained in the object file, even if it is unreferenced. |
be_bryan | 0:b74591d5ab33 | 102 | * |
be_bryan | 0:b74591d5ab33 | 103 | * @code |
be_bryan | 0:b74591d5ab33 | 104 | * #include "mbed_toolchain.h" |
be_bryan | 0:b74591d5ab33 | 105 | * |
be_bryan | 0:b74591d5ab33 | 106 | * MBED_USED int foo; |
be_bryan | 0:b74591d5ab33 | 107 | * |
be_bryan | 0:b74591d5ab33 | 108 | * @endcode |
be_bryan | 0:b74591d5ab33 | 109 | */ |
be_bryan | 0:b74591d5ab33 | 110 | #ifndef MBED_USED |
be_bryan | 0:b74591d5ab33 | 111 | #if defined(__GNUC__) || defined(__clang__) || defined(__CC_ARM) |
be_bryan | 0:b74591d5ab33 | 112 | #define MBED_USED __attribute__((used)) |
be_bryan | 0:b74591d5ab33 | 113 | #elif defined(__ICCARM__) |
be_bryan | 0:b74591d5ab33 | 114 | #define MBED_USED __root |
be_bryan | 0:b74591d5ab33 | 115 | #else |
be_bryan | 0:b74591d5ab33 | 116 | #define MBED_USED |
be_bryan | 0:b74591d5ab33 | 117 | #endif |
be_bryan | 0:b74591d5ab33 | 118 | #endif |
be_bryan | 0:b74591d5ab33 | 119 | |
be_bryan | 0:b74591d5ab33 | 120 | /** MBED_WEAK |
be_bryan | 0:b74591d5ab33 | 121 | * Mark a function as being weak. |
be_bryan | 0:b74591d5ab33 | 122 | * |
be_bryan | 0:b74591d5ab33 | 123 | * @note |
be_bryan | 0:b74591d5ab33 | 124 | * Functions should only be marked as weak in the source file. The header file |
be_bryan | 0:b74591d5ab33 | 125 | * should contain a regular function declaration to insure the function is emitted. |
be_bryan | 0:b74591d5ab33 | 126 | * A function marked weak will not be emitted if an alternative non-weak |
be_bryan | 0:b74591d5ab33 | 127 | * implementation is defined. |
be_bryan | 0:b74591d5ab33 | 128 | * |
be_bryan | 0:b74591d5ab33 | 129 | * @note |
be_bryan | 0:b74591d5ab33 | 130 | * Weak functions are not friendly to making code re-usable, as they can only |
be_bryan | 0:b74591d5ab33 | 131 | * be overridden once (and if they are multiply overridden the linker will emit |
be_bryan | 0:b74591d5ab33 | 132 | * no warning). You should not normally use weak symbols as part of the API to |
be_bryan | 0:b74591d5ab33 | 133 | * re-usable modules. |
be_bryan | 0:b74591d5ab33 | 134 | * |
be_bryan | 0:b74591d5ab33 | 135 | * @code |
be_bryan | 0:b74591d5ab33 | 136 | * #include "mbed_toolchain.h" |
be_bryan | 0:b74591d5ab33 | 137 | * |
be_bryan | 0:b74591d5ab33 | 138 | * MBED_WEAK void foo() { |
be_bryan | 0:b74591d5ab33 | 139 | * // a weak implementation of foo that can be overriden by a definition |
be_bryan | 0:b74591d5ab33 | 140 | * // without __weak |
be_bryan | 0:b74591d5ab33 | 141 | * } |
be_bryan | 0:b74591d5ab33 | 142 | * @endcode |
be_bryan | 0:b74591d5ab33 | 143 | */ |
be_bryan | 0:b74591d5ab33 | 144 | #ifndef MBED_WEAK |
be_bryan | 0:b74591d5ab33 | 145 | #if defined(__ICCARM__) |
be_bryan | 0:b74591d5ab33 | 146 | #define MBED_WEAK __weak |
be_bryan | 0:b74591d5ab33 | 147 | #else |
be_bryan | 0:b74591d5ab33 | 148 | #define MBED_WEAK __attribute__((weak)) |
be_bryan | 0:b74591d5ab33 | 149 | #endif |
be_bryan | 0:b74591d5ab33 | 150 | #endif |
be_bryan | 0:b74591d5ab33 | 151 | |
be_bryan | 0:b74591d5ab33 | 152 | /** MBED_PURE |
be_bryan | 0:b74591d5ab33 | 153 | * Hint to the compiler that a function depends only on parameters |
be_bryan | 0:b74591d5ab33 | 154 | * |
be_bryan | 0:b74591d5ab33 | 155 | * @code |
be_bryan | 0:b74591d5ab33 | 156 | * #include "mbed_toolchain.h" |
be_bryan | 0:b74591d5ab33 | 157 | * |
be_bryan | 0:b74591d5ab33 | 158 | * MBED_PURE int foo(int arg){ |
be_bryan | 0:b74591d5ab33 | 159 | * // no access to global variables |
be_bryan | 0:b74591d5ab33 | 160 | * } |
be_bryan | 0:b74591d5ab33 | 161 | * @endcode |
be_bryan | 0:b74591d5ab33 | 162 | */ |
be_bryan | 0:b74591d5ab33 | 163 | #ifndef MBED_PURE |
be_bryan | 0:b74591d5ab33 | 164 | #if defined(__GNUC__) || defined(__clang__) || defined(__CC_ARM) |
be_bryan | 0:b74591d5ab33 | 165 | #define MBED_PURE __attribute__((const)) |
be_bryan | 0:b74591d5ab33 | 166 | #else |
be_bryan | 0:b74591d5ab33 | 167 | #define MBED_PURE |
be_bryan | 0:b74591d5ab33 | 168 | #endif |
be_bryan | 0:b74591d5ab33 | 169 | #endif |
be_bryan | 0:b74591d5ab33 | 170 | |
be_bryan | 0:b74591d5ab33 | 171 | /** MBED_NOINLINE |
be_bryan | 0:b74591d5ab33 | 172 | * Declare a function that must not be inlined. |
be_bryan | 0:b74591d5ab33 | 173 | * |
be_bryan | 0:b74591d5ab33 | 174 | * @code |
be_bryan | 0:b74591d5ab33 | 175 | * #include "mbed_toolchain.h" |
be_bryan | 0:b74591d5ab33 | 176 | * |
be_bryan | 0:b74591d5ab33 | 177 | * MBED_NOINLINE void foo() { |
be_bryan | 0:b74591d5ab33 | 178 | * |
be_bryan | 0:b74591d5ab33 | 179 | * } |
be_bryan | 0:b74591d5ab33 | 180 | * @endcode |
be_bryan | 0:b74591d5ab33 | 181 | */ |
be_bryan | 0:b74591d5ab33 | 182 | #ifndef MBED_NOINLINE |
be_bryan | 0:b74591d5ab33 | 183 | #if defined(__GNUC__) || defined(__clang__) || defined(__CC_ARM) |
be_bryan | 0:b74591d5ab33 | 184 | #define MBED_NOINLINE __attribute__((noinline)) |
be_bryan | 0:b74591d5ab33 | 185 | #elif defined(__ICCARM__) |
be_bryan | 0:b74591d5ab33 | 186 | #define MBED_NOINLINE _Pragma("inline=never") |
be_bryan | 0:b74591d5ab33 | 187 | #else |
be_bryan | 0:b74591d5ab33 | 188 | #define MBED_NOINLINE |
be_bryan | 0:b74591d5ab33 | 189 | #endif |
be_bryan | 0:b74591d5ab33 | 190 | #endif |
be_bryan | 0:b74591d5ab33 | 191 | |
be_bryan | 0:b74591d5ab33 | 192 | /** MBED_FORCEINLINE |
be_bryan | 0:b74591d5ab33 | 193 | * Declare a function that must always be inlined. Failure to inline |
be_bryan | 0:b74591d5ab33 | 194 | * such a function will result in an error. |
be_bryan | 0:b74591d5ab33 | 195 | * |
be_bryan | 0:b74591d5ab33 | 196 | * @code |
be_bryan | 0:b74591d5ab33 | 197 | * #include "mbed_toolchain.h" |
be_bryan | 0:b74591d5ab33 | 198 | * |
be_bryan | 0:b74591d5ab33 | 199 | * MBED_FORCEINLINE void foo() { |
be_bryan | 0:b74591d5ab33 | 200 | * |
be_bryan | 0:b74591d5ab33 | 201 | * } |
be_bryan | 0:b74591d5ab33 | 202 | * @endcode |
be_bryan | 0:b74591d5ab33 | 203 | */ |
be_bryan | 0:b74591d5ab33 | 204 | #ifndef MBED_FORCEINLINE |
be_bryan | 0:b74591d5ab33 | 205 | #if defined(__GNUC__) || defined(__clang__) || defined(__CC_ARM) |
be_bryan | 0:b74591d5ab33 | 206 | #define MBED_FORCEINLINE static inline __attribute__((always_inline)) |
be_bryan | 0:b74591d5ab33 | 207 | #elif defined(__ICCARM__) |
be_bryan | 0:b74591d5ab33 | 208 | #define MBED_FORCEINLINE _Pragma("inline=forced") static |
be_bryan | 0:b74591d5ab33 | 209 | #else |
be_bryan | 0:b74591d5ab33 | 210 | #define MBED_FORCEINLINE static inline |
be_bryan | 0:b74591d5ab33 | 211 | #endif |
be_bryan | 0:b74591d5ab33 | 212 | #endif |
be_bryan | 0:b74591d5ab33 | 213 | |
be_bryan | 0:b74591d5ab33 | 214 | /** MBED_NORETURN |
be_bryan | 0:b74591d5ab33 | 215 | * Declare a function that will never return. |
be_bryan | 0:b74591d5ab33 | 216 | * |
be_bryan | 0:b74591d5ab33 | 217 | * @code |
be_bryan | 0:b74591d5ab33 | 218 | * #include "mbed_toolchain.h" |
be_bryan | 0:b74591d5ab33 | 219 | * |
be_bryan | 0:b74591d5ab33 | 220 | * MBED_NORETURN void foo() { |
be_bryan | 0:b74591d5ab33 | 221 | * // must never return |
be_bryan | 0:b74591d5ab33 | 222 | * while (1) {} |
be_bryan | 0:b74591d5ab33 | 223 | * } |
be_bryan | 0:b74591d5ab33 | 224 | * @endcode |
be_bryan | 0:b74591d5ab33 | 225 | */ |
be_bryan | 0:b74591d5ab33 | 226 | #ifndef MBED_NORETURN |
be_bryan | 0:b74591d5ab33 | 227 | #if defined(__GNUC__) || defined(__clang__) || defined(__CC_ARM) |
be_bryan | 0:b74591d5ab33 | 228 | #define MBED_NORETURN __attribute__((noreturn)) |
be_bryan | 0:b74591d5ab33 | 229 | #elif defined(__ICCARM__) |
be_bryan | 0:b74591d5ab33 | 230 | #define MBED_NORETURN __noreturn |
be_bryan | 0:b74591d5ab33 | 231 | #else |
be_bryan | 0:b74591d5ab33 | 232 | #define MBED_NORETURN |
be_bryan | 0:b74591d5ab33 | 233 | #endif |
be_bryan | 0:b74591d5ab33 | 234 | #endif |
be_bryan | 0:b74591d5ab33 | 235 | |
be_bryan | 0:b74591d5ab33 | 236 | /** MBED_UNREACHABLE |
be_bryan | 0:b74591d5ab33 | 237 | * An unreachable statement. If the statement is reached, |
be_bryan | 0:b74591d5ab33 | 238 | * behaviour is undefined. Useful in situations where the compiler |
be_bryan | 0:b74591d5ab33 | 239 | * cannot deduce the unreachability of code. |
be_bryan | 0:b74591d5ab33 | 240 | * |
be_bryan | 0:b74591d5ab33 | 241 | * @code |
be_bryan | 0:b74591d5ab33 | 242 | * #include "mbed_toolchain.h" |
be_bryan | 0:b74591d5ab33 | 243 | * |
be_bryan | 0:b74591d5ab33 | 244 | * void foo(int arg) { |
be_bryan | 0:b74591d5ab33 | 245 | * switch (arg) { |
be_bryan | 0:b74591d5ab33 | 246 | * case 1: return 1; |
be_bryan | 0:b74591d5ab33 | 247 | * case 2: return 2; |
be_bryan | 0:b74591d5ab33 | 248 | * ... |
be_bryan | 0:b74591d5ab33 | 249 | * } |
be_bryan | 0:b74591d5ab33 | 250 | * MBED_UNREACHABLE; |
be_bryan | 0:b74591d5ab33 | 251 | * } |
be_bryan | 0:b74591d5ab33 | 252 | * @endcode |
be_bryan | 0:b74591d5ab33 | 253 | */ |
be_bryan | 0:b74591d5ab33 | 254 | #ifndef MBED_UNREACHABLE |
be_bryan | 0:b74591d5ab33 | 255 | #if (defined(__GNUC__) || defined(__clang__)) && !defined(__CC_ARM) |
be_bryan | 0:b74591d5ab33 | 256 | #define MBED_UNREACHABLE __builtin_unreachable() |
be_bryan | 0:b74591d5ab33 | 257 | #else |
be_bryan | 0:b74591d5ab33 | 258 | #define MBED_UNREACHABLE while (1) |
be_bryan | 0:b74591d5ab33 | 259 | #endif |
be_bryan | 0:b74591d5ab33 | 260 | #endif |
be_bryan | 0:b74591d5ab33 | 261 | |
be_bryan | 0:b74591d5ab33 | 262 | /** MBED_DEPRECATED("message string") |
be_bryan | 0:b74591d5ab33 | 263 | * Mark a function declaration as deprecated, if it used then a warning will be |
be_bryan | 0:b74591d5ab33 | 264 | * issued by the compiler possibly including the provided message. Note that not |
be_bryan | 0:b74591d5ab33 | 265 | * all compilers are able to display the message. |
be_bryan | 0:b74591d5ab33 | 266 | * |
be_bryan | 0:b74591d5ab33 | 267 | * @code |
be_bryan | 0:b74591d5ab33 | 268 | * #include "mbed_toolchain.h" |
be_bryan | 0:b74591d5ab33 | 269 | * |
be_bryan | 0:b74591d5ab33 | 270 | * MBED_DEPRECATED("don't foo any more, bar instead") |
be_bryan | 0:b74591d5ab33 | 271 | * void foo(int arg); |
be_bryan | 0:b74591d5ab33 | 272 | * @endcode |
be_bryan | 0:b74591d5ab33 | 273 | */ |
be_bryan | 0:b74591d5ab33 | 274 | #ifndef MBED_DEPRECATED |
be_bryan | 0:b74591d5ab33 | 275 | #if defined(__CC_ARM) |
be_bryan | 0:b74591d5ab33 | 276 | #define MBED_DEPRECATED(M) __attribute__((deprecated)) |
be_bryan | 0:b74591d5ab33 | 277 | #elif defined(__GNUC__) || defined(__clang__) |
be_bryan | 0:b74591d5ab33 | 278 | #define MBED_DEPRECATED(M) __attribute__((deprecated(M))) |
be_bryan | 0:b74591d5ab33 | 279 | #else |
be_bryan | 0:b74591d5ab33 | 280 | #define MBED_DEPRECATED(M) |
be_bryan | 0:b74591d5ab33 | 281 | #endif |
be_bryan | 0:b74591d5ab33 | 282 | #endif |
be_bryan | 0:b74591d5ab33 | 283 | |
be_bryan | 0:b74591d5ab33 | 284 | /** MBED_DEPRECATED_SINCE("version", "message string") |
be_bryan | 0:b74591d5ab33 | 285 | * Mark a function declaration as deprecated, noting that the declaration was |
be_bryan | 0:b74591d5ab33 | 286 | * deprecated on the specified version. If the function is used then a warning |
be_bryan | 0:b74591d5ab33 | 287 | * will be issued by the compiler possibly including the provided message. |
be_bryan | 0:b74591d5ab33 | 288 | * Note that not all compilers are able to display this message. |
be_bryan | 0:b74591d5ab33 | 289 | * |
be_bryan | 0:b74591d5ab33 | 290 | * @code |
be_bryan | 0:b74591d5ab33 | 291 | * #include "mbed_toolchain.h" |
be_bryan | 0:b74591d5ab33 | 292 | * |
be_bryan | 0:b74591d5ab33 | 293 | * MBED_DEPRECATED_SINCE("mbed-os-5.1", "don't foo any more, bar instead") |
be_bryan | 0:b74591d5ab33 | 294 | * void foo(int arg); |
be_bryan | 0:b74591d5ab33 | 295 | * @endcode |
be_bryan | 0:b74591d5ab33 | 296 | */ |
be_bryan | 0:b74591d5ab33 | 297 | #define MBED_DEPRECATED_SINCE(D, M) MBED_DEPRECATED(M " [since " D "]") |
be_bryan | 0:b74591d5ab33 | 298 | |
be_bryan | 0:b74591d5ab33 | 299 | /** MBED_CALLER_ADDR() |
be_bryan | 0:b74591d5ab33 | 300 | * Returns the caller of the current function. |
be_bryan | 0:b74591d5ab33 | 301 | * |
be_bryan | 0:b74591d5ab33 | 302 | * @note |
be_bryan | 0:b74591d5ab33 | 303 | * This macro is only implemented for GCC and ARMCC. |
be_bryan | 0:b74591d5ab33 | 304 | * |
be_bryan | 0:b74591d5ab33 | 305 | * @code |
be_bryan | 0:b74591d5ab33 | 306 | * #include "mbed_toolchain.h" |
be_bryan | 0:b74591d5ab33 | 307 | * |
be_bryan | 0:b74591d5ab33 | 308 | * printf("This function was called from %p", MBED_CALLER_ADDR()); |
be_bryan | 0:b74591d5ab33 | 309 | * @endcode |
be_bryan | 0:b74591d5ab33 | 310 | * |
be_bryan | 0:b74591d5ab33 | 311 | * @return Address of the calling function |
be_bryan | 0:b74591d5ab33 | 312 | */ |
be_bryan | 0:b74591d5ab33 | 313 | #ifndef MBED_CALLER_ADDR |
be_bryan | 0:b74591d5ab33 | 314 | #if (defined(__GNUC__) || defined(__clang__)) && !defined(__CC_ARM) |
be_bryan | 0:b74591d5ab33 | 315 | #define MBED_CALLER_ADDR() __builtin_extract_return_addr(__builtin_return_address(0)) |
be_bryan | 0:b74591d5ab33 | 316 | #elif defined(__CC_ARM) |
be_bryan | 0:b74591d5ab33 | 317 | #define MBED_CALLER_ADDR() __builtin_return_address(0) |
be_bryan | 0:b74591d5ab33 | 318 | #else |
be_bryan | 0:b74591d5ab33 | 319 | #define MBED_CALLER_ADDR() (NULL) |
be_bryan | 0:b74591d5ab33 | 320 | #endif |
be_bryan | 0:b74591d5ab33 | 321 | #endif |
be_bryan | 0:b74591d5ab33 | 322 | |
be_bryan | 0:b74591d5ab33 | 323 | #ifndef MBED_SECTION |
be_bryan | 0:b74591d5ab33 | 324 | #if (defined(__GNUC__) || defined(__clang__)) || defined(__CC_ARM) |
be_bryan | 0:b74591d5ab33 | 325 | #define MBED_SECTION(name) __attribute__ ((section (name))) |
be_bryan | 0:b74591d5ab33 | 326 | #elif defined(__ICCARM__) |
be_bryan | 0:b74591d5ab33 | 327 | #define MBED_SECTION(name) _Pragma(MBED_STRINGIFY(location=name)) |
be_bryan | 0:b74591d5ab33 | 328 | #else |
be_bryan | 0:b74591d5ab33 | 329 | #error "Missing MBED_SECTION directive" |
be_bryan | 0:b74591d5ab33 | 330 | #endif |
be_bryan | 0:b74591d5ab33 | 331 | #endif |
be_bryan | 0:b74591d5ab33 | 332 | |
be_bryan | 0:b74591d5ab33 | 333 | /** |
be_bryan | 0:b74591d5ab33 | 334 | * Macro expanding to a string literal of the enclosing function name. |
be_bryan | 0:b74591d5ab33 | 335 | * |
be_bryan | 0:b74591d5ab33 | 336 | * The string returned takes into account language specificity and yield human |
be_bryan | 0:b74591d5ab33 | 337 | * readable content. |
be_bryan | 0:b74591d5ab33 | 338 | * |
be_bryan | 0:b74591d5ab33 | 339 | * As an example, if the macro is used within a C++ function then the string |
be_bryan | 0:b74591d5ab33 | 340 | * literal containing the function name will contain the complete signature of |
be_bryan | 0:b74591d5ab33 | 341 | * the function - including template parameters - and namespace qualifications. |
be_bryan | 0:b74591d5ab33 | 342 | */ |
be_bryan | 0:b74591d5ab33 | 343 | #ifndef MBED_PRETTY_FUNCTION |
be_bryan | 0:b74591d5ab33 | 344 | #define MBED_PRETTY_FUNCTION __PRETTY_FUNCTION__ |
be_bryan | 0:b74591d5ab33 | 345 | #endif |
be_bryan | 0:b74591d5ab33 | 346 | |
be_bryan | 0:b74591d5ab33 | 347 | #ifndef MBED_PRINTF |
be_bryan | 0:b74591d5ab33 | 348 | #if defined(__GNUC__) || defined(__CC_ARM) |
be_bryan | 0:b74591d5ab33 | 349 | #define MBED_PRINTF(format_idx, first_param_idx) __attribute__ ((__format__(__printf__, format_idx, first_param_idx))) |
be_bryan | 0:b74591d5ab33 | 350 | #else |
be_bryan | 0:b74591d5ab33 | 351 | #define MBED_PRINTF(format_idx, first_param_idx) |
be_bryan | 0:b74591d5ab33 | 352 | #endif |
be_bryan | 0:b74591d5ab33 | 353 | #endif |
be_bryan | 0:b74591d5ab33 | 354 | |
be_bryan | 0:b74591d5ab33 | 355 | #ifndef MBED_PRINTF_METHOD |
be_bryan | 0:b74591d5ab33 | 356 | #if defined(__GNUC__) || defined(__CC_ARM) |
be_bryan | 0:b74591d5ab33 | 357 | #define MBED_PRINTF_METHOD(format_idx, first_param_idx) __attribute__ ((__format__(__printf__, format_idx+1, first_param_idx+1))) |
be_bryan | 0:b74591d5ab33 | 358 | #else |
be_bryan | 0:b74591d5ab33 | 359 | #define MBED_PRINTF_METHOD(format_idx, first_param_idx) |
be_bryan | 0:b74591d5ab33 | 360 | #endif |
be_bryan | 0:b74591d5ab33 | 361 | #endif |
be_bryan | 0:b74591d5ab33 | 362 | |
be_bryan | 0:b74591d5ab33 | 363 | #ifndef MBED_SCANF |
be_bryan | 0:b74591d5ab33 | 364 | #if defined(__GNUC__) || defined(__CC_ARM) |
be_bryan | 0:b74591d5ab33 | 365 | #define MBED_SCANF(format_idx, first_param_idx) __attribute__ ((__format__(__scanf__, format_idx, first_param_idx))) |
be_bryan | 0:b74591d5ab33 | 366 | #else |
be_bryan | 0:b74591d5ab33 | 367 | #define MBED_SCANF(format_idx, first_param_idx) |
be_bryan | 0:b74591d5ab33 | 368 | #endif |
be_bryan | 0:b74591d5ab33 | 369 | #endif |
be_bryan | 0:b74591d5ab33 | 370 | |
be_bryan | 0:b74591d5ab33 | 371 | #ifndef MBED_SCANF_METHOD |
be_bryan | 0:b74591d5ab33 | 372 | #if defined(__GNUC__) || defined(__CC_ARM) |
be_bryan | 0:b74591d5ab33 | 373 | #define MBED_SCANF_METHOD(format_idx, first_param_idx) __attribute__ ((__format__(__scanf__, format_idx+1, first_param_idx+1))) |
be_bryan | 0:b74591d5ab33 | 374 | #else |
be_bryan | 0:b74591d5ab33 | 375 | #define MBED_SCANF_METHOD(format_idx, first_param_idx) |
be_bryan | 0:b74591d5ab33 | 376 | #endif |
be_bryan | 0:b74591d5ab33 | 377 | #endif |
be_bryan | 0:b74591d5ab33 | 378 | |
be_bryan | 0:b74591d5ab33 | 379 | // FILEHANDLE declaration |
be_bryan | 0:b74591d5ab33 | 380 | #if defined(TOOLCHAIN_ARM) |
be_bryan | 0:b74591d5ab33 | 381 | #include <rt_sys.h> |
be_bryan | 0:b74591d5ab33 | 382 | #endif |
be_bryan | 0:b74591d5ab33 | 383 | |
be_bryan | 0:b74591d5ab33 | 384 | #ifndef FILEHANDLE |
be_bryan | 0:b74591d5ab33 | 385 | typedef int FILEHANDLE; |
be_bryan | 0:b74591d5ab33 | 386 | #endif |
be_bryan | 0:b74591d5ab33 | 387 | |
be_bryan | 0:b74591d5ab33 | 388 | // Backwards compatibility |
be_bryan | 0:b74591d5ab33 | 389 | #ifndef WEAK |
be_bryan | 0:b74591d5ab33 | 390 | #define WEAK MBED_WEAK |
be_bryan | 0:b74591d5ab33 | 391 | #endif |
be_bryan | 0:b74591d5ab33 | 392 | |
be_bryan | 0:b74591d5ab33 | 393 | #ifndef PACKED |
be_bryan | 0:b74591d5ab33 | 394 | #define PACKED MBED_PACKED() |
be_bryan | 0:b74591d5ab33 | 395 | #endif |
be_bryan | 0:b74591d5ab33 | 396 | |
be_bryan | 0:b74591d5ab33 | 397 | #ifndef EXTERN |
be_bryan | 0:b74591d5ab33 | 398 | #define EXTERN extern |
be_bryan | 0:b74591d5ab33 | 399 | #endif |
be_bryan | 0:b74591d5ab33 | 400 | |
be_bryan | 0:b74591d5ab33 | 401 | #endif |
be_bryan | 0:b74591d5ab33 | 402 | |
be_bryan | 0:b74591d5ab33 | 403 | /** @}*/ |
be_bryan | 0:b74591d5ab33 | 404 | /** @}*/ |