LinuxQMISDK  SLQS03.03.16
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Data Structures | Typedefs | Functions
qaGobiApiSwiOmadms.h File Reference
SWI Open Mobile Alliance Service (SWIOMA)

SWI Open Mobile Alliance Device Management Service API function prototypes SWI OMA-DM QMI Service revision 1.6. More...

Go to the source code of this file.

Data Structures

struct  _SLQSOMADMSessionInfo
 
struct  _SLQSOMADMSettingsReqParams
 
struct  _SLQSOMADMSettings
 
struct  _SLQSOMADMSettingsReqParams3
 

Typedefs

typedef struct
_SLQSOMADMSessionInfo 		SLQSOMADMSessionInfo
 
typedef struct
_SLQSOMADMSettingsReqParams 		SLQSOMADMSettingsReqParams
 
typedef struct _SLQSOMADMSettings SLQSOMADMSettings
 
typedef struct
_SLQSOMADMSettingsReqParams3 		SLQSOMADMSettingsReqParams3
 

Functions

ULONG SLQSOMADMStartSession (ULONG sessionType)
 
ULONG SLQSOMADMCancelSession (ULONG session)
 
ULONG SLQSOMADMGetSessionInfo (ULONG *pSessionType, SLQSOMADMSessionInfo *pResp)
 
ULONG SLQSOMADMSendSelection (ULONG selection)
 
ULONG SLQSOMADMGetSettings (ULONG *pbOMADMEnabled, ULONG *pbFOTAdownload, ULONG *pbFOTAUpdate)
 
ULONG SLQSOMADMSetSettings (ULONG bFOTAdownload, ULONG bFOTAUpdate)
 
ULONG SLQSOMADMSetSettings2 (SLQSOMADMSettingsReqParams *pSLQSOMADMSettingsReqParams)
 
ULONG SLQSOMADMGetSettings2 (SLQSOMADMSettings *pSLQSOMADMSettings)
 
ULONG SLQSOMADMStartSession2 (ULONG sessionType, ULONG *pFwAvailability)
 
ULONG SLQSOMADMSendSelection2 (ULONG selection, ULONG *pDeferTime, ULONG *pRejectReason)
 
ULONG SLQSOMADMSetSettings3 (SLQSOMADMSettingsReqParams3 *pSLQSOMADMSettingsReqParams3)
 

Detailed Description

SWI Open Mobile Alliance Device Management Service API function prototypes SWI OMA-DM QMI Service revision 1.6.

Typedef Documentation

typedef struct _SLQSOMADMSessionInfo SLQSOMADMSessionInfo

Structure containing the OMA DM Session Info returned by the device. Also used as input parameter to specify the size of variable parameters. (ref. notes)

Parameters
pStatus
  • 1 Byte parameter indicating status(optional)
    • 0x01 - No Firmware available
    • 0x02 - Query Firmware Download
    • 0x03 - Firmware Downloading
    • 0x04 - Firmware Downloaded
    • 0x05 - Query Firmware Update
    • 0x06 - Firmware Updating
    • 0x07 - Firmware Updated
pUpdateCompleteStatus
pSeverity
  • 1 byte parameter indicating severity(optional)
    • 0x01 - Mandatory
    • 0x02 - Optional
pSourceLength
  • 2 byte parameter indicating Length of Vendor Name String in Bytes.(optional)
pSource
  • Variable length parameter indicating Vendor Name in ASCII(optional)
pPkgNameLength
  • 2 byte parameter indicating Length of Package Name String in Bytes.(optional)
pPkgName
  • Variable length parameter indicating Package Name in ASCII(optional)
pPkgDescLength
  • 2 byte parameter indicating Length of Package Description String in Bytes.(optional)
pPkgDescription
  • Variable length parameter indicating Package Description in ASCII(optional)
pDateLength
  • 2 byte parameter indicating Length of Package Description String in Bytes.(optional)
pDate
  • Variable length parameter indicating Package Description in ASCII
pTimeLength
  • 2 byte parameter indicating Length of Time String in Bytes.(optional)
pTime
  • Variable length parameter indicating Time String in ASCII(optional)
pSessionType
  • 1 byte parameter reflects the last session started for Sprint(optional)
    • 0x00 - No session since boot
    • 0x01 - Sprint CI-DC Session
    • 0x02 - Sprint CI-PRL Session
    • 0x03 - Sprint CI-FUMO Session
    • 0x04 - Sprint HFA-DC Session
    • 0x05 - Sprint HFA-PRL Session
    • 0x06 - Sprint HFA-FUMO Session
    • 0x07 - Sprint NI Session
pSessionState
  • 1 byte parameter indicating session state(optional)
    • 0x01 - idle
    • 0x02 - active
    • 0x03 - pending
