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

Go to the source code of this file.

Macros

#define IFGEN_TAF_HMS_PROTOCOL_ID   "cc3827cbeec19f09ccdab03c0939c367"
 
#define IFGEN_TAF_HMS_MSG_SIZE   48
 
#define TAF_HMS_MAX_NAME_SIZE   32
 

Typedefs

typedef struct taf_hms_UbiDevInfoList * taf_hms_UbiDevInfoListRef_t
 
typedef struct taf_hms_UbiDevInfo * taf_hms_UbiDevInfoRef_t
 
typedef struct taf_hms_UbiVolInfo * taf_hms_UbiVolInfoRef_t
 
typedef struct taf_hms_MtdDevInfoList * taf_hms_MtdDevInfoListRef_t
 
typedef struct taf_hms_MtdDevInfo * taf_hms_MtdDevInfoRef_t
 

Functions

LE_SHARED bool ifgen_taf_hms_HasLocalBinding (void)
 
LE_SHARED void ifgen_taf_hms_InitCommonData (void)
 
LE_SHARED void ifgen_taf_hms_CleanupCommonData (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED le_result_t ifgen_taf_hms_OpenSession (le_msg_SessionRef_t _ifgen_sessionRef, bool isBlocking)
 
LE_SHARED le_result_t ifgen_taf_hms_GetCpuLoad (le_msg_SessionRef_t _ifgen_sessionRef, double *cpuCurrentLoadPtr)
 
LE_SHARED uint32_t ifgen_taf_hms_GetCpuCoreNum (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED le_result_t ifgen_taf_hms_GetIndvCoreUsage (le_msg_SessionRef_t _ifgen_sessionRef, uint32_t coreID, double *cpuUsagePtr)
 
LE_SHARED le_result_t ifgen_taf_hms_GetRamMemInfo (le_msg_SessionRef_t _ifgen_sessionRef, uint32_t *ramTotalMemPtr, uint32_t *ramUsedMemPtr, uint32_t *ramFreeMemPtr)
 
LE_SHARED taf_hms_UbiDevInfoListRef_t ifgen_taf_hms_GetUbiDevInfoList (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED taf_hms_UbiDevInfoRef_t ifgen_taf_hms_GetFirstUbiDevInfo (le_msg_SessionRef_t _ifgen_sessionRef, taf_hms_UbiDevInfoListRef_t ubiDevInfoListRef)
 
LE_SHARED le_result_t ifgen_taf_hms_DeleteUbiDevInfoList (le_msg_SessionRef_t _ifgen_sessionRef, taf_hms_UbiDevInfoListRef_t ubiDevInfoListRef)
 
LE_SHARED taf_hms_UbiDevInfoRef_t ifgen_taf_hms_GetNextUbiDevInfo (le_msg_SessionRef_t _ifgen_sessionRef, taf_hms_UbiDevInfoListRef_t ubiDevInfoListRef)
 
LE_SHARED le_result_t ifgen_taf_hms_GetUbiDevId (le_msg_SessionRef_t _ifgen_sessionRef, taf_hms_UbiDevInfoRef_t ubiDevInfoRef, uint32_t *ubiDevIdPtr)
 
LE_SHARED le_result_t ifgen_taf_hms_GetUbiDevMaxEraseCnt (le_msg_SessionRef_t _ifgen_sessionRef, taf_hms_UbiDevInfoRef_t ubiDevInfoRef, uint32_t *ubiEraseCntPtr)
 
LE_SHARED le_result_t ifgen_taf_hms_GetUbiDevBadBlkCnt (le_msg_SessionRef_t _ifgen_sessionRef, taf_hms_UbiDevInfoRef_t ubiDevInfoRef, uint32_t *ubiBbCntPtr)
 
LE_SHARED taf_hms_UbiVolInfoRef_t ifgen_taf_hms_GetFirstUbiVolInfo (le_msg_SessionRef_t _ifgen_sessionRef, taf_hms_UbiDevInfoRef_t ubiDevInfoRef)
 
LE_SHARED taf_hms_UbiVolInfoRef_t ifgen_taf_hms_GetNextUbiVolInfo (le_msg_SessionRef_t _ifgen_sessionRef, taf_hms_UbiDevInfoRef_t ubiDevInfoRef)
 
LE_SHARED le_result_t ifgen_taf_hms_GetUbiVolId (le_msg_SessionRef_t _ifgen_sessionRef, taf_hms_UbiVolInfoRef_t ubiVolInfoRef, uint32_t *ubiVolIdPtr)
 
LE_SHARED le_result_t ifgen_taf_hms_GetUbiVolName (le_msg_SessionRef_t _ifgen_sessionRef, taf_hms_UbiVolInfoRef_t ubiVolInfoRef, char *ubiVolName, size_t ubiVolNameSize)
 
LE_SHARED le_result_t ifgen_taf_hms_GetUbiVolSize (le_msg_SessionRef_t _ifgen_sessionRef, taf_hms_UbiVolInfoRef_t ubiVolInfoRef, uint32_t *ubiVolSizePtr)
 
LE_SHARED taf_hms_MtdDevInfoListRef_t ifgen_taf_hms_GetMtdDevInfoList (le_msg_SessionRef_t _ifgen_sessionRef)
 
LE_SHARED le_result_t ifgen_taf_hms_DeleteMtdDevInfoList (le_msg_SessionRef_t _ifgen_sessionRef, taf_hms_MtdDevInfoListRef_t mtdDevInfoListRef)
 
LE_SHARED taf_hms_MtdDevInfoRef_t ifgen_taf_hms_GetFirstMtdDevInfo (le_msg_SessionRef_t _ifgen_sessionRef, taf_hms_MtdDevInfoListRef_t mtdDevInfoListRef)
 
LE_SHARED taf_hms_MtdDevInfoRef_t ifgen_taf_hms_GetNextMtdDevInfo (le_msg_SessionRef_t _ifgen_sessionRef, taf_hms_MtdDevInfoListRef_t mtdDevInfoListRef)
 
LE_SHARED le_result_t ifgen_taf_hms_GetMtdDevName (le_msg_SessionRef_t _ifgen_sessionRef, taf_hms_MtdDevInfoRef_t mtdDevInfoRef, char *mtdName, size_t mtdNameSize)
 
LE_SHARED le_result_t ifgen_taf_hms_GetMtdDevBlkSize (le_msg_SessionRef_t _ifgen_sessionRef, taf_hms_MtdDevInfoRef_t mtdDevInfoRef, uint32_t *mtdBlkSizePtr)
 
LE_SHARED le_result_t ifgen_taf_hms_GetMtdDevId (le_msg_SessionRef_t _ifgen_sessionRef, taf_hms_MtdDevInfoRef_t mtdDevInfoRef, uint32_t *mtdDevIdPtr)
 
LE_SHARED le_result_t ifgen_taf_hms_GetMtdDevBlkCnt (le_msg_SessionRef_t _ifgen_sessionRef, taf_hms_MtdDevInfoRef_t mtdDevInfoRef, uint32_t *mtdBlkCntPtr)
 

Macro Definition Documentation

◆ IFGEN_TAF_HMS_PROTOCOL_ID

#define IFGEN_TAF_HMS_PROTOCOL_ID   "cc3827cbeec19f09ccdab03c0939c367"

◆ IFGEN_TAF_HMS_MSG_SIZE

#define IFGEN_TAF_HMS_MSG_SIZE   48

◆ TAF_HMS_MAX_NAME_SIZE

#define TAF_HMS_MAX_NAME_SIZE   32

The maximum size of the String.

Typedef Documentation

◆ taf_hms_UbiDevInfoListRef_t

typedef struct taf_hms_UbiDevInfoList* taf_hms_UbiDevInfoListRef_t

The UBI device information list reference.

◆ taf_hms_UbiDevInfoRef_t

typedef struct taf_hms_UbiDevInfo* taf_hms_UbiDevInfoRef_t

Reference type for details of UBI device info.

◆ taf_hms_UbiVolInfoRef_t

typedef struct taf_hms_UbiVolInfo* taf_hms_UbiVolInfoRef_t

Reference type for details of UBI volume info.

◆ taf_hms_MtdDevInfoListRef_t

typedef struct taf_hms_MtdDevInfoList* taf_hms_MtdDevInfoListRef_t

The MTD information list reference.

◆ taf_hms_MtdDevInfoRef_t

typedef struct taf_hms_MtdDevInfo* taf_hms_MtdDevInfoRef_t

Reference type for details of MTD info.

Function Documentation

◆ ifgen_taf_hms_HasLocalBinding()

LE_SHARED bool ifgen_taf_hms_HasLocalBinding ( void  )

Get if this client bound locally.

◆ ifgen_taf_hms_InitCommonData()

LE_SHARED void ifgen_taf_hms_InitCommonData ( void  )

Init data that is common across all threads

◆ ifgen_taf_hms_CleanupCommonData()

LE_SHARED void ifgen_taf_hms_CleanupCommonData ( le_msg_SessionRef_t  _ifgen_sessionRef)

Cleanup the data of a session

◆ ifgen_taf_hms_OpenSession()

LE_SHARED le_result_t ifgen_taf_hms_OpenSession ( le_msg_SessionRef_t  _ifgen_sessionRef,
bool  isBlocking 
)

Perform common initialization and open a session

◆ ifgen_taf_hms_GetCpuLoad()

LE_SHARED le_result_t ifgen_taf_hms_GetCpuLoad ( le_msg_SessionRef_t  _ifgen_sessionRef,
double *  cpuCurrentLoadPtr 
)

Gets the total CPU usage from " /proc/stat ".

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Parameters
[out]cpuCurrentLoadPtrCPU Total Usage.

◆ ifgen_taf_hms_GetCpuCoreNum()

LE_SHARED uint32_t ifgen_taf_hms_GetCpuCoreNum ( le_msg_SessionRef_t  _ifgen_sessionRef)

Gets number of CPU core from " /proc/cpuinfo ".

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.

◆ ifgen_taf_hms_GetIndvCoreUsage()

LE_SHARED le_result_t ifgen_taf_hms_GetIndvCoreUsage ( le_msg_SessionRef_t  _ifgen_sessionRef,
uint32_t  coreID,
double *  cpuUsagePtr 
)

Gets the CPU usage of each core from " /proc/stat ". The API provides total CPU usage of each core ranging from 0 to 100 %. The coreID range can be 0 - (cpuCoreNum-1), the result value can be LE_OK.

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Parameters
[in]coreIDCore ID
[out]cpuUsagePtrcpuUsage

◆ ifgen_taf_hms_GetRamMemInfo()

LE_SHARED le_result_t ifgen_taf_hms_GetRamMemInfo ( le_msg_SessionRef_t  _ifgen_sessionRef,
uint32_t *  ramTotalMemPtr,
uint32_t *  ramUsedMemPtr,
uint32_t *  ramFreeMemPtr 
)

Gets the meminfo value from " /proc/meminfo ".

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Parameters
[out]ramTotalMemPtrTotal Memory in kB.
[out]ramUsedMemPtrUsed Memory in kB.
[out]ramFreeMemPtrFree memory in kB.

◆ ifgen_taf_hms_GetUbiDevInfoList()

LE_SHARED taf_hms_UbiDevInfoListRef_t ifgen_taf_hms_GetUbiDevInfoList ( le_msg_SessionRef_t  _ifgen_sessionRef)

Gets the list of available UBI device information.

Returns
  • NULL No information found.
  • taf_hms_UbiDevInfoListRef The UBI device Info list object reference.

◆ ifgen_taf_hms_GetFirstUbiDevInfo()

LE_SHARED taf_hms_UbiDevInfoRef_t ifgen_taf_hms_GetFirstUbiDevInfo ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_hms_UbiDevInfoListRef_t  ubiDevInfoListRef 
)

Gets the first UBI device Info object reference in the list of the UbiDevInfoList retrieved with taf_hms_GetUbiDevInfoList().

Returns
  • NULL No information found.
  • taf_hms_UbiDevInfoListRef The UBI device Info object reference.
Parameters
[in]ubiDevInfoListRefUBI device list reference

◆ ifgen_taf_hms_DeleteUbiDevInfoList()

LE_SHARED le_result_t ifgen_taf_hms_DeleteUbiDevInfoList ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_hms_UbiDevInfoListRef_t  ubiDevInfoListRef 
)

Deletes the UbiDevInfoList list retrieved with taf_hms_GetUbiDevInfoList().

Returns
  • LE_BAD_PARAMETER – Bad parameters.
  • LE_OK – Succeeded.
Parameters
[in]ubiDevInfoListRefUBI device list reference

◆ ifgen_taf_hms_GetNextUbiDevInfo()

LE_SHARED taf_hms_UbiDevInfoRef_t ifgen_taf_hms_GetNextUbiDevInfo ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_hms_UbiDevInfoListRef_t  ubiDevInfoListRef 
)

