mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_SDT32620B/TOOLCHAIN_ARM_STD/mxc_assert.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 167:84c0a372a020 1 /**
AnnaBridge 167:84c0a372a020 2 * @file
AnnaBridge 167:84c0a372a020 3 * @brief Assertion checks for debugging.
AnnaBridge 167:84c0a372a020 4 */
AnnaBridge 167:84c0a372a020 5 /* ****************************************************************************
AnnaBridge 167:84c0a372a020 6 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
AnnaBridge 167:84c0a372a020 7 *
AnnaBridge 167:84c0a372a020 8 * Permission is hereby granted, free of charge, to any person obtaining a
AnnaBridge 167:84c0a372a020 9 * copy of this software and associated documentation files (the "Software"),
AnnaBridge 167:84c0a372a020 10 * to deal in the Software without restriction, including without limitation
AnnaBridge 167:84c0a372a020 11 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
AnnaBridge 167:84c0a372a020 12 * and/or sell copies of the Software, and to permit persons to whom the
AnnaBridge 167:84c0a372a020 13 * Software is furnished to do so, subject to the following conditions:
AnnaBridge 167:84c0a372a020 14 *
AnnaBridge 167:84c0a372a020 15 * The above copyright notice and this permission notice shall be included
AnnaBridge 167:84c0a372a020 16 * in all copies or substantial portions of the Software.
AnnaBridge 167:84c0a372a020 17 *
AnnaBridge 167:84c0a372a020 18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
AnnaBridge 167:84c0a372a020 19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
AnnaBridge 167:84c0a372a020 20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
AnnaBridge 167:84c0a372a020 21 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
AnnaBridge 167:84c0a372a020 22 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
AnnaBridge 167:84c0a372a020 23 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
AnnaBridge 167:84c0a372a020 24 * OTHER DEALINGS IN THE SOFTWARE.
AnnaBridge 167:84c0a372a020 25 *
AnnaBridge 167:84c0a372a020 26 * Except as contained in this notice, the name of Maxim Integrated
AnnaBridge 167:84c0a372a020 27 * Products, Inc. shall not be used except as stated in the Maxim Integrated
AnnaBridge 167:84c0a372a020 28 * Products, Inc. Branding Policy.
AnnaBridge 167:84c0a372a020 29 *
AnnaBridge 167:84c0a372a020 30 * The mere transfer of this software does not imply any licenses
AnnaBridge 167:84c0a372a020 31 * of trade secrets, proprietary technology, copyrights, patents,
AnnaBridge 167:84c0a372a020 32 * trademarks, maskwork rights, or any other form of intellectual
AnnaBridge 167:84c0a372a020 33 * property whatsoever. Maxim Integrated Products, Inc. retains all
AnnaBridge 167:84c0a372a020 34 * ownership rights.
AnnaBridge 167:84c0a372a020 35 *
AnnaBridge 167:84c0a372a020 36 *
AnnaBridge 167:84c0a372a020 37 * $Date: 2017-02-16 13:35:22 -0600 (Thu, 16 Feb 2017) $
AnnaBridge 167:84c0a372a020 38 * $Revision: 26485 $
AnnaBridge 167:84c0a372a020 39 *
AnnaBridge 167:84c0a372a020 40 *************************************************************************** */
AnnaBridge 167:84c0a372a020 41
AnnaBridge 167:84c0a372a020 42 /* Define to prevent redundant inclusion */
AnnaBridge 167:84c0a372a020 43 #ifndef _MXC_ASSERT_H_
AnnaBridge 167:84c0a372a020 44 #define _MXC_ASSERT_H_
AnnaBridge 167:84c0a372a020 45
AnnaBridge 167:84c0a372a020 46 /* **** Includes **** */
AnnaBridge 167:84c0a372a020 47
AnnaBridge 167:84c0a372a020 48
AnnaBridge 167:84c0a372a020 49 #ifdef __cplusplus
AnnaBridge 167:84c0a372a020 50 extern "C" {
AnnaBridge 167:84c0a372a020 51 #endif
AnnaBridge 167:84c0a372a020 52
AnnaBridge 167:84c0a372a020 53 /**
AnnaBridge 167:84c0a372a020 54 * @ingroup syscfg
AnnaBridge 167:84c0a372a020 55 * @defgroup mxc_assertions Assertion Checks for Debugging
AnnaBridge 167:84c0a372a020 56 * @brief Assertion checks for debugging.
AnnaBridge 167:84c0a372a020 57 * @{
AnnaBridge 167:84c0a372a020 58 */
AnnaBridge 167:84c0a372a020 59 /* **** Definitions **** */
AnnaBridge 167:84c0a372a020 60 /**
AnnaBridge 167:84c0a372a020 61 * @note To use debug assertions, the symbol @c MXC_ASSERT_ENABLE must be
AnnaBridge 167:84c0a372a020 62 * defined.
AnnaBridge 167:84c0a372a020 63 */
AnnaBridge 167:84c0a372a020 64 ///@cond
AnnaBridge 167:84c0a372a020 65 #ifdef MXC_ASSERT_ENABLE
AnnaBridge 167:84c0a372a020 66 /**
AnnaBridge 167:84c0a372a020 67 * Macro that checks the expression for true and generates an assertion.
AnnaBridge 167:84c0a372a020 68 * @note To use debug assertions, the symbol @c MXC_ASSERT_ENABLE must be
AnnaBridge 167:84c0a372a020 69 * defined.
AnnaBridge 167:84c0a372a020 70 */
AnnaBridge 167:84c0a372a020 71 #define MXC_ASSERT(expr) \
AnnaBridge 167:84c0a372a020 72 if (!(expr)) \
AnnaBridge 167:84c0a372a020 73 { \
AnnaBridge 167:84c0a372a020 74 mxc_assert(#expr, __FILE__, __LINE__); \
AnnaBridge 167:84c0a372a020 75 }
AnnaBridge 167:84c0a372a020 76 /**
AnnaBridge 167:84c0a372a020 77 * Macro that generates an assertion with the message "FAIL".
AnnaBridge 167:84c0a372a020 78 * @note To use debug assertions, the symbol @c MXC_ASSERT_ENABLE must be
AnnaBridge 167:84c0a372a020 79 * defined.
AnnaBridge 167:84c0a372a020 80 */
AnnaBridge 167:84c0a372a020 81 #define MXC_ASSERT_FAIL() mxc_assert("FAIL", __FILE__, __LINE__);
AnnaBridge 167:84c0a372a020 82 #else
AnnaBridge 167:84c0a372a020 83 #define MXC_ASSERT(expr)
AnnaBridge 167:84c0a372a020 84 #define MXC_ASSERT_FAIL()
AnnaBridge 167:84c0a372a020 85 #endif
AnnaBridge 167:84c0a372a020 86 ///@endcond
AnnaBridge 167:84c0a372a020 87 /* **** Globals **** */
AnnaBridge 167:84c0a372a020 88
AnnaBridge 167:84c0a372a020 89 /* **** Function Prototypes **** */
AnnaBridge 167:84c0a372a020 90
AnnaBridge 167:84c0a372a020 91 /**
AnnaBridge 167:84c0a372a020 92 * @brief Assert an error when the given expression fails during debugging.
AnnaBridge 167:84c0a372a020 93 * @param expr String with the expression that failed the assertion.
AnnaBridge 167:84c0a372a020 94 * @param file File containing the failed assertion.
AnnaBridge 167:84c0a372a020 95 * @param line Line number for the failed assertion.
AnnaBridge 167:84c0a372a020 96 * @note This is defined as a weak function and can be overridden at the
AnnaBridge 167:84c0a372a020 97 * application layer to print the debugging information.
AnnaBridge 167:84c0a372a020 98 * @code
AnnaBridge 167:84c0a372a020 99 * printf("%s, file: %s, line %d\n", expr, file, line);
AnnaBridge 167:84c0a372a020 100 * @endcode
AnnaBridge 167:84c0a372a020 101 * @note To use debug assertions, the symbol @c MXC_ASSERT_ENABLE must be
AnnaBridge 167:84c0a372a020 102 * defined.
AnnaBridge 167:84c0a372a020 103 */
AnnaBridge 167:84c0a372a020 104 void mxc_assert(const char *expr, const char *file, int line);
AnnaBridge 167:84c0a372a020 105
AnnaBridge 167:84c0a372a020 106 /**@} end of group MXC_Assertions*/
AnnaBridge 167:84c0a372a020 107
AnnaBridge 167:84c0a372a020 108 #ifdef __cplusplus
AnnaBridge 167:84c0a372a020 109 }
AnnaBridge 167:84c0a372a020 110 #endif
AnnaBridge 167:84c0a372a020 111
AnnaBridge 167:84c0a372a020 112 #endif /* _MXC_ASSERT_H_ */