4 * This file is part of BeRTOS.
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.
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.
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
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.
29 * Copyright 2007 Develer S.r.l. (http://www.develer.com/)
35 * \author Francesco Sacchi <batt@develer.com>
37 * \brief BattFS: a filesystem for embedded platforms (interface).
38 * TODO: Add detailed filesystem description.
44 #include <cfg/compiler.h> // uintXX_t; STATIC_ASSERT
45 #include <cpu/types.h> // CPU_BITS_PER_CHAR
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 uint8_t fsc_t;
55 * Reserve 2 bits from fill field to allocate seq number.
57 #define FILLSIZE ((sizeof(fill_t) * CPU_BITS_PER_CHAR) - 2)
62 * \note fields order is chosen to comply
65 typedef struct BattFsPageHeader
67 mark_t mark; ///< Marker used to keep trace of free/used pages.
68 pgoff_t pgoff; ///< Page offset inside file.
69 fill_t fill:FILLSIZE; ///< Filled bytes in page.
70 seq_t seq:2; ///< bit[1:0]: Page sequence number; bit[7:2] unused for now, must be set to 1.
71 inode_t inode; ///< File inode (file identifier).
72 fsc_t fsc; ///< FSC of the page header.
75 /* Ensure structure has no padding added */
76 STATIC_ASSERT(sizeof(BattFsPageHeader) == 8);
82 * Type for disk page addressing.
84 typedef uint32_t battfs_page_t;
87 * Type interface for disk init function.
88 * \return true if all is ok, false otherwise.
90 typedef bool (*disk_init_t) (struct BattFsSuper *d);
93 * Type interface for disk page read function.
94 * \a page is the page address, \a size the lenght to be read.
95 * \return the number of bytes read.
97 typedef size_t (*disk_page_read_t) (struct BattFsSuper *d, void *buf, battfs_page_t page, size_t size);
100 * Type interface for disk page write function.
101 * \a page is the page address, \a size the lenght to be written.
102 * \return the number of bytes written.
104 typedef size_t (*disk_page_write_t) (struct BattFsSuper *d, const void *buf, battfs_page_t page, size_t size);
107 * Type interface for disk page erase function.
108 * \a page is the page address.
109 * \return true if all is ok, false otherwise.
111 typedef bool (*disk_page_erase_t) (struct BattFsSuper *d, battfs_page_t page);
113 typedef uint32_t disk_size_t; ///< Type for disk sizes.
116 * Context used to describe a disk.
117 * This context structure will be used to access disk.
118 * Must be initialized by hw memory driver.
120 typedef struct BattFsSuper
122 disk_init_t init; ///< Disk init.
123 disk_page_read_t read; ///< Page read.
124 disk_page_write_t write; ///< Page write.
125 disk_page_erase_t erase; ///< Page erase.
127 disk_size_t disk_size; ///< Size of the disk, in bytes.
128 disk_size_t free_bytes; ///< Free space on the disk.
129 /* TODO add other fields. */
132 #endif /* FS_BATTFS_H */