mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_NRF51_DK/TOOLCHAIN_ARM_STD/app_error.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 146:22da6e220af6 1 /*
AnnaBridge 146:22da6e220af6 2 * Copyright (c) 2013 Nordic Semiconductor ASA
AnnaBridge 146:22da6e220af6 3 * All rights reserved.
AnnaBridge 146:22da6e220af6 4 *
AnnaBridge 146:22da6e220af6 5 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 146:22da6e220af6 6 * are permitted provided that the following conditions are met:
AnnaBridge 146:22da6e220af6 7 *
AnnaBridge 146:22da6e220af6 8 * 1. Redistributions of source code must retain the above copyright notice, this list
AnnaBridge 146:22da6e220af6 9 * of conditions and the following disclaimer.
AnnaBridge 146:22da6e220af6 10 *
AnnaBridge 146:22da6e220af6 11 * 2. Redistributions in binary form, except as embedded into a Nordic Semiconductor ASA
AnnaBridge 146:22da6e220af6 12 * integrated circuit in a product or a software update for such product, must reproduce
AnnaBridge 146:22da6e220af6 13 * the above copyright notice, this list of conditions and the following disclaimer in
AnnaBridge 146:22da6e220af6 14 * the documentation and/or other materials provided with the distribution.
AnnaBridge 146:22da6e220af6 15 *
AnnaBridge 146:22da6e220af6 16 * 3. Neither the name of Nordic Semiconductor ASA nor the names of its contributors may be
AnnaBridge 146:22da6e220af6 17 * used to endorse or promote products derived from this software without specific prior
AnnaBridge 146:22da6e220af6 18 * written permission.
AnnaBridge 146:22da6e220af6 19 *
AnnaBridge 146:22da6e220af6 20 * 4. This software, with or without modification, must only be used with a
AnnaBridge 146:22da6e220af6 21 * Nordic Semiconductor ASA integrated circuit.
AnnaBridge 146:22da6e220af6 22 *
AnnaBridge 146:22da6e220af6 23 * 5. Any software provided in binary or object form under this license must not be reverse
AnnaBridge 146:22da6e220af6 24 * engineered, decompiled, modified and/or disassembled.
AnnaBridge 146:22da6e220af6 25 *
AnnaBridge 146:22da6e220af6 26 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
AnnaBridge 146:22da6e220af6 27 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
AnnaBridge 146:22da6e220af6 28 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 146:22da6e220af6 29 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
AnnaBridge 146:22da6e220af6 30 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
AnnaBridge 146:22da6e220af6 31 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
AnnaBridge 146:22da6e220af6 32 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
AnnaBridge 146:22da6e220af6 33 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
AnnaBridge 146:22da6e220af6 34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
AnnaBridge 146:22da6e220af6 35 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 146:22da6e220af6 36 *
AnnaBridge 146:22da6e220af6 37 */
AnnaBridge 146:22da6e220af6 38
AnnaBridge 146:22da6e220af6 39
AnnaBridge 146:22da6e220af6 40 /** @file
AnnaBridge 146:22da6e220af6 41 *
AnnaBridge 146:22da6e220af6 42 * @defgroup app_error Common application error handler
AnnaBridge 146:22da6e220af6 43 * @{
AnnaBridge 146:22da6e220af6 44 * @ingroup app_common
AnnaBridge 146:22da6e220af6 45 *
AnnaBridge 146:22da6e220af6 46 * @brief Common application error handler and macros for utilizing a common error handler.
AnnaBridge 146:22da6e220af6 47 */
AnnaBridge 146:22da6e220af6 48
AnnaBridge 146:22da6e220af6 49 #ifndef APP_ERROR_H__
AnnaBridge 146:22da6e220af6 50 #define APP_ERROR_H__
AnnaBridge 146:22da6e220af6 51
AnnaBridge 146:22da6e220af6 52 #include <stdint.h>
AnnaBridge 146:22da6e220af6 53 #include <stdio.h>
AnnaBridge 146:22da6e220af6 54 #include <stdbool.h>
AnnaBridge 146:22da6e220af6 55 #include "nrf.h"
AnnaBridge 146:22da6e220af6 56 #include "sdk_errors.h"
AnnaBridge 146:22da6e220af6 57 #include "nordic_common.h"
AnnaBridge 146:22da6e220af6 58 #include "nrf_log.h"
AnnaBridge 146:22da6e220af6 59 #include "app_error_weak.h"
AnnaBridge 146:22da6e220af6 60
AnnaBridge 146:22da6e220af6 61 #define NRF_FAULT_ID_SDK_RANGE_START 0x00004000 /**< The start of the range of error IDs defined in the SDK. */
AnnaBridge 146:22da6e220af6 62
AnnaBridge 146:22da6e220af6 63 /**@defgroup APP_ERROR_FAULT_IDS Fault ID types
AnnaBridge 146:22da6e220af6 64 * @{ */
AnnaBridge 146:22da6e220af6 65 #define NRF_FAULT_ID_SDK_ERROR NRF_FAULT_ID_SDK_RANGE_START + 1 /**< An error stemming from a call to @ref APP_ERROR_CHECK or @ref APP_ERROR_CHECK_BOOL. The info parameter is a pointer to an @ref error_info_t variable. */
AnnaBridge 146:22da6e220af6 66 #define NRF_FAULT_ID_SDK_ASSERT NRF_FAULT_ID_SDK_RANGE_START + 2 /**< An error stemming from a call to ASSERT (nrf_assert.h). The info parameter is a pointer to an @ref assert_info_t variable. */
AnnaBridge 146:22da6e220af6 67 /**@} */
AnnaBridge 146:22da6e220af6 68
AnnaBridge 146:22da6e220af6 69 /**@brief Structure containing info about an error of the type @ref NRF_FAULT_ID_SDK_ERROR.
AnnaBridge 146:22da6e220af6 70 */
AnnaBridge 146:22da6e220af6 71 typedef struct
AnnaBridge 146:22da6e220af6 72 {
AnnaBridge 146:22da6e220af6 73 uint16_t line_num; /**< The line number where the error occurred. */
AnnaBridge 146:22da6e220af6 74 uint8_t const * p_file_name; /**< The file in which the error occurred. */
AnnaBridge 146:22da6e220af6 75 uint32_t err_code; /**< The error code representing the error that occurred. */
AnnaBridge 146:22da6e220af6 76 } error_info_t;
AnnaBridge 146:22da6e220af6 77
AnnaBridge 146:22da6e220af6 78 /**@brief Structure containing info about an error of the type @ref NRF_FAULT_ID_SDK_ASSERT.
AnnaBridge 146:22da6e220af6 79 */
AnnaBridge 146:22da6e220af6 80 typedef struct
AnnaBridge 146:22da6e220af6 81 {
AnnaBridge 146:22da6e220af6 82 uint16_t line_num; /**< The line number where the error occurred. */
AnnaBridge 146:22da6e220af6 83 uint8_t const * p_file_name; /**< The file in which the error occurred. */
AnnaBridge 146:22da6e220af6 84 } assert_info_t;
AnnaBridge 146:22da6e220af6 85
AnnaBridge 146:22da6e220af6 86 /**@brief Function for error handling, which is called when an error has occurred.
AnnaBridge 146:22da6e220af6 87 *
AnnaBridge 146:22da6e220af6 88 * @param[in] error_code Error code supplied to the handler.
AnnaBridge 146:22da6e220af6 89 * @param[in] line_num Line number where the handler is called.
AnnaBridge 146:22da6e220af6 90 * @param[in] p_file_name Pointer to the file name.
AnnaBridge 146:22da6e220af6 91 */
AnnaBridge 146:22da6e220af6 92 void app_error_handler(uint32_t error_code, uint32_t line_num, const uint8_t * p_file_name);
AnnaBridge 146:22da6e220af6 93
AnnaBridge 146:22da6e220af6 94 /**@brief Function for error handling, which is called when an error has occurred.
AnnaBridge 146:22da6e220af6 95 *
AnnaBridge 146:22da6e220af6 96 * @param[in] error_code Error code supplied to the handler.
AnnaBridge 146:22da6e220af6 97 */
AnnaBridge 146:22da6e220af6 98 void app_error_handler_bare(ret_code_t error_code);
AnnaBridge 146:22da6e220af6 99
AnnaBridge 146:22da6e220af6 100 /**@brief Function for saving the parameters and entering an eternal loop, for debug purposes.
AnnaBridge 146:22da6e220af6 101 *
AnnaBridge 146:22da6e220af6 102 * @param[in] id Fault identifier. See @ref NRF_FAULT_IDS.
AnnaBridge 146:22da6e220af6 103 * @param[in] pc The program counter of the instruction that triggered the fault, or 0 if
AnnaBridge 146:22da6e220af6 104 * unavailable.
AnnaBridge 146:22da6e220af6 105 * @param[in] info Optional additional information regarding the fault. Refer to each fault
AnnaBridge 146:22da6e220af6 106 * identifier for details.
AnnaBridge 146:22da6e220af6 107 */
AnnaBridge 146:22da6e220af6 108 void app_error_save_and_stop(uint32_t id, uint32_t pc, uint32_t info);
AnnaBridge 146:22da6e220af6 109
AnnaBridge 146:22da6e220af6 110 /**@brief Function for printing all error info (using nrf_log).
AnnaBridge 146:22da6e220af6 111 *
AnnaBridge 146:22da6e220af6 112 * @details Nrf_log library must be initialized using NRF_LOG_INIT macro before calling
AnnaBridge 146:22da6e220af6 113 * this function.
AnnaBridge 146:22da6e220af6 114 *
AnnaBridge 146:22da6e220af6 115 * @param[in] id Fault identifier. See @ref NRF_FAULT_IDS.
AnnaBridge 146:22da6e220af6 116 * @param[in] pc The program counter of the instruction that triggered the fault, or 0 if
AnnaBridge 146:22da6e220af6 117 * unavailable.
AnnaBridge 146:22da6e220af6 118 * @param[in] info Optional additional information regarding the fault. Refer to each fault
AnnaBridge 146:22da6e220af6 119 * identifier for details.
AnnaBridge 146:22da6e220af6 120 */
AnnaBridge 146:22da6e220af6 121 static __INLINE void app_error_log(uint32_t id, uint32_t pc, uint32_t info)
AnnaBridge 146:22da6e220af6 122 {
AnnaBridge 146:22da6e220af6 123 switch (id)
AnnaBridge 146:22da6e220af6 124 {
AnnaBridge 146:22da6e220af6 125 case NRF_FAULT_ID_SDK_ASSERT:
AnnaBridge 146:22da6e220af6 126 NRF_LOG(NRF_LOG_COLOR_RED "\n*** ASSERTION FAILED ***\n");
AnnaBridge 146:22da6e220af6 127 if (((assert_info_t *)(info))->p_file_name)
AnnaBridge 146:22da6e220af6 128 {
AnnaBridge 146:22da6e220af6 129 NRF_LOG_PRINTF(NRF_LOG_COLOR_WHITE "Line Number: %u\n", (unsigned int) ((assert_info_t *)(info))->line_num);
AnnaBridge 146:22da6e220af6 130 NRF_LOG_PRINTF("File Name: %s\n", ((assert_info_t *)(info))->p_file_name);
AnnaBridge 146:22da6e220af6 131 }
AnnaBridge 146:22da6e220af6 132 NRF_LOG_PRINTF(NRF_LOG_COLOR_DEFAULT "\n");
AnnaBridge 146:22da6e220af6 133 break;
AnnaBridge 146:22da6e220af6 134
AnnaBridge 146:22da6e220af6 135 case NRF_FAULT_ID_SDK_ERROR:
AnnaBridge 146:22da6e220af6 136 NRF_LOG(NRF_LOG_COLOR_RED "\n*** APPLICATION ERROR *** \n" NRF_LOG_COLOR_WHITE);
AnnaBridge 146:22da6e220af6 137 if (((error_info_t *)(info))->p_file_name)
AnnaBridge 146:22da6e220af6 138 {
AnnaBridge 146:22da6e220af6 139 NRF_LOG_PRINTF("Line Number: %u\n", (unsigned int) ((error_info_t *)(info))->line_num);
AnnaBridge 146:22da6e220af6 140 NRF_LOG_PRINTF("File Name: %s\n", ((error_info_t *)(info))->p_file_name);
AnnaBridge 146:22da6e220af6 141 }
AnnaBridge 146:22da6e220af6 142 NRF_LOG_PRINTF("Error Code: 0x%X\n" NRF_LOG_COLOR_DEFAULT "\n", (unsigned int) ((error_info_t *)(info))->err_code);
AnnaBridge 146:22da6e220af6 143 break;
AnnaBridge 146:22da6e220af6 144 }
AnnaBridge 146:22da6e220af6 145 }
AnnaBridge 146:22da6e220af6 146
AnnaBridge 146:22da6e220af6 147 /**@brief Function for printing all error info (using printf).
AnnaBridge 146:22da6e220af6 148 *
AnnaBridge 146:22da6e220af6 149 * @param[in] id Fault identifier. See @ref NRF_FAULT_IDS.
AnnaBridge 146:22da6e220af6 150 * @param[in] pc The program counter of the instruction that triggered the fault, or 0 if
AnnaBridge 146:22da6e220af6 151 * unavailable.
AnnaBridge 146:22da6e220af6 152 * @param[in] info Optional additional information regarding the fault. Refer to each fault
AnnaBridge 146:22da6e220af6 153 * identifier for details.
AnnaBridge 146:22da6e220af6 154 */
AnnaBridge 146:22da6e220af6 155 //lint -save -e438
AnnaBridge 146:22da6e220af6 156 static __INLINE void app_error_print(uint32_t id, uint32_t pc, uint32_t info)
AnnaBridge 146:22da6e220af6 157 {
AnnaBridge 146:22da6e220af6 158 unsigned int tmp = id;
AnnaBridge 146:22da6e220af6 159 printf("app_error_print():\r\n");
AnnaBridge 146:22da6e220af6 160 printf("Fault identifier: 0x%X\r\n", tmp);
AnnaBridge 146:22da6e220af6 161 printf("Program counter: 0x%X\r\n", tmp = pc);
AnnaBridge 146:22da6e220af6 162 printf("Fault information: 0x%X\r\n", tmp = info);
AnnaBridge 146:22da6e220af6 163
AnnaBridge 146:22da6e220af6 164 switch (id)
AnnaBridge 146:22da6e220af6 165 {
AnnaBridge 146:22da6e220af6 166 case NRF_FAULT_ID_SDK_ASSERT:
AnnaBridge 146:22da6e220af6 167 printf("Line Number: %u\r\n", tmp = ((assert_info_t *)(info))->line_num);
AnnaBridge 146:22da6e220af6 168 printf("File Name: %s\r\n", ((assert_info_t *)(info))->p_file_name);
AnnaBridge 146:22da6e220af6 169 break;
AnnaBridge 146:22da6e220af6 170
AnnaBridge 146:22da6e220af6 171 case NRF_FAULT_ID_SDK_ERROR:
AnnaBridge 146:22da6e220af6 172 printf("Line Number: %u\r\n", tmp = ((error_info_t *)(info))->line_num);
AnnaBridge 146:22da6e220af6 173 printf("File Name: %s\r\n", ((error_info_t *)(info))->p_file_name);
AnnaBridge 146:22da6e220af6 174 printf("Error Code: 0x%X\r\n", tmp = ((error_info_t *)(info))->err_code);
AnnaBridge 146:22da6e220af6 175 break;
AnnaBridge 146:22da6e220af6 176 }
AnnaBridge 146:22da6e220af6 177 }
AnnaBridge 146:22da6e220af6 178 //lint -restore
AnnaBridge 146:22da6e220af6 179
AnnaBridge 146:22da6e220af6 180
AnnaBridge 146:22da6e220af6 181 /**@brief Macro for calling error handler function.
AnnaBridge 146:22da6e220af6 182 *
AnnaBridge 146:22da6e220af6 183 * @param[in] ERR_CODE Error code supplied to the error handler.
AnnaBridge 146:22da6e220af6 184 */
AnnaBridge 146:22da6e220af6 185 #ifdef DEBUG
AnnaBridge 146:22da6e220af6 186 #define APP_ERROR_HANDLER(ERR_CODE) \
AnnaBridge 146:22da6e220af6 187 do \
AnnaBridge 146:22da6e220af6 188 { \
AnnaBridge 146:22da6e220af6 189 app_error_handler((ERR_CODE), __LINE__, (uint8_t*) __FILE__); \
AnnaBridge 146:22da6e220af6 190 } while (0)
AnnaBridge 146:22da6e220af6 191 #else
AnnaBridge 146:22da6e220af6 192 #define APP_ERROR_HANDLER(ERR_CODE) \
AnnaBridge 146:22da6e220af6 193 do \
AnnaBridge 146:22da6e220af6 194 { \
AnnaBridge 146:22da6e220af6 195 app_error_handler_bare((ERR_CODE)); \
AnnaBridge 146:22da6e220af6 196 } while (0)
AnnaBridge 146:22da6e220af6 197 #endif
AnnaBridge 146:22da6e220af6 198 /**@brief Macro for calling error handler function if supplied error code any other than NRF_SUCCESS.
AnnaBridge 146:22da6e220af6 199 *
AnnaBridge 146:22da6e220af6 200 * @param[in] ERR_CODE Error code supplied to the error handler.
AnnaBridge 146:22da6e220af6 201 */
AnnaBridge 146:22da6e220af6 202 #define APP_ERROR_CHECK(ERR_CODE) \
AnnaBridge 146:22da6e220af6 203 do \
AnnaBridge 146:22da6e220af6 204 { \
AnnaBridge 146:22da6e220af6 205 const uint32_t LOCAL_ERR_CODE = (ERR_CODE); \
AnnaBridge 146:22da6e220af6 206 if (LOCAL_ERR_CODE != NRF_SUCCESS) \
AnnaBridge 146:22da6e220af6 207 { \
AnnaBridge 146:22da6e220af6 208 APP_ERROR_HANDLER(LOCAL_ERR_CODE); \
AnnaBridge 146:22da6e220af6 209 } \
AnnaBridge 146:22da6e220af6 210 } while (0)
AnnaBridge 146:22da6e220af6 211
AnnaBridge 146:22da6e220af6 212 /**@brief Macro for calling error handler function if supplied boolean value is false.
AnnaBridge 146:22da6e220af6 213 *
AnnaBridge 146:22da6e220af6 214 * @param[in] BOOLEAN_VALUE Boolean value to be evaluated.
AnnaBridge 146:22da6e220af6 215 */
AnnaBridge 146:22da6e220af6 216 #define APP_ERROR_CHECK_BOOL(BOOLEAN_VALUE) \
AnnaBridge 146:22da6e220af6 217 do \
AnnaBridge 146:22da6e220af6 218 { \
AnnaBridge 146:22da6e220af6 219 const uint32_t LOCAL_BOOLEAN_VALUE = (BOOLEAN_VALUE); \
AnnaBridge 146:22da6e220af6 220 if (!LOCAL_BOOLEAN_VALUE) \
AnnaBridge 146:22da6e220af6 221 { \
AnnaBridge 146:22da6e220af6 222 APP_ERROR_HANDLER(0); \
AnnaBridge 146:22da6e220af6 223 } \
AnnaBridge 146:22da6e220af6 224 } while (0)
AnnaBridge 146:22da6e220af6 225
AnnaBridge 146:22da6e220af6 226 #endif // APP_ERROR_H__
AnnaBridge 146:22da6e220af6 227
AnnaBridge 146:22da6e220af6 228 /** @} */