RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

drivers/mtd: update docs to match implementation

Browse Source 
some parts reported retvals of number of bytes written, when it should be 0 on success.
This commit is contained in:
Kasper Hjort Berthelsen 2024-03-13 14:35:19 +01:00
parent 102adbb856
commit 9ba76c38be
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
drivers/include/mtd.h
View File

@ -363,7 +363,7 @@ int mtd_read(mtd_dev_t *mtd, void *dest, uint32_t addr, uint32_t count);
* @param[in] offset offset from the start of the page (in bytes)
* @param[in] size the number of bytes to read
*
* @retval n number of bytes read on success
* @retval 0 on success
* @retval <0 value on error
* @retval -ENODEV if @p mtd is not a valid device
* @retval -ENOTSUP if operation is not supported on @p mtd
@ -412,7 +412,7 @@ int mtd_write(mtd_dev_t *mtd, const void *src, uint32_t addr, uint32_t count);
* @param[in] offset byte offset from the start of the page
* @param[in] size the number of bytes to write
*
* @retval n number of bytes written on success
* @retval 0 on success
* @retval <0 value on error
* @retval -ENODEV if @p mtd is not a valid device
* @retval -ENOTSUP if operation is not supported on @p mtd
@ -442,7 +442,7 @@ int mtd_write_page_raw(mtd_dev_t *mtd, const void *src, uint32_t page,
* @param[in] offset byte offset from the start of the page
* @param[in] size the number of bytes to write
*
* @retval n number of bytes written on success
* @retval 0 on success
* @retval <0 value on error
* @retval -ENODEV if @p mtd is not a valid device
* @retval -ENOTSUP if operation is not supported on @p mtd
@ -500,7 +500,7 @@ int mtd_erase_sector(mtd_dev_t *mtd, uint32_t sector, uint32_t num);
* @param[in] sector Sector number to start writing to
* @param[in] num Number of sectors to write
*
* @retval n number of bytes written on success
* @retval 0 on success
* @retval <0 value on error
* @retval -ENODEV if @p mtd is not a valid device
* @retval -ENOTSUP if operation is not supported on @p mtd