Skip to content

Commit 2258dcb

Browse files
de-nordicnashif
authored andcommitted
drivers/flash: Add missing documentation for flash_fill
Add the missing flash_fill documentation. Fixes #74407 Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
1 parent 78b93fe commit 2258dcb

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

include/zephyr/drivers/flash.h

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -320,6 +320,21 @@ static inline int z_impl_flash_erase(const struct device *dev, off_t offset,
320320
return rc;
321321
}
322322

323+
/**
324+
* @brief Fill selected range of device with specified value
325+
*
326+
* Utility function that allows to fill specified range on a device with
327+
* provided value. The @p offset and @p size of range need to be aligned to
328+
* a write block size of a device.
329+
*
330+
* @param dev : flash device
331+
* @param val : value to use for filling the range
332+
* @param offset : offset of the range to fill
333+
* @param size : size of the range
334+
*
335+
* @return 0 on success, negative errno code on fail.
336+
*
337+
*/
323338
__syscall int flash_fill(const struct device *dev, uint8_t val, off_t offset, size_t size);
324339

325340
/**

0 commit comments

Comments
 (0)