Struct stm32wlxx_hal::flash::Flash

pub struct Flash<'a> { /* private fields */ }

Flash driver.

Implementations

impl<'a> Flash<'a>

pub fn unlock(flash: &'a mut FLASH) -> Self

Unlock the flash memory for program or erase operations.

The flash memory will be locked when this struct is dropped.

Example

use stm32wlxx_hal::{flash::Flash, pac};

let mut dp: pac::Peripherals = pac::Peripherals::take().unwrap();

let mut flash: Flash = Flash::unlock(&mut dp.FLASH);

pub unsafe fn standard_program( &mut self, from: *const u64, to: *mut u64 ) -> Result<(), Error>

Program 8 bytes.

Safety

1. Do not write to flash memory that is being used for your code.
2. The destination address must be within the flash memory region.
3. The from and to pointers must be aligned to the pointee type.

pub unsafe fn program_bytes( &mut self, from: &[u8], to: AlignedAddr ) -> Result<(), Error>

Program any number of bytes.

This is the safest possible method for programming.

Safety

1. Do not write to flash memory that is being used for your code.

Example

use stm32wlxx_hal::{
    flash::{Flash, Page},
    pac,
};

let mut dp: pac::Peripherals = pac::Peripherals::take().unwrap();

let my_data: [u8; 3] = [0x14, 0x15, 0x16];

let last_page: Page = Page::from_index(127).unwrap();

let mut flash: Flash = Flash::unlock(&mut dp.FLASH);
unsafe {
    flash.page_erase(last_page)?;
    flash.program_bytes(&my_data, last_page.into())?;
}

pub unsafe fn standard_program_generic<T>( &mut self, from: *const T, to: *mut T ) -> Result<(), Error>

Program a user-defined type.

Safety

1. Do not write to flash memory that is being used for your code.
2. The destination address must be within the flash memory region.
3. The from and to pointers must be aligned to u64. Use #[repr(align(8))] to align your structure.

pub unsafe fn fast_program( &mut self, from: *const u64, to: *mut u64 ) -> Result<(), Error>

Program 256 bytes.

Safety

1. Do not write to flash memory that is being used for your code.
2. The destination address must be within the flash memory region.
3. The flash clock frequency (HCLK3) must be at least 8 MHz.
4. The from and to pointers must be aligned to the pointee type.
5. The from pointer must point to 256 bytes of valid data.
6. The CPU must execute this from SRAM. The compiler may inline this function, because #[inline(never)] is merely a suggestion.

pub unsafe fn page_erase(&mut self, page: Page) -> Result<(), Error>

Erases a 2048 byte page, setting all the bits to 1.

Safety

1. Do not erase flash memory that is being used for your code.

Example

Erase the last page.

use stm32wlxx_hal::{
    flash::{Flash, Page},
    pac,
};

let mut dp: pac::Peripherals = pac::Peripherals::take().unwrap();

let last_page: Page = Page::from_index(127).unwrap();

let mut flash: Flash = Flash::unlock(&mut dp.FLASH);
unsafe { flash.page_erase(last_page)? };

pub unsafe fn mass_erase(&mut self) -> Result<(), Error>

Erases the entire flash memory, setting all the bits to 1.

Safety

1. The CPU must execute this from SRAM. The compiler may inline this function, because #[inline(never)] is merely a suggestion.

Trait Implementations

impl<'a> Debug for Flash<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for Flash<'_>

fn drop(&mut self)

Executes the destructor for this type.