This file contains definitions, enumerations, structures and forward declarations for SwiApiGsmNetwork.c file. More...

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

Data Structures
struct	SWI_STRUCT_ByteCounter

struct	SWI_STRUCT_Rssi

struct	SWI_STRUCT_GsmCellMeasure

struct	SWI_STRUCT_GsmCellInfo

struct	SWI_STRUCT_Rat

struct	SWI_STRUCT_PrlRegion

struct	SWI_STRUCT_PlmnSelection

struct	SWI_STRUCT_GsmSystemStatus

struct	SWI_STRUCT_RscpEcIoInfo

struct	SWI_STRUCT_RscpEcIo

struct	SWI_STRUCT_Profile

struct	SWI_STRUCT_ProfileStatus

struct	SWI_STRUCT_ProfileSummary

struct	SWI_STRUCT_GsmProfileSummary

struct	SWI_STRUCT_GsmProfileBasic

struct	SWI_STRUCT_GsmProfileQos

struct	SWI_STRUCT_GsmProfileDns

struct	SWI_STRUCT_GsmProfileTft

struct	SWI_STRUCT_PktSessionStatus

struct	SWI_STRUCT_PktSessionCall

struct	SWI_STRUCT_IpAddress

struct	SWI_STRUCT_GSM_NetworkStatus

struct	SWI_STRUCT_PlmnReady

struct	SWI_STRUCT_PlmnMode

struct	SWI_STRUCT_Registration

struct	SWI_STRUCT_PlmnAvailable

struct	SWI_STRUCT_ServiceIcon

Macros
#define	MAX_CELLS 6

#define	LENGTH_CallNumber 32 /* Max Caller ID length */

#define	LENGTH_CallExtendedNumber 64 /* Max Ext'd Caller ID lngth */

#define	LENGTH_SectorId 16

#define	LENGTH_WAPUri 128

#define	LENGTH_HdrUati 16

#define	LENGTH_MaxPPPString 33

#define	LENGTH_IPAddress 16

#define	LENGTH_LogFileName 128

#define	LENGTH_SdkPathName 128

#define	LENGTH_CommPort 7

#define	LENGTH_UsbdVersion 85

#define	LENGTH_UsbdBuildDate 9

#define	LENGTH_BootBuildDate 9

#define	NUMVALUE_WIMAX 80216

#define	MAX_NOTIF_LIST 122

#define	LENGTH_DriverName 100

#define	LENGTH_MacAddress 6

#define	LENGTH_ProductName 20

#define	LENGTH_ModemName 75

#define	LENGTH_HardwareId 50

#define	MAX_NUM_LBS_SV 12

#define	LENGTH_TimeStamp 16

#define	MAX_BAND_GROUPS 50

#define	MAX_BAND_LIST 50

#define	MAX_AIR_SERVERS 50 /* Must be < than a frame. */

#define	LENGTH_SPN (16 * UTF8_MAX_CHAR_SIZE) + 1

#define	LENGTH_PLMN (31 * UTF8_MAX_CHAR_SIZE) + 1

#define	LENGTH_AbvPLMN (13 * UTF8_MAX_CHAR_SIZE) + 1

#define	LENGTH_MEPCode 13

#define	LENGTH_USSDInputExp 230

#define	LENGTH_Country (3 * UTF8_MAX_CHAR_SIZE) + 1

#define	LENGTH_Network (8 * UTF8_MAX_CHAR_SIZE) + 1

#define	LENGTH_MCCMNC_BUFFER 3

#define	LENGTH_MCCMNC_TEXT 6

#define	LENGTH_UnlockKey 11

#define	OBJ_LENGTH_Country 6

#define	OBJ_LENGTH_Network 16

#define	OBJ_LENGTH_PLMN 62

#define	OBJ_LENGTH_AbvPLMN 26

#define	OBJ_LENGTH_SPN 32

#define	LENGTH_RsvdGsmProfileBasic 11

#define	LENGTH_CNS_PROFILE_READ_PARAM 3

#define	LENGTH_CNS_PROFILE_WRITE_MAX 245

#define	LENGTH_CNS_PLMN_MODE_SET_PARAM 5

#define	LENGTH_CNS_PROFILE_AUTH_GET 3

#define	OBJ_PROFILE_AUTH_NUMOBJ 2 /* can only set username & password */

#define	OBJ_TYPE_UserName 0x00

#define	OBJ_TYPE_Password 0x01

#define	OBJ_LENGTH_UserName 128

#define	OBJ_LENGTH_Password 128

#define	OBJ_LENGTH_GetRat 2

#define	OBJ_LENGTH_SetRat 3

#define	OBJ_LENGTH_GetPrlRegion 2

#define	OBJ_LENGTH_SetPrlRegion 3

#define	PLMN_REGISTERED 0x01

#define	PLMN_FORBIDDEN 0x02

#define	PLMN_HOME 0x04

#define	PLMN_WEAK 0x08

#define	PLMN_GPRS_BIT 0x10

Enumerations
enum	SWI_TYPE_RoamingState { SWI_ROAMING_Home, SWI_ROAMING_Roaming, SWI_ROAMING_NonPref, SWI_ROAMING_None }

enum	SWI_TYPE_ProfileInfo { SWI_PROFILEINFO_Basic, SWI_PROFILEINFO_Qos, SWI_PROFILEINFO_Dns, SWI_PROFILEINFO_Tft }

enum	SWI_TYPE_Precedence { SWI_PRECED_Subscribed, SWI_PRECED_HighPriority, SWI_PRECED_MediumPriority, SWI_PRECED_LowPriority }

enum	SWI_TYPE_PLMN_Result { SWI_PLMNRESULT_Success, SWI_PLMNRESULT_AttemptFailed, SWI_PLMNRESULT_InProgress, SWI_PLMNRESULT_GeneralFail, SWI_PLMNRESULT_InternalErr, SWI_PLMNRESULT_InvalidSelection }

enum	SWI_TYPE_ModemStatus { SWI_MODEMSTATUS_Offline, SWI_MODEMSTATUS_Online, SWI_MODEMSTATUS_Lpm }

enum	SWI_TYPE_ServiceErr { SWI_SERVICEERR_None, SWI_SERVICEERR_Unspecified = 0xFFFF }

enum	SWI_TYPE_Service { SWI_SERVICE_None, SWI_SERVICE_Gprs, SWI_SERVICE_Edge, SWI_SERVICE_Umts, SWI_SERVICE_Hsdpa, SWI_SERVICE_Hsupa, SWI_SERVICE_Hspa, SWI_SERVICE_HspaPlus, SWI_SERVICE_DcHspaPlus, SWI_SERVICE_Lte }

enum	SWI_TYPE_MncFormat { SWI_MNCFORMAT_2Digit, SWI_MNCFORMAT_3Digit }

enum	SWI_TYPE_Delay { SWI_DELAY_Subscribed, SWI_DELAY_Low, SWI_DELAY_Medium, SWI_DELAY_High, SWI_DELAY_BestEffort }

enum	SWI_TYPE_Reliability { SWI_RELI_Subscribed, SWI_RELI_GTPAcknowledged, SWI_RELI_LLCFrameAcknowledged, SWI_RELI_RLCBlockModeAcknowledged, SWI_RELI_LLCDataProtected, SWI_RELI_UnackUnprotected }

enum	SWI_TYPE_PeakThroughput { SWI_THROUGHPUT_Subscribed, SWI_THROUGHPUT_1000, SWI_THROUGHPUT_2000, SWI_THROUGHPUT_4000, SWI_THROUGHPUT_8000, SWI_THROUGHPUT_16000, SWI_THROUGHPUT_32000, SWI_THROUGHPUT_64000, SWI_THROUGHPUT_128000, SWI_THROUGHPUT_256000 }

enum	SWI_TYPE_MeanThroughput { SWI_MEANTHROUGH_Subscribed, SWI_MEANTHROUGH_100, SWI_MEANTHROUGH_200, SWI_MEANTHROUGH_500, SWI_MEANTHROUGH_1K, SWI_MEANTHROUGH_2K, SWI_MEANTHROUGH_5K, SWI_MEANTHROUGH_10K, SWI_MEANTHROUGH_20K, SWI_MEANTHROUGH_50K, SWI_MEANTHROUGH_100K, SWI_MEANTHROUGH_200K, SWI_MEANTHROUGH_500K, SWI_MEANTHROUGH_1M, SWI_MEANTHROUGH_2M, SWI_MEANTHROUGH_5M, SWI_MEANTHROUGH_10M, SWI_MEANTHROUGH_20M, SWI_MEANTHROUGH_50M, SWI_MEANTHROUGH_BestEffort }

