qaGobiApiSwiOmadms.h File Reference
SWI Open Mobile Alliance Device Management Service API function prototypes.
More...
Go to the source code of this file.
Detailed Description
SWI Open Mobile Alliance Device Management Service API function prototypes.
Copyright: © 2011 Sierra Wireless, Inc. all rights reserved
Typedef Documentation
Structure containing the OMA DM settings retrieved from the device
- Parameters:
-
| pOMADMEnabled[OUT] |
- Optional 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] |
- Optional 1 Byte parameter indicating support for FOTA Automatic download
- 0x00 - Firmware autodownload FALSE
- 0x01 - Firmware autodownload TRUE
- function SLQSOMADMGetSettings2() returns a default value 0xFF in case this parameter is not returned by the modem.
|
| pFOTAUpdate[OUT] |
- Optional 1 byte parameter indicating FOTA Automatic update
- 0x00 - Firmware autoupdate FALSE
- 0x01 - Firmware autoupdate TRUE
- function SLQSOMADMGetSettings2() returns a default value 0xFF in case this parameter is not returned by the modem.
|
| pAutosdm[OUT] |
- Optional 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.
|
- Returns:
- eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
- See also:
- See qmerrno.h for eQCWWAN_xxx error values
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 autodownload FALSE
- 0x01 - Firmware autodownload TRUE
|
| FOTAUpdate |
- 1 byte parameter indicating FOTA Automatic update
- 0x00 - Firmware autoupdate FALSE
- 0x01 - Firmware autoupdate 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
Function Documentation
Cancels an ongoing OMA-DM session.
- Parameters:
-
| session[IN] |
- Session
- 0x01 - FOTA, to check availability of FW Update
- 0x02 - DM, to check availability of DM Update
|
- Returns:
- eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
- See also:
- See qmerrno.h for eQCWWAN_xxx error values
- Note:
- Technology Supported: UMTS/CDMA
Device Supported: MC7750
Timeout: 20 seconds
ULONG SLQSOMADMGetSessionInfo |
( |
ULONG * |
pSessionType, |
|
|
ULONG * |
pSessionState | |
|
) |
| | |
Returns information related to the current (or previous if no session is active) OMA-DM session.
- Parameters:
-
| SessionType[IN/OUT] |
|
| pSessionState[OUT] |
- Session state
- 0x00 - OMA-DM Session Complete
- 0x01 - OMA-DM Session Failed
- 0x02 - Downloading Firmware Session Complete
|
- Returns:
- eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
- See also:
- See qmerrno.h for eQCWWAN_xxx error values
- Note:
- Technology Supported: UMTS/CDMA
Device Supported: MC7750
Timeout: 20 seconds
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 autodownload FALSE
- 0x01 - Firmware autodownload TRUE
|
| pbFOTAUpdate[OUT] |
- Firmware AutoUpdate
- 0x00 - Firmware autoupdate FALSE
- 0x01 - Firmware autoupdate TRUE
|
- Returns:
- eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
- See also:
- See qmerrno.h for eQCWWAN_xxx error values
- Note:
- Technology Supported: UMTS/CDMA
Device Supported: MC7750
Timeout: 20 seconds
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:
- Technology Supported: UMTS/CDMA
Device Supported: MC7750
Timeout: 20 seconds
Sends the specified OMA-DM selection for the current network initiated session.
- Parameters:
-
| selection[IN] |
- OMA-DM NIA Selection
- 0x01 - Accept
- 0x02 - RejectSession
|
- Returns:
- eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
- See also:
- See qmerrno.h for eQCWWAN_xxx error values
- Note:
- Technology Supported: UMTS/CDMA
Device Supported: MC7750
Timeout: 20 seconds
Sets the OMA-DM settings requested.
- Parameters:
-
| bFOTAdownload[IN] |
- Firmware AutoDownload
- 0x00 - Firmware autodownload FALSE
- 0x01 - Firmware autodownload TRUE
|
| bFOTAUpdate[IN] |
- Firmware AutoUpdate
- 0x00 - Firmware autoupdate FALSE
- 0x01 - Firmware autoupdate TRUE
|
- Returns:
- eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
- See also:
- See qmerrno.h for eQCWWAN_xxx error values
- Note:
- Technology Supported: UMTS/CDMA
Device Supported: MC7750
Timeout: 20 seconds
Sets the settings related to OMADM. These settings are saved on the modem across power cycles.
- Parameters:
-
| pSLQSOMADMSettingsReqParams[IN] |
|
- Note:
- Technology Supported: UMTS/CDMA
Device Supported: MC7750
Timeout: 20 seconds
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
|
- Returns:
- eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise
- See also:
- See qmerrno.h for eQCWWAN_xxx error values
- Note:
- Technology Supported: UMTS/CDMA
Device Supported: MC7750
Timeout: 20 seconds