commit ca37494f09dc3d31e3f6aadb9a5a169bc6c59ae1
author Pieter De Gendt <pieter.degendt@basalte.be> Mon Oct 27 12:09:24 2025 +0100
committer Johan Hedberg <johan.hedberg@gmail.com> Wed Oct 29 13:47:30 2025 +0200
tree c411db887d301dcffbfd58c3745258dc69415441
parent a02414a9bceeb46dc8b64812cbb85e8eaf0425da

include: zephyr: nvmem: Add retval doxygen to read/write functions

Document the return values for the read/write NVMEM functions.

Signed-off-by: Pieter De Gendt <pieter.degendt@basalte.be>

include/zephyr/nvmem.h

diff --git a/include/zephyr/nvmem.h b/include/zephyr/nvmem.h
index ae422bc..1e7774e 100644
--- a/include/zephyr/nvmem.h
+++ b/include/zephyr/nvmem.h
@@ -316,7 +316,9 @@
  *
  * @kconfig_dep{CONFIG_NVMEM}
  *
- * @return 0 on success, negative errno code on failure.
+ * @retval -EINVAL Invalid offset or length arguments.
+ * @retval -ENXIO  No runtime device API available.
+ * @return the result of the underlying device API call.
  */
 int nvmem_cell_read(const struct nvmem_cell *cell, void *data, off_t off, size_t len);
 
@@ -330,7 +332,10 @@
  *
  * @kconfig_dep{CONFIG_NVMEM}
  *
- * @return 0 on success, negative errno code on failure.
+ * @retval -EINVAL Invalid offset or length arguments.
+ * @retval -EROFS  Writing to a read-only NVMEM Cell.
+ * @retval -ENXIO  No runtime device API available.
+ * @return the result of the underlying device API call.
  */
 int nvmem_cell_write(const struct nvmem_cell *cell, const void *data, off_t off, size_t len);