Documentation

Mistake on this page? Email us
Data Fields
fota_component_desc_info_t Struct Reference

#include <fota_component.h>

Data Fields

uint32_t install_alignment
 
bool support_delta
 
bool need_reboot
 
fota_candidate_iterate_handler_t candidate_iterate_cb
 
fota_component_verify_install_handler_t component_verify_install_cb
 
fota_component_curr_fw_read curr_fw_read
 
fota_component_curr_fw_get_digest curr_fw_get_digest
 

Detailed Description

Component description information.

Parameters
install_alignmentThe preferred installer fragment size. Typically equal to the flash program size.
support_deltaSpecify whether the component supports differential (delta) update.
need_rebootSpecify whether the component requires system reboot after the component installation has completed. Only true parameter is currently supported.
candidate_iterate_cbA callback function the FOTA client calls for installing the candidate. The FOTA client calls the callback iteratively with a firmware fragment buffer pointer as an argument. Note: For Linux systems, this iterative callback is replaced by fota_app_on_install_candidate().
component_verify_install_cbA callback function to be executed after installation, verifying installation.
curr_fw_readOnly required if ::support delta is set to true. A helper function for reading the currently installed firmware of the component. A callback to read the current firmware.
curr_fw_get_digestOnly required if ::support delta is set to true. A helper function for calculating the SHA256 digest of the currently installed firmware of the component. A callback to get the current firmware digest.
The documentation for this struct was generated from the following file: