SWI CDMA specific IOTA related APIs. More...

#include "SwiDataTypes.h"
#include "SwiRcodes.h"
#include "SwiApiCdmaBasic.h"

Data Structures
struct	SWI_STRUCT_IOTA_State

struct	SWI_STRUCT_IOTA_WAPPush

Macros
#define	LENGTH_WAPUri 128

Typedefs
typedef enum SWI_EMIOTA_EVENT_TYPE	SWI_EMIOTA_EVENT_TYPE

typedef enum SWI_EMIOTA_EVENT_RESULT	SWI_EMIOTA_EVENT_RESULT

typedef enum SWI_EMIOTA_EVENT_FAIL_REASON	SWI_EMIOTA_EVENT_FAIL_REASON

typedef enum SWI_EMIOTA_EVENT_ERR_CODE	SWI_EMIOTA_EVENT_ERR_CODE

typedef struct SWI_STRUCT_IOTA_State	SWI_STRUCT_IOTA_State

typedef struct SWI_STRUCT_IOTA_WAPPush	SWI_STRUCT_IOTA_WAPPush

Enumerations
enum	SWI_EMIOTA_EVENT_TYPE { SWI_EMIOTA_SESSION_START, SWI_EMIOTA_SESSION_END }

enum	SWI_EMIOTA_EVENT_RESULT { SWI_EMIOTA_EVENT_RESULT_SUCCESS, SWI_EMIOTA_EVENT_RESULT_FAILURE }

enum	SWI_EMIOTA_EVENT_FAIL_REASON { SWI_EMIOTA_STATUS_MIN = -1, SWI_EMIOTA_STATUS_SUCCESS, SWI_EMIOTA_STATUS_ERROR_DISCONNECT, SWI_EMIOTA_STATUS_ERROR_NOT_ALLOWED, SWI_EMIOTA_STATUS_ERROR_ALREADY_ACTIVE, SWI_EMIOTA_STATUS_ERROR_CLIENT_ABORT, SWI_EMIOTA_STATUS_ERROR_HTTP, SWI_EMIOTA_STATUS_ERROR_MIME, SWI_EMIOTA_STATUS_ERROR_XML, SWI_EMIOTA_STATUS_ERROR_MMC, SWI_EMIOTA_STATUS_ERROR_NOT_TRUSTED, SWI_EMIOTA_STATUS_ERROR_SESSION_TIMEOUT, SWI_EMIOTA_STATUS_ERROR_UNKNOWN, SWI_EMIOTA_STATUS_ERROR_INTERNAL, SWI_EMIOTA_STATUS_ERROR_NO_SERVICE, SWI_EMIOTA_STATUS_ERROR_ACTIVE_DATA_CALL, SWI_EMIOTA_STATUS_ERROR_ACTIVE_VOICE_CALL, SWI_EMIOTA_STATUS_ERROR_NO_DIGITAL_SERVICE, SWI_EMIOTA_STATUS_MAX }

enum	SWI_EMIOTA_EVENT_ERR_CODE { SWI_EMIOTA_ERR_MMC_DISCONNECT, SWI_EMIOTA_ERR_INVALID_VALREF, SWI_EMIOTA_ERR_CID_MISSING, SWI_EMIOTA_ERR_DLD_FAILED, SWI_EMIOTA_ERR_RESERVED, SWI_EMIOTA_ERR_INVALID_CONTENT, SWI_EMIOTA_ERR_USR_DENIED, SWI_EMIOTA_ERR_BAD_VALUE, SWI_EMIOTA_ERR_TIMEOUT, SWI_EMIOTA_ERR_NONEW_DOC, SWI_EMIOTA_ERR_DELETE_FAILED, SWI_EMIOTA_ERR_BAD_DATA, SWI_EMIOTA_ERR_DISPLAY_DISABLED, SWI_EMIOTA_ERR_WRITE_ONLY, SWI_EMIOTA_ERR_RESULT_ABORT, SWI_EMIOTA_ERR_RESERVED1, SWI_EMIOTA_ERR_BAD_OBJECT, SWI_EMIOTA_ERR_UNKNOWN_RESULT, SWI_EMIOTA_ERR_FILE_LOCKED, SWI_EMIOTA_ERR_FILE_OPEN, SWI_EMIOTA_ERR_CHECK_FAILED, SWI_EMIOTA_ERR_INVALID_SIZE, SWI_EMIOTA_ERR_INVALID_OFFSET, SWI_EMIOTA_ERR_DEVICE_BUSY, SWI_EMIOTA_ERR_RESERVED2 }

