Struct stm32_fmc::nand_device::NandDevice

pub struct NandDevice { /* private fields */ }

NAND Device

Implementations

impl NandDevice

pub fn reset(&mut self)

0xFF Reset: ONFI Section 5.3

pub fn read_id(&mut self) -> ID

0x90 Read ID: ONFI Section 5.6

pub fn read_parameter_page(&mut self) -> ParameterPage

0xEC Read Parameter Page: ONFI Section 5.7

pub fn read_unique_id(&mut self) -> u128

0xED Read Unique ID: ONFI Section 5.8

pub fn block_erase(&mut self, address: usize) -> Status

0x60 Block Erase: ONFI Section 5.9

pub fn start_page_read(&mut self, address: usize, spare: bool)

Page Read: ONFI Section 5.14

This method starts a Page Read operation but does not include the data phase. This method is useful when DMA is used for the data phase.

For a method that completes the entire transaction see page_read.

pub fn page_read(&mut self, address: usize, spare: bool, page: &mut [u8])

Page Read: ONFI Section 5.14

Executes a Page Read operation from the specified address. Data is copied to the slice page. The length of page determines the read length. The read length should not exceed the number of bytes between the specified address and the end of the page. Reading beyond the end of the page results in indeterminate values being returned.

If spare is true, then the read occours from the spare area. The address offset from the start of the page plus the slice length should not exceed the spare area size.

pub fn page_program( &mut self, address: usize, spare: bool, page: &[u8], ) -> Status

Page Program: ONFI Section 5.16

Executes a page program to the specified address and waits for it to complete. The length of page determines the write length. The write length should not exceed the number of bytes between the specified address and the end of the page. Writing beyond this length is undefined.

impl NandDevice

Methods to allow users to implement their own commands using unsafe.

pub fn common_command(&mut self) -> *mut u8

Return a Raw Pointer to the common command space. This memory-mapped address is used to write command phase of NAND device transactions.

It is recommended to use ptr::write_volatile to write to this pointer. Depending on the memory map in use, you may need to ensure the write is committed by using core::atomic::sync::fence.

pub fn attribute_command(&mut self) -> *mut u8

Return a Raw Pointer to the attribute command space. This memory-mapped address is used to write command phase of NAND device transactions.

It is recommended to use ptr::write_volatile to write to this pointer. Depending on the memory map in use, you may need to ensure the write is committed by using core::atomic::sync::fence.

pub fn common_address(&mut self) -> *mut u8

Return a Raw Pointer to the common address space. This memory-mapped address is used to write the address phase of NAND device transactions.

It is recommended to use ptr::write_volatile to write to this pointer. Depending on the memory map in use, you may need to ensure the write is committed by using core::atomic::sync::fence.

pub fn common_data(&mut self) -> *mut u8

Return a Raw Pointer to the common data space. This memory-mapped address is used to write or read the data phase of NAND device transactions.

It is recommended to use ptr::write_volatile to write to this pointer. Depending on the memory map in use, you may need to ensure the write is committed by using core::atomic::sync::fence.

Trait Implementations

impl Clone for NandDevice

fn clone(&self) -> NandDevice

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NandDevice

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

Formats the value using the given formatter.

impl PartialEq for NandDevice

fn eq(&self, other: &NandDevice) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for NandDevice