takashi kadono / Mbed OS Nucleo446_SSD1331

Color Oled(SSD1331) connect to STMicroelectronics Nucleo-F466

Dependencies:   ssd1331

mbed-os/platform/mbed_error_hist.h@3:f3764f852aa8, 2018-10-11 (annotated)

Committer:
kadonotakashi
Date:
Thu Oct 11 02:27:46 2018 +0000
Revision:
3:f3764f852aa8
Parent:
0:8fdf9a60065b 
Nucreo 446 + SSD1331 test version;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kadonotakashi 0:8fdf9a60065b 1 /* mbed Microcontroller Library
kadonotakashi 0:8fdf9a60065b 2 * Copyright (c) 2006-2013 ARM Limited
kadonotakashi 0:8fdf9a60065b 3 *
kadonotakashi 0:8fdf9a60065b 4 * Licensed under the Apache License, Version 2.0 (the "License");
kadonotakashi 0:8fdf9a60065b 5 * you may not use this file except in compliance with the License.
kadonotakashi 0:8fdf9a60065b 6 * You may obtain a copy of the License at
kadonotakashi 0:8fdf9a60065b 7 *
kadonotakashi 0:8fdf9a60065b 8 * http://www.apache.org/licenses/LICENSE-2.0
kadonotakashi 0:8fdf9a60065b 9 *
kadonotakashi 0:8fdf9a60065b 10 * Unless required by applicable law or agreed to in writing, software
kadonotakashi 0:8fdf9a60065b 11 * distributed under the License is distributed on an "AS IS" BASIS,
kadonotakashi 0:8fdf9a60065b 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
kadonotakashi 0:8fdf9a60065b 13 * See the License for the specific language governing permissions and
kadonotakashi 0:8fdf9a60065b 14 * limitations under the License.
kadonotakashi 0:8fdf9a60065b 15 */
kadonotakashi 0:8fdf9a60065b 16 #ifndef MBED_ERROR_HIST_H
kadonotakashi 0:8fdf9a60065b 17 #define MBED_ERROR_HIST_H
kadonotakashi 0:8fdf9a60065b 18
kadonotakashi 0:8fdf9a60065b 19 #ifndef MBED_CONF_PLATFORM_ERROR_HIST_SIZE
kadonotakashi 0:8fdf9a60065b 20 #define MBED_CONF_PLATFORM_ERROR_HIST_SIZE 4
kadonotakashi 0:8fdf9a60065b 21 #else
kadonotakashi 0:8fdf9a60065b 22 #if MBED_CONF_PLATFORM_ERROR_HIST_SIZE == 0
kadonotakashi 0:8fdf9a60065b 23 #define MBED_CONF_PLATFORM_ERROR_HIST_SIZE 1
kadonotakashi 0:8fdf9a60065b 24 #endif
kadonotakashi 0:8fdf9a60065b 25 #endif
kadonotakashi 0:8fdf9a60065b 26
kadonotakashi 0:8fdf9a60065b 27 #ifdef __cplusplus
kadonotakashi 0:8fdf9a60065b 28 extern "C" {
kadonotakashi 0:8fdf9a60065b 29 #endif
kadonotakashi 0:8fdf9a60065b 30 /*
kadonotakashi 0:8fdf9a60065b 31 * Puts/Adds an error entry into the error history list
kadonotakashi 0:8fdf9a60065b 32 *
kadonotakashi 0:8fdf9a60065b 33 * @param error_ctx pointer to the mbed_error_ctx struct with the error context
kadonotakashi 0:8fdf9a60065b 34 * @return 0 or MBED_SUCCESS on success.
kadonotakashi 0:8fdf9a60065b 35 * MBED_ERROR_WRITE_FAILED if writing to file failed
kadonotakashi 0:8fdf9a60065b 36 * MBED_ERROR_INVALID_ARGUMENT if path is not valid
kadonotakashi 0:8fdf9a60065b 37 *
kadonotakashi 0:8fdf9a60065b 38 *
kadonotakashi 0:8fdf9a60065b 39 */
kadonotakashi 0:8fdf9a60065b 40 mbed_error_status_t mbed_error_hist_put(mbed_error_ctx *error_ctx);
kadonotakashi 0:8fdf9a60065b 41
kadonotakashi 0:8fdf9a60065b 42 /*
kadonotakashi 0:8fdf9a60065b 43 * Reads the error entry from the error list with the specified index
kadonotakashi 0:8fdf9a60065b 44 *
kadonotakashi 0:8fdf9a60065b 45 * @param index Index of the error context to be retrieved. It starts from 0 and 0 is the oldest.
kadonotakashi 0:8fdf9a60065b 46 * @param error_ctx pointer to the mbed_error_ctx struct where the error context will be filled, this should be allocated by the caller
kadonotakashi 0:8fdf9a60065b 47 * @return 0 or MBED_SUCCESS on success.
kadonotakashi 0:8fdf9a60065b 48 * MBED_ERROR_WRITE_FAILED if writing to file failed
kadonotakashi 0:8fdf9a60065b 49 * MBED_ERROR_INVALID_ARGUMENT if path is not valid
kadonotakashi 0:8fdf9a60065b 50 *
kadonotakashi 0:8fdf9a60065b 51 *
kadonotakashi 0:8fdf9a60065b 52 */
kadonotakashi 0:8fdf9a60065b 53 mbed_error_status_t mbed_error_hist_get(int index, mbed_error_ctx *error_ctx);
kadonotakashi 0:8fdf9a60065b 54
kadonotakashi 0:8fdf9a60065b 55 /*
kadonotakashi 0:8fdf9a60065b 56 * Gets a reference to the next error entry in the error log where in the error ctx can be filled in.
kadonotakashi 0:8fdf9a60065b 57 * Its like reserving the next error entry to fill in the error info
kadonotakashi 0:8fdf9a60065b 58 *
kadonotakashi 0:8fdf9a60065b 59 * @return Returns the pointer to the next error ctx entry
kadonotakashi 0:8fdf9a60065b 60 *
kadonotakashi 0:8fdf9a60065b 61 *
kadonotakashi 0:8fdf9a60065b 62 */
kadonotakashi 0:8fdf9a60065b 63 mbed_error_ctx *mbed_error_hist_get_entry(void);
kadonotakashi 0:8fdf9a60065b 64
kadonotakashi 0:8fdf9a60065b 65 /*
kadonotakashi 0:8fdf9a60065b 66 * Reads the last(latest) error entry from the error history
kadonotakashi 0:8fdf9a60065b 67 *
kadonotakashi 0:8fdf9a60065b 68 * @param error_ctx pointer to the mbed_error_ctx struct where the error context will be filled, this should be allocated by the caller
kadonotakashi 0:8fdf9a60065b 69 * @return 0 or MBED_SUCCESS on success.
kadonotakashi 0:8fdf9a60065b 70 * MBED_ERROR_WRITE_FAILED if writing to file failed
kadonotakashi 0:8fdf9a60065b 71 * MBED_ERROR_INVALID_ARGUMENT if path is not valid
kadonotakashi 0:8fdf9a60065b 72 *
kadonotakashi 0:8fdf9a60065b 73 *
kadonotakashi 0:8fdf9a60065b 74 */
kadonotakashi 0:8fdf9a60065b 75 mbed_error_status_t mbed_error_hist_get_last_error(mbed_error_ctx *error_ctx);
kadonotakashi 0:8fdf9a60065b 76
kadonotakashi 0:8fdf9a60065b 77 /*
kadonotakashi 0:8fdf9a60065b 78 * Returns the number of error entries in the error history list
kadonotakashi 0:8fdf9a60065b 79 *
kadonotakashi 0:8fdf9a60065b 80 * @return Number of entries in the history list
kadonotakashi 0:8fdf9a60065b 81 *
kadonotakashi 0:8fdf9a60065b 82 *
kadonotakashi 0:8fdf9a60065b 83 */
kadonotakashi 0:8fdf9a60065b 84 int mbed_error_hist_get_count(void);
kadonotakashi 0:8fdf9a60065b 85
kadonotakashi 0:8fdf9a60065b 86 /*
kadonotakashi 0:8fdf9a60065b 87 * Resets the error log by resetting the number of errors to 0 and clears all previous errors in the history list
kadonotakashi 0:8fdf9a60065b 88 *
kadonotakashi 0:8fdf9a60065b 89 * @return 0 or MBED_SUCCESS on success.
kadonotakashi 0:8fdf9a60065b 90 * MBED_ERROR_WRITE_FAILED if writing to file failed
kadonotakashi 0:8fdf9a60065b 91 * MBED_ERROR_INVALID_ARGUMENT if path is not valid
kadonotakashi 0:8fdf9a60065b 92 *
kadonotakashi 0:8fdf9a60065b 93 *
kadonotakashi 0:8fdf9a60065b 94 */
kadonotakashi 0:8fdf9a60065b 95 mbed_error_status_t mbed_error_hist_reset(void);
kadonotakashi 0:8fdf9a60065b 96
kadonotakashi 0:8fdf9a60065b 97 /*
kadonotakashi 0:8fdf9a60065b 98 * Saves the error log information to a file
kadonotakashi 0:8fdf9a60065b 99 *
kadonotakashi 0:8fdf9a60065b 100 * @param path path to the file in the filesystem
kadonotakashi 0:8fdf9a60065b 101 * @return 0 or MBED_SUCCESS on success.
kadonotakashi 0:8fdf9a60065b 102 * MBED_ERROR_WRITE_FAILED if writing to file failed
kadonotakashi 0:8fdf9a60065b 103 * MBED_ERROR_INVALID_ARGUMENT if path is not valid
kadonotakashi 0:8fdf9a60065b 104 *
kadonotakashi 0:8fdf9a60065b 105 * @note Filesystem support is required in order for this function to work.
kadonotakashi 0:8fdf9a60065b 106 *
kadonotakashi 0:8fdf9a60065b 107 */
kadonotakashi 0:8fdf9a60065b 108 mbed_error_status_t mbed_save_error_hist(const char *path);
kadonotakashi 0:8fdf9a60065b 109
kadonotakashi 0:8fdf9a60065b 110 #ifdef __cplusplus
kadonotakashi 0:8fdf9a60065b 111 }
kadonotakashi 0:8fdf9a60065b 112 #endif
kadonotakashi 0:8fdf9a60065b 113
kadonotakashi 0:8fdf9a60065b 114 #endif
kadonotakashi 0:8fdf9a60065b 115
kadonotakashi 0:8fdf9a60065b 116