Functions
SWI_API SWI_RCODE	SwiGetEFileInfo (const swi_charp pszEFilename, SWI_STRUCT_EFileInfo *psEFileInfo, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetEFile (const swi_charp pszEFilename, swi_uint8 *pBuffer, swi_uint16 nBufLen, swi_uint32 timeout)

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.

Macro Definition Documentation

#define LENGTH_WAPUri 128

Max URI length.

Typedef Documentation

typedef enum SWI_EMIOTA_EVENT_ERR_CODE SWI_EMIOTA_EVENT_ERR_CODE

An enumeration of embedded IOTA failure error code.

For HTTP Error - actual HTTP error code should be captured.

typedef enum SWI_EMIOTA_EVENT_FAIL_REASON SWI_EMIOTA_EVENT_FAIL_REASON

An enumeration of embedded IOTA failure reason.

typedef enum SWI_EMIOTA_EVENT_RESULT SWI_EMIOTA_EVENT_RESULT

An enumeration of embedded IOTA result.

typedef enum SWI_EMIOTA_EVENT_TYPE SWI_EMIOTA_EVENT_TYPE

An enumeration of embedded IOTA event type.

typedef struct SWI_STRUCT_IOTA_State SWI_STRUCT_IOTA_State

Contains embedded ITOA notification data structure.

This data structure is used as a member of the notification SWI_NOTIFY_IOTA_Status. Refer to the description of SWI_NOTIFY_IOTA_Status for more detail.

typedef struct SWI_STRUCT_IOTA_WAPPush SWI_STRUCT_IOTA_WAPPush

Contains embedded ITOA WAP URI notification data structure.

This data structure is used as a member of the notification SWI_NOTIFY_IOTA_WAPPush. Refer to the description of SWI_NOTIFY_IOTA_WAPPush for more detail.

Enumeration Type Documentation

enum SWI_EMIOTA_EVENT_ERR_CODE

An enumeration of embedded IOTA failure error code.

For HTTP Error - actual HTTP error code should be captured.

Enumerator
SWI_EMIOTA_ERR_MMC_DISCONNECT	0:Normal Release (MMC "disconnect")
SWI_EMIOTA_ERR_INVALID_VALREF	1:MMC_RESULT_INVALID_VALUEREF
SWI_EMIOTA_ERR_CID_MISSING	2:MMC_RESULT_CID_MISSING
SWI_EMIOTA_ERR_DLD_FAILED	3:MMC_RESULT_DOWNLOAD_FAILED
SWI_EMIOTA_ERR_RESERVED	4:reserved
SWI_EMIOTA_ERR_INVALID_CONTENT	5:MMC_RESULT_INVALID_CONTENT
SWI_EMIOTA_ERR_USR_DENIED	6:MMC_RESULT_USER_DENIED
SWI_EMIOTA_ERR_BAD_VALUE	7:MMC_RESULT_BAD_VALUE
SWI_EMIOTA_ERR_TIMEOUT	8:MMC_RESULT_TIMEOUT
SWI_EMIOTA_ERR_NONEW_DOC	9:MMC_RESULT_NEW_DOC_ARRIVED
SWI_EMIOTA_ERR_DELETE_FAILED	10:MMC_RESULT_DELETE_FAILED
SWI_EMIOTA_ERR_BAD_DATA	11:MMC_RESULT_BAD_DATA
SWI_EMIOTA_ERR_DISPLAY_DISABLED	12:MMC_RESULT_DISPLAY_DISABLED
SWI_EMIOTA_ERR_WRITE_ONLY	13:MMC_RESULT_WRITE_ONLY
SWI_EMIOTA_ERR_RESULT_ABORT	14:MMC_RESULT_ABORT
SWI_EMIOTA_ERR_RESERVED1	15:reserved
SWI_EMIOTA_ERR_BAD_OBJECT	16:MMC_RESULT_BAD_OBJECT
SWI_EMIOTA_ERR_UNKNOWN_RESULT	17:MMC_RESULT_UNKNOWN_ERROR
SWI_EMIOTA_ERR_FILE_LOCKED	18:MMC_RESULT_FILE_LOCKED
SWI_EMIOTA_ERR_FILE_OPEN	19:MMC_RESULT_FILE_OPEN
SWI_EMIOTA_ERR_CHECK_FAILED	20:MMC_RESULT_CHECK_FAILED
SWI_EMIOTA_ERR_INVALID_SIZE	21:MMC_RESULT_INVALID_SIZE
SWI_EMIOTA_ERR_INVALID_OFFSET	22:MMC_RESULT_INVALID_OFFSET
SWI_EMIOTA_ERR_DEVICE_BUSY	23:MMC_RESULT_DEVICE_BUSY
SWI_EMIOTA_ERR_RESERVED2	24:reserved

enum SWI_EMIOTA_EVENT_FAIL_REASON

An enumeration of embedded IOTA failure reason.

Enumerator
SWI_EMIOTA_STATUS_MIN	-1:IOTA status min
SWI_EMIOTA_STATUS_SUCCESS	0:IOTA status success
SWI_EMIOTA_STATUS_ERROR_DISCONNECT	1:status error disconnect
SWI_EMIOTA_STATUS_ERROR_NOT_ALLOWED	2:status error iota session is not allowed
SWI_EMIOTA_STATUS_ERROR_ALREADY_ACTIVE	3:status error iota sesstion is already in progress
SWI_EMIOTA_STATUS_ERROR_CLIENT_ABORT	4:status error client aborted iota session
SWI_EMIOTA_STATUS_ERROR_HTTP	5:status error HTTP
SWI_EMIOTA_STATUS_ERROR_MIME	6:status error MIME
SWI_EMIOTA_STATUS_ERROR_XML	7:status error XML
SWI_EMIOTA_STATUS_ERROR_MMC	8:status error MMC
SWI_EMIOTA_STATUS_ERROR_NOT_TRUSTED	9:status error not trusted domain
SWI_EMIOTA_STATUS_ERROR_SESSION_TIMEOUT	10:status error session timed out
SWI_EMIOTA_STATUS_ERROR_UNKNOWN	11:status error unknown
SWI_EMIOTA_STATUS_ERROR_INTERNAL	12:status error internal
SWI_EMIOTA_STATUS_ERROR_NO_SERVICE	13:status error no service
SWI_EMIOTA_STATUS_ERROR_ACTIVE_DATA_CALL	14:status error user is in active data call
SWI_EMIOTA_STATUS_ERROR_ACTIVE_VOICE_CALL	15:status error user is in active voice call
SWI_EMIOTA_STATUS_ERROR_NO_DIGITAL_SERVICE	16:status error user is no digital service ( roaming mode )
SWI_EMIOTA_STATUS_MAX	17:iota status max

enum SWI_EMIOTA_EVENT_RESULT

An enumeration of embedded IOTA result.

Enumerator
SWI_EMIOTA_EVENT_RESULT_SUCCESS	0:event successful
SWI_EMIOTA_EVENT_RESULT_FAILURE	1:event failed

enum SWI_EMIOTA_EVENT_TYPE

An enumeration of embedded IOTA event type.

Enumerator
SWI_EMIOTA_SESSION_START	0:EM IOTA session started
SWI_EMIOTA_SESSION_END	1:EM IOTA session end

Function Documentation

SWI_API SWI_RCODE SwiGetEFile	(	const swi_charp	pszEFilename,
		swi_uint8 *	pBuffer,
		swi_uint16	nBufLen,
		swi_uint32	timeout
	)

SWI_API SWI_RCODE SwiGetEFileInfo	(	const swi_charp	pszEFilename,
		SWI_STRUCT_EFileInfo *	psEFileInfo,
		swi_uint32	timeout
	)

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

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation