qaGobiApiSwiAvms.h

Go to the documentation of this file.

/*
 * Copyright: © 2017 Sierra Wireless, Inc. all rights reserved
 */
#ifndef __GOBI_API_SWIAVMS_H__
#define __GOBI_API_SWIAVMS_H__

#ifdef __cplusplus
extern "C" {
#endif


#define MAX_GET_SETTINGS_AVMS_APN_STRING_LENGTH 49
#define MAX_GET_SETTINGS_AVMS_UNAME_STRING_LENGTH 29
#define MAX_GET_SETTINGS_AVMS_PWD_STRING_LENGTH 29

ULONG SLQSAVMSStartSession(
    BYTE sessionType,
    ULONG *pSessionResponse );

ULONG SLQSAVMSStopSession(
    BYTE sessiontype,
    BYTE *pSessionRep);



#define QMISWIAVMSSESSIONGETINFO_BINARYUPDATESESSIONINFO_VERSION_LENGTH 128
#define QMISWIAVMSSESSIONGETINFO_BINARYUPDATESESSIONINFO_NAME_LENGTH 128
#define QMISWIAVMSSESSIONGETINFO_BINARYUPDATESESSIONINFO_DESC_LENGTH 1024

typedef struct _QmiSwiAvmsEventReportBinaryUpdateSessionInfoResp
{
    BYTE bBinaryType;
    BYTE bState;
    BYTE bUserInputRequest;
    WORD wUserInputTimeout;
    ULONG ulPkgDownloadSize;
    ULONG ulPkgDownloadComplete;
    WORD wUpdateCompeteStatus;
    BYTE bSerity;
    WORD wVersionLength;
    CHAR szVersion[QMISWIAVMSSESSIONGETINFO_BINARYUPDATESESSIONINFO_VERSION_LENGTH];
    WORD wNameLength;
    CHAR szName[QMISWIAVMSSESSIONGETINFO_BINARYUPDATESESSIONINFO_NAME_LENGTH];
    WORD wDescriptionLength;
    CHAR szDescription[QMISWIAVMSSESSIONGETINFO_BINARYUPDATESESSIONINFO_DESC_LENGTH];
    BYTE TlvPresent;    
}QmiSwiAvmsEventReportBinaryUpdateSessionInfoResp;

#define QMISWIAVMSSESSIONGETINFO_CONFIG_ALERT_MSG_LENGTH 200

typedef struct _QmiSwiAvmsEventReportConfigResp
{
    BYTE bState;
    BYTE bUserInputRequest;
    WORD wUserInputTimeout;
    WORD wAlertMsgLength;
    CHAR szAlertMsg[QMISWIAVMSSESSIONGETINFO_CONFIG_ALERT_MSG_LENGTH];
    BYTE TlvPresent;
}QmiSwiAvmsEventReportConfigResp;

typedef struct _QmiSwiAvmsEventReportNotificationResp
{
    BYTE bNotification;
    WORD wSessionStatus;
    BYTE TlvPresent;
}QmiSwiAvmsEventReportNotificationResp;

typedef struct _QmiSwiAvmsEventReportConnectionRequestResp
{
    BYTE bUserInputRequest;
    WORD wUserInputTimeout;
    BYTE TlvPresent;
}QmiSwiAvmsEventReportConnectionRequestResp;

typedef struct _QmiSwiAvmsEventReportWAMSParamChangeResp
{
    WORD wWamsChangeMask;
    BYTE TlvPresent;
}QmiSwiAvmsEventReportWAMSParamChangeResp;

typedef struct _QmiSwiAvmsEventReportPackageIDResp
{
    BYTE bPackageID;
    BYTE TlvPresent;
}QmiSwiAvmsEventReportPackageIDResp;

typedef struct _QmiSwiAvmsEventReportRegStatusResp
{
    BYTE bRegStatus;
    BYTE TlvPresent;
}QmiSwiAvmsEventReportRegStatusResp;

typedef struct _QmiSwiAvmsEventReportDataSessionStatusResp
{
    BYTE bType;
    WORD wErrorCode;
    BYTE TlvPresent;
}QmiSwiAvmsEventReportDataSessionStatusResp;

typedef struct _QmiSwiAvmsEventReportSessionTypeResp
{
    BYTE bType;
    BYTE TlvPresent;
}QmiSwiAvmsEventReportSessionTypeResp;

typedef struct _QmiSwiAvmsEventReportHTTPStatusResp
{
    WORD wHTTPStatus;
    BYTE TlvPresent;
}QmiSwiAvmsEventReportHTTPStatusResp;

ULONG SLQSAVMSGetSessionInfo(
    QmiSwiAvmsEventReportBinaryUpdateSessionInfoResp *pBinaryUpdteSessionInfo,
    QmiSwiAvmsEventReportConfigResp *pAVMSConfig,
    QmiSwiAvmsEventReportNotificationResp *pNotif,
    QmiSwiAvmsEventReportPackageIDResp *pPackageID
);

ULONG SLQSAVMSSelection(
    BYTE selection ,
    ULONG *pDeferTime,
    BYTE *pClientPerfOperationFlag,
    BYTE *pPackageID,
    WORD *pRejectReason
);

 /*
  * This structure contains the SLQSAVMSSetSettings APN Info to connect to AVMS server.
  *
  * \param  bAPNLength - APN Length(Max 49).
  *
  * \param  szAPN - APN.
  *
  * \param  bUnameLength - User Name Length (Max 29).
  *
  * \param  szUname - User Name.
  *
  * \param  bPWDLength - Password Length (Max 29).
  *
  * \param  szPWD - Password.
  *
  */
typedef struct _SLQSAVMSSettingsAPNInfo
{
    BYTE    bAPNLength;
    CHAR    *pAPN;
    BYTE    bUnameLength;
    CHAR    *pUname;
    BYTE    bPWDLength;
    CHAR    *pPWD;
}SLQSAVMSSettingsAPNInfo;
#define MAX_AVMS_RETRY_TIMER_NUMBER    8
/*
 * This structure contains the SLQSAVMSSettings Polling timer to connect to AVMS server.
 *
 * \param  Timers[0] - Timer 1.
 *                      - 0-20160 (min)
 *                      - 0:retry disabled
 * \param  Timers[1] - Timer 2.
 *                      - 1-20160 (min)
 * \param  Timers[2] - Timer 3.
 *                      - 1-20160 (min)
 * \param  Timers[3] - Timer 4.
 *                      - 1-20160 (min)
 * \param  Timers[4] - Timer 5.
 *                      - 1-20160 (min)
 * \param  Timers[5] - Timer 6.
 *                      - 1-20160 (min)
 * \param  Timers[6] - Timer 7.
 *                      - 1-20160 (min)
 * \param  Timers[7] - Timer 8.
 *                      - 1-20160 (min)
 *
 */
typedef struct _SLQSAVMSSettingsConnectionRetryTimers
{
    WORD Timers[MAX_AVMS_RETRY_TIMER_NUMBER];
}SLQSAVMSSettingsConnectionRetryTimers;

/*
 * This structure contains the SLQSAVMSSettings Min/Max Period of an Observation.
 *
 * \param  min - Min period in seconds.
 *
 * \param  max - Max period in seconds.
 *
 */
typedef struct _SLQSAVMSSettingsPeriodsInfo
{
    ULONG min;
    ULONG max;
}SLQSAVMSSettingsPeriodsInfo;

/*
 * This structure contains the SLQSAVMSSettings (For AVC1 service).
 *
 * \param  pOMADMEnabled - OMA-DM Enabled.
 *                         - 0x00000010: Client Initiated FUMO (CIFUMO).
 *                         - 0x00000020: Network Initiated  FUMO (NIFUMO).
 * \param  pAutoConnect - Automatic connection to AVMS server on reception of SMS wakeup.
 *                         - 0x00 - FALSE.
 *                         - 0x01 - TRUE.
 * \param  pFwPromptdownload - FOTA Auto/Prompt Download of FW.
 *                         - 0x00 - FALSE.
 *                         - 0x01 - TRUE.
 * \param  pFwPromptUpdate - FOTA Auto/Prompt Update of FW.
 *                         - 0x00 - FALSE.
 *                         - 0x01 - TRUE.
 * \param  pFwAutoSDM - OMA Automatic UI Alert Response.
 *                         - 0x00 - Disabled.
 *                         - 0x01 - Enabled Accept.
 *                         - 0x02 - Enabled Reject.
 * \param  pPollingTimer[OPTIONAL] - Polling timer to connect to AVMS server.
 *                         - 0-525600 (min)
 *                         - 0:disabled 
 * \param  pConnectionRetryTimers[OPTIONAL] - Connection Retry timers.
 *                         - See \ref SLQSAVMSSettingsConnectionRetryTimers for more information.
 * \param  pAPNInfo{OPTIONAL] - APN Configuration.
 *                         - See \ref SLQSAVMSSettingsAPNInfo for more information.
 * \param  pNotificationStore[OPTIONAL] - Notification Storing When Disabled or Offline.
 *                         - 0 - Disabled.
 *                         - 1 - Enabeld.
 * \param  pPeroidsInfo{OPTIONAL] - Min/Max Period of an Observation.
 *                         - See \ref SLQSAVMSSettingsPeriodsInfo for more information.
 */
typedef struct _SLQSAVMSSettings
{
    ULONG             *pOMADMEnabled;
    BYTE              *pAutoConnect;
    BYTE              *pAutoReboot;
    BYTE              *pFwPromptdownload;
    BYTE              *pFwPromptUpdate;
    BYTE              *pFwAutoSDM;
    ULONG             *pPollingTimer;
    SLQSAVMSSettingsConnectionRetryTimers *pConnectionRetryTimers;
    SLQSAVMSSettingsAPNInfo *pAPNInfo;
    BYTE              *pNotificationStore;
    SLQSAVMSSettingsPeriodsInfo             *pPeroidsInfo;
} SLQSAVMSSettings;
    ULONG SLQSAVMSGetSettings(
       SLQSAVMSSettings *settings);

/*
 * This structure contains the SLQSAVMSSettings_v2 (For AVC2 service)..
 *
 * \param  pOMADMEnabled - OMA-DM Enabled.
 *                         - 0x00000010: Client Initiated FUMO (CIFUMO).
 *                         - 0x00000020: Network Initiated  FUMO (NIFUMO).
 * \param  pAutoConnect - Automatic connection to AVMS server on reception of SMS wakeup.
 *                         - 0x00 - FALSE.
 *                         - 0x01 - TRUE.
 * \param  pFwPromptdownload - FOTA Auto/Prompt Download of FW.
 *                         - 0x00 - FALSE.
 *                         - 0x01 - TRUE.
 * \param  pFwPromptUpdate - FOTA Auto/Prompt Update of FW.
 *                         - 0x00 - FALSE.
 *                         - 0x01 - TRUE.
 * \param  pFwAutoSDM - OMA Automatic UI Alert Response.
 *                         - 0x00 - Disabled.
 *                         - 0x01 - Enabled Accept.
 *                         - 0x02 - Enabled Reject.
 * \param  pPollingTimer[OPTIONAL] - Polling timer to connect to AVMS server.
 *                         - 0-525600 (min)
 *                         - 0:disabled 
 * \param  pConnectionRetryTimers[OPTIONAL] - Connection Retry timers.
 *                         - See \ref SLQSAVMSSettingsConnectionRetryTimers for more information.
 * \param  pAPNInfo[OPTIONAL] - APN Configuration.
 *                         - See \ref SLQSAVMSSettingsAPNInfo for more information.
 * \param  pNotificationStore[OPTIONAL] - Notification Storing When Disabled or Offline.
 *                         - 0 - Disabled.
 *                         - 1 - Enabeld.
 * \param  pPeroidsInfo[OPTIONAL] - Min/Max Period of an Observation.
 *                         - See \ref SLQSAVMSSettingsPeriodsInfo for more information.
 * \param  pAutoReboot[OPTIONAL] - Auto/Prompt of device reboot
 *                         - 0x00 - FALSE.
 *                         - 0x01 - TRUE.
 */
typedef struct _SLQSAVMSSettings_v2
{
    ULONG             *pOMADMEnabled;
    BYTE              *pAutoConnect;
    BYTE              *pFwPromptdownload;
    BYTE              *pFwPromptUpdate;
    BYTE              *pFwAutoSDM;
    ULONG             *pPollingTimer;
    SLQSAVMSSettingsConnectionRetryTimers *pConnectionRetryTimers;
    SLQSAVMSSettingsAPNInfo *pAPNInfo;
    BYTE              *pNotificationStore;
    SLQSAVMSSettingsPeriodsInfo             *pPeroidsInfo;    
    BYTE              *pAutoReboot;
} SLQSAVMSSettings_v2;
    ULONG SLQSAVMSGetSettings_v2(
       SLQSAVMSSettings_v2 *settings);

/*
 * This structure contains the SLQSAVMSSetSettings Min/Max Period of an Observation.
 *
 * \param  ulMin - Min period in seconds.
 *
 * \param  ulMax - Max period in seconds.
 *
 */
typedef struct _QmiSwiAvmsSetSettingsPeriodInfo
{
    ULONG ulMin;
    ULONG ulMax;
}QmiSwiAvmsSetSettingsPeriodInfo;

#define MAX_SWI_AVMS_SET_SETTING_APN_LENGTH 49
#define MAX_SWI_AVMS_SET_SETTING_UNAME_LENGTH 29
#define MAX_SWI_AVMS_SET_SETTING_PWD_LENGTH 29
/*
 * This structure contains the SLQSAVMSSetSettings APN Info to connect to AVMS server.
 *
 * \param  bAPNLength - APN Length(Max 49).
 *
 * \param  szAPN - APN.
 *
 * \param  bUnameLength - User Name Length (Max 29).
 *
 * \param  szUname - User Name.
 *
 * \param  bPWDLength - Password Length (Max 29).
 *
 * \param  szPWD - Password.
 *
 */

typedef struct _QmiSwiAvmsSetSettingsAPNInfo
{
    BYTE bAPNLength;
    CHAR szAPN[MAX_SWI_AVMS_SET_SETTING_APN_LENGTH];
    BYTE bUnameLength;
    CHAR szUname[MAX_SWI_AVMS_SET_SETTING_UNAME_LENGTH];
    BYTE bPWDLength;
    CHAR szPWD[MAX_SWI_AVMS_SET_SETTING_PWD_LENGTH];
}QmiSwiAvmsSetSettingsAPNInfo;


#define MAX_SWI_AVMS_SET_SETTING_CONNECTION_RETRY_TIMMERS 8
/*
 * This structure contains the SLQSAVMSSetSettings Polling timer to connect to AVMS server.
 *
 * \param  Timers[0] - Timer 1.
 *                      - 0-20160 (min)
 *                      - 0:retry disabled
 * \param  Timers[1] - Timer 2.
 *                      - 1-20160 (min)
 * \param  Timers[2] - Timer 3.
 *                      - 1-20160 (min)
 * \param  Timers[3] - Timer 4.
 *                      - 1-20160 (min)
 * \param  Timers[4] - Timer 5.
 *                      - 1-20160 (min)
 * \param  Timers[5] - Timer 6.
 *                      - 1-20160 (min)
 * \param  Timers[6] - Timer 7.
 *                      - 1-20160 (min)
 * \param  Timers[7] - Timer 8.
 *                      - 1-20160 (min)
 *
 */

typedef struct _QmiSwiAvmsSetSettingsConnectionRetryTimers
{
    WORD  Timers[MAX_SWI_AVMS_SET_SETTING_CONNECTION_RETRY_TIMMERS];
    
}QmiSwiAvmsSetSettingsConnectionRetryTimers;

typedef struct _SLQSAVMSSetSettingsReqPara
{
    BYTE *pAutoConnect;
    BYTE *pAutoReboot;
    BYTE *pFwPromptdownload;
    BYTE *pFwPromptUpdate;
    BYTE  *pFwAutoSDM;
    ULONG *pPollingTimer;
    QmiSwiAvmsSetSettingsConnectionRetryTimers  *pConnectionRetryTimers;
    QmiSwiAvmsSetSettingsAPNInfo  *pAPNInfo;
    BYTE *pNotifStore;
    QmiSwiAvmsSetSettingsPeriodInfo *pPeroidInfo;
}SLQSAVMSSetSettingsReq;


typedef struct _SLQSAVMSSetSettingsReqPara_v2
{
    BYTE *pAutoConnect;
    BYTE *pFwPromptdownload;
    BYTE *pFwPromptUpdate;
    BYTE  *pFwAutoSDM;
    ULONG *pPollingTimer;
    QmiSwiAvmsSetSettingsConnectionRetryTimers  *pConnectionRetryTimers;
    QmiSwiAvmsSetSettingsAPNInfo  *pAPNInfo;
    BYTE *pNotifStore;
    QmiSwiAvmsSetSettingsPeriodInfo *pPeroidInfo;
    BYTE *pAutoReboot;
}SLQSAVMSSetSettingsReq_v2;

ULONG SLQSAVMSSetSettings(
    SLQSAVMSSetSettingsReq Request);

ULONG SLQSAVMSSetSettings_v2(
    SLQSAVMSSetSettingsReq_v2 Request);


ULONG SLQSAVMSSetSettingsIgnoreAutoReboot(
    SLQSAVMSSetSettingsReq Request);


ULONG SLQSAVMSSetEventReport();

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

#endif /* __GOBI_API_SWIAVMS_H__ */