git.sur5r.net Git - freertos/blob - Demo/Common/drivers/Atmel/at91lib/utility/assert.h

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