Diff: BLE_API_Native_IRC/hw/nRF51822n/nordic/nrf-sdk/ble/ble_error_log.h

Revision:

0:8c643bfe55b7

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/BLE_API_Native_IRC/hw/nRF51822n/nordic/nrf-sdk/ble/ble_error_log.h	Thu Jul 10 14:21:52 2014 +0000
@@ -0,0 +1,70 @@
+/* Copyright (c) 2012 Nordic Semiconductor. All Rights Reserved.
+ *
+ * The information contained herein is property of Nordic Semiconductor ASA.
+ * Terms and conditions of usage are described in detail in NORDIC
+ * SEMICONDUCTOR STANDARD SOFTWARE LICENSE AGREEMENT.
+ *
+ * Licensees are granted free, non-transferable use of the information. NO
+ * WARRANTY of ANY KIND is provided. This heading must NOT be removed from
+ * the file.
+ *
+ */
+
+/** @file
+ *
+ * @defgroup ble_error_log_module Error Log Module
+ * @{
+ * @ingroup ble_sdk_lib
+ * @brief Module for writing error and stack to flash memory.
+ *
+ * @details It contains functions for writing an error code, line number, filename/message and
+ *          the stack to the flash during an error, e.g. in the assert handler.
+ *
+ */
+#ifndef BLE_ERROR_LOG_H__
+#define BLE_ERROR_LOG_H__
+
+#include <stdint.h>
+#include <stdbool.h>
+#include "ble_flash.h"
+#include "nordic_global.h"
+
+#define ERROR_MESSAGE_LENGTH  128                                /**< Length of error message to stored. */
+#define STACK_DUMP_LENGTH     256                                /**< Length of stack to be stored at max: 64 entries of 4 bytes each. */
+#define FLASH_PAGE_ERROR_LOG  (BLE_FLASH_PAGE_END - 2)           /**< Address in flash where stack trace can be stored. */
+
+/**@brief Error Log Data structure.
+ *
+ * @details The structure contains the error, message/filename, line number as well as the current
+ *          stack, at the time where an error occured.
+ */
+typedef struct
+{
+    uint16_t                  failure;                           /**< Indication that a major failure has occurred during last execution of the application. */
+    uint16_t                  line_number;                       /**< Line number indicating at which line the failure occurred. */
+    uint32_t                  err_code;                          /**< Error code when failure occurred. */
+    uint8_t                   message[ERROR_MESSAGE_LENGTH];     /**< Will just use the first 128 bytes of filename to store for debugging purposes. */
+    uint32_t                  stack_info[STACK_DUMP_LENGTH / 4]; /**< Will contain stack information, can be manually unwinded for debug purposes. */
+} ble_error_log_data_t;
+
+
+/**@brief Function for writing the file name/message, line number, and current program stack
+ *        to flash.
+ * 
+ * @note This function will force the writing to flash, and disregard any radio communication.
+ *       USE THIS FUNCTION WITH CARE.
+ *
+ * @param[in]   err_code    Error code to be logged.
+ * @param[in]   p_message   Message to be written to the flash together with stack dump, usually
+ *                          the file name where the error occured.
+ * @param[in]   line_number Line number where the error occured.
+ *
+ * @return      NRF_SUCCESS on successful writing of the error log.
+ *
+ */
+uint32_t ble_error_log_write(uint32_t err_code, const uint8_t * p_message, uint16_t line_number);
+
+
+#endif /* BLE_ERROR_LOG_H__ */
+
+/** @} */