LinuxSDK  V1.4.0.5
SwiApiCdmaRuim.h
Go to the documentation of this file.
1 
13 #ifndef __SWIAPICDMARUIM_H__
14 #define __SWIAPICDMARUIM_H__
15 
16 #ifdef __cplusplus
17 extern "C" {
18 #endif
19 
20 /* include files */
21 #include "SwiDataTypes.h"
22 #include "SwiRcodes.h"
23 
29 typedef enum SWI_TYPE_RuimStatus
30 {
31  SWI_RUIM_STATUS_OK = 0x0000,
32  SWI_RUIM_STATUS_INIT_ERR,
33  SWI_RUIM_STATUS_GENERAL_ERR,
34  SWI_RUIM_STATUS_LOCKED,
35  SWI_RUIM_STATUS_CHV1_BLOCKED,
36  SWI_RUIM_STATUS_CHV2_BLOCKED,
37  SWI_RUIM_STATUS_CHV1_REJECTED,
38  SWI_RUIM_STATUS_CHV2_REJECTED,
39  SWI_RUIM_STATUS_POLL_ERR,
42  SWI_RUIM_STATUS_NO_SRV_ERR,
43 
44  SWI_RUIM_STATUS_ICCID_MISMATCH_ERR
45 }SWI_TYPE_RuimStatus;
46 
52 typedef enum SWI_TYPE_RuimOpReq
53 {
54  SWI_RUIM_OPREQ_NONE = 0x0000,
55  SWI_RUIM_OPREQ_CHV1,
56  SWI_RUIM_OPREQ_CHV2,
57  SWI_RUIM_OPREQ_CHV_UNBLK1,
58  SWI_RUIM_OPREQ_CHV_UNBLK2
59 }SWI_TYPE_RuimOpReq;
60 
66 typedef enum SWI_TYPE_RuimPrevOp
67 {
68  SWI_RUIM_PREV_OP_NONE = 0x0000,
69  SWI_RUIM_PREV_OP_CHV1CHG,
70  SWI_RUIM_PREV_OP_CHV2CHG,
71  SWI_RUIM_PREV_OP_CHV1VER,
72  SWI_RUIM_PREV_OP_CHV2VER,
73  SWI_RUIM_PREV_OP_UNBLK1,
74  SWI_RUIM_PREV_OP_UNBLK2,
75  SWI_RUIM_PREV_OP_CHV1_EN,
76  SWI_RUIM_PREV_OP_CHV1_DIS
77 }SWI_TYPE_RuimPrevOp;
78 
84 typedef enum SWI_TYPE_RuimPrevOpRes
85 {
86  SWI_RUIM_PREV_OP_FAIL = 0x0000,
87  SWI_RUIM_PREV_OP_SUCCESS,
88  SWI_RUIM_PREV_OP_FAIL_VER,
91  SWI_RUIM_PREV_OP_FAIL_CHV_LEN,
92 
94  SWI_RUIM_PREV_OP_FAIL_UNBLK_LEN,
95 
97  SWI_RUIM_PREV_OP_FAIL_NO_SRV,
98 
100  SWI_RUIM_PREV_OP_FAIL_EMERG
101 }SWI_TYPE_RuimPrevOpRes;
102 
108 typedef enum SWI_TYPE_RuimRetryPres
109 {
110  SWI_RUIM_NO_RETRY_INFO = 0x0000,
111  SWI_RUIM_RETRY_INFO
112 }SWI_TYPE_RuimRetryPres;
113 
119 typedef enum SWI_TYPE_RuimRetry
120 {
121  SWI_RUIM_RETRY_CHV1 = 0x0000,
122  SWI_RUIM_RETRY_CHV2,
123  SWI_RUIM_RETRY_UNBLOCK_CHV1,
124  SWI_RUIM_RETRY_UNBLOCK_CHV2
125 }SWI_TYPE_RuimRetry;
126 
132 typedef enum SWI_RUIM_CHV
133 {
134  SWI_RUIM_CHV1 = 0x0001,
135  SWI_RUIM_CHV2,
136  SWI_RUIM_UNBLOCK_CHV1,
137  SWI_RUIM_UNBLOCK_CHV2
138 }SWI_RUIM_CHV;
139 
145 typedef struct SWI_STRUCT_RuimStatus
146 {
147  swi_uint32 sizeStruct;
148  swi_uint16 nStatus;
151  swi_uint16 byActionReq;
152 
154  swi_uint16 byPrevAction;
155 
157  swi_uint16 byPrevActRes;
158 
160  swi_uint16 byRetryPres;
161 
163  swi_uint16 byRetry;
164 
165  swi_uint16 byRetryNum;
166 }SWI_STRUCT_RuimStatus;
167 
168 /* Function prototypes */
169 
170 SWI_API SWI_RCODE SwiGetRUIMStatus(SWI_STRUCT_RuimStatus* sRuimStatus,
171  swi_uint32 timeout);
172 
173 SWI_API SWI_RCODE SwiVerifyCHV(swi_uint16 Chv, const swi_charp szCHV,
174  swi_uint32 timeout);
175 
176 SWI_API SWI_RCODE SwiEnableCHV(swi_bool bEnable, const swi_charp szCHV,
177  swi_uint32 timeout);
178 
179 SWI_API SWI_RCODE SwiChangeCHV(swi_uint16 Chv, const swi_charp szOldCHV,
180  const swi_charp szNewCHV, swi_uint32 timeout);
181 
182 SWI_API SWI_RCODE SwiUnblockCHV(swi_uint16 Chv, const swi_charp szUnblockCHV,
183  const swi_charp szCHV, swi_uint32 timeout);
184 
185 SWI_API SWI_RCODE SwiGetCHVEnableStatus(swi_bool* bEnable, swi_uint32 timeout);
186 
187 #ifdef __cplusplus
188 } /* extern "C" { */
189 #endif
190 
191 #endif /* __SWIAPICDMARUIM_H__ */
192 
193 /*
194  * $Log: SwiApiCdmaRuim.h,v $
195  */
Linux SDK V1.4.0.5
Copyright (c) 2011 Sierra Wireless, Inc. All rights reserved