#include "legato.h"
#include "taf_update_common.h"

Functions
le_msg_ServiceRef_t	taf_update_GetServiceRef (void)

le_msg_SessionRef_t	taf_update_GetClientSessionRef (void)

void	taf_update_AdvertiseService (void)

taf_update_StateHandlerRef_t	taf_update_AddStateHandler (taf_update_StateHandlerFunc_t handlerPtr, void *contextPtr)

void	taf_update_RemoveStateHandler (taf_update_StateHandlerRef_t handlerRef)

void	taf_update_Download (void)

le_result_t	taf_update_Install (taf_update_OTA_t ota, const char *LE_NONNULL name)

le_result_t	taf_update_GetDownloadSession (const char LE_NONNULL cfgFile, taf_update_SessionRef_t sessionPtr)

le_result_t	taf_update_StartDownload (taf_update_SessionRef_t session)

le_result_t	taf_update_PauseDownload (taf_update_SessionRef_t session)

le_result_t	taf_update_ResumeDownload (taf_update_SessionRef_t session)

le_result_t	taf_update_CancelDownload (taf_update_SessionRef_t session)

le_result_t	taf_update_GetInstallationSession (taf_update_PackageType_t pkgType, const char LE_NONNULL cfgFile, taf_update_SessionRef_t sessionPtr)

le_result_t	taf_update_InstallPreCheck (taf_update_SessionRef_t session, const char *LE_NONNULL manifest)

le_result_t	taf_update_StartInstall (taf_update_SessionRef_t session, const char *LE_NONNULL pkgPath)

le_result_t	taf_update_InstallPostCheck (taf_update_SessionRef_t session)

le_result_t	taf_update_GetActiveBank (taf_update_SessionRef_t session, taf_update_Bank_t *bankPtr)

le_result_t	taf_update_VerifyActivation (taf_update_SessionRef_t session, const char *LE_NONNULL manifest)

le_result_t	taf_update_Rollback (taf_update_SessionRef_t session)

le_result_t	taf_update_Sync (taf_update_SessionRef_t session)

Function Documentation

◆ taf_update_GetServiceRef()

le_msg_ServiceRef_t taf_update_GetServiceRef ( void )

Get the server service reference

◆ taf_update_GetClientSessionRef()

le_msg_SessionRef_t taf_update_GetClientSessionRef ( void )

Get the client session reference for the current message

◆ taf_update_AdvertiseService()

void taf_update_AdvertiseService ( void )

Initialize the server and advertise the service.

◆ taf_update_AddStateHandler()

taf_update_StateHandlerRef_t taf_update_AddStateHandler	(	taf_update_StateHandlerFunc_t	handlerPtr,
		void *	contextPtr
	)

Update session reference. Update states. Error codes. OTA workflows. Update package type. Bank enum. Update state indication structure. Handler for update state. Reference type used by Add/Remove functions for EVENT 'taf_update_State' Add handler function for EVENT 'taf_update_State'

Event to report update progress.

Add handler function for EVENT 'taf_update_State'

Event to report update progress.

Parameters

[in]	handlerPtr	Handler for update state.
[in]	contextPtr

◆ taf_update_RemoveStateHandler()

void taf_update_RemoveStateHandler ( taf_update_StateHandlerRef_t handlerRef )

Remove handler function for EVENT 'taf_update_State'

Parameters

[in] handlerRef

◆ taf_update_Download()

void taf_update_Download ( void )

Downloads an OTA package from a cloud server.

Note: Update service will parse the download package and remove the QOTA header once the download is complete.

◆ taf_update_Install()

le_result_t taf_update_Install	(	taf_update_OTA_t	ota,
		const char *LE_NONNULL	name
	)

Installs an OTA package on the target device.

Note: QOTA header should be removed before calling this API.

Returns

LE_FAULT – Failed.
LE_OK – Succeeded.

Parameters

[in]	ota	OTA workflow.
[in]	name	OTA package name.

◆ taf_update_GetDownloadSession()

le_result_t taf_update_GetDownloadSession	(	const char *LE_NONNULL	cfgFile,
		taf_update_SessionRef_t *	sessionPtr
	)

Gets download session.

Returns

LE_FAULT – Failed.
LE_OK – Succeeded.

Parameters

[in]	cfgFile	Configuration file for download session.
[out]	sessionPtr	Download session reference.

◆ taf_update_StartDownload()

le_result_t taf_update_StartDownload ( taf_update_SessionRef_t session )

Starts download.

Returns

LE_FAULT – Failed.
LE_OK – Succeeded.

