Symbols ![]()
loading (4/5)...
Files ![]()
loading (4/5)...
esp_flash_os_functions_t struct
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.
Syntax
typedef struct
{
esp_err_t (*start)(void *arg);
esp_err_t (*end)(void *arg);
esp_err_t (*region_protected)(void* arg, size_t start_addr, size_t size);
esp_err_t (*delay_us)(void *arg, uint32_t us);
void *(*get_temp_buffer)(void* arg, size_t reqest_size, size_t* out_size);
void (*release_temp_buffer)(void* arg, void *temp_buf);
#define SPI_FLASH_YIELD_REQ_YIELD BIT(0)
#define SPI_FLASH_YIELD_REQ_SUSPEND BIT(1)
esp_err_t (*check_yield)(void *arg, uint32_t chip_status, uint32_t* out_request);
#define SPI_FLASH_YIELD_STA_RESUME BIT(2)
esp_err_t (*yield)(void *arg, uint32_t* out_status);
int64_t (*get_system_time)(void *arg);
#define SPI_FLASH_OS_IS_ERASING_STATUS_FLAG BIT(0)
void (*set_flash_op_status)(uint32_t op_status);
} esp_flash_os_functions_t;
Fields
Field
Declared as
Description
Called before commencing any flash operation. Does not need to be recursive (ie is called at most once for each call to 'end').
Called before any erase/write operations to check whether the region is limited by the OS.
Delay for at least 'us' microseconds. Called in between 'start' and 'end'.
void *(*)(void* arg, size_t reqest_size, size_t* out_size)
Called for get temp buffer when buffer from application cannot be directly read into/write from.
void (*)(void* arg, void *temp_buf)
Called for release temp buffer.
Yield to other tasks. Called during erase operations.
Yield to other tasks. Called during erase operations.
void (*)(uint32_t op_status)
Call to set flash operation status.
References
Code
Location
Scope
Referrer