pRetryCount
  • 1 byte parameter indicating retries left count(optional)
    • valid values 0 to 6
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
As input parameter the members pSourceLength, pPkgNameLength pPkgDescLength, pDateLength, pTimeLength have to be specified. These should contain the initialized size of pSource, pPkgName, pPkgDescription, pDate, pTime respectively.
typedef struct _SLQSOMADMSettings SLQSOMADMSettings

Structure containing the OMA DM settings retrieved from the device

Parameters
pOMADMEnabled[OUT]
  • 4 byte parameter indicating OMADM service enabled
    • 0x00000001 - Client-initiated device configuration
    • 0x00000002 - Network-initiated device configuration
    • 0x00000010 - Client-initiated FUMO
    • 0x00000020 - Network-initiated FUMO
  • function SLQSOMADMGetSettings2() returns a default value 0xFFFFFFFF in case this parameter is not returned by the modem.
pFOTAdownload[OUT]
  • 1 Byte parameter indicating support for FOTA Automatic download
    • 0x00 - Host permission required before downloading
    • 0x01 - Automatically start downloading, no host permission required
    • 0x02 - Automatically start downloading, while not roaming
    • 0x03 - Automatically reject download
    • 0x04 - Automatically reject download with “Enterprise Reject Policy”
  • function SLQSOMADMGetSettings2() returns a default value 0xFF in case this parameter is not returned by the modem.
pFOTAUpdate[OUT]
  • 1 byte parameter indicating FOTA Automatic update
    • 0x00 - User permission required before updating firmware
    • 0x01 - No user permission required before updating firmware
    • 0x02 - User permission required, auto update on power up
  • function SLQSOMADMGetSettings2() returns a default value 0xFF in case this parameter is not returned by the modem.
pAutosdm[OUT]
  • 1 byte parameter indicating OMA Automatic UI Alert Response
    • 0x00 - Disabled
    • 0x01 - Enabled Accept
    • 0x02 - Enabled Reject
  • function SLQSOMADMGetSettings2() returns a default value 0xFF in case this parameter is not returned by the modem.
pFwAutoCheck[OUT]
  • Optional 1 byte parameter indicating OMA Automatic Check for Firmware Update on Power-Up Response
    • 0x00 - Disabled
    • 0x01 - Enabled
  • function SLQSOMADMGetSettings2() returns a default value 0xFF in case this parameter is not returned by the modem.
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
typedef struct _SLQSOMADMSettingsReqParams SLQSOMADMSettingsReqParams

Structure containing the OMA DM settings to be set on the device

Parameters
FOTAdownload
  • 1 Byte parameter indicating support for FOTA Automatic download
    • 0x00 - Firmware auto download FALSE
    • 0x01 - Firmware auto download TRUE
FOTAUpdate
  • 1 byte parameter indicating FOTA Automatic update
    • 0x00 - Firmware auto update FALSE
    • 0x01 - Firmware auto update TRUE
pAutosdm[IN]
  • Optional 1 byte parameter indicating OMA Automatic UI Alert Response
    • 0x00 - Disabled
    • 0x01 - Enabled Accept
    • 0x02 - Enabled Reject
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
typedef struct _SLQSOMADMSettingsReqParams3 SLQSOMADMSettingsReqParams3

Structure containing the OMA DM settings to be set on the device

Parameters
FOTAdownload
  • 1 Byte parameter indicating support for FOTA Automatic download
    • 0x00 - Firmware auto download FALSE
    • 0x01 - Firmware auto download TRUE
FOTAUpdate
  • 1 byte parameter indicating FOTA Automatic update
    • 0x00 - Firmware auto update FALSE
    • 0x01 - Firmware auto update TRUE
pAutosdm[IN]
  • Optional 1 byte parameter indicating OMA Automatic UI Alert Response
    • 0x00 - Disabled
    • 0x01 - Enabled Accept
    • 0x02 - Enabled Reject
pFwAutoCheck[IN]
  • Optional 1 byte parameter indicating OMA Automatic Check for Firmware Update on Power-Up Response
    • 0x00 - Disabled
    • 0x01 - Enabled
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values

Function Documentation

ULONG SLQSOMADMCancelSession ( ULONG  session)

Cancels an ongoing OMA-DM session.

Parameters
session[IN]
  • Session
    • 0x01 - FOTA, to check availability of FW Update
    • 0xFF - Cancel any active OMADM session
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
Timeout: 20 seconds
ULONG SLQSOMADMGetSessionInfo ( ULONG *  pSessionType,
SLQSOMADMSessionInfo *  pResp 
)

Returns information related to the current (or previous if no session is active) OMA-DM session.

Parameters
SessionType[IN]
  • Session type
    • 0x01 - FOTA
    • 0xFF - Any active OMADM session. If none active, then previous OMADM session
pResp[IN/OUT]
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
Timeout: 20 seconds
ULONG SLQSOMADMGetSettings ( ULONG *  pbOMADMEnabled,
ULONG *  pbFOTAdownload,
ULONG *  pbFOTAUpdate 
)

