Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Proposal: Add DirectreadNorFlash trait #22

Closed
wants to merge 1 commit into from
Closed

Proposal: Add DirectreadNorFlash trait #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.

## Unreleased

- Add `DirectreadNorFlash` trait

## [0.2.0] - 2021-09-15

- Removed `try_` prefix from all trait methods.
Expand Down
10 changes: 10 additions & 0 deletions src/nor_flash.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,16 @@ pub trait ReadNorFlash {
fn capacity(&self) -> usize;
}

/// Read only NOR flash trait with direct access.
pub trait DirectreadNorFlash: ReadNorFlash {
/// Provides direct access to the storage peripheral, starting at the given address offset
/// with the given byte length.
///
/// This should throw an error if the arguments are out of bounds. Note that there is no
/// alignment restriction (i.e. [`ReadNorFlash::READ_SIZE`] should be 1).
fn direct_read(&self, offset: u32, length: usize) -> Result<&[u8], Self::Error>;
}

/// NOR flash trait.
pub trait NorFlash: ReadNorFlash {
/// The minumum number of bytes the storage peripheral can write
Expand Down