TFDB/tinyflashdb.c

/*
 * Copyright (c) 2022-2023, smartmx - smartmx@qq.com
 *
 * SPDX-License-Identifier: MIT
 *
 * Change Logs:
 * Date           Author       Notes
 * 2022-02-03     smartmx      the first version
 * 2022-02-08     smartmx      fix bugs
 * 2022-02-12     smartmx      fix bugs, add support for 2 byte write flash
 * 2022-03-15     smartmx      fix bugs, add support for stm32l4 flash
 * 2022-08-02     smartmx      add TFDB_VALUE_AFTER_ERASE_SIZE option
 * 2023-02-22     smartmx      add dual flash index function
 * 2023-11-07     smartmx      fix bugs, tfdb_get error when flash write in tfdb_set not success.
 *
 */
#include "tinyflashdb.h"

/**
 * check header in flash.
 *
 * @param index the data manage index.
 * @param rw_buffer buffer to store prepared read data or write data.
 *
 * @return TFDB_Err_Code
 */
TFDB_Err_Code tfdb_check(const tfdb_index_t *index, uint8_t *rw_buffer)
{
    TFDB_Err_Code result;

    TFDB_DEBUG("tfdb_check >\n");
#if (TFDB_WRITE_UNIT_BYTES==8)
    /* flash_size / value_len / end_byte */
    result = tfdb_port_read(index->flash_addr, rw_buffer, 8);
#else
    /* flash_size / value_len / end_byte */
    result = tfdb_port_read(index->flash_addr, rw_buffer, 4);
#endif
    if (result != TFDB_NO_ERR)
    {
        //read err
        TFDB_DEBUG("    read err\n");
        goto end;
    }
    result = TFDB_HDR_ERR;
    /* compare flash_size */
    if ((rw_buffer[0] == ((index->flash_size >> 8) & 0xff)) && (rw_buffer[1] == ((index->flash_size) & 0xff)))
    {
        /* compare value_length and end_byte */
        if ((rw_buffer[2] == index->value_length) && (rw_buffer[3] == index->end_byte))
        {
            /* check hdr success */
            result = TFDB_NO_ERR;
            goto end;
        }
    }
end:
    TFDB_DEBUG("tfdb_check:%d\n", result);
    return result;
}

/**
 * erase the flash block and init header in flash.
 *
 * @param index the data manage index.
 * @param rw_buffer buffer to store prepared read data or write data.
 *
 * @return TFDB_Err_Code
 */
TFDB_Err_Code tfdb_init(const tfdb_index_t *index, uint8_t *rw_buffer)
{
    TFDB_Err_Code result = TFDB_NO_ERR;

    TFDB_DEBUG("tfdb_init >\n");

    result = tfdb_port_erase(index->flash_addr, index->flash_size);
    if (result != TFDB_NO_ERR)
    {
        //erase err
        TFDB_DEBUG("    erase err\n");
        goto end;
    }
    rw_buffer[0] = ((index->flash_size >> 8) & 0xff);
    rw_buffer[1] = ((index->flash_size) & 0xff);
    rw_buffer[2] = index->value_length;
    rw_buffer[3] = index->end_byte;
#if (TFDB_WRITE_UNIT_BYTES==8)
    rw_buffer[4] = index->end_byte;
    rw_buffer[5] = index->end_byte;
    rw_buffer[6] = index->end_byte;
    rw_buffer[7] = index->end_byte;
    /* flash_size / value_len / end_byte */
    result = tfdb_port_write(index->flash_addr, rw_buffer, 8);
#else
    /* flash_size / value_len / end_byte */
    result = tfdb_port_write(index->flash_addr, rw_buffer, 4);
#endif
    if (result != TFDB_NO_ERR)
    {
        //write err
        TFDB_DEBUG("    write err\n");
        goto end;
    }
    result = tfdb_check(index, rw_buffer);
    if (result != TFDB_NO_ERR)
    {
        TFDB_DEBUG("    flash ERR\n");
        result = TFDB_FLASH_ERR;
        goto end;
    }
end:
    TFDB_DEBUG("tfdb_init:%d\n", result);
    return result;
}

