+++ /dev/null
-/**
- * \file
- * <!--
- * This file is part of BeRTOS.
- *
- * Bertos is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
- *
- * As a special exception, you may use this file as part of a free software
- * library without restriction. Specifically, if other files instantiate
- * templates or use macros or inline functions from this file, or you compile
- * this file and link it with other files to produce an executable, this
- * file does not by itself cause the resulting executable to be covered by
- * the GNU General Public License. This exception does not however
- * invalidate any other reasons why the executable file might be covered by
- * the GNU General Public License.
- *
- * Copyright 2007 Develer S.r.l. (http://www.develer.com/)
- *
- * -->
- *
- * \version $Id:$
- *
- * \author Francesco Sacchi <batt@develer.com>
- *
- * \brief BattFS: a filesystem for embedded platforms (interface).
- * TODO: Add detailed filesystem description.
- */
-
-#ifndef FS_BATTFS_H
-#define FS_BATTFS_H
-
-#include <cfg/compiler.h> // uintXX_t; STATIC_ASSERT
-#include <cpu/types.h> // CPU_BITS_PER_CHAR
-#include <algo/rotating_hash.h>
-
-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 seq_t;
-typedef rotating_t fcs_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, 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).
- 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;
-
-/**
- * Size of the header once saved on disk.
- * \see battfs_to_disk
- * \see disk_to_battfs
- */
-#define BATTFS_HEADER_LEN 13
-
-/**
- * Marks for valid pages.
- * Simply set to 1 all field bits.
- * \{
- */
-#define MARK_PAGE_VALID ((1LL << (CPU_BITS_PER_CHAR * sizeof(mark_t))) - 1)
-#define FCS_FREE_VALID ((1 << (CPU_BITS_PER_CHAR * sizeof(fcs_t))) - 1)
-/* \} */
-
-
-/**
- * Half-size of free page marker.
- * Used to keep trace of free marker wrap-arounds.
- */
-#define MARK_HALF_SIZE (1 << (CPU_BITS_PER_CHAR * sizeof(pgaddr_t) + 1))
-
-/**
- * Maximum page address.
- */
-#define MAX_PAGE_ADDR ((1 << (CPU_BITS_PER_CHAR * sizeof(pgaddr_t))) - 1)
-
-/**
- * Max number of files.
- */
-#define BATTFS_MAX_FILES (1 << (CPU_BITS_PER_CHAR * sizeof(inode_t)))
-
-/* Fwd decl */
-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_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 write function.
- * \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 BattFsSuper *d, pgcnt_t page, pgaddr_t addr, 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 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.
-
-/**
- * Context used to describe a disk.
- * This context structure will be used to access disk.
- * Must be initialized by hw memory driver.
- */
-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_erase_t erase; ///< Page erase.
- 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.
-
- /* TODO add other fields. */
-} BattFsSuper;
-
-bool battfs_init(struct BattFsSuper *d);
-
-#endif /* FS_BATTFS_H */
projects / bertos.git / blobdiff