X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=fs%2Fbattfs.h;h=247e058538752f867fb1aa5461bfd2f8928f7546;hb=f5c60ed7a6e06c258385b69e3d25c624243c43fd;hp=4b8fcbe850ca0536ab2e61c7d772998356152f9c;hpb=7b338608c4e6e687e403d5484b42a277d1874024;p=bertos.git diff --git a/fs/battfs.h b/fs/battfs.h index 4b8fcbe8..247e0585 100644 --- a/fs/battfs.h +++ b/fs/battfs.h @@ -42,101 +42,206 @@ #define FS_BATTFS_H #include // uintXX_t; STATIC_ASSERT -#include - -typedef uint16_t filled_t; -typedef uint16_t page_off_t; +#include // CPU_BITS_PER_CHAR +#include +#include +#include + +typedef uint16_t fill_t; +typedef fill_t pgaddr_t; +typedef uint16_t pgoff_t; +typedef uint32_t mark_t; +typedef uint8_t mark_roll_t; typedef uint8_t inode_t; -typedef uint8_t seqnum_t; -typedef rotating_t battfs_crc_t; +typedef uint8_t seq_t; +typedef rotating_t fcs_t; -typedef uint16_t battfs_page_t; +/** + * Size required for free block allocation is at least 1 bit more + * than page addressing. + */ +STATIC_ASSERT(sizeof(mark_t) > sizeof(pgaddr_t)); /** - * BattFS page header. - * \note fields order is chosen to comply - * with CPU alignment. + * BattFS page header, used to represent a page + * header in memory. + * To see how this is stored on disk: + * \see battfs_to_disk + * \see disk_to_battfs */ typedef struct BattFsPageHeader { - inode_t inode; ///< File inode (file identifier). - seqnum_t seqnum; ///< bit[1:0]: Page sequence number; bit[7:2] unused for now, must be set to 1. - filled_t filled; ///< Filled bytes in page. - page_off_t page_off; ///< Page offset inside file. - battfs_crc_t crc; ///< CRC of the page header. + inode_t inode; ///< File inode (file identifier). + seq_t seq; ///< Page sequence number. + fill_t fill; ///< Filled bytes in page. + pgoff_t pgoff; ///< Page offset inside file. + mark_t mark; ///< Marker used to keep trace of free/used pages. + + /** + * FCS (Frame Check Sequence) of the page header once the page + * as been marked as free. + */ + fcs_t fcs_free; + + /** + * FCS (Frame Check Sequence) of the page header. + */ + fcs_t fcs; } BattFsPageHeader; -/* Ensure structure has no padding added */ -STATIC_ASSERT(sizeof(BattFsPageHeader) == sizeof(filled_t) + sizeof(page_off_t) - + sizeof(inode_t) + sizeof(seqnum_t) + siezof(BattFsDisk)); +/** + * Size of the header once saved on disk. + * \see battfs_to_disk + * \see disk_to_battfs + */ +#define BATTFS_HEADER_LEN 12 /** - * Reset page sequence number of struct \a m to default value (0xFF). + * Marks for valid pages. + * Simply set to 1 all field bits. + * \{ */ -#define RESET_SEQ(m) ((m).seqnum = 0xFF) +#define MARK_PAGE_VALID ((1 << (CPU_BITS_PER_CHAR * sizeof(pgaddr_t) + 1)) - 1) +#define FCS_FREE_VALID ((1 << (CPU_BITS_PER_CHAR * sizeof(fcs_t))) - 1) +/* \} */ + /** - * Get page sequence number from struct \a m. + * Half-size of free page marker. + * Used to keep trace of free marker wrap-arounds. */ -#define SEQ(m) ((m).seqnum & 0x03) +#define MARK_HALF_SIZE (1 << (CPU_BITS_PER_CHAR * sizeof(pgaddr_t) + 1)) /** - * Set sequence number of struct \a m to \a d. + * Maximum page address. */ -#define SET_SEQ(m, d) ((m).seqnum = ((m).seqnum & 0xFC) | ((d) & 0x03)) +#define MAX_PAGE_ADDR ((1 << (CPU_BITS_PER_CHAR * sizeof(pgaddr_t))) - 1) /** - * Increment sequence number of struct \a m. + * Max number of files. */ -#define INC_SEQ(m) SET_SEQ((m), SEQ(m) + 1) +#define BATTFS_MAX_FILES (1 << (CPU_BITS_PER_CHAR * sizeof(inode_t))) /* Fwd decl */ -struct BattFsDisk; +struct BattFsSuper; + +/** + * Type for disk page addressing. + */ +typedef uint16_t pgcnt_t; + +/** + * 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_init_t) (struct BattFsDisk *d); +typedef bool (*disk_open_t) (struct BattFsSuper *d); /** * Type interface for disk page read function. - * \a page is the page address, \a size the lenght to be read. + * \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 BattFsDisk *d, void *buf, battfs_page_t page, size_t size); +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 size the lenght to be written. + * \a page is the page address, \a addr the address inside the page, + * \a size the lenght to be written. * \return the number of bytes written. */ -typedef size_t (*disk_page_write_t) (struct BattFsDisk *d, const void *buf, battfs_page_t page, size_t size); +typedef size_t (*disk_page_write_t) (struct BattFsSuper *d, pgcnt_t page, pgaddr_t addr, const void *buf, size_t); /** * 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 BattFsDisk *d, battfs_page_t page); +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); -typedef uint32_t disk_size_t ///< Type for disk sizes. + +typedef uint32_t disk_size_t; ///< Type for disk sizes. /** * Context used to describe a disk. * This context structure will be used to access disk. * Must be initialized by hw memory driver. */ -typedef struct BattFsDisk +typedef struct BattFsSuper { - disk_init_t init; ///< Disk init. + disk_open_t open; ///< Disk init. disk_page_read_t read; ///< Page read. disk_page_write_t write; ///< Page write. disk_page_erase_t erase; ///< Page erase. - - disk_size_t disk_size; ///< Size of the disk, in bytes. - disk_size_t free_space; ///< Free space on the disk, in bytes. + disk_close_t close; ///< Disk deinit. + + pgaddr_t page_size; ///< Size of a disk page, in bytes. + pgcnt_t page_count; ///< Number of pages on disk. + + /** + * Page allocation array. + * This array must be allocated somewhere and + * must have enough space for page_count elements. + * Is used by the filesystem to represent + * the entire disk in memory. + */ + pgcnt_t *page_array; + + /** + * Lowest free page counter. + * This is the counter of the first availble free page. + */ + mark_t free_start; + + /** + * Highest free page counter. + * This value is the next to be used to mark a block as free. + */ + mark_t free_next; + + disk_size_t disk_size; ///< Size of the disk, in bytes (page_count * page_size). + disk_size_t free_bytes; ///< Free space on the disk. + + List file_opened_list; ///< List used to keep trace of open files. /* TODO add other fields. */ -} BattFsDisk; +} BattFsSuper; + +typedef uint8_t filemode_t; ///< Type for file open. + +/** + * Describe a BattFs file usign a KFile. + */ +typedef struct KFileBattFs +{ + KFile fd; ///< KFile context + Node link; ///< Link for inserting in opened file list + inode_t inode; ///< inode of the opened file + BattFsSuper *disk; ///< Disk context + filemode_t mode; ///< File open mode +} KFileBattFs; + +INLINE KFileBattFs * KFILEBATTFS(KFile *fd) +{ + ASSERT(fd->_type == KFT_BATTFS); + return (KFileBattFs *)fd; +} + +bool battfs_init(struct BattFsSuper *d); +bool battfs_close(struct BattFsSuper *disk); + +bool battfs_fileopen(BattFsSuper *disk, KFileBattFs *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, mark_t mark); #endif /* FS_BATTFS_H */