Header file for for GSM APIs related to the Location Based Services. More...

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

Data Structures
struct	SWI_STRUCT_LbsPaKeepWarmStart

struct	SWI_STRUCT_LbsPaWarmBegin

struct	SWI_STRUCT_LbsPaWarmStatus

struct	SWI_STRUCT_LbsPaWarmDone

struct	SWI_STRUCT_LbsPaKeepWarmStop

struct	SWI_STRUCT_LbsUserOptions

struct	SWI_STRUCT_LbsFixSettings

struct	SWI_STRUCT_LbsNiReq

Macros
#define	MAX_NUM_LBS_SV 12

#define	LENGTH_LbsReqId 33

#define	LENGTH_LbsClientName 33

Enumerations
enum	SWI_TYPE_LbsPaErr { SWI_LBSPAERR_NoError, SWI_LBSPAERR_InternalError, SWI_LBSPAERR_InvalidClientId, SWI_LBSPAERR_ErrorInParamToSet, SWI_LBSPAERR_ErrorInLockType, SWI_LBSPAERR_PhoneOffline, SWI_LBSPAERR_ParamCommandAlreadyActive, SWI_LBSPAERR_IncorrectAppSpecificInfo }

enum	SWI_TYPE_LbsPaWarmStatus { SWI_LBSPAWARMSTATUS_NotWarm, SWI_LBSPAWARMSTATUS_Warm }

enum	SWI_TYPE_LbsSettingStatus { SWI_LBSSETTINGSTATUS_Success }

enum	TYPE_LbsNiReqResp { LBSNIREQRESP_Reject, LBSNIREQRESP_Accept, LBSNIREQRESP_Cancel }

enum	TYPE_LbsNiReqErrCode { LBSNIREQERRCODE_NoError, LBSNIREQERRCODE_HandleMismatch, LBSNIREQERRCODE_UserRespTimeout, LBSNIREQERRCODE_NoUserRespReq }

enum	TYPE_LbsNiReqNotif { LBSNIREQNOTIF_NotifyOnly, LBSNIREQNOTIF_UserRespReq }

enum	TYPE_LbsNiReqId { LBSNIREQID_Unknown, LBSNIREQID_LogicalName, LBSNIREQID_Msisdn, LBSNIREQID_Email, LBSNIREQID_Url, LBSNIREQID_SipUrl, LBSNIREQID_ImsPublicId, LBSNIREQID_Min, LBSNIREQID_Mdn }

enum	TYPE_LbsNiReqClientName { LBSNIREQCLIENTNAME_Unknown, LBSNIREQCLIENTNAME_LogicalName, LBSNIREQCLIENTNAME_Msisdn, LBSNIREQCLIENTNAME_Email, LBSNIREQCLIENTNAME_Url, LBSNIREQCLIENTNAME_SipUrl, LBSNIREQCLIENTNAME_ImsPublicId, LBSNIREQCLIENTNAME_Min, LBSNIREQCLIENTNAME_Mdn }

