LinuxQMISDK  SLQS04.00.18
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Data Structures | Macros | Typedefs | Functions
qaGobiApiSwiAvms.h File Reference

SWI Open Mobile Alliance Device Management Service API function prototypes SWI AVMS QMI Service revision 1.14. More...

Go to the source code of this file.

Data Structures

struct  _QmiSwiAvmsEventReportBinaryUpdateSessionInfoResp
 
struct  _QmiSwiAvmsEventReportConfigResp
 
struct  _QmiSwiAvmsEventReportNotificationResp
 
struct  _QmiSwiAvmsEventReportConnectionRequestResp
 
struct  _QmiSwiAvmsEventReportWAMSParamChangeResp
 
struct  _QmiSwiAvmsEventReportPackageIDResp
 
struct  _QmiSwiAvmsEventReportRegStatusResp
 
struct  _QmiSwiAvmsEventReportDataSessionStatusResp
 
struct  _QmiSwiAvmsEventReportSessionTypeResp
 
struct  _QmiSwiAvmsEventReportHTTPStatusResp
 
struct  _SLQSAVMSSettingsAPNInfo
 
struct  _SLQSAVMSSettingsConnectionRetryTimers
 
struct  _SLQSAVMSSettingsPeriodsInfo
 
struct  _SLQSAVMSSettings
 
struct  _SLQSAVMSSettings_v2
 
struct  _QmiSwiAvmsSetSettingsPeriodInfo
 
struct  _QmiSwiAvmsSetSettingsAPNInfo
 
struct  _QmiSwiAvmsSetSettingsConnectionRetryTimers
 
struct  _SLQSAVMSSetSettingsReqPara
 
struct  _SLQSAVMSSetSettingsReqPara_v2
 

Macros

#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
 
#define QMISWIAVMSSESSIONGETINFO_BINARYUPDATESESSIONINFO_VERSION_LENGTH   128
 
#define QMISWIAVMSSESSIONGETINFO_BINARYUPDATESESSIONINFO_NAME_LENGTH   128
 
#define QMISWIAVMSSESSIONGETINFO_BINARYUPDATESESSIONINFO_DESC_LENGTH   1024
 
#define QMISWIAVMSSESSIONGETINFO_CONFIG_ALERT_MSG_LENGTH   200
 
#define MAX_AVMS_RETRY_TIMER_NUMBER   8
 
#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
 
#define MAX_SWI_AVMS_SET_SETTING_CONNECTION_RETRY_TIMMERS   8
 

Typedefs

typedef struct
_QmiSwiAvmsEventReportBinaryUpdateSessionInfoResp 
QmiSwiAvmsEventReportBinaryUpdateSessionInfoResp
 
typedef struct
_QmiSwiAvmsEventReportConfigResp 
QmiSwiAvmsEventReportConfigResp
 
typedef struct
_QmiSwiAvmsEventReportNotificationResp 
QmiSwiAvmsEventReportNotificationResp
 
typedef struct
_QmiSwiAvmsEventReportConnectionRequestResp 
QmiSwiAvmsEventReportConnectionRequestResp
 
typedef struct
_QmiSwiAvmsEventReportWAMSParamChangeResp 
QmiSwiAvmsEventReportWAMSParamChangeResp
 
typedef struct
_QmiSwiAvmsEventReportPackageIDResp 
QmiSwiAvmsEventReportPackageIDResp
 
typedef struct
_QmiSwiAvmsEventReportRegStatusResp 
QmiSwiAvmsEventReportRegStatusResp
 
typedef struct
_QmiSwiAvmsEventReportDataSessionStatusResp 
QmiSwiAvmsEventReportDataSessionStatusResp
 
typedef struct
_QmiSwiAvmsEventReportSessionTypeResp 
QmiSwiAvmsEventReportSessionTypeResp
 
typedef struct
_QmiSwiAvmsEventReportHTTPStatusResp 
QmiSwiAvmsEventReportHTTPStatusResp
 
typedef struct
_SLQSAVMSSettingsAPNInfo 
SLQSAVMSSettingsAPNInfo
 
typedef struct
_SLQSAVMSSettingsConnectionRetryTimers 
SLQSAVMSSettingsConnectionRetryTimers
 
typedef struct
_SLQSAVMSSettingsPeriodsInfo 
SLQSAVMSSettingsPeriodsInfo
 
typedef struct _SLQSAVMSSettings SLQSAVMSSettings
 
typedef struct _SLQSAVMSSettings_v2 SLQSAVMSSettings_v2
 
typedef struct
_QmiSwiAvmsSetSettingsPeriodInfo 
QmiSwiAvmsSetSettingsPeriodInfo
 
typedef struct
_QmiSwiAvmsSetSettingsAPNInfo 
QmiSwiAvmsSetSettingsAPNInfo
 
typedef struct
_QmiSwiAvmsSetSettingsConnectionRetryTimers 
QmiSwiAvmsSetSettingsConnectionRetryTimers
 
typedef struct
_SLQSAVMSSetSettingsReqPara 
SLQSAVMSSetSettingsReq
 
typedef struct
_SLQSAVMSSetSettingsReqPara_v2 
SLQSAVMSSetSettingsReq_v2
 

Functions

ULONG SLQSAVMSStartSession (BYTE sessionType, ULONG *pSessionResponse)
 
ULONG SLQSAVMSStopSession (BYTE sessiontype, BYTE *pSessionRep)
 
ULONG SLQSAVMSGetSessionInfo (QmiSwiAvmsEventReportBinaryUpdateSessionInfoResp *pBinaryUpdteSessionInfo, QmiSwiAvmsEventReportConfigResp *pAVMSConfig, QmiSwiAvmsEventReportNotificationResp *pNotif, QmiSwiAvmsEventReportPackageIDResp *pPackageID)
 
ULONG SLQSAVMSSelection (BYTE selection, ULONG *pDeferTime, BYTE *pClientPerfOperationFlag, BYTE *pPackageID, WORD *pRejectReason)
 
ULONG SLQSAVMSGetSettings (SLQSAVMSSettings *settings)
 
ULONG SLQSAVMSGetSettings_v2 (SLQSAVMSSettings_v2 *settings)
 
ULONG SLQSAVMSSetSettings (SLQSAVMSSetSettingsReq Request)
 
ULONG SLQSAVMSSetSettings_v2 (SLQSAVMSSetSettingsReq_v2 Request)
 
ULONG SLQSAVMSSetSettingsIgnoreAutoReboot (SLQSAVMSSetSettingsReq Request)
 
ULONG SLQSAVMSSetEventReport ()
 

Detailed Description

SWI Open Mobile Alliance Device Management Service API function prototypes SWI AVMS QMI Service revision 1.14.

Macro Definition Documentation

#define MAX_AVMS_RETRY_TIMER_NUMBER   8
#define MAX_GET_SETTINGS_AVMS_APN_STRING_LENGTH   49
#define MAX_GET_SETTINGS_AVMS_PWD_STRING_LENGTH   29
#define MAX_GET_SETTINGS_AVMS_UNAME_STRING_LENGTH   29
#define MAX_SWI_AVMS_SET_SETTING_APN_LENGTH   49
#define MAX_SWI_AVMS_SET_SETTING_CONNECTION_RETRY_TIMMERS   8
#define MAX_SWI_AVMS_SET_SETTING_PWD_LENGTH   29
#define MAX_SWI_AVMS_SET_SETTING_UNAME_LENGTH   29
#define QMISWIAVMSSESSIONGETINFO_BINARYUPDATESESSIONINFO_DESC_LENGTH   1024
#define QMISWIAVMSSESSIONGETINFO_BINARYUPDATESESSIONINFO_NAME_LENGTH   128
#define QMISWIAVMSSESSIONGETINFO_BINARYUPDATESESSIONINFO_VERSION_LENGTH   128
#define QMISWIAVMSSESSIONGETINFO_CONFIG_ALERT_MSG_LENGTH   200

Typedef Documentation

Parameters
bBinaryType: Type
  • 1 - Firmware.
  • 2 - User App.
  • 3 - Legato Framework.
bStat: State
  • 0x01 - No binary update available.
  • 0x02 - Query binary Download.
  • 0x03 - Binary Downloading.
  • 0x04 - Binary downloaded.
  • 0x05 -Query Binary Update.
  • 0x06 - Binary updating.
  • 0x07 - Binary updated.