/**
 * set data in flash and save the addr to addr_cache.
 *
 * @param index the data manage index.
 * @param rw_buffer buffer to store prepared read data or write data.
 * @param addr_cache the pointer to addr which is user offered, which will save read addr.
 * @param value_from the pointer to buffer which is user offered that need to save.
 *
 * @return TFDB_Err_Code
 */
TFDB_Err_Code tfdb_set(const tfdb_index_t *index, uint8_t *rw_buffer, tfdb_addr_t *addr_cache, void *value_from)
{
    TFDB_Err_Code result;
    tfdb_addr_t find_addr;
    uint8_t aligned_value_size;
    uint8_t sum_verify_byte;
    uint8_t i;
#if TFDB_WRITE_MAX_RETRY
    uint32_t max_retry = 0;
#endif

    TFDB_DEBUG("tfdb_set >\n");

    aligned_value_size  = index->value_length + 2;/* data + verify + end_byte */

#if (TFDB_WRITE_UNIT_BYTES==2)
    /* aligned with TFDB_WRITE_UNIT_BYTES */
    aligned_value_size = ((aligned_value_size + 1) & 0xfe);
#elif (TFDB_WRITE_UNIT_BYTES==4)
    /* aligned with TFDB_WRITE_UNIT_BYTES */
    aligned_value_size = ((aligned_value_size + 3) & 0xfc);
#elif (TFDB_WRITE_UNIT_BYTES==8)
    /* aligned with TFDB_WRITE_UNIT_BYTES */
    aligned_value_size = ((aligned_value_size + 7) & 0xf8);
#endif
    TFDB_LOG("aigned size:%d\n", aligned_value_size);

    if (addr_cache == NULL)
    {
start:
        /* addr_cache is not init. so check header first. */
        find_addr = 0;
        result = tfdb_get(index, rw_buffer, &find_addr, NULL);
        if(result == TFDB_NO_ERR)
        {
            find_addr = find_addr + aligned_value_size;
#if (TFDB_WRITE_UNIT_BYTES==8)
            if(find_addr > (index->flash_addr + index->flash_size - ((index->flash_size - 8) % aligned_value_size) - aligned_value_size))
#else
            if(find_addr > (index->flash_addr + index->flash_size - ((index->flash_size - 4) % aligned_value_size) - aligned_value_size))
#endif
            {
                /* the flash block is fill */
                TFDB_DEBUG("    the flash is fill\n");
                goto init;
            }

            /* find the addr success */
            TFDB_LOG("    find success\n");
set:
            /* calculate sum verify */
            sum_verify_byte = 0xff;
            for (i = 0; i < index->value_length; i++)
            {
                sum_verify_byte = ((sum_verify_byte + ((uint8_t *)(value_from))[i]) & 0xff);
            }
write:
#if TFDB_WRITE_MAX_RETRY
            max_retry++;
            if (max_retry > TFDB_WRITE_MAX_RETRY)
            {
                result = TFDB_FLASH_ERR;
                goto end;
            }
#endif
            tfdb_memcpy(rw_buffer, value_from, index->value_length);
            rw_buffer[index->value_length] = sum_verify_byte;
            for (i = index->value_length + 1; i < aligned_value_size; i++)
            {
                /* fill aligned data with end_byte */
                rw_buffer[i] = index->end_byte;
            }
            result = tfdb_port_write(find_addr, rw_buffer, aligned_value_size);
            if (result != TFDB_NO_ERR)
            {
                TFDB_DEBUG("    write err\n");
                goto end;
            }
            result = tfdb_port_read(find_addr, rw_buffer, aligned_value_size);
            if (result != TFDB_NO_ERR)
            {
                TFDB_DEBUG("    read err\n");
                goto end;
            }
            if ((tfdb_memcmp(rw_buffer, value_from, index->value_length) != TFDB_MEMCMP_SAME) \
                    || (rw_buffer[index->value_length] != sum_verify_byte)\
                    || (rw_buffer[aligned_value_size - 1] != index->end_byte))
            {
                /* write verify failed, maybe the flash is error, try next address. */
                TFDB_DEBUG("    Write verify failed, try next address.\n");
                find_addr += aligned_value_size;

#if (TFDB_WRITE_UNIT_BYTES==8)
                if(find_addr > (index->flash_addr + index->flash_size - ((index->flash_size - 8) % aligned_value_size) - aligned_value_size))
#else
                if(find_addr > (index->flash_addr + index->flash_size - ((index->flash_size - 4) % aligned_value_size) - aligned_value_size))
#endif
                {
                    /* the flash is fill */
                    TFDB_DEBUG("    the flash is fill\n");
                    goto init;
                }
                else
                {
                    goto write;
                }
            }
            else
            {
                /* write data to flash success */
                /* save addr to addr_cache */
                if (addr_cache != NULL)
                {
                    *addr_cache = find_addr;
                }
            }
        }
        else if (result == TFDB_HDR_ERR)
        {
            TFDB_DEBUG("    header err\n");
init:
            result = tfdb_init(index, rw_buffer);
            if (result == TFDB_NO_ERR)
            {
after_init:
#if (TFDB_WRITE_UNIT_BYTES==8)
                find_addr = index->flash_addr + 8;
#else
                find_addr = index->flash_addr + 4;
#endif
                goto set;
            }
            goto end;
        }
        else if (result == TFDB_NO_DATA)
        {
            goto after_init;
        }
    }
    else
    {
        if (*addr_cache == 0)
        {
            /* addr_cache is not set */
            goto start;
        }
        else
        {
            /* addr_cache is set */
            TFDB_DEBUG("    addr_cache is set\n");
            find_addr = *addr_cache + aligned_value_size;
            if (find_addr > (index->flash_addr + index->flash_size - aligned_value_size))
            {
                /* the flash is fill */
                TFDB_DEBUG("    the flash is fill\n");
                goto init;
            }
            else
            {
                goto set;
            }
        }
    }
end:
    TFDB_LOG("tfdb_set:%d\n", result);
    return result;
}