Functions
SWI_API SWI_RCODE	SwiSetLbsPaKeepWarmStart (swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetLbsPaWarmStatus (struct SWI_STRUCT_LbsPaWarmStatus *psLbsPaWarmStatus, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetLbsPaKeepWarmStop (swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetLbsFixSettings (struct SWI_STRUCT_LbsFixSettings *psLbsFixSettings, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetLbsFixSettings (struct SWI_STRUCT_LbsFixSettings *psLbsFixSettings, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetLbsNiReq (struct SWI_STRUCT_LbsNiReq *pLbsNiReq, swi_uint32 timeout)

Detailed Description

Header file for for GSM APIs related to the Location Based Services.

Macro Definition Documentation

#define LENGTH_LbsClientName 33

Maximum client name length

#define LENGTH_LbsReqId 33

Maximum requestor ID length

#define MAX_NUM_LBS_SV 12

Maximum number of Satelites

Enumeration Type Documentation

enum SWI_TYPE_LbsPaErr

Enumeration of PA error values

See Also: SWI_STRUCT_LbsPaKeepWarmStart; SWI_STRUCT_LbsPaKeepWarmStop

Enumerator
SWI_LBSPAERR_NoError
SWI_LBSPAERR_InternalError
SWI_LBSPAERR_InvalidClientId
SWI_LBSPAERR_ErrorInParamToSet
SWI_LBSPAERR_ErrorInLockType
SWI_LBSPAERR_PhoneOffline
SWI_LBSPAERR_ParamCommandAlreadyActive
SWI_LBSPAERR_IncorrectAppSpecificInfo

enum SWI_TYPE_LbsPaWarmStatus

Enumeration of Keep Warm status

See Also: SWI_STRUCT_LbsPaWarmStatus

Enumerator
SWI_LBSPAWARMSTATUS_NotWarm
SWI_LBSPAWARMSTATUS_Warm

enum SWI_TYPE_LbsSettingStatus

Enumeration of LBS setting status return codes.

Enumerator
SWI_LBSSETTINGSTATUS_Success

enum TYPE_LbsNiReqClientName

Enumeration of LBS network initiated client name types.

Enumerator
LBSNIREQCLIENTNAME_Unknown
LBSNIREQCLIENTNAME_LogicalName
LBSNIREQCLIENTNAME_Msisdn
LBSNIREQCLIENTNAME_Email
LBSNIREQCLIENTNAME_Url
LBSNIREQCLIENTNAME_SipUrl
LBSNIREQCLIENTNAME_ImsPublicId
LBSNIREQCLIENTNAME_Min
LBSNIREQCLIENTNAME_Mdn

enum TYPE_LbsNiReqErrCode

Enumeration of LBS network initiated error codes.

Used by SWI_STRUCT_LbsNiReq to indicate the status of the SwiLbsSetNiReq request.

See Also: SWI_STRUCT_LbsNiReq; SwiSetLbsNiReq

Enumerator
LBSNIREQERRCODE_NoError	Request was successful.
LBSNIREQERRCODE_HandleMismatch	Network request ID provided is invalid.
LBSNIREQERRCODE_UserRespTimeout	Response was not received within the specified timeout period.
LBSNIREQERRCODE_NoUserRespReq	No user response was required.

enum TYPE_LbsNiReqId

Enumeration of LBS network initiated requester ID types.

Enumerator
LBSNIREQID_Unknown
LBSNIREQID_LogicalName
LBSNIREQID_Msisdn
LBSNIREQID_Email
LBSNIREQID_Url
LBSNIREQID_SipUrl
LBSNIREQID_ImsPublicId
LBSNIREQID_Min
LBSNIREQID_Mdn

enum TYPE_LbsNiReqNotif

Enumeration of LBS network initiated notification types.

Used by SWI_STRUCT_LbsNiReq to indicate whether the SWI_NOTIFY_LbsNiReq notification requires a user response.

See Also: SWI_STRUCT_LbsNiReq; SWI_NOTIFY_LbsNiReq; SwiSetLbsNiReq

Enumerator
LBSNIREQNOTIF_NotifyOnly	No user response required.
LBSNIREQNOTIF_UserRespReq	User must respond with SwiSetLbsNiReq.

enum TYPE_LbsNiReqResp

Enumeration of LBS network initiated request responses.

See Also: SWI_STRUCT_LbsNiReq; SWI_NOTIFY_LbsNiReq; SwiSetLbsNiReq

Enumerator
LBSNIREQRESP_Reject	This value should be used with SwiSetLbsNiReq to signal the host has rejected the network initiated request.
LBSNIREQRESP_Accept	This value should be used with SwiSetLbsNiReq to signal the host has accepted the network initiated request.
LBSNIREQRESP_Cancel	This value should be used with SwiSetLbsNiReq to signal the host has canceled the network initiated request or the specified timeout period has expired.

Function Documentation

SWI_API SWI_RCODE SwiGetLbsFixSettings	(	struct SWI_STRUCT_LbsFixSettings *	psLbsFixSettings,
		swi_uint32	timeout
	)

Use this function to retrieve location fix settings stored on the device.

Parameters

psLbsSettings,:	[OUT] A pointer to a SWI_STRUCT_LbsFixSettings structure which contains location fix settings.
timeout,:	[IN] Function timeout in milliseconds.

Returns: SWI_RCODE_OK indicates that the modem has received the request.; See SWI_STRUCT_LbsFixSettings for actual results of the transaction.; See SWI_RCODE for additional information.

SWI_API SWI_RCODE SwiGetLbsPaWarmStatus	(	struct SWI_STRUCT_LbsPaWarmStatus *	psLbsPaWarmStatus,
		swi_uint32	timeout
	)

Use this function to get the Keep Warm processing status.

Parameters

psLbsPaWarmStatus,:	[OUT] A pointer to a SWI_STRUCT_LbsPaWarmStatus structure which contains warm status information.
timeout,:	[IN] Function timeout in milliseconds.

Returns: See SWI_RCODE for additional information.

SWI_API SWI_RCODE SwiSetLbsFixSettings	(	struct SWI_STRUCT_LbsFixSettings *	psLbsFixSettings,
		swi_uint32	timeout
	)

Use this function to change location fix settings stored on the device.

Parameters

psLbsSettings,:	[IN] A pointer to a SWI_STRUCT_LbsFixSettings structure which contains location fix settings.
timeout,:	[IN] Function timeout in milliseconds.

Returns: SWI_RCODE_OK indicates that the modem has received the request.; See SWI_STRUCT_LbsFixSettings for actual results of the transaction.; See SWI_RCODE for additional information.

SWI_API SWI_RCODE SwiSetLbsNiReq	(	struct SWI_STRUCT_LbsNiReq *	pLbsNiReq,
		swi_uint32	timeout
	)

Use this function to respond to a network initiated location fix request.

The host is notified of a network initiated location fix request via SWI_NOTIFY_LbsNiReq.

Parameters

pLbsNiReq,:	[IN/OUT] A pointer to a SWI_STRUCT_LbsNiReq structure which contains network initiated request information.
timeout,:	[IN] Function timeout in milliseconds.

Returns: SWI_RCODE_OK indicates that the modem has received the request.; See SWI_STRUCT_LbsNiReq::eErrCode for actual results of the transaction.; See SWI_RCODE for additional information.

See Also: SWI_STRUCT_LbsNiReq; SWI_NOTIFY_LbsNiReq

SWI_API SWI_RCODE SwiSetLbsPaKeepWarmStart ( swi_uint32 timeout )

Use this function to start Keep Warm processing.

This downloads GPS assistance data over the network. The status of the process can be monitored using:

SWI_NOTIFY_LbsPaWarmBegin
SWI_NOTIFY_LbsPaWarmStatus
SWI_NOTIFY_LbsPaWarmDone

Parameters

timeout,: [IN] Function timeout in milliseconds.

Returns: See SWI_RCODE for additional information.

SWI_API SWI_RCODE SwiSetLbsPaKeepWarmStop ( swi_uint32 timeout )

Use this function to stop the Keep Warm processing.

SWI_NOTIFY_LbsPaWarmDone is generated when the process completes.

Parameters

timeout,: [IN] Function timeout in milliseconds.

Returns: SWI_RCODE_OK indicates that the modem has successfully received the stop request. A SWI_NOTIFY_LbsPaWarmDone notification is sent the the actually process terminates.; See SWI_RCODE for additional information.

See Also: SWI_NOTIFY_LbsPaWarmDone

Data Structures

Macros

Enumerations

Functions

Detailed Description

Macro Definition Documentation

Enumeration Type Documentation

Function Documentation