SwiApiCdmaRuim.c File Reference

SWI CDMA specific Ruim related APIs. More...

#include "SwiApiCdmaRuim.h"
#include "SwiIntPkCdmaRuim.h"
#include "SwiIntUpkCdmaRuim.h"
#include "ap/apidefs.h"

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

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