X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=bertos%2Ffs%2Fbattfs.h;h=4c7e619d845c69847cb098725dc384351f4c3662;hb=6539fb2d550505f48e8732e887adfe5a3469266c;hp=9c60b9d506e6c274c101e280eceac3d3bf51a467;hpb=9563ce4c778bc517a8439000df985271f6967e21;p=bertos.git diff --git a/bertos/fs/battfs.h b/bertos/fs/battfs.h index 9c60b9d5..4c7e619d 100644 --- a/bertos/fs/battfs.h +++ b/bertos/fs/battfs.h @@ -36,6 +36,10 @@ * * \brief BattFS: a filesystem for embedded platforms (interface). * TODO: Add detailed filesystem description. + * + * $WIZ$ module_name = "battfs" + * $WIZ$ module_depends = "rotating_hash", "kfile" + * $WIZ$ module_configuration = "bertos/cfg/cfg_battfs.h" */ #ifndef FS_BATTFS_H @@ -52,14 +56,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 uint32_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 +72,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 +94,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. @@ -115,16 +112,7 @@ struct BattFsSuper; /** * Sentinel used to keep trace of unset pages in disk->page_array. */ -#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. - */ -typedef bool (*disk_open_t) (struct BattFsSuper *d); +#define PAGE_UNSET_SENTINEL ((pgcnt_t)((1L << (CPU_BITS_PER_CHAR * sizeof(pgcnt_t))) - 1)) /** * Type interface for disk page read function. @@ -134,13 +122,41 @@ 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 pagebuffer read function. + * \a addr is the address inside the current loaded page, + * \a size the lenght to be read. + * \return the number of bytes read. + */ +typedef size_t (*disk_buffer_read_t) (struct BattFsSuper *d, pgaddr_t addr, 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. @@ -165,13 +181,17 @@ typedef uint32_t disk_size_t; ///< Type for disk sizes. */ typedef struct BattFsSuper { - disk_open_t open; ///< Disk init. + void *disk_ctx; ///< Disk context used by disk access functions. 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_buffer_read_t bufferRead; ///< Buffer read. + disk_page_save_t save; ///< Page save. disk_page_erase_t erase; ///< Page erase. disk_close_t close; ///< Disk deinit. - pgaddr_t page_size; ///< Size of a disk page, in bytes. + pgaddr_t page_size; ///< Size of a memory page, in bytes. Used by disk low level driver. + pgaddr_t data_size; ///< Size of space usable for data in a disk page, in bytes. The rest is used by the page header. pgcnt_t page_count; ///< Number of pages on disk. /** @@ -182,6 +202,8 @@ typedef struct BattFsSuper * the entire disk in memory. */ pgcnt_t *page_array; + pgcnt_t curr_page; ///< Current page loaded in disk buffer. + bool cache_dirty; ///< True if current cache is dirty (nneds to be flushed). /** * Lowest address, in page array, for free pages. @@ -196,7 +218,12 @@ typedef struct BattFsSuper /* TODO add other fields. */ } BattFsSuper; -typedef uint8_t filemode_t; ///< Type for file open modes. +/** + * True if space on \a disk is over. + */ +#define SPACE_OVER(disk) ((disk)->free_page_start >= (disk)->page_count) + +typedef uint8_t filemode_t; ///< Type for file open modes. typedef int32_t file_size_t; ///< Type for file sizes. /** @@ -209,6 +236,21 @@ typedef int32_t file_size_t; ///< Type for file sizes. /*/}*/ +/** + * File errors. + * \{ + */ +#define BATTFS_NEGATIVE_SEEK_ERR BV(0) ///< Trying to read/write before file start. +#define BATTFS_DISK_READ_ERR BV(1) ///< Error reading from disk driver. +#define BATTFS_DISK_LOADPAGE_ERR BV(2) ///< Error loading a disk page in the buffer. +#define BATTFS_DISK_BUFFERWR_ERR BV(3) ///< Error writing in the disk page buffer. +#define BATTFS_DISK_GETNEWPAGE_ERR BV(4) ///< Error getting a free page. +#define BATTFS_DISK_BUFFERRD_ERR BV(6) ///< Error reading from the disk page buffer. +#define BATTFS_DISK_SPACEOVER_ERR BV(7) ///< No more disk space available. +#define BATTFS_DISK_FLUSHBUF_ERR BV(8) ///< Error flushing (writing) the current page to disk. +#define BATTFS_FILE_NOT_FOUND_ERR BV(9) ///< File not found on disk. +/*/}*/ + /** * Describe a BattFs file usign a KFile. */ @@ -220,6 +262,8 @@ typedef struct BattFs BattFsSuper *disk; ///< Disk context filemode_t mode; ///< File open mode pgcnt_t *start; ///< Pointer to page_array file start position. + pgcnt_t max_off; ///< Max page offset allocated for the file. + int errors; ///< File status/errors } BattFs; /** @@ -237,8 +281,9 @@ INLINE BattFs * BATTFS_CAST(KFile *fd) return (BattFs *)fd; } -bool battfs_init(struct BattFsSuper *d); -bool battfs_close(struct BattFsSuper *disk); +bool battfs_mount(struct BattFsSuper *d); +bool battfs_fsck(struct BattFsSuper *disk); +bool battfs_umount(struct BattFsSuper *disk); bool battfs_fileExists(BattFsSuper *disk, inode_t inode); bool battfs_fileopen(BattFsSuper *disk, BattFs *fd, inode_t inode, filemode_t mode);