j3d1/esp-open-rtos
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

spi_flash.h: Add note that pointers need to be word-aligned

Browse source
This commit is contained in:
Angus Gratton 2016-03-10 15:59:36 +11:00
parent b304f65c21
commit b9f8e8a648
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
include/espressif/spi_flash.h
View file

@ -31,7 +31,7 @@ sdk_SpiFlashOpResult sdk_spi_flash_erase_sector(uint16_t sec);
/* Write data to flash. /* Write data to flash.
des_addr is byte offset to write to. Should be 4-byte aligned. des_addr is byte offset to write to. Should be 4-byte aligned.
src is pointer to a buffer to read bytes from. src is pointer to a buffer to read bytes from. Should be 4-byte aligned.
size is length of buffer in bytes. Should be a multiple of 4. size is length of buffer in bytes. Should be a multiple of 4.
*/ */
sdk_SpiFlashOpResult sdk_spi_flash_write(uint32_t des_addr, const void *src, uint32_t size); sdk_SpiFlashOpResult sdk_spi_flash_write(uint32_t des_addr, const void *src, uint32_t size);
@ -39,7 +39,7 @@ sdk_SpiFlashOpResult sdk_spi_flash_write(uint32_t des_addr, const void *src, uin
/* Read data from flash. /* Read data from flash.
src_addr is byte offset to read from. Should be 4-byte aligned. src_addr is byte offset to read from. Should be 4-byte aligned.
des is pointer to a buffer to read bytes into. des is pointer to a buffer to read bytes into. Should be 4-byte aligned.
size is number of bytes to read. Should be a multiple of 4. size is number of bytes to read. Should be a multiple of 4.
*/ */
sdk_SpiFlashOpResult sdk_spi_flash_read(uint32_t src_addr, void *des, uint32_t size); sdk_SpiFlashOpResult sdk_spi_flash_read(uint32_t src_addr, void *des, uint32_t size);