LinuxSDK  V1.4.0.5
SwiApiCmDm.h
Go to the documentation of this file.
1 
14 #ifndef __SWIAPICMDM_H__
15 #define __SWIAPICMDM_H__
16 
17 #ifdef __cplusplus
18 extern "C" {
19 #endif
20 
21 /* include files */
22 #include "SwiDataTypes.h"
23 #include "SwiRcodes.h"
24 
25 
26 
27 #define MAX_DL_PKG_NAME 232
28 #define MAX_DL_DESCRIPTION 1024
30 /* OMA-DM Types and Structures */
31 
37 typedef enum SWI_TYPE_OMADM_DEVICE_CAPABILITY
38 {
39  OMADM_DEVICE_CAPABILITY_NONE = 0x00,
42  OMADM_DEVICE_CAPABILITY_SWI = 0x01,
43 
45  OMADM_DEVICE_CAPABILITY_REDBEND = 0x02
46 }SWI_TYPE_OMADM_DEVICE_CAPABILITY;
47 
53 typedef enum SWI_TYPE_OMADM_FEATURE_CAPABILITY
54 {
55  OMADM_FEATURE_CIDC = 0x00000001,
56  OMADM_FEATURE_NIDC = 0x00000002,
57  OMADM_FEATURE_CIPRL = 0x00000004,
58  OMADM_FEATURE_NIPRL = 0x00000008,
61  OMADM_FEATURE_CIFUMO = 0x00000010,
62 
64  OMADM_FEATURE_NIFUMO = 0x00000020,
65 
66  OMADM_FEATURE_HFA = 0x00000040
67 }SWI_TYPE_OMADM_FEATURE_CAPABILITY;
68 
74 typedef struct SWI_STRUCT_OMADM_GET_CONFIG
75 {
76  swi_uint32 sizeStruct;
79  SWI_TYPE_OMADM_DEVICE_CAPABILITY nOMADMCapability;
80 
82  swi_uint8 nMaxAcctSupport;
83 
85  swi_uint8 nNumAccts;
86 
88  swi_uint8 bAcctChanged;
89 
91  swi_uint32 dwFeatureCapabilityMask;
92 
94  swi_uint32 dwFeatureEnableMask;
95 
97  swi_uint8 bHFAAttempted;
98 }SWI_STRUCT_OMADM_GET_CONFIG;
99 
105 typedef enum SWI_TYPE_OMADM_STATUS_RESP
106 {
107  OMADM_STATUS_RESP_SUCCESS = 0x00,
108  OMADM_STATUS_RESP_FAIL = 0x01,
109  OMADM_STATUS_RESP_UNSUPPORTED = 0x02,
110  OMADM_STATUS_RESP_BAD_PARAM = 0x03,
111  OMADM_STATUS_RESP_INVALID_OPTION = 0x04,
114  OMADM_STATUS_RESP_SECURITY_ACCESS_DENIED = 0x05,
115 
117  OMADM_STATUS_RESP_INVALID_DEVICE_STATE = 0x06,
118 
120  OMADM_STATUS_RESP_INVALID_SESSION_STATE = 0x07,
121 
123  OMADM_STATUS_RESP_UNSUPPORTED_NODE = 0x08,
124 
126  OMADM_STATUS_RESP_NODE_ALREADY_EXISTS = 0x09,
127 
129  OMADM_STATUS_RESP_MAX_URI_EXCEEDED = 0x0A
130 }SWI_TYPE_OMADM_STATUS_RESP;
131 
139 typedef struct SWI_STRUCT_OMADM_SET_CONFIG
140 {
141  swi_uint32 sizeStruct;
144  swi_uint32 dwFeatureCapabilityMask;
145 
147  swi_uint32 dwFeatureEnableMask;
148 
150  swi_uint8 bResetHFA;
151 }SWI_STRUCT_OMADM_SET_CONFIG;
152 
158 typedef enum SWI_TYPE_OMADM_SESSION_TYPE
159 {
160  OMADM_SESSION_TYPE_UNKNOWN = 0x00,
161  OMADM_SESSION_TYPE_DEVICE_CONFIG = 0x01,
162  OMADM_SESSION_TYPE_CDMA_PRL_UPDATE = 0x02,
165  OMADM_SESSION_TYPE_FUMO_INFO_EXCHANGE = 0x03,
166 
168  OMADM_SESSION_TYPE_HFA = 0x04,
169 
171  OMADM_SESSION_TYPE_DD_DOWNLOAD = 0x05,
172 
174  OMADM_SESSION_TYPE_PKG_DOWNLOAD = 0x06,
175 
177  OMADM_SESSION_TYPE_STATUS_REPORT = 0x07
178 }SWI_TYPE_OMADM_SESSION_TYPE;
179 
185 typedef enum SWI_TYPE_OMADM_USER_CI_SESSION_TYPE
186 {
187  OMADM_USER_CI_SESSION_TYPE_UNKNOWN = 0x00,
190  OMADM_USER_CI_SESSION_TYPE_DEVICE_CONFIG = 0x01,
191 
192  OMADM_USER_CI_SESSION_TYPE_CDMA_PRL_UPDATE = 0x02,
193  OMADM_USER_CI_SESSION_TYPE_FUMO = 0x03
194 }SWI_TYPE_OMADM_USER_CI_SESSION_TYPE;
195 
201 typedef struct SWI_STRUCT_OMADM_START_SESSION
202 {
203  swi_uint32 sizeStruct;
206  SWI_TYPE_OMADM_USER_CI_SESSION_TYPE nType;
207 
209  swi_uint16 nAcctNameLen;
210 
212  swi_uint8* psAcctName;
213 }SWI_STRUCT_OMADM_START_SESSION;
214 
220 typedef enum SWI_TYPE_OMADM_CANCEL_STATUS
221 {
222  OMADM_CANCEL_SUCCESS = 0x00,
223  OMADM_CANCEL_NO_SESSION = 0x01
224 }SWI_TYPE_OMADM_CANCEL_STATUS;
225 
231 typedef struct SWI_STRUCT_OMADM_CANCEL_RESP
232 {
233  swi_uint32 sizeStruct;
234  SWI_TYPE_OMADM_CANCEL_STATUS nStatus;
235  swi_uint8 bQueuedForReattempt;
236 }SWI_STRUCT_OMADM_CANCEL_RESP;
237 
243 typedef enum SWI_TYPE_OMADM_SESSION_STATE
244 {
245  OMADM_SESSION_STATE_IDLE = 0x00,
248  OMADM_SESSION_STATE_ACTIVE = 0x01,
249 
250  OMADM_SESSION_STATE_HFA_PENDING = 0x02
251 }SWI_TYPE_OMADM_SESSION_STATE;
252 
258 typedef enum SWI_TYPE_OMADM_SESSION_INITIATOR
259 {
260  OMADM_SESSION_INITIATOR_UNKNOWN = 0x00,
263  OMADM_SESSION_INITIATOR_USER_CLIENT = 0x01,
264 
266  OMADM_SESSION_INITIATOR_DEVICE_CLIENT = 0x02,
267 
268  OMADM_SESSION_INITIATOR_NETWORK = 0x03
269 }SWI_TYPE_OMADM_SESSION_INITIATOR;
270 
276 typedef enum SWI_TYPE_OMADM_SESSION_UI_MODE
277 {
278  OMADM_SESSION_UI_MODE_UNKNOWN = 0x00,
279  OMADM_SESSION_UI_MODE_HIDDEN = 0x01,
280  OMADM_SESSION_UI_MODE_UNHIDDEN = 0x02
281 }SWI_TYPE_OMADM_SESSION_UI_MODE;
282 
288 typedef enum SWI_TYPE_OMADM_SESSION_RESULT
289 {
290  OMADM_SESSION_RESULT_SUCCESS = 0x0000,
291  OMADM_SESSION_RESULT_FAIL = 0x0001,
294  OMADM_SESSION_RESULT_NO_COMMANDS_RECEIVED = 0x0002,
295 
296  OMADM_SESSION_RESULT_ABORT_CLIENT_USER = 0x0100,
299  OMADM_SESSION_RESULT_ABORT_CLIENT_DEVICE = 0x0101,
300 
302  OMADM_SESSION_RESULT_ABORT_SERVER = 0x0102,
303 
305  OMADM_SESSION_RESULT_MEMORY_ERROR = 0x0200,
306 
308  OMADM_SESSION_RESULT_HEAP_TOO_SMALL = 0x0201,
309 
311  OMADM_SESSION_RESULT_BUFFER_TOO_SMALL = 0x0202,
312 
314  OMADM_SESSION_RESULT_ROUTINE_NOT_ALLOWED = 0x0300,
315 
317  OMADM_SESSION_RESULT_ROUTINE_WHEN_SUSPEND = 0x0301,
318 
320  OMADM_SESSION_RESULT_BAD_INPUT_PARAM = 0x0302,
321 
323  OMADM_SESSION_RESULT_INVALID_PROTOCOL = 0x0400,
324 
326  OMADM_SESSION_RESULT_AUTH_FAILURE = 0x0401,
327 
329  OMADM_SESSION_RESULT_MISSING_START_MSG = 0x0402,
330 
332  OMADM_SESSION_RESULT_MISSING_END_MSG = 0x0403,
333 
335  OMADM_SESSION_RESULT_FEATURE_NOT_AVAIL = 0x0404,
336 
338  OMADM_SESSION_RESULT_UIA_PARSE_ERROR = 0x0405,
339 
341  OMADM_SESSION_RESULT_DATA_TOO_BIG_TO_RTN = 0x0406,
342 
344  OMADM_SESSION_RESULT_UNSUPPORTED_PROTOCOL = 0x0500,
345 
347  OMADM_SESSION_RESULT_MIME_TYPE_MISMATCH = 0x0501,
348 
350  OMADM_SESSION_RESULT_NTWK_FAIL_TO_OPEN = 0x0502,
351 
353  OMADM_SESSION_RESULT_SSL_FAIL_TO_OPEN = 0x0503,
354 
356  OMADM_SESSION_RESULT_FATAL_NTWK_ERROR = 0x0504,
357 
359  OMADM_SESSION_RESULT_TREE_NODE_EXISTS = 0x1000,
360 
362  OMADM_SESSION_RESULT_TREE_NODE_MISSING = 0x1001,
363 
365  OMADM_SESSION_RESULT_LEAF_NODE_OP_ERROR = 0x1002,
366 
368  OMADM_SESSION_RESULT_INVALID_NODE_TYPE = 0x1003,
369 
371  OMADM_SESSION_RESULT_UNKNOWN_PROPERTY = 0x1004,
372 
374  OMADM_SESSION_RESULT_DELETE_PERM_NODE = 0x1005,
375 
377  OMADM_SESSION_RESULT_ACCESS_TYPE_INVALID = 0x1006,
378 
380  OMADM_SESSION_RESULT_BAD_NAME_FOR_TREE = 0x1007,
381 
383  OMADM_SESSION_RESULT_PARTIAL_WRITE_EXT_DATA = 0x1008,
384 
386  OMADM_SESSION_RESULT_EXT_WRITE_TEMP_BLOCKED = 0x1009,
387 
389  OMADM_SESSION_RESULT_VALUE_NOT_WRITABLE = 0x100A,
390 
392  OMADM_SESSION_RESULT_VALUE_NOT_READABLE = 0x100B,
393 
395  OMADM_SESSION_RESULT_CANNOT_EXECUTE_NODE = 0x100C,
396 
398  OMADM_SESSION_RESULT_TREE_OPEN_ERROR = 0x100D,
399 
401  OMADM_SESSION_RESULT_TREE_COMMIT_ERROR = 0x100E,
402 
404  OMADM_SESSION_RESULT_BOOTSTRAP_RSVD = 0x2000,
405 
407  OMADM_SESSION_RESULT_FUMO_RSVD = 0x3000
408 }SWI_TYPE_OMADM_SESSION_RESULT;
409 
421 typedef enum SWI_TYPE_OMADM_SESSION_COMMIT
422 {
423  OMADM_SESSION_COMMIT_DATA_NOT_UPDATED = 0x00,
424  OMADM_SESSION_COMMIT_DATA_UPDATED = 0x01
425 }SWI_TYPE_OMADM_SESSION_COMMIT;
426 
433 typedef struct SWI_STRUCT_OMADM_SESSION_STATE
434 {
435  swi_uint32 sizeStruct;
436  SWI_TYPE_OMADM_SESSION_STATE nState;
437  swi_uint16 nHFARetryTime;
438  SWI_TYPE_OMADM_SESSION_TYPE nLastSessionType;
441  SWI_TYPE_OMADM_SESSION_INITIATOR nLastSessionInitiator;
442 
443  SWI_TYPE_OMADM_SESSION_UI_MODE nUIMode;
446  SWI_TYPE_OMADM_SESSION_RESULT nLastSessionResult;
447 
449  SWI_TYPE_OMADM_SESSION_COMMIT nLastSessionCommit;
450 }SWI_STRUCT_OMADM_SESSION_STATE;
451 
457  typedef enum SWI_TYPE_OMADM_NIA_PENDING
458 {
459  OMADM_NIA_STATE_PENDING_NONE = 0x00,
460  OMADM_NIA_STATE_PENDING_BLOCKED = 0x01,
461  OMADM_NIA_STATE_PENDING_READY = 0x02
462 }SWI_TYPE_OMADM_NIA_PENDING;
463 
469 typedef enum SWI_TYPE_OMADM_NIA_UI_MODE
470 {
471  OMADM_NIA_UI_MODE_UNKNOWN = 0x00,
472  OMADM_NIA_UI_MODE_BACKGROUND = 0x01,
473  OMADM_NIA_UI_MODE_INFORMATIVE = 0x02,
474  OMADM_NIA_UI_MODE_INTERACTIVE = 0x03,
475  OMADM_NIA_UI_MODE_DORMANT_INTERRUPT = 0x04
476 }SWI_TYPE_OMADM_NIA_UI_MODE;
477 
483 typedef enum SWI_TYPE_OMADM_NIA_SESSION_TYPE
484 {
485  OMADM_NIA_SESSION_TYPE_UNKNOWN = 0x00,
486  OMADM_NIA_SESSION_TYPE_DEVICE_CONFIG = 0x01,
487  OMADM_NIA_SESSION_TYPE_CDMA_PRL_UPDATE = 0x02,
488  OMADM_NIA_SESSION_TYPE_FUMO = 0x03
489 }SWI_TYPE_OMADM_NIA_SESSION_TYPE;
490 
496 typedef struct SWI_STRUCT_OMADM_NI_ALERT
497 {
498  swi_uint32 sizeStruct;
499  SWI_TYPE_OMADM_NIA_PENDING nPending;
500  SWI_TYPE_OMADM_NIA_UI_MODE nUIMode;
501  SWI_TYPE_OMADM_NIA_UI_MODE nForceUIMode;
502  SWI_TYPE_OMADM_NIA_SESSION_TYPE nType;
503 }SWI_STRUCT_OMADM_NI_ALERT;
504 
510 typedef enum SWI_TYPE_OMADM_NI_ALERT_RESP_STATUS
511 {
512  OMADM_NI_ALERT_RESP_STATUS_ACCEPTED = 0x00,
513  OMADM_NI_ALERT_RESP_STATUS_UNEXPECTED = 0x01,
514  OMADM_NI_ALERT_RESP_STATUS_INVALID = 0x02
515 }SWI_TYPE_OMADM_NI_ALERT_RESP_STATUS;
516 
522 typedef struct SWI_STRUCT_OMADM_NI_ALERT_RESP
523 {
524  swi_uint32 sizeStruct;
525  SWI_TYPE_OMADM_NI_ALERT_RESP_STATUS nStatus;
528  swi_uint8 bQueuedForReattempt;
529 }SWI_STRUCT_OMADM_NI_ALERT_RESP;
530 
536 typedef struct SWI_STRUCT_OMADM_UI_ALERT_DISPLAY
537 {
538  swi_uint32 sizeStruct;
541  swi_uint16 nMinDisplayTime;
542 
544  swi_uint16 nMaxDisplayTime;
545 
547  swi_uint16 nTextLength;
548 
550  swi_uint8* psText;
551 }SWI_STRUCT_OMADM_UI_ALERT_DISPLAY;
552 
558 typedef enum SWI_TYPE_OMADM_UI_ALERT_CONFIRM_DEFAULT
559 {
560  OMADM_UI_ALERT_CONFIRM_REJECT = 0x00,
561  OMADM_UI_ALERT_CONFIRM_ACCEPT = 0x01,
562  OMADM_UI_ALERT_CONFIRM_UNSPECIFIED = 0xFF
563 }SWI_TYPE_OMADM_UI_ALERT_CONFIRM_DEFAULT;
564 
570 typedef struct SWI_STRUCT_OMADM_UI_ALERT_CONFIRM
571 {
572  swi_uint32 sizeStruct;
575  swi_uint16 nMinDisplayTime;
576 
578  swi_uint16 nMaxDisplayTime;
579 
581  SWI_TYPE_OMADM_UI_ALERT_CONFIRM_DEFAULT nDefResp;
582 
583  swi_uint16 nTextLength;
586  swi_uint8* psText;
587 }SWI_STRUCT_OMADM_UI_ALERT_CONFIRM;
588 
594 typedef enum SWI_TYPE_OMADM_UI_ALERT_USER_CONFIRM
595 {
596  OMADM_UI_ALERT_USER_CONFIRM_USER = 0x00,
597  OMADM_UI_ALERT_USER_CONFIRM_CANCEL = 0x01
598 }SWI_TYPE_OMADM_UI_ALERT_USER_CONFIRM;
599 
605 typedef enum SWI_TYPE_OMADM_UI_ALERT_CONFIRM_RESP
606 {
607  OMADM_UI_CONFIRM_RESP_REJECT = 0x00,
608  OMADM_UI_CONFIRM_RESP_CONFIRM = 0x01
609 }SWI_TYPE_OMADM_UI_ALERT_CONFIRM_RESP;
610 
616 typedef struct SWI_STRUCT_OMADM_UI_ALERT_CONFIRM_RESP
617 {
618  swi_uint32 sizeStruct;
620  SWI_TYPE_OMADM_UI_ALERT_USER_CONFIRM nUserAction;
624  SWI_TYPE_OMADM_UI_ALERT_CONFIRM_RESP nResp;
625 }SWI_STRUCT_OMADM_UI_ALERT_CONFIRM_RESP;
626 
632 typedef enum SWI_TYPE_OMADM_UI_ALERT_INPUT_TYPE
633 {
634  OMADM_UI_ALERT_INPUT_TYPE_ALPHANUM = 0x00,
635  OMADM_UI_ALERT_INPUT_TYPE_NUMERIC = 0x01,
636  OMADM_UI_ALERT_INPUT_TYPE_DATE = 0x02,
637  OMADM_UI_ALERT_INPUT_TYPE_TIME = 0x03,
641  OMADM_UI_ALERT_INPUT_TYPE_PHONENUM = 0x04,
642 
644  OMADM_UI_ALERT_INPUT_TYPE_IP = 0x05,
645 
646  OMADM_UI_ALERT_INPUT_TYPE_IPV6 = 0x06
647 }SWI_TYPE_OMADM_UI_ALERT_INPUT_TYPE;
648 
654 typedef enum SWI_TYPE_OMADM_UI_ALERT_ECHO_TYPE
655 {
656  OMADM_UI_ALERT_ECHO_TYPE_TEXT = 0x00,
659  OMADM_UI_ALERT_ECHO_TYPE_PASSWORD = 0x01
660 }SWI_TYPE_OMADM_UI_ALERT_ECHO_TYPE;
661 
667 typedef struct SWI_STRUCT_OMADM_UI_ALERT_INPUT
668 {
669  swi_uint32 sizeStruct;
672  swi_uint16 nMinDisplayTime;
673 
675  swi_uint16 nMaxDisplayTime;
676 
679  swi_uint16 nMaxLenUserInput;
680 
682  SWI_TYPE_OMADM_UI_ALERT_INPUT_TYPE nInputType;
683 
685  SWI_TYPE_OMADM_UI_ALERT_ECHO_TYPE nEcho;
686 
688  swi_uint16 nPromptLength;
689 
692  swi_uint8* psText;
693 }SWI_STRUCT_OMADM_UI_ALERT_INPUT;
694 
700 typedef struct SWI_STRUCT_OMADM_UI_ALERT_INPUT_RESP
701 {
702  swi_uint32 sizeStruct;
705  SWI_TYPE_OMADM_UI_ALERT_USER_CONFIRM nUserAction;
706 
709  swi_uint16 nTextLength;
710 
712  swi_uint8* psText;
713 }SWI_STRUCT_OMADM_UI_ALERT_INPUT_RESP;
714 
720 typedef enum SWI_TYPE_OMADM_UI_ALERT_CHOICE_TYPE
721 {
723  OMADM_UI_ALERT_CHOICE_SINGLE = 0x00,
724 
726  OMADM_UI_ALERT_CHOICE_MULTIPLE = 0x01
727 }SWI_TYPE_OMADM_UI_ALERT_CHOICE_TYPE;
728 
734 typedef struct SWI_STRUCT_OMADM_UI_ALERT_CHOICE
735 {
736  swi_uint32 sizeStruct;
737  SWI_TYPE_OMADM_UI_ALERT_CHOICE_TYPE nChoiceType;
738  swi_uint8 nNumChoices;
741  swi_uint16 nMinDisplayTime;
742 
744  swi_uint16 nMaxDisplayTime;
745 
746  swi_uint32 dwChoiceMask;
747  swi_uint16 nTextLength;
750  swi_uint8* psText;
751 }SWI_STRUCT_OMADM_UI_ALERT_CHOICE;
752 
758 typedef struct SWI_STRUCT_OMADM_UI_ALERT_CHOICE_RESP
759 {
760  swi_uint32 sizeStruct;
761  SWI_TYPE_OMADM_UI_ALERT_USER_CONFIRM nUserAction;
762  swi_uint32 dwChoiceMask;
763 }SWI_STRUCT_OMADM_UI_ALERT_CHOICE_RESP;
764 
770 typedef struct SWI_STRUCT_OMADM_NODE_VALUE_REQUEST
771 {
772  swi_uint32 sizeStruct;
773  swi_uint16 nNodePathLength;
774  swi_uint8* psText;
775 }SWI_STRUCT_OMADM_NODE_VALUE_REQUEST;
776 
782 typedef struct SWI_STRUCT_OMADM_NODE_VALUE_RESPONSE
783 {
784  swi_uint32 sizeStruct;
785  SWI_TYPE_OMADM_STATUS_RESP nStatus;
786  swi_uint16 nNodeFormatLength;
787  swi_uint16 nNodeTypeLength;
788  swi_uint16 nNodeValueLength;
792  swi_uint8* psText;
793 }SWI_STRUCT_OMADM_NODE_VALUE_RESPONSE;
794 
800 typedef struct SWI_STRUCT_OMADM_NODE_VALUE
801 {
802  swi_uint32 sizeStruct;
803  swi_uint16 nNodePathLength;
804  swi_uint16 nNodeFormatLength;
805  swi_uint16 nNodeTypeLength;
806  swi_uint16 nNodeValueLength;
810  swi_uint8* psText;
811 }SWI_STRUCT_OMADM_NODE_VALUE;
812 
818 typedef enum SWI_TYPE_DM_DL_PROGRESS_TYPE
819 {
820  DM_DL_PROGRESS_TYPE_NO_PKG = 0x00,
821  DM_DL_PROGRESS_TYPE_FOTA_PKG = 0x01,
822  DM_DL_PROGRESS_TYPE_RESERVED = 0x02
823 }SWI_TYPE_DM_DL_PROGRESS_TYPE;
824 
830 typedef struct SWI_STRUCT_DM_DL_PROGRESS
831 {
832  swi_uint32 sizeStruct;
834  SWI_TYPE_DM_DL_PROGRESS_TYPE nDLType;
837  swi_uint32 nBytesDownloaded;
838 
840  swi_uint32 nTotalBytes;
841 }SWI_STRUCT_DM_DL_PROGRESS;
842 
848 typedef enum SWI_TYPE_DM_DL_VALID_RESP
849 {
850  DM_DL_VALID_RESP_REJECT = 0x01,
851  DM_DL_VALID_RESP_CONFIRM = 0x02,
854  DM_DL_VALID_RESP_DELAY = 0x04
855 }SWI_TYPE_DM_DL_VALID_RESP;
856 
862 typedef enum SWI_TYPE_DM_DL_ALERT_PROMPT
863 {
865  DM_DL_ALERT_PROMPT_DL_AND_INSTALL = 0x00,
866 
868  DM_DL_ALERT_PROMPT_INSTALL_ONLY = 0x01
869 }SWI_TYPE_DM_DL_ALERT_PROMPT;
870 
876 typedef struct SWI_STRUCT_DM_DL_ALERT
877 {
878  swi_uint32 sizeStruct;
879  swi_uint16 nReserved;
882  SWI_TYPE_DM_DL_VALID_RESP nValidRespMask;
883 
885  SWI_TYPE_DM_DL_ALERT_PROMPT nAlertType;
886 
889  swi_uint8 bDescAvail;
890 
892  swi_uint16 nEstDLTime;
893 
895  swi_uint16 nEstInstTime;
896 
898  swi_uint16 nTimeout;
899 
901  swi_uint16 nPkgNameLen;
902 
904  swi_uint8 szName[MAX_DL_PKG_NAME];
905 }SWI_STRUCT_DM_DL_ALERT;
906 
912 typedef enum SWI_TYPE_DM_DL_ALERT_RESP
913 {
914  DM_DL_ALERT_RESP_REJECT = 0x00,
915  DM_DL_ALERT_RESP_CONFIRM = 0x01,
916  DM_DL_ALERT_RESP_DELAY = 0x02
917 }SWI_TYPE_DM_DL_ALERT_RESP;
918 
924 typedef enum SWI_TYPE_DM_DL_ALERT_RESP_STATUS
925 {
926  DM_DL_ALERT_RESP_STATUS_SUCCESS = 0x00,
927  DM_DL_ALERT_RESP_STATUS_FAILED_UNSPECIFIED = 0x01,
930  DM_DL_ALERT_RESP_STATUS_FAILED_INVALID_RESPONSE = 0x02
931 }SWI_TYPE_DM_DL_ALERT_RESP_STATUS;
932 
938 typedef struct SWI_STRUCT_DM_DL_DESCRIPTION
939 {
940  swi_uint32 sizeStruct;
941  swi_uint16 nReserved;
942  swi_uint16 nDescLength;
945  swi_uint8 szDescription[MAX_DL_DESCRIPTION];
946 }SWI_STRUCT_DM_DL_DESCRIPTION;
947 
953 typedef enum SWI_TYPE_DM_DL_INSTALL_STATE
954 {
955  DM_DL_INSTALL_STATE_NULL = 0x00,
956  DM_DL_INSTALL_STATE_OFFLINE_INSTALL_STARTING = 0x01,
957  DM_DL_INSTALL_STATE_OFFLINE_INSTALL_SUCCESS = 0x02,
960  DM_DL_INSTALL_STATE_FAIL = 0xFF
961 }SWI_TYPE_DM_DL_INSTALL_STATE;
962 
968 typedef struct SWI_STRUCT_DM_DL_INSTALL_STATUS
969 {
970  swi_uint32 sizeStruct;
973  swi_uint16 nEstInstallTime;
974 
976  SWI_TYPE_DM_DL_INSTALL_STATE nInstallState;
977 
979  swi_uint16 nDMStatusCode;
980 }SWI_STRUCT_DM_DL_INSTALL_STATUS;
981 
982 /* CWE DM TLV Definitions */
983 
989 typedef enum SWI_TYPE_DM_TLV_TYPE
990 {
991  DM_TLV_Account_Node_Name = 1,
992  DM_TLV_Node_Path = 2,
993  DM_TLV_Node_Format = 3,
994  DM_TLV_Node_Type = 4,
995  DM_TLV_Node_Value = 5,
996  DM_TLV_Node_Property = 6,
997  DM_TLV_UI_Alert_Text = 7,
1000  DM_TLV_UI_Alert_Default_Response_Text = 8,
1001 
1002  DM_TLV_Get_Node_Data = 101,
1003  DM_TLV_Set_Node_Data = 102,
1004  DM_TLV_Set_Node_Property = 103,
1005  DM_TLV_Add_Interior_Node = 104,
1006  DM_TLV_UI_Alert_Text_Input = 105
1007 }SWI_TYPE_DM_TLV_TYPE;
1008 
1009 #define LENGTH_DM_TLV_HEADER 4
1010 #define NUM_Node_Data_Sub_TLV 4
1012 /* Function prototypes */
1013 
1014 SWI_API SWI_RCODE SwiGetOMADMConfig(SWI_STRUCT_OMADM_GET_CONFIG *psConfig,
1015  swi_uint32 timeout);
1016 
1017 SWI_API SWI_RCODE SwiSetOMADMConfig(
1018  const SWI_STRUCT_OMADM_SET_CONFIG *psConfig,
1019  swi_uint8 *pStatus,
1020  swi_uint32 timeout);
1021 
1022 SWI_API SWI_RCODE SwiStartOMADMSession(
1023  const SWI_STRUCT_OMADM_START_SESSION *psSession,
1024  swi_uint8 *pStatus,
1025  swi_uint32 timeout);
1026 
1027 SWI_API SWI_RCODE SwiCancelOMADMSession(SWI_STRUCT_OMADM_CANCEL_RESP *pStatus,
1028  swi_uint32 timeout);
1029 
1030 SWI_API SWI_RCODE SwiGetOMADMSessionState(
1031  SWI_STRUCT_OMADM_SESSION_STATE *psState,
1032  swi_uint32 timeout);
1033 
1034 SWI_API SWI_RCODE SwiGetOMADMNIAlert(SWI_STRUCT_OMADM_NI_ALERT *psAlert,
1035  swi_uint32 timeout);
1036 
1037 SWI_API SWI_RCODE SwiSetOMADMNIAlertResponse(
1038  swi_uint16 nResponse,
1039  SWI_STRUCT_OMADM_NI_ALERT_RESP *psStatus,
1040  swi_uint32 timeout);
1041 
1042 SWI_API SWI_RCODE SwiSetOMADMUIAlertConfirm(
1043  const SWI_STRUCT_OMADM_UI_ALERT_CONFIRM_RESP *psConfirm,
1044  swi_uint16 *pConfResp,
1045  swi_uint32 timeout);
1046 
1047 SWI_API SWI_RCODE SwiSetOMADMUIAlertInput(
1048  const SWI_STRUCT_OMADM_UI_ALERT_INPUT_RESP *psInput,
1049  swi_uint16 *pInputResp,
1050  swi_uint32 timeout);
1051 
1052 SWI_API SWI_RCODE SwiSetOMADMUIAlertChoice(
1053  const SWI_STRUCT_OMADM_UI_ALERT_CHOICE_RESP *psChoice,
1054  swi_uint16 *pConfResp,
1055  swi_uint32 timeout);
1056 
1057 SWI_API SWI_RCODE SwiSetOMADMBootAlgorithm(swi_uint16 *pStatus,
1058  swi_uint32 timeout);
1059 
1060 SWI_API SWI_RCODE SwiGetOMADMNodeValue(
1061  const SWI_STRUCT_OMADM_NODE_VALUE_REQUEST *psItem,
1062  SWI_STRUCT_OMADM_NODE_VALUE_RESPONSE *psValue,
1063  swi_uint32 timeout);
1064 
1065 SWI_API SWI_RCODE SwiSetOMADMNodeValue(
1066  const SWI_STRUCT_OMADM_NODE_VALUE *psValue,
1067  swi_uint8 *pStatus,
1068  swi_uint32 timeout);
1069 
1070 SWI_API SWI_RCODE SwiSetDMDLAlertResponse(swi_uint8 nResponse,
1071  swi_uint8* pStatus,
1072  swi_uint32 timeout);
1073 
1074 SWI_API SWI_RCODE SwiGetDMDLProgress(SWI_STRUCT_DM_DL_PROGRESS *psProgress,
1075  swi_uint32 timeout);
1076 
1077 SWI_API SWI_RCODE SwiGetDMDLDescription(
1078  SWI_STRUCT_DM_DL_DESCRIPTION *psDescription,
1079  swi_uint32 timeout);
1080 
1081 SWI_API SWI_RCODE SwiGetDMDLInstallStatus(
1082  SWI_STRUCT_DM_DL_INSTALL_STATUS *psStatus,
1083  swi_uint32 timeout);
1084 
1085 #ifdef __cplusplus
1086 } /* extern "C" { */
1087 #endif
1088 
1089 #endif /* __SWIAPICMDM_H__ */
1090 
1091 /*
1092  * $Log: SwiApiCmDm.h,v $
1093  */
1094 
Linux SDK V1.4.0.5
Copyright (c) 2011 Sierra Wireless, Inc. All rights reserved