SwiApiCmDm.h File Reference

SWI OMA-DM related APIs. More...

#include "SwiDataTypes.h"
#include "SwiRcodes.h"

Go to the source code of this file.

Data Structures
struct	SWI_STRUCT_OMADM_GET_CONFIG
struct	SWI_STRUCT_OMADM_SET_CONFIG
struct	SWI_STRUCT_OMADM_START_SESSION
struct	SWI_STRUCT_OMADM_CANCEL_RESP
struct	SWI_STRUCT_OMADM_SESSION_STATE
struct	SWI_STRUCT_OMADM_NI_ALERT
struct	SWI_STRUCT_OMADM_NI_ALERT_RESP
struct	SWI_STRUCT_OMADM_UI_ALERT_DISPLAY
struct	SWI_STRUCT_OMADM_UI_ALERT_CONFIRM
struct	SWI_STRUCT_OMADM_UI_ALERT_CONFIRM_RESP
struct	SWI_STRUCT_OMADM_UI_ALERT_INPUT
struct	SWI_STRUCT_OMADM_UI_ALERT_INPUT_RESP
struct	SWI_STRUCT_OMADM_UI_ALERT_CHOICE
struct	SWI_STRUCT_OMADM_UI_ALERT_CHOICE_RESP
struct	SWI_STRUCT_OMADM_NODE_VALUE_REQUEST
struct	SWI_STRUCT_OMADM_NODE_VALUE_RESPONSE
struct	SWI_STRUCT_OMADM_NODE_VALUE
struct	SWI_STRUCT_DM_DL_PROGRESS
struct	SWI_STRUCT_DM_DL_ALERT
struct	SWI_STRUCT_DM_DL_DESCRIPTION
struct	SWI_STRUCT_DM_DL_INSTALL_STATUS

Macros
#define	MAX_DL_PKG_NAME   232
#define	MAX_DL_DESCRIPTION   1024
#define	LENGTH_DM_TLV_HEADER   4
#define	NUM_Node_Data_Sub_TLV   4

Typedefs
typedef enum SWI_TYPE_OMADM_DEVICE_CAPABILITY	SWI_TYPE_OMADM_DEVICE_CAPABILITY
typedef enum SWI_TYPE_OMADM_FEATURE_CAPABILITY	SWI_TYPE_OMADM_FEATURE_CAPABILITY
typedef struct SWI_STRUCT_OMADM_GET_CONFIG	SWI_STRUCT_OMADM_GET_CONFIG
typedef enum SWI_TYPE_OMADM_STATUS_RESP	SWI_TYPE_OMADM_STATUS_RESP
typedef struct SWI_STRUCT_OMADM_SET_CONFIG	SWI_STRUCT_OMADM_SET_CONFIG
typedef enum SWI_TYPE_OMADM_SESSION_TYPE	SWI_TYPE_OMADM_SESSION_TYPE
typedef enum SWI_TYPE_OMADM_USER_CI_SESSION_TYPE	SWI_TYPE_OMADM_USER_CI_SESSION_TYPE
typedef struct SWI_STRUCT_OMADM_START_SESSION	SWI_STRUCT_OMADM_START_SESSION
typedef enum SWI_TYPE_OMADM_CANCEL_STATUS	SWI_TYPE_OMADM_CANCEL_STATUS
typedef struct SWI_STRUCT_OMADM_CANCEL_RESP	SWI_STRUCT_OMADM_CANCEL_RESP
typedef enum SWI_TYPE_OMADM_SESSION_STATE	SWI_TYPE_OMADM_SESSION_STATE
typedef enum SWI_TYPE_OMADM_SESSION_INITIATOR	SWI_TYPE_OMADM_SESSION_INITIATOR
typedef enum SWI_TYPE_OMADM_SESSION_UI_MODE	SWI_TYPE_OMADM_SESSION_UI_MODE
typedef enum SWI_TYPE_OMADM_SESSION_RESULT	SWI_TYPE_OMADM_SESSION_RESULT
typedef enum SWI_TYPE_OMADM_SESSION_COMMIT	SWI_TYPE_OMADM_SESSION_COMMIT
typedef struct SWI_STRUCT_OMADM_SESSION_STATE	SWI_STRUCT_OMADM_SESSION_STATE
typedef enum SWI_TYPE_OMADM_NIA_PENDING	SWI_TYPE_OMADM_NIA_PENDING
typedef enum SWI_TYPE_OMADM_NIA_UI_MODE	SWI_TYPE_OMADM_NIA_UI_MODE
typedef enum SWI_TYPE_OMADM_NIA_SESSION_TYPE	SWI_TYPE_OMADM_NIA_SESSION_TYPE
typedef struct SWI_STRUCT_OMADM_NI_ALERT	SWI_STRUCT_OMADM_NI_ALERT
typedef enum SWI_TYPE_OMADM_NI_ALERT_RESP_STATUS	SWI_TYPE_OMADM_NI_ALERT_RESP_STATUS
typedef struct SWI_STRUCT_OMADM_NI_ALERT_RESP	SWI_STRUCT_OMADM_NI_ALERT_RESP
typedef struct SWI_STRUCT_OMADM_UI_ALERT_DISPLAY	SWI_STRUCT_OMADM_UI_ALERT_DISPLAY
typedef enum SWI_TYPE_OMADM_UI_ALERT_CONFIRM_DEFAULT	SWI_TYPE_OMADM_UI_ALERT_CONFIRM_DEFAULT
typedef struct SWI_STRUCT_OMADM_UI_ALERT_CONFIRM	SWI_STRUCT_OMADM_UI_ALERT_CONFIRM
typedef enum SWI_TYPE_OMADM_UI_ALERT_USER_CONFIRM	SWI_TYPE_OMADM_UI_ALERT_USER_CONFIRM
typedef enum SWI_TYPE_OMADM_UI_ALERT_CONFIRM_RESP	SWI_TYPE_OMADM_UI_ALERT_CONFIRM_RESP
typedef struct SWI_STRUCT_OMADM_UI_ALERT_CONFIRM_RESP	SWI_STRUCT_OMADM_UI_ALERT_CONFIRM_RESP
typedef enum SWI_TYPE_OMADM_UI_ALERT_INPUT_TYPE	SWI_TYPE_OMADM_UI_ALERT_INPUT_TYPE
typedef enum SWI_TYPE_OMADM_UI_ALERT_ECHO_TYPE	SWI_TYPE_OMADM_UI_ALERT_ECHO_TYPE
typedef struct SWI_STRUCT_OMADM_UI_ALERT_INPUT	SWI_STRUCT_OMADM_UI_ALERT_INPUT
typedef struct SWI_STRUCT_OMADM_UI_ALERT_INPUT_RESP	SWI_STRUCT_OMADM_UI_ALERT_INPUT_RESP
typedef enum SWI_TYPE_OMADM_UI_ALERT_CHOICE_TYPE	SWI_TYPE_OMADM_UI_ALERT_CHOICE_TYPE
typedef struct SWI_STRUCT_OMADM_UI_ALERT_CHOICE	SWI_STRUCT_OMADM_UI_ALERT_CHOICE
typedef struct SWI_STRUCT_OMADM_UI_ALERT_CHOICE_RESP	SWI_STRUCT_OMADM_UI_ALERT_CHOICE_RESP
typedef struct SWI_STRUCT_OMADM_NODE_VALUE_REQUEST	SWI_STRUCT_OMADM_NODE_VALUE_REQUEST
typedef struct SWI_STRUCT_OMADM_NODE_VALUE_RESPONSE	SWI_STRUCT_OMADM_NODE_VALUE_RESPONSE
typedef struct SWI_STRUCT_OMADM_NODE_VALUE	SWI_STRUCT_OMADM_NODE_VALUE
typedef enum SWI_TYPE_DM_DL_PROGRESS_TYPE	SWI_TYPE_DM_DL_PROGRESS_TYPE
typedef struct SWI_STRUCT_DM_DL_PROGRESS	SWI_STRUCT_DM_DL_PROGRESS
typedef enum SWI_TYPE_DM_DL_VALID_RESP	SWI_TYPE_DM_DL_VALID_RESP
typedef enum SWI_TYPE_DM_DL_ALERT_PROMPT	SWI_TYPE_DM_DL_ALERT_PROMPT
typedef struct SWI_STRUCT_DM_DL_ALERT	SWI_STRUCT_DM_DL_ALERT
typedef enum SWI_TYPE_DM_DL_ALERT_RESP	SWI_TYPE_DM_DL_ALERT_RESP
typedef enum SWI_TYPE_DM_DL_ALERT_RESP_STATUS	SWI_TYPE_DM_DL_ALERT_RESP_STATUS
typedef struct SWI_STRUCT_DM_DL_DESCRIPTION	SWI_STRUCT_DM_DL_DESCRIPTION
typedef enum SWI_TYPE_DM_DL_INSTALL_STATE	SWI_TYPE_DM_DL_INSTALL_STATE
typedef struct SWI_STRUCT_DM_DL_INSTALL_STATUS	SWI_STRUCT_DM_DL_INSTALL_STATUS
typedef enum SWI_TYPE_DM_TLV_TYPE	SWI_TYPE_DM_TLV_TYPE

