Struct esp_idf_sys::esp_flash_os_functions_t

#[repr(C)]
pub struct esp_flash_os_functions_t {
    pub start: Option<unsafe extern "C" fn(arg: *mut c_void) -> esp_err_t>,
    pub end: Option<unsafe extern "C" fn(arg: *mut c_void) -> esp_err_t>,
    pub region_protected: Option<unsafe extern "C" fn(arg: *mut c_void, start_addr: usize, size: usize) -> esp_err_t>,
    pub delay_us: Option<unsafe extern "C" fn(arg: *mut c_void, us: u32) -> esp_err_t>,
    pub get_temp_buffer: Option<unsafe extern "C" fn(arg: *mut c_void, reqest_size: usize, out_size: *mut usize) -> *mut c_void>,
    pub release_temp_buffer: Option<unsafe extern "C" fn(arg: *mut c_void, temp_buf: *mut c_void)>,
    pub check_yield: Option<unsafe extern "C" fn(arg: *mut c_void, chip_status: u32, out_request: *mut u32) -> esp_err_t>,
    pub yield_: Option<unsafe extern "C" fn(arg: *mut c_void, out_status: *mut u32) -> esp_err_t>,
    pub get_system_time: Option<unsafe extern "C" fn(arg: *mut c_void) -> i64>,
}

@brief OS-level integration hooks for accessing flash chips inside a running OS

It’s in the public header because some instances should be allocated statically in the startup code. May be updated according to hardware version and new flash chip feature requirements, shouldn’t be treated as public API.

For advanced developers, you may replace some of them with your implementations at your own risk.

Fields

start: Option<unsafe extern "C" fn(arg: *mut c_void) -> esp_err_t>

Called before commencing any flash operation. Does not need to be recursive (ie is called at most once for each call to ‘end’).

end: Option<unsafe extern "C" fn(arg: *mut c_void) -> esp_err_t>

Called after completing any flash operation.

region_protected: Option<unsafe extern "C" fn(arg: *mut c_void, start_addr: usize, size: usize) -> esp_err_t>

Called before any erase/write operations to check whether the region is limited by the OS

delay_us: Option<unsafe extern "C" fn(arg: *mut c_void, us: u32) -> esp_err_t>

Delay for at least ‘us’ microseconds. Called in between ‘start’ and ‘end’.

get_temp_buffer: Option<unsafe extern "C" fn(arg: *mut c_void, reqest_size: usize, out_size: *mut usize) -> *mut c_void>

Called for get temp buffer when buffer from application cannot be directly read into/write from.

release_temp_buffer: Option<unsafe extern "C" fn(arg: *mut c_void, temp_buf: *mut c_void)>

Called for release temp buffer.

check_yield: Option<unsafe extern "C" fn(arg: *mut c_void, chip_status: u32, out_request: *mut u32) -> esp_err_t>

Yield to other tasks. Called during erase operations. @return ESP_OK means yield needs to be called (got an event to handle), while ESP_ERR_TIMEOUT means skip yield.

yield_: Option<unsafe extern "C" fn(arg: *mut c_void, out_status: *mut u32) -> esp_err_t>

Yield to other tasks. Called during erase operations.

get_system_time: Option<unsafe extern "C" fn(arg: *mut c_void) -> i64>

Called for get system time.

Trait Implementations

impl Clone for esp_flash_os_functions_t

fn clone(&self) -> esp_flash_os_functions_t

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for esp_flash_os_functions_t

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

Formats the value using the given formatter.

impl Default for esp_flash_os_functions_t

fn default() -> esp_flash_os_functions_t

Returns the “default value” for a type.

impl Copy for esp_flash_os_functions_t