bUserInputRequestBit mask of available user inputs.
  • 0x00 - No user input required. Informational indication.
  • 0x01 - Accept.
  • 0x02 - Reject.
wUserInputTimeoutTimeout for user input in minutes. A value of 0 means no time-out.
ulPkgDownloadSizeThe size (in bytes) of the update package
ulPkgDownloadCompleteThe number of bytes being downloaded. For downloading state, this value shall be > 0 and incremented toward the pkg_dload_size. For other states, the value shall be 0 as it is meaningless.
wUpdateCompeteStatusResult code.This field should be looked at only when the AVMS session is complete.
bSeritySerity.
  • 0x01 - Mandatory.
  • 0x02 - Optional.
wVersionLengthLength of FW Version string in bytes.
szVersionFW Version string in ASCII.
wNameLengthLength Package Name string in bytes.
szNamePackage Name in UCS2.
wDescriptionLengthLength of description in bytes.
szDescriptionDescription of Update Package in USC2.
TlvPresentBoolean indicating the presence of the TLV in the QMI response
Parameters
bStateState.
  • 0x01 - AVMS Read Request.
  • 0x02 - AVMS Change Request.
  • 0x03 - AVMS Config Complete.
bUserInputRequestBit mask of available user inputs.
  • 0x00 - No user input required. Informational indication.
  • 0x01 - Accept.
  • 0x02 - Reject.
wUserInputTimeoutTimeout for user input in seconds. A value of 0 means no time-out
wAlertMsgLengthLength of Alert message string in bytes.
szAlertMsgAlert message in UCS2.
TlvPresentBoolean indicating the presence of the TLV in the QMI response
Parameters
bUserInputRequestBit mask of available user inputs.
  • 0x00 - No user input required. Informational indication.
  • 0x01 - Accept.
  • 0x02 - Reject.
bUserInputRequestTimeout for user input in minutes. A value of 0 means no time-out.
TlvPresentBoolean indicating the presence of the TLV in the QMI response
Parameters
bTypeNotification type.
  • 0: Data session closed.
  • 1: Data session activated.
  • 2: Register made. -3: Data session error.
wErrorCodeLWM2M Session error code.
  • 0x0000: none
TlvPresentBoolean indicating the presence of the TLV in the QMI response
Parameters
wHTTPStatusSee RFC 7231.
  • 100 - Continue
  • 101 - Switching Protocols
  • 200 - OK
  • 201 - Created
  • 202 - Accepted
  • 203 - Non-Authoritative Information
  • 204 - No Content
  • 205 - Reset Content
  • 206 - Partial Content
  • 300 - Multiple Choices
  • 301 - Moved Permanently
  • 302 - Found
  • 303 - See Other
  • 304 - Not Modified
  • 305 - Use Proxy
  • 307 - Temporary Redirect
  • 400 - Bad Request
  • 401 - Unauthorized
  • 402 - Payment Required
  • 403 - Forbidden
  • 404 - Not Found
  • 405 - Method Not Allowed
  • 406 - Not Acceptable
  • 407 - Proxy Authentication Required
  • 408 - Request Timeout
  • 409 - Conflict
  • 410 - Gone
  • 411 - Length Required
  • 412 - Precondition Failed
  • 413 - Payload Too Large
  • 414 - URI Too Long
  • 415 - Unsupported Media Type
  • 416 - Range Not Satisfiable
  • 417 - Expectation Failed
  • 426 - Upgrade Required
  • 500 - Internal Server Error
  • 501 - Not Implemented
  • 502 - Bad Gateway
  • 503 - Service Unavailable
  • 504 - Gateway Timeout
  • 505 - HTTP Version Not Supported
TlvPresentBoolean indicating the presence of the TLV in the QMI response
Parameters
bNotificationNotification.
  • 0x14 - Module starts sending data to server.
  • 0x15 - Authentication with the server.
  • 0x16 - session with the server is ended.
