| CE Gobi SDK 2.7 GobiApi

- Main Page
- Modules
- Classes
- Files

- File List

QCWWANCMAPI2k.h
1 /*===========================================================================
2 FILE:
3 QCWWANCMAPI2k.h
4
5 DESCRIPTION:
6 QUALCOMM Wireless WAN Connection Manager API for Gobi 2000
7
8 Copyright (C) 2009 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
20 /*=========================================================================*/
21 // Definitions
22 /*=========================================================================*/
23 #ifdef GOBIAPI_EXPORTS
24 #define QCIMPORT2K extern "C" __declspec( dllexport )
25 #else //GOBIAPI_EXPORTS
26 #ifdef __cplusplus
27 /* C++ callable DLL */
28 #define QCIMPORT2K extern "C" __declspec( dllimport )
29 #else
30 /* C callable DLL */
31 #define QCIMPORT2K __declspec( dllimport )
32 #endif
33 #endif //GOBIAPI_EXPORTS
34
35 // Calling convention for API
36 #define QCCALLBACK2K __stdcall
37 #define QCWWANAPI2K __stdcall
38
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42
43 // Session state callback function
44 typedef void (QCCALLBACK2K * tFNSessionState)(
45 ULONG state,
46 ULONG sessionEndReason );
47
48 // RX/TX Packet counts callback function
49 typedef void (QCCALLBACK2K * tFNPacketTotals)(
50 ULONG totalPacketTX,
51 ULONG totalPacketRX );
52
53 // RX/TX byte counts callback function
54 typedef void (QCCALLBACK2K * tFNByteTotals)(
55 ULONGLONG totalBytesTX,
56 ULONGLONG totalBytesRX );
57
58 // Dormancy status callback function
59 typedef void (QCCALLBACK2K * tFNDormancyStatus)( ULONG dormancyStatus );
60
61 // Mobile IP status callback function
62 typedef void (QCCALLBACK2K * tFNMobileIPStatus)( ULONG mipStatus );
63
64 // Activation status callback function
65 typedef void (QCCALLBACK2K * tFNActivationStatus)( ULONG activationStatus );
66
67 // Power operating mode callback function
68 typedef void (QCCALLBACK2K * tFNPower)( ULONG operatingMode );
69
70 // Serving system data capabilities callback function
71 typedef void (QCCALLBACK2K * tFNDataCapabilities)(
72 BYTE dataCapsSize,
73 BYTE * pDataCaps );
74
75 // Data bearer technology callback function
76 typedef void (QCCALLBACK2K * tFNDataBearer)( ULONG dataBearer );
77
78 // Roaming indicator callback function
79 typedef void (QCCALLBACK2K * tFNRoamingIndicator)( ULONG roaming );
80
81 // Signal strength callback function
82 typedef void (QCCALLBACK2K * tFNSignalStrength)(
83 INT8 signalStrength,
84 ULONG radioInterface );
85
86 // RF information callback function
87 typedef void (QCCALLBACK2K * tFNRFInfo)(
88 ULONG radioInterface,
89 ULONG activeBandClass,
90 ULONG activeChannel );
91
92 // LU reject callback function
93 typedef void (QCCALLBACK2K * tFNLUReject)(
94 ULONG serviceDomain,
95 ULONG rejectCause );
96
97 // New SMS message callback function
98 typedef void (QCCALLBACK2K * tFNNewSMS)(
99 ULONG storageType,
100 ULONG messageIndex );
101
102 // New NMEA sentence callback function
103 typedef void (QCCALLBACK2K * tFNNewNMEA)( LPCSTR pNMEA );
104
105 // New NMEA sentence plus mode callback function
106 typedef void (QCCALLBACK2K * tFNNewNMEAPlus)(
107 LPCSTR pNMEA,
108 ULONG mode );
109
110 // PDS session state callback function
111 typedef void (QCCALLBACK2K * tFNPDSState)(
112 ULONG enabledStatus,
113 ULONG trackingStatus );
114
115 // CAT event callback function
116 typedef void (QCCALLBACK2K * tFNCATEvent)(
117 ULONG eventID,
118 ULONG eventLen,
119 BYTE * pEventData );
120
121 // OMA-DM network initiated alert callback function
122 typedef void (QCCALLBACK2K * tFNOMADMAlert)(
123 ULONG sessionType,
124 USHORT sessionID );
125
126 // OMA-DM state callback function
127 typedef void (QCCALLBACK2K * tFNOMADMState)(
128 ULONG sessionState,
129 ULONG failureReason );
130
131 // NAS PLMN mode state callback function
132 typedef void (QCCALLBACK2K * tFNPLMNMode)(ULONG mode);
133
134 #ifdef __cplusplus
135 };
136 #endif
137
138 /*=========================================================================*/
139 // Prototypes
140 /*=========================================================================*/
141
142 /*===========================================================================
143 METHOD:
144 QCWWAN2kEnumerateDevices
145
146 DESCRIPTION:
147 This function enumerates the QC WWAN devices currently attached to the
148 system
149
150 PARAMETERS:
151 pDevicesSize [I/O] - Upon input the maximum number of elements that the
152 device array can contain. Upon successful output
153 the actual number of elements in the device array
154 pDevices [ O ] - The device array
155
156 RETURN VALUE:
157 ULONG - Return code
158 ===========================================================================*/
159 QCIMPORT2K ULONG QCWWANAPI2K QCWWAN2kEnumerateDevices(
160 BYTE * pDevicesSize,
161 BYTE * pDevices );
162
163 /*===========================================================================
164 METHOD:
165 QCWWANConnect (Deprecated)
166
167 DESCRIPTION:
168 This function connects the CM API library to the first QC WWAN
169 device detected
170
171 RETURN VALUE:
172 ULONG - Return code
173 ===========================================================================*/
174 QCIMPORT2K ULONG QCWWANAPI2K QCWWANConnect();
175
176 /*===========================================================================
177 METHOD:
178 QCWWAN2kConnect
179
180 DESCRIPTION:
181 This function connects the CM API library to the specified QC WWAN
182 device
183
184 PARAMETERS:
185 pDeviceID [ I ] - The device ID as reported by Windows
186 pDeviceKey [ I ] - The device key (unique, stored on-device)
187
188 RETURN VALUE:
189 ULONG - Return code
190 ===========================================================================*/
191 QCIMPORT2K ULONG QCWWANAPI2K QCWWAN2kConnect(
192 CHAR * pDeviceID,
193 CHAR * pDeviceKey );
194
195 /*===========================================================================
196 METHOD:
197 QCWWANDisconnect
198
199 DESCRIPTION:
200 This function disconnects the CM API library from the currently
201 connected QC WWAN device
202
203 RETURN VALUE:
204 ULONG - Return code
205 ===========================================================================*/
206 QCIMPORT2K ULONG QCWWANAPI2K QCWWANDisconnect();
207
208 /*===========================================================================
209 METHOD:
210 QCWWANGetConnectedDeviceID (Deprecated)
211
212 DESCRIPTION:
213 This function returns the ID of the device the QC WWAN CM API library
214 is currently connected to
215
216 PARAMETERS:
217 stringSize [ I ] - The maximum number of characters (including NULL
218 terminator) that the string array can contain
219 pString [ O ] - NULL terminated string
220
221 RETURN VALUE:
222 ULONG - Return code
223 ===========================================================================*/
224 QCIMPORT2K ULONG QCWWANAPI2K QCWWANGetConnectedDeviceID(
225 ULONG stringSize,
226 CHAR * pString );
227
228 /*===========================================================================
229 METHOD:
230 QCWWAN2kGetConnectedDeviceID
231
232 DESCRIPTION:
233 This function returns the ID/key of the device the QC WWAN CM API library
234 is currently connected to
235
236 PARAMETERS:
237 deviceIDSize [ I ] - The maximum number of characters (including NULL
238 terminator) that the device ID array can contain
239 pDeviceID [ O ] - Device ID (NULL terminated string)
240 deviceKeySize [ I ] - The maximum number of characters (including NULL
241 terminator) that the device key array can contain
242 pDeviceKey [ O ] - Device key (NULL terminated string)
243
244 RETURN VALUE:
245 ULONG - Return code
246 ===========================================================================*/
247 QCIMPORT2K ULONG QCWWANAPI2K QCWWAN2kGetConnectedDeviceID(
248 ULONG deviceIDSize,
249 CHAR * pDeviceID,
250 ULONG deviceKeySize,
251 CHAR * pDeviceKey );
252
253 /*===========================================================================
254 METHOD:
255 GetSessionState
256
257 DESCRIPTION:
258 This function returns the state of the current packet data session
259
260 PARAMETERS:
261 pState [ O ] - State of the current packet session
262
263 RETURN VALUE:
264 ULONG - Return code
265 ===========================================================================*/
266 QCIMPORT2K ULONG QCWWANAPI2K GetSessionState( ULONG * pState );
267
268 /*===========================================================================
269 METHOD:
270 GetSessionDuration
271
272 DESCRIPTION:
273 This function returns the duration of the current packet data session
274
275 PARAMETERS:
276 pDuration [ O ] - Duration of the current packet session
277
278 RETURN VALUE:
279 ULONG - Return code
280 ===========================================================================*/
281 QCIMPORT2K ULONG QCWWANAPI2K GetSessionDuration( ULONGLONG * pDuration );
282
283 /*===========================================================================
284 METHOD:
285 GetDormancyState
286
287 DESCRIPTION:
288 This function returns the dormancy state of the current packet
289 data session (when connected)
290
291 PARAMETERS:
292 pState [ O ] - Dormancy state of the current packet session
293
294 RETURN VALUE:
295 ULONG - Return code
296 ===========================================================================*/
297 QCIMPORT2K ULONG QCWWANAPI2K GetDormancyState( ULONG * pState );
298
299 /*===========================================================================
300 METHOD:
301 GetAutoconnect
302
303 DESCRIPTION:
304 This function returns the current autoconnect data session setting
305
306 PARAMETERS:
307 pSetting [ O ] - NDIS autoconnect disabled (0) or enabled (1)
308
309 RETURN VALUE:
310 ULONG - Return code
311 ===========================================================================*/
312 QCIMPORT2K ULONG QCWWANAPI2K GetAutoconnect( ULONG * pSetting );
313
314 /*===========================================================================
315 METHOD:
316 SetAutoconnect
317
318 DESCRIPTION:
319 This function sets the autoconnect data session setting
320
321 PARAMETERS:
322 setting [ I ] - NDIS autoconnect disabled (0) or enabled (non-zero)
323
324 RETURN VALUE:
325 ULONG - Return code
326 ===========================================================================*/
327 QCIMPORT2K ULONG QCWWANAPI2K SetAutoconnect( ULONG setting );
328
329 /*===========================================================================
330 METHOD:
331 SetDefaultProfile
332
333 DESCRIPTION:
334 This function writes the default profile settings to the device, the
335 default profile is used during autoconnect
336
337 PARAMETERS:
338 profileType [ I ] - Profile type being written
339 pPDPType [ I ] - (Optional) PDP type
340 pIPAddress [ I ] - (Optional) Preferred assigned IPv4 address
341 pPrimaryDNS [ I ] - (Optional) Primary DNS IPv4 address
342 pSecondaryDNS [ I ] - (Optional) Secondary DNS IPv4 address
343 pAuthentication [ I ] - (Optional) Authentication algorithm bitmap
344 pName [ I ] - (Optional) The profile name or description
345 pAPNName [ I ] - (Optional) Access point name
346 pUsername [ I ] - (Optional) Username used during authentication
347 pPassword [ I ] - (Optional) Password used during authentication
348
349 RETURN VALUE:
350 ULONG - Return code
351 ===========================================================================*/
352 QCIMPORT2K ULONG QCWWANAPI2K SetDefaultProfile(
353 ULONG profileType,
354 ULONG * pPDPType,
355 ULONG * pIPAddress,
356 ULONG * pPrimaryDNS,
357 ULONG * pSecondaryDNS,
358 ULONG * pAuthentication,
359 CHAR * pName,
360 CHAR * pAPNName,
361 CHAR * pUsername,
362 CHAR * pPassword );
363
364 /*===========================================================================
365 METHOD:
366 GetDefaultProfile
367
368 DESCRIPTION:
369 This function reads the default profile settings from the device, the
370 default profile is used during autoconnect
371
372 PARAMETERS:
373 profileType [ I ] - Profile type being read
374 pPDPType [ O ] - PDP type
375 pIPAddress [ O ] - Preferred assigned IPv4 address
376 pPrimaryDNS [ O ] - Primary DNS IPv4 address
377 pSecondaryDNS [ O ] - Secondary DNS IPv4 address
378 pAuthentication [ O ] - Authentication algorithm bitmap
379 nameSize [ I ] - The maximum number of characters (including
380 NULL terminator) that the profile name array
381 can contain
382 pName [ O ] - The profile name or description
383 apnSize [ I ] - The maximum number of characters (including
384 NULL terminator) that the APN name array
385 can contain
386 pAPNName [ O ] - Access point name represented as a NULL
387 terminated string (empty string returned when
388 unknown)
389 userSize [ I ] - The maximum number of characters (including
390 NULL terminator) that the username array
391 can contain
392 pUsername [ O ] - Username used during authentication
393
394 RETURN VALUE:
395 ULONG - Return code
396 ===========================================================================*/
397 QCIMPORT2K ULONG QCWWANAPI2K GetDefaultProfile(
398 ULONG profileType,
399 ULONG * pPDPType,
400 ULONG * pIPAddress,
401 ULONG * pPrimaryDNS,
402 ULONG * pSecondaryDNS,
403 ULONG * pAuthentication,
404 BYTE nameSize,
405 CHAR * pName,
406 BYTE apnSize,
407 CHAR * pAPNName,
408 BYTE userSize,
409 CHAR * pUsername );
410
411 /*===========================================================================
412 METHOD:
413 StartDataSession/StartDataSession2
414
415 DESCRIPTION:
416 These functions activate a packet data session
417
418 PARAMETERS:
419 pTechnology [ I ] - (Optional) Technology bitmap
420 pPrimaryDNS [ I ] - (Optional) Primary DNS IPv4 address
421 pSecondaryDNS [ I ] - (Optional) Secondary DNS IPv4 address
422 pPrimaryNBNS [ I ] - (Optional) Primary NetBIOS NS IPv4 address
423 pSecondaryNBNS [ I ] - (Optional) Secondary NetBIOS NS IPv4 address
424 pAPNName [ I ] - (Optional) Access point name
425 pIPAddress [ I ] - (Optional) Preferred assigned IPv4 address
426 pAuthentication [ I ] - (Optional) Authentication algorithm bitmap
427 pUsername [ I ] - (Optional) Username used during authentication
428 pPassword [ I ] - (Optional) Password used during authentication
429 pSessionId [ O ] - The assigned session ID
430
431 pFailureReason [ O ] - Upon call failure the failure reason provided
432
433 RETURN VALUE:
434 ULONG - Return code
435 ===========================================================================*/
436 QCIMPORT2K ULONG QCWWANAPI2K StartDataSession(
437 ULONG * pTechnology,
438 ULONG * pPrimaryDNS,
439 ULONG * pSecondaryDNS,
440 ULONG * pPrimaryNBNS,
441 ULONG * pSecondaryNBNS,
442 CHAR * pAPNName,
443 ULONG * pIPAddress,
444 ULONG * pAuthentication,
445 CHAR * pUsername,
446 CHAR * pPassword,
447 ULONG * pSessionId );
448
449 QCIMPORT2K ULONG QCWWANAPI2K StartDataSession2(
450 ULONG * pTechnology,
451 ULONG * pPrimaryDNS,
452 ULONG * pSecondaryDNS,
453 ULONG * pPrimaryNBNS,
454 ULONG * pSecondaryNBNS,
455 CHAR * pAPNName,
456 ULONG * pIPAddress,
457 ULONG * pAuthentication,
458 CHAR * pUsername,
459 CHAR * pPassword,
460 ULONG * pSessionId,
461 ULONG * pFailureReason );
462
463 /*===========================================================================
464 METHOD:
465 StopDataSession
466
467 DESCRIPTION:
468 This function stops the current data session
469
470 PARAMETERS:
471 sessionId [ I ] - The ID of the session to terminate
472
473 RETURN VALUE:
474 ULONG - Return code
475 ===========================================================================*/
476 QCIMPORT2K ULONG QCWWANAPI2K StopDataSession( ULONG sessionId );
477
478 /*===========================================================================
479 METHOD:
480 GetIPAddress
481
482 DESCRIPTION:
483 This function returns the current packet data session IP address
484
485 PARAMETERS:
486 pIPAddress [ O ] - Assigned IPv4 address
487
488 RETURN VALUE:
489 ULONG - Return code
490 ===========================================================================*/
491 QCIMPORT2K ULONG QCWWANAPI2K GetIPAddress( ULONG * pIPAddress );
492
493 /*===========================================================================
494 METHOD:
495 GetConnectionRate
496
497 DESCRIPTION:
498 This function returns connection rate information for the packet data
499 connection
500
501 PARAMETERS:
502 pCurrentChannelTXRate [ O ] - Current channel TX rate (bps)
503 pCurrentChannelRXRate [ O ] - Current channel RX rate (bps)
504 pMaxChannelTXRate [ O ] - Maximum channel TX rate (bps)
505 pMaxChannelRXRate [ O ] - Maximum channel RX rate (bps)
506
507 RETURN VALUE:
508 ULONG - Return code
509 ===========================================================================*/
510 QCIMPORT2K ULONG QCWWANAPI2K GetConnectionRate(
511 ULONG * pCurrentChannelTXRate,
512 ULONG * pCurrentChannelRXRate,
513 ULONG * pMaxChannelTXRate,
514 ULONG * pMaxChannelRXRate );
515
516 /*===========================================================================
517 METHOD:
518 GetPacketStatus
519
520 DESCRIPTION:
521 This function returns the packet data transfer statistics since the start
522 of the current packet data session
523
524 PARAMETERS:
525 pTXPacketSuccesses [ O ] - Packets transmitted without error
526 pRXPacketSuccesses [ O ] - Packets received without error
527 pTXPacketErrors [ O ] - Outgoing packets with framing errors
528 pRXPacketErrors [ O ] - Incoming packets with framing errors
529 pTXPacketOverflows [ O ] - Packets dropped because TX buffer overflowed
530 pRXPacketOverflows [ O ] - Packets dropped because RX buffer overflowed
531
532 RETURN VALUE:
533 ULONG - Return code
534 ===========================================================================*/
535 QCIMPORT2K ULONG QCWWANAPI2K GetPacketStatus(
536 ULONG * pTXPacketSuccesses,
537 ULONG * pRXPacketSuccesses,
538 ULONG * pTXPacketErrors,
539 ULONG * pRXPacketErrors,
540 ULONG * pTXPacketOverflows,
541 ULONG * pRXPacketOverflows );
542
543 /*===========================================================================
544 METHOD:
545 GetByteTotals
546
547 DESCRIPTION:
548 This function returns the RX/TX byte counts since the start of the
549 current packet data session
550
551 PARAMETERS:
552 pTXTotalBytes [ O ] - Bytes transmitted without error
553 pRXTotalBytes [ O ] - Bytes received without error
554
555 RETURN VALUE:
556 ULONG - Return code
557 ===========================================================================*/
558 QCIMPORT2K ULONG QCWWANAPI2K GetByteTotals(
559 ULONGLONG * pTXTotalBytes,
560 ULONGLONG * pRXTotalBytes );
561
562 /*===========================================================================
563 METHOD:
564 SetMobileIP
565
566 DESCRIPTION:
567 This function sets the current mobile IP setting
568
569 PARAMETERS:
570 mode [ I ] - Desired mobile IP setting
571
572 RETURN VALUE:
573 ULONG - Return code
574 ===========================================================================*/
575 QCIMPORT2K ULONG QCWWANAPI2K SetMobileIP( ULONG mode );
576
577 /*===========================================================================
578 METHOD:
579 GetMobileIP
580
581 DESCRIPTION:
582 This function gets the current mobile IP setting
583
584 PARAMETERS:
585 pMode [ O ] - Current mobile IP setting
586
587 RETURN VALUE:
588 ULONG - Return code
589 ===========================================================================*/
590 QCIMPORT2K ULONG QCWWANAPI2K GetMobileIP( ULONG * pMode );
591
592 /*===========================================================================
593 METHOD:
594 SetActiveMobileIPProfile
595
596 DESCRIPTION:
597 This function sets the active mobile IP profile index
598
599 PARAMETERS:
600 pSPC [ I ] - Six digit service programming code
601 index [ I ] - Desired mobile IP profile index
602
603 RETURN VALUE:
604 ULONG - Return code
605 ===========================================================================*/
606 QCIMPORT2K ULONG QCWWANAPI2K SetActiveMobileIPProfile(
607 CHAR * pSPC,
608 BYTE index );
609
610 /*===========================================================================
611 METHOD:
612 GetActiveMobileIPProfile
613
614 DESCRIPTION:
615 This function gets the the active mobile IP profile index
616
617 PARAMETERS:
618 pIndex [ O ] - Active mobile IP profile index
619
620 RETURN VALUE:
621 ULONG - Return code
622 ===========================================================================*/
623 QCIMPORT2K ULONG QCWWANAPI2K GetActiveMobileIPProfile( BYTE * pIndex );
624
625 /*===========================================================================
626 METHOD:
627 SetMobileIPProfile
628
629 DESCRIPTION:
630 This function sets the specified mobile IP profile settings
631
632 PARAMETERS:
633 pSPC [ I ] - Six digit service programming code
634 index [ I ] - Mobile IP profile ID
635 pEnabled [ I ] - (Optional) Enable MIP profile?
636 pAddress [ I ] - (Optional) Home IPv4 address
637 pPrimaryHA [ I ] - (Optional) Primary home agent IPv4 address
638 pSecondaryHA [ I ] - (Optional) Secondary home agent IPv4 address
639 pRevTunneling [ I ] - (Optional) Enable reverse tunneling?
640 pNAI [ I ] - (Optional) Network access identifier string
641 pHASPI [ I ] - (Optional) HA security parameter index
642 pAAASPI [ I ] - (Optional) AAA security parameter index
643 pMNHA [ I ] - (Optional) MN-HA string
644 pMNAAA [ I ] - (Optional) MN-AAA string
645
646 RETURN VALUE:
647 ULONG - Return code
648 ===========================================================================*/
649 QCIMPORT2K ULONG QCWWANAPI2K SetMobileIPProfile(
650 CHAR * pSPC,
651 BYTE index,
652 BYTE * pEnabled,
653 ULONG * pAddress,
654 ULONG * pPrimaryHA,
655 ULONG * pSecondaryHA,
656 BYTE * pRevTunneling,
657 CHAR * pNAI,
658 ULONG * pHASPI,
659 ULONG * pAAASPI,
660 CHAR * pMNHA,
661 CHAR * pMNAAA );
662
663 /*===========================================================================
664 METHOD:
665 GetMobileIPProfile
666
667 DESCRIPTION:
668 This function gets the specified mobile IP profile settings
669
670 PARAMETERS:
671 index [ I ] - Mobile IP profile ID
672 pEnabled [ O ] - Mobile IP profile enabled?
673 pAddress [ O ] - Home IPv4 address
674 pPrimaryHA [ O ] - Primary home agent IPv4 address
675 pSecondaryHA [ O ] - Secondary home agent IPv4 address
676 pRevTunneling [ O ] - Reverse tunneling enabled?
677 naiSize [ I ] - The maximum number of characters (including NULL
678 terminator) that the NAI array can contain
679 pNAI [ O ] - Network access identifier string
680 pHASPI [ O ] - HA security parameter index
681 pAAASPI [ O ] - AAA security parameter index
682
683 RETURN VALUE:
684 ULONG - Return code
685 ===========================================================================*/
686 QCIMPORT2K ULONG QCWWANAPI2K GetMobileIPProfile(
687 BYTE index,
688 BYTE * pEnabled,
689 ULONG * pAddress,
690 ULONG * pPrimaryHA,
691 ULONG * pSecondaryHA,
692 BYTE * pRevTunneling,
693 BYTE naiSize,
694 CHAR * pNAI,
695 ULONG * pHASPI,
696 ULONG * pAAASPI );
697
698 /*===========================================================================
699 METHOD:
700 GetMobileIPProfile2
701
702 DESCRIPTION:
703 This function gets the specified mobile IP profile settings
704
705 PARAMETERS:
706 index [ I ] - Mobile IP profile ID
707 pEnabled [ O ] - Mobile IP profile enabled?
708 pAddress [ O ] - Home IPv4 address
709 pPrimaryHA [ O ] - Primary home agent IPv4 address
710 pSecondaryHA [ O ] - Secondary home agent IPv4 address
711 pRevTunneling [ O ] - Reverse tunneling enabled?
712 naiSize [ I ] - The maximum number of characters (including NULL
713 terminator) that the NAI array can contain
714 pNAI [ O ] - Network access identifier string
715 pHASPI [ O ] - HA security parameter index
716 pAAASPI [ O ] - AAA security parameter index
717 pHAState [ O ] - HA key state
718 pAAAState [ O ] - AAA key state
719
720 RETURN VALUE:
721 ULONG - Return code
722 ===========================================================================*/
723 QCIMPORT2K ULONG QCWWANAPI2K GetMobileIPProfile2(
724 BYTE index,
725 BYTE * pEnabled,
726 ULONG * pAddress,
727 ULONG * pPrimaryHA,
728 ULONG * pSecondaryHA,
729 BYTE * pRevTunneling,
730 BYTE naiSize,
731 CHAR * pNAI,
732 ULONG * pHASPI,
733 ULONG * pAAASPI,
734 ULONG * pHAState,
735 ULONG * pAAAState );
736
737 /*===========================================================================
738 METHOD:
739 SetMobileIPParameters
740
741 DESCRIPTION:
742 This function sets the specified mobile IP parameters
743
744 PARAMETERS:
745 pSPC [ I ] - Six digit service programming code
746 pMode [ I ] - (Optional) Desired mobile IP setting
747 pRetryLimit [ I ] - (Optional) Retry attempt limit
748 pRetryInterval [ I ] - (Optional) Retry attempt interval
749 pReRegPeriod [ I ] - (Optional) Re-registration period
750 pReRegTraffic [ I ] - (Optional) Re-registration only with traffic?
751 pHAAuthenticator [ I ] - (Optional) MH-HA authenticator calculator?
752 pHA2002bis [ I ] - (Optional) MH-HA RFC 2002bis authentication?
753
754 RETURN VALUE:
755 ULONG - Return code
756 ===========================================================================*/
757 QCIMPORT2K ULONG QCWWANAPI2K SetMobileIPParameters(
758 CHAR * pSPC,
759 ULONG * pMode,
760 BYTE * pRetryLimit,
761 BYTE * pRetryInterval,
762 BYTE * pReRegPeriod,
763 BYTE * pReRegTraffic,
764 BYTE * pHAAuthenticator,
765 BYTE * pHA2002bis );
766
767 /*===========================================================================
768 METHOD:
769 GetMobileIPParameters
770
771 DESCRIPTION:
772 This function gets the mobile IP parameters
773
774 PARAMETERS:
775 pMode [ O ] - Current mobile IP setting
776 pRetryLimit [ O ] - Retry attempt limit
777 pRetryInterval [ O ] - Retry attempt interval
778 pReRegPeriod [ O ] - Re-registration period
779 pReRegTraffic [ O ] - Re-registration only with traffic?
780 pHAAuthenticator [ O ] - MH-HA authenticator calculator?
781 pHA2002bis [ O ] - MH-HA RFC 2002bis authentication?
782
783 RETURN VALUE:
784 ULONG - Return code
785 ===========================================================================*/
786 QCIMPORT2K ULONG QCWWANAPI2K GetMobileIPParameters(
787 ULONG * pMode,
788 BYTE * pRetryLimit,
789 BYTE * pRetryInterval,
790 BYTE * pReRegPeriod,
791 BYTE * pReRegTraffic,
792 BYTE * pHAAuthenticator,
793 BYTE * pHA2002bis );
794
795 /*===========================================================================
796 METHOD:
797 GetLastMobileIPError
798
799 DESCRIPTION:
800 This function gets the last mobile IP error
801
802 PARAMETERS:
803 pError [ O ] - Last mobile IP error
804
805 RETURN VALUE:
806 ULONG - Return code
807 ===========================================================================*/
808 QCIMPORT2K ULONG QCWWANAPI2K GetLastMobileIPError( ULONG * pError );
809
810 /*===========================================================================
811 METHOD:
812 GetANAAAAuthenticationStatus
813
814 DESCRIPTION:
815 This function gets the AN-AAA authentication status
816
817 PARAMETERS:
818 pStatus [ O ] - AN-AAA authentication status
819
820 RETURN VALUE:
821 ULONG - Return code
822 ===========================================================================*/
823 QCIMPORT2K ULONG QCWWANAPI2K GetANAAAAuthenticationStatus( ULONG * pStatus );
824
825 /*===========================================================================
826 METHOD:
827 GetSignalStrength
828
829 DESCRIPTION:
830 This function gets the current signal strength (in dBm) as measured by
831 the device, the signal strength returned will be one of the currently
832 available technologies with preference CDMA 1xEV-DO, CDMA, AMPS,
833 WCDMA, GSM
834
835 PARAMETERS:
836 pSignalStrength [ O ] - Received signal strength (dBm)
837 pRadioInterface [ O ] - Radio interface technology
838
839 RETURN VALUE:
840 ULONG - Return code
841 ===========================================================================*/
842 QCIMPORT2K ULONG QCWWANAPI2K GetSignalStrength(
843 INT8 * pSignalStrength,
844 ULONG * pRadioInterface );
845
846 /*===========================================================================
847 METHOD:
848 GetSignalStrengths
849
850 DESCRIPTION:
851 This function gets the current available signal strengths (in dBm)
852 as measured by the device
853
854 PARAMETERS:
855 pArraySizes [I/O] - Upon input the maximum number of elements
856 that each array can contain can contain.
857 Upon successful output the actual number
858 of elements in each array
859 pSignalStrengths [ O ] - Received signal strength array (dBm)
860 pRadioInterfaces [ O ] - Radio interface technology array
861
862 RETURN VALUE:
863 ULONG - Return code
864 ===========================================================================*/
865 QCIMPORT2K ULONG QCWWANAPI2K GetSignalStrengths(
866 ULONG * pArraySizes,
867 INT8 * pSignalStrengths,
868 ULONG * pRadioInterfaces );
869
870 /*===========================================================================
871 METHOD:
872 GetRFInfo
873
874 DESCRIPTION:
875 This function gets the current RF information
876
877 PARAMETERS:
878 pInstanceSize [I/O] - Upon input the maximum number of elements that the
879 RF info instance array can contain. Upon success
880 the actual number of elements in the RF info
881 instance array
882 pInstances [ O ] - The RF info instance array
883
884 RETURN VALUE:
885 ULONG - Return code
886 ===========================================================================*/
887 QCIMPORT2K ULONG QCWWANAPI2K GetRFInfo(
888 BYTE * pInstanceSize,
889 BYTE * pInstances );
890
891 /*===========================================================================
892 METHOD:
893 PerformNetworkScan
894
895 DESCRIPTION:
896 This function performs a scan for available networks
897
898 PARAMETERS:
899 pInstanceSize [I/O] - Upon input the maximum number of elements that the
900 network info instance array can contain. Upon
901 success the actual number of elements in the
902 network info instance array. NOTE: The QMI message
903 returned from the modem contains a variable-length
904 network name component but the caller must provide
905 a fixed-size array of 255 bytes to store the contents
906 of this variable-length component. The number of
907 instances includes this array implicitly.
908 pInstances [ O ] - The network info instance array
909
910 RETURN VALUE:
911 ULONG - Return code
912 ===========================================================================*/
913 QCIMPORT2K ULONG QCWWANAPI2K PerformNetworkScan(
914 BYTE * pInstanceSize,
915 BYTE * pInstances );
916
917 /*===========================================================================
918 METHOD:
919 PerformNetworkRATScan
920
921 DESCRIPTION:
922 This function performs a scan for available networks (includes RAT)
923
924 PARAMETERS:
925 pInstanceSize [I/O] - Upon input the maximum number of elements that the
926 network info instance array can contain. Upon
927 success the actual number of elements in the
928 network info instance array. NOTE: The QMI message
929 returned from the modem contains a variable-length
930 network name component but the caller must provide
931 a fixed-size array of 255 bytes to store the contents
932 of this variable-length component. The number of
933 instances includes this array implicitly.
934 pInstances [ O ] - The network info instance array
935 pRATSize [I/O] - Upon input the maximum number of elements that the
936 RAT info instance array can contain. Upon success
937 the actual number of elements in the RAT info instance array
938 pRATInstances [ O ] - The RAT info instance array
939
940 RETURN VALUE:
941 ULONG - Return code
942 ===========================================================================*/
943 QCIMPORT2K ULONG QCWWANAPI2K PerformNetworkRATScan(
944 BYTE * pInstanceSize,
945 BYTE * pInstances,
946 BYTE * pRATSize,
947 BYTE * pRATInstances );
948
949 /*===========================================================================
950 METHOD:
951 InitiateNetworkRegistration
952
953 DESCRIPTION:
954 This function initiates a network registration
955
956 PARAMETERS:
957 regType [ I ] - Registration type
958 mcc [ I ] - Mobile country code (ignored for auto registration)
959 mnc [ I ] - Mobile network code (ignored for auto registration)
960 rat [ I ] - Radio access type (ignored for auto registration)
961
962 RETURN VALUE:
963 ULONG - Return code
964 ===========================================================================*/
965 QCIMPORT2K ULONG QCWWANAPI2K InitiateNetworkRegistration(
966 ULONG regType,
967 WORD mcc,
968 WORD mnc,
969 ULONG rat );
970
971 /*===========================================================================
972 METHOD:
973 InitiateDomainAttach
974
975 DESCRIPTION:
976 This function initiates a domain attach (or detach)
977
978 PARAMETERS:
979 action [ I ] - PS attach action (attach or detach)
980
981 RETURN VALUE:
982 ULONG - Return code
983 ===========================================================================*/
984 QCIMPORT2K ULONG QCWWANAPI2K InitiateDomainAttach( ULONG action );
985
986 /*===========================================================================
987 METHOD:
988 GetServingNetwork
989
990 DESCRIPTION:
991 Gets information regarding the system that currently provides service
992 to the device
993
994 PARAMETERS:
995 pRegistrationState [ O ] - Registration state
996 pCSDomain [ O ] - Circuit switch domain status
997 pPSDomain [ O ] - Packet switch domain status
998 pRAN [ O ] - Radio access network
999 pRadioIfacesSize [I/O] - Upon input the maximum number of elements
1000 that the radio interfaces can contain. Upon
1001 successful output the actual number of elements
1002 in the radio interface array
1003 pRadioIfaces [ O ] - The radio interface array
1004 pRoaming [ O ] - Roaming indicator (0xFFFFFFFF - Unknown)
1005 pMCC [ O ] - Mobile country code (0xFFFF - Unknown)
1006 pMNC [ O ] - Mobile network code (0xFFFF - Unknown)
1007 nameSize [ I ] - The maximum number of characters (including
1008 NULL terminator) that the network name array
1009 can contain
1010 pName [ O ] - The network name or description represented
1011 as a NULL terminated string (empty string
1012 returned when unknown)
1013
1014 RETURN VALUE:
1015 ULONG - Return code
1016 ===========================================================================*/
1017 QCIMPORT2K ULONG QCWWANAPI2K GetServingNetwork(
1018 ULONG * pRegistrationState,
1019 ULONG * pCSDomain,
1020 ULONG * pPSDomain,
1021 ULONG * pRAN,
1022 BYTE * pRadioIfacesSize,
1023 BYTE * pRadioIfaces,
1024 ULONG * pRoaming,
1025 WORD * pMCC,
1026 WORD * pMNC,
1027 BYTE nameSize,
1028 CHAR * pName );
1029
1030 /*===========================================================================
1031 METHOD:
1032 SWIGetServingNetwork
1033
1034 DESCRIPTION:
1035 Gets information regarding the system that currently provides service
1036 to the device
1037
1038 PARAMETERS:
1039 pRegistrationState [ O ] - Registration state
1040 pCSDomain [ O ] - Circuit switch domain status
1041 pPSDomain [ O ] - Packet switch domain status
1042 pRAN [ O ] - Radio access network
1043 pRadioIfacesSize [I/O] - Upon input the maximum number of elements
1044 that the radio interfaces can contain. Upon
1045 successful output the actual number of elements
1046 in the radio interface array
1047 pRadioIfaces [ O ] - The radio interface array
1048 pRoaming [ O ] - Roaming indicator (0xFFFFFFFF - Unknown)
1049 pMCC [ O ] - Mobile country code (0xFFFF - Unknown)
1050 pMNC [ O ] - Mobile network code (0xFFFF - Unknown)
1051 nameSize [ I ] - The maximum number of characters (including
1052 NULL terminator) that the network name array
1053 can contain
1054 pName [ O ] - The network name or description represented
1055 as a NULL terminated string (empty string
1056 returned when unknown)
1057 pSID [ O ] - CDMA System ID
1058 pNID [ O ] - CDMA Network ID
1059
1060 RETURN VALUE:
1061 ULONG - Return code
1062 ===========================================================================*/
1063 QCIMPORT2K ULONG QCWWANAPI2K SwiGetServingNetwork(
1064 ULONG * pRegistrationState,
1065 ULONG * pCSDomain,
1066 ULONG * pPSDomain,
1067 ULONG * pRAN,
1068 BYTE * pRadioIfacesSize,
1069 BYTE * pRadioIfaces,
1070 ULONG * pRoaming,
1071 WORD * pMCC,
1072 WORD * pMNC,
1073 BYTE nameSize,
1074 CHAR * pName,
1075 WORD* pSID,
1076 WORD* pNID);
1077
1078 /*===========================================================================
1079 METHOD:
1080 GetServingNetworkCapabilities
1081
1082 DESCRIPTION:
1083 Gets information regarding the data capabilities of the system that
1084 currently provides service to the device
1085
1086 PARAMETERS:
1087 pDataCapsSize [I/O] - Upon input the maximum number of elements that the
1088 data capabilities array can contain. Upon success
1089 the actual number of elements in the data
1090 capabilities array
1091 pDataCaps [ O ] - The data capabilities array
1092
1093 RETURN VALUE:
1094 ULONG - Return code
1095 ===========================================================================*/
1096 QCIMPORT2K ULONG QCWWANAPI2K GetServingNetworkCapabilities(
1097 BYTE * pDataCapsSize,
1098 BYTE * pDataCaps );
1099
1100 /*===========================================================================
1101 METHOD:
1102 GetDataBearerTechnology
1103
1104 DESCRIPTION:
1105 This function retrieves the current data bearer technology (only
1106 valid when connected)
1107
1108 PARAMETERS:
1109 pDataCaps [ O ] - The data bearer technology
1110
1111 RETURN VALUE:
1112 ULONG - Return code
1113 ===========================================================================*/
1114 QCIMPORT2K ULONG QCWWANAPI2K GetDataBearerTechnology( ULONG * pDataBearer );
1115
1116 /*===========================================================================
1117 METHOD:
1118 GetHomeNetwork
1119
1120 DESCRIPTION:
1121 This function retrieves information about the home network of the device
1122
1123 PARAMETERS:
1124 pMCC [ O ] - Mobile country code
1125 pMNC [ O ] - Mobile network code
1126 nameSize [ I ] - The maximum number of characters (including NULL
1127 terminator) that the network name array can contain
1128 pName [ O ] - The network name or description represented as a NULL
1129 terminated string (empty string returned when unknown)
1130 pSID [ O ] - Home network system ID (0xFFFF - Unknown)
1131 pNID [ O ] - Home network ID (0xFFFF - Unknown)
1132
1133 RETURN VALUE:
1134 ULONG - Return code
1135 ===========================================================================*/
1136 QCIMPORT2K ULONG QCWWANAPI2K GetHomeNetwork(
1137 WORD * pMCC,
1138 WORD * pMNC,
1139 BYTE nameSize,
1140 CHAR * pName,
1141 WORD * pSID,
1142 WORD * pNID );
1143
1144 /*===========================================================================
1145 METHOD:
1146 SetNetworkPreference
1147
1148 DESCRIPTION:
1149 This function sets the network registration preference
1150
1151 PARAMETERS:
1152 technologyPref [ I ] - Technology preference bitmap
1153 duration [ I ] - Duration of active preference
1154
1155 RETURN VALUE:
1156 ULONG - Return code
1157 ===========================================================================*/
1158 QCIMPORT2K ULONG QCWWANAPI2K SetNetworkPreference(
1159 ULONG technologyPref,
1160 ULONG duration );
1161
1162 /*===========================================================================
1163 METHOD:
1164 GetNetworkPreference
1165
1166 DESCRIPTION:
1167 This function returns the network registration preference
1168
1169 PARAMETERS:
1170 pTechnologyPref [ O ] - Technology preference bitmap
1171 pDuration [ O ] - Duration of active preference
1172 pPersistentTechnologyPref [ O ] - Persistent technology preference bitmap
1173
1174 RETURN VALUE:
1175 ULONG - Return code
1176 ===========================================================================*/
1177 QCIMPORT2K ULONG QCWWANAPI2K GetNetworkPreference(
1178 ULONG * pTechnologyPref,
1179 ULONG * pDuration,
1180 ULONG * pPersistentTechnologyPref );
1181
1182 /*===========================================================================
1183 METHOD:
1184 SetCDMANetworkParameters
1185
1186 DESCRIPTION:
1187 This function sets the desired CDMA network parameters
1188
1189 PARAMETERS:
1190 pSPC [ I ] - Six digit service programming code
1191 pForceRev0 [ I ] - (Optional) Force CDMA 1x-EV-DO Rev. 0 mode?
1192 pCustomSCP [ I ] - (Optional) Use a custom config for CDMA 1x-EV-DO SCP?
1193 pProtocol [ I ] - (Optional) Protocol mask for custom SCP config
1194 pBroadcast [ I ] - (Optional) Broadcast mask for custom SCP config
1195 pApplication [ I ] - (Optional) Application mask for custom SCP config
1196 pRoaming [ I ] - (Optional) Roaming preference
1197
1198 RETURN VALUE:
1199 ULONG - Return code
1200 ===========================================================================*/
1201 QCIMPORT2K ULONG QCWWANAPI2K SetCDMANetworkParameters(
1202 CHAR * pSPC,
1203 BYTE * pForceRev0,
1204 BYTE * pCustomSCP,
1205 ULONG * pProtocol,
1206 ULONG * pBroadcast,
1207 ULONG * pApplication,
1208 ULONG * pRoaming );
1209
1210 /*===========================================================================
1211 METHOD:
1212 GetCDMANetworkParameters
1213
1214 DESCRIPTION:
1215 This function gets the current CDMA network parameters
1216
1217 PARAMETERS:
1218 pSCI [ O ] - Slot cycle index
1219 pSCM [ O ] - Station class mark
1220 pRegHomeSID [ O ] - Register on home SID?
1221 pRegForeignSID [ O ] - Register on foreign SID?
1222 pRegForeignNID [ O ] - Register on foreign NID?
1223 pForceRev0 [ O ] - Force CDMA 1x-EV-DO Rev. 0 mode?
1224 pCustomSCP [ O ] - Use a custom config for CDMA 1x-EV-DO SCP?
1225 pProtocol [ O ] - Protocol mask for custom SCP config
1226 pBroadcast [ O ] - Broadcast mask for custom SCP config
1227 pApplication [ O ] - Application mask for custom SCP config
1228 pRoaming [ O ] - Roaming preference
1229
1230 RETURN VALUE:
1231 ULONG - Return code
1232 ===========================================================================*/
1233 QCIMPORT2K ULONG QCWWANAPI2K GetCDMANetworkParameters(
1234 BYTE * pSCI,
1235 BYTE * pSCM,
1236 BYTE * pRegHomeSID,
1237 BYTE * pRegForeignSID,
1238 BYTE * pRegForeignNID,
1239 BYTE * pForceRev0,
1240 BYTE * pCustomSCP,
1241 ULONG * pProtocol,
1242 ULONG * pBroadcast,
1243 ULONG * pApplication,
1244 ULONG * pRoaming );
1245
1246 /*===========================================================================
1247 METHOD:
1248 GetACCOLC
1249
1250 DESCRIPTION:
1251 This function returns the Access Overload Class (ACCOLC) of the device
1252
1253 PARAMETERS:
1254 pACCOLC [ O ] - The ACCOLC
1255
1256 RETURN VALUE:
1257 ULONG - Return code
1258 ===========================================================================*/
1259 QCIMPORT2K ULONG QCWWANAPI2K GetACCOLC( BYTE * pACCOLC );
1260
1261 /*===========================================================================
1262 METHOD:
1263 SetACCOLC
1264
1265 DESCRIPTION:
1266 This function sets the Access Overload Class (ACCOLC) of the device
1267
1268 PARAMETERS:
1269 pSPC [ I ] - NULL terminated string representing the six digit
1270 service programming code
1271 accolc [ I ] - The ACCOLC
1272
1273 RETURN VALUE:
1274 ULONG - Return code
1275 ===========================================================================*/
1276 QCIMPORT2K ULONG QCWWANAPI2K SetACCOLC(
1277 CHAR * pSPC,
1278 BYTE accolc );
1279
1280 /*===========================================================================
1281 METHOD:
1282 GetDeviceCapabilities
1283
1284 DESCRIPTION:
1285 This function gets device capabilities
1286
1287 PARAMETERS:
1288 pMaxTxChannelRate [ O ] - Maximum transmission rate (bps)
1289 pMaxRxChannelRate [ O ] - Maximum reception rate (bps)
1290 pDataServiceCapability [ O ] - CS/PS data service capability
1291 pSimCapability [ O ] - Device SIM support
1292 pRadioIfacesSize [I/O] - Upon input the maximum number of elements
1293 that the radio interfaces can contain.
1294 Upon successful output the actual number
1295 of elements in the radio interface array
1296 pRadioIfaces [ O ] - The radio interface array
1297
1298 RETURN VALUE:
1299 ULONG - Return code
1300 ===========================================================================*/
1301 QCIMPORT2K ULONG QCWWANAPI2K GetDeviceCapabilities(
1302 ULONG * pMaxTXChannelRate,
1303 ULONG * pMaxRXChannelRate,
1304 ULONG * pDataServiceCapability,
1305 ULONG * pSimCapability,
1306 ULONG * pRadioIfacesSize,
1307 BYTE * pRadioIfaces );
1308
1309 /*===========================================================================
1310 METHOD:
1311 GetManufacturer
1312
1313 DESCRIPTION:
1314 This function returns the device manufacturer name
1315
1316 PARAMETERS:
1317 stringSize [ I ] - The maximum number of characters (including NULL
1318 terminator) that the string array can contain
1319 pString [ O ] - NULL terminated string
1320
1321 RETURN VALUE:
1322 ULONG - Return code
1323 ===========================================================================*/
1324 QCIMPORT2K ULONG QCWWANAPI2K GetManufacturer(
1325 BYTE stringSize,
1326 CHAR * pString );
1327
1328 /*===========================================================================
1329 METHOD:
1330 GetModelID
1331
1332 DESCRIPTION:
1333 This function returns the device model ID
1334
1335 PARAMETERS:
1336 stringSize [ I ] - The maximum number of characters (including NULL
1337 terminator) that the string array can contain
1338 pString [ O ] - NULL terminated string
1339
1340 RETURN VALUE:
1341 ULONG - Return code
1342 ===========================================================================*/
1343 QCIMPORT2K ULONG QCWWANAPI2K GetModelID(
1344 BYTE stringSize,
1345 CHAR * pString );
1346
1347 /*===========================================================================
1348 METHOD:
1349 GetFirmwareRevision
1350
1351 DESCRIPTION:
1352 This function returns the device firmware revision
1353
1354 PARAMETERS:
1355 stringSize [ I ] - The maximum number of characters (including NULL
1356 terminator) that the string array can contain
1357 pString [ O ] - NULL terminated string
1358
1359 RETURN VALUE:
1360 ULONG - Return code
1361 ===========================================================================*/
1362 QCIMPORT2K ULONG QCWWANAPI2K GetFirmwareRevision(
1363 BYTE stringSize,
1364 CHAR * pString );
1365
1366 /*===========================================================================
1367 METHOD:
1368 GetFirmwareRevisions
1369
1370 DESCRIPTION:
1371 This function returns the device firmware (AMSS, boot, and PRI)
1372 revisions
1373
1374 PARAMETERS:
1375 amssSize [ I ] - The maximum number of characters (including NULL
1376 terminator) that the AMSS string array can contain
1377 pAMSSString [ O ] - NULL terminated AMSS revision string
1378 bootSize [ I ] - The maximum number of characters (including NULL
1379 terminator) that the boot string array can contain
1380 pBootString [ O ] - NULL terminated boot code revision string
1381 priSize [ I ] - The maximum number of characters (including NULL
1382 terminator) that the PRI string array can contain
1383 pPRIString [ O ] - NULL terminated PRI revision string
1384
1385 RETURN VALUE:
1386 ULONG - Return code
1387 ===========================================================================*/
1388 QCIMPORT2K ULONG QCWWANAPI2K GetFirmwareRevisions(
1389 BYTE amssSize,
1390 CHAR * pAMSSString,
1391 BYTE bootSize,
1392 CHAR * pBootString,
1393 BYTE priSize,
1394 CHAR * pPRIString );
1395
1396 /*===========================================================================
1397 METHOD:
1398 GetFirmwareInfo
1399
1400 DESCRIPTION:
1401 Returns image information obtained from the current device firmware
1402
1403 PARAMETERS:
1404 pFirmwareID [ O ] - Firmware ID obtained from the firmware image
1405 pTechnology [ O ] - Technology (0xFFFFFFFF if unknown)
1406 pCarrier [ O ] - Carrier (0xFFFFFFFF if unknown)
1407 pRegion [ O ] - Region (0xFFFFFFFF if unknown)
1408 pGPSCapability [ O ] - GPS capability (0xFFFFFFFF if unknown)
1409
1410 RETURN VALUE:
1411 ULONG - Return code
1412 ===========================================================================*/
1413 QCIMPORT2K ULONG QCWWANAPI2K GetFirmwareInfo(
1414 ULONG * pFirmwareID,
1415 ULONG * pTechnology,
1416 ULONG * pCarrier,
1417 ULONG * pRegion,
1418 ULONG * pGPSCapability );
1419
1420 /*===========================================================================
1421 METHOD:
1422 GetVoiceNumber
1423
1424 DESCRIPTION:
1425 This function returns the voice number in use by the device
1426
1427 PARAMETERS:
1428 voiceNumberSize [ I ] - The maximum number of characters (including NULL
1429 terminator) that the voice number array can
1430 contain
1431 pVoiceNumber [ O ] - Voice number (MDN or ISDN) string
1432 minSize [ I ] - The maximum number of characters (including NULL
1433 terminator) that the MIN array can contain
1434 pMIN [ O ] - MIN string (empty string returned when MIN is
1435 not supported/programmed)
1436
1437 RETURN VALUE:
1438 ULONG - Return code
1439 ===========================================================================*/
1440 QCIMPORT2K ULONG QCWWANAPI2K GetVoiceNumber(
1441 BYTE voiceNumberSize,
1442 CHAR * pVoiceNumber,
1443 BYTE minSize,
1444 CHAR * pMIN );
1445
1446 /*===========================================================================
1447 METHOD:
1448 GetIMSI
1449
1450 DESCRIPTION:
1451 This function returns the device IMSI
1452
1453 PARAMETERS:
1454 stringSize [ I ] - The maximum number of characters (including NULL
1455 terminator) that the string array can contain
1456 pString [ O ] - NULL terminated string
1457
1458 RETURN VALUE:
1459 ULONG - Return code
1460 ===========================================================================*/
1461 QCIMPORT2K ULONG QCWWANAPI2K GetIMSI(
1462 BYTE stringSize,
1463 CHAR * pString );
1464
1465 /*===========================================================================
1466 METHOD:
1467 GetSerialNumbers
1468
1469 DESCRIPTION:
1470 This command returns all serial numbers assigned to the device
1471
1472 PARAMETERS:
1473 esnSize [ I ] - The maximum number of characters (including NULL
1474 terminator) that the ESN array can contain
1475 pESNString [ O ] - ESN string (empty string returned when ESN is
1476 not supported/programmed)
1477 imeiSize [ I ] - The maximum number of characters (including NULL
1478 terminator) that the IMEI array can contain
1479 pIMEIString [ O ] - IMEI string (empty string returned when IMEI is
1480 not supported/programmed)
1481 meidSize [ I ] - The maximum number of characters (including NULL
1482 terminator) that the MEID array can contain
1483 pMEIDString [ O ] - MEID string (empty string returned when MEID is
1484 not supported/programmed)
1485
1486 RETURN VALUE:
1487 ULONG - Return code
1488 ===========================================================================*/
1489 QCIMPORT2K ULONG QCWWANAPI2K GetSerialNumbers(
1490 BYTE esnSize,
1491 CHAR * pESNString,
1492 BYTE imeiSize,
1493 CHAR * pIMEIString,
1494 BYTE meidSize,
1495 CHAR * pMEIDString );
1496
1497 /*===========================================================================
1498 METHOD:
1499 SetLock(depreciated)
1500
1501 DESCRIPTION:
1502 This function sets the user lock state maintained by the device
1503
1504 PARAMETERS:
1505 state [ I ] - Desired lock state
1506 pCurrentPIN [ I ] - Current four digit PIN string
1507
1508 RETURN VALUE:
1509 ULONG - Return code
1510 ===========================================================================*/
1511 QCIMPORT2K ULONG QCWWANAPI2K SetLock(
1512 ULONG state,
1513 CHAR * pCurrentPIN );
1514
1515 /*===========================================================================
1516 METHOD:
1517 QueryLock(depreciated)
1518
1519 DESCRIPTION:
1520 This function sets the user lock state maintained by the device
1521
1522 PARAMETERS:
1523 pState [ O ] - Current lock state
1524
1525 RETURN VALUE:
1526 ULONG - Return code
1527 ===========================================================================*/
1528 QCIMPORT2K ULONG QCWWANAPI2K QueryLock( ULONG * pState );
1529
1530 /*===========================================================================
1531 METHOD:
1532 ChangeLockPIN(depreciated)
1533
1534 DESCRIPTION:
1535 This command sets the user lock code maintained by the device
1536
1537 PARAMETERS:
1538 pCurrentPIN [ O ] - Current four digit PIN string
1539 pDesiredPIN [ O ] - New four digit PIN string
1540
1541 RETURN VALUE:
1542 ULONG - Return code
1543 ===========================================================================*/
1544 QCIMPORT2K ULONG QCWWANAPI2K ChangeLockPIN(
1545 CHAR * pCurrentPIN,
1546 CHAR * pDesiredPIN );
1547
1548 /*===========================================================================
1549 METHOD:
1550 GetHardwareRevision
1551
1552 DESCRIPTION:
1553 This function returns the device hardware revision
1554
1555 PARAMETERS:
1556 stringSize [ I ] - The maximum number of characters (including NULL
1557 terminator) that the string array can contain
1558 pString [ O ] - NULL terminated string
1559
1560 RETURN VALUE:
1561 ULONG - Return code
1562 ===========================================================================*/
1563 QCIMPORT2K ULONG QCWWANAPI2K GetHardwareRevision(
1564 BYTE stringSize,
1565 CHAR * pString );
1566
1567 /*===========================================================================
1568 METHOD:
1569 GetPRLVersion
1570
1571 DESCRIPTION:
1572 This function returns the version of the active Preferred Roaming List
1573 (PRL) in use by the device
1574
1575 PARAMETERS:
1576 pPRLVersion [ O ] - The PRL version number
1577
1578 RETURN VALUE:
1579 ULONG - Return code
1580 ===========================================================================*/
1581 QCIMPORT2K ULONG QCWWANAPI2K GetPRLVersion( WORD * pPRLVersion );
1582
1583 /*===========================================================================
1584 METHOD:
1585 GetERIFile
1586
1587 DESCRIPTION:
1588 This command returns the ERI file that is stored in EFS on the device
1589
1590 PARAMETERS:
1591 pFileSize [I/O] - Upon input the maximum number of bytes that the file
1592 contents array can contain. Upon successful output
1593 the actual number of bytes written to the file contents
1594 array
1595 pFile [ O ] - The file contents
1596
1597 RETURN VALUE:
1598 ULONG - Return code
1599 ===========================================================================*/
1600 QCIMPORT2K ULONG QCWWANAPI2K GetERIFile(
1601 ULONG * pFileSize,
1602 BYTE * pFile );
1603
1604 /*===========================================================================
1605 METHOD:
1606 ActivateAutomatic
1607
1608 DESCRIPTION:
1609 This function requests the device to perform automatic service activation
1610
1611 PARAMETERS:
1612 pActivationCode [ I ] - Activation code (maximum string length of 12)
1613
1614 RETURN VALUE:
1615 ULONG - Return code
1616 ===========================================================================*/
1617 QCIMPORT2K ULONG QCWWANAPI2K ActivateAutomatic( CHAR * pActivationCode );
1618
1619 /*===========================================================================
1620 METHOD:
1621 ActivateManual
1622
1623 DESCRIPTION:
1624 This function requests the device perform manual service activation,
1625 after a successful request the device is then asked to reset
1626
1627 PARAMETERS:
1628 pSPC [ I ] - NULL terminated string representing the six digit
1629 service programming code
1630 sid [ I ] - System identification number
1631 pMDN [ I ] - Mobile Directory Number string
1632 pMIN [ I ] - Mobile Identification Number string
1633 prlSize [ I ] - (Optional) Size of PRL file array
1634 pPRL [ I ] - (Optional) The PRL file contents
1635 pMNHA [ I ] - (Optional) MN-HA string
1636 pMNAAA [ I ] - (Optional) MN-AAA string
1637
1638 RETURN VALUE:
1639 ULONG - Return code
1640 ===========================================================================*/
1641 QCIMPORT2K ULONG QCWWANAPI2K ActivateManual(
1642 CHAR * pSPC,
1643 WORD sid,
1644 CHAR * pMDN,
1645 CHAR * pMIN,
1646 ULONG prlSize,
1647 BYTE * pPRL,
1648 CHAR * pMNHA,
1649 CHAR * pMNAAA );
1650
1651 /*===========================================================================
1652 METHOD:
1653 ResetToFactoryDefaults
1654
1655 DESCRIPTION:
1656 This function requests the device reset configuration to factory defaults,
1657 after a successful request the device is then asked to reset
1658
1659 PARAMETERS:
1660 pSPC [ I ] - NULL terminated string representing the six digit
1661 service programming code
1662
1663 RETURN VALUE:
1664 ULONG - Return code
1665 ===========================================================================*/
1666 QCIMPORT2K ULONG QCWWANAPI2K ResetToFactoryDefaults( CHAR * pSPC );
1667
1668 /*===========================================================================
1669 METHOD:
1670 GetActivationState
1671
1672 DESCRIPTION:
1673 This function returns the device activation state
1674
1675 PARAMETERS:
1676 pActivationState [ O ] - Service activation state
1677
1678 RETURN VALUE:
1679 ULONG - Return code
1680 ===========================================================================*/
1681 QCIMPORT2K ULONG QCWWANAPI2K GetActivationState( ULONG * pActivationState );
1682
1683 /*===========================================================================
1684 METHOD:
1685 SetPower
1686
1687 DESCRIPTION:
1688 This function sets the operating mode of the device
1689
1690 PARAMETERS:
1691 powerMode [ I ] - Selected operating mode
1692
1693 RETURN VALUE:
1694 ULONG - Return code
1695 ===========================================================================*/
1696 QCIMPORT2K ULONG QCWWANAPI2K SetPower( ULONG powerMode );
1697
1698 /*===========================================================================
1699 METHOD:
1700 GetPower
1701
1702 DESCRIPTION:
1703 This function returns the operating mode of the device
1704
1705 PARAMETERS:
1706 pPowerMode [ O ] - Current operating mode
1707
1708 RETURN VALUE:
1709 ULONG - Return code
1710 ===========================================================================*/
1711 QCIMPORT2K ULONG QCWWANAPI2K GetPower( ULONG * pPowerMode );
1712
1713 /*===========================================================================
1714 METHOD:
1715 GetOfflineReason
1716
1717 DESCRIPTION:
1718 This function returns the reason why the operating mode of the device
1719 is currently offline
1720
1721 PARAMETERS:
1722 pReasonMask [ O ] - Bitmask of offline reasons
1723 pbPlatform [ O ] - Offline due to being platform retricted?
1724
1725 RETURN VALUE:
1726 ULONG - Return code
1727 ===========================================================================*/
1728 QCIMPORT2K ULONG QCWWANAPI2K GetOfflineReason(
1729 ULONG * pReasonMask,
1730 ULONG * pbPlatform );
1731
1732 /*===========================================================================
1733 METHOD:
1734 GetNetworkTime
1735
1736 DESCRIPTION:
1737 This function returns the current time of the device
1738
1739 PARAMETERS:
1740 pTimeStamp [ O ] - Count of 1.25ms that have elapsed from the start
1741 of GPS time (Jan 6, 1980)
1742 pTimeSource [ O ] - Source of the timestamp
1743
1744 RETURN VALUE:
1745 ULONG - Return code
1746 ===========================================================================*/
1747 QCIMPORT2K ULONG QCWWANAPI2K GetNetworkTime(
1748 ULONGLONG * pTimeCount,
1749 ULONG * pTimeSource );
1750
1751 /*===========================================================================
1752 METHOD:
1753 ValidateSPC
1754
1755 DESCRIPTION:
1756 This function validates the service programming code
1757
1758 PARAMETERS:
1759 pSPC [ I ] - Six digit service programming code
1760
1761 RETURN VALUE:
1762 ULONG - Return code
1763 ===========================================================================*/
1764 QCIMPORT2K ULONG QCWWANAPI2K ValidateSPC( CHAR * pSPC );
1765
1766 /*===========================================================================
1767 METHOD:
1768 DeleteSMS
1769
1770 DESCRIPTION:
1771 This function deletes one or more SMS messages from device memory
1772
1773 PARAMETERS:
1774 storageType [ I ] - SMS message storage type
1775 pMessageIndex [ I ] - (Optional) message index
1776 pMessageTag [ I ] - (Optional) message tag
1777
1778 RETURN VALUE:
1779 ULONG - Return code
1780 ===========================================================================*/
1781 QCIMPORT2K ULONG QCWWANAPI2K DeleteSMS(
1782 ULONG storageType,
1783 ULONG * pMessageIndex,
1784 ULONG * pMessageTag );
1785
1786 /*===========================================================================
1787 METHOD:
1788 GetSMSList
1789
1790 DESCRIPTION:
1791 This function returns the list of SMS messages stored on the device
1792
1793 PARAMETERS:
1794 storageType [ I ] - SMS message storage type
1795 pRequestedTag [ I ] - Message index
1796 pMessageListSize [I/O] - Upon input the maximum number of elements that the
1797 message list array can contain. Upon successful
1798 output the actual number of elements in the message
1799 list array
1800 pMessageList [ O ] - The message list array
1801
1802 RETURN VALUE:
1803 ULONG - Return code
1804 ===========================================================================*/
1805 QCIMPORT2K ULONG QCWWANAPI2K GetSMSList(
1806 ULONG storageType,
1807 ULONG * pRequestedTag,
1808 ULONG * pMessageListSize,
1809 BYTE * pMessageList );
1810
1811 /*===========================================================================
1812 METHOD:
1813 GetSMS
1814
1815 DESCRIPTION:
1816 This function returns an SMS message from device memory
1817
1818 PARAMETERS:
1819 storageType [ I ] - SMS message storage type
1820 messageIndex [ I ] - Message index
1821 pMessageTag [ O ] - Message tag
1822 pMessageFormat [ O ] - Message format
1823 pMessageSize [I/O] - Upon input the maximum number of bytes that can be
1824 written to the message array. Upon successful
1825 output the actual number of bytes written to the
1826 message array
1827 pMessage [ I ] - The message contents array
1828
1829 RETURN VALUE:
1830 ULONG - Return code
1831 ===========================================================================*/
1832 QCIMPORT2K ULONG QCWWANAPI2K GetSMS(
1833 ULONG storageType,
1834 ULONG messageIndex,
1835 ULONG * pMessageTag,
1836 ULONG * pMessageFormat,
1837 ULONG * pMessageSize,
1838 BYTE * pMessage );
1839
1840 /*===========================================================================
1841 METHOD:
1842 ModifySMSStatus
1843
1844 DESCRIPTION:
1845 This function modifies the status of an SMS message saved in storage on
1846 the device
1847
1848 PARAMETERS:
1849 storageType [ I ] - SMS message storage type
1850 messageIndex [ I ] - Message index
1851 messageTag [ I ] - Message tag
1852
1853 RETURN VALUE:
1854 ULONG - Return code
1855 ===========================================================================*/
1856 QCIMPORT2K ULONG QCWWANAPI2K ModifySMSStatus(
1857 ULONG storageType,
1858 ULONG messageIndex,
1859 ULONG messageTag );
1860
1861 /*===========================================================================
1862 METHOD:
1863 SaveSMS
1864
1865 DESCRIPTION:
1866 This function saves an SMS message to device memory
1867
1868 PARAMETERS:
1869 storageType [ I ] - SMS message storage type
1870 messageFormat [ I ] - Message format
1871 messageSize [ I ] - The length of the message contents in bytes
1872 pMessage [ I ] - The message contents
1873 pMessageIndex [ O ] - The message index assigned by the device
1874
1875 RETURN VALUE:
1876 ULONG - Return code
1877 ===========================================================================*/
1878 QCIMPORT2K ULONG QCWWANAPI2K SaveSMS(
1879 ULONG storageType,
1880 ULONG messageFormat,
1881 ULONG messageSize,
1882 BYTE * pMessage,
1883 ULONG * pMessageIndex );
1884
1885 /*===========================================================================
1886 METHOD:
1887 SendSMS
1888
1889 DESCRIPTION:
1890 This function sends an SMS message for immediate over the air transmission
1891
1892 PARAMETERS:
1893 messageFormat [ I ] - Message format
1894 messageSize [ I ] - The length of the message contents in bytes
1895 pMessage [ I ] - The message contents
1896 pMessageFailureCode [ O ] - When the function fails due to an error sending
1897 the message this parameter may contain the
1898 message failure cause code (see 3GPP2 N.S0005
1899 Section 6.5.2.125). If the cause code is not
1900 provided then the value will be 0xFFFFFFFF
1901
1902 RETURN VALUE:
1903 ULONG - Return code
1904 ===========================================================================*/
1905 QCIMPORT2K ULONG QCWWANAPI2K SendSMS(
1906 ULONG messageFormat,
1907 ULONG messageSize,
1908 BYTE * pMessage,
1909 BYTE linkTimer,
1910 ULONG * pMessageFailureCode );
1911
1912 /*===========================================================================
1913 METHOD:
1914 GetSMSCAddress
1915
1916 DESCRIPTION:
1917 This function returns the SMS center address
1918
1919 PARAMETERS:
1920 addressSize [ I ] - The maximum number of characters (including NULL
1921 terminator) that the SMS center address array
1922 can contain
1923 pSMSCAddress [ 0 ] - The SMS center address represented as a NULL
1924 terminated string
1925 typeSize [ I ] - The maximum number of characters (including NULL
1926 terminator) that the SMS center address type array
1927 can contain
1928 pSMSCType [ 0 ] - The SMS center address type represented as a NULL
1929 terminated string
1930
1931 RETURN VALUE:
1932 ULONG - Return code
1933 ===========================================================================*/
1934 QCIMPORT2K ULONG QCWWANAPI2K GetSMSCAddress(
1935 BYTE addressSize,
1936 CHAR * pSMSCAddress,
1937 BYTE typeSize,
1938 CHAR * pSMSCType );
1939
1940 /*===========================================================================
1941 METHOD:
1942 SetSMSCAddress
1943
1944 DESCRIPTION:
1945 This function sets the SMS center address
1946
1947 PARAMETERS:
1948 pSMSCAddress [ I ] - The SMS center address represented as a NULL
1949 terminated string
1950 pSMSCType [ I ] - The SMS center address type represented as a NULL
1951 terminated string (optional)
1952
1953 RETURN VALUE:
1954 ULONG - Return code
1955 ===========================================================================*/
1956 QCIMPORT2K ULONG QCWWANAPI2K SetSMSCAddress(
1957 CHAR * pSMSCAddress,
1958 CHAR * pSMSCType );
1959
1960 /*===========================================================================
1961 METHOD:
1962 DMSUIMSetPINProtection
1963
1964 DESCRIPTION:
1965 This function enables or disables protection of UIM contents by a
1966 given PIN
1967
1968 PARAMETERS:
1969 id [ I ] - PIN ID (1/2)
1970 bEnable [ I ] - Enable/disable PIN protection (0 = disable)?
1971 pValue [ I ] - PIN value of the PIN to be enabled/disabled
1972 pVerifyRetriesLeft [ O ] - Upon operational failure this will indicate
1973 the number of retries left, after which the
1974 PIN will be blocked (0xFFFFFFFF = unknown)
1975 pUnblockRetriesLeft [ O ] - Upon operational failure this will indicate
1976 the number of unblock retries left, after
1977 which the PIN will be permanently blocked,
1978 i.e. UIM is unusable (0xFFFFFFFF = unknown)
1979
1980 RETURN VALUE:
1981 ULONG - Return code
1982 ===========================================================================*/
1983 /*
1984 QCIMPORT2K ULONG QCWWANAPI2K DMSUIMSetPINProtection(
1985 ULONG id,
1986 ULONG bEnable,
1987 CHAR * pValue,
1988 ULONG * pVerifyRetriesLeft,
1989 ULONG * pUnblockRetriesLeft );*/
1990
1991 /*===========================================================================
1992 METHOD:
1993 DMSUIMVerifyPIN
1994
1995 DESCRIPTION:
1996 This function verifies the PIN before accessing the UIM contents
1997
1998 PARAMETERS:
1999 id [ I ] - PIN ID (1/2)
2000 pValue [ I ] - PIN value of the PIN to verify
2001 pVerifyRetriesLeft [ O ] - Upon operational failure this will indicate
2002 the number of retries left, after which the
2003 PIN will be blocked (0xFFFFFFFF = unknown)
2004 pUnblockRetriesLeft [ O ] - Upon operational failure this will indicate
2005 the number of unblock retries left, after
2006 which the PIN will be permanently blocked,
2007 i.e. UIM is unusable (0xFFFFFFFF = unknown)
2008
2009 RETURN VALUE:
2010 ULONG - Return code
2011 ===========================================================================*/
2012 /*
2013 QCIMPORT2K ULONG QCWWANAPI2K DMSUIMVerifyPIN(
2014 ULONG id,
2015 CHAR * pValue,
2016 ULONG * pVerifyRetriesLeft,
2017 ULONG * pUnblockRetriesLeft );
2018 */
2019 /*===========================================================================
2020 METHOD:
2021 DMSUIMUnblockPIN
2022
2023 DESCRIPTION:
2024 This function unblocks a blocked PIN
2025
2026 PARAMETERS:
2027 id [ I ] - PIN ID (1/2)
2028 pPUKValue [ I ] - PUK value of the PIN to unblock
2029 pNewValue [ I ] - New PIN value of the PIN to unblock
2030 pVerifyRetriesLeft [ O ] - Upon operational failure this will indicate
2031 the number of retries left, after which the
2032 PIN will be blocked (0xFFFFFFFF = unknown)
2033 pUnblockRetriesLeft [ O ] - Upon operational failure this will indicate
2034 the number of unblock retries left, after
2035 which the PIN will be permanently blocked,
2036 i.e. UIM is unusable (0xFFFFFFFF = unknown)
2037
2038 RETURN VALUE:
2039 ULONG - Return code
2040 ===========================================================================*/
2041 /*
2042 QCIMPORT2K ULONG QCWWANAPI2K DMSUIMUnblockPIN(
2043 ULONG id,
2044 CHAR * pPUKValue,
2045 CHAR * pNewValue,
2046 ULONG * pVerifyRetriesLeft,
2047 ULONG * pUnblockRetriesLeft );
2048 */
2049
2050 /*===========================================================================
2051 METHOD:
2052 DMSUIMChangePIN
2053
2054 DESCRIPTION:
2055 This function change the PIN value
2056
2057 PARAMETERS:
2058 id [ I ] - PIN ID (1/2)
2059 pOldValue [ I ] - Old PIN value of the PIN to change
2060 pNewValue [ I ] - New PIN value of the PIN to change
2061 pVerifyRetriesLeft [ O ] - Upon operational failure this will indicate
2062 the number of retries left, after which the
2063 PIN will be blocked (0xFFFFFFFF = unknown)
2064 pUnblockRetriesLeft [ O ] - Upon operational failure this will indicate
2065 the number of unblock retries left, after
2066 which the PIN will be permanently blocked,
2067 i.e. UIM is unusable (0xFFFFFFFF = unknown)
2068
2069 RETURN VALUE:
2070 ULONG - Return code
2071 ===========================================================================*/
2072 /*
2073 QCIMPORT2K ULONG QCWWANAPI2K DMSUIMChangePIN(
2074 ULONG id,
2075 CHAR * pOldValue,
2076 CHAR * pNewValue,
2077 ULONG * pVerifyRetriesLeft,
2078 ULONG * pUnblockRetriesLeft );
2079 */
2080 /*===========================================================================
2081 METHOD:
2082 DMSUIMGetPINStatus
2083
2084 DESCRIPTION:
2085 This function returns the status of the pin
2086
2087 PARAMETERS:
2088 id [ I ] - PIN ID (1/2)
2089 pStatus [ O ] - PIN status (0xFFFFFFFF = unknown)
2090 pVerifyRetriesLeft [ O ] - The number of retries left, after which the
2091 PIN will be blocked (0xFFFFFFFF = unknown)
2092 pUnblockRetriesLeft [ O ] - The number of unblock retries left, after
2093 which the PIN will be permanently blocked,
2094 i.e. UIM is unusable (0xFFFFFFFF = unknown)
2095
2096 RETURN VALUE:
2097 ULONG - Return code
2098 ===========================================================================*/
2099 /*
2100 QCIMPORT2K ULONG QCWWANAPI2K DMSUIMGetPINStatus(
2101 ULONG id,
2102 ULONG * pStatus,
2103 ULONG * pVerifyRetriesLeft,
2104 ULONG * pUnblockRetriesLeft );
2105 */
2106 /*===========================================================================
2107 METHOD:
2108 DMSUIMGetICCID
2109
2110 DESCRIPTION:
2111 This function returns the UIM ICCID
2112
2113 PARAMETERS:
2114 stringSize [ I ] - The maximum number of characters (including NULL
2115 terminator) that the string array can contain
2116 pString [ O ] - NULL terminated string
2117
2118 RETURN VALUE:
2119 ULONG - Return code
2120 ===========================================================================*/
2121 QCIMPORT2K ULONG QCWWANAPI2K DMSUIMGetICCID(
2122 BYTE stringSize,
2123 CHAR * pString );
2124
2125 /*===========================================================================
2126 METHOD:
2127 DMSUIMGetControlKeyStatus
2128
2129 DESCRIPTION:
2130 This function returns the status of the specified facility control key
2131
2132 PARAMETERS:
2133 id [ I ] - Facility ID
2134 pStatus [ O ] - Control key status
2135 pVerifyRetriesLeft [ O ] - The number of retries left, after which the
2136 control key will be blocked
2137 pUnblockRetriesLeft [ O ] - The number of unblock retries left, after
2138 which the control key will be permanently
2139 blocked
2140
2141 RETURN VALUE:
2142 ULONG - Return code
2143 ===========================================================================*/
2144 QCIMPORT2K ULONG QCWWANAPI2K DMSUIMGetControlKeyStatus(
2145 ULONG id,
2146 ULONG * pStatus,
2147 ULONG * pVerifyRetriesLeft,
2148 ULONG * pUnblockRetriesLeft );
2149
2150 /*===========================================================================
2151 METHOD:
2152 DMSUIMSetControlKeyProtection
2153
2154 DESCRIPTION:
2155 This function changes the specified facility control key
2156
2157 PARAMETERS:
2158 id [ I ] - Facility ID
2159 status [ I ] - Control key status
2160 pValue [ I ] - Control key de-personalization string
2161 pVerifyRetriesLeft [ O ] - Upon operational failure this will indicate
2162 the number of retries left, after which the
2163 control key will be blocked
2164 (0xFFFFFFFF = unknown)
2165 RETURN VALUE:
2166 ULONG - Return code
2167 ===========================================================================*/
2168 QCIMPORT2K ULONG QCWWANAPI2K DMSUIMSetControlKeyProtection(
2169 ULONG id,
2170 ULONG status,
2171 CHAR * pValue,
2172 ULONG * pVerifyRetriesLeft );
2173
2174 /*===========================================================================
2175 METHOD:
2176 DMSUIMUnblockControlKey
2177
2178 DESCRIPTION:
2179 This function unblocks the specified facility control key
2180
2181 PARAMETERS:
2182 id [ I ] - Facility ID
2183 pValue [ I ] - Control key de-personalization string
2184 pUnblockRetriesLeft [ O ] - The number of unblock retries left, after
2185 which the control key will be permanently
2186 blocked
2187 (0xFFFFFFFF = unknown)
2188 RETURN VALUE:
2189 ULONG - Return code
2190 ===========================================================================*/
2191 QCIMPORT2K ULONG QCWWANAPI2K DMSUIMUnblockControlKey(
2192 ULONG id,
2193 CHAR * pValue,
2194 ULONG * pUnblockRetriesLeft );
2195
2196 /*===========================================================================
2197 METHOD:
2198 GetPDSState
2199
2200 DESCRIPTION:
2201 This function returns the current PDS state
2202
2203 PARAMETERS:
2204 pEnabled [ O ] - Current PDS state (0 = disabled)
2205 pTracking [ O ] - Current PDS tracking session state
2206
2207
2208 RETURN VALUE:
2209 ULONG - Return code
2210 ===========================================================================*/
2211 QCIMPORT2K ULONG QCWWANAPI2K GetPDSState(
2212 ULONG * pEnabled,
2213 ULONG * pTracking );
2214
2215 /*===========================================================================
2216 METHOD:
2217 SetPDSState
2218
2219 DESCRIPTION:
2220 This function sets the PDS state
2221
2222 PARAMETERS:
2223 enable [ I ] - Desired PDS state (0 = disable)
2224
2225 RETURN VALUE:
2226 ULONG - Return code
2227 ===========================================================================*/
2228 QCIMPORT2K ULONG QCWWANAPI2K SetPDSState( ULONG enable );
2229
2230 /*===========================================================================
2231 METHOD:
2232 StartPDSTrackingSession (Deprecated)
2233
2234 DESCRIPTION:
2235 This function starts a PDS tracking session
2236
2237 NOTE: Only one tracking session can be active at any given time
2238
2239 PARAMETERS:
2240 fixInterval [ I ] - Time in milliseconds between fixes
2241
2242 RETURN VALUE:
2243 ULONG - Return code
2244 ===========================================================================*/
2245 QCIMPORT2K ULONG QCWWANAPI2K StartPDSTrackingSession( ULONG fixInterval );
2246
2247 /*===========================================================================
2248 METHOD:
2249 StopPDSTrackingSession (Deprecated)
2250
2251 DESCRIPTION:
2252 This function stops a PDS tracking session
2253
2254 RETURN VALUE:
2255 ULONG - Return code
2256 ===========================================================================*/
2257 QCIMPORT2K ULONG QCWWANAPI2K StopPDSTrackingSession();
2258
2259 /*===========================================================================
2260 METHOD:
2261 PDSInjectTimeReference
2262
2263 DESCRIPTION:
2264 This function injects a system time into the PDS engine
2265
2266 PARAMETERS:
2267 sysTime [ I ] - System time
2268 sysDiscontinuities [ I ] - Number of system time discontinuities
2269
2270 RETURN VALUE:
2271 ULONG - Return code
2272 ===========================================================================*/
2273 QCIMPORT2K ULONG QCWWANAPI2K PDSInjectTimeReference(
2274 ULONGLONG systemTime,
2275 USHORT systemDiscontinuities );
2276
2277 /*===========================================================================
2278 METHOD:
2279 GetPDSDefaults
2280
2281 DESCRIPTION:
2282 This function returns the default tracking session configuration
2283
2284 PARAMETERS:
2285 pOperation [ O ] - Current session operating mode
2286 pTimeout [ O ] - Maximum amount of time (seconds) to work on each fix
2287 pInterval [ O ] - Interval (milliseconds) between fix requests
2288 pAccuracy [ O ] - Current accuracy threshold (meters)
2289
2290 RETURN VALUE:
2291 ULONG - Return code
2292 ===========================================================================*/
2293 QCIMPORT2K ULONG QCWWANAPI2K GetPDSDefaults(
2294 ULONG * pOperation,
2295 BYTE * pTimeout,
2296 ULONG * pInterval,
2297 ULONG * pAccuracy );
2298
2299 /*===========================================================================
2300 METHOD:
2301 SetPDSDefaults
2302
2303 DESCRIPTION:
2304 This function sets the default tracking session configuration
2305
2306 PARAMETERS:
2307 operation [ I ] - Desired session operating mode
2308 timeout [ I ] - Maximum amount of time (seconds) to work on each fix
2309 interval [ I ] - Interval (milliseconds) between fix requests
2310 accuracy [ I ] - Desired accuracy threshold (meters)
2311
2312 RETURN VALUE:
2313 ULONG - Return code
2314 ===========================================================================*/
2315 QCIMPORT2K ULONG QCWWANAPI2K SetPDSDefaults(
2316 ULONG operation,
2317 BYTE timeout,
2318 ULONG interval,
2319 ULONG accuracy );
2320
2321 /*===========================================================================
2322 METHOD:
2323 GetXTRAAutomaticDownload
2324
2325 DESCRIPTION:
2326 This function returns the XTRA automatic download configuration
2327
2328 PARAMETERS:
2329 pbEnabled [ O ] - Automatic download enabled?
2330 pInterval [ O ] - Interval (hours) between XTRA downloads
2331
2332 RETURN VALUE:
2333 ULONG - Return code
2334 ===========================================================================*/
2335 QCIMPORT2K ULONG QCWWANAPI2K GetXTRAAutomaticDownload(
2336 ULONG * pbEnabled,
2337 USHORT * pInterval );
2338
2339 /*===========================================================================
2340 METHOD:
2341 SetXTRAAutomaticDownload
2342
2343 DESCRIPTION:
2344 This function sets the XTRA automatic download configuration
2345
2346 PARAMETERS:
2347 bEnabled [ I ] - Automatic download enabled?
2348 interval [ I ] - Interval (hours) between XTRA downloads
2349
2350 RETURN VALUE:
2351 ULONG - Return code
2352 ===========================================================================*/
2353 QCIMPORT2K ULONG QCWWANAPI2K SetXTRAAutomaticDownload(
2354 ULONG bEnabled,
2355 USHORT interval );
2356
2357 /*===========================================================================
2358 METHOD:
2359 GetXTRANetwork
2360
2361 DESCRIPTION:
2362 This function returns the XTRA WWAN network preference
2363
2364 PARAMETERS:
2365 pPreference [ O ] - XTRA WWAN network preference
2366
2367 RETURN VALUE:
2368 ULONG - Return code
2369 ===========================================================================*/
2370 QCIMPORT2K ULONG QCWWANAPI2K GetXTRANetwork( ULONG * pPreference );
2371
2372 /*===========================================================================
2373 METHOD:
2374 SetXTRANetwork
2375
2376 DESCRIPTION:
2377 This function sets the XTRA WWAN network preference
2378
2379 PARAMETERS:
2380 preference [ I ] - XTRA WWAN network preference
2381
2382 RETURN VALUE:
2383 ULONG - Return code
2384 ===========================================================================*/
2385 QCIMPORT2K ULONG QCWWANAPI2K SetXTRANetwork( ULONG preference );
2386
2387 /*===========================================================================
2388 METHOD:
2389 GetXTRAValidity
2390
2391 DESCRIPTION:
2392 This function returns the XTRA database validity period
2393
2394 PARAMETERS:
2395 pGPSWeek [ O ] - Starting GPS week of validity period
2396 pGPSWeekOffset [ O ] - Starting GPS week offset (minutes) of validity period
2397 pDuration [ O ] - Length of validity period (hours)
2398
2399 RETURN VALUE:
2400 ULONG - Return code
2401 ===========================================================================*/
2402 QCIMPORT2K ULONG QCWWANAPI2K GetXTRAValidity(
2403 USHORT * pGPSWeek,
2404 USHORT * pGPSWeekOffset,
2405 USHORT * pDuration );
2406
2407 /*===========================================================================
2408 METHOD:
2409 ForceXTRADownload
2410
2411 DESCRIPTION:
2412 This function forces the XTRA database to be downloaded to the device
2413
2414 RETURN VALUE:
2415 ULONG - Return code
2416 ===========================================================================*/
2417 QCIMPORT2K ULONG QCWWANAPI2K ForceXTRADownload();
2418
2419 /*===========================================================================
2420 METHOD:
2421 GetAGPSConfig
2422
2423 DESCRIPTION:
2424 This function returns the PDS AGPS configuration
2425
2426 PARAMETERS:
2427 pServerAddress [ O ] - IPv4 address of AGPS server
2428 pServerPort [ O ] - Port number of AGPS server
2429
2430 RETURN VALUE:
2431 ULONG - Return code
2432 ===========================================================================*/
2433 QCIMPORT2K ULONG QCWWANAPI2K GetAGPSConfig(
2434 ULONG * pServerAddress,
2435 ULONG * pServerPort );
2436
2437 /*===========================================================================
2438 METHOD:
2439 SetAGPSConfig
2440
2441 DESCRIPTION:
2442 This function sets the PDS AGPS configuration
2443
2444 PARAMETERS:
2445 serverAddress [ I ] - IPv4 address of AGPS server
2446 serverPort [ I ] - Port number of AGPS server
2447
2448 RETURN VALUE:
2449 ULONG - Return code
2450 ===========================================================================*/
2451 QCIMPORT2K ULONG QCWWANAPI2K SetAGPSConfig(
2452 ULONG serverAddress,
2453 ULONG serverPort );
2454
2455 /*===========================================================================
2456 METHOD:
2457 GetServiceAutomaticTracking
2458
2459 DESCRIPTION:
2460 This function returns the automatic tracking state for the service
2461
2462 PARAMETERS:
2463 pbAuto [ O ] - Automatic tracking session started for service?
2464
2465 RETURN VALUE:
2466 ULONG - Return code
2467 ===========================================================================*/
2468 QCIMPORT2K ULONG QCWWANAPI2K GetServiceAutomaticTracking( ULONG * pbAuto );
2469
2470 /*===========================================================================
2471 METHOD:
2472 SetServiceAutomaticTracking
2473
2474 DESCRIPTION:
2475 This function sets the automatic tracking state for the service
2476
2477 PARAMETERS:
2478 pbAuto [ I ] - Start automatic tracking session for service?
2479
2480 RETURN VALUE:
2481 ULONG - Return code
2482 ===========================================================================*/
2483 QCIMPORT2K ULONG QCWWANAPI2K SetServiceAutomaticTracking( ULONG bAuto );
2484
2485 /*===========================================================================
2486 METHOD:
2487 GetPortAutomaticTracking
2488
2489 DESCRIPTION:
2490 This function returns the automatic tracking configuration for the NMEA
2491 COM port
2492
2493 PARAMETERS:
2494 pbAuto [ O ] - Automatic tracking enabled for NMEA COM port?
2495
2496 RETURN VALUE:
2497 ULONG - Return code
2498 ===========================================================================*/
2499 QCIMPORT2K ULONG QCWWANAPI2K GetPortAutomaticTracking( ULONG * pbAuto );
2500
2501 /*===========================================================================
2502 METHOD:
2503 SetPortAutomaticTracking
2504
2505 DESCRIPTION:
2506 This function sets the automatic tracking configuration for the NMEA
2507 COM port
2508
2509 PARAMETERS:
2510 pbAuto [ I ] - Enable automatic tracking for NMEA COM port?
2511
2512 RETURN VALUE:
2513 ULONG - Return code
2514 ===========================================================================*/
2515 QCIMPORT2K ULONG QCWWANAPI2K SetPortAutomaticTracking( ULONG bAuto );
2516
2517 /*===========================================================================
2518 METHOD:
2519 ResetPDSData
2520
2521 DESCRIPTION:
2522 This function resets the specified PDS data
2523
2524 PARAMETERS:
2525 pGPSDataMask [ I ] - Bitmask of GPS data to clear (optional)
2526 pCellDataMask [ I ] - Bitmask of cell data to clear (optional)
2527
2528 RETURN VALUE:
2529 ULONG - Return code
2530 ===========================================================================*/
2531 QCIMPORT2K ULONG QCWWANAPI2K ResetPDSData(
2532 ULONG * pGPSDataMask,
2533 ULONG * pCellDataMask );
2534
2535 /*===========================================================================
2536 METHOD:
2537 CATSendTerminalResponse
2538
2539 DESCRIPTION:
2540 This function sends the terminal response to the device
2541
2542 PARAMETERS:
2543 refID [ I ] - UIM reference ID (from CAT event)
2544 dataLen [ I ] - Terminal response data length
2545 pData [ I ] - Terminal response data
2546
2547 RETURN VALUE:
2548 ULONG - Return code
2549 ===========================================================================*/
2550 QCIMPORT2K ULONG QCWWANAPI2K CATSendTerminalResponse(
2551 ULONG refID,
2552 ULONG dataLen,
2553 BYTE * pData );
2554
2555 /*===========================================================================
2556 METHOD:
2557 CATSendEnvelopeCommand
2558
2559 DESCRIPTION:
2560 This function sends the envelope command to the device
2561
2562 PARAMETERS:
2563 cmdID [ I ] - Envelope command ID
2564 dataLen [ I ] - Envelope command data length
2565 pData [ I ] - Envelope command data
2566
2567 RETURN VALUE:
2568 ULONG - Return code
2569 ===========================================================================*/
2570 QCIMPORT2K ULONG QCWWANAPI2K CATSendEnvelopeCommand(
2571 ULONG cmdID,
2572 ULONG dataLen,
2573 BYTE * pData );
2574
2575 /*===========================================================================
2576 METHOD:
2577 GetSMSWake
2578
2579 DESCRIPTION:
2580 This function queries the state of the SMS wake functionality
2581
2582 PARAMETERS:
2583 pbEnabled [ O ] - SMS wake functionality enabled?
2584 pWakeMask [ O ] - SMS wake mask (only relevant when enabled)
2585
2586 RETURN VALUE:
2587 ULONG - Return code
2588 ===========================================================================*/
2589 QCIMPORT2K ULONG QCWWANAPI2K GetSMSWake(
2590 ULONG * pbEnabled,
2591 ULONG * pWakeMask );
2592
2593 /*===========================================================================
2594 METHOD:
2595 SetSMSWake
2596
2597 DESCRIPTION:
2598 This function enables/disables the SMS wake functionality
2599
2600 PARAMETERS:
2601 bEnable [ I ] - Enable SMS wake functionality?
2602 wakeMask [ I ] - SMS wake mask (only relevant when enabling)
2603
2604 RETURN VALUE:
2605 ULONG - Return code
2606 ===========================================================================*/
2607 QCIMPORT2K ULONG QCWWANAPI2K SetSMSWake(
2608 ULONG bEnable,
2609 ULONG wakeMask );
2610
2611 /*===========================================================================
2612 METHOD:
2613 OMADMStartSession
2614
2615 DESCRIPTION:
2616 This function starts an OMA-DM session
2617
2618 PARAMETERS:
2619 sessionType [ I ] - Type of session to initiate
2620
2621 RETURN VALUE:
2622 ULONG - Return code
2623 ===========================================================================*/
2624 QCIMPORT2K ULONG QCWWANAPI2K OMADMStartSession( ULONG sessionType );
2625
2626 /*===========================================================================
2627 METHOD:
2628 OMADMCancelSession
2629
2630 DESCRIPTION:
2631 This function cancels an ongoing OMA-DM session
2632
2633 RETURN VALUE:
2634 ULONG - Return code
2635 ===========================================================================*/
2636 QCIMPORT2K ULONG QCWWANAPI2K OMADMCancelSession();
2637
2638 /*===========================================================================
2639 METHOD:
2640 OMADMGetSessionInfo
2641
2642 DESCRIPTION:
2643 This function returns information related to the current (or previous
2644 if no session is active) OMA-DM session
2645
2646 PARAMETERS:
2647 pSessionState [ O ] - State of session
2648 pSessionType [ O ] - Type of session
2649 pFailureReason [ O ] - Session failure reason (when state indicates failure)
2650 pRetryCount [ O ] - Session retry count (when state indicates retrying)
2651 pSessionPause [ O ] - Session pause timer (when state indicates retrying)
2652 pTimeRemaining [ O ] - Pause time remaining (when state indicates retrying)
2653
2654 RETURN VALUE:
2655 ULONG - Return code
2656 ===========================================================================*/
2657 QCIMPORT2K ULONG QCWWANAPI2K OMADMGetSessionInfo(
2658 ULONG * pSessionState,
2659 ULONG * pSessionType,
2660 ULONG * pFailureReason,
2661 BYTE * pRetryCount,
2662 WORD * pSessionPause,
2663 WORD * pTimeRemaining );
2664
2665 /*===========================================================================
2666 METHOD:
2667 OMADMGetPendingNIA
2668
2669 DESCRIPTION:
2670 This function returns information about the pending network initiated
2671 alert
2672
2673 PARAMETERS:
2674 pSessionType [ O ] - Type of session
2675 pSessionID [ O ] - Unique session ID
2676
2677 RETURN VALUE:
2678 ULONG - Return code
2679 ===========================================================================*/
2680 QCIMPORT2K ULONG QCWWANAPI2K OMADMGetPendingNIA(
2681 ULONG * pSessionType,
2682 USHORT * pSessionID );
2683
2684 /*===========================================================================
2685 METHOD:
2686 OMADMSendSelection
2687
2688 DESCRIPTION:
2689 This function sends the specified OMA-DM selection for the current
2690 network initiated session
2691
2692 PARAMETERS:
2693 selection [ I ] - Selection
2694 sessionID [ I ] - Unique session ID
2695
2696 RETURN VALUE:
2697 ULONG - Return code
2698 ===========================================================================*/
2699 QCIMPORT2K ULONG QCWWANAPI2K OMADMSendSelection(
2700 ULONG selection,
2701 USHORT sessionID );
2702
2703 /*===========================================================================
2704 METHOD:
2705 OMADMGetFeatureSettings
2706
2707 DESCRIPTION:
2708 This function returns the OMA-DM feature settings
2709
2710 PARAMETERS:
2711 pbProvisioning [ O ] - Device provisioning service update enabled
2712 pbPRLUpdate [ O ] - PRL service update enabled
2713
2714 RETURN VALUE:
2715 ULONG - Return code
2716 ===========================================================================*/
2717 QCIMPORT2K ULONG QCWWANAPI2K OMADMGetFeatureSettings(
2718 ULONG * pbProvisioning,
2719 ULONG * pbPRLUpdate );
2720
2721 /*===========================================================================
2722 METHOD:
2723 OMADMSetProvisioningFeature
2724
2725 DESCRIPTION:
2726 This function sets the OMA-DM device provisioning service
2727 update feature setting
2728
2729 PARAMETERS:
2730 bProvisioning [ I ] - Device provisioning service update enabled
2731
2732 RETURN VALUE:
2733 ULONG - Return code
2734 ===========================================================================*/
2735 QCIMPORT2K ULONG QCWWANAPI2K OMADMSetProvisioningFeature(
2736 ULONG bProvisioning );
2737
2738 /*===========================================================================
2739 METHOD:
2740 OMADMSetPRLUpdateFeature
2741
2742 DESCRIPTION:
2743 This function sets the OMA-DM PRL service update feature setting
2744
2745 PARAMETERS:
2746 bPRLUpdate [ I ] - PRL service update enabled
2747
2748 RETURN VALUE:
2749 ULONG - Return code
2750 ===========================================================================*/
2751 QCIMPORT2K ULONG QCWWANAPI2K OMADMSetPRLUpdateFeature(
2752 ULONG bPRLUpdate );
2753
2754 /*===========================================================================
2755 METHOD:
2756 GetFirmwareID
2757
2758 DESCRIPTION:
2759 Returns the ID for the firmware image located at the path provided as input
2760
2761 PARAMETERS:
2762 pPath [ I ] - Location of the firmware image
2763 pFirmwareID [ O ] - Firmware ID obtained from the firmware image
2764
2765 RETURN VALUE:
2766 ULONG - Return code
2767 ===========================================================================*/
2768 QCIMPORT2K ULONG QCWWANAPI2K GetFirmwareIDW(
2769 WCHAR * pPath,
2770 ULONG * pFirmwareID );
2771
2772 QCIMPORT2K ULONG QCWWANAPI2K GetFirmwareIDA(
2773 CHAR * pPath,
2774 ULONG * pFirmwareID );
2775
2776 /*===========================================================================
2777 METHOD:
2778 UpgradeFirmware (Deprecated)
2779
2780 DESCRIPTION:
2781 This function performs the following set of steps:
2782 a) Verifies arguments
2783 b) Updates firmware ID on device
2784 c) Resets the device
2785
2786 NOTE: Upon successful completion the above steps will have been completed,
2787 however the actual upgrade of the firmware will necessarily then
2788 follow.
2789
2790 PARAMETERS:
2791 pSourcePath [ I ] - No longer used
2792 pDestinationPath [ I ] - The fully qualified path to the destination folder
2793 that the firmware download service will use
2794
2795 RETURN VALUE:
2796 ULONG - Return code
2797 ===========================================================================*/
2798 QCIMPORT2K ULONG QCWWANAPI2K UpgradeFirmwareW(
2799 WCHAR * pSourcePath,
2800 WCHAR * pDestinationPath );
2801
2802 QCIMPORT2K ULONG QCWWANAPI2K UpgradeFirmwareA(
2803 CHAR * pSourcePath,
2804 CHAR * pDestinationPath );
2805
2806 /*===========================================================================
2807 METHOD:
2808 UpgradeFirmware2k
2809
2810 DESCRIPTION:
2811 This function performs the following set of steps:
2812 a) Verifies arguments
2813 b) Updates firmware ID on device
2814 c) Resets the device
2815
2816 NOTE: Upon successful completion the above steps will have been completed,
2817 however the actual upgrade of the firmware will necessarily then
2818 follow.
2819
2820 PARAMETERS:
2821 pDestinationPath [ I ] - The fully qualified path to the destination folder
2822 that the firmware download service will use
2823
2824 RETURN VALUE:
2825 ULONG - Return code
2826 ===========================================================================*/
2827 QCIMPORT2K ULONG QCWWANAPI2K UpgradeFirmware2kW( WCHAR * pDestinationPath );
2828 QCIMPORT2K ULONG QCWWANAPI2K UpgradeFirmware2kA( CHAR * pDestinationPath );
2829
2830 /*===========================================================================
2831 METHOD:
2832 GetImageInfo
2833
2834 DESCRIPTION:
2835 Returns image information obtained from the firmware image located at the
2836 provided path
2837
2838 PARAMETERS:
2839 pPath [ I ] - Location of the firmware image
2840 pFirmwareID [ O ] - Firmware ID obtained from the firmware image
2841 pTechnology [ O ] - Technology (0xFFFFFFFF if unknown)
2842 pCarrier [ O ] - Carrier (0xFFFFFFFF if unknown)
2843 pRegion [ O ] - Region (0xFFFFFFFF if unknown)
2844 pGPSCapability [ O ] - GPS capability (0xFFFFFFFF if unknown)
2845
2846 RETURN VALUE:
2847 ULONG - Return code
2848 ===========================================================================*/
2849 QCIMPORT2K ULONG QCWWANAPI2K GetImageInfoW(
2850 WCHAR * pPath,
2851 ULONG * pFirmwareID,
2852 ULONG * pTechnology,
2853 ULONG * pCarrier,
2854 ULONG * pRegion,
2855 ULONG * pGPSCapability );
2856
2857 QCIMPORT2K ULONG QCWWANAPI2K GetImageInfoA(
2858 CHAR * pPath,
2859 ULONG * pFirmwareID,
2860 ULONG * pTechnology,
2861 ULONG * pCarrier,
2862 ULONG * pRegion,
2863 ULONG * pGPSCapability );
2864
2865 /*===========================================================================
2866 METHOD:
2867 GetImageStore
2868
2869 DESCRIPTION:
2870 Returns the image store folder, i.e. the folder co-located with the
2871 QDL Service executable which (by default) contains one or more carrier
2872 specific image subfolders
2873
2874 PARAMETERS:
2875 pathSize [ I ] - Maximum number of characters (including NULL
2876 terminator) that can be copied to the image
2877 store path array
2878 pImageStorePath [ O ] - The path to the image store
2879
2880 RETURN VALUE:
2881 ULONG - Return code
2882 ===========================================================================*/
2883 QCIMPORT2K ULONG QCWWANAPI2K GetImageStoreW(
2884 WORD pathSize,
2885 WCHAR * pImageStorePath );
2886
2887 QCIMPORT2K ULONG QCWWANAPI2K GetImageStoreA(
2888 WORD pathSize,
2889 CHAR * pImageStorePath );
2890 /*===========================================================================
2891 METHOD:
2892 GetImagesPreference
2893
2894 DESCRIPTION:
2895 Return the current images preference
2896
2897 PARAMETERS:
2898 pImageListSize [I/O] - Upon input the size in BYTEs of the image list
2899 array. Upon success the actual number of BYTEs
2900 copied to the image list array
2901 pImageList [ O ] - The image info list array
2902
2903 RETURN VALUE:
2904 ULONG - Return code
2905 ===========================================================================*/
2906 QCIMPORT2K ULONG QCWWANAPI2K GetImagesPreference(
2907 ULONG * pImageListSize,
2908 BYTE * pImageList );
2909 /*===========================================================================
2910 METHOD:
2911 SetImagesPreference
2912
2913 DESCRIPTION:
2914 This function sets the current images preference
2915
2916 PARAMETERS:
2917 imageListSize [ I ] - The size in BYTEs of the image list array
2918 pImageList [ I ] - The image list array
2919 bForceDownload [ I ] - Force device to download images from host?
2920 modemIndex [ I ] - Desired storage index for downloaded modem image
2921 pImageTypesSize [I/O] - Upon input the maximum number of elements that
2922 the download image types array can contain.
2923 Upon successful output the actual number of
2924 elements in the download image types array
2925 pImageTypes [ O ] - The download image types array
2926
2927 RETURN VALUE:
2928 ULONG - Return code
2929 ===========================================================================*/
2930 QCIMPORT2K ULONG QCWWANAPI2K SetImagesPreference(
2931 ULONG imageListSize,
2932 BYTE * pImageList,
2933 ULONG bForceDownload,
2934 BYTE modemIndex,
2935 ULONG * pImageTypesSize,
2936 BYTE * pImageTypes );
2937
2938 /*===========================================================================
2939 METHOD:
2940 GetStoredImages
2941
2942 DESCRIPTION:
2943 Return the list of images stored on the device
2944
2945 PARAMETERS:
2946 pImageListSize [I/O] - Upon input the size in BYTEs of the image list
2947 array. Upon success the actual number of BYTEs
2948 copied to the image list array
2949 pImageList [ O ] - The image info list array
2950
2951 RETURN VALUE:
2952 ULONG - Return code
2953 ===========================================================================*/
2954 QCIMPORT2K ULONG QCWWANAPI2K GetStoredImages(
2955 ULONG * pImageListSize,
2956 BYTE * pImageList );
2957
2958 /*===========================================================================
2959 METHOD:
2960 DeleteStoredImage
2961
2962 DESCRIPTION:
2963 This function deletes the specified image from the device
2964
2965 PARAMETERS:
2966 imageInfoSize [ I ] - The size in BYTEs of the image info array
2967 pImageInfo [ I ] - The image info array
2968
2969 RETURN VALUE:
2970 ULONG - Return code
2971 ===========================================================================*/
2972 QCIMPORT2K ULONG QCWWANAPI2K DeleteStoredImage(
2973 ULONG imageInfoSize,
2974 BYTE * pImageInfo );
2975 /*===========================================================================
2976 METHOD:
2977 GetPLMNMode
2978
2979 DESCRIPTION:
2980 This function returns the PLMN mode of the device
2981
2982 PARAMETERS:
2983 pPLMNMode [ O ] - Current PLMN mode
2984
2985 RETURN VALUE:
2986 ULONG - Return code
2987 ===========================================================================*/
2988 QCIMPORT2K ULONG QCWWANAPI2K GetPLMNMode( ULONG * pPLMNMode );
2989 /*===========================================================================
2990 METHOD:
2991 GetPLMNName
2992
2993 DESCRIPTION:
2994 This function returns PLMN name information for the given MCC/MNC
2995
2996 PARAMETERS:
2997 mcc [ I ] - Mobile country code
2998 mnc [ I ] - Mobile network code
2999 pNamesSize [I/O] - Upon input the size in BYTEs of the name structure
3000 array. Upon success the actual number of BYTEs
3001 copied to the name structure array
3002 pNames [ O ] - The name structure array
3003
3004 RETURN VALUE:
3005 ULONG - Return code
3006 ===========================================================================*/
3007 QCIMPORT2K ULONG QCWWANAPI2K GetPLMNName(
3008 WORD mcc,
3009 WORD mnc,
3010 ULONG * pNamesSize,
3011 BYTE * pNames );
3012
3013 /*===========================================================================
3014 METHOD:
3015 ResetDevice
3016
3017 DESCRIPTION:
3018 This function resets the device
3019
3020 RETURN VALUE:
3021 eGobiError - Return code
3022 ===========================================================================*/
3023 QCIMPORT2K ULONG QCWWANAPI2K ResetDevice();
3024
3025 /*===========================================================================
3026 METHOD:
3027 SetSessionStateCallback
3028
3029 DESCRIPTION:
3030 This function enables/disables the session state callback function
3031
3032 PARAMETERS:
3033 pCallback [ I ] - Callback function (0 = disable)
3034
3035 RETURN VALUE:
3036 ULONG - Return code
3037 ===========================================================================*/
3038 QCIMPORT2K ULONG QCWWANAPI2K SetSessionStateCallback( tFNSessionState pCallback );
3039
3040 /*===========================================================================
3041 METHOD:
3042 SetPacketTotalsCallback
3043
3044 DESCRIPTION:
3045 This function enables/disables the RX/TX Packet counts callback function
3046
3047 PARAMETERS:
3048 pCallback [ I ] - Callback function (0 = disable)
3049 interval [ I ] - Interval in seconds (ignored when disabling)
3050
3051 RETURN VALUE:
3052 ULONG - Return code
3053 ===========================================================================*/
3054 QCIMPORT2K ULONG QCWWANAPI2K SetPacketTotalsCallback(
3055 tFNPacketTotals pCallback,
3056 BYTE interval );
3057
3058 /*===========================================================================
3059 METHOD:
3060 SetByteTotalsCallback
3061
3062 DESCRIPTION:
3063 This function enables/disables the RX/TX byte counts callback function
3064
3065 PARAMETERS:
3066 pCallback [ I ] - Callback function (0 = disable)
3067 interval [ I ] - Interval in seconds (ignored when disabling)
3068
3069 RETURN VALUE:
3070 ULONG - Return code
3071 ===========================================================================*/
3072 QCIMPORT2K ULONG QCWWANAPI2K SetByteTotalsCallback(
3073 tFNByteTotals pCallback,
3074 BYTE interval );
3075
3076 /*===========================================================================
3077 METHOD:
3078 SetDataCapabilitiesCallback
3079
3080 DESCRIPTION:
3081 This function enables/disables the serving system data capabilities
3082 callback function
3083
3084 PARAMETERS:
3085 pCallback [ I ] - Callback function (0 = disable)
3086
3087 RETURN VALUE:
3088 ULONG - Return code
3089 ===========================================================================*/
3090 QCIMPORT2K ULONG QCWWANAPI2K SetDataCapabilitiesCallback(
3091 tFNDataCapabilities pCallback );
3092
3093 /*===========================================================================
3094 METHOD:
3095 SetDataBearerCallback
3096
3097 DESCRIPTION:
3098 This function enables/disables the data bearer status callback function
3099
3100 PARAMETERS:
3101 pCallback [ I ] - Callback function (0 = disable)
3102
3103 RETURN VALUE:
3104 ULONG - Return code
3105 ===========================================================================*/
3106 QCIMPORT2K ULONG QCWWANAPI2K SetDataBearerCallback( tFNDataBearer pCallback );
3107
3108 /*===========================================================================
3109 METHOD:
3110 SetDormancyStatusCallback
3111
3112 DESCRIPTION:
3113 This function enables/disables the dormancy status callback function
3114
3115 PARAMETERS:
3116 pCallback [ I ] - Callback function (0 = disable)
3117
3118 RETURN VALUE:
3119 ULONG - Return code
3120 ===========================================================================*/
3121 QCIMPORT2K ULONG QCWWANAPI2K SetDormancyStatusCallback(
3122 tFNDormancyStatus pCallback );
3123
3124 /*===========================================================================
3125 METHOD:
3126 SetMobileIPStatusCallback
3127
3128 DESCRIPTION:
3129 This function enables/disables the mobile IP status callback function
3130
3131 PARAMETERS:
3132 pCallback [ I ] - Callback function (0 = disable)
3133
3134 RETURN VALUE:
3135 ULONG - Return code
3136 ===========================================================================*/
3137 QCIMPORT2K ULONG QCWWANAPI2K SetMobileIPStatusCallback(
3138 tFNMobileIPStatus pCallback );
3139
3140 /*===========================================================================
3141 METHOD:
3142 SetActivationStatusCallback
3143
3144 DESCRIPTION:
3145 This function enables/disables the activation status callback function
3146
3147 PARAMETERS:
3148 pCallback [ I ] - Callback function (0 = disable)
3149
3150 RETURN VALUE:
3151 ULONG - Return code
3152 ===========================================================================*/
3153 QCIMPORT2K ULONG QCWWANAPI2K SetActivationStatusCallback(
3154 tFNActivationStatus pCallback );
3155
3156 /*===========================================================================
3157 METHOD:
3158 SetPowerCallback
3159
3160 DESCRIPTION:
3161 Enable/disable power operating mode callback function
3162
3163 PARAMETERS:
3164 pCallback [ I ] - Callback function
3165
3166 RETURN VALUE:
3167 ULONG
3168 ===========================================================================*/
3169 QCIMPORT2K ULONG QCWWANAPI2K SetPowerCallback( tFNPower pCallback );
3170
3171 /*===========================================================================
3172 METHOD:
3173 SetRoamingIndicatorCallback
3174
3175 DESCRIPTION:
3176 This function enables/disables the roaming indicator callback function
3177
3178 PARAMETERS:
3179 pCallback [ I ] - Callback function (0 = disable)
3180
3181 RETURN VALUE:
3182 ULONG - Return code
3183 ===========================================================================*/
3184 QCIMPORT2K ULONG QCWWANAPI2K SetRoamingIndicatorCallback(
3185 tFNRoamingIndicator pCallback );
3186
3187 /*===========================================================================
3188 METHOD:
3189 SetSignalStrengthCallback
3190
3191 DESCRIPTION:
3192 This function enables/disables the signal strength callback function
3193
3194 PARAMETERS:
3195 pCallback [ I ] - Callback function (0 = disable)
3196 thresholdsSize [ I ] - Number of elements the threshold array contain
3197 (a maximum of 5 thresholds is supported), must
3198 be 0 when disabling the callback
3199 pThresholds [ I ] - Signal threshold array (each entry in dBm),
3200 must be 0 when disabling the callback
3201
3202 RETURN VALUE:
3203 ULONG - Return code
3204 ===========================================================================*/
3205 QCIMPORT2K ULONG QCWWANAPI2K SetSignalStrengthCallback(
3206 tFNSignalStrength pCallback,
3207 BYTE thresholdsSize,
3208 INT8 * pThresholds );
3209
3210 /*===========================================================================
3211 METHOD:
3212 SetRFInfoCallback
3213
3214 DESCRIPTION:
3215 This function enables/disables the RF information callback function
3216
3217 PARAMETERS:
3218 pCallback [ I ] - Callback function (0 = disable)
3219
3220 RETURN VALUE:
3221 ULONG - Return code
3222 ===========================================================================*/
3223 QCIMPORT2K ULONG QCWWANAPI2K SetRFInfoCallback( tFNRFInfo pCallback );
3224
3225 /*===========================================================================
3226 METHOD:
3227 SetLURejectCallback
3228
3229 DESCRIPTION:
3230 This function enables/disables the LU reject callback function
3231
3232 PARAMETERS:
3233 pCallback [ I ] - Callback function (0 = disable)
3234
3235 RETURN VALUE:
3236 ULONG - Return code
3237 ===========================================================================*/
3238 QCIMPORT2K ULONG QCWWANAPI2K SetLURejectCallback( tFNLUReject pCallback );
3239
3240 /*===========================================================================
3241 METHOD:
3242 SetNewSMSCallback
3243
3244 DESCRIPTION:
3245 This function enables/disables the new SMS callback function
3246
3247 PARAMETERS:
3248 pCallback [ I ] - Callback function (0 = disable)
3249
3250 RETURN VALUE:
3251 ULONG - Return code
3252 ===========================================================================*/
3253 QCIMPORT2K ULONG QCWWANAPI2K SetNewSMSCallback( tFNNewSMS pCallback );
3254
3255 /*===========================================================================
3256 METHOD:
3257 SetNMEACallback
3258
3259 DESCRIPTION:
3260 This function enables/disables the NMEA sentence callback function
3261
3262 PARAMETERS:
3263 pCallback [ I ] - Callback function (0 = disable)
3264
3265 RETURN VALUE:
3266 ULONG - Return code
3267 ===========================================================================*/
3268 QCIMPORT2K ULONG QCWWANAPI2K SetNMEACallback( tFNNewNMEA pCallback );
3269
3270 /*===========================================================================
3271 METHOD:
3272 SetNMEAPlusCallback
3273
3274 DESCRIPTION:
3275 This function enables/disables the NMEA sentence plus mode
3276 callback function
3277
3278 PARAMETERS:
3279 pCallback [ I ] - Callback function (0 = disable)
3280
3281 RETURN VALUE:
3282 ULONG - Return code
3283 ===========================================================================*/
3284 QCIMPORT2K ULONG QCWWANAPI2K SetNMEAPlusCallback( tFNNewNMEAPlus pCallback );
3285
3286 /*===========================================================================
3287 METHOD:
3288 SetPDSStateCallback
3289
3290 DESCRIPTION:
3291 This function enables/disables the PDS service state callback function
3292
3293 PARAMETERS:
3294 pCallback [ I ] - Callback function (0 = disable)
3295
3296 RETURN VALUE:
3297 ULONG - Return code
3298 ===========================================================================*/
3299 QCIMPORT2K ULONG QCWWANAPI2K SetPDSStateCallback( tFNPDSState pCallback );
3300
3301 /*===========================================================================
3302 METHOD:
3303 SetCATEventCallback
3304
3305 DESCRIPTION:
3306 This function enables/disables the CAT event callback function
3307
3308 PARAMETERS:
3309 pCallback [ I ] - Callback function (0 = disable)
3310 eventMask [ I ] - Bitmask of CAT events to register for
3311 pErrorMask [ O ] - Error bitmask
3312
3313 RETURN VALUE:
3314 ULONG - Return code
3315 ===========================================================================*/
3316 QCIMPORT2K ULONG QCWWANAPI2K SetCATEventCallback(
3317 tFNCATEvent pCallback,
3318 ULONG eventMask,
3319 ULONG * pErrorMask );
3320
3321 /*===========================================================================
3322 METHOD:
3323 SetOMADMAlertCallback
3324
3325 DESCRIPTION:
3326 This function enables/disables the OMA-DM network initiated alert
3327 callback function
3328
3329 PARAMETERS:
3330 pCallback [ I ] - Callback function (0 = disable)
3331
3332 RETURN VALUE:
3333 ULONG - Return code
3334 ===========================================================================*/
3335 QCIMPORT2K ULONG QCWWANAPI2K SetOMADMAlertCallback( tFNOMADMAlert pCallback );
3336
3337 /*===========================================================================
3338 METHOD:
3339 SetOMADMStateCallback
3340
3341 DESCRIPTION:
3342 This function enables/disables the OMA-DM state callback function
3343
3344 PARAMETERS:
3345 pCallback [ I ] - Callback function (0 = disable)
3346
3347 RETURN VALUE:
3348 ULONG - Return code
3349 ===========================================================================*/
3350 QCIMPORT2K ULONG QCWWANAPI2K SetOMADMStateCallback( tFNOMADMState pCallback );
3351
3352 /*===========================================================================
3353 METHOD:
3354 SetPLMNModeCallback
3355
3356 DESCRIPTION:
3357 This function enables/disables the NAS PLMN Mode state callback function
3358
3359 PARAMETERS:
3360 pCallback [ I ] - Callback function (0 = disable)
3361
3362 RETURN VALUE:
3363 ULONG - Return code
3364 ===========================================================================*/
3365 QCIMPORT2K ULONG QCWWANAPI2K SetPLMNModeCallback( tFNPLMNMode pCallback );
3366
3367 /*=========================================================================*/
3368 // ANSI/UNICODE Varaints
3369 /*=========================================================================*/
3370 #ifdef UNICODE
3371 #define GetFirmwareID GetFirmwareIDW
3372 #define UpgradeFirmware UpgradeFirmwareW
3373 #define UpgradeFirmware2k UpgradeFirmware2kW
3374 #define GetImageInfo GetImageInfoW
3375 #define GetImageStore GetImageStoreW
3376
3377 #else
3378 #define GetFirmwareID GetFirmwareIDA
3379 #define UpgradeFirmware UpgradeFirmwareA
3380 #define UpgradeFirmware2k UpgradeFirmware2kA
3381 #define GetImageInfo GetImageInfoA
3382 #define GetImageStore GetImageStoreA
3383 #endif
SetLURejectCallback
IMPORTGOBI ULONG GOBICMAPI SetLURejectCallback(tFNLUReject pCallback)
SetImagesPreference
IMPORTGOBI ULONG GOBIAPI SetImagesPreference(ULONG imageListSize, BYTE *pImageList, ULONG bForceDownload, BYTE modemIndex, ULONG *pImageTypesSize, BYTE *pImageTypes)
CATSendTerminalResponse
IMPORTGOBI ULONG GOBICMAPI CATSendTerminalResponse(ULONG refID, ULONG dataLen, BYTE *pData)
GetActivationState
IMPORTGOBI ULONG GOBICMAPI GetActivationState(ULONG *pActivationState)
SetSMSWake
IMPORTGOBI ULONG GOBICMAPI SetSMSWake(ULONG bEnable, ULONG wakeMask)
SetNMEAPlusCallback
QCIMPORT2K ULONG QCWWANAPI2K SetNMEAPlusCallback(tFNNewNMEAPlus pCallback)
GetMobileIP
IMPORTGOBI ULONG GOBICMAPI GetMobileIP(ULONG *pMode)
StartPDSTrackingSession
QCIMPORT2K ULONG QCWWANAPI2K StartPDSTrackingSession(ULONG fixInterval)
UpgradeFirmwareA
IMPORTGOBI ULONG GOBICMAPI UpgradeFirmwareA(CHAR *pSourcePath, CHAR *pDestinationPath)
tFNPacketTotals
void(SWICALLBACK * tFNPacketTotals)(ULONG totalPacketTX, ULONG totalPacketRX)
API Return Codes.
Definition: SwiWwanCmApi.h:60
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)
GetSMS
IMPORTGOBI ULONG GOBICMAPI GetSMS(ULONG storageType, ULONG messageIndex, ULONG *pMessageTag, ULONG *pMessageFormat, ULONG *pMessageSize, BYTE *pMessage)
ModifySMSStatus
IMPORTGOBI ULONG GOBICMAPI ModifySMSStatus(ULONG storageType, ULONG messageIndex, ULONG messageTag)
GetVoiceNumber
IMPORTGOBI ULONG GOBICMAPI GetVoiceNumber(BYTE voiceNumberSize, CHAR *pVoiceNumber, BYTE minSize, CHAR *pMIN)
GetActiveMobileIPProfile
IMPORTGOBI ULONG GOBICMAPI GetActiveMobileIPProfile(BYTE *pIndex)
SetSignalStrengthCallback
IMPORTGOBI ULONG GOBICMAPI SetSignalStrengthCallback(tFNSignalStrength pCallback, BYTE thresholdsSize, INT8 *pThresholds)
GetImageInfoA
IMPORTGOBI ULONG GOBICMAPI GetImageInfoA(CHAR *pPath, ULONG *pFirmwareID, ULONG *pTechnology, ULONG *pCarrier, ULONG *pRegion, ULONG *pGPSCapability)
SwiGetServingNetwork
SWIIMPORT ULONG SWICMAPI SwiGetServingNetwork(ULONG *pRegistrationState, ULONG *pCSDomain, ULONG *pPSDomain, ULONG *pRAN, BYTE *pRadioIfacesSize, BYTE *pRadioIfaces, ULONG *pRoaming, WORD *pMCC, WORD *pMNC, BYTE nameSize, CHAR *pName, WORD *pSID, WORD *pNID)
Gets information regarding the system that currently provides service to the device.
SaveSMS
IMPORTGOBI ULONG GOBICMAPI SaveSMS(ULONG storageType, ULONG messageFormat, ULONG messageSize, BYTE *pMessage, ULONG *pMessageIndex)
PerformNetworkRATScan
IMPORTGOBI ULONG GOBICMAPI PerformNetworkRATScan(BYTE *pInstanceSize, BYTE *pInstances, BYTE *pRATSize, BYTE *pRATInstances)
GetAutoconnect
IMPORTGOBI ULONG GOBICMAPI GetAutoconnect(ULONG *pSetting)
GetManufacturer
IMPORTGOBI ULONG GOBICMAPI GetManufacturer(BYTE stringSize, CHAR *pString)
GetNetworkTime
IMPORTGOBI ULONG GOBICMAPI GetNetworkTime(ULONGLONG *pTimeCount, ULONG *pTimeSource)
StartDataSession
IMPORTGOBI ULONG GOBICMAPI StartDataSession(ULONG *pTechnology, ULONG *pPrimaryDNS, ULONG *pSecondaryDNS, ULONG *pPrimaryNBNS, ULONG *pSecondaryNBNS, CHAR *pAPNName, ULONG *pIPAddress, ULONG *pAuthentication, CHAR *pUsername, CHAR *pPassword, ULONG *pSessionId)
StartDataSession2
IMPORTGOBI ULONG GOBICMAPI StartDataSession2(ULONG *pTechnology, ULONG *pPrimaryDNS, ULONG *pSecondaryDNS, ULONG *pPrimaryNBNS, ULONG *pSecondaryNBNS, CHAR *pAPNName, ULONG *pIPAddress, ULONG *pAuthentication, CHAR *pUsername, CHAR *pPassword, ULONG *pSessionId, ULONG *pFailureReason)
GetSMSWake
IMPORTGOBI ULONG GOBICMAPI GetSMSWake(ULONG *pbEnabled, ULONG *pWakeMask)
SetPDSStateCallback
IMPORTGOBI ULONG GOBICMAPI SetPDSStateCallback(tFNPDSState pCallback)
SetServiceAutomaticTracking
IMPORTGOBI ULONG GOBICMAPI SetServiceAutomaticTracking(ULONG bAuto)
SetPower
IMPORTGOBI ULONG GOBICMAPI SetPower(ULONG powerMode)
GetSMSCAddress
IMPORTGOBI ULONG GOBICMAPI GetSMSCAddress(BYTE addressSize, CHAR *pSMSCAddress, BYTE typeSize, CHAR *pSMSCType)
DeleteSMS
IMPORTGOBI ULONG GOBICMAPI DeleteSMS(ULONG storageType, ULONG *pMessageIndex, ULONG *pMessageTag)
UpgradeFirmware2kW
IMPORTGOBI ULONG GOBICMAPI UpgradeFirmware2kW(WCHAR *pDestinationPath)
OMADMStartSession
IMPORTGOBI ULONG GOBICMAPI OMADMStartSession(ULONG sessionType)
GetSessionState
IMPORTGOBI ULONG GOBICMAPI GetSessionState(ULONG *pState)
OMADMSendSelection
IMPORTGOBI ULONG GOBICMAPI OMADMSendSelection(ULONG selection, USHORT sessionID)
GetSignalStrengths
IMPORTGOBI ULONG GOBICMAPI GetSignalStrengths(ULONG *pArraySizes, INT8 *pSignalStrengths, ULONG *pRadioInterfaces)
OMADMSetPRLUpdateFeature
IMPORTGOBI ULONG GOBICMAPI OMADMSetPRLUpdateFeature(ULONG bPRLUpdate)
GetSMSList
IMPORTGOBI ULONG GOBICMAPI GetSMSList(ULONG storageType, ULONG *pRequestedTag, ULONG *pMessageListSize, BYTE *pMessageList)
SetMobileIP
IMPORTGOBI ULONG GOBICMAPI SetMobileIP(ULONG mode)
SetXTRAAutomaticDownload
IMPORTGOBI ULONG GOBICMAPI SetXTRAAutomaticDownload(ULONG bEnabled, USHORT interval)
SetPacketTotalsCallback
QCIMPORT2K ULONG QCWWANAPI2K SetPacketTotalsCallback(tFNPacketTotals pCallback, BYTE interval)
GetANAAAAuthenticationStatus
IMPORTGOBI ULONG GOBICMAPI GetANAAAAuthenticationStatus(ULONG *pStatus)
GetDataBearerTechnology
IMPORTGOBI ULONG GOBICMAPI GetDataBearerTechnology(ULONG *pDataBearer)
SetPDSState
IMPORTGOBI ULONG GOBICMAPI SetPDSState(ULONG enable)
SetPowerCallback
IMPORTGOBI ULONG GOBICMAPI SetPowerCallback(tFNPower pCallback)
GetFirmwareRevision
IMPORTGOBI ULONG GOBICMAPI GetFirmwareRevision(BYTE stringSize, CHAR *pString)
OMADMGetPendingNIA
IMPORTGOBI ULONG GOBICMAPI OMADMGetPendingNIA(ULONG *pSessionType, USHORT *pSessionID)
GetFirmwareIDA
IMPORTGOBI ULONG GOBICMAPI GetFirmwareIDA(CHAR *pPath, ULONG *pFirmwareID)
ActivateManual
IMPORTGOBI ULONG GOBICMAPI ActivateManual(CHAR *pSPC, WORD sid, CHAR *pMDN, CHAR *pMIN, ULONG prlSize, BYTE *pPRL, CHAR *pMNHA, CHAR *pMNAAA)
GetImagesPreference
IMPORTGOBI ULONG GOBIAPI GetImagesPreference(ULONG *pImageListSize, BYTE *pImageList)
GetXTRAValidity
IMPORTGOBI ULONG GOBICMAPI GetXTRAValidity(USHORT *pGPSWeek, USHORT *pGPSWeekOffset, USHORT *pDuration)
InitiateDomainAttach
IMPORTGOBI ULONG GOBICMAPI InitiateDomainAttach(ULONG action)
OMADMGetSessionInfo
IMPORTGOBI ULONG GOBICMAPI OMADMGetSessionInfo(ULONG *pSessionState, ULONG *pSessionType, ULONG *pFailureReason, BYTE *pRetryCount, WORD *pSessionPause, WORD *pTimeRemaining)
SetDormancyStatusCallback
IMPORTGOBI ULONG GOBICMAPI SetDormancyStatusCallback(tFNDormancyStatus pCallback)
StopPDSTrackingSession
QCIMPORT2K ULONG QCWWANAPI2K StopPDSTrackingSession()
ResetToFactoryDefaults
IMPORTGOBI ULONG GOBICMAPI ResetToFactoryDefaults(CHAR *pSPC)
GetPDSDefaults
IMPORTGOBI ULONG GOBICMAPI GetPDSDefaults(ULONG *pOperation, BYTE *pTimeout, ULONG *pInterval, ULONG *pAccuracy)
GetConnectionRate
IMPORTGOBI ULONG GOBICMAPI GetConnectionRate(ULONG *pCurrentChannelTXRate, ULONG *pCurrentChannelRXRate, ULONG *pMaxChannelTXRate, ULONG *pMaxChannelRXRate)
GetPower
IMPORTGOBI ULONG GOBICMAPI GetPower(ULONG *pPowerMode)
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)
GetFirmwareInfo
IMPORTGOBI ULONG GOBICMAPI GetFirmwareInfo(ULONG *pFirmwareID, ULONG *pTechnology, ULONG *pCarrier, ULONG *pRegion, ULONG *pGPSCapability)
SetNetworkPreference
IMPORTGOBI ULONG GOBICMAPI SetNetworkPreference(ULONG technologyPref, ULONG duration)
SendSMS
IMPORTGOBI ULONG GOBICMAPI SendSMS(ULONG messageFormat, ULONG messageSize, BYTE *pMessage, BYTE link_timer, ULONG *pMessageFailureCode)
GetMobileIPProfile
IMPORTGOBI ULONG GOBICMAPI GetMobileIPProfile(BYTE index, BYTE *pEnabled, ULONG *pAddress, ULONG *pPrimaryHA, ULONG *pSecondaryHA, BYTE *pRevTunneling, BYTE naiSize, CHAR *pNAI, ULONG *pHASPI, ULONG *pAAASPI)
PDSInjectTimeReference
IMPORTGOBI ULONG GOBICMAPI PDSInjectTimeReference(ULONGLONG systemTime, USHORT systemDiscontinuities)
GetByteTotals
IMPORTGOBI ULONG GOBICMAPI GetByteTotals(ULONGLONG *pTXTotalBytes, ULONGLONG *pRXTotalBytes)
GetDormancyState
IMPORTGOBI ULONG GOBICMAPI GetDormancyState(ULONG *pState)
GetMobileIPProfile2
IMPORTGOBI ULONG GOBICMAPI GetMobileIPProfile2(BYTE index, BYTE *pEnabled, ULONG *pAddress, ULONG *pPrimaryHA, ULONG *pSecondaryHA, BYTE *pRevTunneling, BYTE naiSize, CHAR *pNAI, ULONG *pHASPI, ULONG *pAAASPI, ULONG *pHAState, ULONG *pAAAState)
OMADMCancelSession
IMPORTGOBI ULONG GOBICMAPI OMADMCancelSession()
QCWWAN2kEnumerateDevices
IMPORTGOBI ULONG GOBICMAPI QCWWAN2kEnumerateDevices(BYTE *pDevicesSize, BYTE *pDevices)
SetMobileIPProfile
IMPORTGOBI ULONG GOBICMAPI SetMobileIPProfile(CHAR *pSPC, BYTE index, BYTE *pEnabled, ULONG *pAddress, ULONG *pPrimaryHA, ULONG *pSecondaryHA, BYTE *pRevTunneling, CHAR *pNAI, ULONG *pHASPI, ULONG *pAAASPI, CHAR *pMNHA, CHAR *pMNAAA)
SetActivationStatusCallback
IMPORTGOBI ULONG GOBICMAPI SetActivationStatusCallback(tFNActivationStatus pCallback)
SetAutoconnect
IMPORTGOBI ULONG GOBICMAPI SetAutoconnect(ULONG setting)
SetNewSMSCallback
IMPORTGOBI ULONG GOBICMAPI SetNewSMSCallback(tFNNewSMS pCallback)
GetMobileIPParameters
IMPORTGOBI ULONG GOBICMAPI GetMobileIPParameters(ULONG *pMode, BYTE *pRetryLimit, BYTE *pRetryInterval, BYTE *pReRegPeriod, BYTE *pReRegTraffic, BYTE *pHAAuthenticator, BYTE *pHA2002bis)
GetImageStoreA
IMPORTGOBI ULONG GOBICMAPI GetImageStoreA(WORD pathSize, CHAR *pImageStorePath)
SetActiveMobileIPProfile
IMPORTGOBI ULONG GOBICMAPI SetActiveMobileIPProfile(CHAR *pSPC, BYTE index)
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)
GetAGPSConfig
IMPORTGOBI ULONG GOBICMAPI GetAGPSConfig(ULONG *pServerAddress, ULONG *pServerPort)
GetServingNetworkCapabilities
IMPORTGOBI ULONG GOBICMAPI GetServingNetworkCapabilities(BYTE *pDataCapsSize, BYTE *pDataCaps)
OMADMSetProvisioningFeature
IMPORTGOBI ULONG GOBICMAPI OMADMSetProvisioningFeature(ULONG bProvisioning)
SetDefaultProfile
IMPORTGOBI ULONG GOBICMAPI SetDefaultProfile(ULONG profileType, ULONG *pPDPType, ULONG *pIPAddress, ULONG *pPrimaryDNS, ULONG *pSecondaryDNS, ULONG *pAuthentication, CHAR *pName, CHAR *pAPNName, CHAR *pUsername, CHAR *pPassword)
GetFirmwareRevisions
IMPORTGOBI ULONG GOBICMAPI GetFirmwareRevisions(BYTE amssSize, CHAR *pAMSSString, BYTE bootSize, CHAR *pBootString, BYTE priSize, CHAR *pPRIString)
GetIPAddress
IMPORTGOBI ULONG GOBICMAPI GetIPAddress(ULONG *pIPAddress)
SetNMEACallback
IMPORTGOBI ULONG GOBICMAPI SetNMEACallback(tFNNewNMEA pCallback)
DMSUIMGetControlKeyStatus
IMPORTGOBI ULONG GOBICMAPI DMSUIMGetControlKeyStatus(ULONG id, ULONG *pStatus, ULONG *pVerifyRetriesLeft, ULONG *pUnblockRetriesLeft)
ResetPDSData
IMPORTGOBI ULONG GOBICMAPI ResetPDSData(ULONG *pGPSDataMask, ULONG *pCellDataMask)
GetPLMNMode
IMPORTGOBI ULONG GOBICMAPI GetPLMNMode(ULONG *pMode)
GetXTRAAutomaticDownload
IMPORTGOBI ULONG GOBICMAPI GetXTRAAutomaticDownload(ULONG *pbEnabled, USHORT *pInterval)
GetXTRANetwork
IMPORTGOBI ULONG GOBICMAPI GetXTRANetwork(ULONG *pPreference)
SetMobileIPStatusCallback
IMPORTGOBI ULONG GOBICMAPI SetMobileIPStatusCallback(tFNMobileIPStatus pCallback)
SetMobileIPParameters
IMPORTGOBI ULONG GOBICMAPI SetMobileIPParameters(CHAR *pSPC, ULONG *pMode, BYTE *pRetryLimit, BYTE *pRetryInterval, BYTE *pReRegPeriod, BYTE *pReRegTraffic, BYTE *pHAAuthenticator, BYTE *pHA2002bis)
DMSUIMUnblockControlKey
IMPORTGOBI ULONG GOBICMAPI DMSUIMUnblockControlKey(ULONG id, CHAR *pValue, ULONG *pUnblockRetriesLeft)
SetPortAutomaticTracking
IMPORTGOBI ULONG GOBICMAPI SetPortAutomaticTracking(ULONG bAuto)
GetStoredImages
IMPORTGOBI ULONG GOBIAPI GetStoredImages(ULONG *pImageListSize, BYTE *pImageList)
GetImageInfoW
IMPORTGOBI ULONG GOBICMAPI GetImageInfoW(WCHAR *pPath, ULONG *pFirmwareID, ULONG *pTechnology, ULONG *pCarrier, ULONG *pRegion, ULONG *pGPSCapability)
GetPortAutomaticTracking
IMPORTGOBI ULONG GOBICMAPI GetPortAutomaticTracking(ULONG *pbAuto)
GetSerialNumbers
IMPORTGOBI ULONG GOBICMAPI GetSerialNumbers(BYTE esnSize, CHAR *pESNString, BYTE imeiSize, CHAR *pIMEIString, BYTE meidSize, CHAR *pMEIDString)
ForceXTRADownload
IMPORTGOBI ULONG GOBICMAPI ForceXTRADownload()
GetIMSI
IMPORTGOBI ULONG GOBICMAPI GetIMSI(BYTE stringSize, CHAR *pString)
GetHardwareRevision
IMPORTGOBI ULONG GOBICMAPI GetHardwareRevision(BYTE stringSize, CHAR *pString)
GetModelID
IMPORTGOBI ULONG GOBICMAPI GetModelID(BYTE stringSize, CHAR *pString)
DeleteStoredImage
IMPORTGOBI ULONG GOBIAPI DeleteStoredImage(ULONG imageInfoSize, BYTE *pImageInfo)
InitiateNetworkRegistration
IMPORTGOBI ULONG GOBICMAPI InitiateNetworkRegistration(ULONG regType, WORD mcc, WORD mnc, ULONG rat)
GetOfflineReason
IMPORTGOBI ULONG GOBICMAPI GetOfflineReason(ULONG *pReasonMask, ULONG *pbPlatform)
SetOMADMStateCallback
IMPORTGOBI ULONG GOBICMAPI SetOMADMStateCallback(tFNOMADMState pCallback)
GetImageStoreW
IMPORTGOBI ULONG GOBICMAPI GetImageStoreW(WORD pathSize, WCHAR *pImageStorePath)
SetCATEventCallback
IMPORTGOBI ULONG GOBICMAPI SetCATEventCallback(tFNCATEvent pCallback, ULONG eventMask, ULONG *pErrorMask)
ActivateAutomatic
IMPORTGOBI ULONG GOBICMAPI ActivateAutomatic(CHAR *pActivationCode)
SetRoamingIndicatorCallback
IMPORTGOBI ULONG GOBICMAPI SetRoamingIndicatorCallback(tFNRoamingIndicator pCallback)
GetERIFile
IMPORTGOBI ULONG GOBICMAPI GetERIFile(ULONG *pFileSize, BYTE *pFile)
SetPDSDefaults
IMPORTGOBI ULONG GOBICMAPI SetPDSDefaults(ULONG operation, BYTE timeout, ULONG interval, ULONG accuracy)
GetPLMNName
IMPORTGOBI ULONG GOBICMAPI GetPLMNName(USHORT mcc, USHORT mnc, ULONG *pNamesSize, BYTE *pNames)
SetXTRANetwork
IMPORTGOBI ULONG GOBICMAPI SetXTRANetwork(ULONG preference)
ValidateSPC
IMPORTGOBI ULONG GOBICMAPI ValidateSPC(CHAR *pSPC)
GetRFInfo
IMPORTGOBI ULONG GOBICMAPI GetRFInfo(BYTE *pInstanceSize, BYTE *pInstances)
GetPDSState
IMPORTGOBI ULONG GOBICMAPI GetPDSState(ULONG *pEnabled, ULONG *pTracking)
SetRFInfoCallback
IMPORTGOBI ULONG GOBICMAPI SetRFInfoCallback(tFNRFInfo pCallback)
SetAGPSConfig
IMPORTGOBI ULONG GOBICMAPI SetAGPSConfig(ULONG serverAddress, ULONG serverPort)
QCWWAN2kConnect
IMPORTGOBI ULONG GOBICMAPI QCWWAN2kConnect(CHAR *pDeviceID, CHAR *pDeviceKey)
DMSUIMSetControlKeyProtection
IMPORTGOBI ULONG GOBICMAPI DMSUIMSetControlKeyProtection(ULONG id, ULONG status, CHAR *pValue, ULONG *pVerifyRetriesLeft)
PerformNetworkScan
IMPORTGOBI ULONG GOBICMAPI PerformNetworkScan(BYTE *pInstanceSize, BYTE *pInstances)
GetDeviceCapabilities
IMPORTGOBI ULONG GOBICMAPI GetDeviceCapabilities(ULONG *pMaxTXChannelRate, ULONG *pMaxRXChannelRate, ULONG *pDataServiceCapability, ULONG *pSimCapability, ULONG *pRadioIfacesSize, BYTE *pRadioIfaces)
SetOMADMAlertCallback
IMPORTGOBI ULONG GOBICMAPI SetOMADMAlertCallback(tFNOMADMAlert pCallback)
QCWWANDisconnect
IMPORTGOBI ULONG GOBICMAPI QCWWANDisconnect()
SetSMSCAddress
IMPORTGOBI ULONG GOBICMAPI SetSMSCAddress(CHAR *pSMSCAddress, CHAR *pSMSCType)
CATSendEnvelopeCommand
IMPORTGOBI ULONG GOBICMAPI CATSendEnvelopeCommand(ULONG cmdID, ULONG dataLen, BYTE *pData)
QCWWANConnect
IMPORTGOBI ULONG GOBICMAPI QCWWANConnect()
QCWWAN2kGetConnectedDeviceID
IMPORTGOBI ULONG GOBICMAPI QCWWAN2kGetConnectedDeviceID(ULONG deviceIDSize, CHAR *pDeviceID, ULONG deviceKeySize, CHAR *pDeviceKey)
GetPRLVersion
IMPORTGOBI ULONG GOBICMAPI GetPRLVersion(WORD *pPRLVersion)
GetPacketStatus
IMPORTGOBI ULONG GOBICMAPI GetPacketStatus(ULONG *pTXPacketSuccesses, ULONG *pRXPacketSuccesses, ULONG *pTXPacketErrors, ULONG *pRXPacketErrors, ULONG *pTXPacketOverflows, ULONG *pRXPacketOverflows)
GetSessionDuration
IMPORTGOBI ULONG GOBICMAPI GetSessionDuration(ULONGLONG *pDuration)
GetLastMobileIPError
IMPORTGOBI ULONG GOBICMAPI GetLastMobileIPError(ULONG *pError)
GetServiceAutomaticTracking
IMPORTGOBI ULONG GOBICMAPI GetServiceAutomaticTracking(ULONG *pbAuto)
GetNetworkPreference
IMPORTGOBI ULONG GOBICMAPI GetNetworkPreference(ULONG *pTechnologyPref, ULONG *pDuration, ULONG *pPersistentTechnologyPref)
StopDataSession
IMPORTGOBI ULONG GOBICMAPI StopDataSession(ULONG sessionId)
ResetDevice
IMPORTGOBI ULONG GOBIAPI ResetDevice()
GetHomeNetwork
IMPORTGOBI ULONG GOBICMAPI GetHomeNetwork(WORD *pMCC, WORD *pMNC, BYTE nameSize, CHAR *pName, WORD *pSID, WORD *pNID)
SetSessionStateCallback
IMPORTGOBI ULONG GOBICMAPI SetSessionStateCallback(tFNSessionState pCallback)
SetByteTotalsCallback
IMPORTGOBI ULONG GOBICMAPI SetByteTotalsCallback(tFNByteTotals pCallback, BYTE interval)
GetDefaultProfile
IMPORTGOBI ULONG GOBICMAPI GetDefaultProfile(ULONG profileType, ULONG *pPDPType, ULONG *pIPAddress, ULONG *pPrimaryDNS, ULONG *pSecondaryDNS, ULONG *pAuthentication, BYTE nameSize, CHAR *pName, BYTE apnSize, CHAR *pAPNName, BYTE userSize, CHAR *pUsername)
UpgradeFirmware2kA
IMPORTGOBI ULONG GOBICMAPI UpgradeFirmware2kA(CHAR *pDestinationPath)
GetFirmwareIDW
IMPORTGOBI ULONG GOBICMAPI GetFirmwareIDW(WCHAR *pPath, ULONG *pFirmwareID)
OMADMGetFeatureSettings
IMPORTGOBI ULONG GOBICMAPI OMADMGetFeatureSettings(ULONG *pbProvisioning, ULONG *pbPRLUpdate)
SetDataBearerCallback
IMPORTGOBI ULONG GOBICMAPI SetDataBearerCallback(tFNDataBearer pCallback)
DMSUIMGetICCID
IMPORTGOBI ULONG GOBICMAPI DMSUIMGetICCID(BYTE stringSize, CHAR *pString)
QCWWANGetConnectedDeviceID
IMPORTGOBI ULONG GOBICMAPI QCWWANGetConnectedDeviceID(ULONG stringSize, CHAR *pString)
UpgradeFirmwareW
IMPORTGOBI ULONG GOBICMAPI UpgradeFirmwareW(WCHAR *pSourcePath, WCHAR *pDestinationPath)