Network Management and Status


Classes

struct  SWI_STRUCT_RadioBandInfo
struct  SWI_STRUCT_RadioBandList
struct  SWI_STRUCT_RadioBandConfig
struct  SWI_STRUCT_TransmitAlert

Defines

#define SWI_RADIOBANDGROUP_CdmaClass0A   0x0000000000000001ui64
#define SWI_RADIOBANDGROUP_CdmaClass0B   0x0000000000000002ui64
#define SWI_RADIOBANDGROUP_CdmaClass1   0x0000000000000004ui64
#define SWI_RADIOBANDGROUP_CdmaClass2   0x0000000000000008ui64
#define SWI_RADIOBANDGROUP_CdmaClass3   0x0000000000000010ui64
#define SWI_RADIOBANDGROUP_CdmaClass4   0x0000000000000020ui64
#define SWI_RADIOBANDGROUP_CdmaClass5   0x0000000000000040ui64
#define SWI_RADIOBANDGROUP_CdmaClass6   0x0000000000000080ui64
#define SWI_RADIOBANDGROUP_CdmaClass7   0x0000000000000100ui64
#define SWI_RADIOBANDGROUP_CdmaClass8   0x0000000000000200ui64
#define SWI_RADIOBANDGROUP_CdmaClass9   0x0000000000000400ui64
#define SWI_RADIOBANDGROUP_CdmaClass10   0x0000000000000800ui64
#define SWI_RADIOBANDGROUP_CdmaClass11   0x0000000000001000ui64
#define SWI_RADIOBANDGROUP_CdmaClass12   0x0000000000002000ui64
#define SWI_RADIOBANDGROUP_Gsm450   0x0000000000010000ui64
#define SWI_RADIOBANDGROUP_Gsm480   0x0000000000020000ui64
#define SWI_RADIOBANDGROUP_Gsm750   0x0000000000040000ui64
#define SWI_RADIOBANDGROUP_Gsm850   0x0000000000080000ui64
#define SWI_RADIOBANDGROUP_GsmRGsm900   0x0000000000100000ui64
#define SWI_RADIOBANDGROUP_GsmPcs1900   0x0000000000200000ui64
#define SWI_RADIOBANDGROUP_GsmDcs1800   0x0000000000400000ui64
#define SWI_RADIOBANDGROUP_GsmEGsm900   0x0000000000800000ui64
#define SWI_RADIOBANDGROUP_GsmPGsm900   0x0000000001000000ui64
#define SWI_RADIOBANDGROUP_WcdmaIImt2000   0x0000000100000000ui64
#define SWI_RADIOBANDGROUP_WcdmaIIPcs1900   0x0000000200000000ui64
#define SWI_RADIOBANDGROUP_WcdmaIII1700   0x0000000400000000ui64
#define SWI_RADIOBANDGROUP_WcdmaIV1700   0x0000000800000000ui64
#define SWI_RADIOBANDGROUP_WcdmaV850   0x0000001000000000ui64
#define SWI_RADIOBANDGROUP_WcdmaVI800   0x0000002000000000ui64
#define SWI_RADIOBANDGROUP_WcdmaVII2600   0x0000004000000000ui64
#define SWI_RADIOBANDGROUP_WcdmaVIII900   0x0000008000000000ui64
#define SWI_RADIOBANDGROUP_WcdmaIX1700   0x0000010000000000ui64
#define SWI_RADIOBANDGROUP_AutoBand   0xFFFFFFFFFFFFFFFFui64

Enumerations

