le_update_interface.h File Reference

#include "legato.h"
#include "le_limit_interface.h"

Go to the source code of this file.

Typedefs
typedef struct le_update_ProgressHandler *	le_update_ProgressHandlerRef_t
typedef void(*	le_update_ProgressHandlerFunc_t) (le_update_State_t updateState, uint percentDone, void *contextPtr)

Enumerations
enum	le_update_State_t { LE_UPDATE_STATE_UNPACKING, LE_UPDATE_STATE_APPLYING, LE_UPDATE_STATE_SUCCESS, LE_UPDATE_STATE_FAILED }
enum	le_update_ErrorCode_t { LE_UPDATE_ERR_NONE, LE_UPDATE_ERR_BAD_PACKAGE, LE_UPDATE_ERR_INTERNAL_ERROR, LE_UPDATE_ERR_SECURITY_FAILURE }

Functions
void	le_update_ConnectService (void)
void	le_update_DisconnectService (void)
le_update_ProgressHandlerRef_t	le_update_AddProgressHandler (le_update_ProgressHandlerFunc_t handlerPtr, void *contextPtr)
void	le_update_RemoveProgressHandler (le_update_ProgressHandlerRef_t addHandlerRef)
le_result_t	le_update_Start (int fd)
void	le_update_End (void)
le_update_ErrorCode_t	le_update_GetErrorCode (void)
int32_t	le_update_GetCurrentSysIndex (void)
le_result_t	le_update_GetSystemHash (int32_t systemIndex, char *hashStr, size_t hashStrNumElements)
int32_t	le_update_GetPreviousSystemIndex (int32_t systemIndex)

Detailed Description

Legato Software Update include file.

Copyright (C) Sierra Wireless Inc. Use of this work is subject to license.

Typedef Documentation

typedef void(* le_update_ProgressHandlerFunc_t) (le_update_State_t updateState, uint percentDone, void *contextPtr)

The client callback function (handler) passed to le_update_Start() must look like this.

Parameters

updateState	Current state of update.
percentDone	Percent done for current state. For example, in state UNPACKING, a percentDone of 80 means that 80% of the update data has been unpacked.
contextPtr

typedef struct le_update_ProgressHandler* le_update_ProgressHandlerRef_t

Reference type used by Add/Remove functions for EVENT 'le_update_Progress'

Enumeration Type Documentation

enum le_update_ErrorCode_t

Error code used to provide diagnostic information after a failed update.

Note

Additional information may also be available in the target device's system log.

Enumerator
LE_UPDATE_ERR_NONE	No error.
LE_UPDATE_ERR_BAD_PACKAGE	Encountered bad update package. Check logs.
LE_UPDATE_ERR_INTERNAL_ERROR	Something failed while doing update. Check logs.
LE_UPDATE_ERR_SECURITY_FAILURE	Error while doing security check of the package.

enum le_update_State_t

Different states in the update state machine. The state machine is maintained to track the update task underway.

Example: for successful installation task, state transitions look like:

    --> UNPACKING --> APPLYING --> SUCCESS.
            |            |
            +------------+-------> FAILED.

Enumerator
LE_UPDATE_STATE_UNPACKING	Unpacking update data.
LE_UPDATE_STATE_APPLYING	Applying update(i.e. installation/removal operation going on).
LE_UPDATE_STATE_SUCCESS	Successfully completed all update task.
LE_UPDATE_STATE_FAILED	Update failed due to some error or deletion request.

Function Documentation

le_update_ProgressHandlerRef_t le_update_AddProgressHandler	(	le_update_ProgressHandlerFunc_t	handlerPtr,
		void *	contextPtr
	)

Add handler function for EVENT 'le_update_Progress'

Register for notification of the progress of a given update.

Parameters

[in]	handlerPtr
[in]	contextPtr

void le_update_ConnectService

(

void

)

Connect the current client thread to the service providing this API.

This function must be called before any other functions in this API. Normally, it's automatically called for the main thread, but must be explicitly called for other threads. For details, see Client-specific Functions.

This function is created automatically.

void le_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 Client-specific Functions.

This function is created automatically.

void le_update_End

(

void

)

Ends an update session. If the update isn't finished yet, cancels it.

int32_t le_update_GetCurrentSysIndex

(

void

)

Get the index of the currently running system.

Returns

The index of the running system.

le_update_ErrorCode_t le_update_GetErrorCode

(

void

)

Function to get error code when update fails.

Returns

• Error code of encountered error.
• ERR_NONE if update is in any other state.

int32_t le_update_GetPreviousSystemIndex

(

int32_t

systemIndex

)

Get the index for the previous system in the chain, using the current system as a starting point.

Returns

The index to the system that's previous to the given system. -1 is returned if the previous system was not found.

Parameters

[in]

systemIndex

Get the system that's older than this system.

le_result_t le_update_GetSystemHash	(	int32_t	systemIndex,
		char *	hashStr,
		size_t	hashStrNumElements
	)

Gets the hash ID for a given system.

Returns

• LE_OK if no problems are encountered.
• LE_NOT_FOUND if the given index does not correspond to an available system.
• LE_OVERFLOW if the supplied buffer is too small.
• LE_FORMAT_ERROR if there are problems reading the hash for the system.

Parameters

[in]	systemIndex	The system to read the hash for.
[out]	hashStr	Buffer to hold the system hash string.
[in]	hashStrNumElements

void le_update_RemoveProgressHandler

(

le_update_ProgressHandlerRef_t

addHandlerRef

)

Remove handler function for EVENT 'le_update_Progress'

Parameters

[in]

addHandlerRef

le_result_t le_update_Start

(

int

fd

)

Starts an update.

Progress is reported via the progress handler callback.

Returns

• LE_OK if accepted.
• LE_BUSY if another update is in progress.
• LE_UNAVAILABLE if the system is still in "probation" (not marked "good" yet).

Parameters

[in]

fd

Open file descriptor from which the update can be read.