X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;ds=sidebyside;f=bertos%2Ffs%2Fbattfs.h;h=adb5607cd07a3bd03dd5703fc3532fa9f6d23381;hb=500fbef0b281c79719c73ba1a818db54057f74b7;hp=ee104db85ed6dbb8dc019b1a5a404721d27fb4cd;hpb=54cdb63007e4a3dac8cd50ecdb9e601e0302e62b;p=bertos.git diff --git a/bertos/fs/battfs.h b/bertos/fs/battfs.h index ee104db8..adb5607c 100644 --- a/bertos/fs/battfs.h +++ b/bertos/fs/battfs.h @@ -124,13 +124,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. @@ -157,11 +185,15 @@ 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_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. /** @@ -172,6 +204,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. @@ -186,6 +220,11 @@ typedef struct BattFsSuper /* TODO add other fields. */ } BattFsSuper; +/** + * 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. @@ -210,6 +249,7 @@ 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. } BattFs; /** @@ -227,8 +267,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);