SwiApiCdmaRuim.h File Reference

SWI CDMA specific Ruim related APIs. More...

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

Go to the source code of this file.

Data Structures
struct	SWI_STRUCT_RuimStatus

Typedefs
typedef enum SWI_TYPE_RuimStatus	SWI_TYPE_RuimStatus
typedef enum SWI_TYPE_RuimOpReq	SWI_TYPE_RuimOpReq
typedef enum SWI_TYPE_RuimPrevOp	SWI_TYPE_RuimPrevOp
typedef enum SWI_TYPE_RuimPrevOpRes	SWI_TYPE_RuimPrevOpRes
typedef enum SWI_TYPE_RuimRetryPres	SWI_TYPE_RuimRetryPres
typedef enum SWI_TYPE_RuimRetry	SWI_TYPE_RuimRetry
typedef enum SWI_RUIM_CHV	SWI_RUIM_CHV
typedef struct SWI_STRUCT_RuimStatus	SWI_STRUCT_RuimStatus

Enumerations
enum	SWI_TYPE_RuimStatus {   SWI_RUIM_STATUS_OK = 0x0000, SWI_RUIM_STATUS_INIT_ERR, SWI_RUIM_STATUS_GENERAL_ERR, SWI_RUIM_STATUS_LOCKED,   SWI_RUIM_STATUS_CHV1_BLOCKED, SWI_RUIM_STATUS_CHV2_BLOCKED, SWI_RUIM_STATUS_CHV1_REJECTED, SWI_RUIM_STATUS_CHV2_REJECTED,   SWI_RUIM_STATUS_POLL_ERR, SWI_RUIM_STATUS_NO_SRV_ERR, SWI_RUIM_STATUS_ICCID_MISMATCH_ERR }
enum	SWI_TYPE_RuimOpReq {   SWI_RUIM_OPREQ_NONE = 0x0000, SWI_RUIM_OPREQ_CHV1, SWI_RUIM_OPREQ_CHV2, SWI_RUIM_OPREQ_CHV_UNBLK1,   SWI_RUIM_OPREQ_CHV_UNBLK2 }
enum	SWI_TYPE_RuimPrevOp {   SWI_RUIM_PREV_OP_NONE = 0x0000, SWI_RUIM_PREV_OP_CHV1CHG, SWI_RUIM_PREV_OP_CHV2CHG, SWI_RUIM_PREV_OP_CHV1VER,   SWI_RUIM_PREV_OP_CHV2VER, SWI_RUIM_PREV_OP_UNBLK1, SWI_RUIM_PREV_OP_UNBLK2, SWI_RUIM_PREV_OP_CHV1_EN,   SWI_RUIM_PREV_OP_CHV1_DIS }
enum	SWI_TYPE_RuimPrevOpRes {   SWI_RUIM_PREV_OP_FAIL = 0x0000, SWI_RUIM_PREV_OP_SUCCESS, SWI_RUIM_PREV_OP_FAIL_VER, SWI_RUIM_PREV_OP_FAIL_CHV_LEN,   SWI_RUIM_PREV_OP_FAIL_UNBLK_LEN, SWI_RUIM_PREV_OP_FAIL_NO_SRV, SWI_RUIM_PREV_OP_FAIL_EMERG }
enum	SWI_TYPE_RuimRetryPres { SWI_RUIM_NO_RETRY_INFO = 0x0000, SWI_RUIM_RETRY_INFO }
enum	SWI_TYPE_RuimRetry { SWI_RUIM_RETRY_CHV1 = 0x0000, SWI_RUIM_RETRY_CHV2, SWI_RUIM_RETRY_UNBLOCK_CHV1, SWI_RUIM_RETRY_UNBLOCK_CHV2 }
enum	SWI_RUIM_CHV { SWI_RUIM_CHV1 = 0x0001, SWI_RUIM_CHV2, SWI_RUIM_UNBLOCK_CHV1, SWI_RUIM_UNBLOCK_CHV2 }

