taf_info_common.h File Reference

#include "legato.h"

Go to the source code of this file.

Macros
#define	IFGEN_TAF_INFO_PROTOCOL_ID   "490da198983676f5ff86a97a6231f975"
#define	IFGEN_TAF_INFO_MSG_SIZE   272
#define	TAF_INFO_IMEI_MAX_BYTES   16
#define	TAF_INFO_MODEL_MAX_BYTES   256
#define	TAF_INFO_VERSION_MAX_BYTES   256
#define	TAF_INFO_MODEM_MAX_BYTES   256
#define	TAF_INFO_TZ_MAX_BYTES   256
#define	TAF_INFO_TELAF_VERSION_MAX_BYTES   256
#define	TAF_INFO_ROOTFS_VERSION_MAX_BYTES   256

Functions
LE_SHARED bool	ifgen_taf_info_HasLocalBinding (void)
LE_SHARED void	ifgen_taf_info_InitCommonData (void)
LE_SHARED void	ifgen_taf_info_CleanupCommonData (le_msg_SessionRef_t _ifgen_sessionRef)
LE_SHARED le_result_t	ifgen_taf_info_OpenSession (le_msg_SessionRef_t _ifgen_sessionRef, bool isBlocking)
LE_SHARED le_result_t	ifgen_taf_info_GetImei (le_msg_SessionRef_t _ifgen_sessionRef, char *imei, size_t imeiSize)
LE_SHARED le_result_t	ifgen_taf_info_GetModel (le_msg_SessionRef_t _ifgen_sessionRef, char *model, size_t modelSize)
LE_SHARED le_result_t	ifgen_taf_info_GetKernelVersion (le_msg_SessionRef_t _ifgen_sessionRef, char *version, size_t versionSize)
LE_SHARED le_result_t	ifgen_taf_info_GetModemVersion (le_msg_SessionRef_t _ifgen_sessionRef, char *modem, size_t modemSize)
LE_SHARED le_result_t	ifgen_taf_info_GetTZVersion (le_msg_SessionRef_t _ifgen_sessionRef, char *tz, size_t tzSize)
LE_SHARED le_result_t	ifgen_taf_info_GetTelafVersion (le_msg_SessionRef_t _ifgen_sessionRef, char *telafVersion, size_t telafVersionSize)
LE_SHARED le_result_t	ifgen_taf_info_GetRootfsVersion (le_msg_SessionRef_t _ifgen_sessionRef, char *rootfsVersion, size_t rootfsVersionSize)

Macro Definition Documentation

IFGEN_TAF_INFO_PROTOCOL_ID

#define IFGEN_TAF_INFO_PROTOCOL_ID   "490da198983676f5ff86a97a6231f975"

IFGEN_TAF_INFO_MSG_SIZE

#define IFGEN_TAF_INFO_MSG_SIZE   272

TAF_INFO_IMEI_MAX_BYTES

#define TAF_INFO_IMEI_MAX_BYTES   16

Maximum IMEI length including null termination character.

TAF_INFO_MODEL_MAX_BYTES

#define TAF_INFO_MODEL_MAX_BYTES   256

TAF_INFO_VERSION_MAX_BYTES

#define TAF_INFO_VERSION_MAX_BYTES   256

TAF_INFO_MODEM_MAX_BYTES

#define TAF_INFO_MODEM_MAX_BYTES   256

TAF_INFO_TZ_MAX_BYTES

#define TAF_INFO_TZ_MAX_BYTES   256

TAF_INFO_TELAF_VERSION_MAX_BYTES

#define TAF_INFO_TELAF_VERSION_MAX_BYTES   256

TAF_INFO_ROOTFS_VERSION_MAX_BYTES

#define TAF_INFO_ROOTFS_VERSION_MAX_BYTES   256

Function Documentation

ifgen_taf_info_HasLocalBinding()

LE_SHARED bool ifgen_taf_info_HasLocalBinding

(

void

)

Get if this client bound locally.

ifgen_taf_info_InitCommonData()

LE_SHARED void ifgen_taf_info_InitCommonData

(

void

)

Init data that is common across all threads

ifgen_taf_info_CleanupCommonData()

LE_SHARED void ifgen_taf_info_CleanupCommonData

(

le_msg_SessionRef_t

_ifgen_sessionRef

)

Cleanup the data of a session

ifgen_taf_info_OpenSession()

LE_SHARED le_result_t ifgen_taf_info_OpenSession	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		bool	isBlocking
	)

Perform common initialization and open a session

ifgen_taf_info_GetImei()

LE_SHARED le_result_t ifgen_taf_info_GetImei	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		char *	imei,
		size_t	imeiSize
	)

Retrieves the International Mobile Equipment Identity (IMEI).

Returns

LE_FAULT – Failed to retrieve the IMEI. LE_OVERFLOW – IMEI length exceeds the maximum length. LE_UNSUPPORTED – Not Supported. LE_OK – Succeeded.

Parameters

[out]	imei	IMEI number.
[in]	imeiSize

ifgen_taf_info_GetModel()

LE_SHARED le_result_t ifgen_taf_info_GetModel	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		char *	model,
		size_t	modelSize
	)

Retrieves the Device Model.

Returns

LE_FAULT – Failed to retrieve the Device Model. LE_OK – Succeeded.

Parameters

[out]	model	Device Model
[in]	modelSize

ifgen_taf_info_GetKernelVersion()

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

Retrieves the Kernel Version.

Returns

LE_FAULT – Failed to retrieve the Kernel Version. LE_OK – Succeeded.

Parameters

[out]	version	Kernel Version
[in]	versionSize

ifgen_taf_info_GetModemVersion()

LE_SHARED le_result_t ifgen_taf_info_GetModemVersion	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		char *	modem,
		size_t	modemSize
	)

Retrieves the Modem Version.

Returns

LE_FAULT – Failed to retrieve the Modem Version. LE_OK – Succeeded.

Parameters

[out]	modem	Modem Version
[in]	modemSize

ifgen_taf_info_GetTZVersion()

LE_SHARED le_result_t ifgen_taf_info_GetTZVersion	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		char *	tz,
		size_t	tzSize
	)

Retrieves the TZ Version.

Returns

LE_FAULT – Failed to retrieve the TZ Version. LE_OK – Succeeded.

Parameters

[out]	tz	TZ version
[in]	tzSize

ifgen_taf_info_GetTelafVersion()

LE_SHARED le_result_t ifgen_taf_info_GetTelafVersion	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		char *	telafVersion,
		size_t	telafVersionSize
	)

Retrieves the TelAF Version.

Returns

LE_FAULT – Failed to retrieve the TelAF Version. LE_OK – Succeeded.

Parameters

[out]	telafVersion	TelAF version
[in]	telafVersionSize

ifgen_taf_info_GetRootfsVersion()

LE_SHARED le_result_t ifgen_taf_info_GetRootfsVersion	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		char *	rootfsVersion,
		size_t	rootfsVersionSize
	)

Retrieves the root file system Version.

Returns

LE_FAULT – Failed to retrieve the root file system version. LE_OK – Succeeded.

Parameters

[out]	rootfsVersion	Root file system version
[in]	rootfsVersionSize