| CE Gobi SDK 2.7 GobiApi

- Main Page
- Modules
- Classes
- Files

- File List

QmiDMS.h
1 /*===========================================================================
2 FILE:
3 QmiDMSAPI.h
4
5 DESCRIPTION:
6 QMI Device Management Service APIs. Service type 0x02
7
8 Copyright (C) 2015 Sierra Wireless Incorporated. All rights reserved.
9 Sierra Wireless Proprietary/GTDR
10 ==========================================================================*/
11
12 #ifndef __QMI_DMS_API_H__
13 #define __QMI_DMS_API_H__
14 /*=========================================================================*/
15 // Definitions
16 /*=========================================================================*/
17
22
23 /*=========================================================================*/
24 // Structs
25 /*=========================================================================*/
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29
30 #ifdef __cplusplus
31 };
32 #endif
33
34 /*=========================================================================*/
35 // Prototypes
36 /*=========================================================================*/
37
48 IMPORTGOBI ULONG GOBICMAPI SetPowerCallback( tFNPower pCallback );
49
60 IMPORTGOBI ULONG GOBICMAPI SetActivationStatusCallback(
61 tFNActivationStatus pCallback );
62
75 IMPORTGOBI ULONG GOBICMAPI DMSUIMGetICCID(
76 BYTE stringSize,
77 CHAR * pString );
78
95 IMPORTGOBI ULONG GOBICMAPI DMSUIMGetControlKeyStatus(
96 ULONG id,
97 ULONG * pStatus,
98 ULONG * pVerifyRetriesLeft,
99 ULONG * pUnblockRetriesLeft );
100
101
117 IMPORTGOBI ULONG GOBICMAPI DMSUIMSetControlKeyProtection(
118 ULONG id,
119 ULONG status,
120 CHAR * pValue,
121 ULONG * pVerifyRetriesLeft );
122
137 IMPORTGOBI ULONG GOBICMAPI DMSUIMUnblockControlKey(
138 ULONG id,
139 CHAR * pValue,
140 ULONG * pUnblockRetriesLeft );
141
163 IMPORTGOBI ULONG GOBICMAPI DMSUIMSetPINProtection(
164 ULONG id,
165 ULONG bEnable,
166 CHAR * pValue,
167 ULONG * pVerifyRetriesLeft,
168 ULONG * pUnblockRetriesLeft );
169
188 IMPORTGOBI ULONG GOBICMAPI DMSUIMVerifyPIN(
189 ULONG id,
190 CHAR * pValue,
191 ULONG * pVerifyRetriesLeft,
192 ULONG * pUnblockRetriesLeft );
193
215 IMPORTGOBI ULONG GOBICMAPI DMSUIMUnblockPIN(
216 ULONG id,
217 CHAR * pPUKValue,
218 CHAR * pNewValue,
219 ULONG * pVerifyRetriesLeft,
220 ULONG * pUnblockRetriesLeft );
221
241 IMPORTGOBI ULONG GOBICMAPI DMSUIMChangePIN(
242 ULONG id,
243 CHAR * pOldValue,
244 CHAR * pNewValue,
245 ULONG * pVerifyRetriesLeft,
246 ULONG * pUnblockRetriesLeft );
247
262 IMPORTGOBI ULONG GOBICMAPI DMSUIMGetPINStatus(
263 ULONG id,
264 ULONG * pStatus,
265 ULONG * pVerifyRetriesLeft,
266 ULONG * pUnblockRetriesLeft );
267
280 IMPORTGOBI ULONG GOBICMAPI GetHardwareRevision(
281 BYTE stringSize,
282 CHAR * pString );
283
295 IMPORTGOBI ULONG GOBICMAPI GetPRLVersion( WORD * pPRLVersion );
296
311 IMPORTGOBI ULONG GOBICMAPI GetERIFile(
312 ULONG * pFileSize,
313 BYTE * pFile );
314
325 IMPORTGOBI ULONG GOBICMAPI ActivateAutomatic( CHAR * pActivationCode );
326
346 IMPORTGOBI ULONG GOBICMAPI ActivateManual(
347 CHAR * pSPC,
348 WORD sid,
349 CHAR * pMDN,
350 CHAR * pMIN,
351 ULONG prlSize,
352 BYTE * pPRL,
353 CHAR * pMNHA,
354 CHAR * pMNAAA );
355
368 IMPORTGOBI ULONG GOBICMAPI ResetToFactoryDefaults( CHAR * pSPC );
369
380 IMPORTGOBI ULONG GOBICMAPI GetActivationState( ULONG * pActivationState );
381
392 IMPORTGOBI ULONG GOBICMAPI SetPower( ULONG powerMode );
393
404 IMPORTGOBI ULONG GOBICMAPI GetPower( ULONG * pPowerMode );
405
418 IMPORTGOBI ULONG GOBICMAPI GetOfflineReason(
419 ULONG * pReasonMask,
420 ULONG * pbPlatform );
421
434 IMPORTGOBI ULONG GOBICMAPI GetNetworkTime(
435 ULONGLONG * pTimeCount,
436 ULONG * pTimeSource );
437
448 IMPORTGOBI ULONG GOBICMAPI ValidateSPC( CHAR * pSPC );
449
468 IMPORTGOBI ULONG GOBICMAPI GetDeviceCapabilities(
469 ULONG * pMaxTXChannelRate,
470 ULONG * pMaxRXChannelRate,
471 ULONG * pDataServiceCapability,
472 ULONG * pSimCapability,
473 ULONG * pRadioIfacesSize,
474 BYTE * pRadioIfaces );
475
488 IMPORTGOBI ULONG GOBICMAPI GetManufacturer(
489 BYTE stringSize,
490 CHAR * pString );
491
504 IMPORTGOBI ULONG GOBICMAPI GetModelID(
505 BYTE stringSize,
506 CHAR * pString );
507
519 IMPORTGOBI ULONG GOBICMAPI GetFirmwareRevision(
520 BYTE stringSize,
521 CHAR * pString );
522
542 IMPORTGOBI ULONG GOBICMAPI GetFirmwareRevisions(
543 BYTE amssSize,
544 CHAR * pAMSSString,
545 BYTE bootSize,
546 CHAR * pBootString,
547 BYTE priSize,
548 CHAR * pPRIString );
549
564 IMPORTGOBI ULONG GOBICMAPI GetFirmwareInfo(
565 ULONG * pFirmwareID,
566 ULONG * pTechnology,
567 ULONG * pCarrier,
568 ULONG * pRegion,
569 ULONG * pGPSCapability );
570
588 IMPORTGOBI ULONG GOBICMAPI GetVoiceNumber(
589 BYTE voiceNumberSize,
590 CHAR * pVoiceNumber,
591 BYTE minSize,
592 CHAR * pMIN );
593
605 IMPORTGOBI ULONG GOBICMAPI GetIMSI(
606 BYTE stringSize,
607 CHAR * pString );
608
630 IMPORTGOBI ULONG GOBICMAPI GetSerialNumbers(
631 BYTE esnSize,
632 CHAR * pESNString,
633 BYTE imeiSize,
634 CHAR * pIMEIString,
635 BYTE meidSize,
636 CHAR * pMEIDString );
637
650 IMPORTGOBI ULONG GOBIAPI GetStoredImages(
651 ULONG * pImageListSize,
652 BYTE * pImageList );
653
672 IMPORTGOBI ULONG GOBIAPI SetImagesPreference(
673 ULONG imageListSize,
674 BYTE * pImageList,
675 ULONG bForceDownload,
676 BYTE modemIndex,
677 ULONG * pImageTypesSize,
678 BYTE * pImageTypes );
679
693 IMPORTGOBI ULONG GOBIAPI GetImagesPreference(
694 ULONG * pImageListSize,
695 BYTE * pImageList );
696
704 IMPORTGOBI ULONG GOBIAPI ResetDevice(); // End of DMS group
706 #endif
SetImagesPreference
IMPORTGOBI ULONG GOBIAPI SetImagesPreference(ULONG imageListSize, BYTE *pImageList, ULONG bForceDownload, BYTE modemIndex, ULONG *pImageTypesSize, BYTE *pImageTypes)
GetActivationState
IMPORTGOBI ULONG GOBICMAPI GetActivationState(ULONG *pActivationState)
GetVoiceNumber
IMPORTGOBI ULONG GOBICMAPI GetVoiceNumber(BYTE voiceNumberSize, CHAR *pVoiceNumber, BYTE minSize, CHAR *pMIN)
GetManufacturer
IMPORTGOBI ULONG GOBICMAPI GetManufacturer(BYTE stringSize, CHAR *pString)
GetNetworkTime
IMPORTGOBI ULONG GOBICMAPI GetNetworkTime(ULONGLONG *pTimeCount, ULONG *pTimeSource)
DMSUIMGetPINStatus
IMPORTGOBI ULONG GOBICMAPI DMSUIMGetPINStatus(ULONG id, ULONG *pStatus, ULONG *pVerifyRetriesLeft, ULONG *pUnblockRetriesLeft)
SetPower
IMPORTGOBI ULONG GOBICMAPI SetPower(ULONG powerMode)
SetPowerCallback
IMPORTGOBI ULONG GOBICMAPI SetPowerCallback(tFNPower pCallback)
GetFirmwareRevision
IMPORTGOBI ULONG GOBICMAPI GetFirmwareRevision(BYTE stringSize, CHAR *pString)
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)
ResetToFactoryDefaults
IMPORTGOBI ULONG GOBICMAPI ResetToFactoryDefaults(CHAR *pSPC)
GetPower
IMPORTGOBI ULONG GOBICMAPI GetPower(ULONG *pPowerMode)
DMSUIMSetPINProtection
IMPORTGOBI ULONG GOBICMAPI DMSUIMSetPINProtection(ULONG id, ULONG bEnable, CHAR *pValue, ULONG *pVerifyRetriesLeft, ULONG *pUnblockRetriesLeft)
GetFirmwareInfo
IMPORTGOBI ULONG GOBICMAPI GetFirmwareInfo(ULONG *pFirmwareID, ULONG *pTechnology, ULONG *pCarrier, ULONG *pRegion, ULONG *pGPSCapability)
SetActivationStatusCallback
IMPORTGOBI ULONG GOBICMAPI SetActivationStatusCallback(tFNActivationStatus pCallback)
DMSUIMUnblockPIN
IMPORTGOBI ULONG GOBICMAPI DMSUIMUnblockPIN(ULONG id, CHAR *pPUKValue, CHAR *pNewValue, ULONG *pVerifyRetriesLeft, ULONG *pUnblockRetriesLeft)
GetFirmwareRevisions
IMPORTGOBI ULONG GOBICMAPI GetFirmwareRevisions(BYTE amssSize, CHAR *pAMSSString, BYTE bootSize, CHAR *pBootString, BYTE priSize, CHAR *pPRIString)
DMSUIMGetControlKeyStatus
IMPORTGOBI ULONG GOBICMAPI DMSUIMGetControlKeyStatus(ULONG id, ULONG *pStatus, ULONG *pVerifyRetriesLeft, ULONG *pUnblockRetriesLeft)
DMSUIMUnblockControlKey
IMPORTGOBI ULONG GOBICMAPI DMSUIMUnblockControlKey(ULONG id, CHAR *pValue, ULONG *pUnblockRetriesLeft)
GetStoredImages
IMPORTGOBI ULONG GOBIAPI GetStoredImages(ULONG *pImageListSize, BYTE *pImageList)
GetSerialNumbers
IMPORTGOBI ULONG GOBICMAPI GetSerialNumbers(BYTE esnSize, CHAR *pESNString, BYTE imeiSize, CHAR *pIMEIString, BYTE meidSize, CHAR *pMEIDString)
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)
GetOfflineReason
IMPORTGOBI ULONG GOBICMAPI GetOfflineReason(ULONG *pReasonMask, ULONG *pbPlatform)
ActivateAutomatic
IMPORTGOBI ULONG GOBICMAPI ActivateAutomatic(CHAR *pActivationCode)
GetERIFile
IMPORTGOBI ULONG GOBICMAPI GetERIFile(ULONG *pFileSize, BYTE *pFile)
ValidateSPC
IMPORTGOBI ULONG GOBICMAPI ValidateSPC(CHAR *pSPC)
DMSUIMSetControlKeyProtection
IMPORTGOBI ULONG GOBICMAPI DMSUIMSetControlKeyProtection(ULONG id, ULONG status, CHAR *pValue, ULONG *pVerifyRetriesLeft)
GetDeviceCapabilities
IMPORTGOBI ULONG GOBICMAPI GetDeviceCapabilities(ULONG *pMaxTXChannelRate, ULONG *pMaxRXChannelRate, ULONG *pDataServiceCapability, ULONG *pSimCapability, ULONG *pRadioIfacesSize, BYTE *pRadioIfaces)
DMSUIMVerifyPIN
IMPORTGOBI ULONG GOBICMAPI DMSUIMVerifyPIN(ULONG id, CHAR *pValue, ULONG *pVerifyRetriesLeft, ULONG *pUnblockRetriesLeft)
GetPRLVersion
IMPORTGOBI ULONG GOBICMAPI GetPRLVersion(WORD *pPRLVersion)
ResetDevice
IMPORTGOBI ULONG GOBIAPI ResetDevice()
DMSUIMChangePIN
IMPORTGOBI ULONG GOBICMAPI DMSUIMChangePIN(ULONG id, CHAR *pOldValue, CHAR *pNewValue, ULONG *pVerifyRetriesLeft, ULONG *pUnblockRetriesLeft)
DMSUIMGetICCID
IMPORTGOBI ULONG GOBICMAPI DMSUIMGetICCID(BYTE stringSize, CHAR *pString)