wSessionStatusThis field will set to the session status for notifications that occur at the end of a session, zero for all other notifications.
  • 0x0000: Successful: Session succeeded
  • 0x0001: Break: Session succeeded
  • 0x0002: Large Object Handled: Session succeeded
  • 0x0003: No status: Session succeeded
  • 0x0004: No more commands: Session succeeded
  • 0x0005: User cancel: Session cancelled
  • 0x0100-0x01FF: General errors
  • 0x0200-0x02FF: Syncml errors
  • 0x0300-0x03FF: Authentication errors
  • 0x0400-0x04FF: Protocol errors
  • 0x0500-0x05FF: Tree errors (DM Only)
  • 0x0600-0x06FF: Not applicable
  • 0x0700-0x07FF: Trigger errors
  • 0x0800-0x08FF: FUMO errors
  • 0x0900-0x09FF: Communication errors
  • 0x0A00-0x0AFF: Parsing errors
  • 0x0B00-0x0CFF: Not applicable
  • 0x7F00-0x7F12:Insignia errors
  • 0x7F13: Illegal text: Text received contains illegal characters
  • 0x7F14: Download failure: Failed to download FOTA image
  • 0x7F15: Empty session: Session ran successfully, but no information wasa updated
  • 0x7F16: Factory reset successful: Factory reset succeeded
  • 0x7F17: Factory reset fail: Factory reset failed
TlvPresentBoolean indicating the presence of the TLV in the QMI response
Parameters
bPackageIDPackage ID of the application binary that this AVMS_EVENT_ID notification is for.
TlvPresentBoolean indicating the presence of the TLV in the QMI response
Parameters
bRegStatusLWM2M Registration status.
  • 0: Need Bootstrap.
  • 1: Bootstrap made.
  • 2: Register made. -3: Update made.
TlvPresentBoolean indicating the presence of the TLV in the QMI response
Parameters
bTypeSession Type.
  • 0: Bootstrap session.
  • 1. DM session
TlvPresentBoolean indicating the presence of the TLV in the QMI response
Parameters
wWamsChangeMaskMask of WAMS parameters changed.
  • By default set to 0xFF for all changes.
  • 0x01 - device_login
  • 0x02 - device_MD5_key
  • 0x04 - server_login
  • 0x08 - server_MD5_key
  • 0x10 - server_URL
  • 0x20 - Nonce
  • 0x40 - Application key
TlvPresentBoolean indicating the presence of the TLV in the QMI response

Sets the AVMS settings requested (For AVC1 service).

Parameters
bAutoConnect[IN]
  • Auto Connect to AirVantage server
    • 0x00 - FALSE
    • 0x01 - TRUE
bAutoReboot[IN]
  • Automatic device reboot when the request is received from AirVantage server
    • 0x00 - FALSE
    • 0x01 - TRUE
bFwPromptdownload[IN]
  • Start Firmware Download promptly/automatically
    • 0x00 - FALSE
    • 0x01 - TRUE
bFwPromptUpdate[IN]
  • Start Firmware Download promptly/automatically
    • 0x00 - FALSE
    • 0x01 - TRUE
FwAutoSDM[Optional]- OMA Automatic UI Alert Response
  • 0x00 - DISABLED
  • 0x01 - ENABLED ACCEPT
  • 0x02 - ENABLED REJECT
PollingTimer[Optional]
  • 0-525600 (min)
  • 0:disabled
ConnectionRetryTimers[Optional]
APNInfo[Optional]
NotifStore[Optional]
  • 0 : Disabled.
  • 1 : Enabeld.
PeroidInfo[Optional]
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
Timeout: 2 seconds

Sets the AVMS settings requested (For AVC2 service).

Parameters
bAutoConnect[IN]
  • Auto Connect to AirVantage server
    • 0x00 - FALSE
    • 0x01 - TRUE
bFwPromptdownload[IN]
  • Start Firmware Download promptly/automatically
    • 0x00 - FALSE
    • 0x01 - TRUE
bFwPromptUpdate[IN]
  • Start Firmware Download promptly/automatically
    • 0x00 - FALSE
    • 0x01 - TRUE
FwAutoSDM[Optional]- OMA Automatic UI Alert Response
  • 0x00 - DISABLED
  • 0x01 - ENABLED ACCEPT
  • 0x02 - ENABLED REJECT
