qaGobiApiCbk.h File Reference

Callback Service API function prototypes. More...

Go to the source code of this file.

Data Structures

struct  qaQmiInterfaceInfo
struct  slqsSessionStateInfo
struct  slqsWdsEventInfo
struct  TransferStatsDataType
struct  SignalStrengthDataType
struct  SMSMTMessage
struct  SMSTransferRouteMTMessage
struct  SMSMessageMode
struct  SMSEtwsMessage
struct  SMSEtwsPlmn
struct  SMSCAddress
struct  SMSOnIMS
struct  SMSEventInfo_s
struct  CATEventDataType
struct  ServingSystemInfo
struct  SLQSSignalStrengthsInformation
struct  SLQSSignalStrengthsIndReq
struct  ECTNum
struct  voiceSUPSNotification
struct  voiceSetAllCallStatusCbkInfo
struct  _transLayerInfoNotification
struct  _transNWRegInfoNotification
struct  UIMStatusChangeInfo
struct  voicePrivacyInfo
struct  voiceDTMFEventInfo
struct  voiceSUPSInfo
struct  nasSysInfo
struct  UniversalTime
struct  nasNetworkTime
struct  omaDmFotaTlv
struct  omaDmConfigTlv
union  sessionInfo
struct  SMSMemoryInfo
struct  voiceOTASPStatusInfo
struct  signalInfo
struct  callerIDInfo
struct  callingPartyInfo
struct  calledPartyInfo
struct  redirNumInfo
struct  NSSAudioCtrl
struct  lineCtrlInfo
struct  extDispRecInfo
struct  voiceInfoRec
struct  msgWaitingInfo
struct  QosFlowInfoState
struct  QosFlowInfo
struct  QosEventInfo
struct  nasSigInfo
struct  _modemTempNotification
struct  _packetSrvStatus
struct  HDRPersonalityInd
struct  imsSIPConfigInfo
struct  imsRegMgrConfigInfo
struct  imsSMSConfigInfo
struct  imsUserConfigInfo
struct  imsVoIPConfigInfo

Defines

#define SIGSTRENGTH_THRESHOLD_ARR_SZ   5
#define QMI_WMS_MAX_PAYLOAD_LENGTH   256
#define QMI_MAX_VOICE_NUMBER_LENGTH   81
#define MAX_NO_OF_UUSINFO   20
#define MAXUSSDLENGTH   182
#define MAX_NO_OF_CALLS   20
#define CBK_ENABLE_EVENT   0x01
#define CBK_DISABLE_EVENT   0x00
#define CBK_NOCHANGE   0xFF
#define MAX_NO_OF_APPLICATIONS   10
#define MAX_NO_OF_SLOTS   5
#define MAX_NO_OF_FILES   255
#define MAX_PATH_LENGTH   255
#define EVENT_MASK_CARD   0x00000001
#define EVENT_MASK_DEREGISTER_ALL   0x00000000
#define REGISTER_EVENT   0x01
#define DEREGISTER_EVENT   0x00
#define FIRST_INSTANCE   0x00
#define SECOND_INSTANCE   0x01
#define THIRD_INSTANCE   0x02
#define INVALID_INSTACNE   0x08
#define REGISTER_SRV   0x01
#define DEREGISTER_SRV   0x00
#define WDS_SRV   0x01
#define NAS_SRV   0x02
#define PDS_SRV   0x04
#define VOICE_SRV   0x08
#define NUM_OF_SET   0xFF
#define MAX_RADIO_INTERFACE_LIST   255

Typedefs

typedef void(* tFNSLQSSessionState )(slqsSessionStateInfo *pSessionStateInfo)
typedef void(* tFNSLQSWDSEvent )(slqsWdsEventInfo *pWdsEventInfo)
typedef void(* tFNPower )(ULONG operatingMode)
typedef void(* tFNActivationStatus )(ULONG activationStatus)
typedef void(* tFNMobileIPStatus )(ULONG mipStatus)
typedef void(* tFNRoamingIndicator )(ULONG roaming)
typedef void(* tFNDataCapabilities )(BYTE dataCapsSize, BYTE *pDataCaps)
typedef void(* tFNSignalStrength )(INT8 signalStrength, ULONG radioInterface)
typedef void(* tFNRFInfo )(ULONG radioInterface, ULONG activeBandClass, ULONG activeChannel)
typedef void(* tFNLUReject )(ULONG serviceDomain, ULONG rejectCause)
typedef void(* tFNNewSMS )(ULONG storageType, ULONG messageIndex)
typedef enum SMSEventType eSMSEventType
typedef struct SMSMTMessage SMSMTMessageInfo
typedef struct
SMSTransferRouteMTMessage 
SMSTransferRouteMTMessageInfo
typedef struct SMSMessageMode SMSMessageModeInfo
typedef struct SMSEtwsMessage SMSEtwsMessageInfo
typedef struct SMSEtwsPlmn SMSEtwsPlmnInfo
typedef struct SMSCAddress SMSCAddressInfo
typedef struct SMSOnIMS SMSOnIMSInfo
typedef struct SMSEventInfo_s SMSEventInfo
typedef void(* tFNSMSEvents )(SMSEventInfo *pSMSEventInfo)
typedef void(* tFNNewNMEA )(LPCSTR pNMEA)
typedef void(* tFNPDSState )(ULONG enabledStatus, ULONG trackingStatus)
typedef void(* tFNCATEvent )(ULONG eventID, ULONG eventLen, BYTE *pEventData)
typedef enum device_state_enum eDevState
typedef void(* tFNDeviceStateChange )(eDevState device_state)
typedef void(* tFNNet )(ULONG q_depth, BYTE isThrottle)
typedef void(* tFNFwDldCompletion )(ULONG fwdld_completion_status)
typedef void(* tFNSLQSOMADMAlert )(ULONG sessionType, BYTE *psessionTypeFields)
typedef void(* tFNOMADMState )(ULONG sessionState, ULONG failureReason)
typedef void(* tFNServingSystem )(struct ServingSystemInfo *pServingSystem)
typedef void(* tFNBandPreference )(ULONGLONG band_pref)
typedef void(* tFNUSSDRelease )(void)
typedef void(* tFNUSSDNotification )(ULONG type, BYTE *pNetworkInfo)
typedef void(* tFNSLQSSignalStrengths )(struct SLQSSignalStrengthsInformation sSLQSSignalStrengthsInfo)
typedef void(* tFNSUPSNotification )(voiceSUPSNotification *pVoiceSUPSNotification)
typedef void(* tFNSDKTerminated )(BYTE *psReason)
typedef void(* tFNAllCallStatus )(voiceSetAllCallStatusCbkInfo *pVoiceSetAllCallStatusCbkInfo)
typedef struct
_transLayerInfoNotification 
transLayerNotification
typedef void(* tFNtransLayerInfo )(transLayerNotification *pTransLayerNotification)
typedef struct
_transNWRegInfoNotification 
transNWRegInfoNotification
typedef void(* tFNtransNWRegInfo )(transNWRegInfoNotification *pTransNWRegInfoNotification)
typedef void(* tFNSysSelectionPref )(sysSelectPrefInfo *pSysSelectPrefInfo)
typedef void(* tFNUIMRefresh )(UIMRefreshEvent *pUIMRefreshEvent)
typedef void(* tFNUIMStatusChangeInfo )(UIMStatusChangeInfo *pUIMStatusChangeInfo)
typedef void(* tFNPrivacyChange )(voicePrivacyInfo *pVoicePrivacyInfo)
typedef void(* tFNDTMFEvent )(voiceDTMFEventInfo *pVoiceDTMFEventInfo)
typedef void(* tFNSUPSInfo )(voiceSUPSInfo *pVoiceSUPSInfo)
typedef void(* tFNSysInfo )(nasSysInfo *pNasSysInfo)
typedef void(* tFNNetworkTime )(nasNetworkTime *pNasNetworkTime)
typedef union sessionInfo sessionInformation
typedef void(* tFNMemoryFull )(SMSMemoryInfo *pSMSMemoryFullInfo)
typedef void(* tFNOTASPStatus )(voiceOTASPStatusInfo *pVoiceOTASPStatusInfo)
typedef void(* tFNInfoRec )(voiceInfoRec *pVoiceInfoRec)
typedef void(* tFNMessageWaiting )(msgWaitingInfo *pSMSMessageWaitingInfo)
typedef void(* tFNSLQSQOSEvent )(BYTE instance, QosFlowInfo *pFlowInfo)
typedef void(* tFNQosStatus )(BYTE instance, ULONG id, BYTE status, BYTE event, BYTE reason)
typedef void(* tFNQosNWStatus )(BYTE status)
typedef void(* tFNQosPriEvent )(WORD event)
typedef void(* tFNSigInfo )(nasSigInfo *pNasSigInfo)
typedef struct
_modemTempNotification 
modemTempNotification
typedef void(* tFNModemTempInfo )(modemTempNotification *pModemTempNotification)
typedef struct _packetSrvStatus packetSrvStatus
typedef void(* tFNPacketSrvState )(packetSrvStatus *pPacketSrvStatus)
typedef void(* tFNHDRPersonaity )(HDRPersonalityInd *pHDRPers)
typedef void(* tFNImsSIPConfig )(imsSIPConfigInfo *pImsSIPConfigInfo)
typedef void(* tFNImsRegMgrConfig )(imsRegMgrConfigInfo *pImsRegMgrConfigInfo)
typedef void(* tFNImsSMSConfig )(imsSMSConfigInfo *pImsSMSConfigInfo)
typedef void(* tFNImsUserConfig )(imsUserConfigInfo *pImsUserConfigInfo)
typedef void(* tFNImsVoIPConfig )(imsVoIPConfigInfo *pImsVoIPConfigInfo)

