aboutsummaryrefslogtreecommitdiffstats
path: root/os/ex/subsystems/mfs
diff options
context:
space:
mode:
Diffstat (limited to 'os/ex/subsystems/mfs')
-rw-r--r--os/ex/subsystems/mfs/mfs.c1366
-rw-r--r--os/ex/subsystems/mfs/mfs.h678
2 files changed, 1022 insertions, 1022 deletions
diff --git a/os/ex/subsystems/mfs/mfs.c b/os/ex/subsystems/mfs/mfs.c
index d232b664d..99a3c0c1b 100644
--- a/os/ex/subsystems/mfs/mfs.c
+++ b/os/ex/subsystems/mfs/mfs.c
@@ -1,683 +1,683 @@
-/*
- 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.c
- * @brief Managed Flash Storage module code.
- * @details This module manages a flash partition as a generic storage where
- * arbitrary data records can be created, updated, deleted and
- * retrieved.<br>
- * A managed partition is composed of two banks of equal size, a
- * bank is composed of one or more erasable sectors, a sector is
- * divided in writable pages.<br>
- * The module handles flash wear leveling and recovery of damaged
- * banks (where possible) caused by power loss during operations.
- * Both operations are transparent to the user.
- *
- * @addtogroup mfs
- * @{
- */
-
-#include "hal.h"
-
-#include "mfs.h"
-
-/*===========================================================================*/
-/* Driver local definitions. */
-/*===========================================================================*/
-
-#define PAIR(a, b) (((unsigned)(a) << 2U) | (unsigned)(b))
-
-/**
- * @brief Error check helper.
- */
-#define RET_ON_ERROR(err) do { \
- mfs_error_t e = (err); \
- if (e != MFS_NO_ERROR) { \
- return e; \
- } \
-} while (false)
-
-/*===========================================================================*/
-/* Driver exported variables. */
-/*===========================================================================*/
-
-/*===========================================================================*/
-/* Driver local variables and types. */
-/*===========================================================================*/
-
-const uint16_t crc16_table[256] = {
- 0x0000, 0x1021, 0x2042, 0x3063, 0x4084, 0x50A5, 0x60C6, 0x70E7,
- 0x8108, 0x9129, 0xA14A, 0xB16B, 0xC18C, 0xD1AD, 0xE1CE, 0xF1EF,
- 0x1231, 0x0210, 0x3273, 0x2252, 0x52B5, 0x4294, 0x72F7, 0x62D6,
- 0x9339, 0x8318, 0xB37B, 0xA35A, 0xD3BD, 0xC39C, 0xF3FF, 0xE3DE,
- 0x2462, 0x3443, 0x0420, 0x1401, 0x64E6, 0x74C7, 0x44A4, 0x5485,
- 0xA56A, 0xB54B, 0x8528, 0x9509, 0xE5EE, 0xF5CF, 0xC5AC, 0xD58D,
- 0x3653, 0x2672, 0x1611, 0x0630, 0x76D7, 0x66F6, 0x5695, 0x46B4,
- 0xB75B, 0xA77A, 0x9719, 0x8738, 0xF7DF, 0xE7FE, 0xD79D, 0xC7BC,
- 0x48C4, 0x58E5, 0x6886, 0x78A7, 0x0840, 0x1861, 0x2802, 0x3823,
- 0xC9CC, 0xD9ED, 0xE98E, 0xF9AF, 0x8948, 0x9969, 0xA90A, 0xB92B,
- 0x5AF5, 0x4AD4, 0x7AB7, 0x6A96, 0x1A71, 0x0A50, 0x3A33, 0x2A12,
- 0xDBFD, 0xCBDC, 0xFBBF, 0xEB9E, 0x9B79, 0x8B58, 0xBB3B, 0xAB1A,
- 0x6CA6, 0x7C87, 0x4CE4, 0x5CC5, 0x2C22, 0x3C03, 0x0C60, 0x1C41,
- 0xEDAE, 0xFD8F, 0xCDEC, 0xDDCD, 0xAD2A, 0xBD0B, 0x8D68, 0x9D49,
- 0x7E97, 0x6EB6, 0x5ED5, 0x4EF4, 0x3E13, 0x2E32, 0x1E51, 0x0E70,
- 0xFF9F, 0xEFBE, 0xDFDD, 0xCFFC, 0xBF1B, 0xAF3A, 0x9F59, 0x8F78,
- 0x9188, 0x81A9, 0xB1CA, 0xA1EB, 0xD10C, 0xC12D, 0xF14E, 0xE16F,
- 0x1080, 0x00A1, 0x30C2, 0x20E3, 0x5004, 0x4025, 0x7046, 0x6067,
- 0x83B9, 0x9398, 0xA3FB, 0xB3DA, 0xC33D, 0xD31C, 0xE37F, 0xF35E,
- 0x02B1, 0x1290, 0x22F3, 0x32D2, 0x4235, 0x5214, 0x6277, 0x7256,
- 0xB5EA, 0xA5CB, 0x95A8, 0x8589, 0xF56E, 0xE54F, 0xD52C, 0xC50D,
- 0x34E2, 0x24C3, 0x14A0, 0x0481, 0x7466, 0x6447, 0x5424, 0x4405,
- 0xA7DB, 0xB7FA, 0x8799, 0x97B8, 0xE75F, 0xF77E, 0xC71D, 0xD73C,
- 0x26D3, 0x36F2, 0x0691, 0x16B0, 0x6657, 0x7676, 0x4615, 0x5634,
- 0xD94C, 0xC96D, 0xF90E, 0xE92F, 0x99C8, 0x89E9, 0xB98A, 0xA9AB,
- 0x5844, 0x4865, 0x7806, 0x6827, 0x18C0, 0x08E1, 0x3882, 0x28A3,
- 0xCB7D, 0xDB5C, 0xEB3F, 0xFB1E, 0x8BF9, 0x9BD8, 0xABBB, 0xBB9A,
- 0x4A75, 0x5A54, 0x6A37, 0x7A16, 0x0AF1, 0x1AD0, 0x2AB3, 0x3A92,
- 0xFD2E, 0xED0F, 0xDD6C, 0xCD4D, 0xBDAA, 0xAD8B, 0x9DE8, 0x8DC9,
- 0x7C26, 0x6C07, 0x5C64, 0x4C45, 0x3CA2, 0x2C83, 0x1CE0, 0x0CC1,
- 0xEF1F, 0xFF3E, 0xCF5D, 0xDF7C, 0xAF9B, 0xBFBA, 0x8FD9, 0x9FF8,
- 0x6E17, 0x7E36, 0x4E55, 0x5E74, 0x2E93, 0x3EB2, 0x0ED1, 0x1EF0
-};
-
-/*===========================================================================*/
-/* Driver local functions. */
-/*===========================================================================*/
-
-uint16_t crc16(uint16_t crc, const uint8_t *data, size_t n) {
-
- while (n > 0U) {
- crc = (crc << 8U) ^ crc16_table[(crc >> 8U) ^ (uint16_t)*data];
- data++;
- n--;
- }
-
- return crc;
-}
-
-#if (MFS_CFG_ID_CACHE_SIZE > 0) || defined(__DOXYGEN__)
-void mfs_cache_init(MFSDriver *devp) {
-
- (void)devp;
-}
-
-mfs_cached_id_t *mfs_cache_find_id(MFSDriver *devp, uint32_t id) {
-
- (void)devp;
- (void)id;
-
- return NULL;
-}
-
-void mfs_cache_update_id(MFSDriver *devp, uint32_t id) {
-
- (void)devp;
- (void)id;
-}
-
-void mfs_cache_erase_id(MFSDriver *devp, uint32_t id) {
-
- (void)devp;
- (void)id;
-}
-#endif /* MFS_CFG_ID_CACHE_SIZE > 0 */
-
-/**
- * @brief Flash write.
- * @note If the option @p MFS_CFG_WRITE_VERIFY is enabled then the flash
- * is also read back for verification.
- *
- * @param[in] devp pointer to the @p MFSDriver object
- * @param[in] offset flash offset
- * @param[in] n number of bytes to be read
- * @param[out] rp pointer to the data buffer
- * @return The operation status.
- * @retval MFS_NO_ERROR if the operation has been successfully completed.
- * @retval MFS_FLASH_FAILURE if the flash memory is unusable because HW
- * failures.
- *
- * @notapi
- */
-static mfs_error_t mfs_flash_write(MFSDriver *devp,
- flash_offset_t offset,
- size_t n, const
- uint8_t *p) {
- flash_error_t ferr;
-
- ferr = flashProgram(devp->config->flashp, offset, n, p);
- if (ferr != FLASH_NO_ERROR) {
- return MFS_FLASH_FAILURE;
- }
-
- return MFS_NO_ERROR;
-}
-
-/**
- * @brief Erases and verifies all sectors belonging to a bank.
- *
- * @param[in] devp pointer to the @p MFSDriver object
- * @param[in] bank bank to be erased
- * @return The operation status.
- * @retval MFS_NO_ERROR if the operation has been successfully completed.
- * @retval MFS_FLASH_FAILURE if the flash memory is unusable because HW
- * failures.
- *
- * @notapi
- */
-static mfs_error_t mfs_bank_erase(MFSDriver *devp, mfs_bank_t bank) {
- flash_sector_t sector, end;
-
- if (bank == MFS_BANK_0) {
- sector = devp->config->bank0_start;
- end = devp->config->bank0_start + devp->config->bank0_sectors;
- }
- else {
- sector = devp->config->bank1_start;
- end = devp->config->bank1_start + devp->config->bank1_sectors;
- }
-
- while (sector < end) {
- flash_error_t ferr;
-
- ferr = flashStartEraseSector(devp->config->flashp, sector);
- if (ferr != FLASH_NO_ERROR) {
- return MFS_FLASH_FAILURE;
- }
- ferr = flashWaitErase(devp->config->flashp);
- if (ferr != FLASH_NO_ERROR) {
- return MFS_FLASH_FAILURE;
- }
- ferr = flashVerifyErase(devp->config->flashp, sector);
- if (ferr != FLASH_NO_ERROR) {
- return MFS_FLASH_FAILURE;
- }
-
- sector++;
- }
-
- return MFS_NO_ERROR;
-}
-
-/**
- * @brief Writes the validation header in a bank.
- *
- * @param[in] devp pointer to the @p MFSDriver object
- * @param[in] bank bank to be validated
- * @param[in] cnt value for the flash usage counter
- * @return The operation status.
- * @retval MFS_NO_ERROR if the operation has been successfully completed.
- * @retval MFS_FLASH_FAILURE if the flash memory is unusable because HW
- * failures.
- *
- * @notapi
- */
-static mfs_error_t mfs_bank_set_header(MFSDriver *devp,
- mfs_bank_t bank,
- uint32_t cnt) {
- flash_sector_t sector;
- mfs_bank_header_t header;
-
- if (bank == MFS_BANK_0) {
- sector = devp->config->bank0_start;
- }
- else {
- sector = devp->config->bank1_start;
- }
-
- header.magic1 = MFS_BANK_MAGIC_1;
- header.magic1 = MFS_BANK_MAGIC_1;
- header.counter = cnt;
- header.next = sizeof (mfs_bank_header_t);
- header.crc = crc16(0xFFFFU,
- (const uint8_t *)&header,
- sizeof (flash_sector_t) - sizeof (uint16_t));
-
- return mfs_flash_write(devp,
- flashGetSectorOffset(devp->config->flashp, sector),
- sizeof (mfs_bank_header_t),
- (const uint8_t *)&header);
-}
-
-/**
- * @brief Copies all records from a bank to another.
- *
- * @param[in] devp pointer to the @p MFSDriver object
- * @param[in] sbank source bank
- * @param[in] dbank destination bank
- * @return The operation status.
- * @retval MFS_NO_ERROR if the operation has been successfully completed.
- * @retval MFS_FLASH_FAILURE if the flash memory is unusable because HW
- * failures.
- *
- * @notapi
- */
-static mfs_error_t mfs_copy_bank(MFSDriver *devp,
- mfs_bank_t sbank,
- mfs_bank_t dbank) {
-
- (void)devp;
- (void)sbank;
- (void)dbank;
-
- return MFS_NO_ERROR;
-}
-
-/**
- * @brief Selects a bank as current.
- *
- * @param[in] devp pointer to the @p MFSDriver object
- * @param[in] bank bank to be erased
- * @return The operation status.
- * @retval MFS_NO_ERROR if the operation has been successfully completed.
- *
- * @notapi
- */
-static mfs_error_t mfs_mount(MFSDriver *devp, mfs_bank_t bank) {
-
- (void)devp;
- (void)bank;
-
- return MFS_NO_ERROR;
-}
-
-/**
- * @brief Determines the state of a flash bank.
- *
- * @param[in] devp pointer to the @p MFSDriver object
- * @param[in] bank the bank identifier
- * @param[out] cntp bank counter value, only valid if the bank is not
- * in the @p MFS_BANK_GARBAGE or @p MFS_BANK_ERASED
- * states.
- *
- * @return The bank state.
- * @retval MFS_BANK_ERASED if the bank is fully erased.
- * @retval MFS_BANK_OK if the bank contains valid data.
- * @retval MFS_BANK_PARTIAL if the bank contains errors but the data is still
- * readable.
- * @retval MFS_BANK_GARBAGE if the bank contains unreadable garbage.
- */
-static mfs_bank_state_t mfs_get_bank_state(MFSDriver *devp,
- mfs_bank_t bank,
- uint32_t *cntp) {
-
- (void)devp;
- (void)bank;
- (void)cntp;
-
- return MFS_BANK_OK;
-}
-
-/**
- * @brief Performs a flash partition mount attempt.
- *
- * @param[in] devp pointer to the @p MFSDriver object
- * @return The operation status.
- * @retval MFS_NO_ERROR if the operation has been successfully completed.
- * @retval MFS_REPAIR_WARNING if the operation has been completed but a
- * repair has been performed.
- * @retval MFS_FLASH_FAILURE if the flash memory is unusable because HW
- * failures.
- *
- * @api
- */
-static mfs_error_t mfs_try_mount(MFSDriver *devp) {
- mfs_bank_state_t sts0, sts1;
- uint32_t cnt0 = 0, cnt1 = 0;
-
- /* Assessing the state of the two banks.*/
- sts0 = mfs_get_bank_state(devp, MFS_BANK_0, &cnt0);
- sts1 = mfs_get_bank_state(devp, MFS_BANK_1, &cnt1);
-
- /* Handling all possible scenarios, each one requires its own recovery
- strategy.*/
- switch (PAIR(sts0, sts1)) {
-
- case PAIR(MFS_BANK_ERASED, MFS_BANK_ERASED):
- /* Both banks erased, first initialization.*/
- RET_ON_ERROR(mfs_bank_set_header(devp, MFS_BANK_0, 1));
- RET_ON_ERROR(mfs_mount(devp, MFS_BANK_0));
- return MFS_NO_ERROR;
-
- case PAIR(MFS_BANK_ERASED, MFS_BANK_OK):
- /* Normal situation, bank one is used.*/
- RET_ON_ERROR(mfs_mount(devp, MFS_BANK_1));
- return MFS_NO_ERROR;
-
- case PAIR(MFS_BANK_ERASED, MFS_BANK_PARTIAL):
- /* Bank zero is erased, bank one has problems.*/
- RET_ON_ERROR(mfs_copy_bank(devp, MFS_BANK_1, MFS_BANK_0));
- RET_ON_ERROR(mfs_bank_set_header(devp, MFS_BANK_0, cnt1 + 1));
- RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_1));
- RET_ON_ERROR(mfs_mount(devp, MFS_BANK_0));
- return MFS_REPAIR_WARNING;
-
- case PAIR(MFS_BANK_ERASED, MFS_BANK_GARBAGE):
- /* Bank zero is erased, bank one is not readable.*/
- RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_1));
- RET_ON_ERROR(mfs_bank_set_header(devp, MFS_BANK_0, 1));
- RET_ON_ERROR(mfs_mount(devp, MFS_BANK_0));
- return MFS_REPAIR_WARNING;
-
- case PAIR(MFS_BANK_OK, MFS_BANK_ERASED):
- /* Normal situation, bank zero is used.*/
- RET_ON_ERROR(mfs_mount(devp, MFS_BANK_0));
- return MFS_NO_ERROR;
-
- case PAIR(MFS_BANK_OK, MFS_BANK_OK):
- /* Both banks appear to be valid but one must be newer, erasing the
- older one.*/
- if (cnt0 > cnt1) {
- /* Bank 0 is newer.*/
- RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_1));
- RET_ON_ERROR(mfs_mount(devp, MFS_BANK_0));
- }
- else {
- /* Bank 1 is newer.*/
- RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_0));
- RET_ON_ERROR(mfs_mount(devp, MFS_BANK_1));
- }
- return MFS_REPAIR_WARNING;
-
- case PAIR(MFS_BANK_OK, MFS_BANK_PARTIAL):
- /* Bank zero is normal, bank one has problems.*/
- if (cnt0 > cnt1) {
- /* Normal bank zero is more recent than the partial bank one, the
- partial bank needs to be erased.*/
- RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_1));
- RET_ON_ERROR(mfs_mount(devp, MFS_BANK_0));
- }
- else {
- /* Partial bank one is more recent than the normal bank zero.*/
- RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_0));
- RET_ON_ERROR(mfs_copy_bank(devp, MFS_BANK_1, MFS_BANK_0));
- RET_ON_ERROR(mfs_bank_set_header(devp, MFS_BANK_0, cnt1 + 1));
- RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_1));
- RET_ON_ERROR(mfs_mount(devp, MFS_BANK_0));
- }
- return MFS_REPAIR_WARNING;
-
- case PAIR(MFS_BANK_OK, MFS_BANK_GARBAGE):
- /* Bank zero is normal, bank one is unreadable.*/
- RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_1));
- RET_ON_ERROR(mfs_mount(devp, MFS_BANK_0));
- return MFS_REPAIR_WARNING;
-
- case PAIR(MFS_BANK_PARTIAL, MFS_BANK_ERASED):
- /* Bank zero has problems, bank one is erased.*/
- RET_ON_ERROR(mfs_copy_bank(devp, MFS_BANK_0, MFS_BANK_1));
- RET_ON_ERROR(mfs_bank_set_header(devp, MFS_BANK_1, cnt0 + 1));
- RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_0));
- RET_ON_ERROR(mfs_mount(devp, MFS_BANK_1));
- return MFS_REPAIR_WARNING;
-
- case PAIR(MFS_BANK_PARTIAL, MFS_BANK_OK):
- /* Bank zero has problems, bank one is normal.*/
- if (cnt1 > cnt0) {
- /* Normal bank one is more recent than the partial bank zero, the
- partial bank has to be erased.*/
- RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_0));
- RET_ON_ERROR(mfs_mount(devp, MFS_BANK_1));
- }
- else {
- /* Partial bank zero is more recent than the normal bank one.*/
- RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_1));
- RET_ON_ERROR(mfs_copy_bank(devp, MFS_BANK_0, MFS_BANK_1));
- RET_ON_ERROR(mfs_bank_set_header(devp, MFS_BANK_1, cnt0 + 1));
- RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_0));
- RET_ON_ERROR(mfs_mount(devp, MFS_BANK_1));
- }
- return MFS_REPAIR_WARNING;
-
- case PAIR(MFS_BANK_PARTIAL, MFS_BANK_PARTIAL):
- /* Both banks have problems.*/
- if (cnt0 > cnt1) {
- /* Bank zero is newer, copying in bank one and using it.*/
- RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_1));
- RET_ON_ERROR(mfs_copy_bank(devp, MFS_BANK_0, MFS_BANK_1));
- RET_ON_ERROR(mfs_bank_set_header(devp, MFS_BANK_1, cnt0 + 1));
- RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_0));
- RET_ON_ERROR(mfs_mount(devp, MFS_BANK_1));
- }
- else {
- /* Bank one is newer, copying in bank zero and using it.*/
- RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_0));
- RET_ON_ERROR(mfs_copy_bank(devp, MFS_BANK_1, MFS_BANK_0));
- RET_ON_ERROR(mfs_bank_set_header(devp, MFS_BANK_0, cnt1 + 1));
- RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_1));
- RET_ON_ERROR(mfs_mount(devp, MFS_BANK_0));
- }
- return MFS_REPAIR_WARNING;
-
- case PAIR(MFS_BANK_PARTIAL, MFS_BANK_GARBAGE):
- /* Bank zero has problems, bank one is unreadable.*/
- RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_1));
- RET_ON_ERROR(mfs_copy_bank(devp, MFS_BANK_0, MFS_BANK_1));
- RET_ON_ERROR(mfs_bank_set_header(devp, MFS_BANK_1, cnt0 + 1));
- RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_0));
- RET_ON_ERROR(mfs_mount(devp, MFS_BANK_1));
- return MFS_REPAIR_WARNING;
-
- case PAIR(MFS_BANK_GARBAGE, MFS_BANK_ERASED):
- /* Bank zero is unreadable, bank one is erased.*/
- RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_1));
- RET_ON_ERROR(mfs_bank_set_header(devp, MFS_BANK_0, 1));
- RET_ON_ERROR(mfs_mount(devp, MFS_BANK_0));
- return MFS_REPAIR_WARNING;
-
- case PAIR(MFS_BANK_GARBAGE, MFS_BANK_OK):
- /* Bank zero is unreadable, bank one is normal.*/
- RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_0));
- RET_ON_ERROR(mfs_mount(devp, MFS_BANK_1));
- return MFS_REPAIR_WARNING;
-
- case PAIR(MFS_BANK_GARBAGE, MFS_BANK_PARTIAL):
- /* Bank zero is unreadable, bank one has problems.*/
- RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_0));
- RET_ON_ERROR(mfs_copy_bank(devp, MFS_BANK_1, MFS_BANK_0));
- RET_ON_ERROR(mfs_bank_set_header(devp, MFS_BANK_0, cnt0 + 1));
- RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_1));
- RET_ON_ERROR(mfs_mount(devp, MFS_BANK_0));
- return MFS_REPAIR_WARNING;
-
- case PAIR(MFS_BANK_GARBAGE, MFS_BANK_GARBAGE):
- /* Both banks are unreadable, reinitializing.*/
- RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_0));
- RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_1));
- RET_ON_ERROR(mfs_bank_set_header(devp, MFS_BANK_0, 1));
- RET_ON_ERROR(mfs_mount(devp, MFS_BANK_0));
- return MFS_REPAIR_WARNING;
-
- default:
- osalSysHalt("internal error");
- }
-
- /* Never reached.*/
- return MFS_INTERNAL_ERROR;
-}
-
-/*===========================================================================*/
-/* Driver exported functions. */
-/*===========================================================================*/
-
-/**
- * @brief Initializes an instance.
- *
- * @param[out] devp pointer to the @p MFSDriver object
- *
- * @init
- */
-void mfsObjectInit(MFSDriver *devp) {
-
- osalDbgCheck(devp != NULL);
-
- devp->state = MFS_STOP;
- devp->config = NULL;
-}
-
-/**
- * @brief Configures and activates a MFS driver.
- *
- * @param[in] devp pointer to the @p MFSDriver object
- * @param[in] config pointer to the configuration
- *
- * @api
- */
-void mfsStart(MFSDriver *devp, const MFSConfig *config) {
-
- osalDbgCheck((devp != NULL) && (config != NULL));
- osalDbgAssert(devp->state != MFS_UNINIT, "invalid state");
-
- if (devp->state == MFS_STOP) {
-
- devp->config = config;
- devp->state = MFS_READY;
- }
-}
-
-/**
- * @brief Deactivates a MFS driver.
- *
- * @param[in] devp pointer to the @p MFSDriver object
- *
- * @api
- */
-void mfsStop(MFSDriver *devp) {
-
- osalDbgCheck(devp != NULL);
- osalDbgAssert(devp->state != MFS_UNINIT, "invalid state");
-
- if (devp->state != MFS_STOP) {
-
- devp->state = MFS_STOP;
- }
-}
-
-/**
- * @brief Mounts a managed flash storage.
- * @details This functions checks the storage internal state and eventually
- * performs the required initialization or repair operations.
- *
- * @param[in] devp pointer to the @p MFSDriver object
- * @return The operation status.
- * @retval MFS_NO_ERROR if the operation has been successfully completed.
- * @retval MFS_REPAIR_WARNING if the operation has been completed but a
- * repair has been performed.
- * @retval MFS_FLASH_FAILURE if the flash memory is unusable because HW
- * failures.
- *
- * @api
- */
-mfs_error_t mfsMount(MFSDriver *devp) {
- unsigned i;
-
- /* Attempting to mount the managed partition.*/
- for (i = 0; i < MFS_CFG_MAX_REPAIR_ATTEMPTS; i++) {
- mfs_error_t err;
-
- err = mfs_try_mount(devp);
- if (!MFS_IS_ERROR(err))
- return err;
- }
-
- return MFS_FLASH_FAILURE;
-}
-
-/**
- * @brief Unmounts a manage flash storage.
- */
-mfs_error_t mfsUnmount(MFSDriver *devp) {
-
- (void)devp;
-
- return MFS_NO_ERROR;
-}
-
-/**
- * @brief Retrieves and reads a data record.
- *
- * @param[in] devp pointer to the @p MFSDriver object
- * @param[in] id record numeric identifier
- * @param[in,out] np on input is the maximum buffer size, on return it is
- * the size of the data copied into the buffer
- * @param[in] buffer pointer to a buffer for record data
- * @return The operation status.
- * @retval MFS_NO_ERROR if the operation has been successfully completed.
- * @retval MFS_ID_NOT_FOUND if the specified id does not exists.
- * @retval MFS_CRC_ERROR if retrieved data has a CRC error.
- *
- * @api
- */
-mfs_error_t mfsReadRecord(MFSDriver *devp, uint32_t id,
- uint32_t *np, uint8_t *buffer) {
-
- (void)devp;
- (void)id;
- (void)np;
- (void)buffer;
-
- return MFS_NO_ERROR;
-}
-
-/**
- * @brief Creates or updates a data record.
- *
- * @param[in] devp pointer to the @p MFSDriver object
- * @param[in] id record numeric identifier
- * @param[in] n size of data to be written, it cannot be zero
- * @param[in] buffer pointer to a buffer for record data
- * @return The operation status.
- * @retval MFS_NO_ERROR if the operation has been successfully completed.
- * @retval MFS_FLASH_FAILURE if the flash memory is unusable because HW
- * failures.
- *
- * @api
- */
-mfs_error_t mfsUpdateRecord(MFSDriver *devp, uint32_t id,
- uint32_t n, const uint8_t *buffer) {
-
- (void)devp;
- (void)id;
- (void)n;
- (void)buffer;
-
- return MFS_NO_ERROR;
-}
-
-/**
- * @brief Erases a data record.
- *
- * @param[in] devp pointer to the @p MFSDriver object
- * @param[in] id record numeric identifier
- * @return The operation status.
- * @retval MFS_NO_ERROR if the operation has been successfully completed.
- * @retval MFS_FLASH_FAILURE if the flash memory is unusable because HW
- * failures.
- *
- * @api
- */
-mfs_error_t mfsEraseRecord(MFSDriver *devp, uint32_t id) {
-
- (void)devp;
- (void)id;
-
- return MFS_NO_ERROR;
-}
-
-/** @} */
+/*
+ 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.c
+ * @brief Managed Flash Storage module code.
+ * @details This module manages a flash partition as a generic storage where
+ * arbitrary data records can be created, updated, deleted and
+ * retrieved.<br>
+ * A managed partition is composed of two banks of equal size, a
+ * bank is composed of one or more erasable sectors, a sector is
+ * divided in writable pages.<br>
+ * The module handles flash wear leveling and recovery of damaged
+ * banks (where possible) caused by power loss during operations.
+ * Both operations are transparent to the user.
+ *
+ * @addtogroup mfs
+ * @{
+ */
+
+#include "hal.h"
+
+#include "mfs.h"
+
+/*===========================================================================*/
+/* Driver local definitions. */
+/*===========================================================================*/
+
+#define PAIR(a, b) (((unsigned)(a) << 2U) | (unsigned)(b))
+
+/**
+ * @brief Error check helper.
+ */
+#define RET_ON_ERROR(err) do { \
+ mfs_error_t e = (err); \
+ if (e != MFS_NO_ERROR) { \
+ return e; \
+ } \
+} while (false)
+
+/*===========================================================================*/
+/* Driver exported variables. */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* Driver local variables and types. */
+/*===========================================================================*/
+
+const uint16_t crc16_table[256] = {
+ 0x0000, 0x1021, 0x2042, 0x3063, 0x4084, 0x50A5, 0x60C6, 0x70E7,
+ 0x8108, 0x9129, 0xA14A, 0xB16B, 0xC18C, 0xD1AD, 0xE1CE, 0xF1EF,
+ 0x1231, 0x0210, 0x3273, 0x2252, 0x52B5, 0x4294, 0x72F7, 0x62D6,
+ 0x9339, 0x8318, 0xB37B, 0xA35A, 0xD3BD, 0xC39C, 0xF3FF, 0xE3DE,
+ 0x2462, 0x3443, 0x0420, 0x1401, 0x64E6, 0x74C7, 0x44A4, 0x5485,
+ 0xA56A, 0xB54B, 0x8528, 0x9509, 0xE5EE, 0xF5CF, 0xC5AC, 0xD58D,
+ 0x3653, 0x2672, 0x1611, 0x0630, 0x76D7, 0x66F6, 0x5695, 0x46B4,
+ 0xB75B, 0xA77A, 0x9719, 0x8738, 0xF7DF, 0xE7FE, 0xD79D, 0xC7BC,
+ 0x48C4, 0x58E5, 0x6886, 0x78A7, 0x0840, 0x1861, 0x2802, 0x3823,
+ 0xC9CC, 0xD9ED, 0xE98E, 0xF9AF, 0x8948, 0x9969, 0xA90A, 0xB92B,
+ 0x5AF5, 0x4AD4, 0x7AB7, 0x6A96, 0x1A71, 0x0A50, 0x3A33, 0x2A12,
+ 0xDBFD, 0xCBDC, 0xFBBF, 0xEB9E, 0x9B79, 0x8B58, 0xBB3B, 0xAB1A,
+ 0x6CA6, 0x7C87, 0x4CE4, 0x5CC5, 0x2C22, 0x3C03, 0x0C60, 0x1C41,
+ 0xEDAE, 0xFD8F, 0xCDEC, 0xDDCD, 0xAD2A, 0xBD0B, 0x8D68, 0x9D49,
+ 0x7E97, 0x6EB6, 0x5ED5, 0x4EF4, 0x3E13, 0x2E32, 0x1E51, 0x0E70,
+ 0xFF9F, 0xEFBE, 0xDFDD, 0xCFFC, 0xBF1B, 0xAF3A, 0x9F59, 0x8F78,
+ 0x9188, 0x81A9, 0xB1CA, 0xA1EB, 0xD10C, 0xC12D, 0xF14E, 0xE16F,
+ 0x1080, 0x00A1, 0x30C2, 0x20E3, 0x5004, 0x4025, 0x7046, 0x6067,
+ 0x83B9, 0x9398, 0xA3FB, 0xB3DA, 0xC33D, 0xD31C, 0xE37F, 0xF35E,
+ 0x02B1, 0x1290, 0x22F3, 0x32D2, 0x4235, 0x5214, 0x6277, 0x7256,
+ 0xB5EA, 0xA5CB, 0x95A8, 0x8589, 0xF56E, 0xE54F, 0xD52C, 0xC50D,
+ 0x34E2, 0x24C3, 0x14A0, 0x0481, 0x7466, 0x6447, 0x5424, 0x4405,
+ 0xA7DB, 0xB7FA, 0x8799, 0x97B8, 0xE75F, 0xF77E, 0xC71D, 0xD73C,
+ 0x26D3, 0x36F2, 0x0691, 0x16B0, 0x6657, 0x7676, 0x4615, 0x5634,
+ 0xD94C, 0xC96D, 0xF90E, 0xE92F, 0x99C8, 0x89E9, 0xB98A, 0xA9AB,
+ 0x5844, 0x4865, 0x7806, 0x6827, 0x18C0, 0x08E1, 0x3882, 0x28A3,
+ 0xCB7D, 0xDB5C, 0xEB3F, 0xFB1E, 0x8BF9, 0x9BD8, 0xABBB, 0xBB9A,
+ 0x4A75, 0x5A54, 0x6A37, 0x7A16, 0x0AF1, 0x1AD0, 0x2AB3, 0x3A92,
+ 0xFD2E, 0xED0F, 0xDD6C, 0xCD4D, 0xBDAA, 0xAD8B, 0x9DE8, 0x8DC9,
+ 0x7C26, 0x6C07, 0x5C64, 0x4C45, 0x3CA2, 0x2C83, 0x1CE0, 0x0CC1,
+ 0xEF1F, 0xFF3E, 0xCF5D, 0xDF7C, 0xAF9B, 0xBFBA, 0x8FD9, 0x9FF8,
+ 0x6E17, 0x7E36, 0x4E55, 0x5E74, 0x2E93, 0x3EB2, 0x0ED1, 0x1EF0
+};
+
+/*===========================================================================*/
+/* Driver local functions. */
+/*===========================================================================*/
+
+uint16_t crc16(uint16_t crc, const uint8_t *data, size_t n) {
+
+ while (n > 0U) {
+ crc = (crc << 8U) ^ crc16_table[(crc >> 8U) ^ (uint16_t)*data];
+ data++;
+ n--;
+ }
+
+ return crc;
+}
+
+#if (MFS_CFG_ID_CACHE_SIZE > 0) || defined(__DOXYGEN__)
+void mfs_cache_init(MFSDriver *devp) {
+
+ (void)devp;
+}
+
+mfs_cached_id_t *mfs_cache_find_id(MFSDriver *devp, uint32_t id) {
+
+ (void)devp;
+ (void)id;
+
+ return NULL;
+}
+
+void mfs_cache_update_id(MFSDriver *devp, uint32_t id) {
+
+ (void)devp;
+ (void)id;
+}
+
+void mfs_cache_erase_id(MFSDriver *devp, uint32_t id) {
+
+ (void)devp;
+ (void)id;
+}
+#endif /* MFS_CFG_ID_CACHE_SIZE > 0 */
+
+/**
+ * @brief Flash write.
+ * @note If the option @p MFS_CFG_WRITE_VERIFY is enabled then the flash
+ * is also read back for verification.
+ *
+ * @param[in] devp pointer to the @p MFSDriver object
+ * @param[in] offset flash offset
+ * @param[in] n number of bytes to be read
+ * @param[out] rp pointer to the data buffer
+ * @return The operation status.
+ * @retval MFS_NO_ERROR if the operation has been successfully completed.
+ * @retval MFS_FLASH_FAILURE if the flash memory is unusable because HW
+ * failures.
+ *
+ * @notapi
+ */
+static mfs_error_t mfs_flash_write(MFSDriver *devp,
+ flash_offset_t offset,
+ size_t n, const
+ uint8_t *p) {
+ flash_error_t ferr;
+
+ ferr = flashProgram(devp->config->flashp, offset, n, p);
+ if (ferr != FLASH_NO_ERROR) {
+ return MFS_FLASH_FAILURE;
+ }
+
+ return MFS_NO_ERROR;
+}
+
+/**
+ * @brief Erases and verifies all sectors belonging to a bank.
+ *
+ * @param[in] devp pointer to the @p MFSDriver object
+ * @param[in] bank bank to be erased
+ * @return The operation status.
+ * @retval MFS_NO_ERROR if the operation has been successfully completed.
+ * @retval MFS_FLASH_FAILURE if the flash memory is unusable because HW
+ * failures.
+ *
+ * @notapi
+ */
+static mfs_error_t mfs_bank_erase(MFSDriver *devp, mfs_bank_t bank) {
+ flash_sector_t sector, end;
+
+ if (bank == MFS_BANK_0) {
+ sector = devp->config->bank0_start;
+ end = devp->config->bank0_start + devp->config->bank0_sectors;
+ }
+ else {
+ sector = devp->config->bank1_start;
+ end = devp->config->bank1_start + devp->config->bank1_sectors;
+ }
+
+ while (sector < end) {
+ flash_error_t ferr;
+
+ ferr = flashStartEraseSector(devp->config->flashp, sector);
+ if (ferr != FLASH_NO_ERROR) {
+ return MFS_FLASH_FAILURE;
+ }
+ ferr = flashWaitErase(devp->config->flashp);
+ if (ferr != FLASH_NO_ERROR) {
+ return MFS_FLASH_FAILURE;
+ }
+ ferr = flashVerifyErase(devp->config->flashp, sector);
+ if (ferr != FLASH_NO_ERROR) {
+ return MFS_FLASH_FAILURE;
+ }
+
+ sector++;
+ }
+
+ return MFS_NO_ERROR;
+}
+
+/**
+ * @brief Writes the validation header in a bank.
+ *
+ * @param[in] devp pointer to the @p MFSDriver object
+ * @param[in] bank bank to be validated
+ * @param[in] cnt value for the flash usage counter
+ * @return The operation status.
+ * @retval MFS_NO_ERROR if the operation has been successfully completed.
+ * @retval MFS_FLASH_FAILURE if the flash memory is unusable because HW
+ * failures.
+ *
+ * @notapi
+ */
+static mfs_error_t mfs_bank_set_header(MFSDriver *devp,
+ mfs_bank_t bank,
+ uint32_t cnt) {
+ flash_sector_t sector;
+ mfs_bank_header_t header;
+
+ if (bank == MFS_BANK_0) {
+ sector = devp->config->bank0_start;
+ }
+ else {
+ sector = devp->config->bank1_start;
+ }
+
+ header.magic1 = MFS_BANK_MAGIC_1;
+ header.magic1 = MFS_BANK_MAGIC_1;
+ header.counter = cnt;
+ header.next = sizeof (mfs_bank_header_t);
+ header.crc = crc16(0xFFFFU,
+ (const uint8_t *)&header,
+ sizeof (flash_sector_t) - sizeof (uint16_t));
+
+ return mfs_flash_write(devp,
+ flashGetSectorOffset(devp->config->flashp, sector),
+ sizeof (mfs_bank_header_t),
+ (const uint8_t *)&header);
+}
+
+/**
+ * @brief Copies all records from a bank to another.
+ *
+ * @param[in] devp pointer to the @p MFSDriver object
+ * @param[in] sbank source bank
+ * @param[in] dbank destination bank
+ * @return The operation status.
+ * @retval MFS_NO_ERROR if the operation has been successfully completed.
+ * @retval MFS_FLASH_FAILURE if the flash memory is unusable because HW
+ * failures.
+ *
+ * @notapi
+ */
+static mfs_error_t mfs_bank_copy(MFSDriver *devp,
+ mfs_bank_t sbank,
+ mfs_bank_t dbank) {
+
+ (void)devp;
+ (void)sbank;
+ (void)dbank;
+
+ return MFS_NO_ERROR;
+}
+
+/**
+ * @brief Selects a bank as current.
+ *
+ * @param[in] devp pointer to the @p MFSDriver object
+ * @param[in] bank bank to be erased
+ * @return The operation status.
+ * @retval MFS_NO_ERROR if the operation has been successfully completed.
+ *
+ * @notapi
+ */
+static mfs_error_t mfs_bank_mount(MFSDriver *devp, mfs_bank_t bank) {
+
+ (void)devp;
+ (void)bank;
+
+ return MFS_NO_ERROR;
+}
+
+/**
+ * @brief Determines the state of a flash bank.
+ *
+ * @param[in] devp pointer to the @p MFSDriver object
+ * @param[in] bank the bank identifier
+ * @param[out] cntp bank counter value, only valid if the bank is not
+ * in the @p MFS_BANK_GARBAGE or @p MFS_BANK_ERASED
+ * states.
+ *
+ * @return The bank state.
+ * @retval MFS_BANK_ERASED if the bank is fully erased.
+ * @retval MFS_BANK_OK if the bank contains valid data.
+ * @retval MFS_BANK_PARTIAL if the bank contains errors but the data is still
+ * readable.
+ * @retval MFS_BANK_GARBAGE if the bank contains unreadable garbage.
+ */
+static mfs_bank_state_t mfs_get_bank_state(MFSDriver *devp,
+ mfs_bank_t bank,
+ uint32_t *cntp) {
+
+ (void)devp;
+ (void)bank;
+ (void)cntp;
+
+ return MFS_BANK_OK;
+}
+
+/**
+ * @brief Performs a flash partition mount attempt.
+ *
+ * @param[in] devp pointer to the @p MFSDriver object
+ * @return The operation status.
+ * @retval MFS_NO_ERROR if the operation has been successfully completed.
+ * @retval MFS_REPAIR_WARNING if the operation has been completed but a
+ * repair has been performed.
+ * @retval MFS_FLASH_FAILURE if the flash memory is unusable because HW
+ * failures.
+ *
+ * @api
+ */
+static mfs_error_t mfs_try_mount(MFSDriver *devp) {
+ mfs_bank_state_t sts0, sts1;
+ uint32_t cnt0 = 0, cnt1 = 0;
+
+ /* Assessing the state of the two banks.*/
+ sts0 = mfs_get_bank_state(devp, MFS_BANK_0, &cnt0);
+ sts1 = mfs_get_bank_state(devp, MFS_BANK_1, &cnt1);
+
+ /* Handling all possible scenarios, each one requires its own recovery
+ strategy.*/
+ switch (PAIR(sts0, sts1)) {
+
+ case PAIR(MFS_BANK_ERASED, MFS_BANK_ERASED):
+ /* Both banks erased, first initialization.*/
+ RET_ON_ERROR(mfs_bank_set_header(devp, MFS_BANK_0, 1));
+ RET_ON_ERROR(mfs_bank_mount(devp, MFS_BANK_0));
+ return MFS_NO_ERROR;
+
+ case PAIR(MFS_BANK_ERASED, MFS_BANK_OK):
+ /* Normal situation, bank one is used.*/
+ RET_ON_ERROR(mfs_bank_mount(devp, MFS_BANK_1));
+ return MFS_NO_ERROR;
+
+ case PAIR(MFS_BANK_ERASED, MFS_BANK_PARTIAL):
+ /* Bank zero is erased, bank one has problems.*/
+ RET_ON_ERROR(mfs_bank_copy(devp, MFS_BANK_1, MFS_BANK_0));
+ RET_ON_ERROR(mfs_bank_set_header(devp, MFS_BANK_0, cnt1 + 1));
+ RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_1));
+ RET_ON_ERROR(mfs_bank_mount(devp, MFS_BANK_0));
+ return MFS_REPAIR_WARNING;
+
+ case PAIR(MFS_BANK_ERASED, MFS_BANK_GARBAGE):
+ /* Bank zero is erased, bank one is not readable.*/
+ RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_1));
+ RET_ON_ERROR(mfs_bank_set_header(devp, MFS_BANK_0, 1));
+ RET_ON_ERROR(mfs_bank_mount(devp, MFS_BANK_0));
+ return MFS_REPAIR_WARNING;
+
+ case PAIR(MFS_BANK_OK, MFS_BANK_ERASED):
+ /* Normal situation, bank zero is used.*/
+ RET_ON_ERROR(mfs_bank_mount(devp, MFS_BANK_0));
+ return MFS_NO_ERROR;
+
+ case PAIR(MFS_BANK_OK, MFS_BANK_OK):
+ /* Both banks appear to be valid but one must be newer, erasing the
+ older one.*/
+ if (cnt0 > cnt1) {
+ /* Bank 0 is newer.*/
+ RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_1));
+ RET_ON_ERROR(mfs_bank_mount(devp, MFS_BANK_0));
+ }
+ else {
+ /* Bank 1 is newer.*/
+ RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_0));
+ RET_ON_ERROR(mfs_bank_mount(devp, MFS_BANK_1));
+ }
+ return MFS_REPAIR_WARNING;
+
+ case PAIR(MFS_BANK_OK, MFS_BANK_PARTIAL):
+ /* Bank zero is normal, bank one has problems.*/
+ if (cnt0 > cnt1) {
+ /* Normal bank zero is more recent than the partial bank one, the
+ partial bank needs to be erased.*/
+ RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_1));
+ RET_ON_ERROR(mfs_bank_mount(devp, MFS_BANK_0));
+ }
+ else {
+ /* Partial bank one is more recent than the normal bank zero.*/
+ RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_0));
+ RET_ON_ERROR(mfs_bank_copy(devp, MFS_BANK_1, MFS_BANK_0));
+ RET_ON_ERROR(mfs_bank_set_header(devp, MFS_BANK_0, cnt1 + 1));
+ RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_1));
+ RET_ON_ERROR(mfs_bank_mount(devp, MFS_BANK_0));
+ }
+ return MFS_REPAIR_WARNING;
+
+ case PAIR(MFS_BANK_OK, MFS_BANK_GARBAGE):
+ /* Bank zero is normal, bank one is unreadable.*/
+ RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_1));
+ RET_ON_ERROR(mfs_bank_mount(devp, MFS_BANK_0));
+ return MFS_REPAIR_WARNING;
+
+ case PAIR(MFS_BANK_PARTIAL, MFS_BANK_ERASED):
+ /* Bank zero has problems, bank one is erased.*/
+ RET_ON_ERROR(mfs_bank_copy(devp, MFS_BANK_0, MFS_BANK_1));
+ RET_ON_ERROR(mfs_bank_set_header(devp, MFS_BANK_1, cnt0 + 1));
+ RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_0));
+ RET_ON_ERROR(mfs_bank_mount(devp, MFS_BANK_1));
+ return MFS_REPAIR_WARNING;
+
+ case PAIR(MFS_BANK_PARTIAL, MFS_BANK_OK):
+ /* Bank zero has problems, bank one is normal.*/
+ if (cnt1 > cnt0) {
+ /* Normal bank one is more recent than the partial bank zero, the
+ partial bank has to be erased.*/
+ RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_0));
+ RET_ON_ERROR(mfs_bank_mount(devp, MFS_BANK_1));
+ }
+ else {
+ /* Partial bank zero is more recent than the normal bank one.*/
+ RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_1));
+ RET_ON_ERROR(mfs_bank_copy(devp, MFS_BANK_0, MFS_BANK_1));
+ RET_ON_ERROR(mfs_bank_set_header(devp, MFS_BANK_1, cnt0 + 1));
+ RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_0));
+ RET_ON_ERROR(mfs_bank_mount(devp, MFS_BANK_1));
+ }
+ return MFS_REPAIR_WARNING;
+
+ case PAIR(MFS_BANK_PARTIAL, MFS_BANK_PARTIAL):
+ /* Both banks have problems.*/
+ if (cnt0 > cnt1) {
+ /* Bank zero is newer, copying in bank one and using it.*/
+ RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_1));
+ RET_ON_ERROR(mfs_bank_copy(devp, MFS_BANK_0, MFS_BANK_1));
+ RET_ON_ERROR(mfs_bank_set_header(devp, MFS_BANK_1, cnt0 + 1));
+ RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_0));
+ RET_ON_ERROR(mfs_bank_mount(devp, MFS_BANK_1));
+ }
+ else {
+ /* Bank one is newer, copying in bank zero and using it.*/
+ RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_0));
+ RET_ON_ERROR(mfs_bank_copy(devp, MFS_BANK_1, MFS_BANK_0));
+ RET_ON_ERROR(mfs_bank_set_header(devp, MFS_BANK_0, cnt1 + 1));
+ RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_1));
+ RET_ON_ERROR(mfs_bank_mount(devp, MFS_BANK_0));
+ }
+ return MFS_REPAIR_WARNING;
+
+ case PAIR(MFS_BANK_PARTIAL, MFS_BANK_GARBAGE):
+ /* Bank zero has problems, bank one is unreadable.*/
+ RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_1));
+ RET_ON_ERROR(mfs_bank_copy(devp, MFS_BANK_0, MFS_BANK_1));
+ RET_ON_ERROR(mfs_bank_set_header(devp, MFS_BANK_1, cnt0 + 1));
+ RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_0));
+ RET_ON_ERROR(mfs_bank_mount(devp, MFS_BANK_1));
+ return MFS_REPAIR_WARNING;
+
+ case PAIR(MFS_BANK_GARBAGE, MFS_BANK_ERASED):
+ /* Bank zero is unreadable, bank one is erased.*/
+ RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_1));
+ RET_ON_ERROR(mfs_bank_set_header(devp, MFS_BANK_0, 1));
+ RET_ON_ERROR(mfs_bank_mount(devp, MFS_BANK_0));
+ return MFS_REPAIR_WARNING;
+
+ case PAIR(MFS_BANK_GARBAGE, MFS_BANK_OK):
+ /* Bank zero is unreadable, bank one is normal.*/
+ RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_0));
+ RET_ON_ERROR(mfs_bank_mount(devp, MFS_BANK_1));
+ return MFS_REPAIR_WARNING;
+
+ case PAIR(MFS_BANK_GARBAGE, MFS_BANK_PARTIAL):
+ /* Bank zero is unreadable, bank one has problems.*/
+ RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_0));
+ RET_ON_ERROR(mfs_bank_copy(devp, MFS_BANK_1, MFS_BANK_0));
+ RET_ON_ERROR(mfs_bank_set_header(devp, MFS_BANK_0, cnt0 + 1));
+ RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_1));
+ RET_ON_ERROR(mfs_bank_mount(devp, MFS_BANK_0));
+ return MFS_REPAIR_WARNING;
+
+ case PAIR(MFS_BANK_GARBAGE, MFS_BANK_GARBAGE):
+ /* Both banks are unreadable, reinitializing.*/
+ RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_0));
+ RET_ON_ERROR(mfs_bank_erase(devp, MFS_BANK_1));
+ RET_ON_ERROR(mfs_bank_set_header(devp, MFS_BANK_0, 1));
+ RET_ON_ERROR(mfs_bank_mount(devp, MFS_BANK_0));
+ return MFS_REPAIR_WARNING;
+
+ default:
+ osalSysHalt("internal error");
+ }
+
+ /* Never reached.*/
+ return MFS_INTERNAL_ERROR;
+}
+
+/*===========================================================================*/
+/* Driver exported functions. */
+/*===========================================================================*/
+
+/**
+ * @brief Initializes an instance.
+ *
+ * @param[out] devp pointer to the @p MFSDriver object
+ *
+ * @init
+ */
+void mfsObjectInit(MFSDriver *devp) {
+
+ osalDbgCheck(devp != NULL);
+
+ devp->state = MFS_STOP;
+ devp->config = NULL;
+}
+
+/**
+ * @brief Configures and activates a MFS driver.
+ *
+ * @param[in] devp pointer to the @p MFSDriver object
+ * @param[in] config pointer to the configuration
+ *
+ * @api
+ */
+void mfsStart(MFSDriver *devp, const MFSConfig *config) {
+
+ osalDbgCheck((devp != NULL) && (config != NULL));
+ osalDbgAssert(devp->state != MFS_UNINIT, "invalid state");
+
+ if (devp->state == MFS_STOP) {
+
+ devp->config = config;
+ devp->state = MFS_READY;
+ }
+}
+
+/**
+ * @brief Deactivates a MFS driver.
+ *
+ * @param[in] devp pointer to the @p MFSDriver object
+ *
+ * @api
+ */
+void mfsStop(MFSDriver *devp) {
+
+ osalDbgCheck(devp != NULL);
+ osalDbgAssert(devp->state != MFS_UNINIT, "invalid state");
+
+ if (devp->state != MFS_STOP) {
+
+ devp->state = MFS_STOP;
+ }
+}
+
+/**
+ * @brief Mounts a managed flash storage.
+ * @details This functions checks the storage internal state and eventually
+ * performs the required initialization or repair operations.
+ *
+ * @param[in] devp pointer to the @p MFSDriver object
+ * @return The operation status.
+ * @retval MFS_NO_ERROR if the operation has been successfully completed.
+ * @retval MFS_REPAIR_WARNING if the operation has been completed but a
+ * repair has been performed.
+ * @retval MFS_FLASH_FAILURE if the flash memory is unusable because HW
+ * failures.
+ *
+ * @api
+ */
+mfs_error_t mfsMount(MFSDriver *devp) {
+ unsigned i;
+
+ /* Attempting to mount the managed partition.*/
+ for (i = 0; i < MFS_CFG_MAX_REPAIR_ATTEMPTS; i++) {
+ mfs_error_t err;
+
+ err = mfs_try_mount(devp);
+ if (!MFS_IS_ERROR(err))
+ return err;
+ }
+
+ return MFS_FLASH_FAILURE;
+}
+
+/**
+ * @brief Unmounts a manage flash storage.
+ */
+mfs_error_t mfsUnmount(MFSDriver *devp) {
+
+ (void)devp;
+
+ return MFS_NO_ERROR;
+}
+
+/**
+ * @brief Retrieves and reads a data record.
+ *
+ * @param[in] devp pointer to the @p MFSDriver object
+ * @param[in] id record numeric identifier
+ * @param[in,out] np on input is the maximum buffer size, on return it is
+ * the size of the data copied into the buffer
+ * @param[in] buffer pointer to a buffer for record data
+ * @return The operation status.
+ * @retval MFS_NO_ERROR if the operation has been successfully completed.
+ * @retval MFS_ID_NOT_FOUND if the specified id does not exists.
+ * @retval MFS_CRC_ERROR if retrieved data has a CRC error.
+ *
+ * @api
+ */
+mfs_error_t mfsReadRecord(MFSDriver *devp, uint32_t id,
+ uint32_t *np, uint8_t *buffer) {
+
+ (void)devp;
+ (void)id;
+ (void)np;
+ (void)buffer;
+
+ return MFS_NO_ERROR;
+}
+
+/**
+ * @brief Creates or updates a data record.
+ *
+ * @param[in] devp pointer to the @p MFSDriver object
+ * @param[in] id record numeric identifier
+ * @param[in] n size of data to be written, it cannot be zero
+ * @param[in] buffer pointer to a buffer for record data
+ * @return The operation status.
+ * @retval MFS_NO_ERROR if the operation has been successfully completed.
+ * @retval MFS_FLASH_FAILURE if the flash memory is unusable because HW
+ * failures.
+ *
+ * @api
+ */
+mfs_error_t mfsUpdateRecord(MFSDriver *devp, uint32_t id,
+ uint32_t n, const uint8_t *buffer) {
+
+ (void)devp;
+ (void)id;
+ (void)n;
+ (void)buffer;
+
+ return MFS_NO_ERROR;
+}
+
+/**
+ * @brief Erases a data record.
+ *
+ * @param[in] devp pointer to the @p MFSDriver object
+ * @param[in] id record numeric identifier
+ * @return The operation status.
+ * @retval MFS_NO_ERROR if the operation has been successfully completed.
+ * @retval MFS_FLASH_FAILURE if the flash memory is unusable because HW
+ * failures.
+ *
+ * @api
+ */
+mfs_error_t mfsEraseRecord(MFSDriver *devp, uint32_t id) {
+
+ (void)devp;
+ (void)id;
+
+ return MFS_NO_ERROR;
+}
+
+/** @} */
diff --git a/os/ex/subsystems/mfs/mfs.h b/os/ex/subsystems/mfs/mfs.h
index ec5719738..89d6b9958 100644
--- a/os/ex/subsystems/mfs/mfs.h
+++ b/os/ex/subsystems/mfs/mfs.h
@@ -1,339 +1,339 @@
-/*
- 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. */
-/*===========================================================================*/
-
-#define MFS_BANK_MAGIC_1 0xEC705ADEU
-#define MFS_BANK_MAGIC_2 0xF0339CC5U
-#define MFS_HEADER_MAGIC 0x5FAEU
-
-/*===========================================================================*/
-/* Driver pre-compile time settings. */
-/*===========================================================================*/
-
-/**
- * @name Configuration options
- * @{
- */
-/**
- * @brief Record identifiers cache size.
- * @details Cache trades RAM for a faster access to stored records. If zero
- * then the cache is disabled.
- */
-#if !defined(MFS_CFG_ID_CACHE_SIZE) || defined(__DOXIGEN__)
-#define MFS_CFG_ID_CACHE_SIZE 16
-#endif
-
-/**
- * @brief Maximum number of repair attempts on partition mount.
- */
-#if !defined(MFS_CFG_MAX_REPAIR_ATTEMPTS) || defined(__DOXIGEN__)
-#define MFS_CFG_MAX_REPAIR_ATTEMPTS 3
-#endif
-
-/**
- * @brief Verify written data.
- */
-#if !defined(MFS_CFG_WRITE_VERIFY) || defined(__DOXIGEN__)
-#define MFS_CFG_WRITE_VERIFY TRUE
-#endif
-/** @} */
-
-/*===========================================================================*/
-/* Derived constants and error checks. */
-/*===========================================================================*/
-
-#if MFS_CFG_ID_CACHE_SIZE < 0
-#error "invalid MFS_CFG_ID_CACHE_SIZE value"
-#endif
-
-#if (MFS_CFG_MAX_REPAIR_ATTEMPTS < 1) || (MFS_CFG_MAX_REPAIR_ATTEMPTS > 10)
-#error "invalid MFS_MAX_REPAIR_ATTEMPTS value"
-#endif
-
-/*===========================================================================*/
-/* Driver data structures and types. */
-/*===========================================================================*/
-
-/**
- * @brief Type of a flash bank.
- */
-typedef enum {
- MFS_BANK_0 = 0,
- MFS_BANK_1 = 1
-} mfs_bank_t;
-
-/**
- * @brief Type of driver state machine states.
- */
-typedef enum {
- MFS_UNINIT = 0,
- MFS_STOP = 1,
- MFS_READY = 2,
- MFS_MOUNTED = 3,
- MFS_ACTIVE = 4
-} mfs_state_t;
-
-/**
- * @brief Type of an MFS error code.
- * @note Errors are negative integers, informative warnings are positive
- * integers.
- */
-typedef enum {
- MFS_NO_ERROR = 0,
- MFS_REPAIR_WARNING = 1,
- MFS_GC_WARNING = 2,
- MFS_ID_NOT_FOUND = -1,
- MFS_CRC_ERROR = -2,
- MFS_FLASH_FAILURE = -3,
- MFS_INTERNAL_ERROR = -4
-} mfs_error_t;
-
-/**
- * @brief Type of a bank state assessment.
- */
-typedef enum {
- MFS_BANK_ERASED = 0,
- MFS_BANK_OK = 1,
- MFS_BANK_PARTIAL = 2,
- MFS_BANK_GARBAGE = 3
-} mfs_bank_state_t;
-
-/**
- * @brief Type of a bank header.
- * @note The header resides in the first 16 bytes of a bank extending
- * to the next page boundary.
- */
-typedef struct {
- /**
- * @brief Bank magic 1.
- */
- uint32_t magic1;
- /**
- * @brief Bank magic 2.
- */
- uint32_t magic2;
- /**
- * @brief Usage counter of the bank.
- * @details This value is increased each time a bank swap is performed. It
- * indicates how much wearing the flash has already endured.
- */
- uint32_t counter;
- /**
- * @brief First data element.
- */
- flash_offset_t next;
- /**
- * @brief Header CRC.
- */
- uint16_t crc;
-} mfs_bank_header_t;
-
-/**
- * @brief Type of a data block header.
- * @details This structure is placed before each written data block.
- */
-typedef struct {
- /**
- * @brief Data header magic.
- */
- uint16_t magic;
- /**
- * @brief Data CRC.
- */
- uint16_t crc;
- /**
- * @brief Data identifier.
- */
- uint32_t id;
- /**
- * @brief Data size for forward scan.
- */
- uint32_t size;
- /**
- * @brief Address of the previous header or zero if none.
- */
- flash_offset_t prev_header;
-} mfs_data_header_t;
-
-#if (MFS_CFG_ID_CACHE_SIZE > 0) || defined(__DOXYGEN__)
-/**
- * @brief Type of an element of the record identifiers cache.
- */
-typedef struct mfs_cached_id {
- /**
- * @brief Pointer to the next element in the list.
- */
- struct mfs_cached_id *lru_next;
- /**
- * @brief Pointer to the previous element in the list.
- */
- struct mfs_cached_id *lru_prev;
- /**
- * @brief Identifier of the cached element.
- */
- uint32_t id;
- /**
- * @brief Data address of the cached element.
- */
- flash_offset_t offset;
- /**
- * @brief Data size of the cached element.
- */
- uint32_t size;
-} mfs_cached_id_t;
-
-/**
- * @brief Type of an element of the record identifiers cache.
- */
-typedef struct mfs_cache_header {
- /**
- * @brief Pointer to the first element in the list.
- */
- struct mfs_cached_id *lru_next;
- /**
- * @brief Pointer to the last element in the list.
- */
- struct mfs_cached_id *lru_prev;
-} mfs_cache_header_t;
-#endif /* MFS_CFG_ID_CACHE_SIZE > 0 */
-
-/**
- * @brief Type of a MFS configuration structure.
- */
-typedef struct {
- /**
- * @brief Flash driver associated to this MFS instance.
- */
- BaseFlash *flashp;
- /**
- * @brief Base sector index for bank 0.
- */
- flash_sector_t bank0_start;
- /**
- * #brief Number of sectors for bank 0.
- */
- flash_sector_t bank0_sectors;
- /**
- * @brief Base sector index for bank 1.
- */
- flash_sector_t bank1_start;
- /**
- * #brief Number of sectors for bank 1.
- */
- flash_sector_t bank1_sectors;
-} 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;
- /**
- * @brief Bank currently in use.
- */
- mfs_bank_t current_bank;
- /**
- * @brief Size in bytes of banks.
- */
- uint32_t banks_size;
- /**
- * @brief Pointer to the next free position in the current bank.
- */
- flash_offset_t next_offset;
- /**
- * @brief Pointer to the last header in the list or zero.
- */
- flash_offset_t last_offset;
- /**
- * @brief Used space in the current bank without considering erased records.
- */
- uint32_t used_space;
-#if (MFS_CFG_ID_CACHE_SIZE > 0) || defined(__DOXYGEN__)
- /**
- * @brief Header of the cache LRU list.
- */
- mfs_cache_header_t cache_header;
- /**
- * @brief Array of the cached identifiers.
- */
- mfs_cached_id_t cache_buffer[MFS_CFG_ID_CACHE_SIZE];
-#endif /* MFS_CFG_ID_CACHE_SIZE > 0 */
-} MFSDriver;
-
-/*===========================================================================*/
-/* Driver macros. */
-/*===========================================================================*/
-
-/**
- * @name Error codes handling macros
- * @{
- */
-#define MFS_IS_ERROR(err) ((err) < MFS_NO_ERROR)
-#define MFS_IS_WARNING(err) ((err) > MFS_NO_ERROR)
-/** @} */
-
-/*===========================================================================*/
-/* External declarations. */
-/*===========================================================================*/
-
-#ifdef __cplusplus
-extern "C" {
-#endif
- void mfsObjectInit(MFSDriver *devp);
- void mfsStart(MFSDriver *devp, const MFSConfig *config);
- void mfsStop(MFSDriver *devp);
- mfs_error_t mfsMount(MFSDriver *devp);
- mfs_error_t mfsUnmount(MFSDriver *devp);
- mfs_error_t mfsReadRecord(MFSDriver *devp, uint32_t id,
- uint32_t *np, uint8_t *buffer);
- mfs_error_t mfsUpdateRecord(MFSDriver *devp, uint32_t id,
- uint32_t n, const uint8_t *buffer);
- mfs_error_t mfsEraseRecord(MFSDriver *devp, uint32_t id);
-#ifdef __cplusplus
-}
-#endif
-
-#endif /* MFS_H */
-
-/** @} */
-
+/*
+ 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. */
+/*===========================================================================*/
+
+#define MFS_BANK_MAGIC_1 0xEC705ADEU
+#define MFS_BANK_MAGIC_2 0xF0339CC5U
+#define MFS_HEADER_MAGIC 0x5FAEU
+
+/*===========================================================================*/
+/* Driver pre-compile time settings. */
+/*===========================================================================*/
+
+/**
+ * @name Configuration options
+ * @{
+ */
+/**
+ * @brief Record identifiers cache size.
+ * @details Cache trades RAM for a faster access to stored records. If zero
+ * then the cache is disabled.
+ */
+#if !defined(MFS_CFG_ID_CACHE_SIZE) || defined(__DOXIGEN__)
+#define MFS_CFG_ID_CACHE_SIZE 16
+#endif
+
+/**
+ * @brief Maximum number of repair attempts on partition mount.
+ */
+#if !defined(MFS_CFG_MAX_REPAIR_ATTEMPTS) || defined(__DOXIGEN__)
+#define MFS_CFG_MAX_REPAIR_ATTEMPTS 3
+#endif
+
+/**
+ * @brief Verify written data.
+ */
+#if !defined(MFS_CFG_WRITE_VERIFY) || defined(__DOXIGEN__)
+#define MFS_CFG_WRITE_VERIFY TRUE
+#endif
+/** @} */
+
+/*===========================================================================*/
+/* Derived constants and error checks. */
+/*===========================================================================*/
+
+#if MFS_CFG_ID_CACHE_SIZE < 0
+#error "invalid MFS_CFG_ID_CACHE_SIZE value"
+#endif
+
+#if (MFS_CFG_MAX_REPAIR_ATTEMPTS < 1) || (MFS_CFG_MAX_REPAIR_ATTEMPTS > 10)
+#error "invalid MFS_MAX_REPAIR_ATTEMPTS value"
+#endif
+
+/*===========================================================================*/
+/* Driver data structures and types. */
+/*===========================================================================*/
+
+/**
+ * @brief Type of a flash bank.
+ */
+typedef enum {
+ MFS_BANK_0 = 0,
+ MFS_BANK_1 = 1
+} mfs_bank_t;
+
+/**
+ * @brief Type of driver state machine states.
+ */
+typedef enum {
+ MFS_UNINIT = 0,
+ MFS_STOP = 1,
+ MFS_READY = 2,
+ MFS_MOUNTED = 3,
+ MFS_ACTIVE = 4
+} mfs_state_t;
+
+/**
+ * @brief Type of an MFS error code.
+ * @note Errors are negative integers, informative warnings are positive
+ * integers.
+ */
+typedef enum {
+ MFS_NO_ERROR = 0,
+ MFS_REPAIR_WARNING = 1,
+ MFS_GC_WARNING = 2,
+ MFS_ID_NOT_FOUND = -1,
+ MFS_CRC_ERROR = -2,
+ MFS_FLASH_FAILURE = -3,
+ MFS_INTERNAL_ERROR = -4
+} mfs_error_t;
+
+/**
+ * @brief Type of a bank state assessment.
+ */
+typedef enum {
+ MFS_BANK_ERASED = 0,
+ MFS_BANK_OK = 1,
+ MFS_BANK_PARTIAL = 2,
+ MFS_BANK_GARBAGE = 3
+} mfs_bank_state_t;
+
+/**
+ * @brief Type of a bank header.
+ * @note The header resides in the first 16 bytes of a bank extending
+ * to the next page boundary.
+ */
+typedef struct {
+ /**
+ * @brief Bank magic 1.
+ */
+ uint32_t magic1;
+ /**
+ * @brief Bank magic 2.
+ */
+ uint32_t magic2;
+ /**
+ * @brief Usage counter of the bank.
+ * @details This value is increased each time a bank swap is performed. It
+ * indicates how much wearing the flash has already endured.
+ */
+ uint32_t counter;
+ /**
+ * @brief First data element.
+ */
+ flash_offset_t next;
+ /**
+ * @brief Header CRC.
+ */
+ uint16_t crc;
+} mfs_bank_header_t;
+
+/**
+ * @brief Type of a data block header.
+ * @details This structure is placed before each written data block.
+ */
+typedef struct {
+ /**
+ * @brief Data header magic.
+ */
+ uint16_t magic;
+ /**
+ * @brief Data CRC.
+ */
+ uint16_t crc;
+ /**
+ * @brief Data identifier.
+ */
+ uint32_t id;
+ /**
+ * @brief Data size for forward scan.
+ */
+ uint32_t size;
+ /**
+ * @brief Address of the previous header or zero if none.
+ */
+ flash_offset_t prev_header;
+} mfs_data_header_t;
+
+#if (MFS_CFG_ID_CACHE_SIZE > 0) || defined(__DOXYGEN__)
+/**
+ * @brief Type of an element of the record identifiers cache.
+ */
+typedef struct mfs_cached_id {
+ /**
+ * @brief Pointer to the next element in the list.
+ */
+ struct mfs_cached_id *lru_next;
+ /**
+ * @brief Pointer to the previous element in the list.
+ */
+ struct mfs_cached_id *lru_prev;
+ /**
+ * @brief Identifier of the cached element.
+ */
+ uint32_t id;
+ /**
+ * @brief Data address of the cached element.
+ */
+ flash_offset_t offset;
+ /**
+ * @brief Data size of the cached element.
+ */
+ uint32_t size;
+} mfs_cached_id_t;
+
+/**
+ * @brief Type of an element of the record identifiers cache.
+ */
+typedef struct mfs_cache_header {
+ /**
+ * @brief Pointer to the first element in the list.
+ */
+ struct mfs_cached_id *lru_next;
+ /**
+ * @brief Pointer to the last element in the list.
+ */
+ struct mfs_cached_id *lru_prev;
+} mfs_cache_header_t;
+#endif /* MFS_CFG_ID_CACHE_SIZE > 0 */
+
+/**
+ * @brief Type of a MFS configuration structure.
+ */
+typedef struct {
+ /**
+ * @brief Flash driver associated to this MFS instance.
+ */
+ BaseFlash *flashp;
+ /**
+ * @brief Base sector index for bank 0.
+ */
+ flash_sector_t bank0_start;
+ /**
+ * #brief Number of sectors for bank 0.
+ */
+ flash_sector_t bank0_sectors;
+ /**
+ * @brief Base sector index for bank 1.
+ */
+ flash_sector_t bank1_start;
+ /**
+ * #brief Number of sectors for bank 1.
+ */
+ flash_sector_t bank1_sectors;
+} 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;
+ /**
+ * @brief Bank currently in use.
+ */
+ mfs_bank_t current_bank;
+ /**
+ * @brief Size in bytes of banks.
+ */
+ uint32_t banks_size;
+ /**
+ * @brief Pointer to the next free position in the current bank.
+ */
+ flash_offset_t next_offset;
+ /**
+ * @brief Pointer to the last header in the list or zero.
+ */
+ flash_offset_t last_offset;
+ /**
+ * @brief Used space in the current bank without considering erased records.
+ */
+ uint32_t used_space;
+#if (MFS_CFG_ID_CACHE_SIZE > 0) || defined(__DOXYGEN__)
+ /**
+ * @brief Header of the cache LRU list.
+ */
+ mfs_cache_header_t cache_header;
+ /**
+ * @brief Array of the cached identifiers.
+ */
+ mfs_cached_id_t cache_buffer[MFS_CFG_ID_CACHE_SIZE];
+#endif /* MFS_CFG_ID_CACHE_SIZE > 0 */
+} MFSDriver;
+
+/*===========================================================================*/
+/* Driver macros. */
+/*===========================================================================*/
+
+/**
+ * @name Error codes handling macros
+ * @{
+ */
+#define MFS_IS_ERROR(err) ((err) < MFS_NO_ERROR)
+#define MFS_IS_WARNING(err) ((err) > MFS_NO_ERROR)
+/** @} */
+
+/*===========================================================================*/
+/* External declarations. */
+/*===========================================================================*/
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+ void mfsObjectInit(MFSDriver *devp);
+ void mfsStart(MFSDriver *devp, const MFSConfig *config);
+ void mfsStop(MFSDriver *devp);
+ mfs_error_t mfsMount(MFSDriver *devp);
+ mfs_error_t mfsUnmount(MFSDriver *devp);
+ mfs_error_t mfsReadRecord(MFSDriver *devp, uint32_t id,
+ uint32_t *np, uint8_t *buffer);
+ mfs_error_t mfsUpdateRecord(MFSDriver *devp, uint32_t id,
+ uint32_t n, const uint8_t *buffer);
+ mfs_error_t mfsEraseRecord(MFSDriver *devp, uint32_t id);
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* MFS_H */
+
+/** @} */
+
generated by cgit v1.2.3 (git 2.25.1) at 2025-07-12 19:06:17 +0000