From 37d9a3c183cc1900e797fac8b0dcbe8043ff54ae Mon Sep 17 00:00:00 2001
From: Lucian Popescu <lucian.popescu187@gmail.com>
Date: Fri, 10 May 2024 12:48:36 +0300
Subject: [PATCH] docs(ota): Document additional errs returned by esp_ota_write

Squashed commit of the following:

commit f47a894231168298f9763642e7d421ebd5e7dc46
Author: Lucian Popescu <lucian.popescu187@gmail.com>
Date:   Fri May 10 10:44:17 2024 +0300

    Update correct codes for esp_ota_write

    Co-authored-by: Harshit Malpani <65167938+hmalpani@users.noreply.github.com>

commit ea407fb82ec75a2e666713607e8892f0ffa91556
Author: Lucian Popescu <lucian.popescu187@gmail.com>
Date:   Wed May 8 14:06:37 2024 +0300

    docs(ota): Document additional errs returned by esp_ota_write
---
 components/app_update/include/esp_ota_ops.h | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/components/app_update/include/esp_ota_ops.h b/components/app_update/include/esp_ota_ops.h
index 7ff948b25d1..ec2c633d536 100644
--- 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);