fs/battfs.h

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2007 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \version $Id:$
  34  *
  35  * \author Francesco Sacchi <batt@develer.com>
  36  *
  37  * \brief BattFS: a filesystem for embedded platforms (interface).
  38  * TODO: Add detailed filesystem description.
  39  */
  40
  41 #ifndef FS_BATTFS_H
  42 #define FS_BATTFS_H
  43
  44 #include <cfg/compiler.h> // uintXX_t; STATIC_ASSERT
  45 #include <cpu/types.h> // CPU_BITS_PER_CHAR
  46
  47 typedef uint16_t fill_t;
  48 typedef uint16_t pgoff_t;
  49 typedef pgoff_t  mark_t;
  50 typedef uint8_t  inode_t;
  51 typedef uint8_t  seq_t;
  52 typedef uint16_t  fcs_t;
  53
  54 /**
  55  * BattFS page header.
  56  * \note fields order is chosen to comply
  57  * with CPU alignment.
  58  */
  59 typedef struct BattFsPageHeader
  60 {
  61         inode_t  inode; ///< File inode (file identifier).
  62         seq_t    seq;   ///< Page sequence number.
  63         mark_t   mark;  ///< Marker used to keep trace of free/used pages.
  64         pgoff_t  pgoff; ///< Page offset inside file.
  65         fill_t   fill;  ///< Filled bytes in page.
  66         uint16_t rfu;   ///< Reserved for future use, 0xFFFF for now.
  67         fcs_t    fcs;   ///< FCS (Frame Check Sequence) of the page header.
  68 } BattFsPageHeader;
  69
  70 /* Ensure structure has no padding added */
  71 STATIC_ASSERT(sizeof(BattFsPageHeader) == 12);
  72
  73 /* Fwd decl */
  74 struct BattFsSuper;
  75
  76 /**
  77  * Type for disk page addressing.
  78  */
  79 typedef uint32_t battfs_page_t;
  80
  81 /**
  82  * Type interface for disk init function.
  83  * \return true if all is ok, false otherwise.
  84  */
  85 typedef bool (*disk_init_t) (struct BattFsSuper *d);
  86
  87 /**
  88  * Type interface for disk page read function.
  89  * \a page is the page address, \a size the lenght to be read.
  90  * \return the number of bytes read.
  91  */
  92 typedef size_t (*disk_page_read_t) (struct BattFsSuper *d, void *buf, battfs_page_t page, size_t size);
  93
  94 /**
  95  * Type interface for disk page write function.
  96  * \a page is the page address, \a size the lenght to be written.
  97  * \return the number of bytes written.
  98  */
  99 typedef size_t  (*disk_page_write_t) (struct BattFsSuper *d, const void *buf, battfs_page_t page, size_t size);
 100
 101 /**
 102  * Type interface for disk page erase function.
 103  * \a page is the page address.
 104  * \return true if all is ok, false otherwise.
 105  */
 106 typedef bool (*disk_page_erase_t) (struct BattFsSuper *d, battfs_page_t page);
 107
 108 typedef uint32_t disk_size_t; ///< Type for disk sizes.
 109
 110 /**
 111  * Context used to describe a disk.
 112  * This context structure will be used to access disk.
 113  * Must be initialized by hw memory driver.
 114  */
 115 typedef struct BattFsSuper
 116 {
 117         disk_init_t init;        ///< Disk init.
 118         disk_page_read_t  read;  ///< Page read.
 119         disk_page_write_t write; ///< Page write.
 120         disk_page_erase_t erase; ///< Page erase.
 121
 122         disk_size_t disk_size;   ///< Size of the disk, in bytes.
 123         disk_size_t free_bytes;  ///< Free space on the disk.
 124         /* TODO add other fields. */
 125 } BattFsSuper;
 126
 127 #endif /* FS_BATTFS_H */