Struct riot_sys::mtd_desc

#[repr(C)]
pub struct mtd_desc {
    pub init: Option<unsafe extern "C" fn(dev: *mut mtd_dev_t) -> c_int>,
    pub read: Option<unsafe extern "C" fn(dev: *mut mtd_dev_t, buff: *mut c_void, addr: u32, size: u32) -> c_int>,
    pub read_page: Option<unsafe extern "C" fn(dev: *mut mtd_dev_t, buff: *mut c_void, page: u32, offset: u32, size: u32) -> c_int>,
    pub write: Option<unsafe extern "C" fn(dev: *mut mtd_dev_t, buff: *const c_void, addr: u32, size: u32) -> c_int>,
    pub write_page: Option<unsafe extern "C" fn(dev: *mut mtd_dev_t, buff: *const c_void, page: u32, offset: u32, size: u32) -> c_int>,
    pub erase: Option<unsafe extern "C" fn(dev: *mut mtd_dev_t, addr: u32, size: u32) -> c_int>,
    pub erase_sector: Option<unsafe extern "C" fn(dev: *mut mtd_dev_t, sector: u32, count: u32) -> c_int>,
    pub power: Option<unsafe extern "C" fn(dev: *mut mtd_dev_t, power: mtd_power_state) -> c_int>,
    pub flags: u8,
}

@brief MTD driver interface

This define the functions to access a MTD.

A MTD is composed of pages combined into sectors. A sector is the smallest erasable unit. The number of pages in a sector must be constant for the whole MTD.

The erase operation is available only for entire sectors.

Fields

init: Option<unsafe extern "C" fn(dev: *mut mtd_dev_t) -> c_int>

@brief Initialize Memory Technology Device (MTD)

@param[in] dev Pointer to the selected driver

@returns 0 on success @returns < 0 value in error

read: Option<unsafe extern "C" fn(dev: *mut mtd_dev_t, buff: *mut c_void, addr: u32, size: u32) -> c_int>

@brief Read from the Memory Technology Device (MTD)

No alignment is required on @p addr and @p size.

@param[in] dev Pointer to the selected driver @param[out] buff Pointer to the data buffer to store read data @param[in] addr Starting address @param[in] size Number of bytes

@return 0 on success @return < 0 value on error

read_page: Option<unsafe extern "C" fn(dev: *mut mtd_dev_t, buff: *mut c_void, page: u32, offset: u32, size: u32) -> c_int>

@brief Read from the Memory Technology Device (MTD) using pagewise addressing.

@p offset should not exceed the page size

@param[in] dev Pointer to the selected driver @param[out] buff Pointer to the data buffer to store read data @param[in] page Page number to start reading from @param[in] offset Byte offset from the start of the page @param[in] size Number of bytes

@return number of bytes read on success @return < 0 value on error

write: Option<unsafe extern "C" fn(dev: *mut mtd_dev_t, buff: *const c_void, addr: u32, size: u32) -> c_int>

@brief Write to the Memory Technology Device (MTD)

@p addr + @p size must be inside a page boundary. @p addr can be anywhere but the buffer cannot overlap two pages.

@param[in] dev Pointer to the selected driver @param[in] buff Pointer to the data to be written @param[in] addr Starting address @param[in] size Number of bytes

@return 0 on success @return < 0 value on error

write_page: Option<unsafe extern "C" fn(dev: *mut mtd_dev_t, buff: *const c_void, page: u32, offset: u32, size: u32) -> c_int>

@brief Write to the Memory Technology Device (MTD) using pagewise addressing.

@p offset should not exceed the page size

@param[in] dev Pointer to the selected driver @param[out] buff Pointer to the data to be written @param[in] page Page number to start writing to @param[in] offset Byte offset from the start of the page @param[in] size Number of bytes

@return bytes written on success @return < 0 value on error

erase: Option<unsafe extern "C" fn(dev: *mut mtd_dev_t, addr: u32, size: u32) -> c_int>

@brief Erase sector(s) over the Memory Technology Device (MTD)

@p addr must be aligned on a sector boundary. @p size must be a multiple of a sector size.

@param[in] dev Pointer to the selected driver @param[in] addr Starting address @param[in] size Number of bytes

@return 0 on success @return < 0 value on error

erase_sector: Option<unsafe extern "C" fn(dev: *mut mtd_dev_t, sector: u32, count: u32) -> c_int>

@brief Erase sector(s) of the Memory Technology Device (MTD)

@param[in] dev Pointer to the selected driver @param[in] sector the first sector number to erase

@param[in] count Number of sectors to erase

@return 0 on success @return < 0 value on error

power: Option<unsafe extern "C" fn(dev: *mut mtd_dev_t, power: mtd_power_state) -> c_int>

@brief Control power of Memory Technology Device (MTD)

@param[in] dev Pointer to the selected driver @param[in] power Power state to apply (from @ref mtd_power_state)

@return 0 on success @return < 0 value on error

flags: u8

@brief Properties of the MTD driver

Trait Implementations

impl Clone for mtd_desc

fn clone(&self) -> mtd_desc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for mtd_desc

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

Formats the value using the given formatter.

impl Default for mtd_desc

fn default() -> mtd_desc

Returns the “default value” for a type.

impl Copy for mtd_desc