Enumerations

enum  eQaQMIService {
  eQA_QMI_SVC_WDS = 0x01,
  eQA_QMI_SVC_NAS = 0x03,
  eQA_QMI_SVC_NA = 0xFF
}
enum  SMSEventType {
  SMS_EVENT_MT_MESSAGE = 0x01,
  SMS_EVENT_TRANSFER_ROUTE_MT_MESSAGE = 0x02,
  SMS_EVENT_MESSAGE_MODE = 0x04,
  SMS_EVENT_ETWS = 0x08,
  SMS_EVENT_ETWS_PLMN = 0x10,
  SMS_EVENT_SMSC_ADDRESS = 0x20,
  SMS_EVENT_SMS_ON_IMS = 0x40
}
enum  device_state_enum {
  DEVICE_STATE_DISCONNECTED,
  DEVICE_STATE_READY,
  DEVICE_STATE_BOOT
}

Functions

ULONG SLQSSetSessionStateCallback (tFNSLQSSessionState pCallback)
ULONG SLQSSetWdsEventCallback (tFNSLQSWDSEvent pCallback, BYTE interval, BYTE instanceid)
ULONG iSLQSSetWdsFirstInstEventCallback (tFNSLQSWDSEvent pCallback)
ULONG iSLQSSetWdsSecondInstEventCallback (tFNSLQSWDSEvent pCallback)
ULONG iSLQSSetWdsThirdInstEventCallback (tFNSLQSWDSEvent pCallback)
ULONG SetPowerCallback (tFNPower pCallback)
ULONG SetActivationStatusCallback (tFNActivationStatus pCallback)
ULONG SetMobileIPStatusCallback (tFNMobileIPStatus pCallback)
ULONG SetRoamingIndicatorCallback (tFNRoamingIndicator pCallback)
ULONG SetDataCapabilitiesCallback (tFNDataCapabilities pCallback)
ULONG SetSignalStrengthCallback (tFNSignalStrength pCallback, BYTE thresholdsSize, INT8 *pThresholds)
ULONG iSetSignalStrengthCallback (tFNSignalStrength pCallback)
ULONG SetRFInfoCallback (tFNRFInfo pCallback)
ULONG SetLURejectCallback (tFNLUReject pCallback)
ULONG SetNewSMSCallback (tFNNewSMS pCallback)
ULONG SLQSSetSMSEventCallback (tFNSMSEvents pCallback)
ULONG SetNMEACallback (tFNNewNMEA pCallback)
ULONG SetPDSStateCallback (tFNPDSState pCallback)
ULONG SetCATEventCallback (tFNCATEvent pCallback, ULONG eventMask, ULONG *pErrorMask)
ULONG iSetCATEventCallback (tFNCATEvent pCallback)
ULONG SetDeviceStateChangeCbk (tFNDeviceStateChange pCallback)
ULONG SetNetChangeCbk (BYTE instance, tFNNet pCallback, ULONG loMark, ULONG hiMark, ULONG period)
ULONG SetFwDldCompletionCbk (tFNFwDldCompletion pCallback)
ULONG SetSLQSOMADMAlertCallback (tFNSLQSOMADMAlert pCallback)
ULONG SetOMADMStateCallback (tFNOMADMState pCallback)
ULONG SLQSSetServingSystemCallback (tFNServingSystem pCallback)
ULONG SLQSSetBandPreferenceCbk (tFNBandPreference pCallback)
ULONG SetUSSDReleaseCallback (tFNUSSDRelease pCallback)
ULONG SetUSSDNotificationCallback (tFNUSSDNotification pCallback)
ULONG SLQSSetSignalStrengthsCallback (tFNSLQSSignalStrengths pCallback, struct SLQSSignalStrengthsIndReq *pSLQSSignalStrengthsIndReq)
ULONG iSLQSSetSignalStrengthsCallback (tFNSLQSSignalStrengths pCallback)
ULONG SLQSVoiceSetSUPSNotificationCallback (tFNSUPSNotification pCallback)
ULONG SLQSSetSDKTerminatedCallback (tFNSDKTerminated pCallback)
ULONG SLQSVoiceSetAllCallStatusCallBack (tFNAllCallStatus pCallback)
ULONG SLQSSetTransLayerInfoCallback (tFNtransLayerInfo pCallback)
ULONG SLQSSetTransNWRegInfoCallback (tFNtransNWRegInfo pCallback)
ULONG SLQSSetSysSelectionPrefCallBack (tFNSysSelectionPref pCallback)
ULONG SLQSUIMSetRefreshCallBack (tFNUIMRefresh pCallback)
ULONG SLQSUIMSetStatusChangeCallBack (tFNUIMStatusChangeInfo pCallback)
ULONG SLQSVoiceSetPrivacyChangeCallBack (tFNPrivacyChange pCallback)
ULONG SLQSVoiceSetDTMFEventCallBack (tFNDTMFEvent pCallback)
ULONG SLQSVoiceSetSUPSCallBack (tFNSUPSInfo pCallback)
ULONG SLQSNasSysInfoCallBack (tFNSysInfo pCallback)
ULONG SLQSNasNetworkTimeCallBack (tFNNetworkTime pCallback)
ULONG SLQSWmsMemoryFullCallBack (tFNMemoryFull pCallback)
ULONG SLQSVoiceSetOTASPStatusCallBack (tFNOTASPStatus pCallback)
ULONG SLQSVoiceInfoRecCallback (tFNInfoRec pCallback)
ULONG SLQSWmsMessageWaitingCallBack (tFNMessageWaiting pCallback)
ULONG SLQSSetQosEventCallback (BYTE instance, tFNSLQSQOSEvent pCallback)
ULONG SLQSSetQosStatusCallback (BYTE instance, tFNQosStatus pCallback)
ULONG SLQSSetQosNWStatusCallback (tFNQosNWStatus pCallback)
ULONG SLQSSetQosPriEventCallback (tFNQosPriEvent pCallback)
ULONG SLQSNasSigInfoCallBack (tFNSigInfo pCallback)
ULONG SLQSSetModemTempCallback (tFNModemTempInfo pCallback)
ULONG SLQSSetPacketSrvStatusCallback (tFNPacketSrvState pCallback)
ULONG SLQSSetSwiHDRPersCallback (tFNHDRPersonaity pCallback)
ULONG SLQSSetSIPConfigCallback (tFNImsSIPConfig pCallback)
ULONG SLQSSetRegMgrConfigCallback (tFNImsRegMgrConfig pCallback)
ULONG SLQSSetIMSSMSConfigCallback (tFNImsSMSConfig pCallback)
ULONG SLQSSetIMSUserConfigCallback (tFNImsUserConfig pCallback)
ULONG SLQSSetIMSVoIPConfigCallback (tFNImsVoIPConfig pCallback)