enum  SWI_TYPE_RadioType { SWI_RADIOTYPE_1xrtt, SWI_RADIOTYPE_Evdo, SWI_RADIOTYPE_GsmWcdma }
enum  SWI_TYPE_RadioBand {
  SWI_RADIOBAND_CdmaClass0 = 0x00, SWI_RADIOBAND_CdmaClass1, SWI_RADIOBAND_CdmaClass2, SWI_RADIOBAND_CdmaClass3,
  SWI_RADIOBAND_CdmaClass4, SWI_RADIOBAND_CdmaClass5, SWI_RADIOBAND_CdmaClass6, SWI_RADIOBAND_CdmaClass7,
  SWI_RADIOBAND_CdmaClass8, SWI_RADIOBAND_CdmaClass9, SWI_RADIOBAND_CdmaClass10, SWI_RADIOBAND_CdmaClass11,
  SWI_RADIOBAND_CdmaClass12, SWI_RADIOBAND_Gsm450 = 0x28, SWI_RADIOBAND_Gsm480, SWI_RADIOBAND_Gsm750,
  SWI_RADIOBAND_Gsm850, SWI_RADIOBAND_GsmEGsm900, SWI_RADIOBAND_GsmPGsm900, SWI_RADIOBAND_GsmRGsm900,
  SWI_RADIOBAND_GsmDcs1800, SWI_RADIOBAND_GsmPcs1900, SWI_RADIOBAND_WcdmaIImt2000 = 0x50, SWI_RADIOBAND_WcdmaIIPcs1900,
  SWI_RADIOBAND_WcdmaIIIDcs1800, SWI_RADIOBAND_WcdmaIV1700, SWI_RADIOBAND_WcdmaV850, SWI_RADIOBAND_WcdmaVI800,
  SWI_RADIOBAND_WcdmaVII2600, SWI_RADIOBAND_WcdmaVIII900, SWI_RADIOBAND_WcdmaIX1700, SWI_RADIOBAND_Invalid = 0xFF
}
enum  SWI_TYPE_TransmitSpeed { SWI_SPPED_1x, SWI_SPPED_2x, SWI_SPPED_3x }
enum  SWI_TYPE_ModeSelection { SWI_MODE_SELECTION_Automatic, SWI_MODE_SELECTION_Manual }
enum  SWI_TYPE_Band {
  SWI_BAND_None, SWI_BAND_PGSM, SWI_BAND_EGSM, SWI_BAND_DCS,
  SWI_BAND_PGSM_DCS, SWI_BAND_EGSM_DCS, SWI_BAND_PCS, SWI_BAND_PGSM_PCS,
  SWI_BAND_EGSM_PCS, SWI_BAND_GSM850, SWI_BAND_GSM850_PCS, SWI_BAND_GSM_ALL,
  SWI_BAND_WCDMA_EU, SWI_BAND_WCDMA_NA, SWI_BAND_WCDMA_GSM_NA, SWI_BAND_WCDMA_GSM_EU,
  SWI_BAND_WCDMA_ALL = 0x0010, SWI_BAND_WCDMA_AU, SWI_BAND_WCDMA_JAP, SWI_BAND_WCDMA_GSM_AU,
  SWI_BAND_WCDMA_GSM_AU_2, SWI_BAND_WCDMA_GSM_AU_3, SWI_BAND_WCDMA_EMEA, SWI_BAND_WCDMA_GSM_EU2,
  SWI_BAND_WCDMA_EU_2, SWI_BAND_WCDMA_NA2, SWI_BAND_WCDMA_EU_3, SWI_BAND_AUTO = 0xffff
}

Functions

SWI_API SWI_RCODE SwiGetRoamingState (SWI_TYPE_RoamingState *eRoaming, U32 timeout)
SWI_API SWI_RCODE SwiGetNetworkProviderID (LPTSTR szName, U32 sizeBuffer, U32 timeout)
SWI_API SWI_RCODE SwiGetCurrentRadioBand (SWI_STRUCT_RadioBandList *pRadioBand, U32 timeout)
SWI_API SWI_RCODE SwiGetRadioBandCfg (SWI_STRUCT_RadioBandConfig *pRadioBand, U32 timeout)
SWI_API SWI_RCODE SwiSetRadioBandCfg (const U64 nRadioBandGroup, U32 timeout)
SWI_API SWI_RCODE SwiGetTrafficStatistics (U32 *nSent, U32 *nReceived, U32 Timeout)
SWI_API SWI_RCODE SwiOptimizeTcp (SWI_STRUCT_TcpOpt sTcpOpt)
SWI_API SWI_RCODE SwiGetTcpOpt (SWI_STRUCT_TcpOpt &sTcpOpt)
SWI_API SWI_RCODE SwiGetDeviceTime (SWI_STRUCT_DeviceTime *pDeviceTime, U32 timeout)
SWI_API SWI_RCODE SwiGetCellID (U32 *nCellID, U32 timeout)
SWI_API SWI_RCODE SwiGetRssiBars (const I32 iRssi, U32 *pNumBars)
SWI_API SWI_RCODE SwiGetRssiBer (SWI_STRUCT_Rssi *sRssiBer, U32 timeout)
SWI_API SWI_RCODE SwiGetServiceStatusEx (SWI_TYPE_ServiceStatus *eServiceStatus, U32 timeout)
SWI_API SWI_RCODE SwiResetTrafficStatistics (U32 timeout)
SWI_API SWI_RCODE SwiGetRoamingDisable (bool *bDisable, U32 timeout)
SWI_API SWI_RCODE SwiSetRoamingDisable (const bool bDisable, U32 timeout)
SWI_API SWI_RCODE SwiGetBandInfo (SWI_STRUCT_Band *sBandInfo, U32 timeout)
SWI_API SWI_RCODE SwiSetBandInfo (const SWI_STRUCT_SetBand *pBandInfo, U32 timeout)
SWI_API SWI_RCODE SwiGetTransmitSpeed (SWI_TYPE_TransmitSpeed *TransmitSpeed, U32 timeout)
SWI_API SWI_RCODE SwiSetTransmitSpeed (const SWI_TYPE_TransmitSpeed TransmitSpeed, U32 timeout)
SWI_API SWI_RCODE SwiGetIPAddress (LPTSTR szIPAddress, U32 sizeBuffer, U32 timeout)
SWI_API SWI_RCODE SwiGetIPAddressEx (SWI_STRUCT_IpAddress *pIp, U32 timeout)
SWI_API SWI_RCODE SwiGetNetworkStatus (SWI_STRUCT_GSM_NetworkStatus *sNetworkStatus, U32 timeout)
SWI_API SWI_RCODE SwiGetPktSessionStatus (SWI_STRUCT_PktSessionStatus *sSessionStatus, U32 timeout)
SWI_API SWI_RCODE SwiGetPktSessionStatusEx (SWI_STRUCT_PktSessionCall *sSessionCall, U32 timeout)
SWI_API SWI_RCODE SwiGetPLMNMode (SWI_TYPE_PLMN_Mode *eMode, U32 timeout)
SWI_API SWI_RCODE SwiSetPLMNMode (const SWI_STRUCT_PlmnSelection sPlmn, U32 timeout)
SWI_API SWI_RCODE SwiStartPLMNSearch (U32 timeout)
SWI_API SWI_RCODE SwiGetPLMNSelection (SWI_STRUCT_PlmnSelection *sPlmn, U32 timeout)
SWI_API SWI_RCODE SwiGetGsmSystemStatus (SWI_STRUCT_GsmSystemStatus *pSysStatus, U32 timeout)
SWI_API SWI_RCODE SwiGetGsmCellInfo (SWI_STRUCT_GsmCellInfo *pCellInfo, U32 timeout)
SWI_API SWI_RCODE SwiGetRscpEcIo (SWI_STRUCT_RscpEcIo *pRscpEcIo, U32 timeout)

