SwiApiCdmaIota.c File Reference

SWI CDMA specific IOTA related APIs. More...

#include "SwiApiCdmaIota.h"
#include "ap/apidefs.h"

Macros
#define	SWI_EMIOTA_FILE   "iota_log"

Functions
SWI_API SWI_RCODE	SwiStartIOTASession (swi_uint32 timeout)
SWI_API SWI_RCODE	SwiStopIOTASession (swi_uint32 timeout)
SWI_API SWI_RCODE	SwiSetIOTADisable (swi_bool bDisable, swi_uint32 timeout)
SWI_API SWI_RCODE	SwiGetIOTADisable (swi_bool *pbDisable, swi_uint32 timeout)
SWI_API SWI_RCODE	SwiGetIOTALog (swi_uint8 *pBuffer, swi_uint16 nBufLen, swi_uint32 timeout)
SWI_API SWI_RCODE	SwiGetIOTALogSize (swi_uint16 *nBufLen, swi_uint32 timeout)

Detailed Description

SWI CDMA specific IOTA related APIs.

Copyright (c) 2011 Sierra Wireless, Inc. All rights reserved

Macro Definition Documentation

#define SWI_EMIOTA_FILE   "iota_log"

Embedded IOTA log file name.

Function Documentation

SWI_API SWI_RCODE SwiGetIOTADisable	(	swi_bool *	pbDisable,
		swi_uint32	timeout
	)

This function gets iota disable/enable state

Parameters

pbDisable[OUT]	pointer to save return value. TRUE: IOTA is disabled; FALSE: Enabled.
timeout[IN]	Function timeout in milliseconds.

Returns

See SwiRcodes.h

SWI_API SWI_RCODE SwiGetIOTALog	(	swi_uint8 *	pBuffer,
		swi_uint16	nBufLen,
		swi_uint32	timeout
	)

This function gets IOTA process Log.

Parameters

pBuffer[OUT]	Buffer to hold the complete log data.
nBufLen[IN]	Data size. (Obtained from SwiGetIOTALogSize )
timeout[IN]	Function timeout in milliseconds.

Returns

See SwiRcodes.h

SWI_API SWI_RCODE SwiGetIOTALogSize	(	swi_uint16 *	nBufLen,
		swi_uint32	timeout
	)

This function gets IOTA process Log file size.

Parameters

nBufLen[OUT]	Log data size.
timeout[IN]	Function timeout in milliseconds.

Returns

See SwiRcodes.h

SWI_API SWI_RCODE SwiSetIOTADisable	(	swi_bool	bDisable,
		swi_uint32	timeout
	)

This function disables or enables IOTA in the modem.

Parameters

bDisable[IN]	TRUE: Disable; FALSE: Enable.
timeout[IN]	Function timeout in milliseconds.

Returns

See SwiRcodes.h

SWI_API SWI_RCODE SwiStartIOTASession

(

swi_uint32

timeout

)

This function starts Embedded IOTA session Indication of session will be notified through notification.

Parameters

timeout[IN]

Function timeout in milliseconds.

Returns

See SwiRcodes.h

SWI_API SWI_RCODE SwiStopIOTASession

(

swi_uint32

timeout

)

This function stops Embedded IOTA session. Indication of session will be notified through notification.

Parameters

timeout[IN]

Function timeout in milliseconds.

Returns

See SwiRcodes.h