enum	SWI_TYPE_InactivityReason { SWI_INACTIVITYREASON_OperatorBarring, SWI_INACTIVITYREASON_LLC, SWI_INACTIVITYREASON_InsufficientResources, SWI_INACTIVITYREASON_MissingOrUnknownAPN, SWI_INACTIVITYREASON_UnknownPDPAddressOrType, SWI_INACTIVITYREASON_UserAuthenticationFailed, SWI_INACTIVITYREASON_ActivationRejectedByGGSN, SWI_INACTIVITYREASON_ServiceOptionNotSupported, SWI_INACTIVITYREASON_ServiceOptionNotSubscribed, SWI_INACTIVITYREASON_ServiceOptionTemporarilyOutOfOrder, SWI_INACTIVITYREASON_RegularDeactivation, SWI_INACTIVITYREASON_QosNotAccepted, SWI_INACTIVITYREASON_NetworkFailure, SWI_INACTIVITYREASON_ReactivationRequired, SWI_INACTIVITYREASON_FeatureNotSup, SWI_INACTIVITYREASON_SemErrTftOper, SWI_INACTIVITYREASON_SynErrTftOper, SWI_INACTIVITYREASON_UnknownPdpContext, SWI_INACTIVITYREASON_TftActive, SWI_INACTIVITYREASON_SemErrPktFilter, SWI_INACTIVITYREASON_SynErrPktFilter, SWI_INACTIVITYREASON_InvalidTransId, SWI_INACTIVITYREASON_SemIncMsg, SWI_INACTIVITYREASON_InvalidInfo, SWI_INACTIVITYREASON_MsgNonExist, SWI_INACTIVITYREASON_MsgTypeNotComp, SWI_INACTIVITYREASON_InfoNonExist, SWI_INACTIVITYREASON_IeErr, SWI_INACTIVITYREASON_MsgNotComp, SWI_INACTIVITYREASON_ProtErr, SWI_INACTIVITYREASON_Normal }

enum	SWI_TYPE_ProfileState { SWI_PROFILE_STATE_Inactive, SWI_PROFILE_STATE_Activated, SWI_PROFILE_STATE_Deleted }

enum	SWI_TYPE_PLMN_Mode { SWI_PLMNMODE_Automatic, SWI_PLMNMODE_Manual, SWI_PLMNMODE_Manual_2G }

enum	SWI_TYPE_ServiceStatus { SWI_SERVICE_STATUS_Normal, SWI_SERVICE_STATUS_Emergency, SWI_SERVICE_STATUS_NoService, SWI_SERVICE_STATUS_AccessDifficulty, SWI_SERVICE_STATUS_ForbiddenPLMN, SWI_SERVICE_STATUS_ForbiddenArea, SWI_SERVICE_STATUS_ForbiddenRoaming, SWI_SERVICE_STATUS_IllegalMobStation, SWI_SERVICE_STATUS_IllegalMobEquip, SWI_SERVICE_STATUS_UnknownIMSI, SWI_SERVICE_STATUS_AuthenticationFailure, SWI_SERVICE_STATUS_GPRSFailed }

enum	SWI_TYPE_QOSUMTS_SrcStatDesc { SWI_QOSUMTS_SRCSTATDESC_Unknown, SWI_QOSUMTS_SRCSTATDESC_Speech }

enum	SWI_TYPE_QOSUMTS_SignInd { SWI_QOSUMTS_SIGNIND_NotOpt, SWI_QOSUMTS_SIGNIND_Opt }

enum	SWI_TYPE_PdpInitiated { SWI_PDP_INITIATED_PrimaryMobile, SWI_PDP_INITIATED_SecondaryMobile, SWI_PDP_INITIATED_Network, SWI_PDP_INITIATED_None }

enum	SWI_TYPE_Authentication { SWI_PDPAUTHENTICATION_None, SWI_PDPAUTHENTICATION_Pap, SWI_PDPAUTHENTICATION_Chap }

enum	SWI_TYPE_QOSUMTS_Bitrate { SWI_QOSUMTS_BITRATE_Subscribed, SWI_QOSUMTS_BITRATE_16Kbps, SWI_QOSUMTS_BITRATE_32Kbps, SWI_QOSUMTS_BITRATE_64Kbps, SWI_QOSUMTS_BITRATE_128Kbps, SWI_QOSUMTS_BITRATE_256Kbps, SWI_QOSUMTS_BITRATE_384Kbps, SWI_QOSUMTS_BITRATE_1_8Mbps, SWI_QOSUMTS_BITRATE_3_6Mbps, SWI_QOSUMTS_BITRATE_7_2Mbps, SWI_QOSUMTS_BITRATE_14_4Mbps }

enum	SWI_TYPE_QOSUMTS_TrafficClass { SWI_QOSUMTS_TRAFFCLS_Subscribed, SWI_QOSUMTS_TRAFFCLS_Conver, SWI_QOSUMTS_TRAFFCLS_Stream, SWI_QOSUMTS_TRAFFCLS_Interact, SWI_QOSUMTS_TRAFFCLS_Backgnd }

enum	SWI_TYPE_QOSUMTS_DelOrder { SWI_QOSUMTS_DELORDER_Subscribed, SWI_QOSUMTS_DELORDER_With, SWI_QOSUMTS_DELORDER_Without }

enum	SWI_TYPE_QOSUMTS_DelErrSdu { SWI_QOSUMTS_DELERRSDU_Subscribed, SWI_QOSUMTS_DELERRSDU_NoDetect, SWI_QOSUMTS_DELERRSDU_Del, SWI_QOSUMTS_DELERRSDU_NotDel }

enum	SWI_TYPE_QOSUMTS_SduErrRatio { SWI_QOSUMTS_SDUERRRATIO_Subscribed, SWI_QOSUMTS_SDUERRRATIO_1E2, SWI_QOSUMTS_SDUERRRATIO_7E3, SWI_QOSUMTS_SDUERRRATIO_1E3, SWI_QOSUMTS_SDUERRRATIO_1E4, SWI_QOSUMTS_SDUERRRATIO_1E5, SWI_QOSUMTS_SDUERRRATIO_1E6, SWI_QOSUMTS_SDUERRRATIO_1E1 }

enum	SWI_TYPE_QOSUMTS_ResBitErrRatio { SWI_QOSUMTS_RESBITERRRATIO_Subscribed, SWI_QOSUMTS_RESBITERRRATIO_5E2, SWI_QOSUMTS_RESBITERRRATIO_1E2, SWI_QOSUMTS_RESBITERRRATIO_5E3, SWI_QOSUMTS_RESBITERRRATIO_4E3, SWI_QOSUMTS_RESBITERRRATIO_1E3, SWI_QOSUMTS_RESBITERRRATIO_1E4, SWI_QOSUMTS_RESBITERRRATIO_1E5, SWI_QOSUMTS_RESBITERRRATIO_1E6, SWI_QOSUMTS_RESBITERRRATIO_6E8 }

enum	SWI_TYPE_QOSUMTS_TraffHandPri { SWI_QOSUMTS_TRAFFHANDPRI_Subscribed, SWI_QOSUMTS_TRAFFHANDPRI_PriLvl1, SWI_QOSUMTS_TRAFFHANDPRI_PriLvl2, SWI_QOSUMTS_TRAFFHANDPRI_PriLvl3 }

enum	SWI_TYPE_ModeSelection { SWI_MODE_SELECTION_Automatic, SWI_MODE_SELECTION_Manual }

enum	SWI_TYPE_Network { SWI_NETWORK_Unknown, SWI_NETWORK_GSM, SWI_NETWORK_DCS, SWI_NETWORK_GSMDCS, SWI_NETWORK_PCS, SWI_NETWORK_GSM_PCS, SWI_NETWORK_IO, SWI_NETWORK_UMTS }

enum	SWI_TYPE_ServiceType { SWI_SERVICE_TYPE_CircuitSwitched, SWI_SERVICE_TYPE_GPRS, SWI_SERVICE_TYPE_Combined, SWI_SERVICE_TYPE_InvalidService }

enum	SWI_TYPE_RatMode { SWI_RATMODE_Automatic, SWI_RATMODE_UMTS3G_Only, SWI_RATMODE_GSM2G_Only, SWI_RATMODE_UMTS3G_Preferred, SWI_RATMODE_GSM2G_Preferred }

enum	SWI_TYPE_PrlRegion { SWI_RRLREGION_Default, SWI_RRLREGION_Europe, SWI_RRLREGION_NorthAmerica, SWI_RRLREGION_Australia, SWI_RRLREGION_Japan, SWI_RRLREGION_Reserved, SWI_RRLREGION_Italy }

enum	SWI_TYPE_PrlChangeStatus { SWI_PRLCHANGE_Success, SWI_PRLCHANGE_InvalidPassword, SWI_PRLCHANGE_GeneralFailure }

enum	SWI_TYPE_ProfileAuth { PROFILEAUTH_Username, PROFILEAUTH_Password, PROFILEAUTH_MaxUsername, PROFILEAUTH_MaxPassword }

