docs(ota): Document additional errs returned by esp_ota_write

Squashed commit of the following: commit f47a894 Author: Lucian Popescu <[email protected]> Date: Fri May 10 10:44:17 2024 +0300 Update correct codes for esp_ota_write Co-authored-by: Harshit Malpani <[email protected]> commit ea407fb Author: Lucian Popescu <[email protected]> Date: Wed May 8 14:06:37 2024 +0300 docs(ota): Document additional errs returned by esp_ota_write
espressif · May 10, 2024 · 6a8d3af · 6a8d3af
1 parent d4cd437
commit 6a8d3af
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/components/app_update/include/esp_ota_ops.h b/components/app_update/include/esp_ota_ops.h
@@ -116,6 +116,8 @@ esp_err_t esp_ota_begin(const esp_partition_t* partition, size_t image_size, esp
  *    - ESP_ERR_OTA_VALIDATE_FAILED: First byte of image contains invalid app image magic byte.
  *    - ESP_ERR_FLASH_OP_TIMEOUT or ESP_ERR_FLASH_OP_FAIL: Flash write failed.
  *    - ESP_ERR_OTA_SELECT_INFO_INVALID: OTA data partition has invalid contents
+ *    - ESP_ERR_INVALID_SIZE: if write would go out of bounds of the partition
+ *    - or one of error codes from lower-level flash driver.
  */
 esp_err_t esp_ota_write(esp_ota_handle_t handle, const void* data, size_t size);