Type of an MFS instance. More...
#include <hal_mfs.h>
Data Fields | |
| mfs_state_t | state |
| Driver state. More... | |
| const MFSConfig * | config |
| Current configuration data. More... | |
| mfs_bank_t | current_bank |
| Bank currently in use. More... | |
| uint32_t | current_counter |
| Usage counter of the current bank. More... | |
| flash_offset_t | next_offset |
| Pointer to the next free position in the current bank. More... | |
| flash_offset_t | used_space |
| Used space in the current bank without considering erased records. More... | |
| mfs_record_descriptor_t | descriptors [MFS_CFG_MAX_RECORDS] |
| Offsets of the most recent instance of the records. More... | |
| flash_offset_t | tr_next_offset |
| Next write offset for current transaction. More... | |
| flash_offset_t | tr_limit_offet |
| Maximum offset for the transaction. More... | |
| uint32_t | tr_nops |
| Number of buffered operations in current transaction. More... | |
| mfs_transaction_op_t | tr_ops [MFS_CFG_TRANSACTION_MAX] |
| Buffered operations in current transaction. More... | |
| union { | |
| } | buffer |
| Transient buffer. More... | |
Detailed Description
Field Documentation
| mfs_state_t MFSDriver::state |
Driver state.
Definition at line 343 of file hal_mfs.h.
Referenced by mfs_bank_erase(), mfs_bank_verify_erase(), mfs_flash_read(), mfs_flash_write(), mfs_mount(), mfsCommitTransaction(), mfsErase(), mfsEraseRecord(), mfsObjectInit(), mfsPerformGarbageCollection(), mfsReadRecord(), mfsRollbackTransaction(), mfsStart(), mfsStartTransaction(), mfsStop(), and mfsWriteRecord().
| const MFSConfig* MFSDriver::config |
Current configuration data.
Definition at line 347 of file hal_mfs.h.
Referenced by mfs_bank_check_header(), mfs_bank_erase(), mfs_bank_scan_records(), mfs_bank_verify_erase(), mfs_bank_write_header(), mfs_flash_read(), mfs_flash_write(), mfsEraseRecord(), mfsObjectInit(), mfsStart(), mfsStartTransaction(), mfsStop(), and mfsWriteRecord().
| mfs_bank_t MFSDriver::current_bank |
Bank currently in use.
Definition at line 351 of file hal_mfs.h.
Referenced by mfs_garbage_collect(), mfs_try_mount(), mfsEraseRecord(), mfsStartTransaction(), and mfsWriteRecord().
| uint32_t MFSDriver::current_counter |
Usage counter of the current bank.
Definition at line 355 of file hal_mfs.h.
Referenced by mfs_garbage_collect(), and mfs_try_mount().
| flash_offset_t MFSDriver::next_offset |
Pointer to the next free position in the current bank.
Definition at line 359 of file hal_mfs.h.
Referenced by mfs_bank_scan_records(), mfs_garbage_collect(), mfsCommitTransaction(), mfsEraseRecord(), mfsStartTransaction(), and mfsWriteRecord().
| flash_offset_t MFSDriver::used_space |
Used space in the current bank without considering erased records.
Definition at line 363 of file hal_mfs.h.
Referenced by mfs_try_mount(), mfsCommitTransaction(), mfsEraseRecord(), mfsStartTransaction(), and mfsWriteRecord().
| mfs_record_descriptor_t MFSDriver::descriptors[MFS_CFG_MAX_RECORDS] |
Offsets of the most recent instance of the records.
- Note
- Zero means that there is not a record with that id.
Definition at line 368 of file hal_mfs.h.
Referenced by mfs_bank_scan_records(), mfs_garbage_collect(), mfs_try_mount(), mfsCommitTransaction(), mfsEraseRecord(), mfsReadRecord(), and mfsWriteRecord().
| flash_offset_t MFSDriver::tr_next_offset |
Next write offset for current transaction.
Definition at line 373 of file hal_mfs.h.
Referenced by mfsCommitTransaction(), mfsEraseRecord(), mfsStartTransaction(), and mfsWriteRecord().
| flash_offset_t MFSDriver::tr_limit_offet |
Maximum offset for the transaction.
Definition at line 377 of file hal_mfs.h.
Referenced by mfsEraseRecord(), mfsStartTransaction(), and mfsWriteRecord().
| uint32_t MFSDriver::tr_nops |
Number of buffered operations in current transaction.
Definition at line 381 of file hal_mfs.h.
Referenced by mfsCommitTransaction(), mfsEraseRecord(), mfsRollbackTransaction(), mfsStartTransaction(), and mfsWriteRecord().
| mfs_transaction_op_t MFSDriver::tr_ops[MFS_CFG_TRANSACTION_MAX] |
Buffered operations in current transaction.
Definition at line 385 of file hal_mfs.h.
Referenced by mfsCommitTransaction(), mfsEraseRecord(), and mfsWriteRecord().
| union { ... } MFSDriver::buffer |
Transient buffer.
Referenced by mfs_bank_check_header(), mfs_bank_get_state(), mfs_bank_scan_records(), mfs_flash_copy(), mfs_flash_write(), mfs_try_mount(), mfsCommitTransaction(), mfsEraseRecord(), mfsReadRecord(), and mfsWriteRecord().
