taf_update_interface.h File Reference

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

Go to the source code of this file.

Typedefs
typedef void(*	taf_update_DisconnectHandler_t) (void *)

Functions
void	taf_update_ConnectService (void)
le_result_t	taf_update_TryConnectService (void)
LE_FULL_API void	taf_update_SetServerDisconnectHandler (taf_update_DisconnectHandler_t disconnectHandler, void *contextPtr)
LE_FULL_API void	taf_update_SetNonExitServerDisconnectHandler (taf_update_DisconnectHandler_t disconnectHandler, void *contextPtr)
void	taf_update_DisconnectService (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)

Typedef Documentation

taf_update_DisconnectHandler_t

typedef void(* taf_update_DisconnectHandler_t) (void *)

Type for handler called when a server disconnects.

Function Documentation

taf_update_ConnectService()

void taf_update_ConnectService

(

void

)

Connect the current client thread to the service providing this API. Block until the service is available.

For each thread that wants to use this API, either ConnectService or TryConnectService must be called before any other functions in this API. Normally, ConnectService is automatically called for the main thread, but not for any other thread. For details, see apiFilesC_client.

This function is created automatically.

taf_update_TryConnectService()

le_result_t taf_update_TryConnectService

(

void

)

Try to connect the current client thread to the service providing this API. Return with an error if the service is not available.

For each thread that wants to use this API, either ConnectService or TryConnectService must be called before any other functions in this API. Normally, ConnectService is automatically called for the main thread, but not for any other thread. For details, see apiFilesC_client.

This function is created automatically.

Returns

• LE_OK if the client connected successfully to the service.
• LE_UNAVAILABLE if the server is not currently offering the service to which the client is bound.
• LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).
• LE_COMM_ERROR if the Service Directory cannot be reached.

taf_update_SetServerDisconnectHandler()

LE_FULL_API void taf_update_SetServerDisconnectHandler	(	taf_update_DisconnectHandler_t	disconnectHandler,
		void *	contextPtr
	)

Set handler called when server disconnection is detected.

When a server connection is lost, call this handler then exit with LE_FATAL. If a program wants to continue without exiting, it should call longjmp() from inside the handler.

taf_update_SetNonExitServerDisconnectHandler()

LE_FULL_API void taf_update_SetNonExitServerDisconnectHandler	(	taf_update_DisconnectHandler_t	disconnectHandler,
		void *	contextPtr
	)

Set handler called when server disconnection is detected without exiting.

When a server connection is lost, call this handler without exit.

Warning

When using the API, it needs the application developer to handle some cases like re-connecting and recycling the resources. For most of cases, it is safe to use SetServerDisconnectHandler.

taf_update_DisconnectService()

void taf_update_DisconnectService

(

void

)

Disconnect the current client thread from the service providing this API.

Normally, this function doesn't need to be called. After this function is called, there's no longer a connection to the service, and the functions in this API can't be used. For details, see apiFilesC_client.

This function is created automatically.

taf_update_AddStateHandler()

taf_update_StateHandlerRef_t taf_update_AddStateHandler	(	taf_update_StateHandlerFunc_t	handlerPtr,
		void *	contextPtr
	)

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.