core_flash.h

Go to the documentation of this file.

/*************************************************************************/
#ifndef CORE_FLASH_H
#define CORE_FLASH_H
 
/*!***************************************************************************
 * @defgroup    core_flash AFBR-S50 Explorer Flash Module
 * @ingroup     explorer_main
 * @brief       AFBR-S50 Explorer Flash Module
 * @details     An application specific wrapper around the flash module to
 *              save/load the application specific settings.
 *
 * @addtogroup  core_flash
 * @{
 *****************************************************************************/
 
#include "explorer_types.h"
 
 
/*!***************************************************************************
 * @brief   Loads the configuration from the flash memory.
 * @details
 * @param   explorer The Explorer data control block.
 * @return  Returns the \link #status_t status\endlink (#STATUS_OK on success).
 *****************************************************************************/
status_t ExplorerApp_LoadCfgFromFlash(explorer_t * explorer);
 
/*!***************************************************************************
 * @brief   Loads the calibration from the flash memory.
 * @details
 * @param   explorer The Explorer data control block.
 * @return  Returns the \link #status_t status\endlink (#STATUS_OK on success).
 *****************************************************************************/
status_t ExplorerApp_LoadCalFromFlash(explorer_t * explorer);
 
/*!***************************************************************************
 * @brief   Loads the configuration and calibration from the flash memory.
 * @details
 * @param   explorer The Explorer data control block.
 * @return  Returns the \link #status_t status\endlink (#STATUS_OK on success).
 *****************************************************************************/
status_t ExplorerApp_LoadSettingsFromFlash(explorer_t * explorer);
 
/*!***************************************************************************
 * @brief   Saves the configuration to the flash memory.
 * @details
 * @param   explorer The Explorer data control block.
 * @return  Returns the \link #status_t status\endlink (#STATUS_OK on success).
 *****************************************************************************/
status_t ExplorerApp_SaveCfgToFlash(explorer_t * explorer);
 
/*!***************************************************************************
 * @brief   Saves the calibration to the flash memory.
 * @details
 * @param   explorer The Explorer data control block.
 * @return  Returns the \link #status_t status\endlink (#STATUS_OK on success).
 *****************************************************************************/
status_t ExplorerApp_SaveCalToFlash(explorer_t * explorer);
 
/*!***************************************************************************
 * @brief   Saves the configuration and calibration to the flash memory.
 * @details
 * @param   explorer The Explorer data control block.
 * @return  Returns the \link #status_t status\endlink (#STATUS_OK on success).
 *****************************************************************************/
status_t ExplorerApp_SaveSettingsToFlash(explorer_t * explorer);
 
/*!***************************************************************************
 * @brief   Deletes the configuration from the flash memory.
 * @details
 * @return  Returns the \link #status_t status\endlink (#STATUS_OK on success).
 *****************************************************************************/
status_t ExplorerApp_ClearCfgFromFlash(void);
 
/*!***************************************************************************
 * @brief   Deletes the calibration from the flash memory.
 * @details
 * @return  Returns the \link #status_t status\endlink (#STATUS_OK on success).
 *****************************************************************************/
status_t ExplorerApp_ClearCalFromFlash(void);
 
/*!***************************************************************************
 * @brief   Deletes the configuration and calibration from the flash memory.
 * @details
 * @return  Returns the \link #status_t status\endlink (#STATUS_OK on success).
 *****************************************************************************/
status_t ExplorerApp_ClearSettingsFromFlash(void);
 
/*!***************************************************************************
 * @brief   Deletes the all application specific values from memory.
 * @details
 * @return  Returns the \link #status_t status\endlink (#STATUS_OK on success).
 *****************************************************************************/
status_t ExplorerApp_ClearFlash(void);
 
 
/*!***************************************************************************
 * @brief   Deletes the user calibration from the flash memory.
 * @details
 * @param   explorer The Explorer data control block.
 * @return  Returns the \link #status_t status\endlink (#STATUS_OK on success).
 *****************************************************************************/
status_t ExplorerApp_ClearUserCalFromFlash(explorer_t * explorer);
 
#endif /* CORE_FLASH_H */