mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-08-13 17:36:02 +00:00
f8a674b45e
Moved fetch of flash device bindings to early initialization of the application. Device bindings are constant while the application is running so it is better to fetch it at startup, and not every time flash_map procedures are called. Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
85 lines
2.1 KiB
C
85 lines
2.1 KiB
C
/*
|
|
* Copyright (c) 2017 Nordic Semiconductor ASA
|
|
* Copyright (c) 2015 Runtime Inc
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
#ifndef __FLASH_MAP_H__
|
|
#define __FLASH_MAP_H__
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
*
|
|
* Provides abstraction of flash regions for type of use.
|
|
* I.e. dude where's my image?
|
|
*
|
|
* System will contain a map which contains flash areas. Every
|
|
* region will contain flash identifier, offset within flash and length.
|
|
*
|
|
* 1. This system map could be in a file within filesystem (Initializer
|
|
* must know/figure out where the filesystem is at).
|
|
* 2. Map could be at fixed location for project (compiled to code)
|
|
* 3. Map could be at specific place in flash (put in place at mfg time).
|
|
*
|
|
* Note that the map you use must be valid for BSP it's for,
|
|
* match the linker scripts when platform executes from flash,
|
|
* and match the target offset specified in download script.
|
|
*/
|
|
#include <zephyr/types.h>
|
|
#include <stddef.h>
|
|
#include <sys/types.h>
|
|
|
|
#define SOC_FLASH_0_ID 0 /* device_id for SoC flash memory driver */
|
|
#define SPI_FLASH_0_ID 1 /* device_id for external SPI flash driver */
|
|
|
|
struct flash_area {
|
|
u8_t fa_id;
|
|
u8_t fa_device_id;
|
|
u16_t pad16;
|
|
off_t fa_off;
|
|
size_t fa_size;
|
|
};
|
|
|
|
struct flash_sector {
|
|
off_t fs_off;
|
|
size_t fs_size;
|
|
};
|
|
|
|
/*
|
|
* Start using flash area.
|
|
*/
|
|
int flash_area_open(u8_t id, const struct flash_area **fa);
|
|
|
|
void flash_area_close(const struct flash_area *fa);
|
|
|
|
/*
|
|
* Read/write/erase. Offset is relative from beginning of flash area.
|
|
*/
|
|
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);
|
|
/* int flash_area_is_empty(const struct flash_area *, bool *); */
|
|
|
|
/*
|
|
* Alignment restriction for flash writes.
|
|
*/
|
|
u8_t flash_area_align(const struct flash_area *fa);
|
|
|
|
/*
|
|
* Given flash area ID, return info about sectors within the area.
|
|
*/
|
|
int flash_area_get_sectors(int fa_id, uint32_t *count,
|
|
struct flash_sector *sectors);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __FLASH_MAP_H__ */
|