Detailed Description

Callback Service API function prototypes.

Copyright: © 2011-2013 Sierra Wireless, Inc. all rights reserved


Define Documentation

#define CBK_DISABLE_EVENT   0x00
#define CBK_ENABLE_EVENT   0x01
#define CBK_NOCHANGE   0xFF
#define DEREGISTER_EVENT   0x00
#define DEREGISTER_SRV   0x00
#define EVENT_MASK_CARD   0x00000001
#define EVENT_MASK_DEREGISTER_ALL   0x00000000
#define FIRST_INSTANCE   0x00
#define INVALID_INSTACNE   0x08
#define MAX_NO_OF_APPLICATIONS   10
#define MAX_NO_OF_CALLS   20
#define MAX_NO_OF_FILES   255
#define MAX_NO_OF_SLOTS   5
#define MAX_NO_OF_UUSINFO   20
#define MAX_PATH_LENGTH   255
#define MAX_RADIO_INTERFACE_LIST   255
#define MAXUSSDLENGTH   182
#define NAS_SRV   0x02
#define NUM_OF_SET   0xFF
#define PDS_SRV   0x04
#define QMI_MAX_VOICE_NUMBER_LENGTH   81
#define QMI_WMS_MAX_PAYLOAD_LENGTH   256
#define REGISTER_EVENT   0x01
#define REGISTER_SRV   0x01
#define SECOND_INSTANCE   0x01
#define SIGSTRENGTH_THRESHOLD_ARR_SZ   5
#define THIRD_INSTANCE   0x02
#define VOICE_SRV   0x08
#define WDS_SRV   0x01

Typedef Documentation

Device State enumeration

This enumeration defines the different type of SMS events that are received

Contains the parameters passed for SLQSSetModemTempCallback by the device.

Parameters:
ModemTempState 
  • provides the temperature state of the modem
  • Values:
    • 0 - unknown
    • 1 - normal
    • 2 - high(warning)
    • 3 - high(critical)
    • 4 - low(critical)
ModemTemperature 
  • provides the temperature of the modem
Note:
None

Contains the parameters passed for SLQSSetPacketSrvStatusCallback by the device.

Parameters:
pQmiInterfaceInfo 
connStatus 
  • Current Link Status
    • 1 - Disconnected
    • 2 - Connected
    • 3 - Suspended
    • 4 - Authenticating
reconfigReqd 
  • Indicates if the network interface on the host needs to be reconfigured
    • 0 - No need to reconfigure
    • 1 - Reconfiguration required
sessionEndReason 
verboseSessnEndReasonType 
  • Call End Reason Type
    • 0 - Unspecified
    • 1 - Mobile IP
    • 2 - Internal
    • 3 - Call Manager defined
    • 6 - 3GPP Specification defined
    • 7 - PPP
    • 8 - EHRPD
    • 9 - IPv6
verboseSessnEndReason 
ipFamily 
  • IP Family of the packet data connection
    • 4 - IPv4
    • 6 - IPv6
techName 
  • Technology name of the packet data connection.
    • -32767 - CDMA
    • -32764 - UMTS
    • -30592 - EPC
    • -30590 - EMBMS
    • -30584 - Modem Link Local EPC is a logical interface to support LTE/eHRPD handoff. Modem Link is an interface for transferring data between entities on the AP and modem.
Note:
Any parameter not returned by the device is returned as its maximum unsigned value by the callback.

This union sessionInfo consist of omaDmFotaTlv and omaDmConfigTlv, out of which one will be unpacked against psessionTypeFields.

typedef struct SMSCAddress SMSCAddressInfo

This structure holds SMSC information

Parameters:
length 
  • Number of sets of following element
data 
  • SMSC address

This structure holds information related earthquake and Tsunami warning system

Parameters:
notificationType 
  • Message mode 0x00 - Primary 0x01 - Secondary GSM 0x02 - Secondary UMTS
length 
  • Number of sets of following elements
data 
  • Raw message data
typedef struct SMSEtwsPlmn SMSEtwsPlmnInfo

This structure holds information related ETWS PLMN

Parameters:
mobileCountryCode 
  • 16 bit representation of MCC value range : 0 -999
mobileNetworkCode 
  • 16 bit representation of MNC value range : 0 -999
typedef struct SMSEventInfo_s SMSEventInfo

This structure will hold the information related to received SMS events

Parameters:
smsEventType 
  • Type of the SMS events that are received. This is a bit map of SMSEventType. Only the parameters (which follows) related to the events received would be filled, and the rest of the parameters would be NULL
pMTMessageInfo 
  • pointer to the SMSMTMessageInfo structure
    NULL, if this event is not present in the smsEventType parameter
pTransferRouteMTMessageInfo 
pMessageModeInfo 
  • pointer to the SMSMessageModeInfo structure
    NULL, if this event is not present in the smsEventType parameter
pEtwsMessageInfo 
  • pointer to the SMSEtwsMessageInfo structure
    NULL, if this event is not present in the smsEventType parameter
pEtwsPlmnInfo 
  • pointer to the SMSEtwsPlmnInfo structure
    NULL, if this event is not present in the smsEventType parameter
pSMSCAddressInfo 
  • pointer to the SMSCAddressInfo structure
    NULL, if this event is not present in the smsEventType parameter
pSMSOnIMSInfo 
  • pointer to the SMSOnIMSInfo structure
    NULL, if this event is not present in the smsEventType parameter Note: None

This structure holds information related to message mode

Parameters:
messageMode 
  • Message mode 0x00 - CDMA 0x01 - GW

This structure holds information related to MT SMS

Parameters:
storageType 
  • SMS message storage type for the new message
    0 - UIM 1 - NV
messageIndex 
  • Index of the new message
typedef struct SMSOnIMS SMSOnIMSInfo

This structure holds information related to message mode

Parameters:
smsOnIMS 
  • Indicates whether the message is received from IMS 0x00 - Message is not recieved from IMS 0x01 - Message is recieved from IMS 0x02-0xFF - Reserved Note: In multiple modem solutions, this TLV may be used to help the client determine with which modem to communicate. This TLV may not be supported on all implementations.

This structure holds information related to transfer route MT SMS

Parameters:
ackIndicator 
  • Parameter to indicate if ACK must be sent by the control point 0x00 - Send ACK 0x01 - Do not send ACK
transactionID 
  • Transaction ID of the message
format 
  • Message format 0x00 - CDMA 0x02 - 0x05 - Reserved 0x06 - GW_PP 0x07 - GW_BC
length 
  • Length of the raw message. This length should not exceed the maximum WMS payload length of 256 bytes
