mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

targets/TARGET_Maxim/TARGET_MAX32620C/mxc/mxc_assert.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
Parent:
186:707f6e361f3e 
mbed library release version 165

Who changed what in which revision?

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