diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 5b5ee297..0dde4d46 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -36,7 +36,7 @@ jobs: cargo build --workspace --target thumbv7m-none-eabi - --features async,defmt-03,embedded-io/defmt,embedded-io-async/defmt + --features async,defmt-03,embedded-io/defmt,embedded-io-async/defmt,embedded-storage/defmt msrv-1-81: runs-on: ubuntu-latest diff --git a/Cargo.toml b/Cargo.toml index eb283217..b6fdf218 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -8,6 +8,8 @@ members = [ "embedded-hal-bus", "embedded-can", "embedded-io", + "embedded-storage", + "embedded-storage-async", "embedded-io-async", "embedded-io-adapters", ] diff --git a/embedded-storage-async/.gitignore b/embedded-storage-async/.gitignore new file mode 100644 index 00000000..96ef6c0b --- /dev/null +++ b/embedded-storage-async/.gitignore @@ -0,0 +1,2 @@ +/target +Cargo.lock diff --git a/embedded-storage-async/CHANGELOG.md b/embedded-storage-async/CHANGELOG.md new file mode 100644 index 00000000..c5f210fe --- /dev/null +++ b/embedded-storage-async/CHANGELOG.md @@ -0,0 +1,32 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) +and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). + +## Unreleased + +- Add RMW helpers for Nor flashes, implementing `Storage` trait. +- Let `&mut` `MultiwriteNorFlash` implement `MultiwriteNorFlash`. + +## [0.4.1] - 2023-11-28 + +- Let `&mut` `NorFlash` implement `NorFlash`. +- Reexport NOR flash errors from `embedded-storage`. +- Use now stabilized `async_fn_in_trait` and `impl_trait_projections`. + +## [0.4.0] - 2022-12-01 + +### Changes +- Switch all traits to use [`async_fn_in_trait`](https://blog.rust-lang.org/inside-rust/2022/11/17/async-fn-in-trait-nightly.html) (AFIT). Requires `nightly-2022-11-22` or newer. +- Remove `Async` prefix in trait names. + +## [0.3.0] - 2022-02-07 + +Initial release to crates.io. + +[Unreleased]: https://github.com/rust-embedded-community/embedded-storage/compare/embedded-storage-async-v0.4.1...HEAD +[0.4.1]: https://github.com/rust-embedded-community/embedded-storage/compare/embedded-storage-async-v0.4.0...embedded-storage-async-v0.4.1 +[0.4.0]: https://github.com/rust-embedded-community/embedded-storage/compare/embedded-storage-async-v0.3.0...embedded-storage-async-v0.4.0 +[0.3.0]: https://github.com/rust-embedded-community/embedded-storage/releases/tag/embedded-storage-async-v0.3.0 diff --git a/embedded-storage-async/Cargo.toml b/embedded-storage-async/Cargo.toml new file mode 100644 index 00000000..8e398c65 --- /dev/null +++ b/embedded-storage-async/Cargo.toml @@ -0,0 +1,16 @@ +[package] +name = "embedded-storage-async" +version = "0.4.1" +edition = "2021" +rust-version = "1.75" +description = "A Storage Abstraction Layer for Embedded Systems" +license = "MIT OR Apache-2.0" +repository = "https://github.com/rust-embedded/embedded-hal" +homepage = "https://github.com/rust-embedded/embedded-hal" +documentation = "https://docs.rs/embedded-storage-async" +readme = "README.md" +keywords = ["storage"] +categories = ["embedded", "hardware-support", "no-std"] + +[dependencies] +embedded-storage = { version = "0.3.1", path = "../embedded-storage" } diff --git a/embedded-storage-async/LICENSE-APACHE b/embedded-storage-async/LICENSE-APACHE new file mode 100644 index 00000000..16fe87b0 --- /dev/null +++ b/embedded-storage-async/LICENSE-APACHE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + +Copyright [yyyy] [name of copyright owner] + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/embedded-storage-async/LICENSE-MIT b/embedded-storage-async/LICENSE-MIT new file mode 100644 index 00000000..2d622264 --- /dev/null +++ b/embedded-storage-async/LICENSE-MIT @@ -0,0 +1,28 @@ +Copyright (c) 2022 Diego Barrios Romero +Copyright (c) 2022 Dario Nieuwenhuis +Copyright (c) 2022 Ulf Lilleengen +Copyright (c) 2022 Mathias Koch + +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. diff --git a/embedded-storage-async/README.md b/embedded-storage-async/README.md new file mode 100644 index 00000000..26e050a7 --- /dev/null +++ b/embedded-storage-async/README.md @@ -0,0 +1,27 @@ +# embedded-storage-async + +> An Embedded Storage Abstraction Layer + +This create defines a set of async traits variants of embedded-storage. + +## Minimum Supported Rust Version (MSRV) + +This crate is guaranteed to compile on stable Rust 1.75.0 and up. + +## License + +Licensed under either of + +- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or + http://www.apache.org/licenses/LICENSE-2.0) +- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) + +at your option. + +### Contribution + +Unless you explicitly state otherwise, any contribution intentionally submitted +for inclusion in the work by you, as defined in the Apache-2.0 license, shall be +dual licensed as above, without any additional terms or conditions. + +[API reference]: https://docs.rs/embedded-storage-async diff --git a/embedded-storage-async/src/lib.rs b/embedded-storage-async/src/lib.rs new file mode 100644 index 00000000..48833925 --- /dev/null +++ b/embedded-storage-async/src/lib.rs @@ -0,0 +1,36 @@ +//! # embedded-storage-async - An async Storage Abstraction Layer for Embedded Systems +//! +//! Storage traits to allow on and off board storage devices to read and write +//! data asynchronously. + +#![no_std] +#![allow(async_fn_in_trait)] + +pub mod nor_flash; + +/// Transparent read only storage trait +pub trait ReadStorage { + /// An enumeration of storage errors + type Error; + + /// Read a slice of data from the storage peripheral, starting the read + /// operation at the given address offset, and reading `bytes.len()` bytes. + /// + /// This should throw an error in case `bytes.len()` will be larger than + /// `self.capacity() - offset`. + async fn read(&mut self, offset: u32, bytes: &mut [u8]) -> Result<(), Self::Error>; + + /// The capacity of the storage peripheral in bytes. + fn capacity(&self) -> usize; +} + +/// Transparent read/write storage trait +pub trait Storage: ReadStorage { + /// Write a slice of data to the storage peripheral, starting the write + /// operation at the given address offset (between 0 and `self.capacity()`). + /// + /// **NOTE:** + /// This function will automatically erase any pages necessary to write the given data, + /// and might as such do RMW operations at an undesirable performance impact. + async fn write(&mut self, offset: u32, bytes: &[u8]) -> Result<(), Self::Error>; +} diff --git a/embedded-storage-async/src/nor_flash.rs b/embedded-storage-async/src/nor_flash.rs new file mode 100644 index 00000000..6ec5985a --- /dev/null +++ b/embedded-storage-async/src/nor_flash.rs @@ -0,0 +1,286 @@ +use embedded_storage::iter::IterableByOverlaps; +pub use embedded_storage::nor_flash::{ErrorType, NorFlashError, NorFlashErrorKind}; +use embedded_storage::Region; + +use crate::{ReadStorage, Storage}; + +/// Read only NOR flash trait. +pub trait ReadNorFlash: ErrorType { + /// The minumum number of bytes the storage peripheral can read + const READ_SIZE: usize; + + /// Read a slice of data from the storage peripheral, starting the read + /// operation at the given address offset, and reading `bytes.len()` bytes. + /// + /// # Errors + /// + /// Returns an error if the arguments are not aligned or out of bounds. The implementation + /// can use the [`check_read`] helper function. + async fn read(&mut self, offset: u32, bytes: &mut [u8]) -> Result<(), Self::Error>; + + /// The capacity of the peripheral in bytes. + fn capacity(&self) -> usize; +} + +/// NOR flash trait. +pub trait NorFlash: ReadNorFlash { + /// The minumum number of bytes the storage peripheral can write + const WRITE_SIZE: usize; + + /// The minumum number of bytes the storage peripheral can erase + const ERASE_SIZE: usize; + + /// Erase the given storage range, clearing all data within `[from..to]`. + /// The given range will contain all 1s afterwards. + /// + /// If power is lost during erase, contents of the page are undefined. + /// + /// # Errors + /// + /// Returns an error if the arguments are not aligned or out of bounds (the case where `to > + /// from` is considered out of bounds). The implementation can use the [`check_erase`] + /// helper function. + async fn erase(&mut self, from: u32, to: u32) -> Result<(), Self::Error>; + + /// If power is lost during write, the contents of the written words are undefined, + /// but the rest of the page is guaranteed to be unchanged. + /// It is not allowed to write to the same word twice. + /// + /// # Errors + /// + /// Returns an error if the arguments are not aligned or out of bounds. The implementation + /// can use the [`check_write`] helper function. + async fn write(&mut self, offset: u32, bytes: &[u8]) -> Result<(), Self::Error>; +} + +impl ReadNorFlash for &mut T { + const READ_SIZE: usize = T::READ_SIZE; + + async fn read(&mut self, offset: u32, bytes: &mut [u8]) -> Result<(), Self::Error> { + T::read(self, offset, bytes).await + } + + fn capacity(&self) -> usize { + T::capacity(self) + } +} + +impl NorFlash for &mut T { + const WRITE_SIZE: usize = T::WRITE_SIZE; + const ERASE_SIZE: usize = T::ERASE_SIZE; + + async fn erase(&mut self, from: u32, to: u32) -> Result<(), Self::Error> { + T::erase(self, from, to).await + } + + async fn write(&mut self, offset: u32, bytes: &[u8]) -> Result<(), Self::Error> { + T::write(self, offset, bytes).await + } +} + +/// Marker trait for NorFlash relaxing the restrictions on `write`. +/// +/// Writes to the same word twice are now allowed. The result is the logical AND of the +/// previous data and the written data. That is, it is only possible to change 1 bits to 0 bits. +/// +/// If power is lost during write: +/// - Bits that were 1 on flash and are written to 1 are guaranteed to stay as 1 +/// - Bits that were 1 on flash and are written to 0 are undefined +/// - Bits that were 0 on flash are guaranteed to stay as 0 +/// - Rest of the bits in the page are guaranteed to be unchanged +pub trait MultiwriteNorFlash: NorFlash {} +impl MultiwriteNorFlash for &mut T {} + +struct Page { + pub start: u32, + pub size: usize, +} + +impl Page { + fn new(index: u32, size: usize) -> Self { + Self { + start: index * size as u32, + size, + } + } +} + +impl Region for Page { + fn start(&self) -> u32 { + self.start + } + + fn end(&self) -> u32 { + self.start + self.size as u32 + } +} + +/// Read-Modify-Write (RMW) Nor Flash storage structure. +#[derive(Debug)] +pub struct RmwNorFlashStorage<'a, S> { + storage: S, + merge_buffer: &'a mut [u8], +} + +impl<'a, S> RmwNorFlashStorage<'a, S> +where + S: NorFlash, +{ + /// Instantiate a new generic `Storage` from a `NorFlash` peripheral + /// + /// **NOTE** This will panic if the provided merge buffer, + /// is smaller than the erase size of the flash peripheral + 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; + + async fn read(&mut self, offset: u32, bytes: &mut [u8]) -> Result<(), Self::Error> { + // Nothing special to be done for reads + self.storage.read(offset, bytes).await + } + + fn capacity(&self) -> usize { + self.storage.capacity() + } +} + +impl<'a, S> Storage for RmwNorFlashStorage<'a, S> +where + S: NorFlash, +{ + async fn write(&mut self, offset: u32, bytes: &[u8]) -> Result<(), Self::Error> { + // Perform read/modify/write operations on the byte slice. + let last_page = self.storage.capacity() / S::ERASE_SIZE; + + // `data` is the part of `bytes` contained within `page`, + // and `addr` in the address offset of `page` + any offset into the page as requested by `address` + 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]) + .await?; + + // If we cannot write multiple times to the same page, we will have to erase it + self.storage.erase(page.start, page.end()).await?; + 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]) + .await?; + } + Ok(()) + } +} + +/// Read-Modify-Write (RMW) Multi-Write Nor Flash storage structure. +pub struct RmwMultiwriteNorFlashStorage<'a, S> { + storage: S, + merge_buffer: &'a mut [u8], +} + +impl<'a, S> RmwMultiwriteNorFlashStorage<'a, S> +where + S: MultiwriteNorFlash, +{ + /// Instantiate a new generic `Storage` from a `NorFlash` peripheral + /// + /// **NOTE** This will panic if the provided merge buffer, + /// is smaller than the erase size of the flash peripheral + 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; + + async fn read(&mut self, offset: u32, bytes: &mut [u8]) -> Result<(), Self::Error> { + // Nothing special to be done for reads + self.storage.read(offset, bytes).await + } + + fn capacity(&self) -> usize { + self.storage.capacity() + } +} + +impl<'a, S> Storage for RmwMultiwriteNorFlashStorage<'a, S> +where + S: MultiwriteNorFlash, +{ + async fn write(&mut self, offset: u32, bytes: &[u8]) -> Result<(), Self::Error> { + // Perform read/modify/write operations on the byte slice. + let last_page = self.storage.capacity() / S::ERASE_SIZE; + + // `data` is the part of `bytes` contained within `page`, + // and `addr` in the address offset of `page` + any offset into the page as requested by `address` + 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]) + .await?; + + 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); + + // Check if we can write the data block directly, under the limitations imposed by NorFlash: + // - We can only change 1's to 0's + if is_subset { + // Use `merge_buffer` as allocation for padding `data` to `WRITE_SIZE` + 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]) + .await?; + } else { + self.storage.erase(page.start, page.end()).await?; + 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]) + .await?; + } + } + Ok(()) + } +} diff --git a/embedded-storage/.gitignore b/embedded-storage/.gitignore new file mode 100644 index 00000000..69369904 --- /dev/null +++ b/embedded-storage/.gitignore @@ -0,0 +1,3 @@ +/target +**/*.rs.bk +Cargo.lock diff --git a/embedded-storage/CHANGELOG.md b/embedded-storage/CHANGELOG.md new file mode 100644 index 00000000..ad3d796a --- /dev/null +++ b/embedded-storage/CHANGELOG.md @@ -0,0 +1,38 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) +and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). + +## Unreleased + +- Add `start()` and `end()` method to the `Region` trait. +- Much faster `OverlapIterator`. +- Let `&mut` `MultiwriteNorFlash` implement `MultiwriteNorFlash`. + +## [0.3.1] - 2023-12-04 + +- Let `&mut` `NorFlash` implement `NorFlash`. + +## [0.3.0] - 2022-02-07 + +- Require Nor flashes error types to be convertible to generic errors. +- Provide helper functions for Nor flashes to check for generic errors. +- Add embedded-storage-async crate with async version of nor flash (requires nightly). +- Add `ErrorType` trait to avoid needing to specify error type multiple times. + +## [0.2.0] - 2021-09-15 + +- Removed `try_` prefix from all trait methods. +- Add RMW helpers for Nor flashes, implementing `Storage` trait. + +## [0.1.0] - 2021-05-18 + +Initial release to crates.io. + +[Unreleased]: https://github.com/rust-embedded-community/embedded-storage/compare/v0.3.1...HEAD +[0.3.1]: https://github.com/rust-embedded-community/embedded-storage/releases/tag/v0.3.1 +[0.3.0]: https://github.com/rust-embedded-community/embedded-storage/releases/tag/v0.3.0 +[0.2.0]: https://github.com/rust-embedded-community/embedded-storage/releases/tag/v0.2.0 +[0.1.0]: https://github.com/rust-embedded-community/embedded-storage/releases/tag/v0.1.0 diff --git a/embedded-storage/Cargo.toml b/embedded-storage/Cargo.toml new file mode 100644 index 00000000..ab043cd7 --- /dev/null +++ b/embedded-storage/Cargo.toml @@ -0,0 +1,12 @@ +[package] +name = "embedded-storage" +version = "0.3.1" +edition = "2018" +description = "A Storage Abstraction Layer for Embedded Systems" +license = "MIT OR Apache-2.0" +repository = "https://github.com/rust-embedded/embedded-hal" +homepage = "https://github.com/rust-embedded/embedded-hal" +documentation = "https://docs.rs/embedded-storage" +readme = "README.md" +keywords = ["storage"] +categories = ["embedded", "hardware-support", "no-std"] diff --git a/embedded-storage/LICENSE-APACHE b/embedded-storage/LICENSE-APACHE new file mode 100644 index 00000000..16fe87b0 --- /dev/null +++ b/embedded-storage/LICENSE-APACHE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + +Copyright [yyyy] [name of copyright owner] + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/embedded-storage/LICENSE-MIT b/embedded-storage/LICENSE-MIT new file mode 100644 index 00000000..5a9afed6 --- /dev/null +++ b/embedded-storage/LICENSE-MIT @@ -0,0 +1,27 @@ +Copyright (c) 2020 Jonathan 'theJPster' Pallant +Copyright (c) 2020 Mathias Koch +Copyright (c) 2020 Diego Barrios Romero + +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. diff --git a/embedded-storage/README.md b/embedded-storage/README.md new file mode 100644 index 00000000..993f50e7 --- /dev/null +++ b/embedded-storage/README.md @@ -0,0 +1,57 @@ +# embedded-storage + +> An Embedded Storage Abstraction Layer + +This crate defines a set of traits that can be implemented to provide +non-volatile storage of different kinds, including but not limited to EEPROM, +NOR-flash & NAND-flash, both external and internal. + +## [API reference] + +## How-to: add a new trait + +This is the suggested approach to adding a new trait to `embedded-storage` + +### Research / Discussion + +Ideally, before proposing a new trait, or set of traits, you should check for an existing issue +suggesting the need for the trait, as well as any related works / use cases / requirements that +are useful to consider in the design of the trait. + +These issues will be labeled as `discussion` in the issue tracker. + +### Implementation / Demonstration + +Proposed traits should then be implemented and demonstrated, either by forking `embedded-storage` or by creating a new crate with the intent of integrating this into `embedded-storage` once the traits have stabilized. You may find [cargo workspaces](https://doc.rust-lang.org/book/ch14-03-cargo-workspaces.html) and [patch](https://doc.rust-lang.org/edition-guide/rust-2018/cargo-and-crates-io/replacing-dependencies-with-patch.html) useful for the forking approach. + +### Proposing a trait + +Once the trait has been demonstrated a PR should be opened to merge the new trait(s) into `embedded-storage`. This should include a link to the previous discussion issue. + +If there is determined to be more than one alternative then there should be further discussion to +try to single out the best option. Once there is consensus this will be merged into the `embedded-storage` repository. + +These issues / PRs will be labeled as `proposal`s in the issue tracker. + +## Minimum Supported Rust Version (MSRV) + +This crate is guaranteed to compile on stable Rust 1.50.0 and up. It *might* +compile with older versions but that may change in any new patch release. + +## License + +Licensed under either of + +- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or + http://www.apache.org/licenses/LICENSE-2.0) +- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) + +at your option. + +### Contribution + +Unless you explicitly state otherwise, any contribution intentionally submitted +for inclusion in the work by you, as defined in the Apache-2.0 license, shall be +dual licensed as above, without any additional terms or conditions. + +[API reference]: https://docs.rs/embedded-storage diff --git a/embedded-storage/rustfmt.toml b/embedded-storage/rustfmt.toml new file mode 100644 index 00000000..6eed6d0f --- /dev/null +++ b/embedded-storage/rustfmt.toml @@ -0,0 +1,2 @@ +hard_tabs = true + diff --git a/embedded-storage/src/iter.rs b/embedded-storage/src/iter.rs new file mode 100644 index 00000000..c97be93a --- /dev/null +++ b/embedded-storage/src/iter.rs @@ -0,0 +1,61 @@ +use crate::Region; + +/// Iterator producing block-region pairs, where each memory block maps to each +/// region. +pub struct OverlapIterator<'a, R, I> +where + R: Region, + I: Iterator, +{ + memory: &'a [u8], + regions: I, + base_address: u32, +} + +/// Trait allowing us to automatically add an `overlaps` function to all iterators over [`Region`] +pub trait IterableByOverlaps<'a, R, I> +where + R: Region, + I: Iterator, +{ + /// Obtain an [`OverlapIterator`] over a subslice of `memory` that overlaps with the region in `self` + fn overlaps(self, memory: &'a [u8], base_address: u32) -> OverlapIterator<'a, R, I>; +} + +impl<'a, R, I> Iterator for OverlapIterator<'a, R, I> +where + R: Region, + I: Iterator, +{ + type Item = (&'a [u8], R, u32); + + fn next(&mut self) -> Option { + let mem_start = self.base_address; + let mem_end = self.base_address + self.memory.len() as u32; + for region in self.regions.by_ref() { + if mem_start < region.end() && mem_end >= region.start() { + let addr_start = core::cmp::max(mem_start, region.start()); + let addr_end = core::cmp::min(mem_end, region.end()); + let start = (addr_start - self.base_address) as usize; + let end = (addr_end - self.base_address) as usize; + return Some((&self.memory[start..end], region, addr_start)); + } + } + None + } +} + +/// Blanket implementation for all types implementing [`Iterator`] over [`Regions`] +impl<'a, R, I> IterableByOverlaps<'a, R, I> for I +where + R: Region, + I: Iterator, +{ + fn overlaps(self, memory: &'a [u8], base_address: u32) -> OverlapIterator<'a, R, I> { + OverlapIterator { + memory, + regions: self, + base_address, + } + } +} diff --git a/embedded-storage/src/lib.rs b/embedded-storage/src/lib.rs new file mode 100644 index 00000000..30707231 --- /dev/null +++ b/embedded-storage/src/lib.rs @@ -0,0 +1,55 @@ +//! # embedded-storage - A Storage Abstraction Layer for Embedded Systems +//! +//! Storage traits to allow on and off board storage devices to read and write +//! data. + +#![doc(html_root_url = "https://docs.rs/embedded-storage/0.1.0")] +#![no_std] +#![deny(missing_docs)] +#![deny(unsafe_code)] + +/// Currently contains [`OverlapIterator`] +pub mod iter; +/// Technology specific traits for NOR Flashes +pub mod nor_flash; + +/// A region denotes a contiguous piece of memory between two addresses. +pub trait Region { + /// Start address of the region of `Self` + fn start(&self) -> u32; + + /// End address of the region of `Self` + fn end(&self) -> u32; + + /// Check if `address` is contained in the region of `Self` + fn contains(&self, address: u32) -> bool { + (address >= self.start()) && (address < self.end()) + } +} + +/// Transparent read only storage trait +pub trait ReadStorage { + /// An enumeration of storage errors + type Error; + + /// Read a slice of data from the storage peripheral, starting the read + /// operation at the given address offset, and reading `bytes.len()` bytes. + /// + /// This should throw an error in case `bytes.len()` will be larger than + /// `self.capacity() - offset`. + fn read(&mut self, offset: u32, bytes: &mut [u8]) -> Result<(), Self::Error>; + + /// The capacity of the storage peripheral in bytes. + fn capacity(&self) -> usize; +} + +/// Transparent read/write storage trait +pub trait Storage: ReadStorage { + /// Write a slice of data to the storage peripheral, starting the write + /// operation at the given address offset (between 0 and `self.capacity()`). + /// + /// **NOTE:** + /// This function will automatically erase any pages necessary to write the given data, + /// and might as such do RMW operations at an undesirable performance impact. + fn write(&mut self, offset: u32, bytes: &[u8]) -> Result<(), Self::Error>; +} diff --git a/embedded-storage/src/nor_flash.rs b/embedded-storage/src/nor_flash.rs new file mode 100644 index 00000000..1a319743 --- /dev/null +++ b/embedded-storage/src/nor_flash.rs @@ -0,0 +1,380 @@ +use crate::{iter::IterableByOverlaps, ReadStorage, Region, Storage}; + +/// NOR flash errors. +/// +/// NOR flash implementations must use an error type implementing this trait. This permits generic +/// code to extract a generic error kind. +pub trait NorFlashError: core::fmt::Debug { + /// Convert a specific NOR flash error into a generic error kind. + fn kind(&self) -> NorFlashErrorKind; +} + +impl NorFlashError for core::convert::Infallible { + fn kind(&self) -> NorFlashErrorKind { + match *self {} + } +} + +/// A trait that NorFlash implementations can use to share an error type. +pub trait ErrorType { + /// Errors returned by this NOR flash. + type Error: NorFlashError; +} + +/// NOR flash error kinds. +/// +/// NOR flash implementations must map their error to those generic error kinds through the +/// [`NorFlashError`] trait. +#[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)] +#[non_exhaustive] +pub enum NorFlashErrorKind { + /// The arguments are not properly aligned. + NotAligned, + + /// The arguments are out of bounds. + OutOfBounds, + + /// Error specific to the implementation. + 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"), + } + } +} + +/// Read only NOR flash trait. +pub trait ReadNorFlash: ErrorType { + /// The minumum number of bytes the storage peripheral can read + const READ_SIZE: usize; + + /// Read a slice of data from the storage peripheral, starting the read + /// operation at the given address offset, and reading `bytes.len()` bytes. + /// + /// # Errors + /// + /// Returns an error if the arguments are not aligned or out of bounds. The implementation + /// can use the [`check_read`] helper function. + fn read(&mut self, offset: u32, bytes: &mut [u8]) -> Result<(), Self::Error>; + + /// The capacity of the peripheral in bytes. + fn capacity(&self) -> usize; +} + +/// Return whether a read operation is within bounds. +pub fn check_read( + flash: &T, + offset: u32, + length: usize, +) -> Result<(), NorFlashErrorKind> { + check_slice(flash, T::READ_SIZE, offset, length) +} + +/// NOR flash trait. +pub trait NorFlash: ReadNorFlash { + /// The minumum number of bytes the storage peripheral can write + const WRITE_SIZE: usize; + + /// The minumum number of bytes the storage peripheral can erase + const ERASE_SIZE: usize; + + /// Erase the given storage range, clearing all data within `[from..to]`. + /// The given range will contain all 1s afterwards. + /// + /// If power is lost during erase, contents of the page are undefined. + /// + /// # Errors + /// + /// Returns an error if the arguments are not aligned or out of bounds (the case where `to > + /// from` is considered out of bounds). The implementation can use the [`check_erase`] + /// helper function. + fn erase(&mut self, from: u32, to: u32) -> Result<(), Self::Error>; + + /// If power is lost during write, the contents of the written words are undefined, + /// but the rest of the page is guaranteed to be unchanged. + /// It is not allowed to write to the same word twice. + /// + /// # Errors + /// + /// Returns an error if the arguments are not aligned or out of bounds. The implementation + /// can use the [`check_write`] helper function. + fn write(&mut self, offset: u32, bytes: &[u8]) -> Result<(), Self::Error>; +} + +/// Return whether an erase operation is aligned and within bounds. +pub fn check_erase(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(()) +} + +/// Return whether a write operation is aligned and within bounds. +pub fn check_write( + flash: &T, + offset: u32, + length: usize, +) -> Result<(), NorFlashErrorKind> { + check_slice(flash, T::WRITE_SIZE, offset, length) +} + +fn check_slice( + 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.is_multiple_of(align) || !length.is_multiple_of(align) { + return Err(NorFlashErrorKind::NotAligned); + } + Ok(()) +} + +impl ErrorType for &mut T { + type Error = T::Error; +} + +impl ReadNorFlash for &mut T { + const READ_SIZE: usize = T::READ_SIZE; + + fn read(&mut self, offset: u32, bytes: &mut [u8]) -> Result<(), Self::Error> { + T::read(self, offset, bytes) + } + + fn capacity(&self) -> usize { + T::capacity(self) + } +} + +impl NorFlash for &mut T { + const WRITE_SIZE: usize = T::WRITE_SIZE; + const ERASE_SIZE: usize = T::ERASE_SIZE; + + fn erase(&mut self, from: u32, to: u32) -> Result<(), Self::Error> { + T::erase(self, from, to) + } + + fn write(&mut self, offset: u32, bytes: &[u8]) -> Result<(), Self::Error> { + T::write(self, offset, bytes) + } +} + +/// Marker trait for NorFlash relaxing the restrictions on `write`. +/// +/// Writes to the same word twice are now allowed. The result is the logical AND of the +/// previous data and the written data. That is, it is only possible to change 1 bits to 0 bits. +/// +/// If power is lost during write: +/// - Bits that were 1 on flash and are written to 1 are guaranteed to stay as 1 +/// - Bits that were 1 on flash and are written to 0 are undefined +/// - Bits that were 0 on flash are guaranteed to stay as 0 +/// - Rest of the bits in the page are guaranteed to be unchanged +pub trait MultiwriteNorFlash: NorFlash {} +impl MultiwriteNorFlash for &mut T {} + +struct Page { + pub start: u32, + pub size: usize, +} + +impl Page { + fn new(index: u32, size: usize) -> Self { + Self { + start: index * size as u32, + size, + } + } +} + +impl Region for Page { + fn start(&self) -> u32 { + self.start + } + + fn end(&self) -> u32 { + self.start + self.size as u32 + } +} + +/// Read-Modify-Write (RMW) Nor Flash storage structure. +pub struct RmwNorFlashStorage<'a, S> { + storage: S, + merge_buffer: &'a mut [u8], +} + +impl<'a, S> RmwNorFlashStorage<'a, S> +where + S: NorFlash, +{ + /// Instantiate a new generic `Storage` from a `NorFlash` peripheral + /// + /// **NOTE** This will panic if the provided merge buffer, + /// is smaller than the erase size of the flash peripheral + 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> { + // Nothing special to be done for reads + 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> { + // Perform read/modify/write operations on the byte slice. + let last_page = self.storage.capacity() / S::ERASE_SIZE; + + // `data` is the part of `bytes` contained within `page`, + // and `addr` in the address offset of `page` + any offset into the page as requested by `address` + 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])?; + + // If we cannot write multiple times to the same page, we will have to erase it + 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(()) + } +} + +/// Read-Modify-Write (RMW) Multi-Write Nor Flash storage structure. +pub struct RmwMultiwriteNorFlashStorage<'a, S> { + storage: S, + merge_buffer: &'a mut [u8], +} + +impl<'a, S> RmwMultiwriteNorFlashStorage<'a, S> +where + S: MultiwriteNorFlash, +{ + /// Instantiate a new generic `Storage` from a `NorFlash` peripheral + /// + /// **NOTE** This will panic if the provided merge buffer, + /// is smaller than the erase size of the flash peripheral + 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> { + // Nothing special to be done for reads + 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> { + // Perform read/modify/write operations on the byte slice. + let last_page = self.storage.capacity() / S::ERASE_SIZE; + + // `data` is the part of `bytes` contained within `page`, + // and `addr` in the address offset of `page` + any offset into the page as requested by `address` + 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); + + // Check if we can write the data block directly, under the limitations imposed by NorFlash: + // - We can only change 1's to 0's + if is_subset { + // Use `merge_buffer` as allocation for padding `data` to `WRITE_SIZE` + 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(()) + } +}