• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /**
2  ****************************************************************************************
3  *
4  * @file app_assert.h
5  *
6  * @brief App Assert API
7  *
8  ****************************************************************************************
9  * @attention
10   #####Copyright (c) 2019 GOODIX
11   All rights reserved.
12 
13     Redistribution and use in source and binary forms, with or without
14     modification, are permitted provided that the following conditions are met:
15   * Redistributions of source code must retain the above copyright
16     notice, this list of conditions and the following disclaimer.
17   * Redistributions in binary form must reproduce the above copyright
18     notice, this list of conditions and the following disclaimer in the
19     documentation and/or other materials provided with the distribution.
20   * Neither the name of GOODIX nor the names of its contributors may be used
21     to endorse or promote products derived from this software without
22     specific prior written permission.
23 
24   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25   AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27   ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDERS AND CONTRIBUTORS BE
28   LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29   CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30   SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32   CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33   ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34   POSSIBILITY OF SUCH DAMAGE.
35  *****************************************************************************************
36  */
37 
38 #ifndef __APP_ASSERT_H__
39 #define __APP_ASSERT_H__
40 
41 #include <stdint.h>
42 #include "gr55xx_sys.h"
43 
44 /**
45  * @defgroup APP_ASSERT_MAROC Defines
46  * @{
47  */
48 /**@brief Macro for calling error handler function if assert check failed. */
49 #define APP_ASSERT_CHECK(EXPR)                              \
50     do                                                      \
51     {                                                       \
52         if (!(EXPR))                                        \
53         {                                                   \
54             app_assert_handler(#EXPR, __FILE__, __LINE__);  \
55         }                                                   \
56     } while (0)
57 /** @} */
58 
59 /**
60  * @defgroup APP_ASSERT_FUNCTION Functions
61  * @{
62  */
63 /**
64  *****************************************************************************************
65  * @brief Init user assert callbacks.
66  *****************************************************************************************
67  */
68 void app_assert_init(void);
69 
70 /**
71  *****************************************************************************************
72  * @brief App assert handler.
73  *
74  * @param[in] expr:  Pxpression.
75  * @param[in] file:  File name.
76  * @param[in] line:  Line number.
77  *****************************************************************************************
78  */
79 void app_assert_handler(const char *expr, const char *file, int line);
80 
81 /**
82  *****************************************************************************************
83  * @brief App assert warning callback.
84  *
85  * @param[in] param0:  Parameter0.
86  * @param[in] param1:  Parameter1.
87  * @param[in] file:    File name.
88  * @param[in] line:    Line number.
89  *****************************************************************************************
90  */
91 void app_assert_warn_cb(int param0, int param1, const char *file, int line);
92 
93 /**
94  *****************************************************************************************
95  * @brief App assert parameter callback.
96  *
97  * @param[in] param0:  Parameter0.
98  * @param[in] param1:  Parameter1.
99  * @param[in] file:    File name.
100  * @param[in] line:    Line number.
101  *****************************************************************************************
102  */
103 void app_assert_param_cb(int param0, int param1, const char *file, int line);
104 
105 /**
106  *****************************************************************************************
107  * @brief App assert error callback.
108  *
109  * @param[in] expr:   Pxpression.
110  * @param[in] file:   File name.
111  * @param[in] line:   Line number.
112  *****************************************************************************************
113  */
114 void app_assert_err_cb(const char *expr, const char *file, int line);
115 /** @} */
116 
117 #endif