Public API for flash map. More...

#include <zephyr/types.h>
#include <stddef.h>
#include <sys/types.h>
#include <zephyr/device.h>
#include <zephyr/devicetree.h>
#include <zephyr/devicetree/fixed-partitions.h>
#include <zephyr/devicetree/mapped-partition.h>
#include <zephyr/devicetree/partitions.h>

Data Structures
struct	flash_area
	Flash partition. More...

struct	flash_sector
	Structure for transfer flash sector boundaries. More...

Macros
#define	PARTITION_EXISTS(label)
	Returns non-0 value if partition of given DTS node label exists.

#define	FIXED_PARTITION_EXISTS(label)
	Deprecated macro, replace with PARTITION_EXISTS(), this cannot use __DEPRECATED_MACRO as it causes usage of the macro to fail with compiler errors.

#define	PARTITION_ID(label)
	Get flash area ID from partition DTS node label.

#define	FIXED_PARTITION_ID(label)
	Deprecated macro, replace with PARTITION_ID()

#define	PARTITION_OFFSET(label)
	Get partition offset from DTS node label.

#define	FIXED_PARTITION_OFFSET(label)
	Deprecated macro, replace with PARTITION_OFFSET()

#define	PARTITION_ADDRESS(label)
	Get partition address from DTS node label.

#define	FIXED_PARTITION_ADDRESS(label)
	Deprecated macro, replace with PARTITION_ADDRESS()

#define	PARTITION_NODE_ADDRESS(node)
	Get partition address from DTS node.

#define	FIXED_PARTITION_NODE_ADDRESS(node)
	Deprecated macro, replace with PARTITION_NODE_ADDRESS()

#define	PARTITION_NODE_OFFSET(node)
	Get partition offset from DTS node.

#define	FIXED_PARTITION_NODE_OFFSET(label)
	Deprecated macro, replace with PARTITION_NODE_OFFSET()

#define	PARTITION_SIZE(label)
	Get partition size for DTS node label.

#define	FIXED_PARTITION_SIZE(label)
	Deprecated macro, replace with PARTITION_SIZE()

#define	PARTITION_NODE_SIZE(node)
	Get fixed-partition size for DTS node.

#define	FIXED_PARTITION_NODE_SIZE(node)
	Deprecated macro, replace with PARTITION_NODE_SIZE()

#define	FLASH_AREA_DEVICE(label)
	Get device pointer for device the area/partition resides on.

#define	PARTITION_DEVICE(label)
	Get device pointer for device the area/partition resides on.

#define	FIXED_PARTITION_DEVICE(label)
	Deprecated macro, replace with PARTITION_DEVICE()

#define	PARTITION_NODE_DEVICE(node)
	Get device pointer for device the area/partition resides on.

#define	FIXED_PARTITION_NODE_DEVICE(node)
	Deprecated macro, replace with PARTITION_NODE_DEVICE()

#define	PARTITION_MTD(label)
	Get the node identifier of the flash controller the area/partition resides on.

#define	FIXED_PARTITION_MTD(label)
	Deprecated macro, replace with PARTITION_OFFSET()

#define	PARTITION_NODE_MTD(node)
	Get the node identifier of the flash controller the area/partition resides on.

#define	FIXED_PARTITION_NODE_MTD(node)
	Deprecated macro, replace with PARTITION_NODE_MTD()

#define	PARTITION(label)
	Get pointer to flash_area object by partition label.

#define	FIXED_PARTITION(label)
	Deprecated macro, replace with PARTITION()

#define	PARTITION_BY_NODE(node)
	Get pointer to flash_area object by partition node in DTS.

#define	FIXED_PARTITION_BY_NODE(node)
	Deprecated macro, replace with PARTITION_OFFSET()

Typedefs
typedef void(*	flash_area_cb_t) (const struct flash_area fa, void user_data)
	Flash map iteration callback.

Functions
int	flash_area_open (uint8_t id, const struct flash_area **fa)
	Retrieve partitions flash area from the flash_map.

void	flash_area_close (const struct flash_area *fa)
	Close flash_area.

static ALWAYS_INLINE bool	flash_area_device_is_ready (const struct flash_area *fa)
	Verify that a device assigned to flash area is ready for use.

int	flash_area_read (const struct flash_area fa, off_t off, void dst, size_t len)
	Read flash area data.

int	flash_area_write (const struct flash_area fa, off_t off, const void src, size_t len)
	Write data to flash area.

int	flash_area_copy (const struct flash_area src_fa, off_t src_off, const struct flash_area dst_fa, off_t dst_off, off_t len, uint8_t *buf, size_t buf_size)
	Copy flash memory from one flash area to another.

int	flash_area_erase (const struct flash_area *fa, off_t off, size_t len)
	Erase flash area.

int	flash_area_flatten (const struct flash_area *fa, off_t off, size_t len)
	Erase flash area or fill with erase-value.

uint32_t	flash_area_align (const struct flash_area *fa)
	Get write block size of the flash area.

int	flash_area_get_sectors (int fa_id, uint32_t count, struct flash_sector sectors)
	Retrieve info about sectors within the area.

int	flash_area_sectors (const struct flash_area fa, uint32_t count, struct flash_sector *sectors)
	Retrieve info about sectors within the area.

void	flash_area_foreach (flash_area_cb_t user_cb, void *user_data)
	Iterate over flash map.

int	flash_area_has_driver (const struct flash_area *fa)
	Check whether given flash area has supporting flash driver in the system.

const struct device *	flash_area_get_device (const struct flash_area *fa)
	Get driver for given flash area.

uint8_t	flash_area_erased_val (const struct flash_area *fa)
	Get the value expected to be read when accessing any erased flash byte.

Detailed Description

Public API for flash map.

Data Structures

Macros

Typedefs

Functions

Detailed Description