Returns the OMA-DM settings.

Parameters
pbOMADMEnabled[OUT]
  • Device OMADM service enabled
    • 0x00000001 - Client-initiated device configuration
    • 0x00000002 - Network-initiated device configuration
    • 0x00000010 - Client-initiated FUMO
    • 0x00000020 - Network-initiated FUMO
pbFOTAdownload[OUT]
  • Firmware AutoDownload
    • 0x00 - Firmware auto download FALSE
    • 0x01 - Firmware autod ownload TRUE
    • 0x02 - Automatically start downloading, while not roaming
    • 0x03 - Automatically reject download
    • 0x04 - Automatically reject download with “Enterprise Reject Policy”
pbFOTAUpdate[OUT]
  • Firmware AutoUpdate
    • 0x00 - Firmware auto update FALSE
    • 0x01 - Firmware auto update TRUE
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
Timeout: 20 seconds
ULONG SLQSOMADMGetSettings2 ( SLQSOMADMSettings *  pSLQSOMADMSettings)

Retrieves the OMA-DM settings from the device.

Parameters
SLQSOMADMSettingsReqParams
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
Timeout: 20 seconds
ULONG SLQSOMADMSendSelection ( ULONG  selection)

Sends the specified OMA-DM selection for the current network initiated session.

Parameters
selection[IN]
  • OMA-DM NIA Selection
    • 0x01 - Accept
    • 0x02 - Reject
    • 0x03 - Defer
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
Timeout: 20 seconds
ULONG SLQSOMADMSendSelection2 ( ULONG  selection,
ULONG *  pDeferTime,
ULONG *  pRejectReason 
)

Sends the specified OMA-DM selection for the current network initiated session.

Parameters
selection[IN]
  • OMA-DM NIA 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.
  • This TLV is mandatory if selection is set to 0x03.
pRejectReason[IN]
  • Reject Reason
  • This TLV is processed if selection is set to 0x02. If it is not present, the reject reason 0 is used as default.
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
Timeout: 20 seconds
ULONG SLQSOMADMSetSettings ( ULONG  bFOTAdownload,
ULONG  bFOTAUpdate 
)

Sets the OMA-DM settings requested.

Parameters
bFOTAdownload[IN]
  • Firmware Auto Download
    • 0x00 - Host permission required before downloading
    • 0x01 - Automatically start downloading, no host permission required
    • 0x02 - Automatically start downloading, while not roaming
    • 0x03 - Automatically reject download
    • 0x04 - Automatically reject download with “Enterprise Reject Policy”
bFOTAUpdate[IN]
  • Firmware Auto Update
    • 0x00 - User permission required before updating firmware
    • 0x01 - No user permission required before updating firmware
    • 0x02 - User permission required, auto update on power up
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
Timeout: 20 seconds
ULONG SLQSOMADMSetSettings2 ( SLQSOMADMSettingsReqParams *  pSLQSOMADMSettingsReqParams)

Sets the settings related to OMADM. These settings are saved on the modem across power cycles.

Parameters
pSLQSOMADMSettingsReqParams[IN]
Note
Timeout: 20 seconds
ULONG SLQSOMADMSetSettings3 ( SLQSOMADMSettingsReqParams3 *  pSLQSOMADMSettingsReqParams3)

Sets the settings related to OMADM. These settings are saved on the modem across power cycles.

Parameters
SLQSOMADMSettingsReqParamsExt[IN]
  • See SLQSOMADMSettingsReqParamsExt for more information
Note
Timeout: 20 seconds
ULONG SLQSOMADMStartSession ( ULONG  sessionType)

Starts an OMA-DM session.

Parameters
sessionType[IN]
  • Session type
    • 0x01 - FOTA, to check availability of FW Update
    • 0x02 - DM, to check availability of DM Update
    • 0x03 - PRL, to check availability of PRL Update
Returns
eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
See Also
See qmerrno.h for eQCWWAN_xxx error values
Note
Timeout: 20 seconds
ULONG SLQSOMADMStartSession2 ( ULONG  sessionType,
ULONG *  pFwAvailability 
)

Starts an OMA-DM session.

Parameters
sessionType[IN]
  • Session type
    • 0x01 - FOTA, to check availability of FW Update
    • 0x02 - DM, to check availability of DM Update
    • 0x03 - PRL, to check availability of PRL Update
pFwAvailability[OUT]
  • OMA-DM CHECK FW Available
    • 0x00000001 - FW Available. For CIDC and CIPRL, this value will be returned by the modem. CIDC and CIPRL are asynchronous OMADM sessions.
    • 0x00000002 - FW Not Available
    • 0x00000003 - FW 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: 20 seconds
Copyright (c) 2011-2015 Sierra Wireless, Inc. All rights reserved