Snapdragon® Telematics Application Framework (TelAF) Interface Specification
taf_fwupdate_common.h File Reference
#include "legato.h"

Go to the source code of this file.

Macros

#define IFGEN_TAF_FWUPDATE_PROTOCOL_ID   "39edc56f5663580943130b3e52509231"
 
#define IFGEN_TAF_FWUPDATE_MSG_SIZE   272
 
#define TAF_FWUPDATE_MAX_VERS_LEN   256
 

Functions

LE_SHARED bool ifgen_taf_fwupdate_HasLocalBinding (void)
 
LE_SHARED void ifgen_taf_fwupdate_InitCommonData (void)
 
LE_SHARED void ifgen_taf_fwupdate_CleanupCommonData (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED le_result_t ifgen_taf_fwupdate_OpenSession (le_msg_SessionRef_t _ifgen_sessionRef, bool isBlocking)
 
LE_SHARED void ifgen_taf_fwupdate_RebootToActive (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED le_result_t ifgen_taf_fwupdate_GetFirmwareVersion (le_msg_SessionRef_t _ifgen_sessionRef, char *version, size_t versionSize)
 
LE_SHARED le_result_t ifgen_taf_fwupdate_Install (le_msg_SessionRef_t _ifgen_sessionRef)
 

Macro Definition Documentation

◆ IFGEN_TAF_FWUPDATE_PROTOCOL_ID

#define IFGEN_TAF_FWUPDATE_PROTOCOL_ID   "39edc56f5663580943130b3e52509231"

◆ IFGEN_TAF_FWUPDATE_MSG_SIZE

#define IFGEN_TAF_FWUPDATE_MSG_SIZE   272

◆ TAF_FWUPDATE_MAX_VERS_LEN

#define TAF_FWUPDATE_MAX_VERS_LEN   256

Maximum firmware version length with null characters.

Function Documentation

◆ ifgen_taf_fwupdate_HasLocalBinding()

LE_SHARED bool ifgen_taf_fwupdate_HasLocalBinding ( void  )

Get if this client bound locally.

◆ ifgen_taf_fwupdate_InitCommonData()

LE_SHARED void ifgen_taf_fwupdate_InitCommonData ( void  )

Init data that is common across all threads

◆ ifgen_taf_fwupdate_CleanupCommonData()

LE_SHARED void ifgen_taf_fwupdate_CleanupCommonData ( le_msg_SessionRef_t  _ifgen_sessionRef)

Cleanup the data of a session

◆ ifgen_taf_fwupdate_OpenSession()

LE_SHARED le_result_t ifgen_taf_fwupdate_OpenSession ( le_msg_SessionRef_t  _ifgen_sessionRef,
bool  isBlocking 
)

Perform common initialization and open a session

◆ ifgen_taf_fwupdate_RebootToActive()

LE_SHARED void ifgen_taf_fwupdate_RebootToActive ( le_msg_SessionRef_t  _ifgen_sessionRef)

Reboots the target device to an active slot.

◆ ifgen_taf_fwupdate_GetFirmwareVersion()

LE_SHARED le_result_t ifgen_taf_fwupdate_GetFirmwareVersion ( le_msg_SessionRef_t  _ifgen_sessionRef,
char *  version,
size_t  versionSize 
)

Gets the firmware version.

Returns
  • LE_BAD_PAREMETER – Bad parameter(s).
  • LE_OK – Succeeded.
Parameters
[out]versionFirmware version.
[in]versionSize

◆ ifgen_taf_fwupdate_Install()

LE_SHARED le_result_t ifgen_taf_fwupdate_Install ( le_msg_SessionRef_t  _ifgen_sessionRef)

Installs firmware.

Returns
  • LE_OK – Succeeded.
Note
Only used for local firmware update.