alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

docs: fix return error of ota docs and fix ota.rst

Browse Source
This commit is contained in:
tzx 2016-11-30 18:19:23 +08:00 committed by Wu Jian Gang
parent 59f3684dee
commit 9b2cad4174
2 changed files with 15 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
components/app_update/include/esp_ota_ops.h
View File

@ -49,9 +49,10 @@ typedef uint32_t esp_ota_handle_t;
* @param image_size size of image need to be updated * @param image_size size of image need to be updated
* @param out_handle handle which should be used for esp_ota_write or esp_ota_end call * @param out_handle handle which should be used for esp_ota_write or esp_ota_end call
* @return: ESP_OK if format ota image OK * @return:
* ESP_ERR_OTA_PARTITION_CONFLICT operate current running bin * - ESP_OK: if format ota image OK
* ESP_ERR_OTA_SELECT_INFO_INVALID ota bin select info invalid * - ESP_ERR_OTA_PARTITION_CONFLICT: operate current running bin
* - ESP_ERR_OTA_SELECT_INFO_INVALID: ota bin select info invalid
*/ */
esp_err_t esp_ota_begin(const esp_partition_t* partition, size_t image_size, esp_ota_handle_t* out_handle); esp_err_t esp_ota_begin(const esp_partition_t* partition, size_t image_size, esp_ota_handle_t* out_handle);
@ -62,9 +63,10 @@ esp_err_t esp_ota_begin(const esp_partition_t* partition, size_t image_size, esp
* @param data Pointer to data write to flash * @param data Pointer to data write to flash
* @param size data size of recieved data * @param size data size of recieved data
* *
* @return: ESP_OK if write flash data OK * @return:
* ESP_ERR_OTA_PARTITION_CONFLICT operate current running bin * - ESP_OK: if write flash data OK
* ESP_ERR_OTA_SELECT_INFO_INVALID ota bin select info invalid * - ESP_ERR_OTA_PARTITION_CONFLICT: operate current running bin
* - ESP_ERR_OTA_SELECT_INFO_INVALID: ota bin select info invalid
*/ */
esp_err_t esp_ota_write(esp_ota_handle_t handle, const void* data, size_t size); esp_err_t esp_ota_write(esp_ota_handle_t handle, const void* data, size_t size);
@ -73,8 +75,9 @@ esp_err_t esp_ota_write(esp_ota_handle_t handle, const void* data, size_t size);
* *
* @param handle Handle obtained from esp_ota_begin * @param handle Handle obtained from esp_ota_begin
* *
* @return: ESP_OK if validate ota image pass * @return:
* ESP_ERR_OTA_VALIDATE_FAILED validate the ota image is invalid * - ESP_OK: if validate ota image pass
* - ESP_ERR_OTA_VALIDATE_FAILED: validate the ota image is invalid
*/ */
esp_err_t esp_ota_end(esp_ota_handle_t handle); esp_err_t esp_ota_end(esp_ota_handle_t handle);
@ -86,8 +89,9 @@ esp_err_t esp_ota_end(esp_ota_handle_t handle);
* *
* @param partition Pointer to partition structure which need to boot * @param partition Pointer to partition structure which need to boot
* *
* @return: ESP_OK if set next boot partition OK * @return:
* ESP_ERR_OTA_SELECT_INFO_INVALID ota bin select info invalid * - ESP_OK: if set next boot partition OK
* - ESP_ERR_OTA_SELECT_INFO_INVALID: ota bin select info invalid
*/ */
esp_err_t esp_ota_set_boot_partition(const esp_partition_t* partition); esp_err_t esp_ota_set_boot_partition(const esp_partition_t* partition);

16
docs/api/ota.rst
View File

@ -1,30 +1,16 @@
OTA OTA
=== ===
Overview
--------
`Instructions`_
Application Example
-------------------
`Instructions`_
API Reference API Reference
------------- -------------
`Instructions`_
.. _Instructions: template.html
Header Files Header Files
^^^^^^^^^^^^ ^^^^^^^^^^^^
* `app_update/include/esp_ota_ops.h <https://github.com/espressif/esp-idf/blob/master/components/app_update/include/esp_ota_ops.h>`_ * `app_update/include/esp_ota_ops.h <https://github.com/espressif/esp-idf/blob/master/components/app_update/include/esp_ota_ops.h>`_
Macros Macros
------ ^^^^^^
.. doxygendefine:: ESP_ERR_OTA_BASE .. doxygendefine:: ESP_ERR_OTA_BASE
.. doxygendefine:: ESP_ERR_OTA_PARTITION_CONFLICT .. doxygendefine:: ESP_ERR_OTA_PARTITION_CONFLICT