PollingTimer[Optional]
  • 0-525600 (min)
  • 0:disabled
ConnectionRetryTimers[Optional]
APNInfo[Optional]
NotifStore[Optional]
  • 0 : Disabled.
  • 1 : Enabeld.
PeroidInfo[Optional]
bAutoReboot[Optional]
  • Automatic device reboot when the request is received from AirVantage server
    • 0x00 - FALSE
    • 0x01 - TRUE
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
Setting PromptFwDownload/PromptFwUpdate as TRUE implies AutoConnect to be also TRUE even if AutoConnect was set FALSE initially. Automatic firmware download/update selection trumps the connection setting flag.

Function Documentation

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

Returns information related to the current AVMS session.

Parameters
pBinaryUpdteSessionInfo[OUT]
pAVMSConfig[OUT]
pNotif[OUT]
pPackageID[OUT]
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
Timeout: 2 seconds
ULONG SLQSAVMSGetSettings ( SLQSAVMSSettings settings)
ULONG SLQSAVMSGetSettings_v2 ( SLQSAVMSSettings_v2 settings)
ULONG SLQSAVMSSelection ( BYTE  selection,
ULONG pDeferTime,
BYTE pClientPerfOperationFlag,
BYTE pPackageID,
WORD pRejectReason 
)

Sends the specified AVMS selection for the current network initiated session.

Parameters
selection[IN]
  • AVMS User Selection.
    • 0x01 - Accept.
    • 0x02 - Reject.
    • 0x03 - Defer.
pDeferTime[IN]
  • Defer time in minutes. A value of 0 will cause the prompt to be resent immediately.
pClientPerfOperationFlag[IN]
  • Client operation flag after accept.
    • 0 - if modem performs the operation (download or update).
    • 1 - if client performs the operation (download or update).
pPackageID[IN]
  • Package ID (relevant to Application binary package)
    • Package ID of the application binary that the client is referring to for its selection. If this field is absent, the modem will assume the package of the most recent AVMS_EVENT_ID notification.
pRejectReason[IN]
  • Reject reason.
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
Timeout: 2 seconds
ULONG SLQSAVMSSetEventReport ( )

Sets AVMS Event Report.

Parameters
NULL
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
Timeout: 2 seconds
ULONG SLQSAVMSSetSettings ( SLQSAVMSSetSettingsReq  Request)

Sets AVMS settings requested (For AVC1 service).

Parameters
Request[IN]
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
Timeout: 2 seconds
ULONG SLQSAVMSSetSettings_v2 ( SLQSAVMSSetSettingsReq_v2  Request)

Sets AVMS settings requested (AVC2 service).

Parameters
Request[IN]
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
Timeout: 2 seconds
ULONG SLQSAVMSSetSettingsIgnoreAutoReboot ( SLQSAVMSSetSettingsReq  Request)

Sets AVMS settings requested without Auto Reboot.

Parameters
Request[IN]
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
Timeout: 2 seconds
ULONG SLQSAVMSStartSession ( BYTE  sessionType,
ULONG pSessionResponse 
)

Starts an AVMS session.

Parameters
sessionType[IN]
  • Session type
    • 0x01 - FOTA, to check availability of FW Update. This field is mandatory in OMA-DM case but not necessary in LWM2M one. To keep compatibility, this shall be used in LWM2M without any specific treatment.
pSessionResponse[OUT]
  • Session Response
    • 0x01 -Available.
    • 0x02 -Not Available.
    • 0x03 -Check Timed Out
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
Timeout: 2 seconds
ULONG SLQSAVMSStopSession ( BYTE  sessiontype,
BYTE pSessionRep 
)

Stop an ongoing AVMS session.

Parameters
session[IN]
  • Session
    • 0x01 - FOTA, to check availability of FW Update.
    • 0xFF - Cancel any active OMADM session.
pSessionRep[OUT]
  • Session
    • 0x01 - FOTA session suspended.
    • 0xFF - Suspend ongoing FOTA session or stop any other active AVMS session.
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
Timeout: 2 seconds

Copyright (c) 2011-2015 Sierra Wireless, Inc. All rights reserved