AFBR-S50 API Reference Manual v1.5.6
AFBR-S50 Time-of-Flight Sensor SDK for Embedded Software
Loading...
Searching...
No Matches
core_flash.h
Go to the documentation of this file.
1/*************************************************************************/
37#ifndef CORE_FLASH_H
38#define CORE_FLASH_H
39
40/*!***************************************************************************
41 * @defgroup core_flash AFBR-S50 Explorer Flash Module
42 * @ingroup explorer_main
43 * @brief AFBR-S50 Explorer Flash Module
44 * @details An application specific wrapper around the flash module to
45 * save/load the application specific settings.
46 *
47 * @addtogroup core_flash
48 * @{
49 *****************************************************************************/
50
51#include "explorer_types.h"
52
53
54/*!***************************************************************************
55 * @brief Loads the configuration from the flash memory.
56 * @details
57 * @param explorer The Explorer data control block.
58 * @return Returns the \link #status_t status\endlink (#STATUS_OK on success).
59 *****************************************************************************/
60status_t ExplorerApp_LoadCfgFromFlash(explorer_t * explorer);
61
62/*!***************************************************************************
63 * @brief Loads the calibration from the flash memory.
64 * @details
65 * @param explorer The Explorer data control block.
66 * @return Returns the \link #status_t status\endlink (#STATUS_OK on success).
67 *****************************************************************************/
68status_t ExplorerApp_LoadCalFromFlash(explorer_t * explorer);
69
70/*!***************************************************************************
71 * @brief Loads the configuration and calibration from the flash memory.
72 * @details
73 * @param explorer The Explorer data control block.
74 * @return Returns the \link #status_t status\endlink (#STATUS_OK on success).
75 *****************************************************************************/
76status_t ExplorerApp_LoadSettingsFromFlash(explorer_t * explorer);
77
78/*!***************************************************************************
79 * @brief Saves the configuration to the flash memory.
80 * @details
81 * @param explorer The Explorer data control block.
82 * @return Returns the \link #status_t status\endlink (#STATUS_OK on success).
83 *****************************************************************************/
84status_t ExplorerApp_SaveCfgToFlash(explorer_t * explorer);
85
86/*!***************************************************************************
87 * @brief Saves the calibration to the flash memory.
88 * @details
89 * @param explorer The Explorer data control block.
90 * @return Returns the \link #status_t status\endlink (#STATUS_OK on success).
91 *****************************************************************************/
92status_t ExplorerApp_SaveCalToFlash(explorer_t * explorer);
93
94/*!***************************************************************************
95 * @brief Saves the configuration and calibration to the flash memory.
96 * @details
97 * @param explorer The Explorer data control block.
98 * @return Returns the \link #status_t status\endlink (#STATUS_OK on success).
99 *****************************************************************************/
100status_t ExplorerApp_SaveSettingsToFlash(explorer_t * explorer);
101
102/*!***************************************************************************
103 * @brief Deletes the configuration from the flash memory.
104 * @details
105 * @return Returns the \link #status_t status\endlink (#STATUS_OK on success).
106 *****************************************************************************/
107status_t ExplorerApp_ClearCfgFromFlash(void);
108
109/*!***************************************************************************
110 * @brief Deletes the calibration from the flash memory.
111 * @details
112 * @return Returns the \link #status_t status\endlink (#STATUS_OK on success).
113 *****************************************************************************/
114status_t ExplorerApp_ClearCalFromFlash(void);
115
116/*!***************************************************************************
117 * @brief Deletes the configuration and calibration from the flash memory.
118 * @details
119 * @return Returns the \link #status_t status\endlink (#STATUS_OK on success).
120 *****************************************************************************/
121status_t ExplorerApp_ClearSettingsFromFlash(void);
122
123/*!***************************************************************************
124 * @brief Deletes the all application specific values from memory.
125 * @details
126 * @return Returns the \link #status_t status\endlink (#STATUS_OK on success).
127 *****************************************************************************/
128status_t ExplorerApp_ClearFlash(void);
129
130
131/*!***************************************************************************
132 * @brief Deletes the user calibration from the flash memory.
133 * @details
134 * @param explorer The Explorer data control block.
135 * @return Returns the \link #status_t status\endlink (#STATUS_OK on success).
136 *****************************************************************************/
137status_t ExplorerApp_ClearUserCalFromFlash(explorer_t * explorer);
138
140#endif /* CORE_FLASH_H */
explorer_types.h
This file is part of the AFBR-S50 Explorer Demo Application.
status_t
int32_t status_t
Type used for all status and error return values.
Definition argus_status.h:70
ExplorerApp_SaveCalToFlash
status_t ExplorerApp_SaveCalToFlash(explorer_t *explorer)
Saves the calibration to the flash memory.
ExplorerApp_LoadCalFromFlash
status_t ExplorerApp_LoadCalFromFlash(explorer_t *explorer)
Loads the calibration from the flash memory.
ExplorerApp_ClearCfgFromFlash
status_t ExplorerApp_ClearCfgFromFlash(void)
Deletes the configuration from the flash memory.
ExplorerApp_SaveCfgToFlash
status_t ExplorerApp_SaveCfgToFlash(explorer_t *explorer)
Saves the configuration to the flash memory.
ExplorerApp_ClearUserCalFromFlash
status_t ExplorerApp_ClearUserCalFromFlash(explorer_t *explorer)
Deletes the user calibration from the flash memory.
Definition core_flash.c:105
ExplorerApp_LoadCfgFromFlash
status_t ExplorerApp_LoadCfgFromFlash(explorer_t *explorer)
Loads the configuration from the flash memory.
ExplorerApp_ClearCalFromFlash
status_t ExplorerApp_ClearCalFromFlash(void)
Deletes the calibration from the flash memory.
ExplorerApp_LoadSettingsFromFlash
status_t ExplorerApp_LoadSettingsFromFlash(explorer_t *explorer)
Loads the configuration and calibration from the flash memory.
ExplorerApp_ClearFlash
status_t ExplorerApp_ClearFlash(void)
Deletes the all application specific values from memory.
Definition core_flash.c:71
ExplorerApp_SaveSettingsToFlash
status_t ExplorerApp_SaveSettingsToFlash(explorer_t *explorer)
Saves the configuration and calibration to the flash memory.
ExplorerApp_ClearSettingsFromFlash
status_t ExplorerApp_ClearSettingsFromFlash(void)
Deletes the configuration and calibration from the flash memory.
explorer_t
Definition explorer_types.h:206