| CE Gobi SDK 2.7 GobiApi

- Main Page
- Modules
- Classes
- Files

- File List

QmiNAS.h
1 /*===========================================================================
2 FILE:
3 QmiNASAPI.h
4
5 DESCRIPTION:
6 Gobi Network Access Service APIs
7
8 Copyright (C) 2015 Sierra Wireless Incorporated. All rights reserved.
9 Sierra Wireless Proprietary/GTDR
10 ==========================================================================*/
11
12 #ifndef __GOBI_NAS_API_H__
13 #define __GOBI_NAS_API_H__
14 /*=========================================================================*/
15 // Definitions
16 /*=========================================================================*/
17
22
23 /*=========================================================================*/
24 // Structs
25 /*=========================================================================*/
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29
30 #ifdef __cplusplus
31 };
32 #endif
33
34 /*=========================================================================*/
35 // Prototypes
36 /*=========================================================================*/
37
38 //TLV 0x01 of QMI_NAS_SERVING_SYSTEM_IND 0x0024
39 IMPORTGOBI ULONG GOBICMAPI SetServingSystemCallback(
40 tFNServingSystem pCallback );
41
42 //QMI_NAS_SERVING_SYSTEM_IND 0x0024
43 //Serving system info callback function (struct containing serving system, current plmn data capability and romaing indicator)
44 IMPORTGOBI ULONG GOBICMAPI SwiSetServingSystemInfoCallback(
45 tFNSwiServingSystemInfo pCallback );
46
47 //TLV 0x12 of QMI_NAS_SERVING_SYSTEM_IND 0x0024
48 IMPORTGOBI ULONG GOBICMAPI SetCurrentPlmnCallback(
49 tFNCurrentPlmn pCallback );
50
51 //QMI_NAS_SET_3GPP2_SUBSCRIPTION_INFO 0x003F
52 IMPORTGOBI ULONG GOBICMAPI Set3Gpp2SubscriptionInfo(
53 BYTE* pNamId,
54 MinBasedImsi* pMinBasedImsi,
55 TrueImsi* pTrueImsi,
56 BYTE* pMdnLen,
57 BYTE* pMdn
58 );
59
60 //QMI_NAS_GET_3GPP2_SUBSCRIPTION_INFO 0x003E
61 IMPORTGOBI ULONG GOBICMAPI Get3Gpp2SubscriptionInfo(
62 BYTE* pNamId,
63 MinBasedImsi* pMinBasedImsi,
64 TrueImsi* pTrueImsi,
65 BYTE* pMdnLen,
66 BYTE* pMdn
67 );
68
69 //QMI_NAS_SET_DDTM_PREFERENCE 0x0037
70 IMPORTGOBI ULONG GOBICMAPI SetDdtmPreference(
71 BYTE ddtmPref,
72 WORD ddtmAction,
73 BYTE soListAction, //string array with fixed size of 16
74 BYTE numSoInstances, //also as input buffer size
75 WORD* pArrServiceOption
76 );
77
78 //QMI_NAS_GET_SYS_INFO 0x004D
79 IMPORTGOBI ULONG GOBICMAPI GetSysInfo(
80 CdmaSystemInfo* pCdmaSystemInfo,
81 HdrSystemInfo* pHdrSystemInfo,
82 GsmSystemInfo* pGsmSystemInfo,
83 WcdmaSystemInfo* pWcdmaSystemInfo,
84 LteSystemInfo* pLteSystemInfo,
85 TdscdmaSystemInfo* pTdscdmaSystemInfo);
86
87 //QMI_NAS_GET_ERR_RATE 0x0052
88 IMPORTGOBI ULONG GOBICMAPI GetErrRate(
89 WORD* pCdmaFrameErrorRate,
90 WORD* pHdrPacketErrorRate,
91 BYTE* pGsmBitErrorRate,
92 BYTE* pWcdmaBlockErrorRate,
93 BYTE* pTdscdmaBlockErrorRate
94 );
95
96
97 //QMI_NAS_GET_HDR_COLOR_CODE 0x0057
98 IMPORTGOBI ULONG GOBICMAPI GetHdrColorCode(
99 BYTE* pColorCode
100 );
101
102 //QMI_NAS_GET_TX_RX_INFO 0x005A
103 IMPORTGOBI ULONG GOBICMAPI GetTxRxInfo(
104 BYTE radioIf,
105 RxInfo* pRxInfoCh0,
106 RxInfo* pRxInfoCh1,
107 TxInfo* pTxInfo
108 );
109
110 //QMI_NAS_SWI_GET_HRPD_STATS 0x5561
111 IMPORTGOBI ULONG GOBICMAPI SwiGetHrpdStats(
112 BYTE* pDrcValue,
113 BYTE* pDrcCover,
114 BYTE* pArrUati, //string array with fixed size of 16
115 BYTE* pNumOfPilot, //also as input buffer size
116 HrpdPilot* pHrpdPilot
117 );
118
119
120 //QMI_NAS_SWI_GET_CDMA_DOMINANT_PN 0x7560
121 IMPORTGOBI ULONG GOBICMAPI SwiGetCdmaDominantPn(
122 WORD* p1xDominantPn,
123 WORD* pDoDominantPn
124 );
125
136 IMPORTGOBI ULONG GOBICMAPI SetPLMNModeCallback( tFNPLMNMode pCallback );
137
153 IMPORTGOBI ULONG GOBICMAPI SetSignalStrengthCallback(
154 tFNSignalStrength pCallback,
155 BYTE thresholdsSize,
156 INT8 * pThresholds );
157
167 IMPORTGOBI ULONG GOBICMAPI SetLURejectCallback( tFNLUReject pCallback );
168
179 IMPORTGOBI ULONG GOBICMAPI SetRFInfoCallback( tFNRFInfo pCallback );
180
192 IMPORTGOBI ULONG GOBICMAPI SetRoamingIndicatorCallback(
193 tFNRoamingIndicator pCallback );
194
206 IMPORTGOBI ULONG GOBICMAPI SetDataCapabilitiesCallback(
207 tFNDataCapabilities pCallback );
208
209
227 IMPORTGOBI ULONG GOBICMAPI GetHomeNetwork(
228 WORD * pMCC,
229 WORD * pMNC,
230 BYTE nameSize,
231 CHAR * pName,
232 WORD * pSID,
233 WORD * pNID );
234
246 IMPORTGOBI ULONG GOBICMAPI SetNetworkPreference(
247 ULONG technologyPref,
248 ULONG duration );
249
263 IMPORTGOBI ULONG GOBICMAPI GetNetworkPreference(
264 ULONG * pTechnologyPref,
265 ULONG * pDuration,
266 ULONG * pPersistentTechnologyPref );
267
284 IMPORTGOBI ULONG GOBICMAPI SetCDMANetworkParameters(
285 CHAR * pSPC,
286 BYTE * pForceRev0,
287 BYTE * pCustomSCP,
288 ULONG * pProtocol,
289 ULONG * pBroadcast,
290 ULONG * pApplication,
291 ULONG * pRoaming );
292
313 IMPORTGOBI ULONG GOBICMAPI GetCDMANetworkParameters(
314 BYTE * pSCI,
315 BYTE * pSCM,
316 BYTE * pRegHomeSID,
317 BYTE * pRegForeignSID,
318 BYTE * pRegForeignNID,
319 BYTE * pForceRev0,
320 BYTE * pCustomSCP,
321 ULONG * pProtocol,
322 ULONG * pBroadcast,
323 ULONG * pApplication,
324 ULONG * pRoaming );
325
336 IMPORTGOBI ULONG GOBICMAPI GetACCOLC( BYTE * pACCOLC );
337
351 IMPORTGOBI ULONG GOBICMAPI SetACCOLC(
352 CHAR * pSPC,
353 BYTE accolc );
354
365 IMPORTGOBI ULONG GOBICMAPI GetPLMNMode( ULONG * pMode );
366
383 IMPORTGOBI ULONG GOBICMAPI GetPLMNName(
384 USHORT mcc,
385 USHORT mnc,
386 ULONG * pNamesSize,
387 BYTE * pNames );
388
403 IMPORTGOBI ULONG GOBICMAPI GetRFInfo(
404 BYTE * pInstanceSize,
405 BYTE * pInstances );
406
420 IMPORTGOBI ULONG GOBICMAPI PerformNetworkScan(
421 BYTE * pInstanceSize,
422 BYTE * pInstances );
423
443 IMPORTGOBI ULONG GOBICMAPI PerformNetworkRATScan(
444 BYTE * pInstanceSize,
445 BYTE * pInstances,
446 BYTE * pRATSize,
447 BYTE * pRATInstances );
448
462 IMPORTGOBI ULONG GOBICMAPI InitiateNetworkRegistration(
463 ULONG regType,
464 WORD mcc,
465 WORD mnc,
466 ULONG rat );
467
480 IMPORTGOBI ULONG GOBICMAPI InitiateDomainAttach( ULONG action );
481
510 IMPORTGOBI ULONG GOBICMAPI GetServingNetwork(
511 ULONG * pRegistrationState,
512 ULONG * pCSDomain,
513 ULONG * pPSDomain,
514 ULONG * pRAN,
515 BYTE * pRadioIfacesSize,
516 BYTE * pRadioIfaces,
517 ULONG * pRoaming,
518 WORD * pMCC,
519 WORD * pMNC,
520 BYTE nameSize,
521 CHAR * pName );
522
538 IMPORTGOBI ULONG GOBICMAPI GetServingNetworkCapabilities(
539 BYTE * pDataCapsSize,
540 BYTE * pDataCaps );
541
552 IMPORTGOBI ULONG GOBICMAPI GetANAAAAuthenticationStatus( ULONG * pStatus );
553
570 IMPORTGOBI ULONG GOBICMAPI GetSignalStrengths(
571 ULONG * pArraySizes,
572 INT8 * pSignalStrengths,
573 ULONG * pRadioInterfaces );
574 // End of NAS group
576 #endif
SetLURejectCallback
IMPORTGOBI ULONG GOBICMAPI SetLURejectCallback(tFNLUReject pCallback)
SetDataCapabilitiesCallback
IMPORTGOBI ULONG GOBICMAPI SetDataCapabilitiesCallback(tFNDataCapabilities pCallback)
GetCDMANetworkParameters
IMPORTGOBI ULONG GOBICMAPI GetCDMANetworkParameters(BYTE *pSCI, BYTE *pSCM, BYTE *pRegHomeSID, BYTE *pRegForeignSID, BYTE *pRegForeignNID, BYTE *pForceRev0, BYTE *pCustomSCP, ULONG *pProtocol, ULONG *pBroadcast, ULONG *pApplication, ULONG *pRoaming)
SetSignalStrengthCallback
IMPORTGOBI ULONG GOBICMAPI SetSignalStrengthCallback(tFNSignalStrength pCallback, BYTE thresholdsSize, INT8 *pThresholds)
PerformNetworkRATScan
IMPORTGOBI ULONG GOBICMAPI PerformNetworkRATScan(BYTE *pInstanceSize, BYTE *pInstances, BYTE *pRATSize, BYTE *pRATInstances)
TxInfo
Definition: GobiConnectionMgmtAPI.h:302
HrpdPilot
Definition: GobiConnectionMgmtAPI.h:285
GetSignalStrengths
IMPORTGOBI ULONG GOBICMAPI GetSignalStrengths(ULONG *pArraySizes, INT8 *pSignalStrengths, ULONG *pRadioInterfaces)
GetANAAAAuthenticationStatus
IMPORTGOBI ULONG GOBICMAPI GetANAAAAuthenticationStatus(ULONG *pStatus)
TrueImsi
Definition: GobiConnectionMgmtAPI.h:110
CdmaSystemInfo
Definition: GobiConnectionMgmtAPI.h:119
InitiateDomainAttach
IMPORTGOBI ULONG GOBICMAPI InitiateDomainAttach(ULONG action)
SetACCOLC
IMPORTGOBI ULONG GOBICMAPI SetACCOLC(CHAR *pSPC, BYTE accolc)
GetACCOLC
IMPORTGOBI ULONG GOBICMAPI GetACCOLC(BYTE *pACCOLC)
SetCDMANetworkParameters
IMPORTGOBI ULONG GOBICMAPI SetCDMANetworkParameters(CHAR *pSPC, BYTE *pForceRev0, BYTE *pCustomSCP, ULONG *pProtocol, ULONG *pBroadcast, ULONG *pApplication, ULONG *pRoaming)
SetNetworkPreference
IMPORTGOBI ULONG GOBICMAPI SetNetworkPreference(ULONG technologyPref, ULONG duration)
SetPLMNModeCallback
IMPORTGOBI ULONG GOBICMAPI SetPLMNModeCallback(tFNPLMNMode pCallback)
GetServingNetwork
IMPORTGOBI ULONG GOBICMAPI GetServingNetwork(ULONG *pRegistrationState, ULONG *pCSDomain, ULONG *pPSDomain, ULONG *pRAN, BYTE *pRadioIfacesSize, BYTE *pRadioIfaces, ULONG *pRoaming, WORD *pMCC, WORD *pMNC, BYTE nameSize, CHAR *pName)
GetServingNetworkCapabilities
IMPORTGOBI ULONG GOBICMAPI GetServingNetworkCapabilities(BYTE *pDataCapsSize, BYTE *pDataCaps)
GsmSystemInfo
Definition: GobiConnectionMgmtAPI.h:171
HdrSystemInfo
Definition: GobiConnectionMgmtAPI.h:151
GetPLMNMode
IMPORTGOBI ULONG GOBICMAPI GetPLMNMode(ULONG *pMode)
MinBasedImsi
Definition: GobiConnectionMgmtAPI.h:82
InitiateNetworkRegistration
IMPORTGOBI ULONG GOBICMAPI InitiateNetworkRegistration(ULONG regType, WORD mcc, WORD mnc, ULONG rat)
SetRoamingIndicatorCallback
IMPORTGOBI ULONG GOBICMAPI SetRoamingIndicatorCallback(tFNRoamingIndicator pCallback)
GetPLMNName
IMPORTGOBI ULONG GOBICMAPI GetPLMNName(USHORT mcc, USHORT mnc, ULONG *pNamesSize, BYTE *pNames)
GetRFInfo
IMPORTGOBI ULONG GOBICMAPI GetRFInfo(BYTE *pInstanceSize, BYTE *pInstances)
RxInfo
Definition: GobiConnectionMgmtAPI.h:292
SetRFInfoCallback
IMPORTGOBI ULONG GOBICMAPI SetRFInfoCallback(tFNRFInfo pCallback)
TdscdmaSystemInfo
Definition: GobiConnectionMgmtAPI.h:249
PerformNetworkScan
IMPORTGOBI ULONG GOBICMAPI PerformNetworkScan(BYTE *pInstanceSize, BYTE *pInstances)
WcdmaSystemInfo
Definition: GobiConnectionMgmtAPI.h:197
LteSystemInfo
Definition: GobiConnectionMgmtAPI.h:225
GetNetworkPreference
IMPORTGOBI ULONG GOBICMAPI GetNetworkPreference(ULONG *pTechnologyPref, ULONG *pDuration, ULONG *pPersistentTechnologyPref)
GetHomeNetwork
IMPORTGOBI ULONG GOBICMAPI GetHomeNetwork(WORD *pMCC, WORD *pMNC, BYTE nameSize, CHAR *pName, WORD *pSID, WORD *pNID)