|
LinuxSDK
V1.4.0.5
|
SWI CDMA specific network related APIs. More...
Go to the source code of this file.
Data Structures | |
| struct | SWI_STRUCT_CallNotificationStatus |
| struct | SWI_STRUCT_ChannelNumber |
| struct | SWI_STRUCT_ChannelState |
| struct | SWI_STRUCT_TechBandClass |
| struct | SWI_STRUCT_ServiceIndication |
| struct | SWI_STRUCT_Prev |
| struct | SWI_STRUCT_RoamingStatus |
| struct | SWI_STRUCT_CallByteCounter |
| struct | SWI_STRUCT_CallConnecting |
| struct | SWI_STRUCT_CallConnected |
| struct | SWI_STRUCT_CallIncoming |
| struct | SWI_STRUCT_CallCallerID |
| struct | SWI_STRUCT_CallExtendedCallerID |
| struct | SWI_STRUCT_CallDisconnected |
| struct | SWI_STRUCT_CallError |
| struct | SWI_STRUCT_CallDormant |
| struct | SWI_STRUCT_OTASPState |
| struct | SWI_STRUCT_CallPrivacy |
| struct | SWI_STRUCT_SidNid |
| struct | SWI_STRUCT_HomeSidNid |
| struct | SWI_STRUCT_TechActiveSetSingle |
| struct | SWI_STRUCT_TechActiveSet |
| struct | SWI_STRUCT_MipEnabled |
| struct | SWI_STRUCT_Rssi_Ecio |
| struct | SWI_STRUCT_Hdr_Roam_Status |
| struct | SWI_STRUCT_Hdr_Srv_State |
| struct | SWI_STRUCT_Hdr_Hybr_Pref |
Macros | |
| #define | SWI_SIDNIDNUM 20 |
| #define | SWI_MAX_ActiveSet 6 /* Same as MAX_ActiveSet */ |
SWI CDMA specific network related APIs.
Copyright (c) 2011 Sierra Wireless, Inc. All rights reserved
| #define SWI_MAX_ActiveSet 6 /* Same as MAX_ActiveSet */ |
| #define SWI_SIDNIDNUM 20 |
| typedef enum cm_mode_pref_e cm_mode_pref_e_type |
An enumeration of modem pref.
For compatibility with QXDM database, please do not change the following fix assigned values. If new values are added please also update the QXDM database.
| typedef struct SWI_STRUCT_CallByteCounter SWI_STRUCT_CallByteCounter |
Contains byte Counter notification data structure.
This data structure is used as a member of the notification SWI_NOTIFY_CallByteCounter. Refer to the description of SWI_NOTIFY_CallByteCounter for more detail.
The counters measure traffic over the local (host/modem) interface. The counter resets when the call is disconnected.
| typedef struct SWI_STRUCT_CallCallerID SWI_STRUCT_CallCallerID |
Contains Caller ID notification data structure.
This data structure is used as a member of the notification SWI_NOTIFY_CallCallerID. Refer to the description of SWI_NOTIFY_CallCallerID for more detail.
The Caller ID string is provided by the network.
| typedef struct SWI_STRUCT_CallConnected SWI_STRUCT_CallConnected |
Contains call connected notification data structure.
This data structure is used as a member of the notification SWI_NOTIFY_CallConnected. Refer to the description of SWI_NOTIFY_CallConnected for more detail.
| typedef struct SWI_STRUCT_CallConnecting SWI_STRUCT_CallConnecting |
Contains call connecting notification data structure.
This data structure is used as a member of the notification SWI_NOTIFY_CallConnecting. Refer to the description of SWI_NOTIFY_CallConnecting for more detail.
| typedef struct SWI_STRUCT_CallDisconnected SWI_STRUCT_CallDisconnected |
Contains call disconnected notification data structure.
This data structure is used as a member of the notification SWI_NOTIFY_CallDisconnected. Refer to the description of SWI_NOTIFY_CallDisconnected for more detail.
| typedef struct SWI_STRUCT_CallDormant SWI_STRUCT_CallDormant |
Contains dormant state notification data structure.
This data structure is used as a member of the notification SWI_NOTIFY_CallDormant. Refer to the description of SWI_NOTIFY_CallDormant for more detail.
| typedef struct SWI_STRUCT_CallError SWI_STRUCT_CallError |
Contains call error notification data structure.
This data structure is used as a member of the notification SWI_NOTIFY_CallError. Refer to the description of SWI_NOTIFY_CallError for more detail.
| typedef struct SWI_STRUCT_CallExtendedCallerID SWI_STRUCT_CallExtendedCallerID |
Contains Caller ID notification data structure.
This data structure is used as a member of the notification SWI_NOTIFY_CallCallerID. Refer to the description of SWI_NOTIFY_CallCallerID for more detail.
The Extended Caller ID string is provided by the network.
| typedef struct SWI_STRUCT_CallIncoming SWI_STRUCT_CallIncoming |
Contains call incoming notification data structure.
This data structure is used as a member of the notification SWI_NOTIFY_CallIncoming. Refer to the description of SWI_NOTIFY_CallIncoming for more detail.
Contains call notification status data structure.
| typedef struct SWI_STRUCT_CallPrivacy SWI_STRUCT_CallPrivacy |
Contains OTASP state notification data structure.
This data structure is used as a member of the notification SWI_NOTIFY_CallPrivacy. Refer to the description of SWI_NOTIFY_CallPrivacy for more detail.
| typedef struct SWI_STRUCT_ChannelNumber SWI_STRUCT_ChannelNumber |
Contains Channel # notification data structure.
This data structure is used as a member of the notification SWI_NOTIFY_ChannelNumber. Refer to the description of SWI_NOTIFY_ChannelNumber for more detail.
| typedef struct SWI_STRUCT_ChannelState SWI_STRUCT_ChannelState |
Contains Channel State notification data structure.
This data structure is used as a member of the notification SWI_NOTIFY_ChannelState. Refer to the description of SWI_NOTIFY_ChannelState for more detail.
| typedef struct SWI_STRUCT_Hdr_Hybr_Pref SWI_STRUCT_Hdr_Hybr_Pref |
Contains EVDO/HDR Hybrid pref mode data structure.
| typedef struct SWI_STRUCT_Hdr_Roam_Status SWI_STRUCT_Hdr_Roam_Status |
Contains EVDO/HDR roaming state data structure.
| typedef struct SWI_STRUCT_Hdr_Srv_State SWI_STRUCT_Hdr_Srv_State |
Contains EVDO/HDR roaming state data structure.
| typedef struct SWI_STRUCT_HomeSidNid SWI_STRUCT_HomeSidNid |
Contains SID/NID pairs data.
This structure is used to report (SwiPstGetHomeSidNid) or set (SwiPstSetHomeSidNid) the home (non-roaming) SID / NID table for an account profile.
| typedef struct SWI_STRUCT_MipEnabled SWI_STRUCT_MipEnabled |
Contains MIP enabling data structure.
| typedef struct SWI_STRUCT_OTASPState SWI_STRUCT_OTASPState |
Contains OTASP state notification data structure.
This data structure is used as a member of the notification SWI_NOTIFY_OTASPState. Refer to the description of SWI_NOTIFY_OTASPState for more detail.
| typedef struct SWI_STRUCT_Prev SWI_STRUCT_Prev |
Contains Protocol Revision notification data structure.
This data structure is used as a member of the notification SWI_NOTIFY_Prev. Refer to the description of SWI_NOTIFY_Prev for more detail.
| typedef struct SWI_STRUCT_RoamingStatus SWI_STRUCT_RoamingStatus |
Contains roaming state notification data structure.
This data structure is used as a member of the notification SWI_NOTIFY_RoamingStatus. Refer to the description of SWI_NOTIFY_RoamingStatus for more detail.
| typedef struct SWI_STRUCT_Rssi_Ecio SWI_STRUCT_Rssi_Ecio |
Contains RSSI and EcIo data structure.
This data structure is used to hold RSSI and EcIo data.
| typedef struct SWI_STRUCT_ServiceIndication SWI_STRUCT_ServiceIndication |
Contains service indication notification data structure.
This data structure is used as a member of the notification SWI_NOTIFY_ServiceIndication. Refer to the description of SWI_NOTIFY_ServiceIndication for more detail.
| typedef struct SWI_STRUCT_SidNid SWI_STRUCT_SidNid |
Contains SID/NID pair data.
This structure is used as a member of SWI_STRUCT_HomeSidNid.
| typedef struct SWI_STRUCT_TechActiveSet SWI_STRUCT_TechActiveSet |
Contains whole active set data structure.
| typedef struct SWI_STRUCT_TechActiveSetSingle SWI_STRUCT_TechActiveSetSingle |
Contains one active set data structure.
| typedef struct SWI_STRUCT_TechBandClass SWI_STRUCT_TechBandClass |
Contains Bandclass notification data structure.
This data structure is used as a member of the notification SWI_NOTIFY_TechBandClass. Refer to the description of SWI_NOTIFY_TechBandClass for more detail.
| typedef enum SWI_TYPE_AnswerState SWI_TYPE_AnswerState |
An enumeration of answer State.
The modes of operation the modem uses to determine how to answer the next incoming voice call.
| typedef enum SWI_TYPE_Band_Pref SWI_TYPE_Band_Pref |
An enumeration of band preferences.
| typedef enum SWI_TYPE_CallCmd SWI_TYPE_CallCmd |
An enumeration of call command.
This enumerates the call commands provided by the notification SWI_NOTIFY_CallError.
| typedef enum SWI_TYPE_CallSource SWI_TYPE_CallSource |
An enumeration of Call Source (AT Cmds or API) enumeration.
This enumerates the call source options which identify if a call was connected using AT commands or using the CnS protocol (used by the API).
| typedef enum SWI_TYPE_CDMA_CallError SWI_TYPE_CDMA_CallError |
An enumeration of call error.
This enumerates the call errors provided by the notification SWI_NOTIFY_CallError.
| typedef enum SWI_TYPE_CDMA_CallState SWI_TYPE_CDMA_CallState |
An enumeration of call state.
This enumeration type identifies the elements of a bit-mapped call state. More than one bit can be
| typedef enum SWI_TYPE_CDMA_CallType SWI_TYPE_CDMA_CallType |
An enumeration of call type.
| typedef enum SWI_TYPE_CdmaRoamingState SWI_TYPE_CdmaRoamingState |
An enumeration of roaming state.
This type definition covers the possible return values of the function SwiGetRoamingState, and the SWI_NOTIFY_NetworkStatus notification.
| typedef enum SWI_TYPE_ChannelState SWI_TYPE_ChannelState |
An enumeration of channel state.
| typedef enum SWI_TYPE_EndReason SWI_TYPE_EndReason |
An enumeration of reason for call termination.
| typedef enum SWI_TYPE_FlashContext SWI_TYPE_FlashContext |
An enumeration of flash Context.
Values for use with the SwiSetCallFlashCmd function.
| typedef enum SWI_TYPE_Hdr_Hybr_Pref SWI_TYPE_Hdr_Hybr_Pref |
An enumeration of EVDO/HDR Hybrid pref.
| typedef enum SWI_TYPE_Hdr_Roam_Status SWI_TYPE_Hdr_Roam_Status |
An enumeration of EVDO/HDR roaming state.
This type definition covers the possible return values of the function SwiGetHdrRoamStatus, and the SWI_NOTIFY_Hdr_Roam_Status notification.
Values above 2 are carrier dependent.
| typedef enum SWI_TYPE_Hdr_Srv_State SWI_TYPE_Hdr_Srv_State |
An enumeration of EVDO/HDR service state.
| typedef enum SWI_TYPE_Mode_Term SWI_TYPE_Mode_Term |
An enumeration of mode terms.
Mode terms that are assigned automatically by call manager when mode is forced on the fly during a call origination.
CM unforce the mode back to it original settings at end of call or some short time after end of call.
NOTE! These mode term should NOT be used by clients when changing the mode preference.
| typedef enum SWI_TYPE_NvPrefOpMode SWI_TYPE_NvPrefOpMode |
An enumeration of NV pref op mode.
| typedef enum SWI_TYPE_NvSystemPref SWI_TYPE_NvSystemPref |
An enumeration of system preference.
| typedef enum SWI_TYPE_OTASPState SWI_TYPE_OTASPState |
An enumeration of OTASP state.
This enumeration type identifies the available OTASP progress states.
A successful OTASP session assumes no failures for any states, and a successful commit.
| typedef enum SWI_TYPE_PrevValue SWI_TYPE_PrevValue |
An enumeration of Protocol Revision.
This enumerates the protocol revision supported by the serving base station.
Values of 6 or 7 (Cdma2000) indicate 1xRTT coverage is availble. Value 1 (Jstd008) is not supported.
| typedef enum SWI_TYPE_Privacy SWI_TYPE_Privacy |
An enumeration of privacy state.
The data enumerates as privacy either on or off
| typedef enum SWI_TYPE_Roam_Pref SWI_TYPE_Roam_Pref |
An enumeration of system selection roam preferences.
| typedef enum SWI_TYPE_ServiceIndication SWI_TYPE_ServiceIndication |
An enumeration of service indication.
This enumeration contains the service indication states. These do not include EVDO/HDR service states. See SWI_TYPE_Hdr_Srv_State.
| typedef enum SWI_TYPE_TechBandClass SWI_TYPE_TechBandClass |
An enumeration of bandclass.
| typedef enum SWI_TYPE_TechPowersaveMode SWI_TYPE_TechPowersaveMode |
An enumeration of power save mode.
| enum cm_mode_pref_e |
An enumeration of modem pref.
For compatibility with QXDM database, please do not change the following fix assigned values. If new values are added please also update the QXDM database.
| enum SWI_TYPE_AnswerState |
An enumeration of answer State.
The modes of operation the modem uses to determine how to answer the next incoming voice call.
| enum SWI_TYPE_Band_Pref |
An enumeration of band preferences.
| enum SWI_TYPE_CallCmd |
An enumeration of call command.
This enumerates the call commands provided by the notification SWI_NOTIFY_CallError.
| enum SWI_TYPE_CallSource |
An enumeration of call error.
This enumerates the call errors provided by the notification SWI_NOTIFY_CallError.
An enumeration of call state.
This enumeration type identifies the elements of a bit-mapped call state. More than one bit can be
An enumeration of call type.
An enumeration of roaming state.
This type definition covers the possible return values of the function SwiGetRoamingState, and the SWI_NOTIFY_NetworkStatus notification.
| Enumerator | |
|---|---|
| SWI_CDMAROAMING_Home |
Not Roaming |
| SWI_CDMAROAMING_Roaming |
Roaming |
| SWI_CDMAROAMING_NonPref |
Not support |
| SWI_CDMAROAMING_None |
Not support |
| enum SWI_TYPE_EndReason |
An enumeration of reason for call termination.
An enumeration of flash Context.
Values for use with the SwiSetCallFlashCmd function.
An enumeration of EVDO/HDR roaming state.
This type definition covers the possible return values of the function SwiGetHdrRoamStatus, and the SWI_NOTIFY_Hdr_Roam_Status notification.
Values above 2 are carrier dependent.
| enum SWI_TYPE_Mode_Term |
An enumeration of mode terms.
Mode terms that are assigned automatically by call manager when mode is forced on the fly during a call origination.
CM unforce the mode back to it original settings at end of call or some short time after end of call.
NOTE! These mode term should NOT be used by clients when changing the mode preference.
An enumeration of NV pref op mode.
| enum SWI_TYPE_OTASPState |
An enumeration of OTASP state.
This enumeration type identifies the available OTASP progress states.
A successful OTASP session assumes no failures for any states, and a successful commit.
| enum SWI_TYPE_PrevValue |
An enumeration of Protocol Revision.
This enumerates the protocol revision supported by the serving base station.
Values of 6 or 7 (Cdma2000) indicate 1xRTT coverage is availble. Value 1 (Jstd008) is not supported.
| enum SWI_TYPE_Privacy |
| enum SWI_TYPE_Roam_Pref |
An enumeration of system selection roam preferences.
| SWI_API SWI_RCODE SwiEVDOGetRssi | ( | swi_int32 * | lRssi, |
| swi_uint32 | timeout | ||
| ) |
This function gets the current EVDO RSSI.
| lRssi[OUT] | RSSI value returned from modem. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiGetAutoconnect | ( | swi_uint16 * | pnEnable, |
| swi_uint32 | timeout | ||
| ) |
This function gets auto connect flag (for data call) set in modem.
| pnEnable[OUT] | value 1 = enable ; 0 to disable. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiGetByteCounter | ( | swi_uint32 * | pSent, |
| swi_uint32 * | pReceived, | ||
| swi_uint32 | timeout | ||
| ) |
This function returns the number of bytes trans-mitted and received in the current call
Counters contain the total bytes sent and received over the local (host/modem) interface. The counter resets when the call is disconnected.
A notification equivalent is available (SWI_NOTIFY_CallByteCounter) and is the preferred mechanism for tracking this data.
| pSent[OUT] | The number of bytes tranmitted. |
| pReceived[OUT] | The number of bytes received. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiGetCallConnectionState | ( | swi_uint16 * | CallState, |
| swi_uint32 | timeout | ||
| ) |
This function reports the state of the modem’s current connections.
Consult the data type for SWI_TYPE_CDMA_CallState for additional information on the meaning of the returned bit mask.
There is a family of notifications used to indicate any changes in call states.
| CallState[OUT] | The destination in which the current call states are returned as a single bit-mapped value. See SWI_TYPE_CDMA_CallState. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiGetCallConnectionStateEx | ( | SWI_STRUCT_CallConnected * | CallState, |
| swi_uint32 | timeout | ||
| ) |
This function reports the state of the modem’s current connections.
Consult the data type for SWI_TYPE_CallState for additional information on the meaning of the returned bit mask.
| CallState[OUT] | The destination in which the current call states are returned as a single bit-mapped value and the SO value of the call. This SO value is ONLY meaningfull when the current call is ACTIVE (CONNECTED). |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiGetCallDuration | ( | swi_uint32 * | pCallDuration, |
| swi_uint32 | timeout | ||
| ) |
This function reports the elapsed time of the current call.
Applicable to both data and voice calls.
| pCallDuration[IN] | Duration of current call in seconds. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiGetCallPrivacy | ( | swi_uint16 * | privacyMode, |
| swi_uint32 | timeout | ||
| ) |
This function returns the modem's call privacy state.
| privacyMode[OUT] | The destination in which the call privacy state is returned: 0 = Call Privacy off 1 = Call Privacy on |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiGetChannelNumber | ( | swi_uint32 * | nChannelNumber, |
| swi_uint32 | timeout | ||
| ) |
This function returns the current channel number.
| nChannelNumber[OUT] | channel number. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiGetCurrentBaseStation | ( | swi_uint16 * | P_PRV, |
| swi_uint32 | timeout | ||
| ) |
This function retrieves the protocol revision (service type) of the base station currently serving the modem.
This command is used to determine if making 1xRTT calls is possible.
Protocol revision 1 is not supported.
| P_PRV[OUT] | The destination in which the base station protocol revision is returned: 1 = JSTD-008 (PCS Japan) 2 = IS-95 3 = IS-95A (Cellular) 4 = IS-95B minimum req. 5 = IS-95B full requirements 6 = CDMA2000 Revision 0 7 = CDMA2000 Revision 1 Values of 6 or above indicate 1xRTT coverage. Values below 6 indicate IS-95 coverage. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiGetHdrHybrPref | ( | swi_uint16 * | iHdrHybrPref, |
| swi_uint32 | timeout | ||
| ) |
This function gets the HDR Hybrid Pref setting.
| iHdrHybrPref[OUT] | HDR Hybrid Pref setting. See SWI_TYPE_Hdr_Hybr_Pref. 0 = OFF; 1 = ON |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiGetHdrNotificationStatus | ( | swi_uint16 * | iHdrNotificationStatus, |
| swi_uint32 | timeout | ||
| ) |
This function gets a mask of which HDR notifications are enabled.
| iHdrNotificationStatus[OUT] | Notification Mask. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiGetHdrRoamStatus | ( | swi_uint16 * | iHdrRoamStatus, |
| swi_uint32 | timeout | ||
| ) |
This function gets the current roaming status for HDR service.
| iHdrRoamStatus[OUT] | HDR roam status. See SWI_TYPE_Hdr_Roam_Status. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiGetHdrSrvState | ( | swi_uint16 * | iHdrSrvState, |
| swi_uint32 | timeout | ||
| ) |
This function gets the HDR service state.
| iHdrSrvState[OUT] | HDR service state. See SWI_TYPE_Hdr_Srv_State. 0 = No Service; 2 = HDR Service |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiGetMipErrCode | ( | swi_uint16 * | nErrCode, |
| swi_uint32 | timeout | ||
| ) |
This function returns the last Mobile IP registration error received from the network.
| nErrCode[OUT] | The destination in which the error code is returned. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiGetMipErrCodeEx | ( | swi_uint16 * | nErrCode1, |
| swi_uint16 * | nErrCode2, | ||
| swi_uint32 | timeout | ||
| ) |
This function returns the last Mobile IP registration error received from the network.
This function extends SwiGetMipErrCode by adding support for carrier-defined errors (nErrCode2).
The standard error code definitions can be found in the following public references: Mobile IP RFC2002.
The classification of the error codes used by Watcher are as follows:
- No Error: 0, 1, 0xffff
- Registration failure: 67
- Sign-in failure: 131, 133
- Session request too long: 69
- Home Agent failure: 80, 81, 82, 88
- Unknown Error: 64, 65, 128, 129
- Unrecognizable Home Agent Addresses: 136
- Network Error: 66, 68, 97-101, 130, 132, 140, 141
- System Error: 70-76, 79, 96, 104-106, 134, 135, 137-139
- Cannot prepare data services: 1012
- Suspension of Account: 801
- Carrier Specific: 89
Carrier specific error codes (valid when nErrCode = 89) include the following:
Verizon:
1 - General Failure
2 - Authentication Failure
3 - Invalid Service Failure
4 - Invalid Public Key Failure
| nErrCode1[OUT] | The destination in which the error code is returned. |
| nErrCode2[OUT] | Carrier specific error code. Valid only when nErrCode = 89. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiGetMobileDirNum | ( | swi_uint16 | Nam, |
| swi_charp | MDN, | ||
| swi_uint32 | length, | ||
| swi_uint32 | timeout | ||
| ) |
This function returns the MDN (Mobile Directory Number) of the specified NAM account profile.
The MDN has a maximum length of 15 bytes.
See also SwiGetPhoneNumber.
| Nam[IN] | NAM index. |
| MDN[OUT] | Mobile Directory Number of the selected NAM profile. |
| length[IN] | Length of the string buffer to receive the result. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiGetRoamingStatus | ( | swi_uint32 * | lRoamingStatus, |
| swi_uint32 | timeout | ||
| ) |
This function reports whether the device has acquired service from a cellular service provider other than that to which the user has subscribed.
Results when called while not in coverage are undefined. The modem cannot verify that you are roaming until it can detect coverage (SwiGetServiceIndication) and identify the service provider(s).
Use of this function should be limited. There is a notification available in the CDMA2000 1X API (SWI_NOTIFY_RoamingStatus) that reports the same data. Use of notifications is preferred over direct polling.
| lRoamingStatus[OUT] | A pointer to return the status: 0 = Not roaming 1 = Roaming 2 = Non preferred roaming >2 = Service provider dependent |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiGetRssi | ( | swi_int32 * | iRssi, |
| swi_uint32 | timeout | ||
| ) |
This function reports the Received Signal Strength Indicator (RSSI) A request is sent to the modem. The modem's response contains the RSSI. The caller must specify the amount of time to wait for the modem to respond to the request.
CDMA does not use an RSSI per se. The modem uses an algorithm incorporating signal quality elements to produce the numbers delivered by this function.
The interpretation is described in the following table:
| -137 | No signal detected | | -136 to -91 | Very poor | | -90 to -86 | Poor | | -85 to -81 | Fair | | -80 to -76 | Good |
Use of this function should be reserved to application startup. There is a notification available in the CDMA2000 1X API (SWI_NOTIFY_Rssi). Use of notifications is preferred over direct polling.
| [OUT] | iRssi: (positive) RSSI value. Negate the value received to interpret it correctly. |
| [IN] | timeout: response timeout value in milliseconds |
| SWI_API SWI_RCODE SwiGetRssiEcio | ( | SWI_STRUCT_Rssi_Ecio * | stRssiEcio, |
| swi_uint32 | timeout | ||
| ) |
This function gets the current RSSI and EcIo values for Signal Stregth reporting.
| [OUT] | stRssiEcio Struct with RSSI and EcIo values. |
| SWI_API SWI_RCODE SwiGetServiceIndication | ( | swi_int32 * | lServiceIndicator, |
| swi_uint32 | timeout | ||
| ) |
This function reports whether or not there is service in the current location.
The presence of a CDMA service does not guarantee that connection is possible. The modem may fail to authenticate with the local service provider. E911 service should still be available, even if authentication fails.
There is a notification equivalent (SWI_NOTIFY_ServiceIndication) to advise the application when entering or leaving coverage. This is preferred over the polling command.
| lServiceIndicator[OUT] | The current service: 0 = No service 1 = Analog (not supported) 2 = Digital service |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiGetTechActiveSet | ( | SWI_STRUCT_TechActiveSet * | pTechActSet, |
| swi_uint32 | timeout | ||
| ) |
This function retrieves the Active Set
| pTechActSet[OUT] | Active set list. See SWI_STRUCT_TechActiveSet. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiGetTechBSInfo | ( | swi_int32 * | longitude, |
| swi_int32 * | latitude, | ||
| swi_uint32 | timeout | ||
| ) |
This function reports the geographical coordindates of the base station the modem is currently using
The geographical coordinates may not be necessilary provided by all base stations.
Below is an example of how to convert the longitude geographical seconds into degrees/minutes/seconds. Latitude is computed identically.
int iMin, iSec, iDeg, iGeoSecs;
iGeoSecs = iLongitude / 4;
iDeg = iGeoSecs / 3600;
iMin = (iGeoSecs - iDeg * 3600) / 60;
iSec = iGeoSecs - iDeg * 3600 - iMin * 60;
GeoDeg = iDeg;
GeoMin = abs(iMin);
GeoSec = abs(iSec); | longitude[OUT] | Longitude reported in geographical seconds. |
| latitude[OUT] | Latitude reported in geographical seconds. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiGetTechFrame | ( | swi_uint32 * | totalFrames, |
| swi_uint32 * | badFrames, | ||
| swi_uint32 | timeout | ||
| ) |
This function reports the frame error rate value.
The frame error rate value is cumulative for the session in which the modem is powered. Any power cycles to the modem (reset, eject/insert, etc) will cause the value to reset.
| totalFrames[OUT] | The destination in which the total # of frames is returned. |
| badFrames[OUT] | The destination in which the # of bad frames is returned. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiGetTechHdrNotificationStatus | ( | swi_uint16 * | iTechHdrNotificationStatus, |
| swi_uint32 | timeout | ||
| ) |
This function gets a mask of which Tech HDR notifications are enabled.
| iTechHdrNotificationStatus[OUT] | Notification Mask. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiGetTechNID | ( | swi_uint16 * | networkID, |
| swi_uint32 | timeout | ||
| ) |
This function retrieve the NID.
| networkID[OUT] | NID returned from modem. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiGetTechPacketZone | ( | swi_uint16 * | packetZoneID, |
| swi_uint32 | timeout | ||
| ) |
This function gets the Packet Zone ID value.
| packetZoneID[OUT] | The Packet Zone ID setting returned from modem. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiGetTechPowersaveMode | ( | swi_uint16 * | powersaveMode, |
| swi_uint32 | timeout | ||
| ) |
This function reports the current powersave status.
The modem enters powersave mode when it fails to find service for a predetermined amount of time. During this state, the modem will periodically wake up and scan for service. To force the modem to immediately exit powersave mode and wake up and scan for service, send an arbitrary DTMF to the modem using the command SwiSetKeyPressed.
Use the notifications SWI_NOTIFY_PowerSaveEnter and leaves powersave mode.
SWI_NOTIFY_PowerSaveExit to determine when the modem enters and
| powersaveMode[OUT] | The destination in which the powersave state is returned: 0 = powersave mode off 1 = powersave mode on See SWI_TYPE_TechPowersaveMode. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiGetTechSID | ( | swi_uint16 * | systemID, |
| swi_uint32 | timeout | ||
| ) |
This function retrieve the SID
| systemID[OUT] | SID returned from modem. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiGetTransmitPower | ( | swi_int16 * | TxPower, |
| swi_uint32 | timeout | ||
| ) |
This function reports the transmit power value
The transmit power value is measured in negative dBm. To interpret the value correctly, divide the value by 100.
| TxPower[OUT] | The destination in which the transmit power value is returned. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiHdrCloseSession | ( | swi_uint32 | timeout | ) |
This function request that the modem close the HDR session.
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstGetDsMip2002BisMnHaAuth | ( | swi_uint16 * | pRfc2002, |
| swi_uint32 | timeout | ||
| ) |
This function gets RFC2002bis MN-HA authenticator calculation enable.
| pRfc2002[IN] | Enable = 1, Disable = 0. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstGetDsMipActiveProf | ( | swi_uint16 * | pActive, |
| swi_uint32 | timeout | ||
| ) |
This function gets the active profile in which a Mobile IP call will use.
This is supported for only Mobile IP enabled modems.
| pActive[OUT] | Active Profile # returned from modem. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstGetDsMipEnableProf | ( | SWI_STRUCT_MipEnabled * | sMipEnabled, |
| swi_uint32 | timeout | ||
| ) |
This function gets MIP Profile Enabled list.
This list should be used to manage which MIP profiles are enabled.
| sMipEnabled[OUT] | MIP Profile Enabled list. (see SWI_STRUCT_MipEnabled) |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstGetDsMipGenUser | ( | swi_uint16 | index, |
| swi_uint16 | naiLength, | ||
| swi_charp | nai, | ||
| swi_uint16 * | pMnHaSpiEnable, | ||
| swi_uint32 * | pMnHaSpi, | ||
| swi_uint16 * | pMnAaaSpiEnable, | ||
| swi_uint32 * | pMnAaaSpi, | ||
| swi_uint16 * | pReverseTunneling, | ||
| swi_uint32 * | pHomeAddress, | ||
| swi_uint32 * | pPrimaryHaAddress, | ||
| swi_uint32 * | pSecondaryHaAddress, | ||
| swi_uint32 | timeout | ||
| ) |
This function retrieves various Mobile IP profile settings.
Supported for only Mobile IP enabled devices. See SwiPstGetDsQcMip for determining MIP capability.
| index[IN] | Index # of Profile to modify: 0-5. |
| naiLength[IN] | Length of NAI field in bytes. |
| nai[OUT] | NAI (username) |
| pMnHaSpiEnable[OUT] | MN-HA SPI enable 0 - disable 1 - enable |
| pMnHaSpi[OUT] | MN-HA SPI |
| pMnAaaSpiEnable[OUT] | MN-AAA SPI enable 0 - disable 1 - enable |
| pMnAaaSpi[OUT] | MN-AAA SPI |
| pReverseTunneling[OUT] | Reverse Tunneling Preferred 0 - disable 1 - enable |
| pHomeAddress[OUT] | Home IP Address |
| pPrimaryHaAddress[OUT] | Primary HA IP Address (big-endian) |
| pSecondaryHaAddress[OUT] | Secondary HA IP Address (big-endian) |
| timeout[OUT] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstGetDsMipPrereRrqTime | ( | swi_uint16 * | pRereg, |
| swi_uint32 | timeout | ||
| ) |
This function gets Pre lifetime expiry re-registration (minutes)
| pRereg[IN] | Re-reg expiry. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstGetDsMipQcDrsOpt | ( | swi_uint16 * | pActive, |
| swi_uint32 | timeout | ||
| ) |
This function Get QC optimized dormant handoff enable.
| pActive[OUT] | Enabled = 1, Disabled = 0.. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstGetDsMipRetries | ( | swi_uint16 * | pRetries, |
| swi_uint32 | timeout | ||
| ) |
This function get Mobile Retry count.
| pRetries[OUT] | Retry count. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstGetDsMipRetryInt | ( | swi_uint16 * | pInterval, |
| swi_uint32 | timeout | ||
| ) |
This function gets Mobile Retry Interval (milliseconds).
| pInterval[OUT] | Retry Interval |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstGetDsMipRrqIfTfrk | ( | swi_uint16 * | pReregistration, |
| swi_uint32 | timeout | ||
| ) |
This function gets Re-register only if traffic since last RRQ enable.
| pReregistration[OUT] | Enable = 1, Disable = 0. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstGetDsQcMip | ( | swi_uint16 * | pBehaviour, |
| swi_uint32 | timeout | ||
| ) |
This function reports the modem's Mobile IP call support.
| pBehaviour[OUT] | The destination in which the MIP support is returned: 0 - Not supported. Simple IP only. 1 - MIP Prefered. (Fallback to SIP if MIP fails) 2 - MIP Only. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstGetHdrPassword | ( | swi_charp | pszPassword, |
| swi_uint32 | szLength, | ||
| swi_uint32 | timeout | ||
| ) |
This function returns the HDR password
The HDR passeord is set using SwiPstSetHdrPassword.
| pszPassword[OUT] | The destination in which the HDR password string is returned. |
| szLength[IN] | The maximum size of the output buffer. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstGetHdrUserId | ( | swi_charp | pszUserId, |
| swi_uint32 | szLength, | ||
| swi_uint32 | timeout | ||
| ) |
This function the HDR Nai
The user ID is also referred to as the NAI (refer to IS-638B section 3.5.8).
The User ID is set using SwiPstSetHdrUserId.
| pszUserId[OUT] | The destination in which the HDR user ID string is returned. |
| szLength[IN] | The maximum size of the output buffer. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstGetHomeSidNid | ( | swi_uint16 | Nam, |
| SWI_STRUCT_HomeSidNid * | HomeSidNid, | ||
| swi_uint32 | timeout | ||
| ) |
This function returns the table of SID and NID values designated as "home" (not roaming).
These values are usually preset at the factory for the particular service provider. They can be changed using SwiPstSetHomeSidNid.
| Nam[IN] | NAM index. |
| HomeSidNid[OUT] | The destination structure in which the data is returned. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstGetPrefMode | ( | swi_uint16 | Nam, |
| swi_uint16 * | PrefMode, | ||
| swi_uint32 | timeout | ||
| ) |
This function gets the Preferred Operating Mode setting.
| Nam[IN] | NAM index. |
| PrefMode[OUT] | Preferred Mode setting. See SWI_TYPE_NvPrefOpMode. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstGetServiceAreaAlert | ( | swi_uint16 * | srvAreaAlert, |
| swi_uint32 | timeout | ||
| ) |
This function reports whether the alert tone for changes in service (in or out of coverage)
The setting can be changed using SwiPstSetServiceAreaAlert.
Enables/disables playing an alert tone in the headset when there is a change in the type of coverage. A call to SwiGetServiceIndication will confirm the nature of the change in service.
| srvAreaAlert[OUT] | The destination in which the service alert state is returned: 0 = disabled 1 = enabled |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstGetSip2Password | ( | swi_charp | pszPassword, |
| swi_uint32 | szLength, | ||
| swi_uint32 | timeout | ||
| ) |
This function returns the Simple IP profile 2 (index 1) password string.
The password is set using SwiPstSetSip2Password.
| pszPassword[OUT] | The destination in which the user password is returned. |
| szLength[IN] | The maximum size of the output buffer. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstGetSip2UserId | ( | swi_charp | pszUserId, |
| swi_uint32 | szLength, | ||
| swi_uint32 | timeout | ||
| ) |
This function the Simple IP profile 2 (index 1) user ID string.
The user ID is also referred to as the NAI (refer to IS-638B section 3.5.8).
The User ID is set using SwiPstSetSip2UserId.
| pszUserId[OUT] | The destination in which the user ID string is returned. |
| szLength[IN] | The maximum size of the output buffer. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstGetSipPassword | ( | swi_charp | pszPassword, |
| swi_uint32 | szLength, | ||
| swi_uint32 | timeout | ||
| ) |
This function returns the Simple IP profile 1 (index 0) password string.
The password is set using SwiPstSetSipPassword.
| pszPassword[OUT] | The destination in which the user password is returned. |
| szLength[IN] | The maximum size of the output buffer. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstGetSipUserId | ( | swi_charp | pszUserId, |
| swi_uint32 | szLength, | ||
| swi_uint32 | timeout | ||
| ) |
This function returns the Simple IP profile 1 (index 0) user ID string.
The user ID is also referred to as the NAI (refer to IS-638B section 3.5.8).
The User ID is set using SwiPstSetSipUserId.
| pszUserId[OUT] | The destination in which the user ID string is returned. |
| szLength[IN] | The maximum size of the output buffer. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstGetSystemPref | ( | swi_uint16 | Nam, |
| swi_uint16 * | PrefServ, | ||
| swi_uint32 | timeout | ||
| ) |
This function returns the setting of the CDMA "preferred service" for a specified NAM account profile.
The preferred service is set using SwiPstSetSystemPref.
| Nam[IN] | NAM index. |
| PrefServ[OUT] | The system preference (determined by the service provider) from the selected NAM account profile: 0 = System A only 1 = System B only 2 = Home only 3 = Home preferred 4 = Automatic A 5 = Automatic B |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstGetTermNid | ( | swi_uint16 | Nam, |
| swi_uint16 * | TermNidEnable, | ||
| swi_uint32 | timeout | ||
| ) |
This function retrieve the Foreign NID registration setting.
| Nam[IN] | NAM index. |
| TermNidEnable[OUT] | Foreign NID registration setting (0 = disabled, 1 = enabled) |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstGetTermSid | ( | swi_uint16 | Nam, |
| swi_uint16 * | TermSidEnable, | ||
| swi_uint32 | timeout | ||
| ) |
This function retrieves the Foreign SID registration setting.
| Nam[IN] | NAM index. |
| TermSidEnable[OUT] | Foreign SID registration setting (0 = disabled, 1 = enabled) |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstSetDsMip2002BisMnHaAuth | ( | swi_uint16 | rfc2002, |
| swi_uint32 | timeout | ||
| ) |
This function sets RFC2002bis MN-HA authenticator calculation enable.
| rfc2002[IN] | Enabled = 1, Disabled = 0. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstSetDsMipActiveProf | ( | swi_uint16 | active, |
| swi_uint32 | timeout | ||
| ) |
This function sets the active profile in which a Mobile IP call will use.
This is supported for only Mobile IP enabled modems.
| active[IN] | Profile # to set as active. Supported values are 0-5. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstSetDsMipEnableProf | ( | const SWI_STRUCT_MipEnabled * | psMipEnabled, |
| swi_uint32 | timeout | ||
| ) |
This function sets MIP Profile Enabled list.
This list should be used to manage which MIP profiles are enabled.
| psMipEnabled[IN] | MIP Profile Enabled list. (see SWI_STRUCT_MipEnabled) |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstSetDsMipGenUser | ( | swi_uint16 | index, |
| swi_uint16 | naiLength, | ||
| swi_charp | nai, | ||
| swi_uint16 | mnHaSpiEnable, | ||
| swi_uint32 | mnHaSpi, | ||
| swi_uint16 | mnAaaSpiEnable, | ||
| swi_uint32 | mnAaaSpi, | ||
| swi_uint16 | reverseTunneling, | ||
| swi_uint32 | homeAddress, | ||
| swi_uint32 | primaryHaAddress, | ||
| swi_uint32 | secondaryHaAddress, | ||
| swi_uint32 | timeout | ||
| ) |
This function configures various Mobile IP profile settings.
Supported for only Mobile IP enabled devices. See SwiPstGetDsQcMip for determining MIP capability.
| index[IN] | Index # of Profile to modify: 0-5. |
| naiLength[IN] | Length of NAI field in bytes. |
| nai[IN] | NAI (username) |
| mnHaSpiEnable[IN] | MN-HA SPI enable 0 - disable 1 - enable |
| mnHaSpi[IN] | MN-HA SPI |
| mnAaaSpiEnable[IN] | MN-AAA SPI enable 0 - disable 1 - enable |
| mnAaaSpi[IN] | MN-AAA SPI |
| reverseTunneling[IN] | Reverse Tunneling Preferred 0 - disable 1 - enable |
| homeAddress[IN] | Home IP Address |
| primaryHaAddress[IN] | Primary HA IP Address (big-endian) |
| secondaryHaAddress[IN] | Secondary HA IP Address (big-endian) |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstSetDsMipPrereRrqTime | ( | swi_uint16 | rereg, |
| swi_uint32 | timeout | ||
| ) |
This function sets Pre lifetime expiry re-registration (minutes)
| rereg[IN] | Re-reg expiry. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstSetDsMipQcDrsOpt | ( | swi_uint16 | active, |
| swi_uint32 | timeout | ||
| ) |
This function Set QC optimized dormant handoff enable.
| active[IN] | Enabled = 1, Disabled = 0. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstSetDsMipRetries | ( | swi_uint16 | retries, |
| swi_uint32 | timeout | ||
| ) |
This function sets Mobile Retry count
| retries[IN] | Retry count. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstSetDsMipRetryInt | ( | swi_uint16 | interval, |
| swi_uint32 | timeout | ||
| ) |
This function set Mobile Retry Interval (milliseconds).
| interval[IN] | Retry Interval. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstSetDsMipRrqIfTfrk | ( | swi_uint16 | reregistration, |
| swi_uint32 | timeout | ||
| ) |
This function sets Re-register only if traffic since last RRQ enable.
| reregistration[IN] | Enable = 1, Disable = 0. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstSetDsQcMip | ( | swi_uint16 | behaviour, |
| swi_uint32 | timeout | ||
| ) |
This function sets the Mobile IP Mode setting.
| behaviour[IN] | The MIP mode behaviour: 0 = SIP only 1 = MIP Preferred (fallback to SIP if MIP fails) 2 = MIP only |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstSetHdrPassword | ( | const swi_charp | pszPassword, |
| swi_uint32 | timeout | ||
| ) |
This function sets the HDR password
The current setting can be read using SwiPstGetHdrPassword.
| pszPassword[IN] | The user password string to store. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstSetHdrUserId | ( | const swi_charp | pszUserId, |
| swi_uint32 | timeout | ||
| ) |
This function sets the Hdr Nai
The user ID is also referred to as the NAI (refer to IS-638B section 3.5.8).
The data is committed and takes effect immediately.
The User ID is get using SwiPstGetHdrUserId.
| pszUserId[IN] | The HDR user ID string to set. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstSetHomeSidNid | ( | swi_uint16 | Nam, |
| const SWI_STRUCT_HomeSidNid * | pHomeSidNid, | ||
| swi_uint32 | timeout | ||
| ) |
| SWI_API SWI_RCODE SwiPstSetPrefMode | ( | swi_uint16 | Nam, |
| swi_uint16 | PrefMode, | ||
| swi_uint32 | timeout | ||
| ) |
This function sets the Preferred Operating Mode value.
| Nam[IN] | NAM index. |
| PrefMode[IN] | This is a parameter. |
| timeout[IN] | Preferred Mode setting. See SWI_TYPE_NvPrefOpMode. |
| SWI_API SWI_RCODE SwiPstSetServiceAreaAlert | ( | swi_uint16 | srvAreaAlert, |
| swi_uint32 | timeout | ||
| ) |
This function enables or disables the playing of a beep tone to alert the user of changes in service while in a voice call.
Enables/disables playing an alert tone in the headset when there is a change in the type of coverage. A call to SwiGetServiceIndication will confirm the nature of the change in service.
The setting can be read using SwiPstGetServiceAreaAlert.
| srvAreaAlert[IN] | The service alert state to set: 0 = disabled 1 = enabled |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstSetSip2Password | ( | const swi_charp | pszPassword, |
| swi_uint32 | timeout | ||
| ) |
This function sets the Simple IP profile 2 (index 1) user password string.
The current setting can be read using SwiPstGetSip2Password.
The data is committed and takes effect immediately.
| pszPassword[IN] | The user password string to store. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstSetSip2UserId | ( | const swi_charp | pszUserId, |
| swi_uint32 | timeout | ||
| ) |
This function sets the Simple IP profile 2 (index 1) user ID string.
The user ID is also referred to as the NAI (refer to IS-638B section 3.5.8). The current setting can be read using SwiPstGetSip2UserID.
The data is committed and takes effect immediately.
| pszUserId[IN] | The user ID string to set. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstSetSipPassword | ( | const swi_charp | pszPassword, |
| swi_uint32 | timeout | ||
| ) |
This function sets the Simple IP profile 1 (index 0) user password string.
The current setting can be read using SwiPstGetSipPassword.
The data is committed and takes effect immediately.
| pszPassword[IN] | The user password string to store. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstSetSipUserId | ( | const swi_charp | pszUserId, |
| swi_uint32 | timeout | ||
| ) |
This function sets the Simple IP profile 1 (index 0) user ID string.
The user ID is also referred to as the NAI (refer to IS-638B section 3.5.8). The current setting can be read using SwiPstGetSipUserID.
The data is committed and takes effect immediately.
| pszUserId[IN] | The user ID string to set. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstSetSystemPref | ( | swi_uint16 | Nam, |
| swi_uint16 | PrefServ, | ||
| swi_uint32 | timeout | ||
| ) |
This function sets the CDMA preferred service for a specified NAM account profile. This is the fallback channel scan if the PRL is exhausted without finding service.
This value is usually set at the factory for the specific service provider. Only change the setting at the service provider’s direction. The current setting can be read using SwiPstGetSystemPref. The modem must be reset via SwiResetModem to have the setting take effect.
| Nam[IN] | NAM index. |
| PrefServ[IN] | The system preference to set in the selected NAM. See SWI_TYPE_NvSystemPref. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstSetTermNid | ( | swi_uint16 | Nam, |
| swi_uint16 | TermNidEnable, | ||
| swi_uint32 | timeout | ||
| ) |
This function sets the Foreign NID registration setting.
| Nam[IN] | NAM index. |
| TermNidEnable[IN] | Foreign NID registration setting (0 = disabled, 1 = enabled) |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiPstSetTermSid | ( | swi_uint16 | Nam, |
| swi_uint16 | TermSidEnable, | ||
| swi_uint32 | timeout | ||
| ) |
This function sets the Foreign SID registration setting.
| Nam[IN] | NAM index. |
| TermSidEnable[IN] | Foreign SID registration setting (0 = disabled, 1 = enabled) |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiSetAutoconnect | ( | swi_uint16 | nEnable, |
| swi_uint32 | timeout | ||
| ) |
This function This function will be used to set auto connect flag (for data call).
| nEnable[IN] | value 1 = enable ; 0 to disable. |
| timeout[IN] | Function timeout in milliseconds. |
This function disconnects the current call.
| SWI_API SWI_RCODE SwiSetCallOriginateCmd | ( | swi_uint16 | callType, |
| const swi_charp | szCallNumber, | ||
| swi_uint32 | timeout | ||
| ) |
This function originates a Voice, QNC, or 1xRTT call / connection.
| callType[IN] | The type of call to originate. See SWI_TYPE_CDMA_CallType. The valid options are: SWI_CALL_TYPE_Voice SWI_CALL_TYPE_AsyncData SWI_CALL_TYPE_PacketData |
| szCallNumber[IN] | The number to dial. You must ensure the string contains only characters: #, *, 0-9. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiSetHdrHybrPref | ( | swi_uint16 | iHdrHybrPref, |
| swi_uint32 | timeout | ||
| ) |
This function sets the HDR Hybrid Pref setting.
| iHdrHybrPref[IN] | HDR Hybrid Pref setting. 0 = OFF; 1 = ON |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiSetMobileDirNum | ( | swi_uint16 | Nam, |
| const swi_charp | MDN, | ||
| swi_uint32 | timeout | ||
| ) |
This function sets the MDN (Mobile Directory Number) of a specified NAM account profile.
The modem must be unlocked via SwiPstUnlock to execute this command.
The MDN has a minimum length of 1 and a maximum length of 15 digits.
The data is not committed until SwiPstLock is called.
| Nam[IN] | NAM index. |
| MDN[IN] | Mobile Directory Number to store. |
| timeout[IN] | Function timeout in milliseconds. |
| SWI_API SWI_RCODE SwiSetTempModePref | ( | swi_uint16 | nModePref, |
| swi_uint16 | nModeTerm, | ||
| swi_uint32 | nModeDur, | ||
| swi_uint32 | nBandPref, | ||
| swi_uint16 | nRoamPref, | ||
| swi_uint32 | timeout | ||
| ) |
This function sets modem preference
| nModePref[IN] | Modem preference |
| nModeTerm[IN] | Mode preference change termination |
| nModeDur[IN] | Time in secs for temp. mode preference change |
| nBandPref[IN] | Band preference to switch to |
| nRoamPref[IN] | Roam preference to switch to |