*
* \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
#include <algo/rotating_hash.h>
#include <struct/list.h>
#include <kern/kfile.h>
+#include <io/kblock.h>
typedef uint16_t fill_t; ///< Type for keeping trace of space filled inside a page
typedef fill_t pgaddr_t; ///< Type for addressing space inside a page
/**
* 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);
-
-/**
- * Type interface for disk page read function.
- * \a page is the page address, \a addr the address inside the page,
- * \a size the lenght to be read.
- * \return the number of bytes read.
- */
-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 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_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.
- * \a page is the page address.
- * \return true if all is ok, false otherwise.
- */
-typedef bool (*disk_page_erase_t) (struct BattFsSuper *d, pgcnt_t page);
-
-/**
- * Type interface for disk deinit function.
- * \return true if all is ok, false otherwise.
- */
-typedef bool (*disk_close_t) (struct BattFsSuper *d);
-
+#define PAGE_UNSET_SENTINEL ((pgcnt_t)((1L << (CPU_BITS_PER_CHAR * sizeof(pgcnt_t))) - 1))
typedef uint32_t disk_size_t; ///< Type for disk sizes.
*/
typedef struct BattFsSuper
{
- disk_open_t open; ///< Disk init.
- disk_page_read_t read; ///< Page read.
- 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.
+ KBlock *dev; ///< Block device context (physical disk).
- 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.
pgcnt_t page_count; ///< Number of pages on disk.
+ pgaddr_t data_size; ///< Size of space usable for data in a disk page, in bytes. The rest is used by the page header.
/**
* Page allocation array.
* This array must be allocated somewhere and
* the entire disk in memory.
*/
pgcnt_t *page_array;
- struct BattFsPageHeader curr_hdr; ///< Current page header (cached)-
- 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.
/* 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.
/*/}*/
+/**
+ * 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 device.
+#define BATTFS_DISK_WRITE_ERR BV(2) ///< Error writing in the disk device.
+#define BATTFS_DISK_SPACEOVER_ERR BV(3) ///< No more disk space available.
+#define BATTFS_DISK_FLUSHBUF_ERR BV(4) ///< Error flushing (writing) the current page to disk.
+#define BATTFS_FILE_NOT_FOUND_ERR BV(5) ///< File not found on disk.
+/*/}*/
+
/**
* Describe a BattFs file usign a KFile.
*/
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;
/**
return (BattFs *)fd;
}
-bool battfs_init(struct BattFsSuper *d);
-bool battfs_close(struct BattFsSuper *disk);
+bool battfs_mount(struct BattFsSuper *disk, struct KBlock *dev, pgcnt_t *page_array, size_t array_size);
+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);
-bool battfs_writeTestBlock(struct BattFsSuper *disk, pgcnt_t page, inode_t inode, seq_t seq, fill_t fill, pgoff_t pgoff);
+
+void battfs_writeTestBlock(KBlock *dev, pgcnt_t page, inode_t inode, seq_t seq, fill_t fill, pgoff_t pgoff);
+void battfs_eraseBlock(KBlock *dev, pgcnt_t page);
#endif /* FS_BATTFS_H */
projects / bertos.git / blobdiff