#include "legato.h"
#include "le_info_common.h"

Typedefs
typedef void(*	le_info_DisconnectHandler_t) (void *)

Functions
void	le_info_ConnectService (void)

le_result_t	le_info_TryConnectService (void)

LE_FULL_API void	le_info_SetServerDisconnectHandler (le_info_DisconnectHandler_t disconnectHandler, void *contextPtr)

void	le_info_DisconnectService (void)

le_result_t	le_info_GetImei (char *imei, size_t imeiSize)

le_result_t	le_info_GetImeiSv (char *imeiSv, size_t imeiSvSize)

le_result_t	le_info_GetFirmwareVersion (char *version, size_t versionSize)

le_result_t	le_info_GetResetInformation (le_info_Reset_t resetPtr, char resetSpecificInfoStr, size_t resetSpecificInfoStrSize)

le_result_t	le_info_GetBootloaderVersion (char *version, size_t versionSize)

le_result_t	le_info_GetDeviceModel (char *modelPtr, size_t modelPtrSize)

le_result_t	le_info_GetMeid (char *meidStr, size_t meidStrSize)

le_result_t	le_info_GetEsn (char *esnStr, size_t esnStrSize)

le_result_t	le_info_GetMdn (char *mdnStr, size_t mdnStrSize)

le_result_t	le_info_GetPrlVersion (uint16_t *prlVersionPtr)

le_result_t	le_info_GetPrlOnlyPreference (bool *prlOnlyPreferencePtr)

le_result_t	le_info_GetMin (char *msisdnStr, size_t msisdnStrSize)

le_result_t	le_info_GetNai (char *naiStr, size_t naiStrSize)

le_result_t	le_info_GetManufacturerName (char *mfrNameStr, size_t mfrNameStrSize)

le_result_t	le_info_GetPriId (char priIdPnStr, size_t priIdPnStrSize, char priIdRevStr, size_t priIdRevStrSize)

le_result_t	le_info_GetCarrierPri (char capriNameStr, size_t capriNameStrSize, char capriRevStr, size_t capriRevStrSize)

le_result_t	le_info_GetPlatformSerialNumber (char *platformSerialNumberStr, size_t platformSerialNumberStrSize)

le_result_t	le_info_GetRfDeviceStatus (uint16_t manufacturedIdPtr, size_t manufacturedIdSizePtr, uint8_t productIdPtr, size_t productIdSizePtr, bool statusPtr, size_t statusSizePtr)

le_result_t	le_info_GetSku (char *skuIdStr, size_t skuIdStrSize)

le_result_t	le_info_GetExpectedResetsCount (uint64_t *resetsCountPtrPtr)

le_result_t	le_info_GetUnexpectedResetsCount (uint64_t *resetsCountPtrPtr)

Detailed Description

Legato Modem Information include file.

Copyright (C) Sierra Wireless Inc.

Typedef Documentation

◆ le_info_DisconnectHandler_t

typedef void(* le_info_DisconnectHandler_t) (void *)

Type for handler called when a server disconnects.

Function Documentation

◆ le_info_ConnectService()

void le_info_ConnectService ( void )

Connect the current client thread to the service providing this API. Block until the service is available.

For each thread that wants to use this API, either ConnectService or TryConnectService must be called before any other functions in this API. Normally, ConnectService is automatically called for the main thread, but not for any other thread. For details, see Client-specific Functions.

This function is created automatically.

◆ le_info_DisconnectService()

void le_info_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.

◆ le_info_GetBootloaderVersion()

le_result_t le_info_GetBootloaderVersion	(	char *	version,
		size_t	versionSize
	)

Get the bootloader version string

Returns

LE_OK on success
LE_NOT_FOUND if the version string is not available
LE_OVERFLOW if version string to big to fit in provided buffer
LE_FAULT for any other errors

Note: If the caller is passing a bad pointer into this function, it is a fatal error, the function will not return.

Parameters

[out]	version	Bootloader version string
[in]	versionSize

◆ le_info_GetCarrierPri()

le_result_t le_info_GetCarrierPri	(	char *	capriNameStr,
		size_t	capriNameStrSize,
		char *	capriRevStr,
		size_t	capriRevStrSize
	)

Get the Carrier PRI Name and Revision Number strings in ASCII text.

Returns

LE_OK The function succeeded.
LE_FAULT The function failed to get the value.
LE_OVERFLOW The Part or the Revision Number strings length exceed the maximum length.
LE_UNSUPPORTED The function is not supported on the platform.

