golioth_fw_update.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022 Golioth, Inc.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
#pragma once
 
#include "golioth.h"
#include <stdbool.h>
 
#define GOLIOTH_FW_UPDATE_DEFAULT_PACKAGE_NAME "main"
 
typedef struct {
    const char* current_version;
    const char* fw_package_name;
} golioth_fw_update_config_t;
 
 
void golioth_fw_update_init(golioth_client_t client, const char* current_version);
 
void golioth_fw_update_init_with_config(
        golioth_client_t client,
        const golioth_fw_update_config_t* config);
 
typedef void (*golioth_fw_update_state_change_callback)(
        golioth_ota_state_t state,
        golioth_ota_reason_t reason,
        void* user_arg);
 
void golioth_fw_update_register_state_change_callback(
        golioth_fw_update_state_change_callback callback,
        void* user_arg);
 
//---------------------------------------------------------------------------
// Backend API for firmware updates. Required to be implemented by port.
// Not intended to be called by user code.
//---------------------------------------------------------------------------
 
bool fw_update_is_pending_verify(void);
 
void fw_update_rollback(void);
 
void fw_update_reboot(void);
 
void fw_update_cancel_rollback(void);
 
golioth_status_t fw_update_handle_block(
        const uint8_t* block,
        size_t block_size,
        size_t offset,
        size_t total_size);
 
golioth_status_t fw_update_read_current_image_at_offset(
        uint8_t* buf,
        size_t bufsize,
        size_t offset);
 
void fw_update_post_download(void);
 
golioth_status_t fw_update_validate(void);
 
golioth_status_t fw_update_change_boot_image(void);
 
void fw_update_end(void);
//---------------------------------------------------------------------------