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