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
use crate::{iter::IterableByOverlaps, ReadStorage, Region, Storage};
pub trait NorFlashError: core::fmt::Debug {
fn kind(&self) -> NorFlashErrorKind;
}
impl NorFlashError for core::convert::Infallible {
fn kind(&self) -> NorFlashErrorKind {
match *self {}
}
}
pub trait ErrorType {
type Error: NorFlashError;
}
#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
#[non_exhaustive]
pub enum NorFlashErrorKind {
NotAligned,
OutOfBounds,
Other,
}
impl NorFlashError for NorFlashErrorKind {
fn kind(&self) -> NorFlashErrorKind {
*self
}
}
impl core::fmt::Display for NorFlashErrorKind {
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
match self {
Self::NotAligned => write!(f, "Arguments are not properly aligned"),
Self::OutOfBounds => write!(f, "Arguments are out of bounds"),
Self::Other => write!(f, "An implementation specific error occurred"),
}
}
}
pub trait ReadNorFlash: ErrorType {
const READ_SIZE: usize;
fn read(&mut self, offset: u32, bytes: &mut [u8]) -> Result<(), Self::Error>;
fn capacity(&self) -> usize;
}
pub fn check_read<T: ReadNorFlash>(
flash: &T,
offset: u32,
length: usize,
) -> Result<(), NorFlashErrorKind> {
check_slice(flash, T::READ_SIZE, offset, length)
}
pub trait NorFlash: ReadNorFlash {
const WRITE_SIZE: usize;
const ERASE_SIZE: usize;
fn erase(&mut self, from: u32, to: u32) -> Result<(), Self::Error>;
fn write(&mut self, offset: u32, bytes: &[u8]) -> Result<(), Self::Error>;
}
pub fn check_erase<T: NorFlash>(flash: &T, from: u32, to: u32) -> Result<(), NorFlashErrorKind> {
let (from, to) = (from as usize, to as usize);
if from > to || to > flash.capacity() {
return Err(NorFlashErrorKind::OutOfBounds);
}
if from % T::ERASE_SIZE != 0 || to % T::ERASE_SIZE != 0 {
return Err(NorFlashErrorKind::NotAligned);
}
Ok(())
}
pub fn check_write<T: NorFlash>(
flash: &T,
offset: u32,
length: usize,
) -> Result<(), NorFlashErrorKind> {
check_slice(flash, T::WRITE_SIZE, offset, length)
}
fn check_slice<T: ReadNorFlash>(
flash: &T,
align: usize,
offset: u32,
length: usize,
) -> Result<(), NorFlashErrorKind> {
let offset = offset as usize;
if length > flash.capacity() || offset > flash.capacity() - length {
return Err(NorFlashErrorKind::OutOfBounds);
}
if offset % align != 0 || length % align != 0 {
return Err(NorFlashErrorKind::NotAligned);
}
Ok(())
}
pub trait MultiwriteNorFlash: NorFlash {}
struct Page {
pub start: u32,
pub size: usize,
}
impl Page {
fn new(index: u32, size: usize) -> Self {
Self {
start: index * size as u32,
size,
}
}
const fn end(&self) -> u32 {
self.start + self.size as u32
}
}
impl Region for Page {
fn contains(&self, address: u32) -> bool {
(self.start <= address) && (self.end() > address)
}
}
pub struct RmwNorFlashStorage<'a, S> {
storage: S,
merge_buffer: &'a mut [u8],
}
impl<'a, S> RmwNorFlashStorage<'a, S>
where
S: NorFlash,
{
pub fn new(nor_flash: S, merge_buffer: &'a mut [u8]) -> Self {
if merge_buffer.len() < S::ERASE_SIZE {
panic!("Merge buffer is too small");
}
Self {
storage: nor_flash,
merge_buffer,
}
}
}
impl<'a, S> ReadStorage for RmwNorFlashStorage<'a, S>
where
S: ReadNorFlash,
{
type Error = S::Error;
fn read(&mut self, offset: u32, bytes: &mut [u8]) -> Result<(), Self::Error> {
self.storage.read(offset, bytes)
}
fn capacity(&self) -> usize {
self.storage.capacity()
}
}
impl<'a, S> Storage for RmwNorFlashStorage<'a, S>
where
S: NorFlash,
{
fn write(&mut self, offset: u32, bytes: &[u8]) -> Result<(), Self::Error> {
let last_page = self.storage.capacity() / S::ERASE_SIZE;
for (data, page, addr) in (0..last_page as u32)
.map(move |i| Page::new(i, S::ERASE_SIZE))
.overlaps(bytes, offset)
{
let offset_into_page = addr.saturating_sub(page.start) as usize;
self.storage
.read(page.start, &mut self.merge_buffer[..S::ERASE_SIZE])?;
self.storage.erase(page.start, page.end())?;
self.merge_buffer[..S::ERASE_SIZE]
.iter_mut()
.skip(offset_into_page)
.zip(data)
.for_each(|(byte, input)| *byte = *input);
self.storage
.write(page.start, &self.merge_buffer[..S::ERASE_SIZE])?;
}
Ok(())
}
}
pub struct RmwMultiwriteNorFlashStorage<'a, S> {
storage: S,
merge_buffer: &'a mut [u8],
}
impl<'a, S> RmwMultiwriteNorFlashStorage<'a, S>
where
S: MultiwriteNorFlash,
{
pub fn new(nor_flash: S, merge_buffer: &'a mut [u8]) -> Self {
if merge_buffer.len() < S::ERASE_SIZE {
panic!("Merge buffer is too small");
}
Self {
storage: nor_flash,
merge_buffer,
}
}
}
impl<'a, S> ReadStorage for RmwMultiwriteNorFlashStorage<'a, S>
where
S: ReadNorFlash,
{
type Error = S::Error;
fn read(&mut self, offset: u32, bytes: &mut [u8]) -> Result<(), Self::Error> {
self.storage.read(offset, bytes)
}
fn capacity(&self) -> usize {
self.storage.capacity()
}
}
impl<'a, S> Storage for RmwMultiwriteNorFlashStorage<'a, S>
where
S: MultiwriteNorFlash,
{
fn write(&mut self, offset: u32, bytes: &[u8]) -> Result<(), Self::Error> {
let last_page = self.storage.capacity() / S::ERASE_SIZE;
for (data, page, addr) in (0..last_page as u32)
.map(move |i| Page::new(i, S::ERASE_SIZE))
.overlaps(bytes, offset)
{
let offset_into_page = addr.saturating_sub(page.start) as usize;
self.storage
.read(page.start, &mut self.merge_buffer[..S::ERASE_SIZE])?;
let rhs = &self.merge_buffer[offset_into_page..S::ERASE_SIZE];
let is_subset = data.iter().zip(rhs.iter()).all(|(a, b)| *a & *b == *a);
if is_subset {
let offset = addr as usize % S::WRITE_SIZE;
let aligned_end = data.len() % S::WRITE_SIZE + offset + data.len();
self.merge_buffer[..aligned_end].fill(0xff);
self.merge_buffer[offset..offset + data.len()].copy_from_slice(data);
self.storage
.write(addr - offset as u32, &self.merge_buffer[..aligned_end])?;
} else {
self.storage.erase(page.start, page.end())?;
self.merge_buffer[..S::ERASE_SIZE]
.iter_mut()
.skip(offset_into_page)
.zip(data)
.for_each(|(byte, input)| *byte = *input);
self.storage
.write(page.start, &self.merge_buffer[..S::ERASE_SIZE])?;
}
}
Ok(())
}
}