Parameters

[out]	capriNameStr	The Carrier Product Requirement Information (CAPRI) Name string (null-terminated).
[in]	capriNameStrSize
[out]	capriRevStr	The Carrier Product Requirement Information (CAPRI) Revision Number string (null-terminated).
[in]	capriRevStrSize

◆ le_info_GetDeviceModel()

le_result_t le_info_GetDeviceModel	(	char *	modelPtr,
		size_t	modelPtrSize
	)

Get the device model identity (Target Hardware Platform).

Returns

LE_OK The function succeeded.
LE_FAULT The function failed to get the value.
LE_OVERFLOW The device model identity length exceed the maximum length.

Parameters

[out]	modelPtr	The model identity string (null-terminated).
[in]	modelPtrSize

◆ le_info_GetEsn()

le_result_t le_info_GetEsn	(	char *	esnStr,
		size_t	esnStrSize
	)

Get the CDMA Electronic Serial Number (ESN) of the device.

Returns

LE_OK The function succeeded.
LE_FAULT The function failed to get the value.
LE_OVERFLOW The Electronic Serial Number length exceed the maximum length.

Parameters

[out]	esnStr	The Electronic Serial Number (ESN) of the device. string (null-terminated).
[in]	esnStrSize

◆ le_info_GetExpectedResetsCount()

le_result_t le_info_GetExpectedResetsCount ( uint64_t * resetsCountPtrPtr )

Get the number of expected resets

Returns

LE_OK Success
LE_BAD_PARAMETER Input prameter is a null pointer
LE_UNSUPPORTED If not supported by the platform
LE_FAULT Failed to get the number if expected resets

Parameters

[out] resetsCountPtrPtr Number of expected resets

◆ le_info_GetFirmwareVersion()

le_result_t le_info_GetFirmwareVersion	(	char *	version,
		size_t	versionSize
	)

Get the firmware version string

Returns

LE_OK on success
LE_NOT_FOUND if the version string is not available
LE_OVERFLOW if version string to big to fit in provided buffer
LE_FAULT for any other errors

Note: If the caller is passing a bad pointer into this function, it is a fatal error, the function will not return.

Parameters

[out]	version	Firmware version string
[in]	versionSize

◆ le_info_GetImei()

le_result_t le_info_GetImei	(	char *	imei,
		size_t	imeiSize
	)

Reset type enum Retrieve the International Mobile Equipment Identity (IMEI).

Returns: LE_FAULT Function failed to retrieve the IMEI.; LE_OVERFLOW IMEI length exceed the maximum length.; LE_OK Function succeeded.

Note: If the caller passes a bad pointer into this function, it's a fatal error the function will not return.

Parameters

[out]	imei	IMEI string.
[in]	imeiSize

◆ le_info_GetImeiSv()

le_result_t le_info_GetImeiSv	(	char *	imeiSv,
		size_t	imeiSvSize
	)

Retrieve the International Mobile Equipment Identity software version number (IMEISV).

Returns: LE_FAULT Function failed to retrieve the IMEISV.; LE_OVERFLOW IMEISV length exceed the maximum length.; LE_OK Function succeeded.

Note: If the caller passes a bad pointer into this function, it's a fatal error; the function will not return.

Parameters

[out]	imeiSv	IMEISV string.
[in]	imeiSvSize

◆ le_info_GetManufacturerName()

le_result_t le_info_GetManufacturerName	(	char *	mfrNameStr,
		size_t	mfrNameStrSize
	)

Get the Manufacturer Name string in ASCII text.

Returns

LE_OK The function succeeded.
LE_FAULT The function failed to get the value.
LE_OVERFLOW The Manufacturer Name length exceed the maximum length.

Parameters

[out]	mfrNameStr	The Manufacturer Name string (null-terminated).
[in]	mfrNameStrSize

◆ le_info_GetMdn()

le_result_t le_info_GetMdn	(	char *	mdnStr,
		size_t	mdnStrSize
	)

Get the CDMA Mobile Directory Number (MDN) of the device.

Returns

LE_OK The function succeeded.
LE_FAULT The function failed to get the value.
LE_OVERFLOW The Mobile Directory Number length exceed the maximum length.

Parameters

[out]	mdnStr	The Mobile Directory Number (MDN) string (null-terminated).
[in]	mdnStrSize

