#define SWI_RADIOBANDGROUP_AutoBand 0xFFFFFFFFFFFFFFFFui64 |
#define SWI_RADIOBANDGROUP_CdmaClass0A 0x0000000000000001ui64 |
Band Class 0 A-system only (Cellular)
This radio band group is to be used with SWI_STRUCT_RadioBandConfig.
#define SWI_RADIOBANDGROUP_CdmaClass0B 0x0000000000000002ui64 |
Band Class 0 B-system only (Cellular)
This radio band group is to be used with SWI_STRUCT_RadioBandConfig.
#define SWI_RADIOBANDGROUP_CdmaClass1 0x0000000000000004ui64 |
#define SWI_RADIOBANDGROUP_CdmaClass10 0x0000000000000800ui64 |
Band Class 10 (Secondary 800 MHz)
This radio band group is to be used with SWI_STRUCT_RadioBandConfig.
#define SWI_RADIOBANDGROUP_CdmaClass11 0x0000000000001000ui64 |
Band Class 11 (400 MHz European PAMR)
This radio band group is to be used with SWI_STRUCT_RadioBandConfig.
#define SWI_RADIOBANDGROUP_CdmaClass12 0x0000000000002000ui64 |
#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_Gsm450 0x0000000000010000ui64 |
#define SWI_RADIOBANDGROUP_Gsm480 0x0000000000020000ui64 |
#define SWI_RADIOBANDGROUP_Gsm750 0x0000000000040000ui64 |
#define SWI_RADIOBANDGROUP_Gsm850 0x0000000000080000ui64 |
#define SWI_RADIOBANDGROUP_GsmDcs1800 0x0000000000400000ui64 |
#define SWI_RADIOBANDGROUP_GsmEGsm900 0x0000000000800000ui64 |
#define SWI_RADIOBANDGROUP_GsmPcs1900 0x0000000000200000ui64 |
#define SWI_RADIOBANDGROUP_GsmPGsm900 0x0000000001000000ui64 |
#define SWI_RADIOBANDGROUP_GsmRGsm900 0x0000000000100000ui64 |
#define SWI_RADIOBANDGROUP_WcdmaIII1700 0x0000000400000000ui64 |
#define SWI_RADIOBANDGROUP_WcdmaIImt2000 0x0000000100000000ui64 |
#define SWI_RADIOBANDGROUP_WcdmaIIPcs1900 0x0000000200000000ui64 |
#define SWI_RADIOBANDGROUP_WcdmaIV1700 0x0000000800000000ui64 |
#define SWI_RADIOBANDGROUP_WcdmaIX1700 0x0000010000000000ui64 |
#define SWI_RADIOBANDGROUP_WcdmaV850 0x0000001000000000ui64 |
#define SWI_RADIOBANDGROUP_WcdmaVI800 0x0000002000000000ui64 |
#define SWI_RADIOBANDGROUP_WcdmaVII2600 0x0000004000000000ui64 |
#define SWI_RADIOBANDGROUP_WcdmaVIII900 0x0000008000000000ui64 |
enum SWI_TYPE_Band |
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.
An enumeration of currently selected network selection modes.
enum SWI_TYPE_RadioBand |
Enumeration of radio bands.
This enumeration is used by SWI_STRUCT_RadioBandInfo and SWI_STRUCT_GmsCellMeasure.
enum SWI_TYPE_RadioType |
An enumeration of transmit speed types based on number of transmit slots.
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.
[OUT] | sBandInfo: Modem band information. | |
[IN] | timeout: Response timeout value in milliseconds |
See SWI_RCODE for other error return codes.
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.
[OUT] | nCellID: Current cell ID | |
[IN] | timeout: Response timeout value in milliseconds. |
See SWI_RCODE for other error return codes.
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.
[OUT] | pRadioBand: Pointer to a SWI_STRUCT_RadioBandList structure to store the list of current radio bands/ | |
[IN] | timeout: Response timeout value in milliseconds. |
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.
[OUT] | pDeviceTime: Pointer to a SWI_STRUCT_DeviceTime structure to store the system time from the device. | |
[IN] | timeout: Response timeout value in milliseconds. |
See SWI_RCODE for other error return codes.
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.
[OUT] | pCellInfo: GSM cell info | |
[IN] | timeout: Response timeout value in milliseconds |
See SWI_RCODE for other error return codes.
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.
[OUT] | pSysStatus: System status | |
[IN] | timeout: Response timeout value in milliseconds. |
See SWI_RCODE for other error return codes.
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.
[OUT] | szIPAddress: IP address (NULL terminated) | |
[IN] | sizeBuffer: Size of the buffer provided for the IP address | |
[IN] | timeout: Response timeout value in milliseconds |
See SWI_RCODE for other error return codes.
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.
[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. |
See SWI_RCODE for other error return codes.
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.
[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 |
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.
[OUT] | sNetworkStatus: Network status | |
[IN] | timeout: Response timeout value in milliseconds. |
See SWI_RCODE for other error return codes.
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.
[OUT] | sSessionStatus: Packet session status | |
[IN] | timeout: Response timeout value in milliseconds |
See SWI_RCODE for other error return codes.
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.
[IN/OUT] | sSessionCall: Packet session status containing profileID | |
[IN] | timeout: Response timeout value in milliseconds |
See SWI_RCODE for other error return codes.
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.
[OUT] | eMode: PLMN selection mode | |
[OUT] | timeout: Response timeout value in milliseconds |
See SWI_RCODE for other error return codes.
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.
[OUT] | sPlmn: PLMN information | |
[IN] | timeout: Response timeout value in milliseconds |
See SWI_RCODE for other error return codes.
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.
[OUT] | pRadioBand: A pointer to a SWI_STRUCT_RadioBandConfig structure to store the current radio band configuration. | |
[IN] | timeout: Response timeout value in milliseconds. |
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.
[OUT] | bDisable: True if packet service is disabled when roaming. False if packet service is never disabled. | |
[IN] | timeout: Response timeout value in milliseconds. |
See SWI_RCODE for other error return codes.
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.
[OUT] | eRoaming: Current SWI_TYPE_RoamingState enumeration roaming state. | |
[IN] | timeout: Response timeout value in milliseconds |
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.
[OUT] | pRscpEcIo: RSCP and Ec/Io measurements. | |
[IN] | timeout: Response timeout value in milliseconds |
See SWI_RCODE for other error return codes.
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.
[IN] | iRssi: RSSI value in dBm to be converted to number of RSSI bars. | |
[OUT] | pNumBars: Number of RSSI bars to be displayed. |
SWI_RCODE_INVALID_PAR: Invalid RRSI value was supplied.
See SWI_RCODE for other error return codes.
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.
[OUT] | sRssiBer: RSSI and BER values | |
[IN] | timeout: Response timeout value in milliseconds. |
See SWI_RCODE for other error return codes.
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.
[OUT] | eServiceStatus: Service status | |
[IN] | timeout: Response timeout value in milliseconds. |
See SWI_RCODE for other error return codes.
SWI_API SWI_RCODE SwiGetTcpOpt | ( | SWI_STRUCT_TcpOpt & | sTcpOpt | ) |
This function is called to retrieve the Window's TCP stack optimization values.
[OUT] | sTcpOpt: Structure to store TCP optimization settings |
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.
[OUT] | nSent: Number of bytes sent | |
[OUT] | nReceived: Number of bytes received | |
[IN] | timeout: Response timeout value in milliseconds |
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.
[OUT] | TransmitSpeed: Current number to transmit slots | |
[IN] | timeout: Response timeout value in milliseconds |
See SWI_RCODE for other error return codes.
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.
[IN] | sTcpOpt: SWI_STRUCT_TcpOpt structure containing TCP optimizations |
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.
[IN] | timeout: Response timeout value in milliseconds. |
See SWI_RCODE for other error return codes.
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.
[IN] | sBandInfo: New frequency band | |
[IN] | timeout: Response timeout value in milliseconds |
See SWI_RCODE for other error return codes.
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.
[IN] | sPlmn: PLMN selection mode information | |
[IN] | timeout: Response timeout value in milliseconds |
See SWI_RCODE for other error return codes.
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.
[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. |
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.
[IN] | bDisable: Set to true to disable packet roaming. Set to false to never disable packet roaming. | |
[IN] | timeout: Response timeout value in milliseconds. |
See SWI_RCODE for other error return codes.
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.
[OUT] | TransmitSpeed: Number to transmit slots | |
[IN] | timeout: Response timeout value in milliseconds |
See SWI_RCODE for other error return codes.
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.
[IN] | timeout: Response timeout value in milliseconds |
See SWI_RCODE for other error return codes.