| CE Gobi SDK 2.14 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 typedef enum
38 {
39 GobiPowerMode_Online = 0,
40 GobiPowerMode_Low,// 1
41 GobiPowerMode_FactoryTest, // 2
42 GobiPowerMode_Offline,// 3
43 GobiPowerMode_Reset,// 4
44 GobiPowerMode_Off,// 5
45 GobiPowerMode_PersistentLow // 6
46 } eGobiPowerMode;
57 IMPORTGOBI ULONG GOBICMAPI SetPowerCallback( tFNPower pCallback );
58
69 IMPORTGOBI ULONG GOBICMAPI SetActivationStatusCallback(
70 tFNActivationStatus pCallback );
71
84 IMPORTGOBI ULONG GOBICMAPI DMSUIMGetICCID(
85 BYTE stringSize,
86 CHAR * pString );
87
104 IMPORTGOBI ULONG GOBICMAPI DMSUIMGetControlKeyStatus(
105 ULONG id,
106 ULONG * pStatus,
107 ULONG * pVerifyRetriesLeft,
108 ULONG * pUnblockRetriesLeft );
109
110
126 IMPORTGOBI ULONG GOBICMAPI DMSUIMSetControlKeyProtection(
127 ULONG id,
128 ULONG status,
129 CHAR * pValue,
130 ULONG * pVerifyRetriesLeft );
131
146 IMPORTGOBI ULONG GOBICMAPI DMSUIMUnblockControlKey(
147 ULONG id,
148 CHAR * pValue,
149 ULONG * pUnblockRetriesLeft );
150
172 IMPORTGOBI ULONG GOBICMAPI DMSUIMSetPINProtection(
173 ULONG id,
174 ULONG bEnable,
175 CHAR * pValue,
176 ULONG * pVerifyRetriesLeft,
177 ULONG * pUnblockRetriesLeft );
178
197 IMPORTGOBI ULONG GOBICMAPI DMSUIMVerifyPIN(
198 ULONG id,
199 CHAR * pValue,
200 ULONG * pVerifyRetriesLeft,
201 ULONG * pUnblockRetriesLeft );
202
224 IMPORTGOBI ULONG GOBICMAPI DMSUIMUnblockPIN(
225 ULONG id,
226 CHAR * pPUKValue,
227 CHAR * pNewValue,
228 ULONG * pVerifyRetriesLeft,
229 ULONG * pUnblockRetriesLeft );
230
250 IMPORTGOBI ULONG GOBICMAPI DMSUIMChangePIN(
251 ULONG id,
252 CHAR * pOldValue,
253 CHAR * pNewValue,
254 ULONG * pVerifyRetriesLeft,
255 ULONG * pUnblockRetriesLeft );
256
271 IMPORTGOBI ULONG GOBICMAPI DMSUIMGetPINStatus(
272 ULONG id,
273 ULONG * pStatus,
274 ULONG * pVerifyRetriesLeft,
275 ULONG * pUnblockRetriesLeft );
276
289 IMPORTGOBI ULONG GOBICMAPI GetHardwareRevision(
290 BYTE stringSize,
291 CHAR * pString );
292
304 IMPORTGOBI ULONG GOBICMAPI GetPRLVersion( WORD * pPRLVersion );
305
320 IMPORTGOBI ULONG GOBICMAPI GetERIFile(
321 ULONG * pFileSize,
322 BYTE * pFile );
323
334 IMPORTGOBI ULONG GOBICMAPI ActivateAutomatic( CHAR * pActivationCode );
335
355 IMPORTGOBI ULONG GOBICMAPI ActivateManual(
356 CHAR * pSPC,
357 WORD sid,
358 CHAR * pMDN,
359 CHAR * pMIN,
360 ULONG prlSize,
361 BYTE * pPRL,
362 CHAR * pMNHA,
363 CHAR * pMNAAA );
364
377 IMPORTGOBI ULONG GOBICMAPI ResetToFactoryDefaults( CHAR * pSPC );
378
403 IMPORTGOBI ULONG GOBICMAPI GetActivationState( ULONG * pActivationState );
404
415 IMPORTGOBI ULONG GOBICMAPI SetPower( ULONG powerMode );
416
427 IMPORTGOBI ULONG GOBICMAPI GetPower( ULONG * pPowerMode );
428
441 IMPORTGOBI ULONG GOBICMAPI GetOfflineReason(
442 ULONG * pReasonMask,
443 ULONG * pbPlatform );
444
457 IMPORTGOBI ULONG GOBICMAPI GetNetworkTime(
458 ULONGLONG * pTimeCount,
459 ULONG * pTimeSource );
460
471 IMPORTGOBI ULONG GOBICMAPI ValidateSPC( CHAR * pSPC );
472
491 IMPORTGOBI ULONG GOBICMAPI GetDeviceCapabilities(
492 ULONG * pMaxTXChannelRate,
493 ULONG * pMaxRXChannelRate,
494 ULONG * pDataServiceCapability,
495 ULONG * pSimCapability,
496 ULONG * pRadioIfacesSize,
497 BYTE * pRadioIfaces );
498
511 IMPORTGOBI ULONG GOBICMAPI GetManufacturer(
512 BYTE stringSize,
513 CHAR * pString );
514
527 IMPORTGOBI ULONG GOBICMAPI GetModelID(
528 BYTE stringSize,
529 CHAR * pString );
530
542 IMPORTGOBI ULONG GOBICMAPI GetFirmwareRevision(
543 BYTE stringSize,
544 CHAR * pString );
545
565 IMPORTGOBI ULONG GOBICMAPI GetFirmwareRevisions(
566 BYTE amssSize,
567 CHAR * pAMSSString,
568 BYTE bootSize,
569 CHAR * pBootString,
570 BYTE priSize,
571 CHAR * pPRIString );
572
587 IMPORTGOBI ULONG GOBICMAPI GetFirmwareInfo(
588 ULONG * pFirmwareID,
589 ULONG * pTechnology,
590 ULONG * pCarrier,
591 ULONG * pRegion,
592 ULONG * pGPSCapability );
593
611 IMPORTGOBI ULONG GOBICMAPI GetVoiceNumber(
612 BYTE voiceNumberSize,
613 CHAR * pVoiceNumber,
614 BYTE minSize,
615 CHAR * pMIN );
616
628 IMPORTGOBI ULONG GOBICMAPI GetIMSI(
629 BYTE stringSize,
630 CHAR * pString );
631
653 IMPORTGOBI ULONG GOBICMAPI GetSerialNumbers(
654 BYTE esnSize,
655 CHAR * pESNString,
656 BYTE imeiSize,
657 CHAR * pIMEIString,
658 BYTE meidSize,
659 CHAR * pMEIDString );
660
673 IMPORTGOBI ULONG GOBIAPI GetStoredImages(
674 ULONG * pImageListSize,
675 BYTE * pImageList );
676
695 IMPORTGOBI ULONG GOBIAPI SetImagesPreference(
696 ULONG imageListSize,
697 BYTE * pImageList,
698 ULONG bForceDownload,
699 BYTE modemIndex,
700 ULONG * pImageTypesSize,
701 BYTE * pImageTypes );
702
716 IMPORTGOBI ULONG GOBIAPI GetImagesPreference(
717 ULONG * pImageListSize,
718 BYTE * pImageList );
719
727 IMPORTGOBI ULONG GOBIAPI ResetDevice(); // End of DMS group
729 #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)