X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=bertos%2Ffs%2Fbattfs.h;h=4c7e619d845c69847cb098725dc384351f4c3662;hb=efcdac5c593b00b2ff79bb6a92849c7ee9358bb3;hp=bd530e81760e8694d1180ad0e6cd49e3f06ed98e;hpb=4ce77ecc12cbc60cdb8717755006f6f461e6f6ad;p=bertos.git diff --git a/bertos/fs/battfs.h b/bertos/fs/battfs.h index bd530e81..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 @@ -108,13 +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) - -/** - * 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. @@ -183,7 +181,7 @@ 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_load_t load; ///< Page load. disk_buffer_write_t bufferWrite; ///< Buffer write. @@ -238,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. */ @@ -250,6 +263,7 @@ typedef struct BattFs 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; /** @@ -267,9 +281,9 @@ INLINE BattFs * BATTFS_CAST(KFile *fd) return (BattFs *)fd; } -bool battfs_init(struct BattFsSuper *d); +bool battfs_mount(struct BattFsSuper *d); bool battfs_fsck(struct BattFsSuper *disk); -bool battfs_close(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);