Functions
SWI_API SWI_RCODE	SwiGetRUIMStatus (SWI_STRUCT_RuimStatus *sRuimStatus, swi_uint32 timeout)
SWI_API SWI_RCODE	SwiVerifyCHV (swi_uint16 Chv, const swi_charp szCHV, swi_uint32 timeout)
SWI_API SWI_RCODE	SwiEnableCHV (swi_bool bEnable, const swi_charp szCHV, swi_uint32 timeout)
SWI_API SWI_RCODE	SwiChangeCHV (swi_uint16 Chv, const swi_charp szOldCHV, const swi_charp szNewCHV, swi_uint32 timeout)
SWI_API SWI_RCODE	SwiUnblockCHV (swi_uint16 Chv, const swi_charp szUnblockCHV, const swi_charp szCHV, swi_uint32 timeout)
SWI_API SWI_RCODE	SwiGetCHVEnableStatus (swi_bool *bEnable, swi_uint32 timeout)

Detailed Description

SWI CDMA specific Ruim related APIs.

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

Typedef Documentation

typedef enum SWI_RUIM_CHV SWI_RUIM_CHV

An enumeration of RUIM chv.

typedef struct SWI_STRUCT_RuimStatus SWI_STRUCT_RuimStatus

Contains RUIM statue data.

typedef enum SWI_TYPE_RuimOpReq SWI_TYPE_RuimOpReq

An enumeration of RUIM user required operation.

typedef enum SWI_TYPE_RuimPrevOp SWI_TYPE_RuimPrevOp

An enumeration of RUIM previous user operation reporting on.

typedef enum SWI_TYPE_RuimPrevOpRes SWI_TYPE_RuimPrevOpRes

An enumeration of RUIM revious user operation result.

typedef enum SWI_TYPE_RuimRetry SWI_TYPE_RuimRetry

An enumeration of RUIM retry information type.

typedef enum SWI_TYPE_RuimRetryPres SWI_TYPE_RuimRetryPres

An enumeration of RUIM retry information present.

typedef enum SWI_TYPE_RuimStatus SWI_TYPE_RuimStatus

An enumeration of RUIM status.

Enumeration Type Documentation

enum SWI_RUIM_CHV

An enumeration of RUIM chv.

Enumerator
SWI_RUIM_CHV1	CHV1
SWI_RUIM_CHV2	CHV1
SWI_RUIM_UNBLOCK_CHV1	CHV1
SWI_RUIM_UNBLOCK_CHV2	CHV1

enum SWI_TYPE_RuimOpReq

An enumeration of RUIM user required operation.

Enumerator
SWI_RUIM_OPREQ_NONE	None
SWI_RUIM_OPREQ_CHV1	Reenter CHV1
SWI_RUIM_OPREQ_CHV2	Reenter CHV2
SWI_RUIM_OPREQ_CHV_UNBLK1	Reenter unblocking CHV1 code
SWI_RUIM_OPREQ_CHV_UNBLK2	Reenter unblocking CHV2 code

enum SWI_TYPE_RuimPrevOp

An enumeration of RUIM previous user operation reporting on.

Enumerator
SWI_RUIM_PREV_OP_NONE	None
SWI_RUIM_PREV_OP_CHV1CHG	Change CHV1
SWI_RUIM_PREV_OP_CHV2CHG	Change CHV2
SWI_RUIM_PREV_OP_CHV1VER	Verify CHV1
SWI_RUIM_PREV_OP_CHV2VER	Verify CHV2
SWI_RUIM_PREV_OP_UNBLK1	Unblock CHV1
SWI_RUIM_PREV_OP_UNBLK2	Unblock CHV2
SWI_RUIM_PREV_OP_CHV1_EN	CHV1 enable
SWI_RUIM_PREV_OP_CHV1_DIS	CHV2 enable

enum SWI_TYPE_RuimPrevOpRes

An enumeration of RUIM revious user operation result.

Enumerator
SWI_RUIM_PREV_OP_FAIL	Failed
SWI_RUIM_PREV_OP_SUCCESS	Succeeded
SWI_RUIM_PREV_OP_FAIL_VER	Failed because CHV not enabled
SWI_RUIM_PREV_OP_FAIL_CHV_LEN	Failed because CHV length out of range (4-8 digits valid)
SWI_RUIM_PREV_OP_FAIL_UNBLK_LEN	Failed because unblocking CHV length out of range(must be 8 digits)
SWI_RUIM_PREV_OP_FAIL_NO_SRV	Failed because disable CHV1 service is not allocated and activated
SWI_RUIM_PREV_OP_FAIL_EMERG	Failed because CHV starts with an emergency number

