Actions_3085S4_V2/framework/ota/include/ota_upgrade.h

/*
 * Copyright (c) 2019 Actions Semiconductor Co., Ltd
 *
 * SPDX-License-Identifier: Apache-2.0
 */

/**
 * @file
 * @brief OTA upgrade interface
 */

#ifndef __OTA_UPGRADE_H__
#define __OTA_UPGRADE_H__

struct ota_upgrade_info;
struct ota_backend;

/** ota state */
enum ota_state
{
	OTA_INIT = 0,
	OTA_RUNNING,
	OTA_DONE,
	OTA_FAIL,
};

typedef void (*ota_notify_t)(int state, int old_state);
typedef void (*ota_ugrade_file_cb)(uint8_t file_id);

/** structure of ota upgrade param, Initialized by the user*/
struct ota_upgrade_param {
	const char *storage_name;
#ifdef CONFIG_OTA_MUTIPLE_STORAGE
	const char *storage_ext_name;
#endif
	ota_notify_t notify;
	ota_ugrade_file_cb file_cb;

	/* flags */
	unsigned int flag_use_recovery:1;	/* use recovery */
	unsigned int flag_use_recovery_app:1;	/* use recovery app */
	unsigned int no_version_control:1; /* OTA without version control */
	unsigned int flag_erase_part_for_upg:1; /* OTA upgrade erase part for upg*/
	unsigned int flag_keep_temp_part:1; /* OTA don't erase temp on init */
};

/**
 * @brief ota upgrade init funcion
 *
 * This routine calls init ota upgrade,called by ota app
 *
 * @param param init ota struct
 *
 * @return pointer to ota struct address.
 * @return NULL if init failed.
 */

struct ota_upgrade_info *ota_upgrade_init(struct ota_upgrade_param *param);

/**
 * @brief ota check and upgrade funcion
 *
 * This routine calls to do ota upgrade ,called by ota app
 *
 * @param ota pointer to the ota upgrade structure
 *
 * @return 0 if upgrade success.
 * @return others if init failed.
 */

int ota_upgrade_check(struct ota_upgrade_info *ota);

/**
 * @brief check the progress of ota
 *
 * This routine calls to check ota progress ,called by recovery_main
 *
 * @param ota pointer to the ota upgrade structure
 *
 * @return 0 if no in progress.
 * @return 1 if in progress.
 */

int ota_upgrade_is_in_progress(struct ota_upgrade_info *ota);

/**
 * @brief set the progress state of ota
 *
 * This routine calls to set ota progress state ,called by recovery_main
 *
 * @param ota pointer to the ota upgrade structure
 *
 * @return 0 if attach success.
 * @return others if attach fail.
 */
int ota_upgrade_set_in_progress(struct ota_upgrade_info *ota);

/**
 * @brief attach backend to ota
 *
 * This routine calls to attach backend to ota ,called by ota app
 *
 * @param ota pointer to the ota upgrade structure
 * @param backend pointer to backend structure
 * @return 0 if attach success.
 * @return others if attach fail.
 */

int ota_upgrade_attach_backend(struct ota_upgrade_info *ota, struct ota_backend *backend);

/**
 * @brief detach backend to ota
 *
 * This routine calls to detach backend to ota ,called by ota app for the end of ota
 *
 * @param ota pointer to the ota upgrade structure
 * @param backend pointer to backend structure
 */

void ota_upgrade_detach_backend(struct ota_upgrade_info *ota, struct ota_backend *backend);

#if defined(CONFIG_OTA_PRODUCT_SUPPORT) || defined(CONFIG_OTA_BLE_MASTER_SUPPORT)
struct ota_host_upgrade_info;
struct ota_trans;
struct ota_upgrade_image_info;
struct ota_host_upgrade_info *ota_host_upgrade_init(struct ota_upgrade_param *param);
void ota_host_upgrade_exit(struct ota_host_upgrade_info *ota);
int ota_host_upgrade_attach_backend(struct ota_host_upgrade_info *ota, struct ota_backend *backend);
void ota_host_upgrade_detach_backend(struct ota_host_upgrade_info *ota, struct ota_backend *backend);
int ota_host_upgrade_send_image(struct ota_host_upgrade_info *ota,int offset,int len);
int ota_host_upgrade_check(struct ota_host_upgrade_info *ota);
int ota_host_upgrade_attach_trans(struct ota_host_upgrade_info *ota, struct ota_trans *trans);
void ota_host_update_state(struct ota_host_upgrade_info *ota, enum ota_state state);
u32_t ota_host_upgrade_get_image_size(struct ota_host_upgrade_info *ota);
u32_t ota_host_upgrade_get_image_ver(struct ota_host_upgrade_info *ota);
u32_t ota_host_upgrade_get_head_crc(struct ota_host_upgrade_info *ota);
#endif

#endif /* __OTA_UPGRADE_H__ */