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
|
/*
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.c
* @brief Managed Flash Storage module code.
*
* @addtogroup mfs
* @{
*/
#include "hal.h"
#include "mfs.h"
/*===========================================================================*/
/* Driver local definitions. */
/*===========================================================================*/
#define MFS_BANK_MAGIC1 0x35A1EC13
#define MFS_BANK_MAGIC2 0x0FE14991
#define MFS_HEADER_MAGIC 0x1AC7002E
/*===========================================================================*/
/* Driver exported variables. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver local variables and types. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver local functions. */
/*===========================================================================*/
/*===========================================================================*/
/* Driver exported functions. */
/*===========================================================================*/
/**
* @brief Initializes an instance.
*
* @param[out] devp pointer to the @p MFSDriver object
*
* @init
*/
void mfsObjectInit(MFSDriver *devp) {
osalDbgCheck(devp != NULL);
devp->state = MFS_STOP;
devp->config = NULL;
}
/**
* @brief Configures and activates a MFS driver.
*
* @param[in] devp pointer to the @p MFSDriver object
* @param[in] config pointer to the configuration
*
* @api
*/
void mfsStart(MFSDriver *devp, const MFSConfig *config) {
osalDbgCheck((devp != NULL) && (config != NULL));
osalDbgAssert(devp->state != MFS_UNINIT, "invalid state");
if (devp->state == MFS_STOP) {
devp->state = MFS_READY;
}
}
/**
* @brief Deactivates a MFS driver.
*
* @param[in] devp pointer to the @p MFSDriver object
*
* @api
*/
void mfsStop(MFSDriver *devp) {
osalDbgCheck(devp != NULL);
osalDbgAssert(devp->state != MFS_UNINIT, "invalid state");
if (devp->state != MFS_STOP) {
devp->state = MFS_STOP;
}
}
/**
* @brief Mounts a managed flash storage.
* @details This functions checks the storage internal state and eventually
* performs the required initialization or repair operations.
*
* @param[in] devp pointer to the @p MFSDriver object
*
* @api
*/
mfs_error_t mfsMount(MFSDriver *devp) {
(void)devp;
return MFS_NOERROR;
}
/**
* @brief Unmounts a manage flash storage.
*/
mfs_error_t mfsUnmount(MFSDriver *devp) {
(void)devp;
return MFS_NOERROR;
}
/**
* @brief Retrieves and reads a data record.
*
* @param[in] devp pointer to the @p MFSDriver object
* @param[in] id record numeric identifier
* @param[in,out] np on input is the maximum buffer size, on return it is
* the size of the data copied into the buffer
* @param[in] buffer pointer to a buffer for record data
*
* @api
*/
mfs_error_t mfsReadRecord(MFSDriver *devp, uint32_t id,
uint32_t *np, uint8_t *buffer) {
(void)devp;
(void)id;
(void)np;
(void)buffer;
return MFS_NOERROR;
}
/**
* @brief Creates or updates a data record.
*
* @param[in] devp pointer to the @p MFSDriver object
* @param[in] id record numeric identifier
* @param[in] n size of data to be written, it cannot be zero
* @param[in] buffer pointer to a buffer for record data
*
* @api
*/
mfs_error_t mfsUpdateRecord(MFSDriver *devp, uint32_t id,
uint32_t n, const uint8_t *buffer) {
(void)devp;
(void)id;
(void)n;
(void)buffer;
return MFS_NOERROR;
}
/**
* @brief Erases a data record.
*
* @param[in] devp pointer to the @p MFSDriver object
* @param[in] id record numeric identifier
*
* @api
*/
mfs_error_t mfsEraseRecord(MFSDriver *devp, uint32_t id) {
(void)devp;
(void)id;
return MFS_NOERROR;
}
/** @} */
|
