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
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
|
/*
ChibiOS - Copyright (C) 2006..2018 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 hal_mfs.h
* @brief Managed Flash Storage module header.
*
* @addtogroup HAL_MFS
* @{
*/
#ifndef HAL_MFS_H
#define HAL_MFS_H
#include "hal_flash.h"
/*===========================================================================*/
/* Driver constants. */
/*===========================================================================*/
#define MFS_BANK_MAGIC_1 0xEC705ADEU
#define MFS_BANK_MAGIC_2 0xF0339CC5U
#define MFS_HEADER_MAGIC 0x5FAE45F0U
/*===========================================================================*/
/* Driver pre-compile time settings. */
/*===========================================================================*/
/**
* @name Configuration options
* @{
*/
/**
* @brief Maximum number of indexed records in the managed storage.
* @note Record indexes go from 0 to @p MFS_CFG_MAX_RECORDS - 1.
*/
#if !defined(MFS_CFG_MAX_RECORDS) || defined(__DOXYGEN__)
#define MFS_CFG_MAX_RECORDS 32
#endif
/**
* @brief Maximum number of repair attempts on partition mount.
*/
#if !defined(MFS_CFG_MAX_REPAIR_ATTEMPTS) || defined(__DOXYGEN__)
#define MFS_CFG_MAX_REPAIR_ATTEMPTS 3
#endif
/**
* @brief Verify written data.
*/
#if !defined(MFS_CFG_WRITE_VERIFY) || defined(__DOXYGEN__)
#define MFS_CFG_WRITE_VERIFY TRUE
#endif
/**
* @brief Enables a stronger and slower check procedure on mount.
* @details Strong checking requires reading of the whole written data and
* this can be slow, normal checking only checks integrity of
* metadata, data errors would be detected on read.
*/
#if !defined(MFS_CFG_STRONG_CHECKING) || defined(__DOXYGEN__)
#define MFS_CFG_STRONG_CHECKING TRUE
#endif
/**
* @brief Size of the buffer used for data copying.
* @note The buffer size must be a power of two and not smaller than
* 16 bytes.
* @note Larger buffers improve performance, buffers with size multiple
* of the flash program page size work better.
*/
#if !defined(MFS_CFG_BUFFER_SIZE) || defined(__DOXYGEN__)
#define MFS_CFG_BUFFER_SIZE 32
#endif
/**
* @brief Enforced memory alignment.
* @details This value must be a power of two, it enforces a memory alignment
* for records in the flash array. This is required when alignment
* constraints exist, for example when using a DTR mode on OSPI
* devices.
* @note When enforcing an alignment you need to use buffers with size
* aligned to the specified value. For example, if you need to
* write a 5 bytes object with alignment of 4 then you need to
* use a 8 bytes data buffer, the last 3 bytes are used as filler
* so ==initialize== those to zero (buffer->DDDDD000) or garbage
* will be written after data.
*/
#if !defined(MFS_CFG_MEMORY_ALIGNMENT) || defined(__DOXYGEN__)
#define MFS_CFG_MEMORY_ALIGNMENT 1
#endif
/** @} */
/*===========================================================================*/
/* Derived constants and error checks. */
/*===========================================================================*/
#if MFS_CFG_MAX_RECORDS < 0
#error "invalid MFS_CFG_MAX_RECORDS value"
#endif
#if (MFS_CFG_MAX_REPAIR_ATTEMPTS < 1) || (MFS_CFG_MAX_REPAIR_ATTEMPTS > 10)
#error "invalid MFS_MAX_REPAIR_ATTEMPTS value"
#endif
#if MFS_CFG_BUFFER_SIZE < 16
#error "invalid MFS_CFG_BUFFER_SIZE value"
#endif
#if (MFS_CFG_BUFFER_SIZE & (MFS_CFG_BUFFER_SIZE - 1)) != 0
#error "MFS_CFG_BUFFER_SIZE is not a power of two"
#endif
#if MFS_CFG_MEMORY_ALIGNMENT < 1
#error "invalid MFS_CFG_MEMORY_ALIGNMENT value"
#endif
#if (MFS_CFG_MEMORY_ALIGNMENT & (MFS_CFG_MEMORY_ALIGNMENT - 1)) != 0
#error "MFS_CFG_MEMORY_ALIGNMENT is not a power of two"
#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_ERROR = 3
} 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_WARN_REPAIR = 1,
MFS_WARN_GC = 2,
MFS_ERR_INV_STATE = -1,
MFS_ERR_INV_SIZE = -2,
MFS_ERR_NOT_FOUND = -3,
MFS_ERR_OUT_OF_MEM = -4,
MFS_ERR_NOT_ERASED = -5,
MFS_ERR_FLASH_FAILURE = -6,
MFS_ERR_INTERNAL = -7
} 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 record state assessment.
*/
typedef enum {
MFS_RECORD_ERASED = 0,
MFS_RECORD_OK = 1,
MFS_RECORD_CRC = 2,
MFS_RECORD_GARBAGE = 3
} mfs_record_state_t;
/**
* @brief Type of a record identifier.
*/
typedef uint32_t mfs_id_t;
/**
* @brief Type of a bank header.
* @note The header resides in the first 16 bytes of a bank.
*/
typedef union {
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 Reserved field.
*/
uint16_t reserved1;
/**
* @brief Header CRC.
*/
uint16_t crc;
} fields;
uint8_t hdr8[16];
uint32_t hdr32[4];
} mfs_bank_header_t;
/**
* @brief Type of a data block header.
* @details This structure is placed before each written data block.
*/
typedef union {
struct {
/**
* @brief Data header magic.
*/
uint32_t magic;
/**
* @brief Data identifier.
*/
uint16_t id;
/**
* @brief Data CRC.
*/
uint16_t crc;
/**
* @brief Data size.
* @note The next record is located at @p MFS_ALIGN_NEXT(size).
*/
uint32_t size;
} fields;
uint8_t hdr8[12];
uint32_t hdr32[3];
} mfs_data_header_t;
typedef struct {
/**
* @brief Offset of the record header.
*/
flash_offset_t offset;
/**
* @brief Record data size.
*/
uint32_t size;
} mfs_record_descriptor_t;
/**
* @brief Type of a MFS configuration structure.
*/
typedef struct {
/**
* @brief Flash driver associated to this MFS instance.
*/
BaseFlash *flashp;
/**
* @brief Erased value.
*/
uint32_t erased;
/**
* @brief Banks size.
*/
flash_offset_t bank_size;
/**
* @brief Base sector index for bank 0.
*/
flash_sector_t bank0_start;
/**
* @brief Number of sectors for bank 0.
* @note The total size of bank0 sectors must be greater or equal to
* @p bank_size.
*/
flash_sector_t bank0_sectors;
/**
* @brief Base sector index for bank 1.
*/
flash_sector_t bank1_start;
/**
* @brief Number of sectors for bank 1.
* @note The total size of bank1 sectors must be greater or equal to
* @p bank_size.
*/
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 Usage counter of the current bank.
*/
uint32_t current_counter;
/**
* @brief Pointer to the next free position in the current bank.
*/
flash_offset_t next_offset;
/**
* @brief Used space in the current bank without considering erased records.
*/
flash_offset_t used_space;
/**
* @brief Offsets of the most recent instance of the records.
* @note Zero means that there is not a record with that id.
*/
mfs_record_descriptor_t descriptors[MFS_CFG_MAX_RECORDS];
/**
* @brief Transient buffer.
*/
union {
mfs_data_header_t dhdr;
mfs_bank_header_t bhdr;
uint8_t data8[MFS_CFG_BUFFER_SIZE];
uint16_t data16[MFS_CFG_BUFFER_SIZE / sizeof (uint16_t)];
uint32_t data32[MFS_CFG_BUFFER_SIZE / sizeof (uint32_t)];
} buffer;
} 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)
/** @} */
/**
* @name Alignment macros
* @{
*/
#define MFS_ALIGN_MASK ((uint32_t)MFS_CFG_MEMORY_ALIGNMENT - 1U)
#define MFS_IS_ALIGNED(v) (((uint32_t)(v) & MFS_ALIGN_MASK) == 0U)
#define MFS_ALIGN_PREV(v) ((uint32_t)(v) & ~MFS_ALIGN_MASK)
#define MFS_ALIGN_NEXT(v) MFS_ALIGN_PREV((size_t)(v) + MFS_ALIGN_MASK)
/** @} */
/*===========================================================================*/
/* External declarations. */
/*===========================================================================*/
#ifdef __cplusplus
extern "C" {
#endif
void mfsObjectInit(MFSDriver *devp);
mfs_error_t mfsStart(MFSDriver *devp, const MFSConfig *config);
void mfsStop(MFSDriver *devp);
mfs_error_t mfsErase(MFSDriver *mfsp);
mfs_error_t mfsReadRecord(MFSDriver *devp, mfs_id_t id,
size_t *np, uint8_t *buffer);
mfs_error_t mfsWriteRecord(MFSDriver *devp, mfs_id_t id,
size_t n, const uint8_t *buffer);
mfs_error_t mfsEraseRecord(MFSDriver *devp, mfs_id_t id);
mfs_error_t mfsPerformGarbageCollection(MFSDriver *mfsp);
#ifdef __cplusplus
}
#endif
#endif /* HAL_MFS_H */
/** @} */
|