Struct Flash

pub struct Flash<SPI: Transfer<u8>, CS: OutputPin> { /* private fields */ }

Driver for 25-series SPI Flash chips.

Type Parameters

• SPI: The SPI master to which the flash chip is attached.
• CS: The Chip-Select line attached to the \CS/\CE pin of the flash chip.

Implementations

impl<SPI: Transfer<u8>, CS: OutputPin> Flash<SPI, CS>

pub fn init(spi: SPI, cs: CS) -> Result<Self, Error<SPI, CS>>

Creates a new 25-series flash driver.

Parameters

• spi: An SPI master. Must be configured to operate in the correct mode for the device.
• cs: The Chip-Select Pin connected to the \CS/\CE pin of the flash chip. Will be driven low when accessing the device.

pub fn read_jedec_id(&mut self) -> Result<Identification, Error<SPI, CS>>

Reads the JEDEC manufacturer/device identification.

pub fn read_status(&mut self) -> Result<Status, Error<SPI, CS>>

Reads the status register.

Trait Implementations

impl<SPI: Transfer<u8>, CS: OutputPin> BlockDevice<u32, SPI, CS> for Flash<SPI, CS>

fn erase_sectors( &mut self, addr: u32, amount: usize, ) -> Result<(), Error<SPI, CS>>

Erases sectors from the memory chip.

fn write_bytes( &mut self, addr: u32, data: &mut [u8], ) -> Result<(), Error<SPI, CS>>

Writes bytes onto the memory chip. This method is supposed to assume that the sectors it is writing to have already been erased and should not do any erasing themselves.

fn erase_all(&mut self) -> Result<(), Error<SPI, CS>>

Erases the memory chip fully.

impl<SPI: Debug + Transfer<u8>, CS: Debug + OutputPin> Debug for Flash<SPI, CS>

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

Formats the value using the given formatter.

impl<SPI: Transfer<u8>, CS: OutputPin> Read<u32, SPI, CS> for Flash<SPI, CS>

fn read(&mut self, addr: u32, buf: &mut [u8]) -> Result<(), Error<SPI, CS>>

Reads flash contents into buf, starting at addr.

Note that addr is not fully decoded: Flash chips will typically only look at the lowest N bits needed to encode their size, which means that the contents are “mirrored” to addresses that are a multiple of the flash size. Only 24 bits of addr are transferred to the device in any case, limiting the maximum size of 25-series SPI flash chips to 16 MiB.

Parameters

• addr: 24-bit address to start reading at.
• buf: Destination buffer to fill.