ble_debug_assert_handler.h

00001 /* Copyright (c) 2013 Nordic Semiconductor. All Rights Reserved.
00002  *
00003  * The information contained herein is property of Nordic Semiconductor ASA.
00004  * Terms and conditions of usage are described in detail in NORDIC
00005  * SEMICONDUCTOR STANDARD SOFTWARE LICENSE AGREEMENT.
00006  *
00007  * Licensees are granted free, non-transferable use of the information. NO
00008  * WARRANTY of ANY KIND is provided. This heading must NOT be removed from
00009  * the file.
00010  *
00011  */
00012 
00013 /** @file
00014  *
00015  * @defgroup ble_debug_assert_handler Assert Handler for debug purposes.
00016  * @{
00017  * @ingroup ble_sdk_lib
00018  * @brief Module for handling of assert during application development when debugging.
00019  *
00020  * @details This module may be used during development of an application to facilitate debugging.
00021  *          It contains a function to write file name, line number and the Stack Memory to flash.
00022  *          This module is ONLY for debugging purposes and must never be used in final product.
00023  *
00024  */
00025  
00026 #ifndef BLE_DEBUG_ASSERT_HANDLER_H__
00027 #define BLE_DEBUG_ASSERT_HANDLER_H__
00028 
00029 #include <stdint.h>
00030 #include "nordic_global.h"
00031  
00032 /**@brief Function for handling the Debug assert, which can be called from an error handler. 
00033  *        To be used only for debugging purposes.
00034  *
00035  *@details This code will copy the filename and line number into local variables for them to always
00036  *         be accessible in Keil debugger. The function will also write the ARM Cortex-M0 stack 
00037  *         memory into flash where it can be retrieved and manually un-winded in order to 
00038  *         back-trace the location where the error ocured.<br>
00039  * @warning <b>ALL INTERRUPTS WILL BE DISABLED.</b>
00040  * 
00041  * @note    This function will never return but loop forever for debug purposes.
00042  *
00043  * @param[in] error_code  Error code supplied to the handler.
00044  * @param[in] line_num    Line number where the original handler is called.
00045  * @param[in] p_file_name Pointer to the file name. 
00046  */
00047 void ble_debug_assert_handler(uint32_t error_code, uint32_t line_num, const uint8_t * p_file_name);
00048 
00049 #endif /* BLE_DEBUG_ASSERT_HANDLER_H__ */