Enumerations
enum	SWI_TYPE_OMADM_DEVICE_CAPABILITY { OMADM_DEVICE_CAPABILITY_NONE = 0x00, OMADM_DEVICE_CAPABILITY_SWI = 0x01, OMADM_DEVICE_CAPABILITY_REDBEND = 0x02 }
enum	SWI_TYPE_OMADM_FEATURE_CAPABILITY {   OMADM_FEATURE_CIDC = 0x00000001, OMADM_FEATURE_NIDC = 0x00000002, OMADM_FEATURE_CIPRL = 0x00000004, OMADM_FEATURE_NIPRL = 0x00000008,   OMADM_FEATURE_CIFUMO = 0x00000010, OMADM_FEATURE_NIFUMO = 0x00000020, OMADM_FEATURE_HFA = 0x00000040 }
enum	SWI_TYPE_OMADM_STATUS_RESP {   OMADM_STATUS_RESP_SUCCESS = 0x00, OMADM_STATUS_RESP_FAIL = 0x01, OMADM_STATUS_RESP_UNSUPPORTED = 0x02, OMADM_STATUS_RESP_BAD_PARAM = 0x03,   OMADM_STATUS_RESP_INVALID_OPTION = 0x04, OMADM_STATUS_RESP_SECURITY_ACCESS_DENIED = 0x05, OMADM_STATUS_RESP_INVALID_DEVICE_STATE = 0x06, OMADM_STATUS_RESP_INVALID_SESSION_STATE = 0x07,   OMADM_STATUS_RESP_UNSUPPORTED_NODE = 0x08, OMADM_STATUS_RESP_NODE_ALREADY_EXISTS = 0x09, OMADM_STATUS_RESP_MAX_URI_EXCEEDED = 0x0A }
enum	SWI_TYPE_OMADM_SESSION_TYPE {   OMADM_SESSION_TYPE_UNKNOWN = 0x00, OMADM_SESSION_TYPE_DEVICE_CONFIG = 0x01, OMADM_SESSION_TYPE_CDMA_PRL_UPDATE = 0x02, OMADM_SESSION_TYPE_FUMO_INFO_EXCHANGE = 0x03,   OMADM_SESSION_TYPE_HFA = 0x04, OMADM_SESSION_TYPE_DD_DOWNLOAD = 0x05, OMADM_SESSION_TYPE_PKG_DOWNLOAD = 0x06, OMADM_SESSION_TYPE_STATUS_REPORT = 0x07 }
enum	SWI_TYPE_OMADM_USER_CI_SESSION_TYPE { OMADM_USER_CI_SESSION_TYPE_UNKNOWN = 0x00, OMADM_USER_CI_SESSION_TYPE_DEVICE_CONFIG = 0x01, OMADM_USER_CI_SESSION_TYPE_CDMA_PRL_UPDATE = 0x02, OMADM_USER_CI_SESSION_TYPE_FUMO = 0x03 }
enum	SWI_TYPE_OMADM_CANCEL_STATUS { OMADM_CANCEL_SUCCESS = 0x00, OMADM_CANCEL_NO_SESSION = 0x01 }
enum	SWI_TYPE_OMADM_SESSION_STATE { OMADM_SESSION_STATE_IDLE = 0x00, OMADM_SESSION_STATE_ACTIVE = 0x01, OMADM_SESSION_STATE_HFA_PENDING = 0x02 }
enum	SWI_TYPE_OMADM_SESSION_INITIATOR { OMADM_SESSION_INITIATOR_UNKNOWN = 0x00, OMADM_SESSION_INITIATOR_USER_CLIENT = 0x01, OMADM_SESSION_INITIATOR_DEVICE_CLIENT = 0x02, OMADM_SESSION_INITIATOR_NETWORK = 0x03 }
enum	SWI_TYPE_OMADM_SESSION_UI_MODE { OMADM_SESSION_UI_MODE_UNKNOWN = 0x00, OMADM_SESSION_UI_MODE_HIDDEN = 0x01, OMADM_SESSION_UI_MODE_UNHIDDEN = 0x02 }
enum	SWI_TYPE_OMADM_SESSION_RESULT {   OMADM_SESSION_RESULT_SUCCESS = 0x0000, OMADM_SESSION_RESULT_FAIL = 0x0001, OMADM_SESSION_RESULT_NO_COMMANDS_RECEIVED = 0x0002, OMADM_SESSION_RESULT_ABORT_CLIENT_USER = 0x0100,   OMADM_SESSION_RESULT_ABORT_CLIENT_DEVICE = 0x0101, OMADM_SESSION_RESULT_ABORT_SERVER = 0x0102, OMADM_SESSION_RESULT_MEMORY_ERROR = 0x0200, OMADM_SESSION_RESULT_HEAP_TOO_SMALL = 0x0201,   OMADM_SESSION_RESULT_BUFFER_TOO_SMALL = 0x0202, OMADM_SESSION_RESULT_ROUTINE_NOT_ALLOWED = 0x0300, OMADM_SESSION_RESULT_ROUTINE_WHEN_SUSPEND = 0x0301, OMADM_SESSION_RESULT_BAD_INPUT_PARAM = 0x0302,   OMADM_SESSION_RESULT_INVALID_PROTOCOL = 0x0400, OMADM_SESSION_RESULT_AUTH_FAILURE = 0x0401, OMADM_SESSION_RESULT_MISSING_START_MSG = 0x0402, OMADM_SESSION_RESULT_MISSING_END_MSG = 0x0403,   OMADM_SESSION_RESULT_FEATURE_NOT_AVAIL = 0x0404, OMADM_SESSION_RESULT_UIA_PARSE_ERROR = 0x0405, OMADM_SESSION_RESULT_DATA_TOO_BIG_TO_RTN = 0x0406, OMADM_SESSION_RESULT_UNSUPPORTED_PROTOCOL = 0x0500,   OMADM_SESSION_RESULT_MIME_TYPE_MISMATCH = 0x0501, OMADM_SESSION_RESULT_NTWK_FAIL_TO_OPEN = 0x0502, OMADM_SESSION_RESULT_SSL_FAIL_TO_OPEN = 0x0503, OMADM_SESSION_RESULT_FATAL_NTWK_ERROR = 0x0504,   OMADM_SESSION_RESULT_TREE_NODE_EXISTS = 0x1000, OMADM_SESSION_RESULT_TREE_NODE_MISSING = 0x1001, OMADM_SESSION_RESULT_LEAF_NODE_OP_ERROR = 0x1002, OMADM_SESSION_RESULT_INVALID_NODE_TYPE = 0x1003,   OMADM_SESSION_RESULT_UNKNOWN_PROPERTY = 0x1004, OMADM_SESSION_RESULT_DELETE_PERM_NODE = 0x1005, OMADM_SESSION_RESULT_ACCESS_TYPE_INVALID = 0x1006, OMADM_SESSION_RESULT_BAD_NAME_FOR_TREE = 0x1007,   OMADM_SESSION_RESULT_PARTIAL_WRITE_EXT_DATA = 0x1008, OMADM_SESSION_RESULT_EXT_WRITE_TEMP_BLOCKED = 0x1009, OMADM_SESSION_RESULT_VALUE_NOT_WRITABLE = 0x100A, OMADM_SESSION_RESULT_VALUE_NOT_READABLE = 0x100B,   OMADM_SESSION_RESULT_CANNOT_EXECUTE_NODE = 0x100C, OMADM_SESSION_RESULT_TREE_OPEN_ERROR = 0x100D, OMADM_SESSION_RESULT_TREE_COMMIT_ERROR = 0x100E, OMADM_SESSION_RESULT_BOOTSTRAP_RSVD = 0x2000,   OMADM_SESSION_RESULT_FUMO_RSVD = 0x3000 }
enum	SWI_TYPE_OMADM_SESSION_COMMIT { OMADM_SESSION_COMMIT_DATA_NOT_UPDATED = 0x00, OMADM_SESSION_COMMIT_DATA_UPDATED = 0x01 }
enum	SWI_TYPE_OMADM_NIA_PENDING { OMADM_NIA_STATE_PENDING_NONE = 0x00, OMADM_NIA_STATE_PENDING_BLOCKED = 0x01, OMADM_NIA_STATE_PENDING_READY = 0x02 }
enum	SWI_TYPE_OMADM_NIA_UI_MODE {   OMADM_NIA_UI_MODE_UNKNOWN = 0x00, OMADM_NIA_UI_MODE_BACKGROUND = 0x01, OMADM_NIA_UI_MODE_INFORMATIVE = 0x02, OMADM_NIA_UI_MODE_INTERACTIVE = 0x03,   OMADM_NIA_UI_MODE_DORMANT_INTERRUPT = 0x04 }
enum	SWI_TYPE_OMADM_NIA_SESSION_TYPE { OMADM_NIA_SESSION_TYPE_UNKNOWN = 0x00, OMADM_NIA_SESSION_TYPE_DEVICE_CONFIG = 0x01, OMADM_NIA_SESSION_TYPE_CDMA_PRL_UPDATE = 0x02, OMADM_NIA_SESSION_TYPE_FUMO = 0x03 }
enum	SWI_TYPE_OMADM_NI_ALERT_RESP_STATUS { OMADM_NI_ALERT_RESP_STATUS_ACCEPTED = 0x00, OMADM_NI_ALERT_RESP_STATUS_UNEXPECTED = 0x01, OMADM_NI_ALERT_RESP_STATUS_INVALID = 0x02 }
enum	SWI_TYPE_OMADM_UI_ALERT_CONFIRM_DEFAULT { OMADM_UI_ALERT_CONFIRM_REJECT = 0x00, OMADM_UI_ALERT_CONFIRM_ACCEPT = 0x01, OMADM_UI_ALERT_CONFIRM_UNSPECIFIED = 0xFF }
enum	SWI_TYPE_OMADM_UI_ALERT_USER_CONFIRM { OMADM_UI_ALERT_USER_CONFIRM_USER = 0x00, OMADM_UI_ALERT_USER_CONFIRM_CANCEL = 0x01 }
enum	SWI_TYPE_OMADM_UI_ALERT_CONFIRM_RESP { OMADM_UI_CONFIRM_RESP_REJECT = 0x00, OMADM_UI_CONFIRM_RESP_CONFIRM = 0x01 }
enum	SWI_TYPE_OMADM_UI_ALERT_INPUT_TYPE {   OMADM_UI_ALERT_INPUT_TYPE_ALPHANUM = 0x00, OMADM_UI_ALERT_INPUT_TYPE_NUMERIC = 0x01, OMADM_UI_ALERT_INPUT_TYPE_DATE = 0x02, OMADM_UI_ALERT_INPUT_TYPE_TIME = 0x03,   OMADM_UI_ALERT_INPUT_TYPE_PHONENUM = 0x04, OMADM_UI_ALERT_INPUT_TYPE_IP = 0x05, OMADM_UI_ALERT_INPUT_TYPE_IPV6 = 0x06 }
enum	SWI_TYPE_OMADM_UI_ALERT_ECHO_TYPE { OMADM_UI_ALERT_ECHO_TYPE_TEXT = 0x00, OMADM_UI_ALERT_ECHO_TYPE_PASSWORD = 0x01 }
enum	SWI_TYPE_OMADM_UI_ALERT_CHOICE_TYPE { OMADM_UI_ALERT_CHOICE_SINGLE = 0x00, OMADM_UI_ALERT_CHOICE_MULTIPLE = 0x01 }
enum	SWI_TYPE_DM_DL_PROGRESS_TYPE { DM_DL_PROGRESS_TYPE_NO_PKG = 0x00, DM_DL_PROGRESS_TYPE_FOTA_PKG = 0x01, DM_DL_PROGRESS_TYPE_RESERVED = 0x02 }
enum	SWI_TYPE_DM_DL_VALID_RESP { DM_DL_VALID_RESP_REJECT = 0x01, DM_DL_VALID_RESP_CONFIRM = 0x02, DM_DL_VALID_RESP_DELAY = 0x04 }
enum	SWI_TYPE_DM_DL_ALERT_PROMPT { DM_DL_ALERT_PROMPT_DL_AND_INSTALL = 0x00, DM_DL_ALERT_PROMPT_INSTALL_ONLY = 0x01 }
enum	SWI_TYPE_DM_DL_ALERT_RESP { DM_DL_ALERT_RESP_REJECT = 0x00, DM_DL_ALERT_RESP_CONFIRM = 0x01, DM_DL_ALERT_RESP_DELAY = 0x02 }
enum	SWI_TYPE_DM_DL_ALERT_RESP_STATUS { DM_DL_ALERT_RESP_STATUS_SUCCESS = 0x00, DM_DL_ALERT_RESP_STATUS_FAILED_UNSPECIFIED = 0x01, DM_DL_ALERT_RESP_STATUS_FAILED_INVALID_RESPONSE = 0x02 }
enum	SWI_TYPE_DM_DL_INSTALL_STATE { DM_DL_INSTALL_STATE_NULL = 0x00, DM_DL_INSTALL_STATE_OFFLINE_INSTALL_STARTING = 0x01, DM_DL_INSTALL_STATE_OFFLINE_INSTALL_SUCCESS = 0x02, DM_DL_INSTALL_STATE_FAIL = 0xFF }
enum	SWI_TYPE_DM_TLV_TYPE {   DM_TLV_Account_Node_Name = 1, DM_TLV_Node_Path = 2, DM_TLV_Node_Format = 3, DM_TLV_Node_Type = 4,   DM_TLV_Node_Value = 5, DM_TLV_Node_Property = 6, DM_TLV_UI_Alert_Text = 7, DM_TLV_UI_Alert_Default_Response_Text = 8,   DM_TLV_Get_Node_Data = 101, DM_TLV_Set_Node_Data = 102, DM_TLV_Set_Node_Property = 103, DM_TLV_Add_Interior_Node = 104,   DM_TLV_UI_Alert_Text_Input = 105 }

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.

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

Macro Definition Documentation

#define LENGTH_DM_TLV_HEADER   4

DM TLV Header size in byte

#define MAX_DL_DESCRIPTION   1024

Max length of DL description

#define MAX_DL_PKG_NAME   232

Max length of DL name

#define NUM_Node_Data_Sub_TLV   4

Number of sub-TLV for Node data

Typedef Documentation

typedef struct SWI_STRUCT_DM_DL_ALERT SWI_STRUCT_DM_DL_ALERT

Contains DM-DL alert data structure.

typedef struct SWI_STRUCT_DM_DL_DESCRIPTION SWI_STRUCT_DM_DL_DESCRIPTION

Contains DM-DL description data structure.

typedef struct SWI_STRUCT_DM_DL_INSTALL_STATUS SWI_STRUCT_DM_DL_INSTALL_STATUS

Contains DM-DL description data structure.

typedef struct SWI_STRUCT_DM_DL_PROGRESS SWI_STRUCT_DM_DL_PROGRESS

Contains DM-DL progress data structure.

typedef struct SWI_STRUCT_OMADM_CANCEL_RESP SWI_STRUCT_OMADM_CANCEL_RESP

Contains OMA-DM session cancelation respond data.

typedef struct SWI_STRUCT_OMADM_GET_CONFIG SWI_STRUCT_OMADM_GET_CONFIG

Contains device OMA-DM configuration data.

typedef struct SWI_STRUCT_OMADM_NI_ALERT SWI_STRUCT_OMADM_NI_ALERT

Contains OMA-DM NI alert data structure.

typedef struct SWI_STRUCT_OMADM_NI_ALERT_RESP SWI_STRUCT_OMADM_NI_ALERT_RESP

Contains OMA-DM NI alert response data structure.

typedef struct SWI_STRUCT_OMADM_NODE_VALUE SWI_STRUCT_OMADM_NODE_VALUE

Contains OMA-DM node value data structure.

typedef struct SWI_STRUCT_OMADM_NODE_VALUE_REQUEST SWI_STRUCT_OMADM_NODE_VALUE_REQUEST

Contains OMA-DM node value request data structure.

typedef struct SWI_STRUCT_OMADM_NODE_VALUE_RESPONSE SWI_STRUCT_OMADM_NODE_VALUE_RESPONSE

Contains OMA-DM node value response data structure.

typedef struct SWI_STRUCT_OMADM_SESSION_STATE SWI_STRUCT_OMADM_SESSION_STATE

Contains OMA-DM session state data.

typedef struct SWI_STRUCT_OMADM_SET_CONFIG SWI_STRUCT_OMADM_SET_CONFIG

Contains data for setting OMA-DM configuration.

Note: Reset HFA requires MSL unlock.

typedef struct SWI_STRUCT_OMADM_START_SESSION SWI_STRUCT_OMADM_START_SESSION

Contains data for starting OMA-DM session.

typedef struct SWI_STRUCT_OMADM_UI_ALERT_CHOICE SWI_STRUCT_OMADM_UI_ALERT_CHOICE

Contains OMA-DM UI alert choice data structure.

typedef struct SWI_STRUCT_OMADM_UI_ALERT_CHOICE_RESP SWI_STRUCT_OMADM_UI_ALERT_CHOICE_RESP

Contains OMA-DM UI alert choice response data structure.

typedef struct SWI_STRUCT_OMADM_UI_ALERT_CONFIRM SWI_STRUCT_OMADM_UI_ALERT_CONFIRM

Contains OMA-DM UI alert confirm data structure.

typedef struct SWI_STRUCT_OMADM_UI_ALERT_CONFIRM_RESP SWI_STRUCT_OMADM_UI_ALERT_CONFIRM_RESP

Contains OMA-DM UI alert confirm data structure.

typedef struct SWI_STRUCT_OMADM_UI_ALERT_DISPLAY SWI_STRUCT_OMADM_UI_ALERT_DISPLAY

Contains OMA-DM UI alert display data structure.

typedef struct SWI_STRUCT_OMADM_UI_ALERT_INPUT SWI_STRUCT_OMADM_UI_ALERT_INPUT

Contains OMA-DM UI alert input data structure.

typedef struct SWI_STRUCT_OMADM_UI_ALERT_INPUT_RESP SWI_STRUCT_OMADM_UI_ALERT_INPUT_RESP

Contains OMA-DM UI alert input response data structure.

typedef enum SWI_TYPE_DM_DL_ALERT_PROMPT SWI_TYPE_DM_DL_ALERT_PROMPT

An enumeration of DM-DL alert prompt type.

typedef enum SWI_TYPE_DM_DL_ALERT_RESP SWI_TYPE_DM_DL_ALERT_RESP

An enumeration of DM-DL alert response type.

typedef enum SWI_TYPE_DM_DL_ALERT_RESP_STATUS SWI_TYPE_DM_DL_ALERT_RESP_STATUS

An enumeration of DM-DL alert response status.

typedef enum SWI_TYPE_DM_DL_INSTALL_STATE SWI_TYPE_DM_DL_INSTALL_STATE

An enumeration of DM-DL install state.

typedef enum SWI_TYPE_DM_DL_PROGRESS_TYPE SWI_TYPE_DM_DL_PROGRESS_TYPE

An enumeration of DM-DL progress type.

typedef enum SWI_TYPE_DM_DL_VALID_RESP SWI_TYPE_DM_DL_VALID_RESP

An enumeration of DM-DL valid response type.

typedef enum SWI_TYPE_DM_TLV_TYPE SWI_TYPE_DM_TLV_TYPE

An enumeration of CWE DM TLV types.

typedef enum SWI_TYPE_OMADM_CANCEL_STATUS SWI_TYPE_OMADM_CANCEL_STATUS

An enumeration of OMA-DM cancel status.

typedef enum SWI_TYPE_OMADM_DEVICE_CAPABILITY SWI_TYPE_OMADM_DEVICE_CAPABILITY

An enumeration of device OMA-DM capability.

typedef enum SWI_TYPE_OMADM_FEATURE_CAPABILITY SWI_TYPE_OMADM_FEATURE_CAPABILITY

An enumeration of device OMA-DM feature capability.

typedef enum SWI_TYPE_OMADM_NI_ALERT_RESP_STATUS SWI_TYPE_OMADM_NI_ALERT_RESP_STATUS

An enumeration of OMA-DM NI alert response status.

typedef enum SWI_TYPE_OMADM_NIA_PENDING SWI_TYPE_OMADM_NIA_PENDING

An enumeration of OMA-DM NIA pending state.

typedef enum SWI_TYPE_OMADM_NIA_SESSION_TYPE SWI_TYPE_OMADM_NIA_SESSION_TYPE

An enumeration of OMA-DM NI alert session type.

typedef enum SWI_TYPE_OMADM_NIA_UI_MODE SWI_TYPE_OMADM_NIA_UI_MODE

An enumeration of OMA-DM NIA UI mode.

typedef enum SWI_TYPE_OMADM_SESSION_COMMIT SWI_TYPE_OMADM_SESSION_COMMIT

An enumeration of OMA-DM session commit mask.

The commit results have specific meanings for each session type: CIDC/NIDC/HFA : DC not updated(0x00)/updated(0x01) CIPRL/NIPRL : PRL not updated(0x00)/updated(0x01) CIFUMO/NIFUMO Info Exchange : Pkg not available(0x00)/Pkg available(0x01) CI/NI DD Download/Package Download/Status Report: N/A

typedef enum SWI_TYPE_OMADM_SESSION_INITIATOR SWI_TYPE_OMADM_SESSION_INITIATOR

An enumeration of OMA-DM session initiator.

typedef enum SWI_TYPE_OMADM_SESSION_RESULT SWI_TYPE_OMADM_SESSION_RESULT

An enumeration of OMA-DM session results.

typedef enum SWI_TYPE_OMADM_SESSION_STATE SWI_TYPE_OMADM_SESSION_STATE

An enumeration of OMA-DM session state.

typedef enum SWI_TYPE_OMADM_SESSION_TYPE SWI_TYPE_OMADM_SESSION_TYPE

An enumeration of OMA-DM session type.

typedef enum SWI_TYPE_OMADM_SESSION_UI_MODE SWI_TYPE_OMADM_SESSION_UI_MODE

An enumeration of OMA-DM UI mode.

typedef enum SWI_TYPE_OMADM_STATUS_RESP SWI_TYPE_OMADM_STATUS_RESP

An enumeration of OMA-DM status response.

typedef enum SWI_TYPE_OMADM_UI_ALERT_CHOICE_TYPE SWI_TYPE_OMADM_UI_ALERT_CHOICE_TYPE

An enumeration of OMA-DM UI alert choice type.

typedef enum SWI_TYPE_OMADM_UI_ALERT_CONFIRM_DEFAULT SWI_TYPE_OMADM_UI_ALERT_CONFIRM_DEFAULT

An enumeration of OMA-DM UI alert confirm defaule value.

typedef enum SWI_TYPE_OMADM_UI_ALERT_CONFIRM_RESP SWI_TYPE_OMADM_UI_ALERT_CONFIRM_RESP

An enumeration of OMA-DM UI alert user confirm response value.

typedef enum SWI_TYPE_OMADM_UI_ALERT_ECHO_TYPE SWI_TYPE_OMADM_UI_ALERT_ECHO_TYPE

An enumeration of OMA-DM UI alert echo type.

typedef enum SWI_TYPE_OMADM_UI_ALERT_INPUT_TYPE SWI_TYPE_OMADM_UI_ALERT_INPUT_TYPE

An enumeration of OMA-DM UI alert input type.

typedef enum SWI_TYPE_OMADM_UI_ALERT_USER_CONFIRM SWI_TYPE_OMADM_UI_ALERT_USER_CONFIRM

An enumeration of OMA-DM UI alert user confirm type.

typedef enum SWI_TYPE_OMADM_USER_CI_SESSION_TYPE SWI_TYPE_OMADM_USER_CI_SESSION_TYPE

An enumeration of OMA-DM client initiated session type.

Enumeration Type Documentation

enum SWI_TYPE_DM_DL_ALERT_PROMPT

An enumeration of DM-DL alert prompt type.

Enumerator
DM_DL_ALERT_PROMPT_DL_AND_INSTALL	Dowload and install
DM_DL_ALERT_PROMPT_INSTALL_ONLY	Install only. Dowload has already completed

enum SWI_TYPE_DM_DL_ALERT_RESP

An enumeration of DM-DL alert response type.

Enumerator
DM_DL_ALERT_RESP_REJECT	Reject
DM_DL_ALERT_RESP_CONFIRM	Confirm
DM_DL_ALERT_RESP_DELAY	Delay

enum SWI_TYPE_DM_DL_ALERT_RESP_STATUS

An enumeration of DM-DL alert response status.

Enumerator
DM_DL_ALERT_RESP_STATUS_SUCCESS	Success
DM_DL_ALERT_RESP_STATUS_FAILED_UNSPECIFIED	Unspecified
DM_DL_ALERT_RESP_STATUS_FAILED_INVALID_RESPONSE	Modem does not expect the response sent by Host

enum SWI_TYPE_DM_DL_INSTALL_STATE

An enumeration of DM-DL install state.

Enumerator
DM_DL_INSTALL_STATE_NULL	Unknown
DM_DL_INSTALL_STATE_OFFLINE_INSTALL_STARTING	Starting
DM_DL_INSTALL_STATE_OFFLINE_INSTALL_SUCCESS	Success
DM_DL_INSTALL_STATE_FAIL	Failed. DM Status code contains Error Number.

enum SWI_TYPE_DM_DL_PROGRESS_TYPE

An enumeration of DM-DL progress type.

Enumerator
DM_DL_PROGRESS_TYPE_NO_PKG	No package
DM_DL_PROGRESS_TYPE_FOTA_PKG	FOTA package
DM_DL_PROGRESS_TYPE_RESERVED	Reserved

enum SWI_TYPE_DM_DL_VALID_RESP

An enumeration of DM-DL valid response type.

Enumerator
DM_DL_VALID_RESP_REJECT	Reject
DM_DL_VALID_RESP_CONFIRM	Confirm
DM_DL_VALID_RESP_DELAY	Delay. May not be valid for some carriers (ie. Sprint for now).

enum SWI_TYPE_DM_TLV_TYPE

An enumeration of CWE DM TLV types.

Enumerator
DM_TLV_Account_Node_Name	account node name
DM_TLV_Node_Path	node path
DM_TLV_Node_Format	node format
DM_TLV_Node_Type	node type
DM_TLV_Node_Value	node value
DM_TLV_Node_Property	node property
DM_TLV_UI_Alert_Text	UI alert text
DM_TLV_UI_Alert_Default_Response_Text	UI alert default response text
DM_TLV_Get_Node_Data	get node data
DM_TLV_Set_Node_Data	set node data
DM_TLV_Set_Node_Property	set node property
DM_TLV_Add_Interior_Node	add interior node
DM_TLV_UI_Alert_Text_Input	UI alert text input

enum SWI_TYPE_OMADM_CANCEL_STATUS

An enumeration of OMA-DM cancel status.

Enumerator
OMADM_CANCEL_SUCCESS	Succeess
OMADM_CANCEL_NO_SESSION	No active session

enum SWI_TYPE_OMADM_DEVICE_CAPABILITY

An enumeration of device OMA-DM capability.

Enumerator
OMADM_DEVICE_CAPABILITY_NONE	OMA-DM is not supported
OMADM_DEVICE_CAPABILITY_SWI	OMA-DM is supported via Sierra Wireless
OMADM_DEVICE_CAPABILITY_REDBEND	OMA-DM is supported via Red Bend

enum SWI_TYPE_OMADM_FEATURE_CAPABILITY

An enumeration of device OMA-DM feature capability.

Enumerator
OMADM_FEATURE_CIDC	Client initiated device config
OMADM_FEATURE_NIDC	Network initiated device config
OMADM_FEATURE_CIPRL	Client initiated PRL update
OMADM_FEATURE_NIPRL	Network initiated PRL update
OMADM_FEATURE_CIFUMO	Client initiated Firmware Update (FUMO)
OMADM_FEATURE_NIFUMO	Network initiated Firmware Update (FUMO)
OMADM_FEATURE_HFA	hands free activation (HFA)

enum SWI_TYPE_OMADM_NI_ALERT_RESP_STATUS

An enumeration of OMA-DM NI alert response status.

Enumerator
OMADM_NI_ALERT_RESP_STATUS_ACCEPTED	Accepted
OMADM_NI_ALERT_RESP_STATUS_UNEXPECTED	Unexpected
OMADM_NI_ALERT_RESP_STATUS_INVALID	Invalid

enum SWI_TYPE_OMADM_NIA_PENDING

An enumeration of OMA-DM NIA pending state.

Enumerator
OMADM_NIA_STATE_PENDING_NONE	No pending
OMADM_NIA_STATE_PENDING_BLOCKED	Pending blocked
OMADM_NIA_STATE_PENDING_READY	Pending ready

enum SWI_TYPE_OMADM_NIA_SESSION_TYPE

An enumeration of OMA-DM NI alert session type.

Enumerator
OMADM_NIA_SESSION_TYPE_UNKNOWN	Unknown
OMADM_NIA_SESSION_TYPE_DEVICE_CONFIG	Device Configuration
OMADM_NIA_SESSION_TYPE_CDMA_PRL_UPDATE	CDMA PRL Update
OMADM_NIA_SESSION_TYPE_FUMO	FUMO

enum SWI_TYPE_OMADM_NIA_UI_MODE

An enumeration of OMA-DM NIA UI mode.

Enumerator
OMADM_NIA_UI_MODE_UNKNOWN	Unknown
OMADM_NIA_UI_MODE_BACKGROUND	Background
OMADM_NIA_UI_MODE_INFORMATIVE	Informative
OMADM_NIA_UI_MODE_INTERACTIVE	Interactive
OMADM_NIA_UI_MODE_DORMANT_INTERRUPT	Interrupt

enum SWI_TYPE_OMADM_SESSION_COMMIT

An enumeration of OMA-DM session commit mask.

The commit results have specific meanings for each session type: CIDC/NIDC/HFA : DC not updated(0x00)/updated(0x01) CIPRL/NIPRL : PRL not updated(0x00)/updated(0x01) CIFUMO/NIFUMO Info Exchange : Pkg not available(0x00)/Pkg available(0x01) CI/NI DD Download/Package Download/Status Report: N/A

Enumerator
OMADM_SESSION_COMMIT_DATA_NOT_UPDATED	Updated
OMADM_SESSION_COMMIT_DATA_UPDATED	Not updated

enum SWI_TYPE_OMADM_SESSION_INITIATOR

An enumeration of OMA-DM session initiator.

Enumerator
OMADM_SESSION_INITIATOR_UNKNOWN	Unknown
OMADM_SESSION_INITIATOR_USER_CLIENT	User client initiated
OMADM_SESSION_INITIATOR_DEVICE_CLIENT	Device client initiated
OMADM_SESSION_INITIATOR_NETWORK	Network initiated

enum SWI_TYPE_OMADM_SESSION_RESULT

An enumeration of OMA-DM session results.

Enumerator
OMADM_SESSION_RESULT_SUCCESS	Success
OMADM_SESSION_RESULT_FAIL	Fail
OMADM_SESSION_RESULT_NO_COMMANDS_RECEIVED	No command recieved
OMADM_SESSION_RESULT_ABORT_CLIENT_USER	User abort
OMADM_SESSION_RESULT_ABORT_CLIENT_DEVICE	Device abort
OMADM_SESSION_RESULT_ABORT_SERVER	Server abort
OMADM_SESSION_RESULT_MEMORY_ERROR	Memory error
OMADM_SESSION_RESULT_HEAP_TOO_SMALL	Heap too small
OMADM_SESSION_RESULT_BUFFER_TOO_SMALL	Buffer too small
OMADM_SESSION_RESULT_ROUTINE_NOT_ALLOWED	Routine not allowed
OMADM_SESSION_RESULT_ROUTINE_WHEN_SUSPEND	Routine suspend
OMADM_SESSION_RESULT_BAD_INPUT_PARAM	Bad input parameter
OMADM_SESSION_RESULT_INVALID_PROTOCOL	Invalid protocol
OMADM_SESSION_RESULT_AUTH_FAILURE	Authentication failure
OMADM_SESSION_RESULT_MISSING_START_MSG	Missing start message
OMADM_SESSION_RESULT_MISSING_END_MSG	Missing ending message
OMADM_SESSION_RESULT_FEATURE_NOT_AVAIL	Feature not available
OMADM_SESSION_RESULT_UIA_PARSE_ERROR	UIA parse error
OMADM_SESSION_RESULT_DATA_TOO_BIG_TO_RTN	Data too big to RTN
OMADM_SESSION_RESULT_UNSUPPORTED_PROTOCOL	Unsupported protocol
OMADM_SESSION_RESULT_MIME_TYPE_MISMATCH	MIME type mismatch
OMADM_SESSION_RESULT_NTWK_FAIL_TO_OPEN	NTWK faile to open
OMADM_SESSION_RESULT_SSL_FAIL_TO_OPEN	SSL faile to open
OMADM_SESSION_RESULT_FATAL_NTWK_ERROR	Fatal network error
OMADM_SESSION_RESULT_TREE_NODE_EXISTS	Tree node exists
OMADM_SESSION_RESULT_TREE_NODE_MISSING	Tree node missing
OMADM_SESSION_RESULT_LEAF_NODE_OP_ERROR	Leaf node operation error
OMADM_SESSION_RESULT_INVALID_NODE_TYPE	Invalid node type
OMADM_SESSION_RESULT_UNKNOWN_PROPERTY	Unknown property
OMADM_SESSION_RESULT_DELETE_PERM_NODE	Delete perm node
OMADM_SESSION_RESULT_ACCESS_TYPE_INVALID	Access type invalid
OMADM_SESSION_RESULT_BAD_NAME_FOR_TREE	Bad name for tree
OMADM_SESSION_RESULT_PARTIAL_WRITE_EXT_DATA	Partial write ext data
OMADM_SESSION_RESULT_EXT_WRITE_TEMP_BLOCKED	Wxt write temp blocked
OMADM_SESSION_RESULT_VALUE_NOT_WRITABLE	Value not writable
OMADM_SESSION_RESULT_VALUE_NOT_READABLE	Value not readable
OMADM_SESSION_RESULT_CANNOT_EXECUTE_NODE	Cannot execute node
OMADM_SESSION_RESULT_TREE_OPEN_ERROR	Tree open error
OMADM_SESSION_RESULT_TREE_COMMIT_ERROR	Tree commit error
OMADM_SESSION_RESULT_BOOTSTRAP_RSVD	Bootstrap reserved
OMADM_SESSION_RESULT_FUMO_RSVD	FUMO reserved

