Skip to content
Permalink
Browse files

drivers/flash: add read alignment requirement comment

Added note on read alignment requirement in order to make
a user more conscious of restrictions.

Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
  • Loading branch information...
nvlsianpu authored and ioannisg committed Jul 12, 2019
1 parent 108a4b3 commit 743f3dbae0579e33c28c4c0a8bb1d20555c4d514
Showing with 4 additions and 0 deletions.
  1. +4 −0 include/drivers/flash.h
@@ -84,6 +84,10 @@ struct flash_driver_api {
/**
* @brief Read data from flash
*
* Most of flash drivers support unaligned flash access, but some have
* restrictions on the read offset or/and the read size. Please refer to
* the driver implementation to get details on the read alignment requirement.
*
* @param dev : flash dev
* @param offset : Offset (byte aligned) to read
* @param data : Buffer to store read data

0 comments on commit 743f3db

Please sign in to comment.
You can’t perform that action at this time.