eeprom

Crates.ioeeprom
lib.rseeprom
version0.3.1
sourcesrc
created_at2017-09-30 03:46:41.860893
updated_at2022-11-19 04:10:17.753873
descriptionEEPROM emulation on top of FLASH for STM32
homepage
repositoryhttps://github.com/idubrov/eeprom
max_upload_size
id33971
size93,406
Ivan Dubrov (idubrov)

documentation

https://docs.rs/eeprom

README

crates.io crates.io CircleCI Codecov

eeprom

Flash-based EEPROM emulation for the STM32 series microcontrollers. Uses 2 or more Flash pages for storing 16-bit data.

Examples

use eeprom::EEPROM;
struct MockFlash;
// let param = Params { .. };
// let mut flash: stm32f1::stm32f103::FLASH = /* get flash somehow */;
let mut eeprom = flash.eeprom(params);
eeprom.init().expect("failed to init EEPROM");
eeprom.write(1, 0xdead).expect("failed to write data to EEPROM");
eeprom.write(2, 0xbeef).expect("failed to write data to EEPROM");
assert_eq!(0xdead, eeprom.read(1).unwrap());
assert_eq!(0xbeef, eeprom.read(2).unwrap());
assert_eq!(true, eeprom.read(3).is_none());

Panics

EEPROM controller will panic in the following cases:

  • No free space on the page even after compaction
  • active page cannot be found during read/write operation (init makes sure that there is exactly one active page.

Full Documentation

License

Licensed under either of

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.

Commit count: 24

cargo fmt