/**
 * get the data in flash and save the addr of data to addr_cache.
 *
 * @param index the data manage index.
 * @param rw_buffer buffer to store prepared read data or write data.
 * @param addr_cache the pointer to addr which is user offered.
 * @param value_to the pointer to buffer which is user offered to save data.
 *
 * @return TFDB_Err_Code
 */
TFDB_Err_Code tfdb_get(const tfdb_index_t *index, uint8_t *rw_buffer, tfdb_addr_t *addr_cache, void *value_to)
{
    TFDB_Err_Code result;
    tfdb_addr_t find_addr;
    uint8_t aligned_value_size;
    uint8_t sum_verify_byte;
    uint8_t i;
    TFDB_LOG("tfdb_get >\n");

    aligned_value_size  = index->value_length + 2;/* data + verify + end_byte */

#if (TFDB_WRITE_UNIT_BYTES==2)
    /* aligned with TFDB_WRITE_UNIT_BYTES */
    aligned_value_size = ((aligned_value_size + 1) & 0xfe);
#elif (TFDB_WRITE_UNIT_BYTES==4)
    /* aligned with TFDB_WRITE_UNIT_BYTES */
    aligned_value_size = ((aligned_value_size + 3) & 0xfc);
#elif (TFDB_WRITE_UNIT_BYTES==8)
    /* aligned with TFDB_WRITE_UNIT_BYTES */
    aligned_value_size = ((aligned_value_size + 7) & 0xf8);
#endif
    TFDB_LOG("aigned size:%d\n", aligned_value_size);

    if (addr_cache == NULL)
    {
start:
        /* addr_cache is not init. so check header first. */
        result = tfdb_check(index, rw_buffer);
        if (result == TFDB_NO_ERR)
        {
            /* the header is right. so start to find data location address in flash. */
#if (TFDB_WRITE_UNIT_BYTES==8)
            find_addr = index->flash_addr + index->flash_size - ((index->flash_size - 8) % aligned_value_size) - aligned_value_size;
            while ((find_addr) >= (index->flash_addr + 8))
#else
            find_addr = index->flash_addr + index->flash_size - ((index->flash_size - 4) % aligned_value_size) - aligned_value_size;
            while ((find_addr) >= (index->flash_addr + 4))
#endif
            {
                /* start to find value */
                result = tfdb_port_read(find_addr, rw_buffer, aligned_value_size);
                if (result != TFDB_NO_ERR)
                {
                    TFDB_DEBUG("    read err\n");
                    goto end;
                }

                if (rw_buffer[aligned_value_size - 1] == index->end_byte)
                {
                    /* find value addr success */
                    break;
                }

                if(find_addr >= aligned_value_size)
                {
                    find_addr -= aligned_value_size;
                }
                else
                {
                    break;
                }
            }

verify:
            if(rw_buffer[aligned_value_size - 1] != index->end_byte)
            {
                TFDB_LOG("end_byte err\n");
                goto read_next;
            }

            sum_verify_byte = 0xff;
            /* calculate sum verify */
            for (i = 0; i < index->value_length; i++)
            {
                sum_verify_byte = ((sum_verify_byte + rw_buffer[i]) & 0xff);
            }
            if (sum_verify_byte != rw_buffer[index->value_length])
            {
                /* not right data, maybe the flash is broken. */
                TFDB_LOG("verify err:%02x,%02x\n", sum_verify_byte, rw_buffer[index->value_length]);
read_next:
#if (TFDB_WRITE_UNIT_BYTES==8)
                if (find_addr >= (index->flash_addr + 8 + aligned_value_size))
#else
                if (find_addr >= (index->flash_addr + 4 + aligned_value_size))
#endif
                {
                    find_addr = find_addr - aligned_value_size;
                    result = tfdb_port_read(find_addr, rw_buffer, aligned_value_size);
                    if (result != TFDB_NO_ERR)
                    {
                        TFDB_DEBUG("    read err\n");
                        goto end;
                    }
                    goto verify;
                }
                else
                {
                    TFDB_DEBUG("    no data in flash\n");
                    result = TFDB_NO_DATA;
                    goto end;
                }
            }
            else
            {
                TFDB_DEBUG("    find success\n");
                result = TFDB_NO_ERR;
                if(value_to != NULL)
                {
                    tfdb_memcpy(value_to, rw_buffer, index->value_length);
                }
                if (addr_cache != NULL)
                {
                    *addr_cache = find_addr;
                }
            }
        }
        else
        {
            TFDB_DEBUG("    header err\n");
            result = TFDB_HDR_ERR;
            goto end;
        }
    }
    else
    {
        if (*addr_cache == 0)
        {
            /* addr_cache is not set */
            goto start;
        }
        else
        {
            find_addr = *addr_cache;
            result = tfdb_port_read(find_addr, rw_buffer, aligned_value_size);
            if (result != TFDB_NO_ERR)
            {
                TFDB_DEBUG("    read err\n");
                goto end;
            }
            goto verify;
        }
    }
end:
    TFDB_LOG("tfdb_get:%d\n", result);
    return result;
}

