Struct opentitanlib::spiflash::flash::SpiFlash

source ·

pub struct SpiFlash {
    pub size: u32,
    pub program_size: u32,
    pub address_mode: AddressMode,
    pub read_mode: ReadMode,
    pub erase_mode: EraseMode,
    pub sfdp: Option<Sfdp>,
    pub read_type: ReadTypes,
    pub erase: Vec<SectorErase>,
}

Fields§

§size: u32§program_size: u32§address_mode: AddressMode§read_mode: ReadMode§erase_mode: EraseMode§sfdp: Option<Sfdp>§read_type: ReadTypes§erase: Vec<SectorErase>

Implementations§

source §

pub const LEGACY_PAGE_SIZE: u32 = 256u32

The legacy JEDEC page size for programming operations is 256 bytes.

source

pub const STATUS_WIP: u8 = 1u8

Status register bits: The WIP bit indicates a write in progress (sometimes called the busy bit).

source

pub const STATUS_WEL: u8 = 2u8

The WEL bit is the write enable latch.

source

pub fn read_jedec_id(spi: &dyn Target, length: usize) -> Result<Vec<u8>>

Read length bytes of the JEDEC ID from the spi target.

source

pub fn read_status(spi: &dyn Target) -> Result<u8>

Read status register from the spi target.

source

pub fn read_status_ex(spi: &dyn Target, seq: Option<&[u8]>) -> Result<u32>

Read the extended status register from the spi target.

source

pub fn wait_for_busy_clear(spi: &dyn Target) -> Result<()>

Poll the status register waiting for the busy bit to clear.

source

pub fn set_write_enable(spi: &dyn Target) -> Result<()>

Send the WRITE_ENABLE opcode to the spi target.

source

pub fn set_write_disable(spi: &dyn Target) -> Result<()>

Send the WRITE_DISABLE opcode to the spi target.

source

pub fn read_sfdp(spi: &dyn Target) -> Result<Sfdp>

Read and parse the SFDP table from the spi target.

source

pub fn from_sfdp(sfdp: Sfdp) -> Self

Create a new SpiFlash instance from an SFDP table.

source

pub fn from_spi(spi: &dyn Target) -> Result<Self>

Create a new SpiFlash instance by reading an SFDP table from the spi Target.

source

pub fn set_address_mode( &mut self, spi: &dyn Target, mode: AddressMode ) -> Result<()>

Set the SPI flash addressing mode to either 3b or 4b mode.

source

pub fn set_address_mode_auto(&mut self, spi: &dyn Target) -> Result<()>

Automatically set the addressing mode based on the size of the SPI flash.

source

pub fn read( &self, spi: &dyn Target, address: u32, buffer: &mut [u8] ) -> Result<&Self>

Read into buffer from the SPI flash starting at address.

source

pub fn read_with_progress( &self, spi: &dyn Target, address: u32, buffer: &mut [u8], progress: &dyn ProgressIndicator, use_4b_opcodes: bool ) -> Result<&Self>

Read into buffer from the SPI flash starting at address. The progress callback will be invoked after each chunk of the read operation.

source

pub fn chip_erase(&self, spi: &dyn Target) -> Result<&Self>

Erase the entire EEPROM via the CHIP_ERASE opcode.

source

pub fn erase( &self, spi: &dyn Target, address: u32, length: u32 ) -> Result<&Self>

Erase a segment of the SPI flash starting at address for length bytes. The address and length must be sector aligned.

source

pub fn erase_with_progress( &self, spi: &dyn Target, address: u32, length: u32, progress: &dyn ProgressIndicator ) -> Result<&Self>

Erase a segment of the SPI flash starting at address for length bytes. The address and length must be sector aligned. The progress callback will be invoked after each chunk of the erase operation.

source

pub fn program( &self, spi: &dyn Target, address: u32, buffer: &[u8] ) -> Result<&Self>

Program a segment of the SPI flash starting at address with the contents of buffer. The address and buffer length may be arbitrary. This function will not erase the segment first.

source

pub fn program_with_progress( &self, spi: &dyn Target, address: u32, buffer: &[u8], progress: &dyn ProgressIndicator ) -> Result<&Self>

Program a segment of the SPI flash starting at address with the contents of buffer. The address and buffer length may be arbitrary. This function will not erase the segment first. The progress callback will be invoked after each chunk of the program operation.

source