112 lines
3.2 KiB
C
112 lines
3.2 KiB
C
/*
|
|
Managed Flash Storage - Copyright (C) 2016 Giovanni Di Sirio
|
|
|
|
This file is part of ChibiOS.
|
|
|
|
ChibiOS is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation; either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
ChibiOS is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
/**
|
|
* @file mfs.h
|
|
* @brief Managed Flash Storage module header.
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
#ifndef MFS_H
|
|
#define MFS_H
|
|
|
|
#include "hal_flash.h"
|
|
|
|
/*===========================================================================*/
|
|
/* Driver constants. */
|
|
/*===========================================================================*/
|
|
|
|
/*===========================================================================*/
|
|
/* Driver pre-compile time settings. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @name Configuration options
|
|
* @{
|
|
*/
|
|
/** @} */
|
|
|
|
/*===========================================================================*/
|
|
/* Derived constants and error checks. */
|
|
/*===========================================================================*/
|
|
|
|
/*===========================================================================*/
|
|
/* Driver data structures and types. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @brief Driver state machine possible states.
|
|
*/
|
|
typedef enum {
|
|
MFS_UNINIT = 0,
|
|
MFS_STOP = 1,
|
|
MFS_READY = 2,
|
|
MFS_ACTIVE = 3
|
|
} mfs_state_t;
|
|
|
|
/**
|
|
* @brief Type of a MFS configuration structure.
|
|
*/
|
|
typedef struct {
|
|
/**
|
|
* @brief Flash driver associated to this MFS instance.
|
|
*/
|
|
BaseFlash *flashp;
|
|
} MFSConfig;
|
|
|
|
/**
|
|
* @extends BaseFlash
|
|
*
|
|
* @brief Type of an MFS instance.
|
|
*/
|
|
typedef struct {
|
|
/**
|
|
* @brief Driver state.
|
|
*/
|
|
mfs_state_t state;
|
|
/**
|
|
* @brief Current configuration data.
|
|
*/
|
|
const MFSConfig *config;
|
|
} MFSDriver;
|
|
|
|
/*===========================================================================*/
|
|
/* Driver macros. */
|
|
/*===========================================================================*/
|
|
|
|
/*===========================================================================*/
|
|
/* External declarations. */
|
|
/*===========================================================================*/
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
void mfsObjectInit(MFSDriver *devp);
|
|
void mfsStart(MFSDriver *devp, const MFSConfig *config);
|
|
void mfsStop(MFSDriver *devp);
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* MFS_H */
|
|
|
|
/** @} */
|
|
|