Gets the next UBI device Info object reference in the list of the UBIInfoList retrieved with taf_hms_GetUBIInfoList().

Returns
  • NULL No information found.
  • taf_hms_UbiDevInfoListRef The UBI device Info object reference.
Parameters
[in]ubiDevInfoListRefUBI device list reference

◆ ifgen_taf_hms_GetUbiDevId()

LE_SHARED le_result_t ifgen_taf_hms_GetUbiDevId ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_hms_UbiDevInfoRef_t  ubiDevInfoRef,
uint32_t *  ubiDevIdPtr 
)

Gets UBI device ID

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Parameters
[in]ubiDevInfoRefUBI device Info reference.
[out]ubiDevIdPtrUBI device ID

◆ ifgen_taf_hms_GetUbiDevMaxEraseCnt()

LE_SHARED le_result_t ifgen_taf_hms_GetUbiDevMaxEraseCnt ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_hms_UbiDevInfoRef_t  ubiDevInfoRef,
uint32_t *  ubiEraseCntPtr 
)

Gets UBI information for current maximum erase count from " /sys/class/ubi/ubi%d/ ".

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Parameters
[in]ubiDevInfoRefUBI device Info reference.
[out]ubiEraseCntPtrErase count.

◆ ifgen_taf_hms_GetUbiDevBadBlkCnt()

