Type Alias riot_sys::mtd_desc_t
source · pub type mtd_desc_t = mtd_desc;
Expand description
@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.
Aliased Type§
struct mtd_desc_t {
pub init: Option<unsafe extern "C" fn(_: *mut mtd_dev_t) -> i32>,
pub read: Option<unsafe extern "C" fn(_: *mut mtd_dev_t, _: *mut c_void, _: u32, _: u32) -> i32>,
pub read_page: Option<unsafe extern "C" fn(_: *mut mtd_dev_t, _: *mut c_void, _: u32, _: u32, _: u32) -> i32>,
pub write_page: Option<unsafe extern "C" fn(_: *mut mtd_dev_t, _: *const c_void, _: u32, _: u32, _: u32) -> i32>,
pub erase: Option<unsafe extern "C" fn(_: *mut mtd_dev_t, _: u32, _: u32) -> i32>,
pub erase_sector: Option<unsafe extern "C" fn(_: *mut mtd_dev_t, _: u32, _: u32) -> i32>,
pub power: Option<unsafe extern "C" fn(_: *mut mtd_dev_t, _: u8) -> i32>,
pub flags: u8,
}
Fields§
§init: Option<unsafe extern "C" fn(_: *mut mtd_dev_t) -> i32>
@brief Initialize Memory Technology Device (MTD)
@param[in] dev Pointer to the selected driver
@retval 0 on success @retval <0 value on error
read: Option<unsafe extern "C" fn(_: *mut mtd_dev_t, _: *mut c_void, _: u32, _: u32) -> i32>
@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
@retval 0 on success @retval <0 value on error
read_page: Option<unsafe extern "C" fn(_: *mut mtd_dev_t, _: *mut c_void, _: u32, _: u32, _: u32) -> i32>
@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
@retval n number of bytes read on success @retval <0 value on error
write_page: Option<unsafe extern "C" fn(_: *mut mtd_dev_t, _: *const c_void, _: u32, _: u32, _: u32) -> i32>
@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
@retval n bytes written on success @retval <0 value on error
erase: Option<unsafe extern "C" fn(_: *mut mtd_dev_t, _: u32, _: u32) -> i32>
@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
@retval 0 on success @retval <0 value on error
erase_sector: Option<unsafe extern "C" fn(_: *mut mtd_dev_t, _: u32, _: u32) -> i32>
@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
@retval 0 on success @retval <0 value on error
power: Option<unsafe extern "C" fn(_: *mut mtd_dev_t, _: u8) -> i32>
@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)
@retval 0 on success @retval <0 value on error
flags: u8
@brief Properties of the MTD driver