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  */
  39
  40 #ifndef FS_BATTFS_H
  41 #define FS_BATTFS_H
  42
  43 #include <cfg/compiler.h> // uintXX_t; STATIC_ASSERT
  44
  45 /**
  46  * BattFS page header.
  47  * \note fields order is chosen to comply with alignment.
  48  */
  49 typedef struct BattFsPageHeader
  50 {
  51         uint16_t filled;      ///< filled bytes in page.
  52         uint16_t page_off;    ///< Page offset inside file.
  53         uint8_t  inode;       ///< File inode (file identifier).
  54         uint8_t  seqnum;      ///< bit[1:0]: Page sequence number; bit[7:2] unused for now, must be set to 1.
  55         uint16_t crc;         ///< CRC of the page header.
  56 } BattFsPageHeader;
  57
  58 STATIC_ASSERT(sizeof(BattFsPageHeader) == 8);
  59
  60 /**
  61  * Reset page sequence number of struct \a m to default value (0xFF).
  62  */
  63 #define RESET_SEQ(m) ((m).seqnum = 0xFF)
  64
  65 /**
  66  * Get page sequence number from struct \a m.
  67  */
  68 #define SEQ(m) ((m).seqnum & 0x03)
  69
  70 /**
  71  * Set sequence number of struct \a m to \a d.
  72  */
  73 #define SET_SEQ(m, d) ((m).seqnum = ((m).seqnum & 0xFC) | ((d) & 0x03))
  74
  75 /**
  76  * Increment sequence number of struct \a m.
  77  */
  78 #define INC_SEQ(m) SET_SEQ((m), SEQ(m) + 1)
  79
  80
  81 #endif /* FS_BATTFS_H */