◆ le_info_GetMeid()

le_result_t le_info_GetMeid	(	char *	meidStr,
		size_t	meidStrSize
	)

Get the CDMA device Mobile Equipment Identifier (MEID).

Returns

LE_OK The function succeeded.
LE_FAULT The function failed to get the value.
LE_OVERFLOW The device Mobile Equipment identifier length exceed the maximum length.

Parameters

[out]	meidStr	The Mobile Equipment identifier (MEID) string (null-terminated).
[in]	meidStrSize

◆ le_info_GetMin()

le_result_t le_info_GetMin	(	char *	msisdnStr,
		size_t	msisdnStrSize
	)

Get the CDMA Mobile Identification Number (MIN).

Returns

LE_OK The function succeeded.
LE_FAULT The function failed to get the value.
LE_OVERFLOW The CDMA Mobile Identification Number length exceed the maximum length.

Parameters

[out]	msisdnStr	The Mobile Identification Number (MIN) string (null-terminated).
[in]	msisdnStrSize

◆ le_info_GetNai()

le_result_t le_info_GetNai	(	char *	naiStr,
		size_t	naiStrSize
	)

Get the CDMA Network Access Identifier (NAI) string in ASCII text.

Returns

LE_OK The function succeeded.
LE_FAULT The function failed to get the value.
LE_OVERFLOW The Network Access Identifier (NAI) length exceed the maximum length.

Parameters

[out]	naiStr	The Network Access Identifier (NAI) string (null-terminated).
[in]	naiStrSize

◆ le_info_GetPlatformSerialNumber()

le_result_t le_info_GetPlatformSerialNumber	(	char *	platformSerialNumberStr,
		size_t	platformSerialNumberStrSize
	)

Get the Platform Serial Number (PSN) string.

Returns

LE_OK on success
LE_OVERFLOW if Platform Serial Number to big to fit in provided buffer
LE_FAULT for any other errors

Parameters

[out]	platformSerialNumberStr	Platform Serial Number string.
[in]	platformSerialNumberStrSize

◆ le_info_GetPriId()

le_result_t le_info_GetPriId	(	char *	priIdPnStr,
		size_t	priIdPnStrSize,
		char *	priIdRevStr,
		size_t	priIdRevStrSize
	)

Get the Product Requirement Information Part Number and Revision Number strings in ASCII text.

Returns

LE_OK The function succeeded.
LE_FAULT The function failed to get the value.
LE_OVERFLOW The Part or the Revision Number strings length exceed the maximum length.

Parameters

[out]	priIdPnStr	The Product Requirement Information Identifier (PRI ID) Part Number string (null-terminated).
[in]	priIdPnStrSize
[out]	priIdRevStr	The Product Requirement Information Identifier (PRI ID) Revision Number string (null-terminated).
[in]	priIdRevStrSize

◆ le_info_GetPrlOnlyPreference()

le_result_t le_info_GetPrlOnlyPreference ( bool * prlOnlyPreferencePtr )

Get the CDMA Preferred Roaming List (PRL) only preferences status.

Returns

LE_OK The function succeeded.
LE_NOT_FOUND The information is not available.
LE_FAULT The function failed to get the value.

Parameters

[out] prlOnlyPreferencePtr The CDMA Preferred Roaming List only preferences status.

◆ le_info_GetPrlVersion()

le_result_t le_info_GetPrlVersion ( uint16_t * prlVersionPtr )

Get the CDMA version of Preferred Roaming List (PRL).

Returns

LE_OK The function succeeded.
LE_NOT_FOUND The information is not available.
LE_FAULT The function failed to get the value.

Parameters

[out] prlVersionPtr The Preferred Roaming List (PRL) version.

◆ le_info_GetResetInformation()

le_result_t le_info_GetResetInformation	(	le_info_Reset_t *	resetPtr,
		char *	resetSpecificInfoStr,
		size_t	resetSpecificInfoStrSize
	)

Get the last reset information reason

Returns

LE_OK on success
LE_UNSUPPORTED if it is not supported by the platform LE_OVERFLOW specific reset information length exceeds the maximum length.
LE_FAULT for any other errors

Note: If the caller is passing a bad pointer into this function, it is a fatal error, the function will not return.

Parameters

[out]	resetPtr	Reset information
[out]	resetSpecificInfoStr	Reset specific information
[in]	resetSpecificInfoStrSize