/**
 * get the previous data in flash and save the addr of data to addr_cache.
 *
 * @param index the data manage index.
 * @param rw_buffer buffer to store prepared read data or write data.
 * @param addr_cache the pointer to addr which is user offered.
 * @param value_to the pointer to buffer which is user offered to save data.
 *
 * @return TFDB_Err_Code
 */
TFDB_Err_Code tfdb_get_pre(const tfdb_index_t *index, uint8_t *rw_buffer, tfdb_addr_t *addr_cache, tfdb_addr_t *pre_addr_cache, void *value_to)
{
    TFDB_Err_Code result;
    uint8_t aligned_value_size;
    tfdb_addr_t find_addr;

    TFDB_LOG("tfdb_get_pre >\n");

    if(addr_cache == NULL)
    {
        goto prepare;
    }
    else
    {
        if(*addr_cache != 0)
        {
            find_addr = *addr_cache;
            TFDB_LOG("find_addr:%x\n", find_addr);
find:
            aligned_value_size  = index->value_length + 2;  /* data + verify + end_byte */

#if (TFDB_WRITE_UNIT_BYTES==2)
            /* aligned with TFDB_WRITE_UNIT_BYTES */
            aligned_value_size = ((aligned_value_size + 1) & 0xfe);
#elif (TFDB_WRITE_UNIT_BYTES==4)
            /* aligned with TFDB_WRITE_UNIT_BYTES */
            aligned_value_size = ((aligned_value_size + 3) & 0xfc);
#elif (TFDB_WRITE_UNIT_BYTES==8)
            /* aligned with TFDB_WRITE_UNIT_BYTES */
            aligned_value_size = ((aligned_value_size + 7) & 0xf8);
#endif

            TFDB_LOG("aigned size:%d\n", aligned_value_size);

#if (TFDB_WRITE_UNIT_BYTES==8)
            if(find_addr >= (index->flash_addr + 8 + aligned_value_size))
#else
            if(find_addr >= (index->flash_addr + 4 + aligned_value_size))
#endif
            {
                find_addr = find_addr - aligned_value_size;
                result = tfdb_get(index, rw_buffer, &find_addr, value_to);
                if(result == TFDB_NO_ERR)
                {
                    if(pre_addr_cache != NULL)
                    {
                        *pre_addr_cache = find_addr;
                    }
                }
            }
            else
            {
                /* no old data. */
                result = TFDB_NO_PRE_DATA;
            }
        }
        else
        {
prepare:
            find_addr = 0;
            result = tfdb_get(index, rw_buffer, &find_addr, value_to);
            if(result != TFDB_NO_ERR)
            {
                goto end;
            }
            if(addr_cache != NULL)
            {
                *addr_cache = find_addr;
            }
            goto find;
        }
    }
end:
    TFDB_LOG("tfdb_get_pre:%d\n", result);
    return result;
}

