SWI OMA-DM related APIs. More...

#include "ap/apidefs.h"
#include "SwiApiCmDm.h"

Functions
SWI_API SWI_RCODE	SwiGetOMADMConfig (SWI_STRUCT_OMADM_GET_CONFIG *psConfig, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetOMADMConfig (const SWI_STRUCT_OMADM_SET_CONFIG psConfig, swi_uint8 pStatus, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiStartOMADMSession (const SWI_STRUCT_OMADM_START_SESSION psSession, swi_uint8 pStatus, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiCancelOMADMSession (SWI_STRUCT_OMADM_CANCEL_RESP *pStatus, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetOMADMSessionState (SWI_STRUCT_OMADM_SESSION_STATE *psState, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetOMADMNIAlert (SWI_STRUCT_OMADM_NI_ALERT *psAlert, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetOMADMNIAlertResponse (swi_uint16 nResponse, SWI_STRUCT_OMADM_NI_ALERT_RESP *psStatus, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetOMADMUIAlertConfirm (const SWI_STRUCT_OMADM_UI_ALERT_CONFIRM_RESP psConfirm, swi_uint16 pConfResp, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetOMADMUIAlertInput (const SWI_STRUCT_OMADM_UI_ALERT_INPUT_RESP psInput, swi_uint16 pInputResp, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetOMADMUIAlertChoice (const SWI_STRUCT_OMADM_UI_ALERT_CHOICE_RESP psChoice, swi_uint16 pConfResp, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetOMADMBootAlgorithm (swi_uint16 *pStatus, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetOMADMNodeValue (const SWI_STRUCT_OMADM_NODE_VALUE_REQUEST psItem, SWI_STRUCT_OMADM_NODE_VALUE_RESPONSE psValue, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetOMADMNodeValue (const SWI_STRUCT_OMADM_NODE_VALUE psValue, swi_uint8 pStatus, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetDMDLAlertResponse (swi_uint8 nResponse, swi_uint8 *pStatus, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetDMDLProgress (SWI_STRUCT_DM_DL_PROGRESS *psProgress, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetDMDLDescription (SWI_STRUCT_DM_DL_DESCRIPTION *psDescription, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetDMDLInstallStatus (SWI_STRUCT_DM_DL_INSTALL_STATUS *psStatus, swi_uint32 timeout)

Detailed Description

SWI OMA-DM related APIs.

Function Documentation

SWI_API SWI_RCODE SwiCancelOMADMSession	(	SWI_STRUCT_OMADM_CANCEL_RESP *	pStatus,
		swi_uint32	timeout
	)

This function requests the device to cancel a OMA-DM session.

Parameters

pStatus[OUT]	Contains OMADM cancel status information. See SWI_STRUCT_OMADM_CANCEL_RESP.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiGetDMDLDescription	(	SWI_STRUCT_DM_DL_DESCRIPTION *	psDescription,
		swi_uint32	timeout
	)

This function gets the the DM Download description text if available.

When the SWI_NOTIFY_DM_DL_Alert notification is received, the nDescAvail parameter will be set if a description is available.

Parameters

psDescription[OUT]	Description. see SWI_STRUCT_DM_DL_DESCRIPTION
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiGetDMDLInstallStatus	(	SWI_STRUCT_DM_DL_INSTALL_STATUS *	psStatus,
		swi_uint32	timeout
	)

This function gets the status of the DM Download install.

When the install begins, the modem will send a SWI_NOTIFY_DM_DL_InstallStatus notification and the modem will de-enumerate from the system (Device Removal) and complete the install. Once the install is complete, the modem will re-enumerate on the system (Device Arrival) and this API should be call (after normal API re-init) to determine the status of the install.

Parameters

psStatus[OUT]	Status of install. See SWI_STRUCT_DM_DL_INSTALL_STATUS.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiGetDMDLProgress	(	SWI_STRUCT_DM_DL_PROGRESS *	psProgress,
		swi_uint32	timeout
	)

This function gets the progress of the DM Download.

This same information is provided in the SWI_NOTIFY_DM_DL_Progress notification when a download is in progress.

Parameters

psProgress[IN]	Contains progress info. See SWI_STRUCT_DM_DL_PROGRESS.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiGetOMADMConfig	(	SWI_STRUCT_OMADM_GET_CONFIG *	psConfig,
		swi_uint32	timeout
	)

This function gets the current OMA-DM configuration supported by the device.

Notification: SWI_NOTIFY_OMADM_Config returns the same data.

Parameters

psConfig[OUT]	Struct containing configuration params. See SWI_STRUCT_OMADM_GET_CONFIG.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiGetOMADMNIAlert	(	SWI_STRUCT_OMADM_NI_ALERT *	psAlert,
		swi_uint32	timeout
	)

This function gets OMA-DM Network Initiated Alert information stored.

Parameters

psAlert[OUT]	Contains OMA-DM NI Alert information. See SWI_STRUCT_OMADM_NI_ALERT.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiGetOMADMNodeValue	(	const SWI_STRUCT_OMADM_NODE_VALUE_REQUEST *	psItem,
		SWI_STRUCT_OMADM_NODE_VALUE_RESPONSE *	psValue,
		swi_uint32	timeout
	)

This function gets a DM tree node value.

Parameters

psItem[IN]	Node value to retrieve. See SWI_STRUCT_OMADM_NODE_VALUE_REQUEST.
psValue[Out]	Node value data. See SWI_STRUCT_OMADM_NODE_VALUE_RESPONSE.
timeout[IN]	Function timeout in milliseconds.

Returns: SWI_RCODE_OMADM_ERROR: The OMADM service returned an error.; See SwiRcodes.h

SWI_API SWI_RCODE SwiGetOMADMSessionState	(	SWI_STRUCT_OMADM_SESSION_STATE *	psState,
		swi_uint32	timeout
	)

This function gets the current OMA-DM session state information.

Notification: SWI_NOTIFY_OMADM_State returns the same data.

Parameters

psState[OUT]	Contains OMA-DM session state information. See SWI_STRUCT_OMADM_SESSION_STATE.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiSetDMDLAlertResponse	(	swi_uint8	nResponse,
		swi_uint8 *	pStatus,
		swi_uint32	timeout
	)

This function sets a DM Download Alert Response for a SWI_NOTIFY_DM_DL_Alert.

This alert notification is sent from the modem when a DM DL package is ready for download and/or install.

Parameters

nResponse[IN]	User response to alert. See SWI_TYPE_DM_DL_ALERT_RESP
pStatus[OUT]	Status of response from modem: 0:Success 1:Fail - unspecified 2:Fail - invalid response
timeout[IN]	Function timeout in milliseconds.

Returns: SWI_RCODE_OMADM_ERROR: The OMADM service returned an error.; See SwiRcodes.h

SWI_API SWI_RCODE SwiSetOMADMBootAlgorithm	(	swi_uint16 *	pStatus,
		swi_uint32	timeout
	)

This function commands the modem to update any per unit DM session configuration values in the device's management tree.

Parameters

pStatus[OUT]	Result of operation.
timeout[IN]	Function timeout in milliseconds.

Returns: SWI_RCODE_OMADM_ERROR: The OMADM service returned an error.; See SwiRcodes.h

SWI_API SWI_RCODE SwiSetOMADMConfig	(	const SWI_STRUCT_OMADM_SET_CONFIG *	psConfig,
		swi_uint8 *	pStatus,
		swi_uint32	timeout
	)

This function sets the current OMA-DM configuration in the device.

Attempting to reset HFA status requires modem to be MSL unlocked.

Parameters

psConfig[IN]	Struct containing configuration params. See SWI_STRUCT_OMADM_SET_CONFIG.
pStatus[OUT]	Contains OMADM error status if return code is SWI_RCODE_OMADM_ERROR.
timeout[IN]	Function timeout in milliseconds.

Returns: SWI_RCODE_OMADM_ERROR: The OMADM service returned an error.; Also see SwiRcodes.h.

SWI_API SWI_RCODE SwiSetOMADMNIAlertResponse	(	swi_uint16	nResponse,
		SWI_STRUCT_OMADM_NI_ALERT_RESP *	psStatus,
		swi_uint32	timeout
	)

This function sends a response for the NI Alert to modem.

Parameters

nResponse[IN]	0 = Deny; 1 = Allow.
psStatus[OUT]	Contains OMADM response status. See SWI_STRUCT_OMADM_NI_ALERT_RESP.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiSetOMADMNodeValue	(	const SWI_STRUCT_OMADM_NODE_VALUE *	psValue,
		swi_uint8 *	pStatus,
		swi_uint32	timeout
	)

This function sets a DM tree node value.

Parameters

psValue[IN]	Node value item and data. See SWI_STRUCT_OMADM_NODE_VALUE.
pStatus[OUT]	Status of operation. See SWI_STRUCT_OMADM_NODE_VALUE_RESPONSE.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiSetOMADMUIAlertChoice	(	const SWI_STRUCT_OMADM_UI_ALERT_CHOICE_RESP *	psChoice,
		swi_uint16 *	pConfResp,
		swi_uint32	timeout
	)

This function is not implemented in EVDO SWI and SDK7 SWI

Parameters

psChoice[IN]	This is a parameter.
pConfResp[IN]	This is a parameter.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiSetOMADMUIAlertConfirm	(	const SWI_STRUCT_OMADM_UI_ALERT_CONFIRM_RESP *	psConfirm,
		swi_uint16 *	pConfResp,
		swi_uint32	timeout
	)

This function is not implemented in EVDO SWI and SDK7 SWI

Parameters

psConfirm[IN]	This is a parameter.
pConfResp[IN]	This is a parameter.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiSetOMADMUIAlertInput	(	const SWI_STRUCT_OMADM_UI_ALERT_INPUT_RESP *	psInput,
		swi_uint16 *	pInputResp,
		swi_uint32	timeout
	)

This function is not implemented in EVDO SWI and SDK7 SWI

Parameters

psInput[IN]	This is a parameter.
pInputResp[IN]	This is a parameter.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiStartOMADMSession	(	const SWI_STRUCT_OMADM_START_SESSION *	psSession,
		swi_uint8 *	pStatus,
		swi_uint32	timeout
	)

This function requests the device to start a OMA-DM session.

Parameters

psSession[IN]	Struct containing sesssion start params. See SWI_STRUCT_OMADM_START_SESSION.
pStatus[OUT]	Contains OMADM error status if returning code is SWI_RCODE_OMADM_ERROR.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

Functions

Detailed Description

Function Documentation