Mustahsin Chowdhury / nRF51822

Nordic stack and drivers for the mbed BLE API

Fork of nRF51822 by Nordic Semiconductor

TARGET_MCU_NRF51822/sdk/source/libraries/util/app_error.h@640:c90ae1400bf2, 2016-09-14 (annotated)

Committer:
Vincent Coubard
Date:
Wed Sep 14 14:39:43 2016 +0100
Revision:
640:c90ae1400bf2
Sync with bdab10dc0f90748b6989c8b577771bb403ca6bd8 from ARMmbed/mbed-os.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Vincent Coubard 640:c90ae1400bf2 1 /*
Vincent Coubard 640:c90ae1400bf2 2 * Copyright (c) Nordic Semiconductor ASA
Vincent Coubard 640:c90ae1400bf2 3 * All rights reserved.
Vincent Coubard 640:c90ae1400bf2 4 *
Vincent Coubard 640:c90ae1400bf2 5 * Redistribution and use in source and binary forms, with or without modification,
Vincent Coubard 640:c90ae1400bf2 6 * are permitted provided that the following conditions are met:
Vincent Coubard 640:c90ae1400bf2 7 *
Vincent Coubard 640:c90ae1400bf2 8 * 1. Redistributions of source code must retain the above copyright notice, this
Vincent Coubard 640:c90ae1400bf2 9 * list of conditions and the following disclaimer.
Vincent Coubard 640:c90ae1400bf2 10 *
Vincent Coubard 640:c90ae1400bf2 11 * 2. Redistributions in binary form must reproduce the above copyright notice, this
Vincent Coubard 640:c90ae1400bf2 12 * list of conditions and the following disclaimer in the documentation and/or
Vincent Coubard 640:c90ae1400bf2 13 * other materials provided with the distribution.
Vincent Coubard 640:c90ae1400bf2 14 *
Vincent Coubard 640:c90ae1400bf2 15 * 3. Neither the name of Nordic Semiconductor ASA nor the names of other
Vincent Coubard 640:c90ae1400bf2 16 * contributors to this software may be used to endorse or promote products
Vincent Coubard 640:c90ae1400bf2 17 * derived from this software without specific prior written permission.
Vincent Coubard 640:c90ae1400bf2 18 *
Vincent Coubard 640:c90ae1400bf2 19 *
Vincent Coubard 640:c90ae1400bf2 20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
Vincent Coubard 640:c90ae1400bf2 21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
Vincent Coubard 640:c90ae1400bf2 22 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Vincent Coubard 640:c90ae1400bf2 23 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
Vincent Coubard 640:c90ae1400bf2 24 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
Vincent Coubard 640:c90ae1400bf2 25 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
Vincent Coubard 640:c90ae1400bf2 26 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
Vincent Coubard 640:c90ae1400bf2 27 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
Vincent Coubard 640:c90ae1400bf2 28 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
Vincent Coubard 640:c90ae1400bf2 29 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Vincent Coubard 640:c90ae1400bf2 30 *
Vincent Coubard 640:c90ae1400bf2 31 */
Vincent Coubard 640:c90ae1400bf2 32
Vincent Coubard 640:c90ae1400bf2 33 /** @file
Vincent Coubard 640:c90ae1400bf2 34 *
Vincent Coubard 640:c90ae1400bf2 35 * @defgroup app_error Common application error handler
Vincent Coubard 640:c90ae1400bf2 36 * @{
Vincent Coubard 640:c90ae1400bf2 37 * @ingroup app_common
Vincent Coubard 640:c90ae1400bf2 38 *
Vincent Coubard 640:c90ae1400bf2 39 * @brief Common application error handler and macros for utilizing a common error handler.
Vincent Coubard 640:c90ae1400bf2 40 */
Vincent Coubard 640:c90ae1400bf2 41
Vincent Coubard 640:c90ae1400bf2 42 #ifndef APP_ERROR_H__
Vincent Coubard 640:c90ae1400bf2 43 #define APP_ERROR_H__
Vincent Coubard 640:c90ae1400bf2 44
Vincent Coubard 640:c90ae1400bf2 45 #include <stdint.h>
Vincent Coubard 640:c90ae1400bf2 46 #include <stdbool.h>
Vincent Coubard 640:c90ae1400bf2 47 #include "nrf_error.h"
Vincent Coubard 640:c90ae1400bf2 48
Vincent Coubard 640:c90ae1400bf2 49 /**@brief Function for error handling, which is called when an error has occurred.
Vincent Coubard 640:c90ae1400bf2 50 *
Vincent Coubard 640:c90ae1400bf2 51 * @param[in] error_code Error code supplied to the handler.
Vincent Coubard 640:c90ae1400bf2 52 * @param[in] line_num Line number where the handler is called.
Vincent Coubard 640:c90ae1400bf2 53 * @param[in] p_file_name Pointer to the file name.
Vincent Coubard 640:c90ae1400bf2 54 */
Vincent Coubard 640:c90ae1400bf2 55 void app_error_handler(uint32_t error_code, uint32_t line_num, const uint8_t * p_file_name);
Vincent Coubard 640:c90ae1400bf2 56
Vincent Coubard 640:c90ae1400bf2 57 /**@brief Macro for calling error handler function.
Vincent Coubard 640:c90ae1400bf2 58 *
Vincent Coubard 640:c90ae1400bf2 59 * @param[in] ERR_CODE Error code supplied to the error handler.
Vincent Coubard 640:c90ae1400bf2 60 */
Vincent Coubard 640:c90ae1400bf2 61 #ifdef DEBUG
Vincent Coubard 640:c90ae1400bf2 62 #define APP_ERROR_HANDLER(ERR_CODE) \
Vincent Coubard 640:c90ae1400bf2 63 do \
Vincent Coubard 640:c90ae1400bf2 64 { \
Vincent Coubard 640:c90ae1400bf2 65 app_error_handler((ERR_CODE), __LINE__, (uint8_t*) __FILE__); \
Vincent Coubard 640:c90ae1400bf2 66 } while (0)
Vincent Coubard 640:c90ae1400bf2 67 #else
Vincent Coubard 640:c90ae1400bf2 68 #define APP_ERROR_HANDLER(ERR_CODE) \
Vincent Coubard 640:c90ae1400bf2 69 do \
Vincent Coubard 640:c90ae1400bf2 70 { \
Vincent Coubard 640:c90ae1400bf2 71 app_error_handler((ERR_CODE), 0, 0); \
Vincent Coubard 640:c90ae1400bf2 72 } while (0)
Vincent Coubard 640:c90ae1400bf2 73 #endif
Vincent Coubard 640:c90ae1400bf2 74 /**@brief Macro for calling error handler function if supplied error code any other than NRF_SUCCESS.
Vincent Coubard 640:c90ae1400bf2 75 *
Vincent Coubard 640:c90ae1400bf2 76 * @param[in] ERR_CODE Error code supplied to the error handler.
Vincent Coubard 640:c90ae1400bf2 77 */
Vincent Coubard 640:c90ae1400bf2 78 #define APP_ERROR_CHECK(ERR_CODE) \
Vincent Coubard 640:c90ae1400bf2 79 do \
Vincent Coubard 640:c90ae1400bf2 80 { \
Vincent Coubard 640:c90ae1400bf2 81 const uint32_t LOCAL_ERR_CODE = (ERR_CODE); \
Vincent Coubard 640:c90ae1400bf2 82 if (LOCAL_ERR_CODE != NRF_SUCCESS) \
Vincent Coubard 640:c90ae1400bf2 83 { \
Vincent Coubard 640:c90ae1400bf2 84 APP_ERROR_HANDLER(LOCAL_ERR_CODE); \
Vincent Coubard 640:c90ae1400bf2 85 } \
Vincent Coubard 640:c90ae1400bf2 86 } while (0)
Vincent Coubard 640:c90ae1400bf2 87
Vincent Coubard 640:c90ae1400bf2 88 /**@brief Macro for calling error handler function if supplied boolean value is false.
Vincent Coubard 640:c90ae1400bf2 89 *
Vincent Coubard 640:c90ae1400bf2 90 * @param[in] BOOLEAN_VALUE Boolean value to be evaluated.
Vincent Coubard 640:c90ae1400bf2 91 */
Vincent Coubard 640:c90ae1400bf2 92 #define APP_ERROR_CHECK_BOOL(BOOLEAN_VALUE) \
Vincent Coubard 640:c90ae1400bf2 93 do \
Vincent Coubard 640:c90ae1400bf2 94 { \
Vincent Coubard 640:c90ae1400bf2 95 const uint32_t LOCAL_BOOLEAN_VALUE = (BOOLEAN_VALUE); \
Vincent Coubard 640:c90ae1400bf2 96 if (!LOCAL_BOOLEAN_VALUE) \
Vincent Coubard 640:c90ae1400bf2 97 { \
Vincent Coubard 640:c90ae1400bf2 98 APP_ERROR_HANDLER(0); \
Vincent Coubard 640:c90ae1400bf2 99 } \
Vincent Coubard 640:c90ae1400bf2 100 } while (0)
Vincent Coubard 640:c90ae1400bf2 101
Vincent Coubard 640:c90ae1400bf2 102 #endif // APP_ERROR_H__
Vincent Coubard 640:c90ae1400bf2 103
Vincent Coubard 640:c90ae1400bf2 104 /** @} */