13#ifndef ZEPHYR_INCLUDE_DRIVERS_FLASH_H_
14#define ZEPHYR_INCLUDE_DRIVERS_FLASH_H_
34#if defined(CONFIG_FLASH_PAGE_LAYOUT)
79 bool no_explicit_erase: 1;
87#define FLASH_ERASE_C_EXPLICIT 0x01
91#define FLASH_ERASE_CAPS_UNSET (int)-1
93#define FLASH_ERASE_C_SUPPORTED 0x02
94#define FLASH_ERASE_C_VAL_BIT 0x04
95#define FLASH_ERASE_UNIFORM_PAGE 0x08
114#if defined(CONFIG_FLASH_HAS_EXPLICIT_ERASE)
115#if defined(CONFIG_FLASH_HAS_NO_EXPLICIT_ERASE)
158 const void *
data,
size_t len);
190#if defined(CONFIG_FLASH_PAGE_LAYOUT)
214 size_t *layout_size);
218 void *
data,
size_t len);
229#if defined(CONFIG_FLASH_PAGE_LAYOUT)
232#if defined(CONFIG_FLASH_JESD216_API)
236#if defined(CONFIG_FLASH_EX_OP_ENABLED)
266static inline int z_impl_flash_read(
const struct device *dev,
off_t offset,
273 return api->read(dev, offset, data, len);
298static inline int z_impl_flash_write(
const struct device *dev,
off_t offset,
299 const void *data,
size_t len)
305 rc = api->write(dev, offset, data, len);
340static inline int z_impl_flash_erase(
const struct device *dev,
off_t offset,
348 if (api->erase !=
NULL) {
349 rc = api->erase(dev, offset, size);
370static inline int z_impl_flash_get_size(
const struct device *dev,
uint64_t *size)
375 if (api->get_size !=
NULL) {
376 rc = api->get_size(dev, size);
444#if defined(CONFIG_FLASH_PAGE_LAYOUT)
508#if defined(CONFIG_FLASH_JESD216_API)
530 void *data,
size_t len);
532static inline int z_impl_flash_sfdp_read(
const struct device *dev,
534 void *data,
size_t len)
540 if (api->sfdp_read !=
NULL) {
541 rv = api->sfdp_read(dev, offset, data, len);
559static inline int z_impl_flash_read_jedec_id(
const struct device *dev,
566 if (api->read_jedec_id !=
NULL) {
567 rv = api->read_jedec_id(dev,
id);
586static inline size_t z_impl_flash_get_write_block_size(
const struct device *dev)
591 return api->get_parameters(dev)->write_block_size;
613 return api->get_parameters(dev);
688#define FLASH_EX_OP_VENDOR_BASE 0x8000
689#define FLASH_EX_OP_IS_VENDOR(c) ((c) & FLASH_EX_OP_VENDOR_BASE)
701static inline int z_impl_flash_ex_op(
const struct device *dev,
uint16_t code,
704#if defined(CONFIG_FLASH_EX_OP_ENABLED)
708 if (api->ex_op ==
NULL) {
712 return api->ex_op(dev, code, in, out);
731#include <zephyr/syscalls/flash.h>
int flash_fill(const struct device *dev, uint8_t val, off_t offset, size_t size)
Fill selected range of device with specified value.
int flash_erase(const struct device *dev, off_t offset, size_t size)
Erase part or all of a flash memory.
const struct flash_parameters * flash_get_parameters(const struct device *dev)
Get pointer to flash_parameters structure.
int flash_flatten(const struct device *dev, off_t offset, size_t size)
Erase part or all of a flash memory or level it.
void flash_page_foreach(const struct device *dev, flash_page_cb cb, void *data)
Iterate over all flash pages on a device.
bool(* flash_page_cb)(const struct flash_pages_info *info, void *data)
Callback type for iterating over flash pages present on a device.
Definition flash.h:490
int flash_get_size(const struct device *dev, uint64_t *size)
Get device size in bytes.
int flash_ex_op(const struct device *dev, uint16_t code, const uintptr_t in, void *out)
Execute flash extended operation on given device.
#define FLASH_ERASE_C_EXPLICIT
Set for ordinary Flash where erase is needed before write of random data.
Definition flash.h:87
int flash_write(const struct device *dev, off_t offset, const void *data, size_t len)
Write buffer into flash memory.
int flash_copy(const struct device *src_dev, off_t src_offset, const struct device *dst_dev, off_t dst_offset, off_t size, uint8_t *buf, size_t buf_size)
Copy flash memory from one device to another.
int flash_sfdp_read(const struct device *dev, off_t offset, void *data, size_t len)
Read data from Serial Flash Discoverable Parameters.
int flash_read(const struct device *dev, off_t offset, void *data, size_t len)
Read data from flash.
size_t flash_get_write_block_size(const struct device *dev)
Get the minimum write block size supported by the driver.
int flash_get_page_info_by_idx(const struct device *dev, uint32_t page_index, struct flash_pages_info *info)
Get the size and start offset of flash page of certain index.
static int flash_params_get_erase_cap(const struct flash_parameters *p)
Definition flash.h:112
int flash_read_jedec_id(const struct device *dev, uint8_t *id)
Read the JEDEC ID from a compatible flash device.
flash_ex_op_types
Enumeration for extra flash operations.
Definition flash.h:694
size_t flash_get_page_count(const struct device *dev)
Get the total number of flash pages.
int flash_get_page_info_by_offs(const struct device *dev, off_t offset, struct flash_pages_info *info)
Get the size and start offset of flash page at certain flash offset.
@ FLASH_EX_OP_RESET
Definition flash.h:698
int(* flash_api_read_jedec_id)(const struct device *dev, uint8_t *id)
Definition flash.h:219
int(* flash_api_erase)(const struct device *dev, off_t offset, size_t size)
Flash erase implementation handler type.
Definition flash.h:173
const struct flash_parameters *(* flash_api_get_parameters)(const struct device *dev)
Definition flash.h:188
int(* flash_api_read)(const struct device *dev, off_t offset, void *data, size_t len)
Flash read implementation handler type.
Definition flash.h:146
void(* flash_api_pages_layout)(const struct device *dev, const struct flash_pages_layout **layout, size_t *layout_size)
Retrieve a flash device's layout.
Definition flash.h:212
int(* flash_api_get_size)(const struct device *dev, uint64_t *size)
Get device size in bytes.
Definition flash.h:186
int(* flash_api_sfdp_read)(const struct device *dev, off_t offset, void *data, size_t len)
Definition flash.h:217
int(* flash_api_ex_op)(const struct device *dev, uint16_t code, const uintptr_t in, void *out)
Definition flash.h:220
int(* flash_api_write)(const struct device *dev, off_t offset, const void *data, size_t len)
Flash write implementation handler type.
Definition flash.h:157
#define ENOSYS
Function not implemented.
Definition errno.h:82
#define ENOTSUP
Unsupported value.
Definition errno.h:114
#define NULL
Definition iar_missing_defs.h:20
__INTPTR_TYPE__ off_t
Definition types.h:36
#define bool
Definition stdbool.h:13
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
__UINT64_TYPE__ uint64_t
Definition stdint.h:91
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
__UINTPTR_TYPE__ uintptr_t
Definition stdint.h:105
__UINT16_TYPE__ uint16_t
Definition stdint.h:89
Runtime device structure (in ROM) per driver instance.
Definition device.h:510
void * data
Address of the device instance private data.
Definition device.h:520
const void * api
Address of the API structure exposed by the device instance.
Definition device.h:516
flash_api_sfdp_read sfdp_read
Definition flash.h:233
flash_api_get_parameters get_parameters
Definition flash.h:227
flash_api_pages_layout page_layout
Definition flash.h:230
flash_api_read read
Definition flash.h:224
flash_api_get_size get_size
Definition flash.h:228
flash_api_write write
Definition flash.h:225
flash_api_erase erase
Definition flash.h:226
flash_api_read_jedec_id read_jedec_id
Definition flash.h:234
size_t size
Definition flash.h:440
off_t start_offset
Definition flash.h:439
uint32_t index
Definition flash.h:441
size_t pages_size
Definition flash.h:37
size_t pages_count
Definition flash.h:36
Flash memory parameters.
Definition flash.h:65
uint8_t erase_value
Value the device is filled in erased areas.
Definition flash.h:83
const size_t write_block_size
Minimal write alignment and size.
Definition flash.h:67