flash_map.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017 Nordic Semiconductor ASA
 * Copyright (c) 2015 Runtime Inc
 * Copyright (c) 2023 Sensorfy B.V.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_STORAGE_FLASH_MAP_H_
#define ZEPHYR_INCLUDE_STORAGE_FLASH_MAP_H_
 
/*
 * This API makes it possible to operate on flash areas easily and
 * effectively.
 *
 * The system contains global data about flash areas. Every area
 * contains an ID number, offset, and length.
 */
 
#include <zephyr/types.h>
#include <stddef.h>
#include <sys/types.h>
#include <zephyr/device.h>
#include <zephyr/devicetree.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define SOC_FLASH_0_ID 0
#define SPI_FLASH_0_ID 1
 
struct flash_area {
        uint8_t fa_id;
        uint16_t pad16;
        off_t fa_off;
        size_t fa_size;
        const struct device *fa_dev;
#if CONFIG_FLASH_MAP_LABELS
        const char *fa_label;
#endif
};
 
struct flash_sector {
        off_t fs_off;
        size_t fs_size;
};
 
#if defined(CONFIG_FLASH_AREA_CHECK_INTEGRITY)
struct flash_area_check {
        const uint8_t *match;           
        size_t clen;                    
        size_t off;                     
        uint8_t *rbuf;                  
        size_t rblen;                   
};
 
int flash_area_check_int_sha256(const struct flash_area *fa,
                                const struct flash_area_check *fac);
#endif
 
int flash_area_open(uint8_t id, const struct flash_area **fa);
 
void flash_area_close(const struct flash_area *fa);
 
int flash_area_read(const struct flash_area *fa, off_t off, void *dst,
                    size_t len);
 
int flash_area_write(const struct flash_area *fa, off_t off, const void *src,
                     size_t len);
 
int flash_area_erase(const struct flash_area *fa, off_t off, size_t len);
 
uint32_t flash_area_align(const struct flash_area *fa);
 
int flash_area_get_sectors(int fa_id, uint32_t *count,
                           struct flash_sector *sectors);
 
typedef void (*flash_area_cb_t)(const struct flash_area *fa,
                                void *user_data);
 
void flash_area_foreach(flash_area_cb_t user_cb, void *user_data);
 
int flash_area_has_driver(const struct flash_area *fa);
 
const struct device *flash_area_get_device(const struct flash_area *fa);
 
#if CONFIG_FLASH_MAP_LABELS
const char *flash_area_label(const struct flash_area *fa);
#endif
 
uint8_t flash_area_erased_val(const struct flash_area *fa);
 
#define FLASH_AREA_LABEL_EXISTS(label) __DEPRECATED_MACRO \
        DT_HAS_FIXED_PARTITION_LABEL(label)
 
#define FLASH_AREA_LABEL_STR(lbl) __DEPRECATED_MACRO \
        DT_PROP(DT_NODE_BY_FIXED_PARTITION_LABEL(lbl), label)
 
#define FLASH_AREA_ID(label) __DEPRECATED_MACRO \
        DT_FIXED_PARTITION_ID(DT_NODE_BY_FIXED_PARTITION_LABEL(label))
 
#define FLASH_AREA_OFFSET(label) __DEPRECATED_MACRO \
        DT_REG_ADDR(DT_NODE_BY_FIXED_PARTITION_LABEL(label))
 
#define FLASH_AREA_SIZE(label) __DEPRECATED_MACRO \
        DT_REG_SIZE(DT_NODE_BY_FIXED_PARTITION_LABEL(label))
 
#define FIXED_PARTITION_EXISTS(label) DT_FIXED_PARTITION_EXISTS(DT_NODELABEL(label))
 
#define FIXED_PARTITION_ID(label) DT_FIXED_PARTITION_ID(DT_NODELABEL(label))
 
#define FIXED_PARTITION_OFFSET(label) DT_REG_ADDR(DT_NODELABEL(label))
 
#define FIXED_PARTITION_SIZE(label) DT_REG_SIZE(DT_NODELABEL(label))
 
#define FLASH_AREA_DEVICE(label) \
        DEVICE_DT_GET(DT_MTD_FROM_FIXED_PARTITION(DT_NODE_BY_FIXED_PARTITION_LABEL(label)))
 
#define FIXED_PARTITION_DEVICE(label) \
        DEVICE_DT_GET(DT_MTD_FROM_FIXED_PARTITION(DT_NODELABEL(label)))
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_STORAGE_FLASH_MAP_H_ */