data 
  • Raw message data
typedef void(* tFNActivationStatus)(ULONG activationStatus)

Activation status callback function.

Parameters:
activationStatus 
  • Service Activation Code
    • 0 - Service not activated
    • 1 - Service activated
    • 2 - Activation connecting
    • 3 - Activation connected
    • 4 - OTASP security authenticated
    • 5 - OTASP NAM downloaded
    • 6 - OTASP MDN downloaded
    • 7 - OTASP IMSI downloaded
    • 8 - OTASP PRL downloaded
    • 9 - OTASP SPC downloaded
    • 10 - OTASP settings committed
typedef void(* tFNAllCallStatus)(voiceSetAllCallStatusCbkInfo *pVoiceSetAllCallStatusCbkInfo)

Voice Call Status Callback function. This funtion pointer will be executed to process received Indication.

Parameters:
pVoiceSetAllCallStatusCbkInfo 
  • Call back will populated memory pointed by this parameter when a call is originated, connected, or ended.
    See voiceSetAllCallStatusCbkInfo for more information.
typedef void(* tFNBandPreference)(ULONGLONG band_pref)

Band Preference Callback function

Parameters:
pBandPref - Bit mask representing the current band preference Bit position meanings:

  • 0 - BC0_A - Band Class 0, A-System
  • 1 - BC0_B - Band Class 0, B-System, Band Class 0 AB , GSM 850 Band
  • 2 - BC1 - Band Class 1, all blocks
  • 3 - BC2 - Band Class 2 place holder
  • 4 - BC3 - Band Class 3, A-System
  • 5 - BC4 - Band Class 4, all blocks
  • 6 - BC5 - Band Class 5, all blocks
  • 7 - GSM_DCS_1800 - GSM DCS band
  • 8 - GSM_EGSM_900 - GSM Extended GSM (E-GSM) band
  • 9 - GSM_PGSM_900 - GSM Primary GSM (P-GSM) band
  • 10 - BC6 - Band Class 6
  • 11 - BC7 - Band Class 7
  • 12 - BC8 - Band Class 8
  • 13 - BC9 - Band Class 9
  • 14 - BC10 - Band Class 10
  • 15 - BC11 - Band Class 11
  • 16 - GSM_450 - GSM 450 band
  • 17 - GSM_480 - GSM 480 band
  • 18 - GSM_750 - GSM 750 band
  • 19 - GSM_850 - GSM 850 band
  • 20 - GSM_RGSM_900 - GSM Railways GSM Band
  • 21 - GSM_PCS_1900 - GSM PCS band
  • 22 - WCDMA_I_IMT_2000 - WCDMA EUROPE JAPAN and CHINA IMT 2100 band
  • 23 - WCDMA_II_PCS_1900 - WCDMA US PCS 1900 band
  • 24 - WCDMA_III_1700 - WCDMA EUROPE and CHINA DCS 1800 band
  • 25 - WCDMA_IV_1700 - WCDMA US 1700 band
  • 26 - WCDMA_V_850 - WCDMA US 850 band
  • 27 - WCDMA_VI_800 - WCDMA JAPAN 800 band
  • 28 - BC12 - Band Class 12
  • 29 - BC14 - Band Class 14
  • 30 - RESERVED_2 - Reserved 2
  • 31 - BC15 - Band Class 15
  • 32 - 47 - Reserved
  • 48 - WCDMA_VII_2600 - WCDMA EUROPE 2600 band
  • 49 - WCDMA_VIII_900 - WCDMA EUROPE and JAPAN 900 band
  • 50 - WCDMA_IX_1700 - WCDMA JAPAN 1700 band
  • 51 to 55 - Reserved
  • 56 - BBC16 - Band Class 16
  • 57 - BC17 - Band Class 17
  • 58 - BC18 - Band Class 18
  • 59 - BC19 - Band Class 19
  • 60 to 64 - Reserved
Note:
Timeout: NA To set the band preference the API SLQSSetBandPreference() should be used
typedef void(* tFNCATEvent)(ULONG eventID, ULONG eventLen, BYTE *pEventData)

CAT event callback function.

Parameters:
eventID 
  • Event ID
    • 16 - Display Text
    • 17 - Get In-Key
    • 18 - Get Input
    • 19 - Setup Menu
    • 20 - Select Item
    • 21 - Send SMS - Alpha Identifier
    • 22 - Setup Event List
    • 23 - Setup Idle Mode Text
    • 24 - Language Notification
    • 25 - Refresh
    • 26 - End Proactive Session
eventLen 
  • Length of pData (in bytes)
pEventData 
Note:
Technology Supported: UMTS
typedef void(* tFNDataCapabilities)(BYTE dataCapsSize, BYTE *pDataCaps)

Serving system data capabilities callback function.

Parameters:
dataCapsSize 
  • Number of elements the data capability array contains
pDataCaps 
  • Data Capabilities Array.
    • 1 - GPRS
    • 2 - EDGE
    • 3 - HSDPA
    • 4 - HSUPA
    • 5 - WCDMA
    • 6 - CDMA 1xRTT
    • 7 - CDMA 1xEV-DO Rev 0
    • 8 - CDMA 1xEV-DO Rev. A
    • 9 - GSM
    • 10 - EVDO Rev. B
    • 11 - LTE
    • 12 - HSDPA Plus
    • 13 - Dual Carrier HSDPA Plus
typedef void(* tFNDeviceStateChange)(eDevState device_state)

Device State Change callback function prototype

Parameters:
device_state 
  • the current state of the device
Note:
Does not require communication with the device
typedef void( * tFNDTMFEvent)(voiceDTMFEventInfo *pVoiceDTMFEventInfo)

Preferred DTMF event indication callback.

Parameters:
pVoiceDTMFEventInfo 
typedef void(* tFNFwDldCompletion)(ULONG fwdld_completion_status)

Firmware Download Completion callback function prototype

Parameters:
error_code 
  • error code returned from firmware download operation
Note:
Does not require communication with the device
typedef void( * tFNHDRPersonaity)(HDRPersonalityInd *pHDRPers)

HDR Personality indication callback.

Parameters:
pHDRPers 
Note:
Technology Supported: CDMA
typedef void( * tFNImsRegMgrConfig)(imsRegMgrConfigInfo *pImsRegMgrConfigInfo)

IMS Reg Mgr Config indication callback.

Parameters:
pImsRegMgrConfigInfo 
typedef void( * tFNImsSIPConfig)(imsSIPConfigInfo *pImsSIPConfigInfo)

IMS SIP Config indication callback.

Parameters:
pImsSIPConfigInfo 
typedef void( * tFNImsSMSConfig)(imsSMSConfigInfo *pImsSMSConfigInfo)

IMS SMS Config indication callback.

Parameters:
pImsSMSConfigInfo 
typedef void( * tFNImsUserConfig)(imsUserConfigInfo *pImsUserConfigInfo)

IMS User Config indication callback.

Parameters:
pImsUserConfigInfo 
typedef void( * tFNImsVoIPConfig)(imsVoIPConfigInfo *pImsVoIPConfigInfo)

IMS VoIP Config indication callback.

Parameters:
pImsVoIPConfigInfo 
typedef void( * tFNInfoRec)(voiceInfoRec *pVoiceInfoRec)

Voice Information Record callback.

Parameters:
pVoiceInfoRec 
Note:
Technology Supported: CDMA
Device Supported: MC7750
typedef void(* tFNLUReject)(ULONG serviceDomain, ULONG rejectCause)

LU reject callback function.

Parameters:
serviceDomain 
  • Service domain
    1 - Circuit Switched
rejectCause 
Note:
Technology Supported: UMTS
typedef void(* tFNMemoryFull)(SMSMemoryInfo *pSMSMemoryFullInfo)

SMS Memory related callback function.

Parameters:
pSMSMemoryFullInfo[OUT] 
typedef void(* tFNMessageWaiting)(msgWaitingInfo *pSMSMessageWaitingInfo)

SMS Memory related callback function.

Parameters:
pSMSMessageWaitingInfo[OUT] 
typedef void(* tFNMobileIPStatus)(ULONG mipStatus)

Mobile IP status callback function.

Parameters:
mipStatus 
typedef void(* tFNModemTempInfo)(modemTempNotification *pModemTempNotification)

Modem Temperature Information callback.

Parameters:
pModemTempNotification 
typedef void(* tFNNet)(ULONG q_depth, BYTE isThrottle)

Transmit Queue Length Change callback function prototype

Parameters:
q_depth 
  • transmit queue length
isThrottle 
  • 0: unthrottle
  • 1: throttle
Note:
Does not require communication with the device
typedef void( * tFNNetworkTime)(nasNetworkTime *pNasNetworkTime)

Network Time indication callback.

Parameters:
pNasNetworkTime 
typedef void(* tFNNewNMEA)(LPCSTR pNMEA)

New NMEA sentence callback function.

Parameters:
pNMEA 
  • NULL-terminated string containing the position data in NMEA sentence format
typedef void(* tFNNewSMS)(ULONG storageType, ULONG messageIndex)

New SMS message callback function.

Parameters:
storageType 
  • SMS message storage type for the new message
    0 - UIM 1 - NV
messageIndex 
  • Index of the new message
typedef void(* tFNOMADMState)(ULONG sessionState, ULONG failureReason)

OMA-DM state callback function

Parameters:
sessionState 
  • Session state
    • 0x00 - Complete, information was updated
    • 0x01 - Complete, update information is unavailable
    • 0x02 - Failed
    • 0x03 - Retrying
    • 0x04 - Connecting
    • 0x05 - Connected
    • 0x06 - Authenticated
    • 0x07 - Mobile Directory Number (MDN) downloaded
    • 0x08 - Mobile Station Identifier (MSID) downloaded
    • 0x09 - PRL downloaded
    • 0x0A - Mobile IP (MIP) profile downloaded
failureReason 
  • Session failure reason (when state indicates failure)
    • 0x00 - Unknown
    • 0x01 - Network is unavailable
    • 0x02 - Server is unavailable
    • 0x03 - Authentication failed
    • 0x04 - Maximum retry exceeded
    • 0x05 - Session is cancelled
Note:
Technology Supported: CDMA
typedef void( * tFNOTASPStatus)(voiceOTASPStatusInfo *pVoiceOTASPStatusInfo)

OTASP or OTAPA event Indication Callback function

Parameters:
pVoiceOTASPStatusInfo 
Note:
Technology Supported: CDMA
typedef void(* tFNPacketSrvState)(packetSrvStatus *pPacketSrvStatus)

Packet Service state callback function.

Parameters:
pPacketSrvStatus 
typedef void(* tFNPDSState)(ULONG enabledStatus, ULONG trackingStatus)

PDS session state callback function.

Parameters:
enabledStatus 
  • GPS enabled status
    • 0 - Disable
    • 1 - Enable
trackingStatus 
  • GPS tracking status
    • 0 - Unknown
    • 1 - Inactive
    • 2 - Active
typedef void(* tFNPower)(ULONG operatingMode)

Power operating mode callback function.

Parameters:
operatingMode 
  • Service Operating mode
    See Tables for Operating Modes
Note:
Technology Supported: UMTS/CDMA
Device Supported: MC83x5, MC7700/50
typedef void( * tFNPrivacyChange)(voicePrivacyInfo *pVoicePrivacyInfo)

Preferred voice privacy indication callback.

Parameters:
pVoicePrivacyInfo 
Note:
Technology Supported: CDMA
typedef void(* tFNQosNWStatus)(BYTE status)

QOS Network status callback function.

Parameters:
status Network QoS support status

  • 0x00 – Current network does not support QoS
  • 0x01 – Current network supports QoS
typedef void(* tFNQosPriEvent)(WORD event)

QOS primary flow callback function.

Parameters:
event Event which causes this indication:

  • 0x0001 – Primary flow QoS modify operation success
  • 0x0002 – Primary flow QoS modify operation failure
typedef void(* tFNQosStatus)(BYTE instance, ULONG id, BYTE status, BYTE event, BYTE reason)

QOS Status callback function.

Parameters:
instance 
  • QMI instance
id 
  • Index identifying the QoS flow whose status is being reported
status Current QoS flow status:

  • 0x01 – QMI_QOS_STATUS_ACTIVATED
  • 0x02 – QMI_QOS_STATUS_SUSPENDED
  • 0x03 – QMI_QOS_STATUS_GONE
event 
  • 0x01 – QMI_QOS_ACTIVATED_EV
  • 0x02 – QMI_QOS_SUSPENDED_EV
  • 0x03 – QMI_QOS_GONE_EV
  • 0x04 – QMI_QOS_MODIFY_ACCEPTED_EV
  • 0x05 – QMI_QOS_MODIFY_REJECTED_EV
  • 0x06 – QMI_QOS_INFO_CODE_UPDATED_EV
reason 
typedef void(* tFNRFInfo)(ULONG radioInterface, ULONG activeBandClass, ULONG activeChannel)

RF information callback function.

Parameters:
radioInterface 
  • Radio interface technology of the signal being measured
    See Tables for Radio Interface
activeBandClass 
  • Active band class
    See Tables for Active Band Class
activeChannel 
  • Active channel
    • 0 - Channel is not relevant to the reported technology
typedef void(* tFNRoamingIndicator)(ULONG roaming)

Roaming indicator callback function.

Parameters:
roaming 
  • Roaming Indication
    • 0 - Roaming
    • 1 - Home
    • 2 - Roaming partner
    • >2 - Operator defined values
typedef void(* tFNSDKTerminated)(BYTE *psReason)

SDK terminated callback function prototype

Parameters:
psReason 
  • sdk termination reason string
Note:
Timeout: None
Does not require communication with the device
typedef void(* tFNServingSystem)(struct ServingSystemInfo *pServingSystem)

Serving System callback function

Parameters:
pServingSystem 
typedef void(* tFNSigInfo)(nasSigInfo *pNasSigInfo)

Signal Strength Information indication callback.

Parameters:
pNasSigInfo 
typedef void(* tFNSignalStrength)(INT8 signalStrength, ULONG radioInterface)

Signal strength callback function.

Parameters:
signalStrength 
  • Received signal strength (in dBm)
radioInterface 
  • Radio interface technology of the signal being measured
    See Tables for Radio Interface
typedef void(* tFNSLQSOMADMAlert)(ULONG sessionType, BYTE *psessionTypeFields)

SWIOMA-DM network-initiated alert callback function

Parameters:
sessionType 
  • 0x00 - SWIOMA-DM FOTA
  • 0x01 - SWIOMA-DM Config
psessionTypeFields 
  • Pointer to structure containing info for that sessionType
  • See sessionInfo for more details
typedef void(* tFNSLQSQOSEvent)(BYTE instance, QosFlowInfo *pFlowInfo)

QOS Event callback function.

Parameters:
instance 
  • QMI instance
pFlowInfo 
typedef void(* tFNSLQSSessionState)(slqsSessionStateInfo *pSessionStateInfo)

Session state callback function.

Parameters:
pSessionStateInfo 
typedef void(* tFNSLQSSignalStrengths)(struct SLQSSignalStrengthsInformation sSLQSSignalStrengthsInfo)

Received Signal Strength Information callback function.