Functions
SWI_API SWI_RCODE	SwiGetRssiBer (struct SWI_STRUCT_Rssi *sRssiBer, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetRssiBars (const swi_int32 iRssi, swi_uint32 *pNumBars)

SWI_API SWI_RCODE	SwiGetTrafficStatistics (swi_uint32 nSent, swi_uint32 nReceived, swi_uint32 Timeout)

SWI_API SWI_RCODE	SwiResetTrafficStatistics (swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetRscpEcIo (struct SWI_STRUCT_RscpEcIo *pRscpEcIo, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetGsmProfileSummary (struct SWI_STRUCT_GsmProfileSummary *pProfileSummary, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetGsmProfileBasic (struct SWI_STRUCT_GsmProfileBasic *pProfile, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetGsmProfileQos (struct SWI_STRUCT_GsmProfileQos *pProfile, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetGsmProfileDns (struct SWI_STRUCT_GsmProfileDns *pProfile, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetGsmProfileTft (struct SWI_STRUCT_GsmProfileTft *pProfile, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetGsmProfileBasic (struct SWI_STRUCT_GsmProfileBasic pProfile, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetGsmProfileQos (struct SWI_STRUCT_GsmProfileQos pProfile, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetGsmProfileDns (struct SWI_STRUCT_GsmProfileDns pProfile, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetGsmProfileTft (struct SWI_STRUCT_GsmProfileTft pProfile, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiEraseProfile (const swi_uint32 nProfileID, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetDefaultProfile (const swi_uint32 nProfileID, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiActivateProfile (const swi_uint32 nProfileID, swi_bool Activate, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetHostStartup (swi_bool bStartup, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetIPAddressEx (struct SWI_STRUCT_IpAddress *pIp, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetPktSessionStatus (struct SWI_STRUCT_PktSessionStatus *sSessionStatus, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetPLMNMode (enum SWI_TYPE_PLMN_Mode *eMode, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetPLMNMode (const struct SWI_STRUCT_PlmnSelection sPlmn, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiStartPLMNSearch (swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetPLMNSelection (struct SWI_STRUCT_PlmnSelection *sPlmn, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetServiceStatusEx (enum SWI_TYPE_ServiceStatus *eServiceStatus, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetPktSessionStatusEx (struct SWI_STRUCT_PktSessionCall *sPktSessionCall, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetRat (struct SWI_STRUCT_Rat *psRat, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetRat (struct SWI_STRUCT_Rat *psRat, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetPrlRegion (struct SWI_STRUCT_PrlRegion *psPrl, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetPrlRegion (struct SWI_STRUCT_PrlRegion *psPrl, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetGsmSystemStatus (struct SWI_STRUCT_GsmSystemStatus *pSysStatus, swi_uint32 timeout)

Detailed Description

This file contains definitions, enumerations, structures and forward declarations for SwiApiGsmNetwork.c file.

Macro Definition Documentation

#define LENGTH_AbvPLMN (13 * UTF8_MAX_CHAR_SIZE) + 1

#define LENGTH_BootBuildDate 9

#define LENGTH_CallExtendedNumber 64 /* Max Ext'd Caller ID lngth */

#define LENGTH_CallNumber 32 /* Max Caller ID length */

#define LENGTH_CNS_PLMN_MODE_SET_PARAM 5

#define LENGTH_CNS_PROFILE_AUTH_GET 3

#define LENGTH_CNS_PROFILE_READ_PARAM 3

#define LENGTH_CNS_PROFILE_WRITE_MAX 245

#define LENGTH_CommPort 7

#define LENGTH_Country (3 * UTF8_MAX_CHAR_SIZE) + 1

#define LENGTH_DriverName 100

#define LENGTH_HardwareId 50

#define LENGTH_HdrUati 16

#define LENGTH_IPAddress 16

#define LENGTH_LogFileName 128

#define LENGTH_MacAddress 6

#define LENGTH_MaxPPPString 33

#define LENGTH_MCCMNC_BUFFER 3

#define LENGTH_MCCMNC_TEXT 6

#define LENGTH_MEPCode 13

#define LENGTH_ModemName 75

#define LENGTH_Network (8 * UTF8_MAX_CHAR_SIZE) + 1

#define LENGTH_PLMN (31 * UTF8_MAX_CHAR_SIZE) + 1

#define LENGTH_ProductName 20

#define LENGTH_RsvdGsmProfileBasic 11

#define LENGTH_SdkPathName 128

#define LENGTH_SectorId 16

#define LENGTH_SPN (16 * UTF8_MAX_CHAR_SIZE) + 1

#define LENGTH_TimeStamp 16

#define LENGTH_UnlockKey 11

#define LENGTH_UsbdBuildDate 9

#define LENGTH_UsbdVersion 85

#define LENGTH_USSDInputExp 230

#define LENGTH_WAPUri 128

#define MAX_AIR_SERVERS 50 /* Must be < than a frame. */

#define MAX_BAND_GROUPS 50

#define MAX_BAND_LIST 50

#define MAX_CELLS 6

#define MAX_NOTIF_LIST 122

#define MAX_NUM_LBS_SV 12

#define NUMVALUE_WIMAX 80216

#define OBJ_LENGTH_AbvPLMN 26

#define OBJ_LENGTH_Country 6

#define OBJ_LENGTH_GetPrlRegion 2

#define OBJ_LENGTH_GetRat 2

#define OBJ_LENGTH_Network 16

#define OBJ_LENGTH_Password 128

#define OBJ_LENGTH_PLMN 62

#define OBJ_LENGTH_SetPrlRegion 3

#define OBJ_LENGTH_SetRat 3

#define OBJ_LENGTH_SPN 32

#define OBJ_LENGTH_UserName 128

#define OBJ_PROFILE_AUTH_NUMOBJ 2 /* can only set username & password */

#define OBJ_TYPE_Password 0x01

#define OBJ_TYPE_UserName 0x00

#define PLMN_FORBIDDEN 0x02

#define PLMN_GPRS_BIT 0x10

#define PLMN_HOME 0x04

#define PLMN_REGISTERED 0x01

#define PLMN_WEAK 0x08

Enumeration Type Documentation

enum SWI_TYPE_Authentication

An enumeration of authentication types.

See Also: SWI_STRUCT_GsmProfileBasic

Enumerator
SWI_PDPAUTHENTICATION_None	No authentication
SWI_PDPAUTHENTICATION_Pap	PAP authentication (default)
SWI_PDPAUTHENTICATION_Chap	CHAP authentication

enum SWI_TYPE_Delay

An enumeration of quality of service delay types.

See Also: SWI_STRUCT_PktSessionStatus; SWI_STRUCT_Profile; SWI_STRUCT_GsmProfileQos; SWI_STRUCT_PktSessionCall

Enumerator
SWI_DELAY_Subscribed	Subscribed delay
SWI_DELAY_Low	Low delay
SWI_DELAY_Medium	Medium delay
SWI_DELAY_High	High delay
SWI_DELAY_BestEffort	Best effort delay

enum SWI_TYPE_InactivityReason

An enumeration of packet session inactivity reason types.

See Also: SWI_STRUCT_PktSessionStatus; SWI_STRUCT_PktSessionCall

Enumerator
SWI_INACTIVITYREASON_OperatorBarring	Operator determined barring
SWI_INACTIVITYREASON_LLC	LCC
SWI_INACTIVITYREASON_InsufficientResources	Insufficient resources
SWI_INACTIVITYREASON_MissingOrUnknownAPN	APN unknown or missing
SWI_INACTIVITYREASON_UnknownPDPAddressOrType	PDP address unknown or missing
SWI_INACTIVITYREASON_UserAuthenticationFailed	User authentication failed
SWI_INACTIVITYREASON_ActivationRejectedByGGSN	GGSN rejection
SWI_INACTIVITYREASON_ServiceOptionNotSupported	Service not supported
SWI_INACTIVITYREASON_ServiceOptionNotSubscribed	Not subscribed for that service
SWI_INACTIVITYREASON_ServiceOptionTemporarilyOutOfOrder	Service out of order
SWI_INACTIVITYREASON_RegularDeactivation	Regular deactivation
SWI_INACTIVITYREASON_QosNotAccepted	QoS not accepted
SWI_INACTIVITYREASON_NetworkFailure	Network failure
SWI_INACTIVITYREASON_ReactivationRequired	Reactivation required
SWI_INACTIVITYREASON_FeatureNotSup	Feature not supported
SWI_INACTIVITYREASON_SemErrTftOper	Semantic error in the TFT operation
SWI_INACTIVITYREASON_SynErrTftOper	Syntactical error in the TFT operation
SWI_INACTIVITYREASON_UnknownPdpContext	Unknown PDP context
SWI_INACTIVITYREASON_TftActive	PDP context without TFT already activated
SWI_INACTIVITYREASON_SemErrPktFilter	Semantic error in packet filter(s)
SWI_INACTIVITYREASON_SynErrPktFilter	Syntactical error in the packet filter(s)
SWI_INACTIVITYREASON_InvalidTransId	Invalid transaction identifier value
SWI_INACTIVITYREASON_SemIncMsg	Semantically incorrect message
SWI_INACTIVITYREASON_InvalidInfo	Invalid mandatory information
SWI_INACTIVITYREASON_MsgNonExist	Message type non-existent or not implemented
SWI_INACTIVITYREASON_MsgTypeNotComp	Message type not compatible with the protocol state
SWI_INACTIVITYREASON_InfoNonExist	Information element non-existent or not implemented
SWI_INACTIVITYREASON_IeErr	Conditional IE error
SWI_INACTIVITYREASON_MsgNotComp	Message not compatible with the protocol state
SWI_INACTIVITYREASON_ProtErr	Protocol error, unspecified
SWI_INACTIVITYREASON_Normal	Normal

enum SWI_TYPE_MeanThroughput

An enumeration of quality of service mean throughput types.

See Also: SWI_STRUCT_PktSessionStatus; SWI_STRUCT_Profile; SWI_STRUCT_GsmProfileQos; SWI_STRUCT_PktSessionCall

Enumerator
SWI_MEANTHROUGH_Subscribed	Subscribed
SWI_MEANTHROUGH_100	100 octets/hr (~0.22 bit/s)
SWI_MEANTHROUGH_200	200 octets/hr (~0.44 bit/s)
SWI_MEANTHROUGH_500	500 octets/hr (~1.11 bit/s)
SWI_MEANTHROUGH_1K	1000 octets/hr (~2.2 bit/s)
SWI_MEANTHROUGH_2K	2000 octets/hr (~4.4 bit/s)
SWI_MEANTHROUGH_5K	5000 octets/hr (~11.1 bit/s)
SWI_MEANTHROUGH_10K	10000 octets/hr (~22 bit/s)
SWI_MEANTHROUGH_20K	20000 octets/hr (~44 bit/s)
SWI_MEANTHROUGH_50K	50000 octets/hr (~111 bit/s)
SWI_MEANTHROUGH_100K	100000 octets/hr (~0.22 kbit/s)
SWI_MEANTHROUGH_200K	200000 octets/hr (~0.44 kbit/s)
SWI_MEANTHROUGH_500K	500000 octets/hr (~1.11 kbit/s)
SWI_MEANTHROUGH_1M	1000000 octets/hr (~2.2 kbit/s)
SWI_MEANTHROUGH_2M	2000000 octets/hr (~4.4 kbit/s)
SWI_MEANTHROUGH_5M	5000000 octets/hr (~11.1 kbit/s)
SWI_MEANTHROUGH_10M	10000000 octets/hr (~22 kbit/s)
SWI_MEANTHROUGH_20M	20000000 octets/hr (~44 kbit/s)
SWI_MEANTHROUGH_50M	50000000 octets/hr (~111 kbit/s)
SWI_MEANTHROUGH_BestEffort	Best effort

enum SWI_TYPE_MncFormat

An enumeration of MNC formats

See Also: SWI_STRUCT_GsmSystemStatus

Enumerator
SWI_MNCFORMAT_2Digit	2 digit format
SWI_MNCFORMAT_3Digit	3 digit format

enum SWI_TYPE_ModemStatus

An enumeration of modem power status.

See Also: SWI_STRUCT_GsmSystemStatus

Enumerator
SWI_MODEMSTATUS_Offline	Offline
SWI_MODEMSTATUS_Online	Online
SWI_MODEMSTATUS_Lpm	Lower power mode

enum SWI_TYPE_ModeSelection

An enumeration of currently selected network selection modes.

See Also: SWI_STRUCT_GSM_NetworkStatus; SWI_STRUCT_GsmSystemStatus

Enumerator
SWI_MODE_SELECTION_Automatic	Automatic network selection
SWI_MODE_SELECTION_Manual	Manual network selection

enum SWI_TYPE_Network

An enumeration of network types.

See Also: SWI_STRUCT_PlmnSelection

Enumerator
SWI_NETWORK_Unknown	No network
SWI_NETWORK_GSM	GSM network
SWI_NETWORK_DCS	DCS network
SWI_NETWORK_GSMDCS	GSM and DCS network
SWI_NETWORK_PCS	PCS network
SWI_NETWORK_GSM_PCS	GSM and PCS network
SWI_NETWORK_IO	IO network
SWI_NETWORK_UMTS	UMTS

enum SWI_TYPE_PdpInitiated

An enumeration of PDP initiated types.

See Also: SWI_STRUCT_GsmProfileBasic

Enumerator
SWI_PDP_INITIATED_PrimaryMobile	Primary context
SWI_PDP_INITIATED_SecondaryMobile	Secondary context
SWI_PDP_INITIATED_Network	Currently not supported
SWI_PDP_INITIATED_None	Currently not supported

enum SWI_TYPE_PeakThroughput

An enumeration of quality of service peak throughput types.

See Also: SWI_STRUCT_PktSessionStatus; SWI_STRUCT_Profile; SWI_STRUCT_GsmProfileQos; SWI_STRUCT_PktSessionCall

Enumerator
SWI_THROUGHPUT_Subscribed	Default to peak throughput class
SWI_THROUGHPUT_1000	Up to 1000 bytes (8 kbit/s)
SWI_THROUGHPUT_2000	up to 2000 bytes (16 kbit/s)
SWI_THROUGHPUT_4000	Up to 4000 bytes (32 kbit/s)
SWI_THROUGHPUT_8000	Up to 8000 bytes (64 kbit/s)
SWI_THROUGHPUT_16000	Up to 16000 bytes (128 kbit/s)
SWI_THROUGHPUT_32000	Up to 32000 bytes (256 kbit/s)
SWI_THROUGHPUT_64000	up to 64000 bytes (512 kbit/s)
SWI_THROUGHPUT_128000	Up to 128000 bytes (1024 kbit/s)
SWI_THROUGHPUT_256000	Up to 256000 bytes (2048 kbit/s)

enum SWI_TYPE_PLMN_Mode

An enumeration of available configurable network selection modes

See Also: SwiGetPLMNMode; SWI_STRUCT_PlmnSelection

Enumerator
SWI_PLMNMODE_Automatic	Automatic PLMN selection
SWI_PLMNMODE_Manual	Manual PLMN selection (3G preferred)
SWI_PLMNMODE_Manual_2G	Manual PLMN selection (2G preferred)

enum SWI_TYPE_PLMN_Result

An enumeration of result codes for a network selection.

See Also: SWI_STRUCT_PlmnMode

Enumerator
SWI_PLMNRESULT_Success	Succeeded in selecting the requested PLMN
SWI_PLMNRESULT_AttemptFailed	Attempt to select requested PLMN failed
SWI_PLMNRESULT_InProgress	PLMN selection is underway
SWI_PLMNRESULT_GeneralFail	General failure
SWI_PLMNRESULT_InternalErr	Internal failure
SWI_PLMNRESULT_InvalidSelection	Invalid PLMN selection

enum SWI_TYPE_Precedence

An enumeration of quality of service precedence types.

See Also: SWI_STRUCT_PktSessionStatus; SWI_STRUCT_Profile; SWI_STRUCT_GsmProfileQos; SWI_STRUCT_PktSessionCall

Enumerator
SWI_PRECED_Subscribed	Subscribed precedence
SWI_PRECED_HighPriority	High priority
SWI_PRECED_MediumPriority	Medium priority
SWI_PRECED_LowPriority	Low priority

enum SWI_TYPE_PrlChangeStatus

An enumeration of PRL region mode change status returned by

See Also: SwiSetPrl.; SWI_STRUCT_PrlRegion; SwiSetPrl

Enumerator
SWI_PRLCHANGE_Success	request successful
SWI_PRLCHANGE_InvalidPassword	invalid password key
SWI_PRLCHANGE_GeneralFailure	general failure

enum SWI_TYPE_PrlRegion

An enumeration of PRL regions.

See Also: SWI_STRUCT_PrlRegion

Enumerator
SWI_RRLREGION_Default	default (internal)
SWI_RRLREGION_Europe	Europe
SWI_RRLREGION_NorthAmerica	North America
SWI_RRLREGION_Australia	Australia
SWI_RRLREGION_Japan	Japan
SWI_RRLREGION_Reserved	Reserved
SWI_RRLREGION_Italy	Italy

enum SWI_TYPE_ProfileAuth

CNS ID : CNS_PROFILE_AUTH (0x700E)

Enumerator
PROFILEAUTH_Username
PROFILEAUTH_Password
PROFILEAUTH_MaxUsername
PROFILEAUTH_MaxPassword

enum SWI_TYPE_ProfileInfo

An enumeration of GSM profile information types.

See Also: SWI_STRUCT_GsmProfileChange

Enumerator
SWI_PROFILEINFO_Basic
SWI_PROFILEINFO_Qos	Basic
SWI_PROFILEINFO_Dns	Quality of service
SWI_PROFILEINFO_Tft	Domain name service Traffic flow template

enum SWI_TYPE_ProfileState

An enumeration of profile states

See Also: SWI_STRUCT_ProfileStatus; SWI_STRUCT_GsmProfileSummary

Enumerator
SWI_PROFILE_STATE_Inactive	Indicates the account profile has a valid account definition but is not currently being used in a session.
SWI_PROFILE_STATE_Activated	The account has a valid definition and is in use with the current session.
SWI_PROFILE_STATE_Deleted	The profile is empty-without a valid account definition. In fact, the profile contains default values but cannot be made active. This profile can be used to store a new account definition.

enum SWI_TYPE_QOSUMTS_Bitrate

An enumeration of UMTS bit rate values.

See Also: SWI_STRUCT_GsmProfileQos; SWI_STRUCT_PktSessionCall

Enumerator
SWI_QOSUMTS_BITRATE_Subscribed	subscribed
SWI_QOSUMTS_BITRATE_16Kbps	16 Kbps
SWI_QOSUMTS_BITRATE_32Kbps	32 Kbps
SWI_QOSUMTS_BITRATE_64Kbps	64 Kbps
SWI_QOSUMTS_BITRATE_128Kbps	128 Kbps
SWI_QOSUMTS_BITRATE_256Kbps	256 Kbps
SWI_QOSUMTS_BITRATE_384Kbps	384 Kbps
SWI_QOSUMTS_BITRATE_1_8Mbps	1.8 Mbps
SWI_QOSUMTS_BITRATE_3_6Mbps	3.6 Mbps
SWI_QOSUMTS_BITRATE_7_2Mbps	7.2 Mbps
SWI_QOSUMTS_BITRATE_14_4Mbps	14.4 Mbps

enum SWI_TYPE_QOSUMTS_DelErrSdu

An enumeration of UMTS delivery of erroneous SDU values.

See Also: SWI_STRUCT_GsmProfileQos; SWI_STRUCT_PktSessionCall

Enumerator
SWI_QOSUMTS_DELERRSDU_Subscribed	Subscribed
SWI_QOSUMTS_DELERRSDU_NoDetect	No detect
SWI_QOSUMTS_DELERRSDU_Del	Erroneous SDUs are delivered
SWI_QOSUMTS_DELERRSDU_NotDel	Erroneous SDUs are not delivered

enum SWI_TYPE_QOSUMTS_DelOrder

An enumeration of UMTS delivery order values.

See Also: SWI_STRUCT_GsmProfileQos; SWI_STRUCT_PktSessionCall

Enumerator
SWI_QOSUMTS_DELORDER_Subscribed	Subscribed
SWI_QOSUMTS_DELORDER_With	With delivery order
SWI_QOSUMTS_DELORDER_Without	Without delivery order

enum SWI_TYPE_QOSUMTS_ResBitErrRatio

An enumeration of UMTS residual bit error ratio values.

See Also: SWI_STRUCT_GsmProfileQos; SWI_STRUCT_PktSessionCall

Enumerator
SWI_QOSUMTS_RESBITERRRATIO_Subscribed	subscribed
SWI_QOSUMTS_RESBITERRRATIO_5E2	5E-2
SWI_QOSUMTS_RESBITERRRATIO_1E2	1E-2
SWI_QOSUMTS_RESBITERRRATIO_5E3	5E-3
SWI_QOSUMTS_RESBITERRRATIO_4E3	4E-3
SWI_QOSUMTS_RESBITERRRATIO_1E3	1E-3
SWI_QOSUMTS_RESBITERRRATIO_1E4	1E-4
SWI_QOSUMTS_RESBITERRRATIO_1E5	1E-5
SWI_QOSUMTS_RESBITERRRATIO_1E6	1E-6
SWI_QOSUMTS_RESBITERRRATIO_6E8	6E-8

enum SWI_TYPE_QOSUMTS_SduErrRatio

An enumeration of UMTS SDU error ratio values.

See Also: SWI_STRUCT_GsmProfileQos; SWI_STRUCT_PktSessionCall

Enumerator
SWI_QOSUMTS_SDUERRRATIO_Subscribed	subscribed
SWI_QOSUMTS_SDUERRRATIO_1E2	1E-2
SWI_QOSUMTS_SDUERRRATIO_7E3	7E-3
SWI_QOSUMTS_SDUERRRATIO_1E3	1E-3
SWI_QOSUMTS_SDUERRRATIO_1E4	1E-4
SWI_QOSUMTS_SDUERRRATIO_1E5	1E-5
SWI_QOSUMTS_SDUERRRATIO_1E6	1E-6
SWI_QOSUMTS_SDUERRRATIO_1E1	1E-1

enum SWI_TYPE_QOSUMTS_SignInd

An enumeration of UMTS signaling indication values.

See Also: SWI_STRUCT_GsmProfileQos; SWI_STRUCT_PktSessionCall

Enumerator
SWI_QOSUMTS_SIGNIND_NotOpt	Not optimized for signaling traffic.
SWI_QOSUMTS_SIGNIND_Opt	Optimized for signaling traffic.

enum SWI_TYPE_QOSUMTS_SrcStatDesc

An enumeration of UMTS source statistics descriptor values.

See Also: SWI_STRUCT_GsmProfileQos; SWI_STRUCT_PktSessionCall

Enumerator
SWI_QOSUMTS_SRCSTATDESC_Unknown	Unknown
SWI_QOSUMTS_SRCSTATDESC_Speech	Speech

enum SWI_TYPE_QOSUMTS_TraffHandPri

An enumeration of UMTS traffic handling priority values.

See Also: SWI_STRUCT_GsmProfileQos; SWI_STRUCT_PktSessionCall

Enumerator
SWI_QOSUMTS_TRAFFHANDPRI_Subscribed	Subscribed
SWI_QOSUMTS_TRAFFHANDPRI_PriLvl1	Priority level 1
SWI_QOSUMTS_TRAFFHANDPRI_PriLvl2	Priority level 2
SWI_QOSUMTS_TRAFFHANDPRI_PriLvl3	Priority level 3

enum SWI_TYPE_QOSUMTS_TrafficClass

An enumeration of UMTS quality of service traffic class types.

See Also: SWI_STRUCT_GsmProfileQos; SWI_STRUCT_PktSessionCall

Enumerator
SWI_QOSUMTS_TRAFFCLS_Subscribed	Subscribed
SWI_QOSUMTS_TRAFFCLS_Conver	Conversational
SWI_QOSUMTS_TRAFFCLS_Stream	Streaming
SWI_QOSUMTS_TRAFFCLS_Interact	Interactive
SWI_QOSUMTS_TRAFFCLS_Backgnd	Background

enum SWI_TYPE_RatMode

An enumeration of Radio Access Technology (RAT) mode.

See Also: SWI_STRUCT_Rat

Enumerator
SWI_RATMODE_Automatic	Automatic
SWI_RATMODE_UMTS3G_Only	UMTS 3G Only
SWI_RATMODE_GSM2G_Only	GSM 2G Only
SWI_RATMODE_UMTS3G_Preferred	UMTS 3G Preferred
SWI_RATMODE_GSM2G_Preferred	GSM 2G Preferred

enum SWI_TYPE_Reliability

An enumeration of quality of service reliability types.

See Also: SWI_STRUCT_PktSessionStatus; SWI_STRUCT_Profile; SWI_STRUCT_GsmProfileQos; SWI_STRUCT_PktSessionCall

Enumerator
SWI_RELI_Subscribed	Default reliability class
SWI_RELI_GTPAcknowledged	GTP reliability class
SWI_RELI_LLCFrameAcknowledged	LCC frame reliability class
SWI_RELI_RLCBlockModeAcknowledged	RLC acknowledged reliability class
SWI_RELI_LLCDataProtected	LCC data protected reliability class
SWI_RELI_UnackUnprotected	Unacknowledged reliability class

enum SWI_TYPE_RoamingState

Defines the roaming states returned by the modem.

See Also: SWI_STRUCT_GSM_NetworkStatus; SwiGetRoamingState

Enumerator
SWI_ROAMING_Home	not roaming
SWI_ROAMING_Roaming	roaming
SWI_ROAMING_NonPref	no roaming information
SWI_ROAMING_None	unknown roaming state

enum SWI_TYPE_Service

An enumeration of services types.

See Also: SWI_STRUCT_ServiceIcon; SWI_STRUCT_GsmSystemStatus

Enumerator
SWI_SERVICE_None	No service.
SWI_SERVICE_Gprs	GPRS
SWI_SERVICE_Edge	EDGE
SWI_SERVICE_Umts	UMTS
SWI_SERVICE_Hsdpa	HSDPA
SWI_SERVICE_Hsupa	HSUPA
SWI_SERVICE_Hspa	HSDPA + HSUPA
SWI_SERVICE_HspaPlus	HSPA+
SWI_SERVICE_DcHspaPlus	DC HSPA+
SWI_SERVICE_Lte	LTE

enum SWI_TYPE_ServiceErr

An enumeration of service errors types.

See Also: SWI_STRUCT_GsmSystemStatus

Enumerator
SWI_SERVICEERR_None	No error
SWI_SERVICEERR_Unspecified	Unspecified protocol error

enum SWI_TYPE_ServiceStatus

An enumeration of network service status types.

See Also: SWI_STRUCT_GSM_NetworkStatus; SWI_STRUCT_GsmSystemStatus; SWI_STRUCT_GsmCellMeasure; SwiGetServiceStatusEx

Enumerator
SWI_SERVICE_STATUS_Normal	The modem has acquired normal GPRS service and can use all available features.
SWI_SERVICE_STATUS_Emergency	Full service is not available but there is coverage permitting 911 emergency voice calls. The reasons full service is not available vary and can include: security lock, account activation, and others.
SWI_SERVICE_STATUS_NoService	The modem has not acquired GSM GPRS service, or the modem is security locked preventing service.
SWI_SERVICE_STATUS_AccessDifficulty	The network reports this fault. The modem is unable to register. The user should check their signal strength or contact their carrier.
SWI_SERVICE_STATUS_ForbiddenPLMN	The network indicates that you do not have permission to use it.
SWI_SERVICE_STATUS_ForbiddenArea	The modem is in a geographic area where use of the service is not permitted.
SWI_SERVICE_STATUS_ForbiddenRoaming	The modem is not in its home coverage area and is not permitted to roam in the current coverage area.
SWI_SERVICE_STATUS_IllegalMobStation	The user's account is not permitted on the network.
SWI_SERVICE_STATUS_IllegalMobEquip	The modem is not permitted on the network, possibly for regulatory reasons.
SWI_SERVICE_STATUS_UnknownIMSI	The SIM Card's identifier is unrecognized (or disqualified) by carrier.
SWI_SERVICE_STATUS_AuthenticationFailure	The user name and/or password associated with the account profile failed to authenticate.
SWI_SERVICE_STATUS_GPRSFailed	GPRS service is not available.

enum SWI_TYPE_ServiceType

An enumeration of service types.

For modems capable of both circuit switched(GSM) as well as packet (GPRS) data operations, this enumerated type identifies the type of service currently available.

See Also: SWI_STRUCT_GSM_NetworkStatus; SWI_STRUCT_GsmSystemStatus

Enumerator
SWI_SERVICE_TYPE_CircuitSwitched	Circuit switched
SWI_SERVICE_TYPE_GPRS	Packet switched
SWI_SERVICE_TYPE_Combined	Combined circuit and packet switched
SWI_SERVICE_TYPE_InvalidService	Invalid service

Function Documentation

SWI_API SWI_RCODE SwiActivateProfile	(	const swi_uint32	nProfileID,
		swi_bool	Activate,
		swi_uint32	timeout
	)

This function initiates or destroys a packet session.

Parameters

nProfileID,:	[IN] Profile ID to acted on. Profile ID ranges from 1-16 for 3G and newer devices and 1-3 for older (AC7xx and MP7xx) devices.
Activate,:	[IN] True if the profile should be activated. False if the profile should be deactivated.
timeout,:	[IN] Response timeout value in milliseconds.

Returns: SWI_RCODE_OK: The request has been processed. A SWI_NOTIFY_PktSessionStatus notification will indicate the result of the request.; SWI_RCODE_REQUEST_REJECTED: Activation requests MAY be rejected if FDN is enabled. This behaviour is customizable by the carrier. SwiGetLastError would return "FDN Mismatch".

See Also: See SWI_RCODE for other error return codes.; SWI_NOTIFY_PktSessionStatus

SWI_API SWI_RCODE SwiEraseProfile	(	const swi_uint32	nProfileID,
		swi_uint32	timeout
	)

This function will erase the account information from a profile and restore to factory defaults. The profile will then report a status of "deleted".

Parameters

nProfileID,:	[IN] Profile ID to be erased. Profile ID ranges from 1-16 for 3G and newer devices and 1-3 for older (AC7xx and MP7xx) devices.
timeout,:	[IN] Response timeout value in milliseconds

Returns: SWI_RCODE_OK: The request has been processed.; SWI_RCODE_FAILED: If the profile is active when you attempt to write a new setting, the function will return SWI_RCODE_FAILED.; See SWI_RCODE for other error return codes.

See Also: SWI_NOTIFY_GsmProfileChange

SWI_API SWI_RCODE SwiGetGsmProfileBasic	(	struct SWI_STRUCT_GsmProfileBasic *	pProfile,
		swi_uint32	timeout
	)

This function retrieves the basic details of a connection profile.

This function is used with 3G and newer devices. For older devices, use SwiGetProfile.

Calling this function on profile that is not present (deleted) returns default profile settings.

SWI_NOTIFY_GsmProfileChange can be used to monitor for changes made to profile information.

Parameters

pProfile,:	[OUT] Basic profile information
timeout,:	[IN] Response timeout value in milliseconds

Returns: SWI_RCODE_OK: The request has been processed and values returned are valid.

See Also: See SWI_RCODE for other error return codes.; SWI_STRUCT_GsmProfileBasic; SWI_NOTIFY_GsmProfileChange; SwiGetGsmProfileQos; SwiGetGsmProfileDns; SwiGetGsmProfileTft; SwiSetGsmProfileBasic; SwiSetGsmProfileQos; SwiSetGsmProfileDns; SwiSetGsmProfileTft; SWI_STRUCT_Profile

SWI_API SWI_RCODE SwiGetGsmProfileDns	(	struct SWI_STRUCT_GsmProfileDns *	pProfile,
		swi_uint32	timeout
	)

This function retrieves the DNS details of a connection profile.

This function is used with 3G and newer devices. For older devices, use SwiGetProfile.

Calling this function on profile that is not present (deleted) returns default profile settings.

SWI_NOTIFY_GsmProfileChange can be used to monitor for changes made to profile information.

Parameters

pProfile,:	[OUT] DNS profile information
timeout,:	[IN] Response timeout value in milliseconds

Returns: SWI_RCODE_OK: The request has been processed and values returned are valid.

See Also: See SWI_RCODE for other error return codes.; SWI_STRUCT_GsmProfileDns; SWI_NOTIFY_GsmProfileChange; SwiGetGsmProfileBasic; SwiGetGsmProfileQos; SwiGetGsmProfileTft; SwiSetGsmProfileBasic; SwiSetGsmProfileQos; SwiSetGsmProfileDns; SwiSetGsmProfileTft; SWI_STRUCT_Profile

SWI_API SWI_RCODE SwiGetGsmProfileQos	(	struct SWI_STRUCT_GsmProfileQos *	pProfile,
		swi_uint32	timeout
	)

This function retrieves the QoS details of a connection profile.

This function is used with 3G and newer devices. For older devices, use SwiGetProfile.

Calling this function on profile that is not present (deleted) returns default profile settings.

SWI_NOTIFY_GsmProfileChange can be used to monitor for changes made to profile information.

Parameters

pProfile,:	[OUT] QoS profile information
timeout,:	[IN] Response timeout value in milliseconds

Returns: SWI_RCODE_OK: The request has been processed and values returned are valid.

See Also: See SWI_RCODE for other error return codes.; SWI_STRUCT_GsmProfileQos; SWI_NOTIFY_GsmProfileChange; SwiGetGsmProfileBasic; SwiGetGsmProfileDns; SwiGetGsmProfileTft; SwiSetGsmProfileBasic; SwiSetGsmProfileQos; SwiSetGsmProfileDns; SwiSetGsmProfileTft; SWI_STRUCT_Profile

SWI_API SWI_RCODE SwiGetGsmProfileSummary	(	struct SWI_STRUCT_GsmProfileSummary *	pProfileSummary,
		swi_uint32	timeout
	)

This function returns a summary of the status of all account profiles, and identifies which one is the default profile for auto connection.

Use this function with 3G and newer devices. SwiGetProfileSummary should be used with older devices.

The summary reports the status of each profile along with its context number. The summary structure reports two profile context identities: one for the default profile used for automatic activation, and another to identify the current profile that is actively connected to the network (activated). If the modem is not currently connected, the current profile context is reported as zero.

Parameters

pProfileSummary,:	[OUT] Profile summary information
timeout,:	[IN] Response timeout value in milliseconds

Returns: SWI_RCODE_OK: The request has been processed and values returned are valid.

See Also: See SWI_RCODE for other error return codes.; SWI_STRUCT_GsmProfileSummary; SwiGetProfileSummary

SWI_API SWI_RCODE SwiGetGsmProfileTft	(	struct SWI_STRUCT_GsmProfileTft *	pProfile,
		swi_uint32	timeout
	)

This function retrieves the TFT details of a connection profile.

This function is used with 3G and newer devices. Older devices do not support TFT configurations.

Calling this function on profile that is not present (deleted) returns default profile settings.

SWI_NOTIFY_GsmProfileChange can be used to monitor for changes made to profile information.

Parameters

pProfile,:	[OUT] TFT profile information
timeout,:	[IN] Response timeout value in milliseconds

Returns: SWI_RCODE_OK: The request has been processed and values returned are valid.

See Also: See SWI_RCODE for other error return codes.; SWI_STRUCT_GsmProfileTft; SWI_NOTIFY_GsmProfileChange; SwiGetGsmProfileBasic; SwiGetGsmProfileDns; SwiGetGsmProfileQos; SwiSetGsmProfileBasic; SwiSetGsmProfileQos; SwiSetGsmProfileDns; SwiSetGsmProfileTft; SWI_STRUCT_Profile

SWI_API SWI_RCODE SwiGetGsmSystemStatus	(	struct SWI_STRUCT_GsmSystemStatus *	pSysStatus,
		swi_uint32	timeout
	)

This function is used to retrieve the GSM system status.

This function replaces SwiGetNetworkStatus.

Use of this function should be limited. SWI_NOTIFY_GsmSystemStatus notification is generated when there is a change in the system status information. Use of notifications is preferred over direct polling.

This function is only supported on GSM devices.

Parameters

pSysStatus,:	[OUT] System status
timeout,:	[IN] Response timeout value in milliseconds.

Returns: SWI_RCODE_OK: The request has been processed and values returned are valid.

See Also: See SWI_RCODE for other error return codes.; SWI_STRUCT_GsmSystemStatus; SWI_NOTIFY_GsmSystemStatus; SwiGetNetworkStatus

SWI_API SWI_RCODE SwiGetIPAddressEx	(	struct SWI_STRUCT_IpAddress *	pIp,
		swi_uint32	timeout
	)

This function retrieves the IP address of the specified profile.

This function is only supported on GSM devices.

Parameters

pIp,:	[OUT] IP address information. ProfileId of the IP address structure must be specified before calling this function.
timeout,:	[IN] Response timeout value in milliseconds.

Returns: SWI_RCODE_OK: The request has been processed and values returned are valid.

See Also: See SWI_RCODE for other error return codes.; SWI_STRUCT_IpAddress; SwiGetIPAddress

SWI_API SWI_RCODE SwiGetPktSessionStatus	(	struct SWI_STRUCT_PktSessionStatus *	sSessionStatus,
		swi_uint32	timeout
	)

This function is used to fetch the packet session status of the modem.

This function has been deprecated and SwiGetPktSessionStatusEx() should be used instead.

See Also: SwiGetPktSessionStatusEx()

Parameters

sSessionStatus,:	[OUT] Packet session status
timeout,:	[IN] Response timeout value in milliseconds

Returns: SWI_RCODE_OK: The request has been processed and values returned are valid.

See Also: See SWI_RCODE for other error return codes.; SWI_STRUCT_PktSessionStatus; SWI_NOTIFY_PktSessionStatus

SWI_API SWI_RCODE SwiGetPktSessionStatusEx	(	struct SWI_STRUCT_PktSessionCall *	sPktSessionCall,
		swi_uint32	timeout
	)

This API is used to fetch the packet session status of the modem.

This API replaces the old API SwiGetPktSessionStatus()

This API is only supported on GSM devices.

Parameters

sSessionStatus,:	[IN/OUT] Packet session status containing profileID
timeout,:	[IN] Response timeout value in milliseconds

Returns: SWI_RCODE_OK: The request has been processed and values returned are valid.

See Also: See SWI_RCODE for other error return codes.; SWI_STRUCT_PktSessionCall

SWI_API SWI_RCODE SwiGetPLMNMode	(	enum SWI_TYPE_PLMN_Mode *	eMode,
		swi_uint32	timeout
	)

This function is used to fetch the PLMN selection mode of the modem.

The modem PLMN selection mode will be either Automatic or Manual.

This function is only supported on GSM devices.

Parameters

eMode,:	[OUT] PLMN selection mode
timeout,:	[OUT] Response timeout value in milliseconds

Returns: SWI_RCODE_OK: The request has been processed and values returned are valid.

See Also: See SWI_RCODE for other error return codes.; SWI_TYPE_PLMN_Mode; SwiSetPLMNMode

SWI_API SWI_RCODE SwiGetPLMNSelection	(	struct SWI_STRUCT_PlmnSelection *	sPlmn,
		swi_uint32	timeout
	)

The PLMN scan initiated by SwiStartPLMNSearch compiles a list of PLMNs in the area. This function is used to retrieve a single PLMN from that list.

This function is only supported on GSM devices.

Parameters

sPlmn,:	[OUT] PLMN information
timeout,:	[IN] Response timeout value in milliseconds

Returns: SWI_RCODE_OK: The request has been processed and values returned are valid. The modem's response contains a single PLMNs information and will indicate if there are more PLMN to be retrieved from the list on the modem. See SWI_STRUCT_PlmnSelection for additional info. If there are additional PLMNs in the list, call SwiGetPLMNSelection repeatedly until all PLMNs are read.

See Also: See SWI_RCODE for other error return codes.; SWI_NOTIFY_PlmnAvailable; SwiStartPLMNSearch; SWI_STRUCT_PlmnSelection

SWI_API SWI_RCODE SwiGetPrlRegion	(	struct SWI_STRUCT_PrlRegion *	psPrl,
		swi_uint32	timeout
	)

This function allows the host to get the PRL Region of the device. The PRL Region setting determines the scan order and grouping of the GSM and WCDMA bands.

Parameters

sPrl:[OUT]	PRL region information. The structure size must be populated by the caller.
timeout:[IN]	Response timeout value in milliseconds

Returns: SWI_RCODE_OK: The request has been processed and values returned are valid. when SWI_RCODE_OK is returned, the caller still has to check the ePrlChangeStatu *s for the actual results of the request.; See SWI_RCODE for other error return codes.

See Also: SWI_STRUCT_PrlRegion; SwiSetPrlRegion

SWI_API SWI_RCODE SwiGetRat	(	struct SWI_STRUCT_Rat *	psRat,
		swi_uint32	timeout
	)

This function allows the host to get the RAT mode of the device. This function is only supported on GSM devices.

Parameters

psRat,:	[OUT] RAT mode information.
timeout,:	[IN] Response timeout value in milliseconds

Returns: SWI_RCODE_OK: The request has been processed and values returned are valid.; See SWI_RCODE for other error return codes.

See Also: SWI_STRUCT_Rat; SwiSetRat

SWI_API SWI_RCODE SwiGetRscpEcIo	(	struct SWI_STRUCT_RscpEcIo *	pRscpEcIo,
		swi_uint32	timeout
	)

This function is used to retrieve the RSCP and Ec/Io measurements.

Use of this function should be limited. SWI_NOTIFY_RscpEcIo notification is generated when there is a change in the information. Use of notifications is preferred over direct polling.

This function is only supported on GSM devices.

Parameters

pRscpEcIo,:	[OUT] RSCP and Ec/Io measurements.
timeout,:	[IN] Response timeout value in milliseconds

Returns: SWI_RCODE_OK: The request has been processed and values returned are valid.; See SWI_RCODE for other error return codes.

See Also: SWI_STRUCT_RscpEcIo; SWI_NOTIFY_RscpEcIo

SWI_API SWI_RCODE SwiGetRssiBars	(	const swi_int32	iRssi,
		swi_uint32 *	pNumBars
	)

This function maps RSSI values to the number of RSSI bars that should be shown to the user. It will output 0 to 5 RSSI bars.

This function is only supported on GSM devices.

Parameters

iRssi,:	[IN] RSSI value in dBm to be converted to number of RSSI bars.
pNumBars,:	[OUT] Number of RSSI bars to be displayed.

Returns: SWI_RCODE_OK: The request has been processed and values returned are valid.; SWI_RCODE_INVALID_PAR: Invalid RRSI value was supplied.

See Also: See SWI_RCODE for other error return codes.; To get the RSSI value in dBm, call SwiGetRssiBer.

SWI_API SWI_RCODE SwiGetRssiBer	(	struct SWI_STRUCT_Rssi *	sRssiBer,
		swi_uint32	timeout
	)

Function Prototypes

This function is used to fetch the current received signal strength indication (RSSI) and bit error rate (BER) from the modem.

The RSSI values are measured in dBm. A return value approaching -110 indicates that the modem is outside of coverage or the signal is weak.

Use of this function should be reserved to application startup. There is a notification available in the GPRS API (SWI_NOTIFY_Rssi) that also includes a measure of the Block Error Rate (BER). Use of notifications is preferred over direct polling.

This function is only supported on GSM devices.

Parameters

sRssiBer,:	[OUT] RSSI and BER values
timeout,:	[IN] Response timeout value in milliseconds.

Returns: SWI_RCODE_OK: The request has been processed and values returned are valid.

See Also: See SWI_RCODE for other error return codes.; SWI_STRUCT_Rssi; SWI_NOTIFY_Rssi

SWI_API SWI_RCODE SwiGetServiceStatusEx	(	enum SWI_TYPE_ServiceStatus *	eServiceStatus,
		swi_uint32	timeout
	)

This function requests the current service status from the modem.

Use of this function should be limited. There is a notification available in the GPRS API (SWI_NOTIFY_NetworkStatus or SWI_NOTIFY_GsmSystemStatus) that reports this data along with other useful service parameters. Use of notifications is preferred over direct polling.

This function is only supported on GSM devices.

Parameters

eServiceStatus,:	[OUT] Service status
timeout,:	[IN] Response timeout value in milliseconds.

Returns: SWI_RCODE_OK: The request has been processed and values returned are valid.

See Also: See SWI_RCODE for other error return codes.; SWI_TYPE_ServiceStatus; SWI_STRUCT_GsmSystemStatus; SWI_NOTIFY_NetworkStatus

SWI_API SWI_RCODE SwiGetTrafficStatistics	(	swi_uint32 *	nSent,
		swi_uint32 *	nReceived,
		swi_uint32	timeout
	)

This function is called to retrieve network traffic statistics (the number of bytes transmitted and received).

The traffic counters are reset to zero when the connection is dropped. While disconnected, this will report zeros. The traffic count is user payload data only and does not include network housekeeping traffic or SMS messages.

Parameters

nSent,:	[OUT] Number of bytes sent
nReceived,:	[OUT] Number of bytes received
timeout,:	[IN] Response timeout value in milliseconds

See Also: See SWI_RCODE for additional information.

SWI_API SWI_RCODE SwiResetTrafficStatistics ( swi_uint32 timeout )

This function is used to reset the modem's byte data counters.

If not explicitly reset, byte counter information is persistent across PDP context activations.

This function is only supported on GSM devices.

Parameters

timeout,: [IN] Response timeout value in milliseconds.

Returns: SWI_RCODE_OK: The request has been processed.

See Also: See SWI_RCODE for other error return codes.

SWI_API SWI_RCODE SwiSetDefaultProfile	(	const swi_uint32	nProfileID,
		swi_uint32	timeout
	)

This function sets which profile is to be used for possible automatic connection. If the profile that is set to be the default has the auto connection flag set to true, then that profile will be used to connect to the network automatically when the modem is started or reset.

The modem does not verify that the profile contains a valid (non-blank) account. You can set the default to a "deleted" profile; the autoconnect flag will be false so this is equivalent to disabling autoconnection.

Parameters

nProfileID,:	[IN] Profile ID to be made the default. Profile ID ranges from 1-16 for 3G and newer devices and 1-3 for older (AC7xx and MP7xx) devices.
timeout,:	[IN] Response timeout value in milliseconds.

Returns: SWI_RCODE_OK: The request has been processed.

See Also: See SWI_RCODE for other error return codes.; SwiGetGsmProfileSummary; SwiGetProfileSummary

SWI_API SWI_RCODE SwiSetGsmProfileBasic	(	struct SWI_STRUCT_GsmProfileBasic	pProfile,
		swi_uint32	timeout
	)

This function stores the basic user account information in a profile slot, making it available for connection.

This function is used with 3G and newer devices. For older devices, use SwiSetProfile.

Parameters

pProfile,:	[IN] Basic profile information to be updated on the modem. The profile ID and size of the structure must be provided by the caller.
timeout,:	[IN] Response timeout value in milliseconds

Returns: SWI_RCODE_OK: The request has been processed.; SWI_RCODE_FAILED: The modem will verify the validity of the data in the profile structure. If it fails to validate, the function will return SWI_RCODE_FAILED. You must use the validation process provided in the sample code to ensure the profile data can be written. If the profile is active when you attempt to write a new setting, the function will also return SWI_RCODE_FAILED.

See Also: See SWI_RCODE for other error return codes.; SWI_STRUCT_GsmProfileBasic; SWI_NOTIFY_GsmProfileChange

SWI_API SWI_RCODE SwiSetGsmProfileDns	(	struct SWI_STRUCT_GsmProfileDns	pProfile,
		swi_uint32	timeout
	)

This function stores the DNS user account information in a profile slot.

This function is used with 3G and newer devices. For older devices, use SwiSetProfile.

Parameters

pProfile,:	[IN] DNS profile information to be updated on the modem. The profile ID and size of the structure must be provided by the caller.
timeout,:	[IN] Response timeout value in milliseconds

Returns: SWI_RCODE_OK: The request has been processed.; SWI_RCODE_FAILED: The modem will verify the validity of the data in the profile structure. If it fails to validate, the function will return SWI_RCODE_FAILED. You must use the validation process provided in the sample code to ensure the profile data can be written. If the profile is active when you attempt to write a new setting, the function will also return SWI_RCODE_FAILED.

See Also: See SWI_RCODE for other error return codes.; SWI_STRUCT_GsmProfileDns; SWI_NOTIFY_GsmProfileChange

SWI_API SWI_RCODE SwiSetGsmProfileQos	(	struct SWI_STRUCT_GsmProfileQos	pProfile,
		swi_uint32	timeout
	)

This function stores the QoS user account information in a profile slot.

This function is used with 3G and newer devices. For older devices, use SwiSetProfile.

Parameters

pProfile,:	[IN] QoS profile information to be updated on the modem. The profile ID and size of the structure must be provided by the caller.
timeout,:	[IN] Response timeout value in milliseconds

Returns: SWI_RCODE_OK: The request has been processed.; SWI_RCODE_FAILED: The modem will verify the validity of the data in the profile structure. If it fails to validate, the function will return SWI_RCODE_FAILED. You must use the validation process provided in the sample code to ensure the profile data can be written. If the profile is active when you attempt to write a new setting the function will also return SWI_RCODE_FAILED.

See Also: See SWI_RCODE for other error return codes.; SWI_STRUCT_GsmProfileQos; SWI_NOTIFY_GsmProfileChange

SWI_API SWI_RCODE SwiSetGsmProfileTft	(	struct SWI_STRUCT_GsmProfileTft	pProfile,
		swi_uint32	timeout
	)

This function stores the TFT user account information in a profile slot.

This function is used with 3G and newer devices. Older devices do not support TFT configurations.

Parameters

pProfile,:	[IN] TFT profile information to be updated on the modem. The profile ID and size of the structure must be provided by the caller.
timeout,:	[IN] Response timeout value in milliseconds

Returns: SWI_RCODE_OK: The request has been processed.; SWI_RCODE_FAILED: The modem will verify the validity of the data in the profile structure. If it fails to validate, the function will return SWI_RCODE_FAILED. You must use the validation process provided in the sample code to ensure the profile data can be written. If the profile is active when you attempt to write a new setting, the function will also return SWI_RCODE_FAILED.

See Also: See SWI_RCODE for other error return codes.; SWI_STRUCT_GsmProfileTft; SWI_NOTIFY_GsmProfileChange

SWI_API SWI_RCODE SwiSetHostStartup	(	swi_bool	bStartup,
		swi_uint32	timeout
	)

This function controls the radio power state.

This function is similar to SwiSetModemDisable. When called to "shutdown" the radio, the modem will detach from the network and power down the radio. Unlike SwiSetModemDisable, however, this powered down state is NOT persistent across modem power cycles.

When called to "startup" the radio, the modem will power on the radio and attempt to attach to a network (if available).

It is recommended that this function be called with the "shutdown" parameter when the host application shuts down or when the PC enters a suspend state.

It is recommended that this function be called with the "startup" parameter when the host application initially starts up and after resuming from a PC suspend state.

A change in the radio's power state will be signaled with a SWI_NOTIFY_ModemDisabled indication.

This function is only supported on GSM devices.

Parameters

bStartup,:	[IN] Set to true to power up the radio and attempt to attach to a network (if available). Set to false to detach from the network and power down the radio.
timeout,:	[IN] Response timeout value in milliseconds.

Returns: SWI_RCODE_OK: The request was received by the modem. The result of the request is indicated in a SWI_NOTIFY_ModemDisabled notification.; See SWI_RCODE for other error return codes.

See Also: SWI_NOTIFY_ModemDisabled

SWI_API SWI_RCODE SwiSetPLMNMode	(	const struct SWI_STRUCT_PlmnSelection	sPlmn,
		swi_uint32	timeout
	)

This function is used to set the PLMN selection mode of the modem.

The mode can be set to automatic or manual. The PLMN must be specified for the manual mode. Use SwiStartPLMNSearch to search for a list of available PLMNs before switching to manual mode.

This function is only supported on GSM devices.

Parameters

sPlmn,:	[IN] PLMN selection mode information
timeout,:	[IN] Response timeout value in milliseconds

Returns: SWI_RCODE_OK: The request has been processed and values returned are valid.

See Also: See SWI_RCODE for other error return codes.; SWI_STRUCT_PlmnSelection; SwiGetPLMNMode; SwiStartPLMNSearch

SWI_API SWI_RCODE SwiSetPrlRegion	(	struct SWI_STRUCT_PrlRegion *	psPrl,
		swi_uint32	timeout
	)

This function allows the host to set the PRL Region of the device. The PRL Region setting determines the scan order and grouping of the GSM and WCDMA bands.

Parameters

sPrl:[IN/OUT]	PRL region information. The structure size, PRL region and the password to unlock API must be populated by the caller. The action result is returned.
timeout:[IN]	Response timeout value in milliseconds

Returns: SWI_RCODE_OK: The request has been processed and values returned are valid. when SWI_RCODE_OK is returned, the caller still has to check the ePrlChangeStatus for the actual result of the request.; See SWI_RCODE for other error return codes.

See Also: SWI_STRUCT_PrlRegion; SwiGetPrlRegion; SwiApiUnlock

SWI_API SWI_RCODE SwiSetRat	(	struct SWI_STRUCT_Rat *	psRat,
		swi_uint32	timeout
	)

This function allows the host to set the RAT mode of the device. This function is only supported on GSM devices.

Parameters

psRat	[IN/OUT] RAT information. The structure size and RAT mode type must be supplied by the caller. The action result is returned.
timeout	[IN]: Response timeout value in milliseconds

Returns: SWI_RCODE_OK: The request has been processed and values returned are valid.; See SWI_RCODE for other error return codes.

See Also: SWI_STRUCT_Rat; SwiGetRat

SWI_API SWI_RCODE SwiStartPLMNSearch ( swi_uint32 timeout )

This function is used to initiate a PLMN scan. In general this is done before switching to manual PLMN selection mode.

This function should not be called until the SWI_NOTIFY_PlmnReady notification has been received.

This function is only supported on GSM devices.

Parameters

timeout,: [IN] Response timeout value in milliseconds

Returns: SWI_RCODE_OK: The request has been processed. The result of the request will be indicated in a SWI_NOTIFY_PlmnAvailable notification. SwiGetPLMNSelection() should be used to retrieve the list of PLMN found in the area as a result of the scan.

See Also: See SWI_RCODE for other error return codes.; SWI_NOTIFY_PlmnAvailable; SWI_NOTIFY_PlmnReady; SwiGetPLMNSelection; SwiSetPLMNMode; SwiGetPLMNMode

Data Structures

Macros

Enumerations

Functions

Detailed Description

Macro Definition Documentation

Enumeration Type Documentation

Function Documentation