LE_SHARED le_result_t ifgen_taf_hms_GetUbiDevBadBlkCnt ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_hms_UbiDevInfoRef_t  ubiDevInfoRef,
uint32_t *  ubiBbCntPtr 
)

Gets UBI information for bad block count from " /sys/class/ubi/ubi%d/ ".

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Parameters
[in]ubiDevInfoRefUBI device Info reference.
[out]ubiBbCntPtrBad Block count.

◆ ifgen_taf_hms_GetFirstUbiVolInfo()

LE_SHARED taf_hms_UbiVolInfoRef_t ifgen_taf_hms_GetFirstUbiVolInfo ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_hms_UbiDevInfoRef_t  ubiDevInfoRef 
)

Gets the first UBI volume Info object reference in the list of the UbiVolInfoList retrieved with taf_hms_GetUbiDevInfoList().

Returns
  • NULL No information found.
  • taf_hms_UbiVolInfoListRef The UBI device Info object reference.
Parameters
[in]ubiDevInfoRefUBI device Info reference.

◆ ifgen_taf_hms_GetNextUbiVolInfo()

LE_SHARED taf_hms_UbiVolInfoRef_t ifgen_taf_hms_GetNextUbiVolInfo ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_hms_UbiDevInfoRef_t  ubiDevInfoRef 
)