/**
 * judge which seq is new.
 *
 * @param seq the pointer to seq[2] buffer.
 *
 * @return uint8_t which seq is new, 0xff means all seq is illegal.
 */
static uint8_t tfdb_dual_judge(uint16_t *seq)
{
    /* seq range: 0x00ff -> 0x0ff0 -> 0xff00 */
    switch (seq[0])
    {
    case 0xff00:
        if (seq[1] == 0x00ff)
        {
            return 1;
        }
        else
        {
            return 0;
        }
    case 0x0ff0:
        if (seq[1] == 0xff00)
        {
            return 1;
        }
        else
        {
            return 0;
        }
    case 0x00ff:
        if (seq[1] == 0x0ff0)
        {
            return 1;
        }
        else
        {
            return 0;
        }
    default:
        if ((seq[1] == 0x00ff) || (seq[1] == 0x0ff0) || (seq[1] == 0xff00))
        {
            return 1;
        }
        break;
    }
    return 0xff;
}

/**
 * get next seq from given seq.
 *
 * @param seq the pointer to seq[2] buffer.
 *
 * @return uint8_t which seq is new, 0xff means all seq is illegal.
 */
static uint16_t tfdb_dual_get_next_seq(uint16_t seq)
{
    /* seq range: 0x00ff -> 0x0ff0 -> 0xff00 */
    if (seq == 0x00ff)
    {
        return 0x0ff0;
    }
    else if (seq == 0x0ff0)
    {
        return 0xff00;
    }
    else
    {
        return 0x00ff;
    }
}

/**
 * get the data in flash and save the addr and seq to cache.
 *
 * @param index the data manage index.
 * @param rw_buffer buffer to store prepared read data or write data.
 * @param rw_buffer_bak buffer to store prepared read data or write data.
 * @param cache the pointer to addr which is user offered, which will save read addr and seq.
 * @param value_from the pointer to buffer which is user offered that need to save.
 *
 * @return TFDB_Err_Code
 */
