ST / ST_Events-old

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   HelloWorld_CCA01M1 HelloWorld_CCA02M1 CI-data-logger-server HelloWorld_CCA02M1 ... more

This is a fork of the events subdirectory of https://github.com/ARMmbed/mbed-os.

Note, you must import this library with import name: events!!!

hal/api/toolchain.h@7482:a3c8ec7eba46, 2016-08-08 (annotated)

Committer:
Christopher Haster
Date:
Mon Aug 08 17:12:48 2016 -0500
Revision:
7482:a3c8ec7eba46
Parent:
6375:81a9af277ac6
Child:
7486:e02c89fc45ad
Added more well-defined garuntees on deprecation notices in mbed



From the discussion on issue #2068:

Functions marked deprecated in the mbed library should notate when

the deprecation was started to allow efficient removal once a set

amount of time has expired.



Added the following macro:

MBED_DEPRECATED_SINCE("version", "message string")



Example usage:



    MBED_DEPRECATED_SINCE("v5.1", "don't foo any more, bar instead")

    void foo(int arg);



Adopted in existing deprecations:

- FunctionPointer

- RtosTimer

- Thread

Who changed what in which revision?

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