Gets the next UBI volume Info object reference in the list of the UbiVolInfoList retrieved with taf_hms_GetUbiDevInfoList().

Returns
  • NULL No information found.
  • taf_hms_UbiVolInfoListRef The UBI volume Info object reference.
Parameters
[in]ubiDevInfoRefUBI device Info reference.

◆ ifgen_taf_hms_GetUbiVolId()

LE_SHARED le_result_t ifgen_taf_hms_GetUbiVolId ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_hms_UbiVolInfoRef_t  ubiVolInfoRef,
uint32_t *  ubiVolIdPtr 
)

Gets UBI volume ID.

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Parameters
[in]ubiVolInfoRef
[out]ubiVolIdPtr

◆ ifgen_taf_hms_GetUbiVolName()

LE_SHARED le_result_t ifgen_taf_hms_GetUbiVolName ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_hms_UbiVolInfoRef_t  ubiVolInfoRef,
char *  ubiVolName,
size_t  ubiVolNameSize 
)

Gets name of UBI volume.

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Parameters
[in]ubiVolInfoRefUBI device Info reference.
[out]ubiVolNameUBI volume name.
[in]ubiVolNameSize

◆ ifgen_taf_hms_GetUbiVolSize()

LE_SHARED le_result_t ifgen_taf_hms_GetUbiVolSize ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_hms_UbiVolInfoRef_t  ubiVolInfoRef,
uint32_t *  ubiVolSizePtr 
)