Parameters:
sSLQSSignalStrengthsInfo 
typedef void(* tFNSLQSWDSEvent)(slqsWdsEventInfo *pWdsEventInfo)

WDS Event callback function.

Parameters:
pWdsEventInfo 
typedef void(* tFNSMSEvents)(SMSEventInfo *pSMSEventInfo)

SMS event related callback function.

Parameters:
pSMSEventInfo[OUT] 
typedef void( * tFNSUPSInfo)(voiceSUPSInfo *pVoiceSUPSInfo)

Preferred SUPS indication callback.

Parameters:
pVoiceSUPSInfo 
Note:
Technology Supported: GSM
typedef void(* tFNSUPSNotification)(voiceSUPSNotification *pVoiceSUPSNotification)

Supplementary service notification callback.

Parameters:
pVoiceSUPSNotification 
typedef void( * tFNSysInfo)(nasSysInfo *pNasSysInfo)

System Information indication callback.

Parameters:
pNasSysInfo 
typedef void(* tFNSysSelectionPref)(sysSelectPrefInfo *pSysSelectPrefInfo)

System Selection Preference Callback function

Parameters:
pSysSelectPrefInfo 
  • Current System Selection preferences for the device.
  • See sysSelectPrefInfo for more information
typedef void(* tFNtransLayerInfo)(transLayerNotification *pTransLayerNotification)

Transport Layer Information callback.

Parameters:
transLayerNotification 
typedef void(* tFNtransNWRegInfo)(transNWRegInfoNotification *pTransNWRegInfoNotification)

Transport Network Registration Information callback.

Parameters:
pTransNWRegInfoNotification 
typedef void(* tFNUIMRefresh)(UIMRefreshEvent *pUIMRefreshEvent)

UIM Refresh Callback function

Parameters:
pUIMRefreshEvent 
  • Pointer to Refresh Event structure.
  • See UIMRefreshEvent for more information
typedef void( * tFNUIMStatusChangeInfo)(UIMStatusChangeInfo *pUIMStatusChangeInfo)

UIM Status Change Callback function

Parameters:
pUIMStatusChangeInfo 
typedef void(* tFNUSSDNotification)(ULONG type, BYTE *pNetworkInfo)

SetUSSDNotificationCallback function prototype

Parameters:
type - Notification type

  • 0x01 - No action required
  • 0x02 - Action required
pNetworkInfo 
  • USS information from the network (0 indicates that no info was received)
Note:
Technology Supported: UMTS
typedef void(* tFNUSSDRelease)(void)

USSD releasecallback function prototype

Note:
Technology Supported: UMTS

Contains the parameters passed for SLQSSetTransLayerInfoCallback by the device.

Parameters:
regInd 
  • Indicates whether the transport layer is registered or not
  • Values:
    • 0x00 - Transport layer is not registered
    • 0x01 - Transport layer is registered
pTransLayerInfo 
Note:
None

Contains the parameters passed for SLQSSetTransNWRegInfoCallback by the device.

Parameters:
NWRegStat 
  • provides the transport network registration information
  • Values:
    • 0x00 - No Service
    • 0x01 - In Progress
    • 0x02 - Failed
    • 0x03 - Limited Service
    • 0x04 - Full Service
Note:
None

Enumeration Type Documentation

Device State enumeration

Enumerator:
DEVICE_STATE_DISCONNECTED 
DEVICE_STATE_READY 
DEVICE_STATE_BOOT 

The QMI service information which is exposed to the application, only the services which are relevant to multiple PDP are listed in this enumeration as these are the only required services to be exposed.

Enumerator:
eQA_QMI_SVC_WDS 
eQA_QMI_SVC_NAS 
eQA_QMI_SVC_NA 

This enumeration defines the different type of SMS events that are received

Enumerator:
SMS_EVENT_MT_MESSAGE 
SMS_EVENT_TRANSFER_ROUTE_MT_MESSAGE 
SMS_EVENT_MESSAGE_MODE 
SMS_EVENT_ETWS 
SMS_EVENT_ETWS_PLMN 
SMS_EVENT_SMSC_ADDRESS 
SMS_EVENT_SMS_ON_IMS 

Function Documentation

ULONG iSetCATEventCallback ( tFNCATEvent  pCallback  ) 
ULONG iSetSignalStrengthCallback ( tFNSignalStrength  pCallback  ) 
ULONG iSLQSSetSignalStrengthsCallback ( tFNSLQSSignalStrengths  pCallback  ) 
ULONG iSLQSSetWdsFirstInstEventCallback ( tFNSLQSWDSEvent  pCallback  ) 
ULONG iSLQSSetWdsSecondInstEventCallback ( tFNSLQSWDSEvent  pCallback  ) 
ULONG iSLQSSetWdsThirdInstEventCallback ( tFNSLQSWDSEvent  pCallback  ) 
ULONG SetActivationStatusCallback ( tFNActivationStatus  pCallback  ) 

Enables/disables the Activation Status callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • Callback function pointer (0 - disable)
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
ULONG SetCATEventCallback ( tFNCATEvent  pCallback,
ULONG  eventMask,
ULONG pErrorMask 
)

Enables/disables the CAT event callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • Callback function pointer (0 - Disable)
eventMask 
  • bitmask of CAT events to register for
    • 0x00000001 - Display Text
    • 0x00000002 - Get In-Key
    • 0x00000004 - Get Input
    • 0x00000008 - Setup Menu
    • 0x00000010 - Select Item
    • 0x00000020 - Send SMS - Alpha Identifier
    • 0x00000040 - Setup Event: User Activity
    • 0x00000080 - Setup Event: Idle Screen Notify
    • 0x00000100 - Setup Event: Language Sel Notify
    • 0x00000200 - Setup Idle Mode Text
    • 0x00000400 - Language Notification
    • 0x00000800 - Refresh
    • 0x00001000 - End Proactive Session
pErrorMask[OUT] 
  • error bitmask. Each bit set indicates the proactive command that caused the error
    • 0x00000001 - Display Text
    • 0x00000002 - Get In-Key
    • 0x00000004 - Get Input
    • 0x00000008 - Setup Menu
    • 0x00000010 - Select Item
    • 0x00000020 - Send SMS - Alpha Identifier
    • 0x00000040 - Setup Event: User Activity
    • 0x00000080 - Setup Event: Idle Screen Notify
    • 0x00000100 - Setup Event: Language Sel Notify
    • 0x00000200 - Setup Idle Mode Text
    • 0x00000400 - Language Notification
    • 0x00000800 - Refresh
    • 0x00001000 - End Proactive Session
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
Note:
Technology Supported: UMTS
Timeout: 2 seconds
ULONG SetDataCapabilitiesCallback ( tFNDataCapabilities  pCallback  ) 

Enables/disables the data capabilities callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • Callback function pointer (0 - disable)
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
Note:
Does not require communication with the device
ULONG SetDeviceStateChangeCbk ( tFNDeviceStateChange  pCallback  ) 

Used by the client application to register a Callback function for Device State Change (DSC) event notifications. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • a valid function pointer to be notified of DSC events
  • NULL to disable DSC event notification
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
ULONG SetFwDldCompletionCbk ( tFNFwDldCompletion  pCallback  ) 

Used by the client application to register a Callback function for a Firmware Download Completion (FDC) event notification. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • a valid function pointer to enable FDC event notification
  • NULL to disable FDC event notification
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
Note:
Timeout: N/A
ULONG SetLURejectCallback ( tFNLUReject  pCallback  ) 

Enables/disables the LU reject callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • Callback function pointer (0 - disable)
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
Note:
Timeout: 2 seconds
ULONG SetMobileIPStatusCallback ( tFNMobileIPStatus  pCallback  ) 

