#define FS_BATTFS_H
#include <cfg/compiler.h> // uintXX_t; STATIC_ASSERT
-#include <algo/rotating_hash.h>
+#include <cpu/types.h> // CPU_BITS_PER_CHAR
-typedef uint16_t filled_t;
-typedef uint16_t page_off_t;
+typedef uint16_t fill_t;
+typedef uint16_t pgoff_t;
+typedef pgoff_t mark_t;
typedef uint8_t inode_t;
-typedef uint8_t seqnum_t;
-typedef rotating_t battfs_crc_t;
-
-typedef uint16_t battfs_page_t;
+typedef uint8_t seq_t;
+typedef uint16_t fsc_t;
/**
* BattFS page header.
*/
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.
+ mark_t mark; ///< Marker used to keep trace of free/used pages.
+ pgoff_t pgoff; ///< Page offset inside file.
+ fill_t fill; ///< Filled bytes in page.
+ seq_t seq; ///< Page sequence number.
+ inode_t inode; ///< File inode (file identifier).
+ uint16_t rfu; ///< Reserved for future use, 0xFFFF for now.
+ fsc_t fsc; ///< FSC of the page header.
} 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));
-
-/**
- * Reset page sequence number of struct \a m to default value (0xFF).
- */
-#define RESET_SEQ(m) ((m).seqnum = 0xFF)
-
-/**
- * Get page sequence number from struct \a m.
- */
-#define SEQ(m) ((m).seqnum & 0x03)
+STATIC_ASSERT(sizeof(BattFsPageHeader) == 12);
-/**
- * Set sequence number of struct \a m to \a d.
- */
-#define SET_SEQ(m, d) ((m).seqnum = ((m).seqnum & 0xFC) | ((d) & 0x03))
+/* Fwd decl */
+struct BattFsSuper;
/**
- * Increment sequence number of struct \a m.
+ * Type for disk page addressing.
*/
-#define INC_SEQ(m) SET_SEQ((m), SEQ(m) + 1)
-
-/* Fwd decl */
-struct BattFsDisk;
+typedef uint32_t battfs_page_t;
/**
* 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_init_t) (struct BattFsSuper *d);
/**
* Type interface for disk page read function.
* \a page is the page address, \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, void *buf, battfs_page_t page, size_t size);
/**
* Type interface for disk page write function.
* \a page is the page address, \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, const void *buf, battfs_page_t page, size_t size);
/**
* 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, battfs_page_t page);
-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_page_read_t read; ///< Page read.
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_size_t free_bytes; ///< Free space on the disk.
/* TODO add other fields. */
-} BattFsDisk;
+} BattFsSuper;
#endif /* FS_BATTFS_H */