1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
|
/*
Managed Flash Storage - Copyright (C) 2016 Giovanni Di Sirio
This file is part of ChibiOS.
ChibiOS 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 3 of the License, or
(at your option) any later version.
ChibiOS 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, see <http://www.gnu.org/licenses/>.
*/
/**
* @file mfs.h
* @brief Managed Flash Storage module header.
*
* @{
*/
#ifndef MFS_H
#define MFS_H
#include "hal_flash.h"
/*===========================================================================*/
/* Driver constants. */
/*===========================================================================*/
#define MFS_BANK_MAGIC_1 0xEC705ADEU
#define MFS_BANK_MAGIC_2 0xF0339CC5U
#define MFS_HEADER_MAGIC 0x5FAEU
/*===========================================================================*/
/* Driver pre-compile time settings. */
/*===========================================================================*/
/**
* @name Configuration options
* @{
*/
/**
* @brief Record identifiers cache size.
* @details Cache trades RAM for a faster access to stored records. If zero
* then the cache is disabled.
*/
#if !defined(MFS_CFG_ID_CACHE_SIZE) || defined(__DOXIGEN__)
#define MFS_CFG_ID_CACHE_SIZE 16
#endif
/**
* @brief Maximum number of repair attempts on partition mount.
*/
#if !defined(MFS_CFG_MAX_REPAIR_ATTEMPTS) || defined(__DOXIGEN__)
#define MFS_CFG_MAX_REPAIR_ATTEMPTS 3
#endif
/**
* @brief Verify written data.
*/
#if !defined(MFS_CFG_WRITE_VERIFY) || defined(__DOXIGEN__)
#define MFS_CFG_WRITE_VERIFY TRUE
#endif
/** @} */
/*===========================================================================*/
/* Derived constants and error checks. */
/*===========================================================================*/
#if MFS_CFG_ID_CACHE_SIZE < 0
#error "invalid MFS_CFG_ID_CACHE_SIZE value"
#endif
#if (MFS_CFG_MAX_REPAIR_ATTEMPTS < 1) || (MFS_CFG_MAX_REPAIR_ATTEMPTS > 10)
#error "invalid MFS_MAX_REPAIR_ATTEMPTS value"
#endif
/*===========================================================================*/
/* Driver data structures and types. */
/*===========================================================================*/
/**
* @brief Type of a flash bank.
*/
typedef enum {
MFS_BANK_0 = 0,
MFS_BANK_1 = 1
} mfs_bank_t;
/**
* @brief Type of driver state machine states.
*/
typedef enum {
MFS_UNINIT = 0,
MFS_STOP = 1,
MFS_READY = 2,
MFS_MOUNTED = 3,
MFS_ACTIVE = 4
} mfs_state_t;
/**
* @brief Type of an MFS error code.
* @note Errors are negative integers, informative warnings are positive
* integers.
*/
typedef enum {
MFS_NO_ERROR = 0,
MFS_REPAIR_WARNING = 1,
MFS_GC_WARNING = 2,
MFS_ID_NOT_FOUND = -1,
MFS_CRC_ERROR = -2,
MFS_FLASH_FAILURE = -3,
MFS_INTERNAL_ERROR = -4
} mfs_error_t;
/**
* @brief Type of a bank state assessment.
*/
typedef enum {
MFS_BANK_ERASED = 0,
MFS_BANK_OK = 1,
MFS_BANK_PARTIAL = 2,
MFS_BANK_GARBAGE = 3
} mfs_bank_state_t;
/**
* @brief Type of a bank header.
* @note The header resides in the first 16 bytes of a bank extending
* to the next page boundary.
*/
typedef struct {
/**
* @brief Bank magic 1.
*/
uint32_t magic1;
/**
* @brief Bank magic 2.
*/
uint32_t magic2;
/**
* @brief Usage counter of the bank.
* @details This value is increased each time a bank swap is performed. It
* indicates how much wearing the flash has already endured.
*/
uint32_t counter;
/**
* @brief First data element.
*/
flash_offset_t next;
/**
* @brief Header CRC.
*/
uint16_t crc;
} mfs_bank_header_t;
/**
* @brief Type of a data block header.
* @details This structure is placed before each written data block.
*/
typedef struct {
/**
* @brief Data header magic.
*/
uint16_t magic;
/**
* @brief Data CRC.
*/
uint16_t crc;
/**
* @brief Data identifier.
*/
uint32_t id;
/**
* @brief Data size for forward scan.
*/
uint32_t size;
/**
* @brief Address of the previous header or zero if none.
*/
flash_offset_t prev_header;
} mfs_data_header_t;
#if (MFS_CFG_ID_CACHE_SIZE > 0) || defined(__DOXYGEN__)
/**
* @brief Type of an element of the record identifiers cache.
*/
typedef struct mfs_cached_id {
/**
* @brief Pointer to the next element in the list.
*/
struct mfs_cached_id *lru_next;
/**
* @brief Pointer to the previous element in the list.
*/
struct mfs_cached_id *lru_prev;
/**
* @brief Identifier of the cached element.
*/
uint32_t id;
/**
* @brief Data address of the cached element.
*/
flash_offset_t offset;
/**
* @brief Data size of the cached element.
*/
uint32_t size;
} mfs_cached_id_t;
/**
* @brief Type of an element of the record identifiers cache.
*/
typedef struct mfs_cache_header {
/**
* @brief Pointer to the first element in the list.
*/
struct mfs_cached_id *lru_next;
/**
* @brief Pointer to the last element in the list.
*/
struct mfs_cached_id *lru_prev;
} mfs_cache_header_t;
#endif /* MFS_CFG_ID_CACHE_SIZE > 0 */
/**
* @brief Type of a MFS configuration structure.
*/
typedef struct {
/**
* @brief Flash driver associated to this MFS instance.
*/
BaseFlash *flashp;
/**
* @brief Base sector index for bank 0.
*/
flash_sector_t bank0_start;
/**
* #brief Number of sectors for bank 0.
*/
flash_sector_t bank0_sectors;
/**
* @brief Base sector index for bank 1.
*/
flash_sector_t bank1_start;
/**
* #brief Number of sectors for bank 1.
*/
flash_sector_t bank1_sectors;
} MFSConfig;
/**
* @extends BaseFlash
*
* @brief Type of an MFS instance.
*/
typedef struct {
/**
* @brief Driver state.
*/
mfs_state_t state;
/**
* @brief Current configuration data.
*/
const MFSConfig *config;
/**
* @brief Bank currently in use.
*/
mfs_bank_t current_bank;
/**
* @brief Size in bytes of banks.
*/
uint32_t banks_size;
/**
* @brief Pointer to the next free position in the current bank.
*/
flash_offset_t next_offset;
/**
* @brief Pointer to the last header in the list or zero.
*/
flash_offset_t last_offset;
/**
* @brief Used space in the current bank without considering erased records.
*/
uint32_t used_space;
#if (MFS_CFG_ID_CACHE_SIZE > 0) || defined(__DOXYGEN__)
/**
* @brief Header of the cache LRU list.
*/
mfs_cache_header_t cache_header;
/**
* @brief Array of the cached identifiers.
*/
mfs_cached_id_t cache_buffer[MFS_CFG_ID_CACHE_SIZE];
#endif /* MFS_CFG_ID_CACHE_SIZE > 0 */
} MFSDriver;
/*===========================================================================*/
/* Driver macros. */
/*===========================================================================*/
/**
* @name Error codes handling macros
* @{
*/
#define MFS_IS_ERROR(err) ((err) < MFS_NO_ERROR)
#define MFS_IS_WARNING(err) ((err) > MFS_NO_ERROR)
/** @} */
/*===========================================================================*/
/* External declarations. */
/*===========================================================================*/
#ifdef __cplusplus
extern "C" {
#endif
void mfsObjectInit(MFSDriver *devp);
void mfsStart(MFSDriver *devp, const MFSConfig *config);
void mfsStop(MFSDriver *devp);
mfs_error_t mfsMount(MFSDriver *devp);
mfs_error_t mfsUnmount(MFSDriver *devp);
mfs_error_t mfsReadRecord(MFSDriver *devp, uint32_t id,
uint32_t *np, uint8_t *buffer);
mfs_error_t mfsUpdateRecord(MFSDriver *devp, uint32_t id,
uint32_t n, const uint8_t *buffer);
mfs_error_t mfsEraseRecord(MFSDriver *devp, uint32_t id);
#ifdef __cplusplus
}
#endif
#endif /* MFS_H */
/** @} */
|