TFDB_Err_Code tfdb_dual_get(const tfdb_dual_index_t *index, uint8_t *rw_buffer, uint8_t *rw_buffer_bak, tfdb_dual_cache_t *cache, void *value_to)
{
    TFDB_Err_Code rresult = TFDB_NO_ERR;
    TFDB_Err_Code result[2];
    uint8_t judge_state;

    if (cache != NULL)
    {
        judge_state = tfdb_dual_judge(cache->seq);

        TFDB_DEBUG("tfdb_dual_judge:%d\n", judge_state);

        /* usually, we just read value once during the initializing. */
        if (judge_state == 0xff)
        {
            result[0] = tfdb_get(&index->indexes[0], rw_buffer, &(cache->addr_cache[0]), rw_buffer_bak);
            if (result[0] == TFDB_NO_ERR)
            {
                cache->seq[0] = (rw_buffer_bak[0] << 8) | (rw_buffer_bak[1]);
                tfdb_memcpy(value_to, &(rw_buffer_bak[2]), index->indexes[0].value_length - 2);
            }
            else
            {
                cache->seq[0] = 0;
            }

            result[1] = tfdb_get(&index->indexes[1], rw_buffer, &(cache->addr_cache[1]), rw_buffer_bak);
            if (result[1] == TFDB_NO_ERR)
            {
                cache->seq[1] = (rw_buffer_bak[0] << 8) | (rw_buffer_bak[1]);
            }
            else
            {
                cache->seq[1] = 0;
            }

            judge_state = tfdb_dual_judge(cache->seq);
            if (judge_state == 1)
            {
                tfdb_memcpy(value_to, &(rw_buffer_bak[2]), index->indexes[1].value_length - 2);
            }
            else if (judge_state == 0xff)
            {
                rresult = TFDB_SEQ_ERR;
            }
        }
        else
        {
            rresult = tfdb_get(&index->indexes[judge_state], rw_buffer, &(cache->addr_cache[judge_state]), rw_buffer_bak);
            if (rresult == TFDB_NO_ERR)
            {
                tfdb_memcpy(value_to, &(rw_buffer_bak[2]), index->indexes[judge_state].value_length - 2);
            }
            else
            {
                /* block not right, don't read another block. */
            }
        }
    }
    else
    {
        rresult = TFDB_CACHE_ERR;
    }

    return rresult;
}

/**
 * set data in flash and save the addr and seq to cache.
 *
 * @param index the data manage index.
 * @param rw_buffer buffer to store prepared read data or write data.
 * @param rw_buffer_bak buffer to store prepared read data or write data.
 * @param cache the pointer to addr which is user offered, which will save read addr and seq.
 * @param value_from the pointer to buffer which is user offered that need to save.
 *
 * @return TFDB_Err_Code
 */
TFDB_Err_Code tfdb_dual_set(const tfdb_dual_index_t *index, uint8_t *rw_buffer, uint8_t *rw_buffer_bak, tfdb_dual_cache_t *cache, void *value_from)
{
    TFDB_Err_Code rresult = TFDB_NO_ERR;
    TFDB_Err_Code result[2];
    uint8_t judge_state;
    uint16_t write_seq;

    if (cache != NULL)
    {
        judge_state = tfdb_dual_judge(cache->seq);

        TFDB_DEBUG("tfdb_dual_judge:%d\n", judge_state);

        /* usually, we just read value once during the initializing. */
        if (judge_state != 0xff)
        {
write:
            write_seq = tfdb_dual_get_next_seq(cache->seq[judge_state]);
            judge_state = 1 - judge_state;  /* we need to write in another flash block. */

            rw_buffer_bak[0] = (uint8_t)(write_seq >> 8);
            rw_buffer_bak[1] = (uint8_t)write_seq;

            tfdb_memcpy(&(rw_buffer_bak[2]), value_from, index->indexes[judge_state].value_length - 2);

            result[judge_state] = tfdb_set(&index->indexes[judge_state], rw_buffer, &(cache->addr_cache[judge_state]), rw_buffer_bak);
            if (result[judge_state] == TFDB_NO_ERR)
            {
                cache->seq[judge_state] = write_seq;
            }
            else
            {
                /* block is error, do not write to another block, for keeping the old data safe.
                 * if you want to write in another block, please use tfdb_set directly. */
                rresult = judge_state + TFDB_FLASH1_ERR;
            }
        }
        else
        {
            result[0] = tfdb_get(&index->indexes[0], rw_buffer, &(cache->addr_cache[0]), rw_buffer_bak);
            if (result[0] == TFDB_NO_ERR)
            {
                cache->seq[0] = (rw_buffer_bak[0] << 8) | (rw_buffer_bak[1]);
            }
            else
            {
                cache->seq[0] = 0;
            }

            result[1] = tfdb_get(&index->indexes[1], rw_buffer, &(cache->addr_cache[1]), rw_buffer_bak);
            if (result[1] == TFDB_NO_ERR)
            {
                cache->seq[1] = (rw_buffer_bak[0] << 8) | (rw_buffer_bak[1]);
            }
            else
            {
                cache->seq[1] = 0;
            }

            judge_state = tfdb_dual_judge(cache->seq);
            if (judge_state == 0xff)
            {
                judge_state = 0;    /* first write 0 block. */
            }

            goto write;
        }
    }
    else
    {
        return TFDB_CACHE_ERR;
    }

    return rresult;
}