fota_component.h

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// Copyright 2019-2021 Pelion Ltd.
//
// SPDX-License-Identifier: Apache-2.0
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// ----------------------------------------------------------------------------

#ifndef __FOTA_COMPONENT_H_
#define __FOTA_COMPONENT_H_

#include "fota/fota_base.h"

#if defined(MBED_CLOUD_CLIENT_FOTA_ENABLE)

#include "fota/fota_component_defs.h"
#include "fota/fota_crypto_defs.h"
#include "fota/fota_candidate.h"
#include "fota/fota_header_info.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef int (*fota_component_curr_fw_read)(uint8_t *buf, size_t offset, size_t size, size_t *num_read);

typedef int (*fota_component_curr_fw_get_digest)(uint8_t *buf);

typedef int (*fota_component_verify_install_handler_t)(const char *comp_name, const fota_header_info_t *expected_header_info);


typedef struct {
    uint32_t install_alignment;
    bool support_delta;
    bool need_reboot;
#if !defined(TARGET_LIKE_LINUX)
    fota_candidate_iterate_handler_t candidate_iterate_cb;
#endif
    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;
} fota_component_desc_info_t;

int fota_component_add(const fota_component_desc_info_t *comp_desc, const char *comp_name, const char *comp_semver);

int fota_component_version_int_to_semver(fota_component_version_t version, char *sem_ver);

#ifdef __cplusplus
}
#endif

#endif // defined(MBED_CLOUD_CLIENT_FOTA_ENABLE)
#endif // __FOTA_COMPONENT_H_