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
46 #include <algo/rotating_hash.h>
47 #include <struct/list.h>
48 #include <kern/kfile.h>
50 typedef uint16_t fill_t; ///< Type for keeping trace of space filled inside a page
51 typedef fill_t pgaddr_t; ///< Type for addressing space inside a page
52 typedef uint16_t pgcnt_t; ///< Type for counting pages on disk
53 typedef pgcnt_t pgoff_t; ///< Type for counting pages inside a file
54 typedef uint8_t inode_t; ///< Type for file inodes
55 typedef uint64_t seq_t; ///< Type for page seq number, at least 40bits wide.
56 typedef rotating_t fcs_t; ///< Type for header FCS.
60 * BattFS page header, used to represent a page
62 * To see how this is stored on disk:
66 typedef struct BattFsPageHeader
68 inode_t inode; ///< File inode (file identifier).
69 fill_t fill; ///< Filled bytes in page.
70 pgoff_t pgoff; ///< Page offset inside file.
73 * Page sequence number.
74 * Every time a page is rewritten the seq number is
75 * increased by 1. seq_t is wide enough to not to perform
76 * a wrap around before the memory death.
77 * So it can be kept as it would be
78 * monotonically increasing for our needs.
83 * FCS (Frame Check Sequence) of the page header.
89 * Size of the header once saved on disk.
93 #define BATTFS_HEADER_LEN 12
96 * Maximum page address.
98 #define MAX_PAGE_ADDR ((1 << (CPU_BITS_PER_CHAR * sizeof(pgcnt_t))) - 1)
101 * Max number of files.
103 #define BATTFS_MAX_FILES (1 << (CPU_BITS_PER_CHAR * sizeof(inode_t)))
109 * Sentinel used to keep trace of unset pages in disk->page_array.
111 #define PAGE_UNSET_SENTINEL ((1 << (CPU_BITS_PER_CHAR * sizeof(pgcnt_t))) - 1)
114 * Type interface for disk init function.
115 * \return true if all is ok, false otherwise.
117 typedef bool (*disk_open_t) (struct BattFsSuper *d);
120 * Type interface for disk page read function.
121 * \a page is the page address, \a addr the address inside the page,
122 * \a size the lenght to be read.
123 * \return the number of bytes read.
125 typedef size_t (*disk_page_read_t) (struct BattFsSuper *d, pgcnt_t page, pgaddr_t addr, void *buf, size_t);
129 * Type interface for disk page load function.
130 * The disk should supply a buffer used for loading/saving pages.
131 * This has to be done by the disk driver because it knows memory details
132 * (e.g. some memories can have the buffer inside the memory itself).
133 * \a page is the page to be loaded from the disk in the buffer.
134 * \return true if ok, false on errors.
136 typedef bool (*disk_page_load_t) (struct BattFsSuper *d, pgcnt_t page);
139 * Type interface for disk pagebuffer write function.
140 * \a addr is the address inside the current loaded page,
141 * \a size the lenght to be written.
142 * \return the number of bytes written.
144 typedef size_t (*disk_buffer_write_t) (struct BattFsSuper *d, pgaddr_t addr, const void *buf, size_t);
147 * Type interface for disk pagebuffer read function.
148 * \a addr is the address inside the current loaded page,
149 * \a size the lenght to be read.
150 * \return the number of bytes read.
152 typedef size_t (*disk_buffer_read_t) (struct BattFsSuper *d, pgaddr_t addr, void *buf, size_t);
155 * Type interface for disk page save function.
156 * The disk should supply a buffer used for loading/saving pages.
157 * For details \see disk_page_load_t.
158 * \a page is the page where the buffer will be written.
159 * \return true if ok, false on errors.
161 typedef bool (*disk_page_save_t) (struct BattFsSuper *d, pgcnt_t page);
164 * Type interface for disk page erase function.
165 * \a page is the page address.
166 * \return true if all is ok, false otherwise.
168 typedef bool (*disk_page_erase_t) (struct BattFsSuper *d, pgcnt_t page);
171 * Type interface for disk deinit function.
172 * \return true if all is ok, false otherwise.
174 typedef bool (*disk_close_t) (struct BattFsSuper *d);
177 typedef uint32_t disk_size_t; ///< Type for disk sizes.
180 * Context used to describe a disk.
181 * This context structure will be used to access disk.
182 * Must be initialized by hw memory driver.
184 typedef struct BattFsSuper
186 disk_open_t open; ///< Disk init.
187 disk_page_read_t read; ///< Page read.
188 disk_page_load_t load; ///< Page load.
189 disk_buffer_write_t bufferWrite; ///< Buffer write.
190 disk_buffer_read_t bufferRead; ///< Buffer read.
191 disk_page_save_t save; ///< Page save.
192 disk_page_erase_t erase; ///< Page erase.
193 disk_close_t close; ///< Disk deinit.
195 pgaddr_t page_size; ///< Size of a disk page, in bytes.
196 pgcnt_t page_count; ///< Number of pages on disk.
199 * Page allocation array.
200 * This array must be allocated somewhere and
201 * must have enough space for page_count elements.
202 * Is used by the filesystem to represent
203 * the entire disk in memory.
206 pgcnt_t curr_page; ///< Current page loaded in disk buffer.
207 bool cache_dirty; ///< True if current cache is dirty (nneds to be flushed).
210 * Lowest address, in page array, for free pages.
211 * Pages above this element are free for use.
213 pgcnt_t free_page_start;
215 disk_size_t disk_size; ///< Size of the disk, in bytes (page_count * page_size).
216 disk_size_t free_bytes; ///< Free space on the disk.
218 List file_opened_list; ///< List used to keep trace of open files.
219 /* TODO add other fields. */
222 typedef uint8_t filemode_t; ///< Type for file open modes.
223 typedef int32_t file_size_t; ///< Type for file sizes.
226 * Modes for battfs_fileopen.
229 #define BATTFS_CREATE BV(0) ///< Create file if does not exist
230 #define BATTFS_RD BV(1) ///< Open file for reading
231 #define BATTFS_WR BV(2) ///< Open file fir writing
236 * Describe a BattFs file usign a KFile.
238 typedef struct BattFs
240 KFile fd; ///< KFile context
241 Node link; ///< Link for inserting in opened file list
242 inode_t inode; ///< inode of the opened file
243 BattFsSuper *disk; ///< Disk context
244 filemode_t mode; ///< File open mode
245 pgcnt_t *start; ///< Pointer to page_array file start position.
246 pgcnt_t max_off; ///< Max page offset allocated for the file.
250 * Id for battfs file descriptors.
252 #define KFT_BATTFS MAKE_ID('B', 'T', 'F', 'S')
255 * Macro used to cast a KFile to a BattFS.
256 * Also perform dynamic type check.
258 INLINE BattFs * BATTFS_CAST(KFile *fd)
260 ASSERT(fd->_type == KFT_BATTFS);
264 bool battfs_init(struct BattFsSuper *d);
265 bool battfs_close(struct BattFsSuper *disk);
267 bool battfs_fileExists(BattFsSuper *disk, inode_t inode);
268 bool battfs_fileopen(BattFsSuper *disk, BattFs *fd, inode_t inode, filemode_t mode);
269 bool battfs_writeTestBlock(struct BattFsSuper *disk, pgcnt_t page, inode_t inode, seq_t seq, fill_t fill, pgoff_t pgoff);
270 #endif /* FS_BATTFS_H */