X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=bertos%2Ffs%2Fbattfs.h;h=e0829917ddce66b33f25a442389fd1b6f16db8ae;hb=c36d4b6e73fd7e760f1a99fd2d87d7083fd87933;hp=0422c43a7497181a5d03264c123bf9cf39a655ff;hpb=0a08cd291277f26da98d3266911afd57ccfbe698;p=bertos.git diff --git a/bertos/fs/battfs.h b/bertos/fs/battfs.h index 0422c43a..e0829917 100644 --- a/bertos/fs/battfs.h +++ b/bertos/fs/battfs.h @@ -52,14 +52,9 @@ typedef fill_t pgaddr_t; ///< Type for addressing space inside a page typedef uint16_t pgcnt_t; ///< Type for counting pages on disk typedef pgcnt_t pgoff_t; ///< Type for counting pages inside a file typedef uint8_t inode_t; ///< Type for file inodes -typedef uint8_t seq_t; ///< Type for page seq number +typedef uint64_t seq_t; ///< Type for page seq number, at least 40bits wide. typedef rotating_t fcs_t; ///< Type for header FCS. -/** - * Size required for free block allocation is at least 1 bit more - * than page addressing. - */ -STATIC_ASSERT(sizeof(seq_t) > sizeof(pgcnt_t)); /** * BattFS page header, used to represent a page @@ -73,7 +68,16 @@ typedef struct BattFsPageHeader inode_t inode; ///< File inode (file identifier). fill_t fill; ///< Filled bytes in page. pgoff_t pgoff; ///< Page offset inside file. - seq_t seq; ///< Page sequence number. + + /** + * Page sequence number. + * Every time a page is rewritten the seq number is + * increased by 1. seq_t is wide enough to not to perform + * a wrap around before the memory death. + * So it can be kept as it would be + * monotonically increasing for our needs. + */ + seq_t seq; /** * FCS (Frame Check Sequence) of the page header. @@ -86,18 +90,7 @@ typedef struct BattFsPageHeader * \see battfs_to_disk * \see disk_to_battfs */ -#define BATTFS_HEADER_LEN 10 - -/** - * Half-size of page sequence numer. - */ -#define HALF_SEQ (1 << (CPU_BITS_PER_CHAR * sizeof(pgcnt_t))) - -/** - * Max sequence number. - */ -#define MAX_SEQ ((1 << (CPU_BITS_PER_CHAR * sizeof(pgcnt_t) + 1)) - 1) - +#define BATTFS_HEADER_LEN 12 /** * Maximum page address. @@ -117,9 +110,6 @@ struct BattFsSuper; */ #define PAGE_UNSET_SENTINEL ((1 << (CPU_BITS_PER_CHAR * sizeof(pgcnt_t))) - 1) -/** Also used as an error marker sometimes */ -#define PAGE_ERROR PAGE_UNSET_SENTINEL - /** * Type interface for disk init function. * \return true if all is ok, false otherwise. @@ -134,13 +124,33 @@ typedef bool (*disk_open_t) (struct BattFsSuper *d); */ typedef size_t (*disk_page_read_t) (struct BattFsSuper *d, pgcnt_t page, pgaddr_t addr, void *buf, size_t); + /** - * Type interface for disk page write function. - * \a page is the page address, \a addr the address inside the page, + * Type interface for disk page load function. + * The disk should supply a buffer used for loading/saving pages. + * This has to be done by the disk driver because it knows memory details + * (e.g. some memories can have the buffer inside the memory itself). + * \a page is the page to be loaded from the disk in the buffer. + * \return true if ok, false on errors. + */ +typedef bool (*disk_page_load_t) (struct BattFsSuper *d, pgcnt_t page); + +/** + * Type interface for disk pagebuffer write function. + * \a addr is the address inside the current loaded page, * \a size the lenght to be written. * \return the number of bytes written. */ -typedef size_t (*disk_page_write_t) (struct BattFsSuper *d, pgcnt_t page, pgaddr_t addr, const void *buf, size_t); +typedef size_t (*disk_buffer_write_t) (struct BattFsSuper *d, pgaddr_t addr, const void *buf, size_t); + +/** + * Type interface for disk page save function. + * The disk should supply a buffer used for loading/saving pages. + * For details \see disk_page_load_t. + * \a page is the page where the buffer will be written. + * \return true if ok, false on errors. + */ +typedef bool (*disk_page_save_t) (struct BattFsSuper *d, pgcnt_t page); /** * Type interface for disk page erase function. @@ -167,7 +177,9 @@ typedef struct BattFsSuper { disk_open_t open; ///< Disk init. disk_page_read_t read; ///< Page read. - disk_page_write_t write; ///< Page write. + disk_page_load_t load; ///< Page load. + disk_buffer_write_t bufferWrite; ///< Buffer write. + disk_page_save_t save; ///< Page save. disk_page_erase_t erase; ///< Page erase. disk_close_t close; ///< Disk deinit. @@ -182,6 +194,8 @@ typedef struct BattFsSuper * the entire disk in memory. */ pgcnt_t *page_array; + pgcnt_t curr_page; + bool cache_dirty; /** * Lowest address, in page array, for free pages. @@ -196,8 +210,8 @@ typedef struct BattFsSuper /* TODO add other fields. */ } BattFsSuper; -typedef uint8_t filemode_t; ///< Type for file open modes. -typedef uint32_t file_size_t; ///< Type for file sizes. +typedef uint8_t filemode_t; ///< Type for file open modes. +typedef int32_t file_size_t; ///< Type for file sizes. /** * Modes for battfs_fileopen. @@ -242,6 +256,5 @@ bool battfs_close(struct BattFsSuper *disk); bool battfs_fileExists(BattFsSuper *disk, inode_t inode); bool battfs_fileopen(BattFsSuper *disk, BattFs *fd, inode_t inode, filemode_t mode); - -bool battfs_writeTestBlock(struct BattFsSuper *disk, pgcnt_t page, inode_t inode, seq_t seq, fill_t fill, pgoff_t pgoff, seq_t seq); +bool battfs_writeTestBlock(struct BattFsSuper *disk, pgcnt_t page, inode_t inode, seq_t seq, fill_t fill, pgoff_t pgoff); #endif /* FS_BATTFS_H */