qaGobiApiDms.h

Go to the documentation of this file.

/*
 * Copyright: © 2011-2015 Sierra Wireless, Inc. all rights reserved
 */
#ifndef __GOBI_API_DMS_H__
#define __GOBI_API_DMS_H__

#define MAX_FSN_LENGTH    255

#define MAX_CUST_ID_LEN   64
#define MAX_CUST_VALUE_LEN 8

#ifdef __cplusplus
extern "C" {
#endif

ULONG GetManufacturer(
    BYTE     stringSize,
    CHAR    *pString );

ULONG GetModelID(
    BYTE     stringSize,
    CHAR    *pString );

ULONG GetFirmwareRevision(
    BYTE     stringSize,
    CHAR    *pString );

ULONG GetFirmwareRevisions(
    BYTE   amssSize,
    CHAR * pAMSSString,
    BYTE   bootSize,
    CHAR * pBootString,
    BYTE   priSize,
    CHAR * pPRIString );

ULONG GetPRLVersion(
    WORD * pPRLVersion );

ULONG GetIMSI(
    BYTE   stringSize,
    CHAR * pString );

ULONG GetSerialNumbers(
   BYTE     esnSize,
   CHAR    *pESNString,
   BYTE     imeiSize,
   CHAR    *pIMEIString,
   BYTE     meidSize,
   CHAR    *pMEIDString );

typedef struct serialNumbersInfo
{
    BYTE     esnSize;
    CHAR    *pESNString;
    BYTE     imeiSize;
    CHAR    *pIMEIString;
    BYTE     meidSize;
    CHAR    *pMEIDString;
    BYTE    imeiSvnSize;
    CHAR    *pImeiSvnString;
}serialNumbersInfo;

ULONG SLQSGetSerialNumbers(
       serialNumbersInfo *pSerialNumbersInfo);

ULONG GetHardwareRevision(
    BYTE stringSize,
    CHAR *pString );

ULONG GetNetworkTime(
    ULONGLONG *pTimeStamp,
    ULONG     *pTimeSource );

ULONG UIMSetPINProtection(
    ULONG id,
    ULONG bEnable,
    CHAR  *pValue,
    ULONG *pVerifyRetriesLeft,
    ULONG *pUnblockRetriesLeft );

ULONG UIMUnblockPIN(
    ULONG id,
    CHAR  *pPUKValue,
    CHAR  *pNewValue,
    ULONG *pVerifyRetriesLeft,
    ULONG *pUnblockRetriesLeft );

ULONG UIMVerifyPIN(
    ULONG id,
    CHAR  *pValue,
    ULONG *pVerifyRetriesLeft,
    ULONG *pUnblockRetriesLeft );

ULONG UIMChangePIN(
    ULONG id,
    CHAR  *pOldValue,
    CHAR  *pNewValue,
    ULONG *pVerifyRetriesLeft,
    ULONG *pUnblockRetriesLeft );

ULONG GetVoiceNumber(
    BYTE voiceNumberSize,
    CHAR *pVoiceNumber,
    BYTE minSize,
    CHAR *pMIN );

ULONG SetPower(
    ULONG powerMode );

ULONG GetPower(
    ULONG *pPowerMode );

ULONG UIMGetControlKeyStatus(
    ULONG id,
    ULONG *pStatus,
    ULONG *pVerifyRetriesLeft,
    ULONG *pUnblockRetriesLeft );

ULONG UIMGetICCID(
    BYTE stringSize,
    CHAR *pString );

ULONG UIMGetPINStatus(
    ULONG id,
    ULONG *pStatus,
    ULONG *pVerifyRetriesLeft,
    ULONG *pUnblockRetriesLeft );

ULONG GetOfflineReason(
    ULONG *pReasonMask,
    ULONG *pbPlatform );

ULONG UIMSetControlKeyProtection(
    ULONG id,
    ULONG status,
    CHAR  *pValue,
    ULONG *pVerifyRetriesLeft );

ULONG UIMUnblockControlKey(
    ULONG id,
    CHAR  *pValue,
    ULONG *pUnblockRetriesLeft );

ULONG GetDeviceCapabilities(
    ULONG *pMaxTXChannelRate,
    ULONG *pMaxRXChannelRate,
    ULONG *pDataServiceCapability,
    ULONG *pSimCapability,
    ULONG *pRadioIfacesSize,
    BYTE  *pRadioIfaces );

ULONG ResetToFactoryDefaults(
    CHAR *pSPC );

ULONG ValidateSPC(
    CHAR *pSPC );

ULONG ActivateAutomatic(
    CHAR *pActivationCode );

typedef struct ERIFileparams
{
    WORD  *pFileSize;
    BYTE  *pFile;
}ERIFileparams;

ULONG SLQSGetERIFile(
    ERIFileparams *pERIFileparams );

ULONG GetActivationState(
    ULONG *pActivationState);

ULONG SLQSUIMGetState(
    ULONG *pUIMState);

ULONG SLQSGetBandCapability( ULONGLONG *pBandCapability );

typedef struct custFeaturesInfo
{
    ULONG GpsEnable;
    BYTE  *pDisableIMSI;
    WORD  *pIPFamSupport;
    BYTE  *pRMAutoConnect;
    BYTE  *pGPSSel;
    BYTE  *pSMSSupport;
    BYTE  *pIsVoiceEnabled;
    BYTE  *pDHCPRelayEnabled;
    BYTE  *pGPSLPM;
}custFeaturesInfo;

ULONG SLQSGetCustFeatures(
    custFeaturesInfo *pCustFeaturesInfo );

typedef struct custFeaturesSetting
{
    BYTE  *pGPSSel;
    ULONG *pGPSEnable;
    BYTE  *pIsVoiceEnabled;
    BYTE  *pDHCPRelayEnabled;
    BYTE  *pGPSLPM;
}custFeaturesSetting;

ULONG SLQSSetCustFeatures(
    custFeaturesSetting *pCustFeaturesSetting );

typedef struct dmsCurrentPRLInfo
{
    WORD *pPRLVersion;
    BYTE *pPRLPreference;
} dmsCurrentPRLInfo;

ULONG SLQSGetCurrentPRLInfo(
    dmsCurrentPRLInfo *pCurrentPRLInfo );

typedef struct
{
    BYTE FSNumber[MAX_FSN_LENGTH];
} FactorySequenceNumber;

ULONG SLQSSwiGetFSN( FactorySequenceNumber *pFSNumber);


typedef struct
{
    ULONG ResCode;
    BYTE  *pImgType;
    ULONG *pRefData;
    BYTE  *pRefStringLen;
    BYTE  *pRefString;
    BYTE  *pLogStringLen;
    BYTE  *pLogString;
} FirmwareUpdatStat;

ULONG SLQSSwiGetFwUpdateStatus( FirmwareUpdatStat *pFirmwareUpdatStat );

typedef struct
{
    BYTE  *pUSBComp;
    BYTE  *pNumSupUSBComps;
    BYTE  *pSupUSBComps;
} USBCompParams;

ULONG SLQSSwiGetUSBComp( USBCompParams *pUSBCompParams );

typedef struct
{
    BYTE *pUSBComp;
} USBCompConfig;

ULONG SLQSSwiSetUSBComp( USBCompConfig *pUSBCompConfig );

typedef struct
{
    WORD  numCrashes;
    ULONG crashId;
    ULONG crashData;
    WORD  crashStrLen;
    CHAR  *pCrashString;
    WORD  gcDumpStrLen;
    CHAR  *pGCDumpString;

} CrashInfo;

typedef struct
{
    BYTE      *pDevCrashStatus;
    CrashInfo *pCrashInfo;
} CrashInfoParams;

ULONG SLQSSwiGetCrashInfo( BYTE *pClear,CrashInfoParams *pCrashInfoParams );

ULONG SLQSSwiGetCrashAction( BYTE *pDevCrashState );

ULONG SLQSSwiSetCrashAction( BYTE crashActionParams);
typedef struct _SLQSSwiGetHostDevInfoParams
{
   BYTE     bManSize;
   CHAR    *pManString;
   BYTE     bModelSize;
   CHAR    *pModelString;
   BYTE     bSWVerSize;
   CHAR    *pSWVerString;
   BYTE     bPlasmaIDSize;
   CHAR    *pPlasmaIDString;
} SLQSSwiGetHostDevInfoParams;

ULONG SLQSSwiGetHostDevInfo( SLQSSwiGetHostDevInfoParams *pGetHostDevInfoParams );


typedef struct _SLQSSwiSetHostDevInfoParams
{
   BYTE     bManSize;
   CHAR    *pManString;
   BYTE     bModelSize;
   CHAR    *pModelString;
   BYTE     bSWVerSize;
   CHAR    *pSWVerString;
   BYTE     bPlasmaIDSize;
   CHAR    *pPlasmaIDString;
} SLQSSwiSetHostDevInfoParams;

ULONG SLQSSwiSetHostDevInfo( SLQSSwiSetHostDevInfoParams *pSetHostDevInfoParams );
typedef struct _SLQSSwiGetOSInfoParams
{
   BYTE     bNameSize;
   CHAR    *pNameString;
   BYTE     bVersionSize;
   CHAR    *pVersionString;
} SLQSSwiGetOSInfoParams;
ULONG SLQSSwiGetOSInfo( SLQSSwiGetOSInfoParams *pParams );

typedef struct _SLQSSwiSetOSInfoParams
{
   BYTE     bNameSize;
   CHAR    *pNameString;
   BYTE     bVersionSize;
   CHAR    *pVersionString;
} SLQSSwiSetOSInfoParams;

ULONG SLQSSwiSetOSInfo( SLQSSwiSetOSInfoParams *pParams );

typedef struct _SLQSSwiGetSerialNoExtParams
{
   BYTE     meidLength;
   CHAR    *pMeidString;
} SLQSSwiGetSerialNoExtParams;

ULONG SLQSSwiGetSerialNoExt( SLQSSwiGetSerialNoExtParams *pParams );

typedef struct
{
    CHAR cust_id[MAX_CUST_ID_LEN+1];
    WORD value_length;
    BYTE cust_value[MAX_CUST_VALUE_LEN+1];
} setCustomSettingV2;

ULONG SLQSSetCustFeaturesV2(
    setCustomSettingV2 *pSetCustSetting );

typedef struct
{
    CHAR cust_id[MAX_CUST_ID_LEN+1];
    BYTE list_type;
} getCustomInput;

typedef struct
{
    WORD id_length;
    CHAR cust_id[MAX_CUST_ID_LEN+1];
    WORD value_length;
    BYTE cust_value[MAX_CUST_VALUE_LEN+1];
    WORD cust_attr;
} custSettingInfo;

typedef struct
{
    BYTE list_type;
    WORD num_instances;
    custSettingInfo custSetting[256];
} custSettingList;

typedef struct
{
    getCustomInput *pGetCustomInput;
    custSettingInfo *pCustSettingInfo;
    custSettingList *pCustSettingList;
} getCustomFeatureV2;

ULONG SLQSGetCustFeaturesV2(
    getCustomFeatureV2 *pGetCustomFeatureV2 );

#define MAX_DYING_GASP_CFG_SMS_CONTENT_LENGTH 160
#define MAX_DYING_GASP_CFG_SMS_NUMBER_LENGTH 20

typedef struct
{
    BYTE *pDestSMSNum;
    BYTE *pDestSMSContent;
} getDyingGaspCfg;

ULONG SLQSSwiGetDyingGaspCfg(
    getDyingGaspCfg *pConfig );

typedef struct
{
    BYTE *pDestSMSNum;
    BYTE *pDestSMSContent;
} setDyingGaspCfg;

ULONG SLQSSwiSetDyingGaspCfg(
    setDyingGaspCfg *pConfig );

typedef struct
{
    ULONG *pTimeStamp;
    BYTE  *pSMSAttemptedFlag;
} getDyingGaspStatistics;

ULONG SLQSSwiGetDyingGaspStatistics(
    getDyingGaspStatistics *pStatistics );

ULONG SLQSSwiClearDyingGaspStatistics();

typedef struct
{
    BYTE *pSwiGetResetInd;
} dmsIndicationRegisterReq;

ULONG SLQSDmsSwiIndicationRegister(
    dmsIndicationRegisterReq *pIndicationRegisterReq );

typedef struct
{
    BYTE type;
    BYTE source;
} dmsSwiGetResetInfo;

ULONG SLQSDmsSwiGetResetInfo(
    dmsSwiGetResetInfo *pGetResetInfoResp );
typedef struct
{
    ULONGLONG bandCapability;
    ULONGLONG *pLteBandCapability;
    ULONGLONG *pTdsBandCapability;
} BandCapabilityResp;
ULONG SLQSGetBandCapabilities( BandCapabilityResp *pBandCapability );

typedef struct
{
    BYTE  opMode;
    ULONG *pLpmFlag;
    BYTE  *pWdisable;
    BYTE  *pPowerOffMode;
    BYTE  *pPersistentLpm;
} dmsSwiGetPCInfo;

ULONG SLQSDmsSwiGetPCInfo(
    dmsSwiGetPCInfo *pGetPCInfoResp );

typedef struct
{
    BYTE  TlvPresent;
    BYTE  enableState;
} PSMEnableStateTlv;

typedef struct
{
    BYTE   TlvPresent;
    ULONG  durationThreshold;
} PSMDurationThresholdTlv;

typedef struct
{
    BYTE  TlvPresent;
    ULONG durationDueToOOS;
} PSMDurationDueToOOSTlv;

typedef struct
{
    BYTE  TlvPresent;
    ULONG randomizationWindow;
} PSMRandomizationWindowTlv;

typedef struct
{
    BYTE  TlvPresent;
    ULONG activeTimer;
} PSMActiveTimerTlv;

typedef struct
{
    BYTE  TlvPresent;
    ULONG periodicUpdateTimer;
} PSMPeriodicUpdateTimerTlv;

typedef struct
{
    BYTE  TlvPresent;
    ULONG earlyWakeupTime;
} PSMEarlyWakeupTimeTlv;

typedef struct
{
    PSMEnableStateTlv         *pPsmEnableState;
    PSMDurationThresholdTlv   *pDurationThreshold;
    PSMDurationDueToOOSTlv    *pDurationDueToOOS;
    PSMRandomizationWindowTlv *pRandomizationWindow;
    PSMActiveTimerTlv         *pActiveTimer;
    PSMPeriodicUpdateTimerTlv *pPeriodicUpdateTimer;
    PSMEarlyWakeupTimeTlv     *pEarlyWakeupTime;
} PowerSaveModeConfigResp;

ULONG SLQSGetPowerSaveModeConfig( PowerSaveModeConfigResp *pPSMConfigParam );

typedef struct
{
    BYTE    *pPsmEnableState;
    ULONG   *pActiveTimer;
    ULONG   *pPeriodicUpdateTimer;
} PowerSaveModeConfigReq;

ULONG SLQSSetPowerSaveModeConfig( PowerSaveModeConfigReq *pPSMConfigParamReq );

#ifdef __cplusplus
} /* extern "C" { */
#endif

#endif /* __GOBI_API_DMS_H__ */