fota_candidate.h

// ----------------------------------------------------------------------------
// 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_CANDIDATE_H_
#define __FOTA_CANDIDATE_H_

#include "fota/fota_base.h"

#if defined(MBED_CLOUD_CLIENT_FOTA_ENABLE)

#include "fota/fota_header_info.h"
#include "fota/fota_crypto_defs.h"
#include "fota/fota_comp_callbacks.h"

#ifdef __cplusplus
extern "C" {
#endif

// Block checksum (in case of resume and non encrypted blocks)
typedef uint16_t fota_candidate_block_checksum_t;

typedef struct {
    fota_candidate_iterate_status status;
    size_t frag_size;
    size_t frag_pos;
    uint8_t  *frag_buf;
    fota_header_info_t *header_info;
    void *user_ctx;
} fota_candidate_iterate_callback_info;

typedef struct {
    size_t    storage_size;
    size_t    storage_start_addr;
} fota_candidate_config_t;

void fota_candidate_set_config(fota_candidate_config_t *in_fota_candidate_config);

const fota_candidate_config_t *fota_candidate_get_config(void);

fota_deprecated typedef int (*fota_candidate_iterate_handler_t)(fota_candidate_iterate_callback_info *info);

#define FOTA_CANDIDATE_SKIP_VALIDATION 0x27

int fota_candidate_iterate_image_backward_support(uint8_t validate, bool force_encrypt, const char *expected_comp_name,
                                 uint32_t install_alignment, fota_candidate_iterate_handler_t handler);

int fota_candidate_iterate_image(uint8_t validate, bool force_encrypt, const char *expected_comp_name,
                                 uint32_t install_alignment, fota_candidate_iterate_handler_t handler, fota_comp_install_cb_t component_install_cb);

int fota_candidate_read_candidate_ready_header(size_t *addr, uint32_t bd_read_size, uint32_t bd_prog_size,
                                               fota_candidate_ready_header_t *header);

int fota_candidate_read_header(size_t *addr, uint32_t bd_read_size, uint32_t bd_prog_size, fota_header_info_t *header);

int fota_candidate_erase(void);

#ifdef __cplusplus
}
#endif

#endif // defined(MBED_CLOUD_CLIENT_FOTA_ENABLE)

#endif // __FOTA_CANDIDATE_H_