flash_driver_api Struct Reference

@driver_ops{Flash} More...

#include <flash.h>

Data Fields
flash_api_read	read
	@driver_ops_mandatory Read data from flash.
flash_api_write	write
	@driver_ops_mandatory Write buffer into flash memory.
flash_api_erase	erase
	@driver_ops_optional Erase part or all of a flash memory.
flash_api_get_parameters	get_parameters
	@driver_ops_mandatory Get pointer to flash_parameters structure.
flash_api_get_size	get_size
	@driver_ops_optional Get device size in bytes.
flash_api_pages_layout	page_layout
	@driver_ops_mandatory Retrieve a flash device's layout.
flash_api_sfdp_read	sfdp_read
	@driver_ops_optional Read data from Serial Flash Discoverable Parameters.
flash_api_read_jedec_id	read_jedec_id
	@driver_ops_optional Read the JEDEC ID from a compatible flash device.
flash_api_ex_op	ex_op
	@driver_ops_optional Vendor-specific extended operations for flash drivers.

Detailed Description

@driver_ops{Flash}

Field Documentation

erase

flash_api_erase flash_driver_api::erase

@driver_ops_optional Erase part or all of a flash memory.

ex_op

flash_api_ex_op flash_driver_api::ex_op

@driver_ops_optional Vendor-specific extended operations for flash drivers.

Attention

Available only when the following Kconfig option is enabled:

CONFIG_FLASH_EX_OP_ENABLED 

.

get_parameters

flash_api_get_parameters flash_driver_api::get_parameters

@driver_ops_mandatory Get pointer to flash_parameters structure.

get_size

flash_api_get_size flash_driver_api::get_size

@driver_ops_optional Get device size in bytes.

page_layout

flash_api_pages_layout flash_driver_api::page_layout

@driver_ops_mandatory Retrieve a flash device's layout.

Attention

Available only when the following Kconfig option is enabled:

CONFIG_FLASH_PAGE_LAYOUT 

.

read

flash_api_read flash_driver_api::read

@driver_ops_mandatory Read data from flash.

read_jedec_id

flash_api_read_jedec_id flash_driver_api::read_jedec_id

@driver_ops_optional Read the JEDEC ID from a compatible flash device.

Attention

Available only when the following Kconfig option is enabled:

CONFIG_FLASH_JESD216_API 

.

sfdp_read

flash_api_sfdp_read flash_driver_api::sfdp_read

@driver_ops_optional Read data from Serial Flash Discoverable Parameters.

Attention

Available only when the following Kconfig option is enabled:

CONFIG_FLASH_JESD216_API 

.

write

flash_api_write flash_driver_api::write

@driver_ops_mandatory Write buffer into flash memory.

---

The documentation for this struct was generated from the following file:

• include/zephyr/drivers/flash.h