enum SWI_TYPE_RuimRetry

An enumeration of RUIM retry information type.

Enumerator
SWI_RUIM_RETRY_CHV1	CHV1
SWI_RUIM_RETRY_CHV2	CHV2
SWI_RUIM_RETRY_UNBLOCK_CHV1	unblocking CHV1
SWI_RUIM_RETRY_UNBLOCK_CHV2	unblocking CHV2

enum SWI_TYPE_RuimRetryPres

An enumeration of RUIM retry information present.

Enumerator
SWI_RUIM_NO_RETRY_INFO	False
SWI_RUIM_RETRY_INFO	True

enum SWI_TYPE_RuimStatus

An enumeration of RUIM status.

Enumerator
SWI_RUIM_STATUS_OK	RUIM OK
SWI_RUIM_STATUS_INIT_ERR	RUIM initialization error (fatal)
SWI_RUIM_STATUS_GENERAL_ERR	RUIM general failure (fatal)
SWI_RUIM_STATUS_LOCKED	RUIM locked
SWI_RUIM_STATUS_CHV1_BLOCKED	CHV1 blocked
SWI_RUIM_STATUS_CHV2_BLOCKED	CHV2 blocked
SWI_RUIM_STATUS_CHV1_REJECTED	CHV1 rejected(no recoverable error)
SWI_RUIM_STATUS_CHV2_REJECTED	CHV2 rejected
SWI_RUIM_STATUS_POLL_ERR	Polling error (fatal)
SWI_RUIM_STATUS_NO_SRV_ERR	Wrong RUIM inserted after PC card powered up
SWI_RUIM_STATUS_ICCID_MISMATCH_ERR	RUIM OK

Function Documentation

SWI_API SWI_RCODE SwiChangeCHV	(	swi_uint16	Chv,
		const swi_charp	szOldCHV,
		const swi_charp	szNewCHV,
		swi_uint32	timeout
	)

This function changes the CHV code

Parameters

Chv[IN]	Type of CHV
szOldCHV	Old CHV code
szNewCHV	New CHV code
timeout[IN]	Function timeout in milliseconds.

Returns

See SwiRcodes.h

SWI_API SWI_RCODE SwiEnableCHV	(	swi_bool	bEnable,
		const swi_charp	szCHV,
		swi_uint32	timeout
	)

This function enables or disable CHV Security.

Parameters

bEnable[IN]	TRUE:Enable or FALSE:disable
szCHV[IN]	CHV code
timeout[IN]	Function timeout in milliseconds.

Returns

See SwiRcodes.h

SWI_API SWI_RCODE SwiGetCHVEnableStatus	(	swi_bool *	bEnable,
		swi_uint32	timeout
	)

This function retrieves CHV enabled status

Parameters

bEnable[OUT]	TRUE:CHV Enabled; FALSE: CHV disabled.
timeout[IN]	Function timeout in milliseconds.

Returns

See SwiRcodes.h

SWI_API SWI_RCODE SwiGetRUIMStatus	(	SWI_STRUCT_RuimStatus *	sRuimStatus,
		swi_uint32	timeout
	)

This function retrieves the current RUIM Status.

Parameters

sRuimStatus[OUT]	Data Structure to contain the RUIM status.
timeout[IN]	Function timeout in milliseconds.

Returns

See SwiRcodes.h

SWI_API SWI_RCODE SwiUnblockCHV	(	swi_uint16	Chv,
		const swi_charp	szUnblockCHV,
		const swi_charp	szCHV,
		swi_uint32	timeout
	)

This function unblocks the CHV code

Parameters

Chv[IN]	Type of CHV
szUnblockCHV	Unblocking code
szCHV[IN]	New CHV code to use
timeout[IN]	Function timeout in milliseconds.

Returns

See SwiRcodes.h

SWI_API SWI_RCODE SwiVerifyCHV	(	swi_uint16	Chv,
		const swi_charp	szCHV,
		swi_uint32	timeout
	)

This function request the modem to verify the passed in CHV code.

Parameters

Chv[IN]	Type of CHV.
szCHV[IN]	CHV code.
timeout[IN]	Function timeout in milliseconds.

Returns

See SwiRcodes.h