Modified for BG96
Fork of mbed-dev by
Diff: platform/mbed_error_hist.h
- Revision:
- 187:0387e8f68319
- Parent:
- 186:707f6e361f3e
--- a/platform/mbed_error_hist.h Fri Jun 22 16:45:37 2018 +0100 +++ b/platform/mbed_error_hist.h Thu Sep 06 13:40:20 2018 +0100 @@ -16,12 +16,12 @@ #ifndef MBED_ERROR_HIST_H #define MBED_ERROR_HIST_H -#ifndef MBED_CONF_ERROR_HIST_SIZE - #define MBED_CONF_ERROR_HIST_SIZE 4 +#ifndef MBED_CONF_PLATFORM_ERROR_HIST_SIZE +#define MBED_CONF_PLATFORM_ERROR_HIST_SIZE 4 #else - #if MBED_CONF_ERROR_HIST_SIZE == 0 - #define MBED_CONF_ERROR_HIST_SIZE 1 - #endif +#if MBED_CONF_PLATFORM_ERROR_HIST_SIZE == 0 +#define MBED_CONF_PLATFORM_ERROR_HIST_SIZE 1 +#endif #endif #ifdef __cplusplus @@ -29,24 +29,24 @@ #endif /* * Puts/Adds an error entry into the error history list - * + * * @param error_ctx pointer to the mbed_error_ctx struct with the error context * @return 0 or MBED_SUCCESS on success. * MBED_ERROR_WRITE_FAILED if writing to file failed - * MBED_ERROR_INVALID_ARGUMENT if path is not valid + * MBED_ERROR_INVALID_ARGUMENT if path is not valid * * */ mbed_error_status_t mbed_error_hist_put(mbed_error_ctx *error_ctx); - + /* * Reads the error entry from the error list with the specified index - * + * * @param index Index of the error context to be retrieved. It starts from 0 and 0 is the oldest. * @param error_ctx pointer to the mbed_error_ctx struct where the error context will be filled, this should be allocated by the caller * @return 0 or MBED_SUCCESS on success. * MBED_ERROR_WRITE_FAILED if writing to file failed - * MBED_ERROR_INVALID_ARGUMENT if path is not valid + * MBED_ERROR_INVALID_ARGUMENT if path is not valid * * */ @@ -55,8 +55,8 @@ /* * Gets a reference to the next error entry in the error log where in the error ctx can be filled in. * Its like reserving the next error entry to fill in the error info - * - * @return Returns the pointer to the next error ctx entry + * + * @return Returns the pointer to the next error ctx entry * * */ @@ -64,11 +64,11 @@ /* * Reads the last(latest) error entry from the error history - * + * * @param error_ctx pointer to the mbed_error_ctx struct where the error context will be filled, this should be allocated by the caller * @return 0 or MBED_SUCCESS on success. * MBED_ERROR_WRITE_FAILED if writing to file failed - * MBED_ERROR_INVALID_ARGUMENT if path is not valid + * MBED_ERROR_INVALID_ARGUMENT if path is not valid * * */ @@ -76,8 +76,8 @@ /* * Returns the number of error entries in the error history list - * - * @return Number of entries in the history list + * + * @return Number of entries in the history list * * */ @@ -85,10 +85,10 @@ /* * Resets the error log by resetting the number of errors to 0 and clears all previous errors in the history list - * + * * @return 0 or MBED_SUCCESS on success. * MBED_ERROR_WRITE_FAILED if writing to file failed - * MBED_ERROR_INVALID_ARGUMENT if path is not valid + * MBED_ERROR_INVALID_ARGUMENT if path is not valid * * */ @@ -96,17 +96,17 @@ /* * Saves the error log information to a file - * + * * @param path path to the file in the filesystem * @return 0 or MBED_SUCCESS on success. * MBED_ERROR_WRITE_FAILED if writing to file failed - * MBED_ERROR_INVALID_ARGUMENT if path is not valid + * MBED_ERROR_INVALID_ARGUMENT if path is not valid * * @note Filesystem support is required in order for this function to work. * */ -mbed_error_status_t mbed_save_error_hist(const char *path); - +mbed_error_status_t mbed_save_error_hist(const char *path); + #ifdef __cplusplus } #endif