| CE Gobi SDK 2.14 GobiApi

- Main Page
- Modules
- Classes
- Files

- File List

GobiConnectionMgmtAPI.h
1 /*===========================================================================
2 FILE:
3 GobiConnectionMgmtAPI.h
4
5 DESCRIPTION:
6 QUALCOMM Connection Management API for Gobi 3000
7
8 Copyright (C) 2011 QUALCOMM Incorporated. All rights reserved.
9 QUALCOMM Proprietary/GTDR
10
11 All data and information contained in or disclosed by this document is
12 confidential and proprietary information of QUALCOMM Incorporated and all
13 rights therein are expressly reserved. By accepting this material the
14 recipient agrees that this material and the information contained therein
15 is held in confidence and in trust and will not be used, copied, reproduced
16 in whole or in part, nor its contents revealed in any manner to others
17 without the express written permission of QUALCOMM Incorporated.
18 ==========================================================================*/
19 #ifndef GobiConnectionMgmtAPI_H
20 #define GobiConnectionMgmtAPI_H
21 /*=========================================================================*/
22 // Definitions
23 /*=========================================================================*/
24 #ifdef GOBIAPI_EXPORTS
25 #define IMPORTGOBI extern "C" __declspec( dllexport )
26 #else //GOBIAPI_EXPORTS
27 #ifdef __cplusplus
28 /* C++ callable DLL */
29 #define IMPORTGOBI extern "C" __declspec( dllimport )
30 #else
31 /* C callable DLL */
32 #define IMPORTGOBI __declspec( dllimport )
33 #endif
34 #endif //GOBIAPI_EXPORTS
35
36 // Calling convention for API
37 #define GOBICALLBACK __stdcall
38 #define GOBICMAPI __stdcall
39
44
45
46 #ifdef __cplusplus
47 extern "C" {
48 #endif
49
50 #define MAX_CDMA_SYS_INFO_MNC 3
51 #define MAX_CDMA_SYS_INFO_MCC 3
52 #define MAX_HDR_SYS_INFO_IS856SID 16
53 #define MAX_GSM_SYS_INFO_MCC 3
54 #define MAX_GSM_SYS_INFO_MNC 3
55 #define MAX_WCDMA_SYS_INFO_MCC 3
56 #define MAX_WCDMA_SYS_INFO_MNC 3
57 #define MAX_LTE_SYS_INFO_MCC 3
58 #define MAX_LTE_SYS_INFO_MNC 3
59 #define MAX_TDSCDMA_SYS_INFO_MCC 3
60 #define MAX_TDSCDMA_SYS_INFO_MNC 3
61 #define MAX_MCC 3
62 #define MAX_IMSI_11_12 2
63 #define MAX_IMSI_S1 7
64 #define MAX_IMSI_S2 3
65
82 typedef struct
83 {
84 BYTE mcc_m[MAX_MCC];
85 BYTE imsi_m_11_12[MAX_IMSI_11_12];
86 BYTE imsi_m_s1[MAX_IMSI_S1];
87 BYTE imsi_m_s2[MAX_IMSI_S2];
88 } MinBasedImsi;
89
110 typedef struct
111 {
112 BYTE mcc_t[MAX_MCC];
113 BYTE imsi_t_11_12[MAX_IMSI_11_12];
114 BYTE imsi_t_s1[MAX_IMSI_S1];
115 BYTE imsi_t_s2[MAX_IMSI_S2];
116 BYTE imsi_t_addr_num;
117 } TrueImsi;
118
119 typedef struct
120 {
121 BYTE srvDomainValid;
122 BYTE srvDomain;
123 BYTE srvCapValid;
124 BYTE srvCap;
125 BYTE roamStatusValid;
126 BYTE roamStatus;
127 BYTE isSysForbiddenValid;
128 BYTE isSysForbidden;
129 BYTE isSysPrlMatchValid;
130 BYTE isSysPrlMatch;
131 BYTE pRevInUseValid;
132 BYTE pRevInUse;
133 BYTE bsPRevValid;
134 BYTE bsPRev;
135 BYTE ccsSupportedValid;
136 BYTE ccsSupported;
137 BYTE cdmaSysIdValid;
138 WORD sid;
139 WORD nid;
140 BYTE bsInfoValid;
141 WORD baseId;
142 ULONG baseLat;
143 ULONG baseLong;
144 BYTE packetZoneValid;
145 WORD packetZone;
146 BYTE networkIdValid;
147 CHAR mcc[MAX_CDMA_SYS_INFO_MCC];
148 CHAR mnc[MAX_CDMA_SYS_INFO_MNC];
149 } CdmaSystemInfo;
150
151 typedef struct
152 {
153 BYTE srvDomainValid;
154 BYTE srvDomain;
155 BYTE srvCapValid;
156 BYTE srvCap;
157 BYTE roamStatusValid;
158 BYTE roamStatus;
159 BYTE isSysForbiddenValid;
160 BYTE isSysForbidden;
161 BYTE isSysPrlMatchValid;
162 BYTE isSysPrlMatch;
163 BYTE hdrPersonalityValid;
164 BYTE hdrPersonality;
165 BYTE hdrActiveProtValid;
166 BYTE hdrActiveProt;
167 BYTE is856SysIdValid;
168 BYTE is856SysId[MAX_HDR_SYS_INFO_IS856SID];
169 } HdrSystemInfo;
170
171 typedef struct
172 {
173 BYTE srvDomainValid;
174 BYTE srvDomain;
175 BYTE srvCapValid;
176 BYTE srvCap;
177 BYTE roamStatusValid;
178 BYTE roamStatus;
179 BYTE isSysForbiddenValid;
180 BYTE isSysForbidden;
181 BYTE lacValid;
182 WORD lac;
183 BYTE cellIdValid;
184 ULONG cellId;
185 BYTE regRejectInfoValid;
186 BYTE regRejectSrvDomain;
187 BYTE rejectCause;
188 BYTE networkIdValid;
189 CHAR mcc[MAX_GSM_SYS_INFO_MCC];
190 CHAR mnc[MAX_GSM_SYS_INFO_MNC];
191 BYTE egprsSuppValid;
192 BYTE egprsSupp;
193 BYTE dtmSuppValid;
194 BYTE dtmSupp;
195 } GsmSystemInfo;
196
197 typedef struct
198 {
199 BYTE srvDomainValid;
200 BYTE srvDomain;
201 BYTE srvCapValid;
202 BYTE srvCap;
203 BYTE roamStatusValid;
204 BYTE roamStatus;
205 BYTE isSysForbiddenValid;
206 BYTE isSysForbidden;
207 BYTE lacValid;
208 WORD lac;
209 BYTE cellIdValid;
210 ULONG cellId;
211 BYTE regRejectInfoValid;
212 BYTE regRejectSrvDomain;
213 BYTE rejectCause;
214 BYTE networkIdValid;
215 CHAR mcc[MAX_WCDMA_SYS_INFO_MCC];
216 CHAR mnc[MAX_WCDMA_SYS_INFO_MNC];
217 BYTE hsCallStatusValid;
218 BYTE hsCallStatus;
219 BYTE hsIndValid;
220 BYTE hsInd;
221 BYTE pscValid;
222 WORD psc;
223 } WcdmaSystemInfo;
224
225 typedef struct
226 {
227 BYTE srvDomainValid;
228 BYTE srvDomain;
229 BYTE srvCapValid;
230 BYTE srvCap;
231 BYTE roamStatusValid;
232 BYTE roamStatus;
233 BYTE isSysForbiddenValid;
234 BYTE isSysForbidden;
235 BYTE lacValid;
236 WORD lac;
237 BYTE cellIdValid;
238 ULONG cellId;
239 BYTE regRejectInfoValid;
240 BYTE regRejectSrvDomain;
241 BYTE rejectCause;
242 BYTE networkIdValid;
243 CHAR mcc[MAX_LTE_SYS_INFO_MCC];
244 CHAR mnc[MAX_LTE_SYS_INFO_MNC];
245 BYTE tacValid;
246 WORD tac;
247 } LteSystemInfo;
248
249 typedef struct
250 {
251 BYTE srvDomainValid;
252 BYTE srvDomain;
253 BYTE srvCapValid;
254 BYTE srvCap;
255 BYTE roamStatusValid;
256 BYTE roamStatus;
257 BYTE isSysForbiddenValid;
258 BYTE isSysForbidden;
259 BYTE lacValid;
260 WORD lac;
261 BYTE cellIdValid;
262 ULONG cellId;
263 BYTE regRejectInfoValid;
264 BYTE regRejectSrvDomain;
265 BYTE rejectCause;
266 BYTE networkIdValid;
267 CHAR mcc[MAX_TDSCDMA_SYS_INFO_MCC];
268 CHAR mnc[MAX_TDSCDMA_SYS_INFO_MNC];
269 BYTE hsCallStatusValid;
270 BYTE hsCallStatus;
271 BYTE hsIndValid;
272 BYTE hsInd;
273 BYTE cellParameterIdValid;
274 WORD cellParameterId;
275 BYTE cellBroadcastCapValid;
276 ULONG cellBroadcastCap;
277 BYTE csBarStatusValid;
278 ULONG csBarStatus;
279 BYTE psBarStatusValid;
280 ULONG psBarStatus;
281 BYTE cipherDomainValid;
282 BYTE cipherDomain;
283 } TdscdmaSystemInfo;
284
285 typedef struct
286 {
287 ULONG PilotType;
288 WORD PilotPn;
289 WORD PilotStrength;
290 } HrpdPilot;
291
292 typedef struct
293 {
294 BYTE isRadioTuned;
295 LONG rxPwr;
296 LONG ecio;
297 LONG rscp;
298 LONG rsrp;
299 LONG phase;
300 } RxInfo;
301
302 typedef struct
303 {
304 BYTE isInTraffic;
305 LONG txPwr;
306 } TxInfo;
307
308 struct SWI_STRUCT_ServingSystem
309 {
311 ULONG nVersion;
312
323 ULONG nRegistrationState;
324
329 ULONG nCsAttachState;
330
335 ULONG nPsAttachState;
336
341 ULONG nSelectedNetwork;
342
344 ULONG nNumOfRadioIf;
345
354 ULONG nRadioIf[255];
355
362 ULONG nRoamingIndicator;
363
365 BYTE nDataCapabilityListLen;
366
381 ULONG nDataCapabilities[255];
382
385 WORD nMobileCountryCode;
386
389 WORD nMobileNetworkCode;
390
393 ULONG nNetworkDescriptionLength;
394
396 CHAR NetworkDescription[255];
397
398 SWI_STRUCT_ServingSystem()
399 {
400 nVersion = 2;
401 memset( &nRadioIf[0], 0, sizeof(ULONG) * 255 );
402 memset( &nDataCapabilities[0], 0, sizeof(ULONG) * 255);
403 memset( &NetworkDescription[0], 0, sizeof(NetworkDescription));
404 }
405 };
406
407 // Session state callback function
408 typedef void (GOBICALLBACK * tFNSessionState)(
409 ULONG state,
410 ULONG sessionEndReason );
411
412 // RX/TX byte counts callback function
413 typedef void (GOBICALLBACK * tFNByteTotals)(
414 ULONGLONG totalBytesTX,
415 ULONGLONG totalBytesRX );
416
417 // Dormancy status callback function
418 typedef void (GOBICALLBACK * tFNDormancyStatus)( ULONG dormancyStatus );
419
420 // Mobile IP status callback function
421 // MIPStatus:status of the last MIP call(or attempt)
422 // see RFC2002 IP MObility Support for more information
423 typedef void (GOBICALLBACK * tFNMobileIPStatus)( ULONG mipStatus );
424
425 // Activation status callback function
426 typedef void (GOBICALLBACK * tFNActivationStatus)( ULONG activationStatus );
427
428 // Power operating mode callback function
429 typedef void (GOBICALLBACK * tFNPower)( ULONG operatingMode );
430
431 // Wireless disable callback function
432 typedef void (GOBICALLBACK * tFNWirelessDisable)( ULONG bState );
433
434 // Serving system callback function
435 typedef void (GOBICALLBACK * tFNServingSystem)(
436 BYTE registrationState,
437 BYTE csAttachState,
438 BYTE psAttachState,
439 BYTE selectedNetwork,
440 BYTE inUseRadioIfListNum,
441 BYTE * pRadioIf );
442
443 // Serving system Current PLMN callback function
444 typedef void (GOBICALLBACK * tFNCurrentPlmn)(
445 WORD mobileCountryCode,
446 WORD mobileNetworkCode,
447 BYTE networkDescriptionLength,
448 CHAR * pNetworkDescription );
449
450 // Serving system info callback function (struct containing serving system, current plmn data capability and romaing indicator)
451 typedef void (GOBICALLBACK * tFNSwiServingSystemInfo)(
452 SWI_STRUCT_ServingSystem * pServingSystemInfo );
453
454 // Serving system data capabilities callback function
455 typedef void (GOBICALLBACK * tFNDataCapabilities)(
456 BYTE dataCapsSize,
457 BYTE * pDataCaps );
458
459
460
461 // Data bearer technology callback function
462 typedef void (GOBICALLBACK * tFNDataBearer)( ULONG dataBearer );
463
464 // Roaming indicator callback function
465 typedef void (GOBICALLBACK * tFNRoamingIndicator)( ULONG roaming );
466
467 // Signal strength callback function
468 typedef void (GOBICALLBACK * tFNSignalStrength)(
469 INT8 signalStrength,
470 ULONG radioInterface );
471
472 // RF information callback function
473 typedef void (GOBICALLBACK * tFNRFInfo)(
474 ULONG radioInterface,
475 ULONG activeBandClass,
476 ULONG activeChannel );
477
478 // LU reject callback function
479 typedef void (GOBICALLBACK * tFNLUReject)(
480 ULONG serviceDomain,
481 ULONG rejectCause );
482
483 // PLMN mode callback function
484 typedef void (GOBICALLBACK * tFNPLMNMode)( ULONG mode );
485
486 // New SMS message callback function
487 typedef void (GOBICALLBACK * tFNNewSMS)(
488 ULONG storageType,
489 ULONG messageIndex );
490
491 typedef void (GOBICALLBACK * tFNNewSMSCB)(
492 BYTE ackIndicator,
493 ULONG transactionId,
494 BYTE format,
495 USHORT length,
496 BYTE* rawData );
497
498 typedef void (GOBICALLBACK * tFNMsgWaitingCB)(
499 BYTE numInstances,
500 BYTE* msgType,
501 BYTE* indStatus,
502 BYTE* msgCount);
503
504 // New NMEA sentence callback function
505 typedef void (GOBICALLBACK * tFNNewNMEA)( LPCSTR pNMEA );
506
507 // PDS session state callback function
508 typedef void (GOBICALLBACK * tFNPDSState)(
509 ULONG enabledStatus,
510 ULONG trackingStatus );
511
512 // CAT event callback function
513 typedef void (GOBICALLBACK * tFNCATEvent)(
514 ULONG eventID,
515 ULONG eventLen,
516 BYTE * pEventData );
517
518 // OMA-DM network initiated alert callback function
519 typedef void (GOBICALLBACK * tFNOMADMAlert)(
520 ULONG sessionType,
521 USHORT sessionID );
522
523 // OMA-DM state callback function
524 typedef void (GOBICALLBACK * tFNOMADMState)(
525 ULONG sessionState,
526 ULONG failureReason );
527
528
529
530
531
532
533 // Network Time callback function
534 typedef void (GOBICALLBACK * tFNNetworkTime)(
535 WORD m_year,
536 BYTE m_month,
537 BYTE m_day,
538 BYTE m_hour,
539 BYTE m_minute,
540 BYTE m_second,
541 BYTE m_dayOfWeek,
542 BYTE m_timeZone,
543 BYTE m_dayLightAdj
544 );
545
546 typedef void (GOBICALLBACK * tFNSystemSelectionPref)(BYTE * Mode);
547
548 #ifdef __cplusplus
549 };
550 #endif
551
552 /*=========================================================================*/
553 // Prototypes
554 /*=========================================================================*/
555
556
557 // End of GCM group
559 #endif
SWI_STRUCT_ServingSystem::NetworkDescription
CHAR NetworkDescription[255]
Definition: GobiConnectionMgmtAPI.h:396
SWI_STRUCT_ServingSystem::nRadioIf
ULONG nRadioIf[255]
Definition: GobiConnectionMgmtAPI.h:354
SWI_STRUCT_ServingSystem::nPsAttachState
ULONG nPsAttachState
Definition: GobiConnectionMgmtAPI.h:335
SWI_STRUCT_ServingSystem::nDataCapabilities
ULONG nDataCapabilities[255]
Definition: GobiConnectionMgmtAPI.h:381
SWI_STRUCT_ServingSystem::nRegistrationState
ULONG nRegistrationState
Definition: GobiConnectionMgmtAPI.h:323
TxInfo
Definition: GobiConnectionMgmtAPI.h:302
HrpdPilot
Definition: GobiConnectionMgmtAPI.h:285
SWI_STRUCT_ServingSystem::nNumOfRadioIf
ULONG nNumOfRadioIf
Definition: GobiConnectionMgmtAPI.h:344
TrueImsi
Definition: GobiConnectionMgmtAPI.h:110
SWI_STRUCT_ServingSystem
Definition: GobiConnectionMgmtAPI.h:308
CdmaSystemInfo
Definition: GobiConnectionMgmtAPI.h:119
SWI_STRUCT_ServingSystem::nRoamingIndicator
ULONG nRoamingIndicator
Definition: GobiConnectionMgmtAPI.h:362
SWI_STRUCT_ServingSystem::nNetworkDescriptionLength
ULONG nNetworkDescriptionLength
Definition: GobiConnectionMgmtAPI.h:393
SWI_STRUCT_ServingSystem::nVersion
ULONG nVersion
Definition: GobiConnectionMgmtAPI.h:311
SWI_STRUCT_ServingSystem::nMobileCountryCode
WORD nMobileCountryCode
Definition: GobiConnectionMgmtAPI.h:385
GsmSystemInfo
Definition: GobiConnectionMgmtAPI.h:171
HdrSystemInfo
Definition: GobiConnectionMgmtAPI.h:151
MinBasedImsi
Definition: GobiConnectionMgmtAPI.h:82
SWI_STRUCT_ServingSystem::nSelectedNetwork
ULONG nSelectedNetwork
Definition: GobiConnectionMgmtAPI.h:341
SWI_STRUCT_ServingSystem::nCsAttachState
ULONG nCsAttachState
Definition: GobiConnectionMgmtAPI.h:329
SWI_STRUCT_ServingSystem::nDataCapabilityListLen
BYTE nDataCapabilityListLen
Definition: GobiConnectionMgmtAPI.h:365
RxInfo
Definition: GobiConnectionMgmtAPI.h:292
TdscdmaSystemInfo
Definition: GobiConnectionMgmtAPI.h:249
WcdmaSystemInfo
Definition: GobiConnectionMgmtAPI.h:197
LteSystemInfo
Definition: GobiConnectionMgmtAPI.h:225
SWI_STRUCT_ServingSystem::nMobileNetworkCode
WORD nMobileNetworkCode
Definition: GobiConnectionMgmtAPI.h:389