SWI CDMA specific LBS related APIs. More...

#include "SwiApiCmLbs.h"
#include "SwiApiCdmaLbs.h"
#include "SwiIntPkCdmaLbs.h"
#include "SwiIntUpkCdmaLbs.h"
#include "ap/apidefs.h"

Functions
SWI_API SWI_RCODE	SwiGetLbsLocNotifyStatus (SWI_STRUCT_LbsLocNotifyStatus *psNotifyStatus, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetLbsLocNotifyStatus (const SWI_STRUCT_LbsLocNotifyStatus *psNotifyStatus, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetLbsDloadNotifyStatus (SWI_STRUCT_LbsDloadNotifyStatus *psNotifyStatus, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetLbsDloadNotifyStatus (const SWI_STRUCT_LbsDloadNotifyStatus *psNotifyStatus, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetLbsParamNotifyStatus (SWI_STRUCT_LbsParamNotifyStatus *psNotifyStatus, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetLbsParamNotifyStatus (const SWI_STRUCT_LbsParamNotifyStatus *psNotifyStatus, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetLbsPdDownload (const SWI_STRUCT_LbsPdDownload *psLbsPdDownload, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetLbsPaGpsLock (SWI_STRUCT_LbsPaGpsLock *psPaGpsLock, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetLbsPaGpsLock (const SWI_STRUCT_LbsPaGpsLock *psPaGpsLock, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetLbsPaPtlmMode (SWI_STRUCT_LbsPaPtlmMode *psPaPtlmMode, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetLbsPaPtlmMode (const SWI_STRUCT_LbsPaPtlmMode *psPaPtlmMode, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetLbsPaPrivacy (SWI_STRUCT_LbsPaPrivacy *psPaPrivacy, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetLbsPaPrivacy (const SWI_STRUCT_LbsPaPrivacy *psPaPrivacy, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetLbsPaNetAccess (SWI_STRUCT_LbsPaNetAccess *psPaNetAccess, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetLbsPaNetAccess (const SWI_STRUCT_LbsPaNetAccess *psPaNetAccess, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetLbsPaBsInfo (SWI_STRUCT_LbsPaBsInfo *psBsInfo, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetLbsSmartModeControl (swi_uint8 *pnMask, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetLbsSmartModeControl (swi_uint8 nMask, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetLbsSWSmartModeControl (swi_uint8 *pnMask, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetLbsSWSmartModeControl (swi_uint8 nMask, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetLbsFixTypeControl (SWI_STRUCT_LBS_FixTypeControl *pFixTypeControl, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetLbsFixTypeControl (const SWI_STRUCT_LBS_FixTypeControl *pFixTypeControl, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetLbsCLMControl (swi_uint8 *pnMask, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetLbsCLMControl (swi_uint8 nMask, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetLbsNemaOutputMessageControl (swi_uint8 *pnMask, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetLbsNemaOutputMessageControl (swi_uint8 nMask, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetLbsAutoStart (SWI_STRUCT_LbsAutoStart *psLbsAutoStart, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetLbsAutoStart (const SWI_STRUCT_LbsAutoStart *psLbsAutoStart, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetLbsFixTypeSupportStatus (swi_uint8 *pStatus, swi_uint32 nLen, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetLbsXtraAssistData (SWI_STRUCT_LBS_XTRA_ASSIST_DATA_GET *data, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetLbsXtraAssistData (SWI_STRUCT_LBS_XTRA_ASSIST_DATA_SET data, LBS_XTRA_ASSIST_DATA_RESULT response, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetLbsXtraTimeInfo (SWI_STRUCT_LBS_XTRA_TIME_INFO_SET data, LBS_XTRA_ASSIST_DATA_RESULT response, swi_uint32 timeout)

static SWI_RCODE	SwiGetLbsXtraServerURL (swi_uint16theCNSType, SWI_STRUCT_LBS_XTRA_SERVER_URL *data, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetLbsXtraDataServerURL (SWI_STRUCT_LBS_XTRA_SERVER_URL *data, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetLbsXtraTimeServerURL (SWI_STRUCT_LBS_XTRA_SERVER_URL *data, swi_uint32 timeout)

Detailed Description

SWI CDMA specific LBS related APIs.

Function Documentation

SWI_API SWI_RCODE SwiGetLbsAutoStart	(	SWI_STRUCT_LbsAutoStart *	psLbsAutoStart,
		swi_uint32	timeout
	)

This function gets GPS AutoStart settings

Parameters

psLbsAutoStart[OUT]	AutoStart Settings. See SWI_STRUCT_LbsAutoStart.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiGetLbsCLMControl	(	swi_uint8 *	pnMask,
		swi_uint32	timeout
	)

This function get LBS Coarse Location Message (CLM) Control.

Parameters

pnMask[OUT]	Pointer save CLM control value. One 8-Bit Data Field to Enable/Disable the CLM Request Message Support.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiGetLbsDloadNotifyStatus	(	SWI_STRUCT_LbsDloadNotifyStatus *	psNotifyStatus,
		swi_uint32	timeout
	)

This function reports LBS download notification status mask.

Use this function to check the current notification state of the following group of LBS notifications:

SWI_NOTIFY_LbsPdDloadBegin
SWI_NOTIFY_LbsPdDloadData
SWI_NOTIFY_LbsPdDloadDone
SWI_NOTIFY_LbsPdDloadEnd

Parameters

psNotifyStatus[OUT]	Current notification state.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiGetLbsFixTypeControl	(	SWI_STRUCT_LBS_FixTypeControl *	pFixTypeControl,
		swi_uint32	timeout
	)

This function get LBS fix type control.

Parameters

pFixTypeControl[OUT]	Pointer save fix type control value. See SWI_STRUCT_LBS_FixTypeControl.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiGetLbsFixTypeSupportStatus	(	swi_uint8 *	pStatus,
		swi_uint32	nLen,
		swi_uint32	timeout
	)

This function gets LBS fix type support status.

Parameters

pStatus[OUT]	LBS fix type support status.
nLen[IN]	Length of output buffer.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiGetLbsLocNotifyStatus	(	SWI_STRUCT_LbsLocNotifyStatus *	psNotifyStatus,
		swi_uint32	timeout
	)

This function reports the LBS notification status mask.

Use this function to check the current notification state of the following group of LBS notifications:

SWI_NOTIFY_LbsPdDone
SWI_NOTIFY_LbsPdData
SWI_NOTIFY_LbsPdEnd
SWI_NOTIFY_LbsPdBegin
SWI_NOTIFY_LbsPdUpdateFailure

Parameters

psNotifyStatus[OUT]	Current notification state.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiGetLbsNemaOutputMessageControl	(	swi_uint8 *	pnMask,
		swi_uint32	timeout
	)

This function gets NMEA Output Message Control

Parameters

pnMask[OUT] Pointer save NMEA Output Message control value. One 8-Bit Data Field with 5 bits defined and OR'd together to control the different NMEA message types being output. GPGGA Message Type [Valid choice is Enable (0x01) or Disable (0x00)] GPGSA Message Type [Valid choice is Enable (0x02) or Disable (0x00)] GPGSV Message Type [Valid choice is Enable (0x04) or Disable (0x00)] GPVTG Message Type [Valid choice is Enable (0x08) or Disable (0x00)] GPRMC Message Type [Valid choice is Enable (0x10) or Disable (0x00)]

timeout[IN] Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiGetLbsPaBsInfo	(	SWI_STRUCT_LbsPaBsInfo *	psBsInfo,
		swi_uint32	timeout
	)

This function gets current GPS base station information.

Parameters

psBsInfo[OUT]	Base station information.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiGetLbsPaGpsLock	(	SWI_STRUCT_LbsPaGpsLock *	psPaGpsLock,
		swi_uint32	timeout
	)

This function gets GPS Lock settings from the modem.

Parameters

psPaGpsLock[OUT]	GPS lock settings.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiGetLbsPaNetAccess	(	SWI_STRUCT_LbsPaNetAccess *	psPaNetAccess,
		swi_uint32	timeout
	)

This function gets GPS network access permissions used during LBS sessions.

Parameters

psPaNetAccess[OUT]	Network access permissions.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiGetLbsPaPrivacy	(	SWI_STRUCT_LbsPaPrivacy *	psPaPrivacy,
		swi_uint32	timeout
	)

This function gets GPS privacy setting used for LBS sessions.

Parameters

psPaPrivacy[OUT]	Privacy settings.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiGetLbsPaPtlmMode	(	SWI_STRUCT_LbsPaPtlmMode *	psPaPtlmMode,
		swi_uint32	timeout
	)

This function gets the mechanism used to transport LBS messages.

Parameters

psPaPtlmMode[OUT]	Transport mechanism.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiGetLbsParamNotifyStatus	(	SWI_STRUCT_LbsParamNotifyStatus *	psNotifyStatus,
		swi_uint32	timeout
	)

This function reports LBS parameter notification status mask.

Use this function to check the current notification state of the following group of CnS notifications:

SWI_NOTIFY_LbsPaIpAddr
SWI_NOTIFY_LbsPaGpsLock
SWI_NOTIFY_LbsPaPtlmMode
SWI_NOTIFY_LbsPaPortId
SWI_NOTIFY_LbsPaPrivacy
SWI_NOTIFY_LbsPaNetAccess

Parameters

psNotifyStatus[OUT]	Current notification state.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiGetLbsSmartModeControl	(	swi_uint8 *	pnMask,
		swi_uint32	timeout
	)

This function gets Qualcomm smart mode control.

Parameters

pnMask[OUT]	Pointer save Smart Mode control value. One 8-Bit Data Field with two bits assigned to two different smart modes and ORd Together. Smart MS-Based Mode [Valid choice is Enable (0x01) or Disable (0x00)]. Smart Standalone Mode [Valid choice is Enable (0x02) or Disable (0x00)].
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiGetLbsSWSmartModeControl	(	swi_uint8 *	pnMask,
		swi_uint32	timeout
	)

This function get Sierra Wireless smart mode control.

Parameters

pnMask[OUT]	pointer save Smart Mode control value. One 8-Bit Field to allow Enable/Disable of Sierra MS-Based Fallback.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiGetLbsXtraAssistData	(	SWI_STRUCT_LBS_XTRA_ASSIST_DATA_GET *	data,
		swi_uint32	timeout
	)

This function gets current almanac data status.

Parameters

data[OUT]	Contains the returned almanac data.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiGetLbsXtraDataServerURL	(	SWI_STRUCT_LBS_XTRA_SERVER_URL *	data,
		swi_uint32	timeout
	)

This function gets GPS One Xtra server URL to acquire almanac injection data

Parameters

data[OUT]	Contain GPS One Xtra data server URL returned.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

static SWI_RCODE SwiGetLbsXtraServerURL	(	swi_uint16	theCNSType,
		SWI_STRUCT_LBS_XTRA_SERVER_URL *	data,
		swi_uint32	timeout
	)

static

SWI_API SWI_RCODE SwiGetLbsXtraTimeServerURL	(	SWI_STRUCT_LBS_XTRA_SERVER_URL *	data,
		swi_uint32	timeout
	)

This function gets GPS One Xtra server URL to acquire time injection data.

Parameters

data[OUT]	Contain GPS One Xtra time server URL returned.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiSetLbsAutoStart	(	const SWI_STRUCT_LbsAutoStart *	psLbsAutoStart,
		swi_uint32	timeout
	)

This function sets GPS AutoStart Settings

Parameters

psLbsAutoStart[IN]	AutoStart Settings. See SWI_STRUCT_LbsAutoStart.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiSetLbsCLMControl	(	swi_uint8	nMask,
		swi_uint32	timeout
	)

This function sets GPS Coarse Location Message (CLM) Control.

Parameters

nMask[IN]	CLM control value to set. One 8-Bit Data Field to Enable/Disable the CLM Request Message Support.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiSetLbsDloadNotifyStatus	(	const SWI_STRUCT_LbsDloadNotifyStatus *	psNotifyStatus,
		swi_uint32	timeout
	)

This function sets LBS download notification status mask.

Use this function to check the current notification state of the following group of LBS notifications:

SWI_NOTIFY_LbsPdDloadBegin
SWI_NOTIFY_LbsPdDloadData
SWI_NOTIFY_LbsPdDloadDone
SWI_NOTIFY_LbsPdDloadEnd

Parameters

psNotifyStatus[IN]	New notification state.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiSetLbsFixTypeControl	(	const SWI_STRUCT_LBS_FixTypeControl *	pFixTypeControl,
		swi_uint32	timeout
	)

This function sets GPS fix type control.

Parameters

pFixTypeControl[IN]	Pointer point to fix type control value to set. See SWI_STRUCT_LBS_FixTypeControl.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiSetLbsLocNotifyStatus	(	const SWI_STRUCT_LbsLocNotifyStatus *	psNotifyStatus,
		swi_uint32	timeout
	)

This function sets the LBS notification status mask.

Use this function to set the current notification state of the following group of LBS notifications:

SWI_NOTIFY_LbsPdDone
SWI_NOTIFY_LbsPdData
SWI_NOTIFY_LbsPdEnd
SWI_NOTIFY_LbsPdBegin
SWI_NOTIFY_LbsPdUpdateFailure

Parameters

psNotifyStatus[IN]	New notification state.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiSetLbsNemaOutputMessageControl	(	swi_uint8	nMask,
		swi_uint32	timeout
	)

This function sets NMEA Output Message Control.

Parameters

nMask[IN] NMEA Output Message control value to set. One 8-Bit Data Field with 5 bits defined and OR'd together to control the different NMEA message types being output. GPGGA Message Type [Valid choice is Enable (0x01) or Disable (0x00)] GPGSA Message Type [Valid choice is Enable (0x02) or Disable (0x00)] GPGSV Message Type [Valid choice is Enable (0x04) or Disable (0x00)] GPVTG Message Type [Valid choice is Enable (0x08) or Disable (0x00)] GPRMC Message Type [Valid choice is Enable (0x10) or Disable (0x00)]

timeout[IN] Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiSetLbsPaGpsLock	(	const SWI_STRUCT_LbsPaGpsLock *	psPaGpsLock,
		swi_uint32	timeout
	)

This function sets GPS Lock Setting.

Parameters

psPaGpsLock[IN]	GPS lock settings.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiSetLbsPaNetAccess	(	const SWI_STRUCT_LbsPaNetAccess *	psPaNetAccess,
		swi_uint32	timeout
	)

This function sets GPS network access permissions used during LBS sessions.

Parameters

psPaNetAccess[IN]	Network access permissions.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiSetLbsPaPrivacy	(	const SWI_STRUCT_LbsPaPrivacy *	psPaPrivacy,
		swi_uint32	timeout
	)

This function sets GPS privacy settings used for LBS sessions.

Parameters

psPaPrivacy[IN]	Privacy settings.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiSetLbsPaPtlmMode	(	const SWI_STRUCT_LbsPaPtlmMode *	psPaPtlmMode,
		swi_uint32	timeout
	)

This function sets the mechanism used to transport LBS messages.

Parameters

psPaPtlmMode[IN]	Transport mechanism.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiSetLbsParamNotifyStatus	(	const SWI_STRUCT_LbsParamNotifyStatus *	psNotifyStatus,
		swi_uint32	timeout
	)

This function sets LBS parameter notification status mask.

Use this function to check the current notification state of the following group of CnS notifications:

SWI_NOTIFY_LbsPaIpAddr
SWI_NOTIFY_LbsPaGpsLock
SWI_NOTIFY_LbsPaPtlmMode
SWI_NOTIFY_LbsPaPortId
SWI_NOTIFY_LbsPaPrivacy
SWI_NOTIFY_LbsPaNetAccess

Parameters

psNotifyStatus[IN]	New notification state.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiSetLbsPdDownload	(	const SWI_STRUCT_LbsPdDownload *	psLbsPdDownload,
		swi_uint32	timeout
	)

This function requests a data download of ephemeris and almanac data.

The host can use the download option specified in SWI_STRUCT_LbsPdDownload to indicate whether the data download should occur just once or periodically, in an effort to keep the data "warm". If the application that will be requesting this data will be requiring the use of the data over a period of time, the application should indicate that the download should be periodic.

Parameters

psLbsPdDownload[IN]	Download configuration.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiSetLbsSmartModeControl	(	swi_uint8	nMask,
		swi_uint32	timeout
	)

This function sets Qualcomm smart mode control.

Parameters

nMask[IN]	Smart Mode control value to set. One 8-Bit Data Field with two bits assigned to two different smart modes and ORd Together. Smart MS-Based Mode [Valid choice is Enable (0x01) or Disable (0x00)]. Smart Standalone Mode [Valid choice is Enable (0x02) or Disable (0x00)].
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiSetLbsSWSmartModeControl	(	swi_uint8	nMask,
		swi_uint32	timeout
	)

This function sets Sierra Wireless smart mode control.

Parameters

nMask[IN]	Smart Mode control value to set. One 8-Bit Field to allow Enable/Disable of Sierra MS-Based Fallback.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiSetLbsXtraAssistData	(	SWI_STRUCT_LBS_XTRA_ASSIST_DATA_SET *	data,
		LBS_XTRA_ASSIST_DATA_RESULT *	response,
		swi_uint32	timeout
	)

This function sets GPS One Xtra almanac data.

Parameters

data[IN]	Point to GPS One Xtra almanac data to be set.
response[OUT]	Contain results for setting GPS One Xtra data.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiSetLbsXtraTimeInfo	(	SWI_STRUCT_LBS_XTRA_TIME_INFO_SET *	data,
		LBS_XTRA_ASSIST_DATA_RESULT *	response,
		swi_uint32	timeout
	)

This function sets GPS One Xtra time injection data.

Parameters

data[IN]	Point to GPS One Xtra time injection date to be set.
response[OUT]	Contain results for setting the time information.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

Functions

Detailed Description

Function Documentation