mbed-os
Fork of mbed-os by
targets/TARGET_ONSEMI/TARGET_NCS36510/assert_onsemi.h@0:f269e3021894, 2016-10-23 (annotated)
- Committer:
- elessair
- Date:
- Sun Oct 23 15:10:02 2016 +0000
- Revision:
- 0:f269e3021894
Initial commit
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
elessair | 0:f269e3021894 | 1 | /** |
elessair | 0:f269e3021894 | 2 | ****************************************************************************** |
elessair | 0:f269e3021894 | 3 | * @file assert.h |
elessair | 0:f269e3021894 | 4 | * @brief Defines an assertion for debugging purposes. |
elessair | 0:f269e3021894 | 5 | * @internal |
elessair | 0:f269e3021894 | 6 | * @author ON Semiconductor |
elessair | 0:f269e3021894 | 7 | * $Rev: 3823 $ |
elessair | 0:f269e3021894 | 8 | * $Date: 2015-10-23 16:21:37 +0530 (Fri, 23 Oct 2015) $ |
elessair | 0:f269e3021894 | 9 | ****************************************************************************** |
elessair | 0:f269e3021894 | 10 | * Copyright 2016 Semiconductor Components Industries LLC (d/b/a ON Semiconductor). |
elessair | 0:f269e3021894 | 11 | * All rights reserved. This software and/or documentation is licensed by ON Semiconductor |
elessair | 0:f269e3021894 | 12 | * under limited terms and conditions. The terms and conditions pertaining to the software |
elessair | 0:f269e3021894 | 13 | * and/or documentation are available at http://www.onsemi.com/site/pdf/ONSEMI_T&C.pdf |
elessair | 0:f269e3021894 | 14 | * (ON Semiconductor Standard Terms and Conditions of Sale, Section 8 Software) and |
elessair | 0:f269e3021894 | 15 | * if applicable the software license agreement. Do not use this software and/or |
elessair | 0:f269e3021894 | 16 | * documentation unless you have carefully read and you agree to the limited terms and |
elessair | 0:f269e3021894 | 17 | * conditions. By using this software and/or documentation, you agree to the limited |
elessair | 0:f269e3021894 | 18 | * terms and conditions. |
elessair | 0:f269e3021894 | 19 | * |
elessair | 0:f269e3021894 | 20 | * THIS SOFTWARE IS PROVIDED "AS IS". NO WARRANTIES, WHETHER EXPRESS, IMPLIED |
elessair | 0:f269e3021894 | 21 | * OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF |
elessair | 0:f269e3021894 | 22 | * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE. |
elessair | 0:f269e3021894 | 23 | * ON SEMICONDUCTOR SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, |
elessair | 0:f269e3021894 | 24 | * INCIDENTAL, OR CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER. |
elessair | 0:f269e3021894 | 25 | * @endinternal |
elessair | 0:f269e3021894 | 26 | * |
elessair | 0:f269e3021894 | 27 | * @details |
elessair | 0:f269e3021894 | 28 | * While debugging, the ASSERT macro can be used to verify the expected behaviour |
elessair | 0:f269e3021894 | 29 | * of the source code. If the condition that is passed as a parameter to the ASSERT |
elessair | 0:f269e3021894 | 30 | * macro evaluates to False, execution stops. |
elessair | 0:f269e3021894 | 31 | * |
elessair | 0:f269e3021894 | 32 | * The user has the possibility to hook into the assertion through the assertCallback |
elessair | 0:f269e3021894 | 33 | * callback function. Note though that the callback function must not use any |
elessair | 0:f269e3021894 | 34 | * functionality of the RTOS, or rely on interrupts being called. Once the function |
elessair | 0:f269e3021894 | 35 | * returns, it's done. |
elessair | 0:f269e3021894 | 36 | * |
elessair | 0:f269e3021894 | 37 | * @ingroup debug |
elessair | 0:f269e3021894 | 38 | */ |
elessair | 0:f269e3021894 | 39 | |
elessair | 0:f269e3021894 | 40 | #ifndef ASSERT_H_ |
elessair | 0:f269e3021894 | 41 | #define ASSERT_H_ |
elessair | 0:f269e3021894 | 42 | |
elessair | 0:f269e3021894 | 43 | #ifdef __cplusplus |
elessair | 0:f269e3021894 | 44 | extern "C" { |
elessair | 0:f269e3021894 | 45 | #endif |
elessair | 0:f269e3021894 | 46 | |
elessair | 0:f269e3021894 | 47 | #ifdef DEBUG |
elessair | 0:f269e3021894 | 48 | |
elessair | 0:f269e3021894 | 49 | /** Executes when an assertion condition evaluates to false. |
elessair | 0:f269e3021894 | 50 | * @param filename The name of the current file (normally the __FILE__ macro). |
elessair | 0:f269e3021894 | 51 | * @param line The current line number (normally the __LINE__ macro). |
elessair | 0:f269e3021894 | 52 | */ |
elessair | 0:f269e3021894 | 53 | void fOnAssert(const char *filename, unsigned int line); |
elessair | 0:f269e3021894 | 54 | |
elessair | 0:f269e3021894 | 55 | /** Can be assigned to hook into the assertion. */ |
elessair | 0:f269e3021894 | 56 | extern void (*assertCallback)(const char *filename, unsigned int line); |
elessair | 0:f269e3021894 | 57 | |
elessair | 0:f269e3021894 | 58 | #define ASSERT(test) ((test) ? (void)0 : fOnAssert(__FILE__, __LINE__)) |
elessair | 0:f269e3021894 | 59 | |
elessair | 0:f269e3021894 | 60 | #define VERIFY(test) ASSERT(test) |
elessair | 0:f269e3021894 | 61 | |
elessair | 0:f269e3021894 | 62 | #else |
elessair | 0:f269e3021894 | 63 | |
elessair | 0:f269e3021894 | 64 | #define ASSERT(test) ((test) ? (void)0 : 1) |
elessair | 0:f269e3021894 | 65 | |
elessair | 0:f269e3021894 | 66 | #define VERIFY(test) ((void)(test)) |
elessair | 0:f269e3021894 | 67 | |
elessair | 0:f269e3021894 | 68 | #endif // DEBUG |
elessair | 0:f269e3021894 | 69 | |
elessair | 0:f269e3021894 | 70 | #ifdef __cplusplus |
elessair | 0:f269e3021894 | 71 | } |
elessair | 0:f269e3021894 | 72 | #endif |
elessair | 0:f269e3021894 | 73 | |
elessair | 0:f269e3021894 | 74 | #endif /* ASSERT_H_ */ |