enum SWI_TYPE_OMADM_SESSION_STATE

An enumeration of OMA-DM session state.

Enumerator
OMADM_SESSION_STATE_IDLE	No OMA-DM session
OMADM_SESSION_STATE_ACTIVE	Active OMA-DM session exists
OMADM_SESSION_STATE_HFA_PENDING	HFA pending

enum SWI_TYPE_OMADM_SESSION_TYPE

An enumeration of OMA-DM session type.

Enumerator
OMADM_SESSION_TYPE_UNKNOWN	Unknown
OMADM_SESSION_TYPE_DEVICE_CONFIG	Device config
OMADM_SESSION_TYPE_CDMA_PRL_UPDATE	PRL update
OMADM_SESSION_TYPE_FUMO_INFO_EXCHANGE	FUMO Information Exchanged
OMADM_SESSION_TYPE_HFA	Hand free actiovation
OMADM_SESSION_TYPE_DD_DOWNLOAD	Download Descriptor Download
OMADM_SESSION_TYPE_PKG_DOWNLOAD	FUMO Package Download
OMADM_SESSION_TYPE_STATUS_REPORT	Status update to OMADM Server

enum SWI_TYPE_OMADM_SESSION_UI_MODE

An enumeration of OMA-DM UI mode.

Enumerator
OMADM_SESSION_UI_MODE_UNKNOWN	Unknown
OMADM_SESSION_UI_MODE_HIDDEN	Hidden
OMADM_SESSION_UI_MODE_UNHIDDEN	Unhidden

enum SWI_TYPE_OMADM_STATUS_RESP

An enumeration of OMA-DM status response.

Enumerator
OMADM_STATUS_RESP_SUCCESS	Success
OMADM_STATUS_RESP_FAIL	Fail
OMADM_STATUS_RESP_UNSUPPORTED	Unsupported
OMADM_STATUS_RESP_BAD_PARAM	Bad parameter
OMADM_STATUS_RESP_INVALID_OPTION	Invalid option
OMADM_STATUS_RESP_SECURITY_ACCESS_DENIED	Security access denied
OMADM_STATUS_RESP_INVALID_DEVICE_STATE	Invalid service state
OMADM_STATUS_RESP_INVALID_SESSION_STATE	Invalid session state
OMADM_STATUS_RESP_UNSUPPORTED_NODE	Unsupported node
OMADM_STATUS_RESP_NODE_ALREADY_EXISTS	Node alrady exists
OMADM_STATUS_RESP_MAX_URI_EXCEEDED	Exceed URI length limit

enum SWI_TYPE_OMADM_UI_ALERT_CHOICE_TYPE

An enumeration of OMA-DM UI alert choice type.

Enumerator
OMADM_UI_ALERT_CHOICE_SINGLE	User can only select a single choice
OMADM_UI_ALERT_CHOICE_MULTIPLE	User allowed multiple selections

enum SWI_TYPE_OMADM_UI_ALERT_CONFIRM_DEFAULT

An enumeration of OMA-DM UI alert confirm defaule value.

Enumerator
OMADM_UI_ALERT_CONFIRM_REJECT	Reject
OMADM_UI_ALERT_CONFIRM_ACCEPT	Accept
OMADM_UI_ALERT_CONFIRM_UNSPECIFIED	Unspecified

enum SWI_TYPE_OMADM_UI_ALERT_CONFIRM_RESP

An enumeration of OMA-DM UI alert user confirm response value.

Enumerator
OMADM_UI_CONFIRM_RESP_REJECT	Response is rejected
OMADM_UI_CONFIRM_RESP_CONFIRM	Response is confirmed

enum SWI_TYPE_OMADM_UI_ALERT_ECHO_TYPE

An enumeration of OMA-DM UI alert echo type.

Enumerator
OMADM_UI_ALERT_ECHO_TYPE_TEXT	Text input (default)
OMADM_UI_ALERT_ECHO_TYPE_PASSWORD	Password input (hide/mask user input text)

enum SWI_TYPE_OMADM_UI_ALERT_INPUT_TYPE

An enumeration of OMA-DM UI alert input type.

Enumerator
OMADM_UI_ALERT_INPUT_TYPE_ALPHANUM	Alpha-numeric input
OMADM_UI_ALERT_INPUT_TYPE_NUMERIC	Numeric
OMADM_UI_ALERT_INPUT_TYPE_DATE	"DDMMYYYY"
OMADM_UI_ALERT_INPUT_TYPE_TIME	"hhmmss"
OMADM_UI_ALERT_INPUT_TYPE_PHONENUM	Phone number input (All numeric characters, "+","p","w" and "s". "+" must be first if present in phone number)
OMADM_UI_ALERT_INPUT_TYPE_IP	IP address input www.xxx.yyy.zzz
OMADM_UI_ALERT_INPUT_TYPE_IPV6	IPV6 input

enum SWI_TYPE_OMADM_UI_ALERT_USER_CONFIRM

An enumeration of OMA-DM UI alert user confirm type.

Enumerator
OMADM_UI_ALERT_USER_CONFIRM_USER	Confirmed by user
OMADM_UI_ALERT_USER_CONFIRM_CANCEL	Canceled by user

enum SWI_TYPE_OMADM_USER_CI_SESSION_TYPE

An enumeration of OMA-DM client initiated session type.

Enumerator
OMADM_USER_CI_SESSION_TYPE_UNKNOWN	Unknown
OMADM_USER_CI_SESSION_TYPE_DEVICE_CONFIG	Device Configuration
OMADM_USER_CI_SESSION_TYPE_CDMA_PRL_UPDATE	CDMA PRL Update
OMADM_USER_CI_SESSION_TYPE_FUMO	FUMO

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