Gets size of UBI volume in bytes.

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Parameters
[in]ubiVolInfoRefUBI device Info reference.
[out]ubiVolSizePtrUBI volume size.

◆ ifgen_taf_hms_GetMtdDevInfoList()

LE_SHARED taf_hms_MtdDevInfoListRef_t ifgen_taf_hms_GetMtdDevInfoList ( le_msg_SessionRef_t  _ifgen_sessionRef)

Gets the list of available MTD Node.

Returns
  • NULL No information found.
  • taf_hms_MtdInfoListRef The MtdInfo list object reference.

◆ ifgen_taf_hms_DeleteMtdDevInfoList()

LE_SHARED le_result_t ifgen_taf_hms_DeleteMtdDevInfoList ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_hms_MtdDevInfoListRef_t  mtdDevInfoListRef 
)

Deletes the MtdInfoList list retrieved with taf_hms_GetMtdInfoList().

Returns
  • LE_BAD_PARAMETER – Bad parameters.
  • LE_OK – Succeeded.
Parameters
[in]mtdDevInfoListRefMTD device list reference

◆ ifgen_taf_hms_GetFirstMtdDevInfo()

LE_SHARED taf_hms_MtdDevInfoRef_t ifgen_taf_hms_GetFirstMtdDevInfo ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_hms_MtdDevInfoListRef_t  mtdDevInfoListRef 
)

Gets the first MtdInfo object reference in the list of the MtdInfoList retrieved with taf_hms_GetMtdInfoList().

Returns
  • NULL No information found.
  • taf_hms_MtdInfoListRef The MtdInfo object reference.
Parameters
[in]mtdDevInfoListRefMTD node list reference

◆ ifgen_taf_hms_GetNextMtdDevInfo()

LE_SHARED taf_hms_MtdDevInfoRef_t ifgen_taf_hms_GetNextMtdDevInfo ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_hms_MtdDevInfoListRef_t  mtdDevInfoListRef 
)

Gets the next MtdInfo object reference in the list of the MtdInfoList retrieved with taf_hms_GetMtdInfoList().

Returns
  • NULL No information found.
  • taf_hms_MtdInfoListRef The MtdInfo object reference.
Parameters
[in]mtdDevInfoListRefMTD node list reference

◆ ifgen_taf_hms_GetMtdDevName()

LE_SHARED le_result_t ifgen_taf_hms_GetMtdDevName ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_hms_MtdDevInfoRef_t  mtdDevInfoRef,
char *  mtdName,
size_t  mtdNameSize 
)

Gets MTD information for name from " /sys/class/mtd/mtd%d/ ".

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Parameters
[in]mtdDevInfoRefMTD Info reference.
[out]mtdNameMTD name.
[in]mtdNameSize

◆ ifgen_taf_hms_GetMtdDevBlkSize()

LE_SHARED le_result_t ifgen_taf_hms_GetMtdDevBlkSize ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_hms_MtdDevInfoRef_t  mtdDevInfoRef,
uint32_t *  mtdBlkSizePtr 
)

Gets MTD information for block size in bytes.

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Parameters
[in]mtdDevInfoRefMTD Info reference.
[out]mtdBlkSizePtrBad block size.

◆ ifgen_taf_hms_GetMtdDevId()

LE_SHARED le_result_t ifgen_taf_hms_GetMtdDevId ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_hms_MtdDevInfoRef_t  mtdDevInfoRef,
uint32_t *  mtdDevIdPtr 
)

Gets MTD information for device ID.

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Parameters
[in]mtdDevInfoRefMTD Info reference.
[out]mtdDevIdPtrDevice ID.

◆ ifgen_taf_hms_GetMtdDevBlkCnt()

LE_SHARED le_result_t ifgen_taf_hms_GetMtdDevBlkCnt ( le_msg_SessionRef_t  _ifgen_sessionRef,
taf_hms_MtdDevInfoRef_t  mtdDevInfoRef,
uint32_t *  mtdBlkCntPtr 
)

Gets MTD information for block count.

Returns
  • LE_FAULT Failed.
  • LE_OK Succeeded.
Parameters
[in]mtdDevInfoRefMTD Info reference.
[out]mtdBlkCntPtrBlock count.