Parameters

[in] session Download session reference.

◆ taf_update_PauseDownload()

le_result_t taf_update_PauseDownload ( taf_update_SessionRef_t session )

Pauses download.

Returns

LE_FAULT – Failed.
LE_OK – Succeeded.

Parameters

[in] session Download session reference.

◆ taf_update_ResumeDownload()

le_result_t taf_update_ResumeDownload ( taf_update_SessionRef_t session )

Resumes download.

Returns

LE_FAULT – Failed.
LE_OK – Succeeded.

Parameters

[in] session Download session reference.

◆ taf_update_CancelDownload()

le_result_t taf_update_CancelDownload ( taf_update_SessionRef_t session )

Cancels download.

Returns

LE_FAULT – Failed.
LE_OK – Succeeded.

Parameters

[in] session Download session reference.

◆ taf_update_GetInstallationSession()

le_result_t taf_update_GetInstallationSession	(	taf_update_PackageType_t	pkgType,
		const char *LE_NONNULL	cfgFile,
		taf_update_SessionRef_t *	sessionPtr
	)

Gets installation session.

Returns

LE_FAULT – Failed.
LE_OK – Succeeded.

Parameters

[in]	pkgType	Package type for installation.
[in]	cfgFile	Configuration file for installation session.
[out]	sessionPtr	Installation session reference.

◆ taf_update_InstallPreCheck()

le_result_t taf_update_InstallPreCheck	(	taf_update_SessionRef_t	session,
		const char *LE_NONNULL	manifest
	)

Checks prerequisites for installation.

Returns

LE_FAULT – Failed.
LE_OK – Succeeded.

Parameters

[in]	session	Installation session reference.
[in]	manifest	Manifest for pre-check.

◆ taf_update_StartInstall()

le_result_t taf_update_StartInstall	(	taf_update_SessionRef_t	session,
		const char *LE_NONNULL	pkgPath
	)

Start installation.

Returns

LE_FAULT – Failed.
LE_OK – Succeeded.

Parameters

[in]	session	Installation session reference.
[in]	pkgPath	Package path.

◆ taf_update_InstallPostCheck()

le_result_t taf_update_InstallPostCheck ( taf_update_SessionRef_t session )

Verification post installation, check if flashing properly on inactive bank.

Returns

LE_FAULT – Failed.
LE_OK – Succeeded.

Parameters

[in] session Installation session reference.

◆ taf_update_GetActiveBank()

le_result_t taf_update_GetActiveBank	(	taf_update_SessionRef_t	session,
		taf_update_Bank_t *	bankPtr
	)

Gets the active bank.

Returns

LE_FAULT – Failed.
LE_OK – Succeeded.

Parameters

[in]	session	Installation session reference.
[out]	bankPtr	The active bank.

◆ taf_update_VerifyActivation()

le_result_t taf_update_VerifyActivation	(	taf_update_SessionRef_t	session,
		const char *LE_NONNULL	manifest
	)

Activation verification, check if each component has the updated version.

Returns

LE_FAULT – Failed.
LE_OK – Succeeded.

Parameters

[in]	session	Installation session reference.
[in]	manifest	Manifest for activation verification.

◆ taf_update_Rollback()

le_result_t taf_update_Rollback ( taf_update_SessionRef_t session )

Rollback to previous configurations to keep pesistency.

Returns

LE_FAULT – Failed.
LE_OK – Succeeded.

Parameters

[in] session Installation session reference.

◆ taf_update_Sync()

le_result_t taf_update_Sync ( taf_update_SessionRef_t session )

Bank synchronization.

Returns

LE_FAULT – Failed.
LE_OK – Succeeded.

Parameters

[in] session Installation session reference.

Functions

Function Documentation

◆ taf_update_GetServiceRef()

◆ taf_update_GetClientSessionRef()

◆ taf_update_AdvertiseService()

◆ taf_update_AddStateHandler()

◆ taf_update_RemoveStateHandler()

◆ taf_update_Download()

◆ taf_update_Install()

◆ taf_update_GetDownloadSession()

◆ taf_update_StartDownload()

◆ taf_update_PauseDownload()

◆ taf_update_ResumeDownload()

◆ taf_update_CancelDownload()

◆ taf_update_GetInstallationSession()

◆ taf_update_InstallPreCheck()

◆ taf_update_StartInstall()

◆ taf_update_InstallPostCheck()

◆ taf_update_GetActiveBank()

◆ taf_update_VerifyActivation()

◆ taf_update_Rollback()

◆ taf_update_Sync()