Define Documentation

#define SWI_RADIOBANDGROUP_AutoBand   0xFFFFFFFFFFFFFFFFui64

Auto band

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See also:
SWI_STRUCT_RadioBandInfo

SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_CdmaClass0A   0x0000000000000001ui64

Band Class 0 A-system only (Cellular)

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See also:
SWI_STRUCT_RadioBandInfo

SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_CdmaClass0B   0x0000000000000002ui64

Band Class 0 B-system only (Cellular)

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See also:
SWI_STRUCT_RadioBandInfo

SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_CdmaClass1   0x0000000000000004ui64

Band Class 1 (US PCS)

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See also:
SWI_STRUCT_RadioBandInfo

SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_CdmaClass10   0x0000000000000800ui64

Band Class 10 (Secondary 800 MHz)

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See also:
SWI_STRUCT_RadioBandInfo

SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_CdmaClass11   0x0000000000001000ui64

Band Class 11 (400 MHz European PAMR)

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See also:
SWI_STRUCT_RadioBandInfo

SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_CdmaClass12   0x0000000000002000ui64

Band Class 12 (800 MHz PAMR)

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See also:
SWI_STRUCT_RadioBandInfo

SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_CdmaClass2   0x0000000000000008ui64

Band Class 2 (TACS)

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See also:
SWI_STRUCT_RadioBandInfo

SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_CdmaClass3   0x0000000000000010ui64

Band Class 3 (JTACS)

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See also:
SWI_STRUCT_RadioBandInfo

SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_CdmaClass4   0x0000000000000020ui64

Band Class 4 (Korean PCS)

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See also:
SWI_STRUCT_RadioBandInfo

SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_CdmaClass5   0x0000000000000040ui64

Band Class 5 (450 MHz)

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See also:
SWI_STRUCT_RadioBandInfo

SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_CdmaClass6   0x0000000000000080ui64

Band Class 6 (2 GHz)

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See also:
SWI_STRUCT_RadioBandInfo

SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_CdmaClass7   0x0000000000000100ui64

Band Class 7 (700 MHz)

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See also:
SWI_STRUCT_RadioBandInfo

SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_CdmaClass8   0x0000000000000200ui64

Band Class 8 (1800 MHz)

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See also:
SWI_STRUCT_RadioBandInfo

SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_CdmaClass9   0x0000000000000400ui64

Band Class 9 (900 MHz)

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See also:
SWI_STRUCT_RadioBandInfo

SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_Gsm450   0x0000000000010000ui64

GSM 450

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See also:
SWI_STRUCT_RadioBandInfo

SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_Gsm480   0x0000000000020000ui64

GSM 480

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See also:
SWI_STRUCT_RadioBandInfo

SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_Gsm750   0x0000000000040000ui64

GSM 750

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See also:
SWI_STRUCT_RadioBandInfo

SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_Gsm850   0x0000000000080000ui64

GSM 850

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See also:
SWI_STRUCT_RadioBandInfo

SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_GsmDcs1800   0x0000000000400000ui64

GSM DCS 1800

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See also:
SWI_STRUCT_RadioBandInfo

SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_GsmEGsm900   0x0000000000800000ui64

GSM EGSM 900

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See also:
SWI_STRUCT_RadioBandInfo

SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_GsmPcs1900   0x0000000000200000ui64

GSM PCS 1900

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See also:
SWI_STRUCT_RadioBandInfo

SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_GsmPGsm900   0x0000000001000000ui64

GSM PGSM 900

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See also:
SWI_STRUCT_RadioBandInfo

SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_GsmRGsm900   0x0000000000100000ui64

GSM RGSM 900

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See also:
SWI_STRUCT_RadioBandInfo

SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_WcdmaIII1700   0x0000000400000000ui64

WCDMA III 1700

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See also:
SWI_STRUCT_RadioBandInfo

SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_WcdmaIImt2000   0x0000000100000000ui64

WCDMA I IMT 2000 (EU)

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See also:
SWI_STRUCT_RadioBandInfo

SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_WcdmaIIPcs1900   0x0000000200000000ui64

WCDMA II PCS 1900

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See also:
SWI_STRUCT_RadioBandInfo

SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_WcdmaIV1700   0x0000000800000000ui64

WCDMA IV 1700

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See also:
SWI_STRUCT_RadioBandInfo

SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_WcdmaIX1700   0x0000010000000000ui64

WCDMA IX 1700

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See also:
SWI_STRUCT_RadioBandInfo

SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_WcdmaV850   0x0000001000000000ui64

WCDMA V 850

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See also:
SWI_STRUCT_RadioBandInfo

SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_WcdmaVI800   0x0000002000000000ui64

WCDMA VI 800

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See also:
SWI_STRUCT_RadioBandInfo

SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_WcdmaVII2600   0x0000004000000000ui64

WCDMA VII 2600

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See also:
SWI_STRUCT_RadioBandInfo

SwiGetCurrentRadioBand

#define SWI_RADIOBANDGROUP_WcdmaVIII900   0x0000008000000000ui64

WCDMA VIII 900

This radio band group is to be used with SWI_STRUCT_RadioBandConfig.

See also:
SWI_STRUCT_RadioBandInfo

SwiGetCurrentRadioBand


Enumeration Type Documentation

An enumeration of frequency bands.

This enumeration is only used with AC710/AC750/AC775/AC850/AC860 devices. Newer devices should use SWI_TYPE_RadioBand.

The AC710 is a single band card. It only supports PCS. The AC750 is a tri-band card. It supports EGSM, EGSM_DCS, PCS and Auto.

See also:
SWI_STRUCT_Band

SWI_STRUCT_SetBand

SWI_TYPE_RadioBand

Enumerator:
SWI_BAND_None  None
SWI_BAND_PGSM  900MHz (not supported)
SWI_BAND_EGSM  Extended 900MHz
SWI_BAND_DCS  1800MHz (not supported)
SWI_BAND_PGSM_DCS  900MHz and 1800MHz (not supported)
SWI_BAND_EGSM_DCS  Extended 900MHz and 1800MHz
SWI_BAND_PCS  1900MHz
SWI_BAND_PGSM_PCS  900 and 1900 MHz
SWI_BAND_EGSM_PCS  900e and 1900 MHz
SWI_BAND_GSM850  850MHz (not supported)
SWI_BAND_GSM850_PCS  850 and 1900 MHz (not supported)
SWI_BAND_GSM_ALL  All GSM bands
SWI_BAND_WCDMA_EU  EU band: WCDMA 2100
SWI_BAND_WCDMA_NA  NA band: WCDMA 850/1900
SWI_BAND_WCDMA_GSM_NA  NA bands: WDMA 850/1900 & GSM 850/1900
SWI_BAND_WCDMA_GSM_EU  EU bands: WCDMA 2100 & GSM 900/1800
SWI_BAND_WCDMA_ALL  All WCDMA bands
SWI_BAND_WCDMA_AU  Australia bands: WCDMA 2100/850
SWI_BAND_WCDMA_JAP  Japan bands: WCDMA 2100/800
SWI_BAND_WCDMA_GSM_AU  Australia bands: WCDMA 2100/850 GSM 900/1800
SWI_BAND_WCDMA_GSM_AU_2  Australia bands: WCDMA 850 GSM 900/1800
SWI_BAND_WCDMA_GSM_AU_3  Australia bands: WCDMA 850
SWI_BAND_WCDMA_EMEA  EMEA (urope Middle East Africa) band: WCDMA 2100
SWI_BAND_WCDMA_GSM_EU2  EU band: WCDMA 2100/900 & GSM 900/1800
SWI_BAND_WCDMA_EU_2  EU band: WCDMA 900
SWI_BAND_WCDMA_NA2  NA band: WCDMA 1900
SWI_BAND_WCDMA_EU_3  EU band: WCDMA 2100/900
SWI_BAND_AUTO  Auto band selection

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

Enumeration of radio bands.

This enumeration is used by SWI_STRUCT_RadioBandInfo and SWI_STRUCT_GmsCellMeasure.

