1 |
608 |
jeremybenn |
/* ----------------------------------------------------------------------------
|
2 |
|
|
* ATMEL Microcontroller Software Support
|
3 |
|
|
* ----------------------------------------------------------------------------
|
4 |
|
|
* Copyright (c) 2008, Atmel Corporation
|
5 |
|
|
*
|
6 |
|
|
* All rights reserved.
|
7 |
|
|
*
|
8 |
|
|
* Redistribution and use in source and binary forms, with or without
|
9 |
|
|
* modification, are permitted provided that the following conditions are met:
|
10 |
|
|
*
|
11 |
|
|
* - Redistributions of source code must retain the above copyright notice,
|
12 |
|
|
* this list of conditions and the disclaimer below.
|
13 |
|
|
*
|
14 |
|
|
* Atmel's name may not be used to endorse or promote products derived from
|
15 |
|
|
* this software without specific prior written permission.
|
16 |
|
|
*
|
17 |
|
|
* DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR
|
18 |
|
|
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
19 |
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
|
20 |
|
|
* DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,
|
21 |
|
|
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
22 |
|
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
|
23 |
|
|
* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
|
24 |
|
|
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
|
25 |
|
|
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
|
26 |
|
|
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
27 |
|
|
* ----------------------------------------------------------------------------
|
28 |
|
|
*/
|
29 |
|
|
|
30 |
|
|
/*
|
31 |
|
|
Title: Assert
|
32 |
|
|
|
33 |
|
|
About: Purpose
|
34 |
|
|
Definition of the ASSERT() macro, which is used for runtime condition
|
35 |
|
|
verifying.
|
36 |
|
|
|
37 |
|
|
About: Usage
|
38 |
|
|
1 - Use <ASSERT> in your code to check the value of function parameters,
|
39 |
|
|
return values, etc. *Warning:* the ASSERT condition must not have
|
40 |
|
|
any side-effect; otherwise, the program may not work properly
|
41 |
|
|
anymore when assertions are disabled.
|
42 |
|
|
2 - Use SANITY_CHECK to perform checks with a default error message
|
43 |
|
|
(outputs the file and line number where the error occured). This
|
44 |
|
|
reduces memory overhead caused by assertion error strings.
|
45 |
|
|
3 - Initialize the <DBGU> to see failed assertions at run-time.
|
46 |
|
|
4 - Disable assertions by defining the NOASSERT symbol at compilation
|
47 |
|
|
time.
|
48 |
|
|
*/
|
49 |
|
|
|
50 |
|
|
#ifndef ASSERT_H
|
51 |
|
|
#define ASSERT_H
|
52 |
|
|
|
53 |
|
|
//------------------------------------------------------------------------------
|
54 |
|
|
// Headers
|
55 |
|
|
//------------------------------------------------------------------------------
|
56 |
|
|
|
57 |
|
|
#include <stdio.h>
|
58 |
|
|
|
59 |
|
|
//------------------------------------------------------------------------------
|
60 |
|
|
// Definitions
|
61 |
|
|
//------------------------------------------------------------------------------
|
62 |
|
|
/*
|
63 |
|
|
Macro: ASSERT
|
64 |
|
|
Check that the given condition is true, otherwise displays an error
|
65 |
|
|
message and stops the program execution.
|
66 |
|
|
|
67 |
|
|
Parameters:
|
68 |
|
|
condition - Condition to verify.
|
69 |
|
|
string - Formatted string to output if the condition fails.
|
70 |
|
|
... - Additional arguments depending on the formatted string.
|
71 |
|
|
*/
|
72 |
|
|
#if !defined(NOASSERT) && !defined(NOTRACE)
|
73 |
|
|
|
74 |
|
|
//char sanityError[] = "Sanity check failed at %s:%d\n\r";
|
75 |
|
|
|
76 |
|
|
#define ASSERT(condition, ...) { \
|
77 |
|
|
if (!(condition)) { \
|
78 |
|
|
printf(__VA_ARGS__); \
|
79 |
|
|
while (1); \
|
80 |
|
|
} \
|
81 |
|
|
}
|
82 |
|
|
#define SANITY_ERROR "Sanity check failed at %s:%d\n\r"
|
83 |
|
|
#define SANITY_CHECK(condition) ASSERT(condition, SANITY_ERROR, __FILE__, __LINE__)
|
84 |
|
|
#else
|
85 |
|
|
#define ASSERT(...)
|
86 |
|
|
#define SANITY_CHECK(...)
|
87 |
|
|
#endif
|
88 |
|
|
|
89 |
|
|
#endif //#ifndef ASSERT_H
|
90 |
|
|
|