taf_mrc_common.h File Reference

#include "legato.h"

Go to the source code of this file.

Macros
#define	IFGEN_TAF_MRC_PROTOCOL_ID   "bbabbb0245e36158cfed5ba457091e10"
#define	IFGEN_TAF_MRC_MSG_SIZE   12

Enumerations
enum	taf_mrc_OtaOperationStatus_t { TAF_MRC_OTA_OP_STATUS_SUCCESS = 1, TAF_MRC_OTA_OP_STATUS_FAILURE = 2 }

Functions
LE_SHARED bool	ifgen_taf_mrc_HasLocalBinding (void)
LE_SHARED void	ifgen_taf_mrc_InitCommonData (void)
LE_SHARED void	ifgen_taf_mrc_CleanupCommonData (le_msg_SessionRef_t _ifgen_sessionRef)
LE_SHARED le_result_t	ifgen_taf_mrc_OpenSession (le_msg_SessionRef_t _ifgen_sessionRef, bool isBlocking)
LE_SHARED le_result_t	ifgen_taf_mrc_SendOtaStartMsg (le_msg_SessionRef_t _ifgen_sessionRef)
LE_SHARED le_result_t	ifgen_taf_mrc_SendOtaResumeMsg (le_msg_SessionRef_t _ifgen_sessionRef)
LE_SHARED le_result_t	ifgen_taf_mrc_SendOtaEndMsg (le_msg_SessionRef_t _ifgen_sessionRef, taf_mrc_OtaOperationStatus_t otaStatus)
LE_SHARED le_result_t	ifgen_taf_mrc_SendOtaAbsyncMsg (le_msg_SessionRef_t _ifgen_sessionRef)

Macro Definition Documentation

IFGEN_TAF_MRC_PROTOCOL_ID

#define IFGEN_TAF_MRC_PROTOCOL_ID   "bbabbb0245e36158cfed5ba457091e10"

IFGEN_TAF_MRC_MSG_SIZE

#define IFGEN_TAF_MRC_MSG_SIZE   12

Enumeration Type Documentation

taf_mrc_OtaOperationStatus_t

enum taf_mrc_OtaOperationStatus_t

OTA operation status enum.

Note

OTA status notified to MRCD.

Enumerator
TAF_MRC_OTA_OP_STATUS_SUCCESS	OTA operation status is success.
TAF_MRC_OTA_OP_STATUS_FAILURE	OTA operation status is failure.

Function Documentation

ifgen_taf_mrc_HasLocalBinding()

LE_SHARED bool ifgen_taf_mrc_HasLocalBinding

(

void

)

Get if this client bound locally.

ifgen_taf_mrc_InitCommonData()

LE_SHARED void ifgen_taf_mrc_InitCommonData

(

void

)

Init data that is common across all threads

ifgen_taf_mrc_CleanupCommonData()

LE_SHARED void ifgen_taf_mrc_CleanupCommonData

(

le_msg_SessionRef_t

_ifgen_sessionRef

)

Cleanup the data of a session

ifgen_taf_mrc_OpenSession()

LE_SHARED le_result_t ifgen_taf_mrc_OpenSession	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		bool	isBlocking
	)

Perform common initialization and open a session

ifgen_taf_mrc_SendOtaStartMsg()

LE_SHARED le_result_t ifgen_taf_mrc_SendOtaStartMsg

(

le_msg_SessionRef_t

_ifgen_sessionRef

)

Sends an OTA start message to MRCD.

Returns

• LE_FAULT – Failed.
• LE_OK – Succeeded.

ifgen_taf_mrc_SendOtaResumeMsg()

LE_SHARED le_result_t ifgen_taf_mrc_SendOtaResumeMsg

(

le_msg_SessionRef_t

_ifgen_sessionRef

)

Sends an OTA resume message to MRCD.

Returns

• LE_FAULT – Failed.
• LE_OK – Succeeded.

ifgen_taf_mrc_SendOtaEndMsg()

LE_SHARED le_result_t ifgen_taf_mrc_SendOtaEndMsg	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_mrc_OtaOperationStatus_t	otaStatus
	)

Sends an OTA end message to MRCD.

Returns

• LE_FAULT – Failed.
• LE_OK – Succeeded.

Parameters

[in]

otaStatus

OTA operation status.

ifgen_taf_mrc_SendOtaAbsyncMsg()

LE_SHARED le_result_t ifgen_taf_mrc_SendOtaAbsyncMsg

(

le_msg_SessionRef_t

_ifgen_sessionRef

)

Sends a message to MRCD to synchronize active and inactive slots.

Returns

• LE_FAULT – Failed.
• LE_OK – Succeeded.