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