See also:
SWI_STRUCT_RadioBandInfo

SWI_STRUCT_GsmCellMeasure

Enumerator:
SWI_RADIOBAND_CdmaClass0  CDMA Band Class 0
SWI_RADIOBAND_CdmaClass1  CDMA Band Class 1
SWI_RADIOBAND_CdmaClass2  CDMA Band Class 2
SWI_RADIOBAND_CdmaClass3  CDMA Band Class 3
SWI_RADIOBAND_CdmaClass4  CDMA Band Class 4
SWI_RADIOBAND_CdmaClass5  CDMA Band Class 5
SWI_RADIOBAND_CdmaClass6  CDMA Band Class 6
SWI_RADIOBAND_CdmaClass7  CDMA Band Class 7
SWI_RADIOBAND_CdmaClass8  CDMA Band Class 8
SWI_RADIOBAND_CdmaClass9  CDMA Band Class 9
SWI_RADIOBAND_CdmaClass10  CDMA Band Class 10
SWI_RADIOBAND_CdmaClass11  CDMA Band Class 11
SWI_RADIOBAND_CdmaClass12  CDMA Band Class 12
SWI_RADIOBAND_Gsm450  GSM 450 Band
SWI_RADIOBAND_Gsm480  GSM 480 Band
SWI_RADIOBAND_Gsm750  GSM 750 Band
SWI_RADIOBAND_Gsm850  GSM 850 Band
SWI_RADIOBAND_GsmEGsm900  GSM E-GSM 900 Band
SWI_RADIOBAND_GsmPGsm900  GSM P-GSM 900 Band
SWI_RADIOBAND_GsmRGsm900  GSM R-GSM 900 Band
SWI_RADIOBAND_GsmDcs1800  GSM DCS 1800 Band
SWI_RADIOBAND_GsmPcs1900  GSM DCS 1900 Band
SWI_RADIOBAND_WcdmaIImt2000  WCDMA I IMT 2000
SWI_RADIOBAND_WcdmaIIPcs1900  WCDMA II PCS 1900
SWI_RADIOBAND_WcdmaIIIDcs1800  WCDMA III DCS 1800
SWI_RADIOBAND_WcdmaIV1700  WCDMA IV 1700
SWI_RADIOBAND_WcdmaV850  WCDMA V 850
SWI_RADIOBAND_WcdmaVI800  WCDMA VI 800
SWI_RADIOBAND_WcdmaVII2600  WCDMA VII 2600
SWI_RADIOBAND_WcdmaVIII900  WCDMA VIII 900
SWI_RADIOBAND_WcdmaIX1700  WCDMA IX 1700
SWI_RADIOBAND_Invalid  Invalid band

Enumeration of radio technologies.

See also:
SWI_STRUCT_RadioBandInfo
Enumerator:
SWI_RADIOTYPE_1xrtt  1xRTT
SWI_RADIOTYPE_Evdo  EVDO
SWI_RADIOTYPE_GsmWcdma  GSM/WCDMA

An enumeration of transmit speed types based on number of transmit slots.

See also:
SwiGetTransmitSpeed

SwiSetTransmitSpeed

Enumerator:
SWI_SPPED_1x  One slot
SWI_SPPED_2x  Two slots
SWI_SPPED_3x  Four slots


Function Documentation

SWI_API SWI_RCODE SwiGetBandInfo ( SWI_STRUCT_Band sBandInfo,
U32  timeout 
)

This function is used to fetch the current frequency band and a list of all bands supported by the modem.

With 3G products, the following set of band related objects should be used:

This function is only supported on GSM devices.

Parameters:
[OUT] sBandInfo: Modem band information.
[IN] timeout: 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_RadioBandList

SWI_STRUCT_RadioBandConfig

SwiGetCurrentRadioBand

SwiSetRadioBandCfg

SwiGetRadioBandCfg

SWI_STRUCT_Band

SWI_TYPE_Band

SWI_NOTIFY_Band

SWI_API SWI_RCODE SwiGetCellID ( U32 *  nCellID,
U32  timeout 
)

This function retrieves the identifier of the cell currently being used by the modem.