◆ le_info_GetRfDeviceStatus()

le_result_t le_info_GetRfDeviceStatus	(	uint16_t *	manufacturedIdPtr,
		size_t *	manufacturedIdSizePtr,
		uint8_t *	productIdPtr,
		size_t *	productIdSizePtr,
		bool *	statusPtr,
		size_t *	statusSizePtr
	)

Get the RF devices working status (i.e. working or broken) of modem's RF devices such as power amplifier, antenna switch and transceiver. That status is updated every time the module power on.

Returns

LE_OK on success
LE_UNSUPPORTED request not supported
LE_FAULT function failed to get the RF devices working status
LE_OVERFLOW the number of statuses exceeds the maximum size (LE_INFO_RF_DEVICES_STATUS_MAX)
LE_BAD_PARAMETER Null pointers provided

Note: If the caller is passing null pointers to this function, it is a fatal error, the function will not return.

Parameters

[out]	manufacturedIdPtr	Manufactured identifier (MID)
[in,out]	manufacturedIdSizePtr
[out]	productIdPtr	Product identifier (PID)
[in,out]	productIdSizePtr
[out]	statusPtr	Status of the RF device (MID,PID): 0 means something wrong 1 means no error found
[in,out]	statusSizePtr

◆ le_info_GetSku()

le_result_t le_info_GetSku	(	char *	skuIdStr,
		size_t	skuIdStrSize
	)

Get the product stock keeping unit number (SKU) string in ASCII text.

Returns

LE_OK The function succeeded.
LE_FAULT The function failed to get the value.
LE_OVERFLOW The SKU number string length exceeds the maximum length.

Parameters

[out]	skuIdStr	Product SKU ID string.
[in]	skuIdStrSize

◆ le_info_GetUnexpectedResetsCount()

le_result_t le_info_GetUnexpectedResetsCount ( uint64_t * resetsCountPtrPtr )

Get the number of unexpected resets

Returns

LE_OK Success
LE_BAD_PARAMETER Input prameter is a null pointer
LE_UNSUPPORTED If not supported by the platform
LE_FAULT Failed to get the number if expected resets

Parameters

[out] resetsCountPtrPtr Number of expected resets

◆ le_info_SetServerDisconnectHandler()

LE_FULL_API void le_info_SetServerDisconnectHandler	(	le_info_DisconnectHandler_t	disconnectHandler,
		void *	contextPtr
	)

Set handler called when server disconnection is detected.

When a server connection is lost, call this handler then exit with LE_FATAL. If a program wants to continue without exiting, it should call longjmp() from inside the handler.

◆ le_info_TryConnectService()

le_result_t le_info_TryConnectService ( void )

Try to connect the current client thread to the service providing this API. Return with an error if the service is not available.

For each thread that wants to use this API, either ConnectService or TryConnectService must be called before any other functions in this API. Normally, ConnectService is automatically called for the main thread, but not for any other thread. For details, see Client-specific Functions.

This function is created automatically.

Returns

LE_OK if the client connected successfully to the service.
LE_UNAVAILABLE if the server is not currently offering the service to which the client is bound.
LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).
LE_COMM_ERROR if the Service Directory cannot be reached.

/ Legato Documentation

le_info_interface.h File Reference

Typedefs

Functions

Detailed Description

Typedef Documentation

◆ le_info_DisconnectHandler_t

Function Documentation

◆ le_info_ConnectService()

◆ le_info_DisconnectService()

◆ le_info_GetBootloaderVersion()

◆ le_info_GetCarrierPri()

◆ le_info_GetDeviceModel()

◆ le_info_GetEsn()

◆ le_info_GetExpectedResetsCount()

◆ le_info_GetFirmwareVersion()

◆ le_info_GetImei()

◆ le_info_GetImeiSv()

◆ le_info_GetManufacturerName()

◆ le_info_GetMdn()

◆ le_info_GetMeid()

◆ le_info_GetMin()

◆ le_info_GetNai()

◆ le_info_GetPlatformSerialNumber()

◆ le_info_GetPriId()

◆ le_info_GetPrlOnlyPreference()

◆ le_info_GetPrlVersion()

◆ le_info_GetResetInformation()

◆ le_info_GetRfDeviceStatus()

◆ le_info_GetSku()

◆ le_info_GetUnexpectedResetsCount()

◆ le_info_SetServerDisconnectHandler()

◆ le_info_TryConnectService()