Enables/disables the Mobile IP Status callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • Callback function pointer (0 - disable)
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
Note:
Technology Supported: CDMA
Timeout: 2 seconds
ULONG SetNetChangeCbk ( BYTE  instance,
tFNNet  pCallback,
ULONG  loMark,
ULONG  hiMark,
ULONG  period 
)

Used by the client application to register a Callback function for USB Transmit Queue Length Change event notifications. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
instance[IN] 
  • PDP instance
pCallback[IN] 
  • a valid function pointer to be notified of the event
  • NULL to disable the event notification
loMark[IN] 
  • Transmit queue length smaller will trigger unthrottle event notification
hiMark[IN] 
  • Transmit queue length larger will trigger throttle event notification
period[IN] 
  • monitoring period in seconds, minimum 1 second
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
ULONG SetNewSMSCallback ( tFNNewSMS  pCallback  ) 

Enables/disables the new SMS callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • Callback function pointer (0 - Disable)
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
Note:
Timeout: 2 seconds
ULONG SetNMEACallback ( tFNNewNMEA  pCallback  ) 

Enables/disables the NMEA sentence callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • Callback function pointer (0 - Disable)
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
ULONG SetOMADMStateCallback ( tFNOMADMState  pCallback  ) 

Enables/disables the OMADM state callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • a valid function pointer to enable OMADMState notification
  • NULL to disable OMADMState notification
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
Note:
Technology Supported: CDMA
Timeout: 2 seconds
ULONG SetPDSStateCallback ( tFNPDSState  pCallback  ) 

Enables/disables the PDS service state callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • Callback function pointer (0 - Disable)
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
ULONG SetPowerCallback ( tFNPower  pCallback  ) 

Enables/disables the Operating Mode callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • Callback function pointer (0 - disable)
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
Note:
Timeout: 2 seconds
ULONG SetRFInfoCallback ( tFNRFInfo  pCallback  ) 

Enables/disables the radio frequency information callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • Callback function pointer (0 - Disable)
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
Note:
Timeout: 2 seconds
ULONG SetRoamingIndicatorCallback ( tFNRoamingIndicator  pCallback  ) 

Enables/disables the Roaming Indicator callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • Callback function pointer (0 - disable)
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
Note:
Timeout: 2 seconds
ULONG SetSignalStrengthCallback ( tFNSignalStrength  pCallback,
BYTE  thresholdsSize,
INT8 pThresholds 
)

Enables/disables the Signal Strength callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • Callback function pointer (0-Disable)
thresholdsSize 
  • Number of elements threshold array contains; a maximum of five thresholds is supported;
  • This parameter is not used when disabling the callback.
pThresholds[IN] 
  • Signal threshold array for each entry (in dBm).
  • This parameter is not used when disabling the callback.
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
Note:
Timeout: 2 seconds
The signal strength callback function is called when a threshold in the threshold array is crossed.
ULONG SetSLQSOMADMAlertCallback ( tFNSLQSOMADMAlert  pCallback  ) 

Enables/disables the SWIOMADM network-initiated alert callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • a valid function pointer to enable SLQSOMADMAlert notification
  • NULL to disable SLQSOMADMAlert notification
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
ULONG SetUSSDNotificationCallback ( tFNUSSDNotification  pCallback  ) 

Enables/disables the USSDNotification callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • a valid function pointer to enable ServingSystem notification
  • NULL to disable ServingSystem notification
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
Note:
Technology Supported: UMTS
Timeout: Does not require communication with device
ULONG SetUSSDReleaseCallback ( tFNUSSDRelease  pCallback  ) 

Enables/disables the USSD release callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • a valid function pointer to enable ServingSystem notification
  • NULL to disable ServingSystem notification
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
Note:
Technology Supported: UMTS
Timeout: Does not require communication with the device
ULONG SLQSNasNetworkTimeCallBack ( tFNNetworkTime  pCallback  ) 

Enables/disables the Network Time callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • Callback function pointer (0-Disable)
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
Note:
Timeout: 2 seconds
This callback is sent when the 3GPP or 3GPP2 network sends time information to the User Equipment.
ULONG SLQSNasSigInfoCallBack ( tFNSigInfo  pCallback  ) 

Enables/disables the Signal Info callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • Callback function pointer (0-Disable)
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
Note:
Timeout: 2 seconds
This callback is sent when the signal strength change occurs
ULONG SLQSNasSysInfoCallBack ( tFNSysInfo  pCallback  ) 

Enables/disables the Sys Info callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • Callback function pointer (0-Disable)
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
Note:
Timeout: 2 seconds
This callback provides current serving system information, including registration information and system property. The serving system information of the radio interfaces specified in mode_pref are included in the response message. When any value in the sys_info message changes, an indication message is sent. Indications contain all the values for all active RATs.
ULONG SLQSSetBandPreferenceCbk ( tFNBandPreference  pCallback  ) 

Enables/disables the Band Preference callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • a valid function pointer to enable Band Preference Indication notification
  • NULL to disable Band Preference notification
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
Note:
Timeout: NA To set the band preference the API SLQSSetBandPreference() should be used
ULONG SLQSSetIMSSMSConfigCallback ( tFNImsSMSConfig  pCallback  ) 

Enables/disables the SMS Config callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • Callback function pointer (0-Disable)
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
Note:
Timeout: 2 seconds
ULONG SLQSSetIMSUserConfigCallback ( tFNImsUserConfig  pCallback  ) 

Enables/disables the User Config callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • Callback function pointer (0-Disable)
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
Note:
Timeout: 2 seconds
ULONG SLQSSetIMSVoIPConfigCallback ( tFNImsVoIPConfig  pCallback  ) 

Enables/disables the VoIP Config callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • Callback function pointer (0-Disable)
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
Note:
Timeout: 2 seconds
ULONG SLQSSetModemTempCallback ( tFNModemTempInfo  pCallback  ) 

Enables/disables the Modem Temperature information callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • Callback function pointer (0-Disable)
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
Note:
Timeout: 5 seconds
ULONG SLQSSetPacketSrvStatusCallback ( tFNPacketSrvState  pCallback  ) 

Enables/disables the session state callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • Callback function pointer (0 - disable)
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
Note:
Timeout: none; does not require communication with the device
ULONG SLQSSetQosEventCallback ( BYTE  instance,
tFNSLQSQOSEvent  pCallback 
)

Enables/disables the QoS event callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs. This callback provide extra information regarding the QoS flow state

Parameters:
[in] instance 
  • QMI instance
[in] pCallback 
  • Callback function pointer (0 - disable)
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
ULONG SLQSSetQosNWStatusCallback ( tFNQosNWStatus  pCallback  ) 

Enables/disables the QoS event callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs. This callback provide extra information regarding the QoS Network supports status

Parameters:
[in] pCallback[IN] 
  • Callback function pointer (0 - disable)
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
ULONG SLQSSetQosPriEventCallback ( tFNQosPriEvent  pCallback  ) 

Enables/disables the QoS event callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs. This callback provide extra information regarding the QoS Primary flow event

Parameters:
[in] pCallback 
  • Callback function pointer (0 - disable)
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
ULONG SLQSSetQosStatusCallback ( BYTE  instance,
tFNQosStatus  pCallback 
)

Enables/disables the QoS event callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs. This callback provide extra information regarding the QoS status

Parameters:
[in] instance 
  • QMI instance
[in] pCallback[IN] 
  • Callback function pointer (0 - disable)
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
ULONG SLQSSetRegMgrConfigCallback ( tFNImsRegMgrConfig  pCallback  ) 

Enables/disables the Reg Mgr Config callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • Callback function pointer (0-Disable)
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
Note:
Timeout: 2 seconds
ULONG SLQSSetSDKTerminatedCallback ( tFNSDKTerminated  pCallback  ) 