The Cell ID reported is a numeric value. This information is usually only meaningful to technicians for support purposes. In the future there may be some application of this for locating the device on a map. Use of this function should be limited. There is a notification available in the GPRS API (SWI_NOTIFY_NetworkStatus or SWI_STRUCT_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:
[OUT] nCellID: Current cell ID
[IN] timeout: 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_GsmSystemStatus

SWI_NOTIFY_NetworkStatus

SWI_API SWI_RCODE SwiGetCurrentRadioBand ( SWI_STRUCT_RadioBandList pRadioBand,
U32  timeout 
)

This function is used to determine the current radio band(s) the device is currently using.

This object replaces SwiGetBandInfo.

For GSM/WCDMA devices and CDMA/EVDO devices operating in non-hybrid mode operation, only one band is supported at a time. In these cases, the band info list will only contain a single entry.

Parameters:
[OUT] pRadioBand: Pointer to a SWI_STRUCT_RadioBandList structure to store the list of current radio bands/
[IN] timeout: Response timeout value in milliseconds.
Returns:
See SWI_RCODE for other error return codes.
See also:
SWI_STRUCT_RadioBandList

SWI_API SWI_RCODE SwiGetDeviceTime ( SWI_STRUCT_DeviceTime pDeviceTime,
U32  timeout 
)

This function is used to retrieve the system time on the device.

This call will return an error (SWI_RCODE_REQUEST_REJECTED) if the device has not received a time update from the network.

Parameters:
[OUT] pDeviceTime: Pointer to a SWI_STRUCT_DeviceTime structure to store the system time from the device.
[IN] timeout: Response timeout value in milliseconds.
Returns:
SWI_RCODE_OK: The request has been received.

See SWI_RCODE for other error return codes.

See also:
SWI_STRUCT_DeviceTime

SWI_API SWI_RCODE SwiGetGsmCellInfo ( SWI_STRUCT_GsmCellInfo pCellInfo,
U32  timeout 
)

This function is used to retrieve GSM cell information.

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

This function is only supported on GSM devices.

Parameters:
[OUT] pCellInfo: GSM cell info
[IN] timeout: 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_GsmCellInfo

SWI_NOTIFY_GsmCellInfo

SWI_API SWI_RCODE SwiGetGsmSystemStatus ( SWI_STRUCT_GsmSystemStatus pSysStatus,
U32  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:
[OUT] pSysStatus: System status
[IN] timeout: 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_GsmSystemStatus

SWI_NOTIFY_GsmSystemStatus

SwiGetNetworkStatus

SWI_API SWI_RCODE SwiGetIPAddress ( LPTSTR  szIPAddress,
U32  sizeBuffer,
U32  timeout 
)

This function retrieves the IP address of the current GPRS session from the modem.

This function is only supported on GSM devices.

Parameters:
[OUT] szIPAddress: IP address (NULL terminated)
[IN] sizeBuffer: Size of the buffer provided for the IP address
[IN] timeout: 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:
SwiGetIPAddressEx

SWI_API SWI_RCODE SwiGetIPAddressEx ( SWI_STRUCT_IpAddress pIp,
U32  timeout 
)

This function retrieves the IP address of the specified profile.

This function is only supported on GSM devices.

Parameters:
[OUT] pIp: IP address information. ProfileId of the IP address structure must be specified before calling this function.
[IN] timeout: 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_IpAddress

SwiGetIPAddress

SWI_API SWI_RCODE SwiGetNetworkProviderID ( LPTSTR  szName,
U32  sizeBuffer,
U32  timeout 
)

This function reports the current service provider's identification code.

The provider ID for GPRS is a string provided by the carrier, over the air. The length of the string can be up to 17 characters long. If this function is called while outside of coverage or not in service with a carrier, the function returns a null string and the OK result. Use SwiGetServiceStatusEx to confirm coverage.

Parameters:
[OUT] szName: Network provider name (NULL terminated)
[IN] sizeBuffer: Size of buffer provided for the network provider name
[IN] timeout: Response timeout value in milliseconds
Returns:
See SWI_RCODE for additional information.

SWI_API SWI_RCODE SwiGetNetworkStatus ( SWI_STRUCT_GSM_NetworkStatus sNetworkStatus,
U32  timeout 
)

This function is obsolete and is replaced with SwiGetGsmSystemStatus.

This function is used to fetch the network status of the modem.

SWI_NOTIFY_NetworkStatus indication is generated when there is a state change. This is the preferred method of monitoring status instead of polling with this function.

This function is only supported on GSM devices.

Parameters:
[OUT] sNetworkStatus: Network status
[IN] timeout: 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:
SwiGetGsmSystemStatus

SWI_STRUCT_GSM_NetworkStatus

SWI_NOTIFY_NetworkStatus

SWI_API SWI_RCODE SwiGetPktSessionStatus ( SWI_STRUCT_PktSessionStatus sSessionStatus,
U32  timeout 
)

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

SWI_NOTIFY_PktSessionStatus indication is generated when there is a state change. This is the preferred method of monitoring status instead of polling with this function.

This function is only supported on GSM devices.

Parameters:
[OUT] sSessionStatus: Packet session status
[IN] timeout: 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_PktSessionStatus

SWI_NOTIFY_PktSessionStatus

SWI_API SWI_RCODE SwiGetPktSessionStatusEx ( SWI_STRUCT_PktSessionCall sSessionCall,
U32  timeout 
)

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

This function replaces the old API SwiGetPktSessionStatus()

SWI_NOTIFY_PktSessionStatus indication is generated when there is a state change. This is the preferred method of monitoring status instead of polling with this function.

This function is only supported on GSM devices.

Parameters:
[IN/OUT] sSessionCall: Packet session status containing profileID
[IN] timeout: 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_PktSessionCall

SWI_API SWI_RCODE SwiGetPLMNMode ( SWI_TYPE_PLMN_Mode *  eMode,
U32  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:
[OUT] eMode: PLMN selection mode
[OUT] timeout: 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_TYPE_PLMN_Mode

SwiSetPLMNMode

SWI_API SWI_RCODE SwiGetPLMNSelection ( SWI_STRUCT_PlmnSelection sPlmn,
U32  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:
[OUT] sPlmn: PLMN information
[IN] timeout: 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 SWI_RCODE for other error return codes.

See also:
SWI_NOTIFY_PlmnAvailable

SwiStartPLMNSearch

SWI_STRUCT_PlmnSelection

SWI_API SWI_RCODE SwiGetRadioBandCfg ( SWI_STRUCT_RadioBandConfig pRadioBand,
U32  timeout 
)

This function is used to retrieve the current radio band setting of the device along with the list of all the device supported radio bands.

This object replaces SwiGetBandInfo.

Parameters:
[OUT] pRadioBand: A pointer to a SWI_STRUCT_RadioBandConfig structure to store the current radio band configuration.
[IN] timeout: Response timeout value in milliseconds.
Returns:
See SWI_RCODE for other error return codes.
See also:
SWI_STRUCT_RadioBandConfig

SWI_API SWI_RCODE SwiGetRoamingDisable ( bool *  bDisable,
U32  timeout 
)

This function is no longer supported.

This function is used to fetch the packet roaming disable setting of the modem. If packet roaming is disabled then packet service will be prevented when the modem is not on the home network.

This function is only supported on GSM devices.

Parameters:
[OUT] bDisable: True if packet service is disabled when roaming. False if packet service is never disabled.
[IN] timeout: 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.

/sa Use SwiSetRoamingDisable to change the packet roaming disable setting on the modem.

SWI_API SWI_RCODE SwiGetRoamingState ( SWI_TYPE_RoamingState *  eRoaming,
U32  timeout 
)

This function is used to retrieve the roaming state. The modem is either roaming or on the home network.

If this function is called while the modem is not in coverage, it will report being at home. The modem cannot verify that you are roaming until it can detect coverage and identify the carrier(s). Use of this function should be limited. There is a notification available in the GPRS API (SWI_NOTIFY_NetworkStatus) that reports this data along with other useful service parameters. Use of notifications is preferred over direct polling.

Parameters:
[OUT] eRoaming: Current SWI_TYPE_RoamingState enumeration roaming state.
[IN] timeout: Response timeout value in milliseconds
Returns:
See SWI_RCODE for additional information.
See also:
SWI_TYPE_RoamingState

SWI_API SWI_RCODE SwiGetRscpEcIo ( SWI_STRUCT_RscpEcIo pRscpEcIo,
U32  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:
[OUT] pRscpEcIo: RSCP and Ec/Io measurements.
[IN] timeout: 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 I32  iRssi,
U32 *  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:
[IN] iRssi: RSSI value in dBm to be converted to number of RSSI bars.
[OUT] pNumBars: 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 SWI_RCODE for other error return codes.

See also:
To get the RSSI value in dBm, call SwiGetRssiBer.

SWI_API SWI_RCODE SwiGetRssiBer ( SWI_STRUCT_Rssi sRssiBer,
U32  timeout 
)

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:
[OUT] sRssiBer: RSSI and BER values
[IN] timeout: 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_Rssi

SWI_NOTIFY_Rssi

SWI_API SWI_RCODE SwiGetServiceStatusEx ( SWI_TYPE_ServiceStatus *  eServiceStatus,
U32  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:
[OUT] eServiceStatus: Service status
[IN] timeout: 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_TYPE_ServiceStatus

SWI_STRUCT_GsmSystemStatus

SWI_NOTIFY_NetworkStatus

SWI_API SWI_RCODE SwiGetTcpOpt ( SWI_STRUCT_TcpOpt sTcpOpt  ) 

This function is called to retrieve the Window's TCP stack optimization values.

Parameters:
[OUT] sTcpOpt: Structure to store TCP optimization settings
Returns:
See SWI_RCODE for additional information.
See also:
SWI_STRUCT_TcpOpt

SWI_API SWI_RCODE SwiGetTrafficStatistics ( U32 *  nSent,
U32 *  nReceived,
U32  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:
[OUT] nSent: Number of bytes sent
[OUT] nReceived: Number of bytes received
[IN] timeout: Response timeout value in milliseconds
Returns:
See SWI_RCODE for additional information.

SWI_API SWI_RCODE SwiGetTransmitSpeed ( SWI_TYPE_TransmitSpeed TransmitSpeed,
U32  timeout 
)

This function is used to fetch the transmit speed from the modem. The transmit speed is determined by the number of time slots used for GPRS transmit traffic. The greater the number of slots the higher the maximum transmit speed.

This function is only supported on GSM devices.

Parameters:
[OUT] TransmitSpeed: Current number to transmit slots
[IN] timeout: 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_TYPE_TransmitSpeed

SwiSetTransmitSpeed

SWI_API SWI_RCODE SwiOptimizeTcp ( SWI_STRUCT_TcpOpt  sTcpOpt  ) 

This function is called to optimize Window's TCP stack to improve wireless transfer performance with the modem.

This request modifies Window's registry values.

Parameters:
[IN] sTcpOpt: SWI_STRUCT_TcpOpt structure containing TCP optimizations
Returns:
See SWI_RCODE for additional information.
See also:
SWI_STRUCT_TcpOpt

SWI_API SWI_RCODE SwiResetTrafficStatistics ( U32  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:
[IN] timeout: Response timeout value in milliseconds.
Returns:
SWI_RCODE_OK: The request has been processed.

See SWI_RCODE for other error return codes.

Notes: None

SWI_API SWI_RCODE SwiSetBandInfo ( const SWI_STRUCT_SetBand pBandInfo,
U32  timeout 
)

This function is used to set the current frequency band.

With 3G products, the following set of band related objects should be used:

Setting the frequency band may cause a modem reset. The caller should use SwiGetBandInfo to retrieve the list of supported bands before calling SwiSetBandInfo.

This function is only supported on GSM devices.

Parameters:
[IN] sBandInfo: New frequency band
[IN] timeout: Response timeout value in milliseconds
Returns:
SWI_RCODE_OK: The request has been processed.

See SWI_RCODE for other error return codes.

See also:
SWI_STRUCT_RadioBandList

SWI_STRUCT_RadioBandConfig

SwiGetCurrentRadioBand

SwiSetRadioBandCfg

SwiGetRadioBandCfg

SWI_STRUCT_SetBand

SWI_TYPE_Band

SWI_NOTIFY_Band

SWI_NOTIFY_BandWrite

SWI_API SWI_RCODE SwiSetPLMNMode ( const SWI_STRUCT_PlmnSelection  sPlmn,
U32  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:
[IN] sPlmn: PLMN selection mode information
[IN] timeout: 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_PlmnSelection

SwiGetPLMNMode

SwiStartPLMNSearch

SWI_API SWI_RCODE SwiSetRadioBandCfg ( const U64  nRadioBandGroup,
U32  timeout 
)

This function is used to request a new radio band setting.

This object replaces SwiSetBandInfo.

Setting the frequency band may cause a modem reset. The caller should use SwiGetRadioBandCfg to retrieve the list of supported bands before calling SwiSetRadioBandCfg.

Parameters:
[IN] nRadioBandGroup: A bit mask value which specifies the radio band group to use. See SWI_RADIOBANDGROUP_xxx definitions.
[IN] timeout: Response timeout value in milliseconds.
Returns:
See SWI_RCODE for other error return codes.
See also:
SWI_RADIOBANDGROUP_xxx

SWI_API SWI_RCODE SwiSetRoamingDisable ( const bool  bDisable,
U32  timeout 
)

This function is no longer supported.

This function is used to set the packet roaming disable setting on the modem. If packet roaming is disabled then packet service will be prevented when the modem is not on the home network.

This function is only supported on GSM devices.

Parameters:
[IN] bDisable: Set to true to disable packet roaming. Set to false to never disable packet roaming.
[IN] timeout: Response timeout value in milliseconds.
Returns:
SWI_RCODE_OK: The request has been processed.

See SWI_RCODE for other error return codes.

See also:
SwiGetRoamingDisable

SWI_API SWI_RCODE SwiSetTransmitSpeed ( const SWI_TYPE_TransmitSpeed  TransmitSpeed,
U32  timeout 
)

This function is used to set the transmit speed on the modem. The transmit speed is determined by the number of time slots used for GPRS transmit traffic. The greater the number of slots the higher the maximum transmit speed.

Note that only requests the maximum number of slots the modem will use. However, the network may allocate fewer.

This function is only supported on GSM devices.

Parameters:
[OUT] TransmitSpeed: Number to transmit slots
[IN] timeout: Response timeout value in milliseconds
Returns:
SWI_RCODE_OK: The request has been processed.

See SWI_RCODE for other error return codes.

See also:
SWI_TYPE_TransmitSpeed

SwiGetTransmitSpeed

SWI_API SWI_RCODE SwiStartPLMNSearch ( U32  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:
[IN] timeout: 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 SWI_RCODE for other error return codes.

See also:
SWI_NOTIFY_PlmnAvailable

SWI_NOTIFY_PlmnReady

SwiGetPLMNSelection

SwiSetPLMNMode

SwiGetPLMNMode


Generated on Fri Oct 2 10:27:30 2009 for 3G SDK by  doxygen 1.5.9