123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329 |
- #ifndef FDS_INTERNAL_DEFS_H__
- #define FDS_INTERNAL_DEFS_H__
- #include "sdk_config.h"
- #include <stdint.h>
- #include <stdbool.h>
- #if defined (FDS_THREADS)
- #include "nrf_soc.h"
- #include "app_util_platform.h"
- #endif
- #ifdef __cplusplus
- extern "C" {
- #endif
- #define FDS_PAGE_TAG_SIZE (2)
- #define FDS_PAGE_TAG_WORD_0 (0)
- #define FDS_PAGE_TAG_WORD_1 (1)
- #define FDS_PAGE_TAG_MAGIC (0xDEADC0DE)
- #define FDS_PAGE_TAG_SWAP (0xF11E01FF)
- #define FDS_PAGE_TAG_DATA (0xF11E01FE)
- #define FDS_ERASED_WORD (0xFFFFFFFF)
- #define FDS_OFFSET_TL (0)
- #define FDS_OFFSET_IC (1)
- #define FDS_OFFSET_ID (2)
- #define FDS_OFFSET_DATA (3)
- #define FDS_HEADER_SIZE_TL (1)
- #define FDS_HEADER_SIZE_IC (1)
- #define FDS_HEADER_SIZE_ID (1)
- #define FDS_HEADER_SIZE (3)
- #define FDS_OP_EXECUTING (NRF_SUCCESS)
- #define FDS_OP_COMPLETED (0x1D1D)
- #define NRF_FSTORAGE_NVMC 1
- #define NRF_FSTORAGE_SD 2
- #if defined(NRF51)
- #define FDS_PHY_PAGE_SIZE (256)
- #else
- #define FDS_PHY_PAGE_SIZE (1024)
- #endif
- #define FDS_PHY_PAGES ((FDS_VIRTUAL_PAGES * FDS_VIRTUAL_PAGE_SIZE) / FDS_PHY_PAGE_SIZE)
- #define FDS_PHY_PAGES_RESERVED ((FDS_VIRTUAL_PAGES_RESERVED * FDS_VIRTUAL_PAGE_SIZE) / FDS_PHY_PAGE_SIZE)
- #define FDS_PHY_PAGES_IN_VPAGE (FDS_VIRTUAL_PAGE_SIZE / FDS_PHY_PAGE_SIZE)
- #define FDS_DATA_PAGES (FDS_VIRTUAL_PAGES - 1)
-
- #define FDS_PAGE_SIZE (FDS_VIRTUAL_PAGE_SIZE)
- #if (FDS_VIRTUAL_PAGE_SIZE % FDS_PHY_PAGE_SIZE != 0)
- #error "FDS_VIRTUAL_PAGE_SIZE must be a multiple of the size of a physical page."
- #endif
- #if (FDS_VIRTUAL_PAGES < 2)
- #error "FDS requires at least two virtual pages."
- #endif
- typedef enum
- {
- FDS_PAGE_DATA,
- FDS_PAGE_SWAP,
- FDS_PAGE_ERASED,
- FDS_PAGE_UNDEFINED,
- } fds_page_type_t;
- typedef enum
- {
- FDS_HEADER_VALID,
- FDS_HEADER_DIRTY,
- FDS_HEADER_CORRUPT
- } fds_header_status_t;
- typedef struct
- {
- fds_page_type_t page_type;
- uint32_t const * p_addr;
- uint16_t write_offset;
- uint16_t words_reserved;
- uint32_t volatile records_open;
- bool can_gc;
- } fds_page_t;
- typedef struct
- {
- uint32_t const * p_addr;
- uint16_t write_offset;
- } fds_swap_page_t;
- typedef enum
- {
- FDS_OP_NONE,
- FDS_OP_INIT,
- FDS_OP_WRITE,
- FDS_OP_UPDATE,
- FDS_OP_DEL_RECORD,
- FDS_OP_DEL_FILE,
- FDS_OP_GC
- } fds_op_code_t;
- typedef enum
- {
- FDS_OP_INIT_TAG_SWAP,
- FDS_OP_INIT_TAG_DATA,
- FDS_OP_INIT_ERASE_SWAP,
- FDS_OP_INIT_PROMOTE_SWAP,
- } fds_init_step_t;
- typedef enum
- {
- FDS_OP_WRITE_HEADER_BEGIN,
- FDS_OP_WRITE_HEADER_FINALIZE,
- FDS_OP_WRITE_RECORD_ID,
- FDS_OP_WRITE_DATA,
- FDS_OP_WRITE_FIND_RECORD,
- FDS_OP_WRITE_FLAG_DIRTY,
- FDS_OP_WRITE_DONE,
- } fds_write_step_t;
- typedef enum
- {
- FDS_OP_DEL_RECORD_FLAG_DIRTY,
- FDS_OP_DEL_FILE_FLAG_DIRTY,
- FDS_OP_DEL_DONE,
- } fds_delete_step_t;
- #if defined(__CC_ARM)
- #pragma push
- #pragma anon_unions
- #elif defined(__ICCARM__)
- #pragma language=extended
- #elif defined(__GNUC__)
-
- #endif
- typedef struct
- {
- fds_op_code_t op_code;
- union
- {
- struct
- {
- fds_init_step_t step;
- } init;
- struct
- {
- fds_header_t header;
- void const * p_data;
- uint16_t page;
- fds_write_step_t step;
- uint32_t record_to_delete;
- } write;
- struct
- {
- fds_delete_step_t step;
- uint16_t file_id;
- uint16_t record_key;
- uint32_t record_to_delete;
- } del;
- };
- } fds_op_t;
- #if defined(__CC_ARM)
- #pragma pop
- #elif defined(__ICCARM__)
-
- #elif defined(__GNUC__)
-
- #endif
- enum
- {
- PAGE_ERASED = 0x1,
- PAGE_DATA = 0x2,
- PAGE_SWAP_CLEAN = 0x4,
- PAGE_SWAP_DIRTY = 0x8,
- };
- typedef enum
- {
-
-
- NO_PAGES,
-
-
- NO_SWAP = (PAGE_DATA),
-
- FRESH_INSTALL = (PAGE_ERASED),
-
- TAG_SWAP = (PAGE_ERASED | PAGE_DATA),
-
- TAG_DATA = (PAGE_ERASED | PAGE_SWAP_CLEAN),
-
- TAG_DATA_INST = (PAGE_ERASED | PAGE_DATA | PAGE_SWAP_CLEAN),
-
-
-
- PROMOTE_SWAP = (PAGE_ERASED | PAGE_SWAP_DIRTY),
-
- PROMOTE_SWAP_INST = (PAGE_ERASED | PAGE_DATA | PAGE_SWAP_DIRTY),
-
-
-
- DISCARD_SWAP = (PAGE_DATA | PAGE_SWAP_DIRTY),
-
- ALREADY_INSTALLED = (PAGE_DATA | PAGE_SWAP_CLEAN),
- } fds_init_opts_t;
- typedef enum
- {
- GC_BEGIN,
- GC_NEXT_PAGE,
- GC_FIND_NEXT_RECORD,
- GC_COPY_RECORD,
- GC_ERASE_PAGE,
- GC_DISCARD_SWAP,
- GC_PROMOTE_SWAP,
- GC_TAG_NEW_SWAP
- } fds_gc_state_t;
- typedef struct
- {
- fds_gc_state_t state;
- uint16_t cur_page;
- uint32_t const * p_record_src;
- uint16_t run_count;
- bool do_gc_page[FDS_DATA_PAGES];
- bool resume;
- } fds_gc_data_t;
- #if defined (FDS_THREADS)
- #define CRITICAL_SECTION_ENTER() CRITICAL_REGION_ENTER()
- #define CRITICAL_SECTION_EXIT() CRITICAL_REGION_EXIT()
- #else
- #define CRITICAL_SECTION_ENTER()
- #define CRITICAL_SECTION_EXIT()
- #endif
- #ifdef __cplusplus
- }
- #endif
- #endif
|