OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity

include/drivers/flash: document on the unrestricted source buffers 

Document unrestricted source buffer location while writing to
the flash.

Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
This commit is contained in:
Andrzej Puzdrowski 2020-08-05 16:54:17 +02:00 committed by Anas Nashif
parent 1d8cf859db
commit 4d4455b174
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
include/drivers/flash.h
View File

@ -120,6 +120,10 @@ static inline int z_impl_flash_read(struct device *dev, off_t offset, void *data
/**
* @brief Write buffer into flash memory.
*
* All flash drivers support a source buffer located either in RAM or
* SoC flash, without alignment restrictions on the source address, or
* write size or offset.
*
* Prior to the invocation of this API, the flash_write_protection_set needs
* to be called first to disable the write protection.
*