1 /******************************************************************************
2 *  Filename:       debug.h
3 *  Revised:        2015-07-16 12:12:04 +0200 (Thu, 16 Jul 2015)
4 *  Revision:       44151
5 *
6 *  Description:    Macros for assisting debug of the driver library.
7 *
8 *  Copyright (c) 2015, Texas Instruments Incorporated
9 *  All rights reserved.
10 *
11 *  Redistribution and use in source and binary forms, with or without
12 *  modification, are permitted provided that the following conditions are met:
13 *
14 *  1) Redistributions of source code must retain the above copyright notice,
15 *     this list of conditions and the following disclaimer.
16 *
17 *  2) Redistributions in binary form must reproduce the above copyright notice,
18 *     this list of conditions and the following disclaimer in the documentation
19 *     and/or other materials provided with the distribution.
20 *
21 *  3) Neither the name of the ORGANIZATION nor the names of its contributors may
22 *     be used to endorse or promote products derived from this software without
23 *     specific prior written permission.
24 *
25 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
26 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
29 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35 *  POSSIBILITY OF SUCH DAMAGE.
36 *
37 ******************************************************************************/
38 
39 //*****************************************************************************
40 //
41 //! \addtogroup system_control_group
42 //! @{
43 //! \addtogroup debug_api
44 //! @{
45 //
46 //*****************************************************************************
47 
48 #ifndef __DEBUG_H__
49 #define __DEBUG_H__
50 
51 //*****************************************************************************
52 //
53 // Prototype for the function that is called when an invalid argument is passed
54 // to an API.  This is only used when doing a DRIVERLIB_DEBUG build.
55 //
56 //*****************************************************************************
57 extern void __error__(char *pcFilename, uint32_t ui32Line);
58 
59 //*****************************************************************************
60 //
61 // The ASSERT macro, which does the actual assertion checking. Typically, this
62 // will be for procedure arguments.
63 //
64 //*****************************************************************************
65 #ifdef DRIVERLIB_DEBUG
66 #define ASSERT(expr) {                                      \
67                          if(!(expr))                        \
68                          {                                  \
69                              __error__(__FILE__, __LINE__); \
70                          }                                  \
71                      }
72 
73 #else
74 #define ASSERT(expr)
75 #endif
76 
77 #endif // __DEBUG_H__
78 
79 //*****************************************************************************
80 //
81 //! Close the Doxygen group.
82 //! @}
83 //! @}
84 //
85 //*****************************************************************************
86