Used by the client application to register a Callback function for SDK terminated event notifications. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • a valid function pointer to be notified of SWI events
  • NULL to disable SWI event notification
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
Note:
Technology Supported: N/A
Device Supported: N/A
Timeout: N/A
The following signals will trigger this callback:
          2 INT      4 ILL      5 TRAP     6 ABRT     7 BUS
          8 FPE     11 SEGV    13 PIPE    15 TERM    31 SYS
 
ULONG SLQSSetServingSystemCallback ( tFNServingSystem  pCallback  ) 

Enables/disables the Serving System callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • a valid function pointer to enable ServingSystem notification
  • NULL to disable ServingSystem notification
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
ULONG SLQSSetSessionStateCallback ( tFNSLQSSessionState  pCallback  ) 

Enables/disables the session state callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs. This callback provide extra information regarding the multiple PDP interface

Parameters:
pCallback[IN] 
  • Callback function pointer (0 - disable)
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
Note:
Timeout: none; does not require communication with the device
ULONG SLQSSetSignalStrengthsCallback ( tFNSLQSSignalStrengths  pCallback,
struct SLQSSignalStrengthsIndReq pSLQSSignalStrengthsIndReq 
)

Enables/disables the Received Signal Strength Information callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • Callback function pointer (0-Disable)
pSLQSSignalStrengthsIndReq 
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
Note:
Timeout: 2 seconds
The signal strength callback function is called when a threshold in the threshold array is crossed.
ULONG SLQSSetSIPConfigCallback ( tFNImsSIPConfig  pCallback  ) 

Enables/disables the SIP Config callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • Callback function pointer (0-Disable)
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
Note:
Timeout: 2 seconds
ULONG SLQSSetSMSEventCallback ( tFNSMSEvents  pCallback  ) 

Enables/disables the events related to SMS callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • Callback function pointer (0 - Disable)
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
ULONG SLQSSetSwiHDRPersCallback ( tFNHDRPersonaity  pCallback  ) 

Enables/disables the HDR Personality callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • Callback function pointer (0-Disable)
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
Note:
Technology Supported: CDMA
Timeout: 5 seconds
ULONG SLQSSetSysSelectionPrefCallBack ( tFNSysSelectionPref  pCallback  ) 

Enables/disables the System Selection Preference callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • a valid function pointer to enable System Selection Preference Indication notification
  • NULL to disable Band Preference notification
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
Note:
Timeout: 2 seconds
To set the system selection preferences the API SLQSSetSysSelectionPref() should be used
ULONG SLQSSetTransLayerInfoCallback ( tFNtransLayerInfo  pCallback  ) 

Enables/disables the Transport Layer information callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • Callback function pointer (0-Disable)
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
Note:
Timeout: 2 seconds
ULONG SLQSSetTransNWRegInfoCallback ( tFNtransNWRegInfo  pCallback  ) 

Enables/disables the Transport Network Registration information callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • Callback function pointer (0-Disable)
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
Note:
Timeout: 2 seconds
ULONG SLQSSetWdsEventCallback ( tFNSLQSWDSEvent  pCallback,
BYTE  interval,
BYTE  instanceid 
)

Enables/disables the WDS event callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs. This callback provide extra information regarding the multiple PDP interface

Parameters:
pCallback[IN] 
  • Callback function pointer (0 - disable)
interval 
  • Interval in seconds.
  • ignored when disabling, should be non-zero when enabling
instanceid 
  • PDP Instanceid 0 - First PDP insatnce 1 - Second PDP insatcne 2 - Third PDP instance
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
Note:
Timeout: 2 seconds Currently 3 PDP instances are supported in device. user of this callback can subscribe by passing instanceid of particular instance. All PDP instance can be subscribed by passing instanceid sequentially.
ULONG SLQSUIMSetRefreshCallBack ( tFNUIMRefresh  pCallback  ) 

Enables/disables the UIM refresh callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • a valid function pointer to enable UIM Refresh Indication notification
  • NULL to disable Band Preference notification
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
Note:
Timeout: 2 seconds
SLQSUIMRefreshRegister() API should be invoked prior to the invocation of the callback for the events to be registered.
ULONG SLQSUIMSetStatusChangeCallBack ( tFNUIMStatusChangeInfo  pCallback  ) 

Enables/disables the UIM Status Change Callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • a valid function pointer to enable UIM Status Change Indication notification
  • NULL to disable Band Preference notification
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
Note:
Timeout: 2 seconds
ULONG SLQSVoiceInfoRecCallback ( tFNInfoRec  pCallback  ) 

Enables/disables the Voice information Record callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs. (Applicable only for 3GPP2)

Parameters:
pCallback[IN] 
  • Callback function pointer (0-Disable)
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
Note:
Technology Supported: CDMA
Timeout: 2 seconds
ULONG SLQSVoiceSetAllCallStatusCallBack ( tFNAllCallStatus  pCallback  ) 

Enables/disables Voice Call Status Callback function. User can subscribe this callback get the call state change notifications. eg:- Call originated,connected, or ended. Whenever there is a change in the call information, there will be a indication with the information.

Parameters:
pCallback[IN] 
  • Callback function pointer (0 - Disable)
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
ULONG SLQSVoiceSetDTMFEventCallBack ( tFNDTMFEvent  pCallback  ) 

Enables/disables the DTMF Event callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • Callback function pointer (0-Disable)
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
Note:
Timeout: 2 seconds
This callback communicates that a DTMF event has been received.
ULONG SLQSVoiceSetOTASPStatusCallBack ( tFNOTASPStatus  pCallback  ) 

Enables/disables OTASP(Over-The-Air Service Provisioning) or OTAPA(Over-The-Air Parameter Administration) event CallBack Funtion (applicable only for 3GPP2). The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • a valid function pointer to enable OTASP or OTAPA event Indication notification
  • NULL to disable OTASP or OTAPA event, Indication notification
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
Note:
Technology Supported: CDMA
Timeout: 10 seconds
This indication communicates the occurrence of an OTASP or OTAPA event.This indication is only applicable for 3GPP2 devices.
ULONG SLQSVoiceSetPrivacyChangeCallBack ( tFNPrivacyChange  pCallback  ) 

Enables/disables the voice privacy change callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • Callback function pointer (0-Disable)
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
Note:
Technology Supported: CDMA
Timeout: 2 seconds
This callback communicates a change in the voice privacy of a call. This is applicable only in 3GPP2 devices.
ULONG SLQSVoiceSetSUPSCallBack ( tFNSUPSInfo  pCallback  ) 

Enables/disables the SUPS callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • Callback function pointer (0-Disable)
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
Note:
Technology Supported: GSM
Timeout: 2 seconds
This callback notifies clients about the modem-originated supplementary service requests and the responses received from the network.
ULONG SLQSVoiceSetSUPSNotificationCallback ( tFNSUPSNotification  pCallback  ) 

Enables/disables the supplementary service notification callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • Callback function pointer (0-Disable)
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
Note:
Timeout: 2 seconds
ULONG SLQSWmsMemoryFullCallBack ( tFNMemoryFull  pCallback  ) 

Enables/disables the event related to memory full status callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • Callback function pointer (0-Disable)
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values
ULONG SLQSWmsMessageWaitingCallBack ( tFNMessageWaiting  pCallback  ) 

Enables/disables the event related to message waiting information callback function. The most recent successfully subscribed callback function will be the only function that is invoked when the corresponding event occurs.

Parameters:
pCallback[IN] 
  • Callback function pointer (0-Disable)
Returns:
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See also:
See qmerrno.h for eQCWWAN_xxx error values

Copyright (c) 2011 Sierra Wireless, Inc. All rights reserved