LinuxSDK  V1.4.0.5
SwiApiCdmaLbs.h
Go to the documentation of this file.
1 
14 #ifndef __SWIAPICDMALBS_H__
15 #define __SWIAPICDMALBS_H__
16 
17 #ifdef __cplusplus
18 extern "C" {
19 #endif
20 
21 /* include files */
22 #include "SwiDataTypes.h"
23 #include "SwiRcodes.h"
24 #include "SwiApiCmLbs.h"
25 #include "SwiApiCdmaLbs.h"
26 
27 /* GPS enhancement */
28 
34 typedef struct SWI_STRUCT_LBS_FixTypeControl
35 {
37  swi_uint8 bStandalone;
38 
40  swi_uint8 bMSBased;
41 
43  swi_uint8 bMSAssisted;
44 
46  swi_uint8 bOptimalAccuracy;
47 
49  swi_uint8 bOptimalSpeed;
50 
52  swi_uint8 bOptimalData;
53 }SWI_STRUCT_LBS_FixTypeControl;
54 
60 enum SWI_TYPE_AUTOTRACK_SUPPORT
61 {
62  SWI_AUTOTRACK_NOT_ALLOWED = 0x00,
65  SWI_AUTOTRACK_ALLOWED = 0x01,
66 
69  SWI_AUTOTRACK_ON_CONNECT = 0x02
70 };
71 
77 typedef struct SWI_STRUCT_LbsAutoStart
78 {
79  swi_uint8 nAllowed;
83  swi_uint8 bEnabled;
84 
87  swi_uint16 nFixType;
88 
89  swi_uint16 nPerformance;
90  swi_uint32 nAccuracy;
91  swi_uint16 nFixCount;
92  swi_uint32 nFixRate;
93 }SWI_STRUCT_LbsAutoStart;
94 
95 /* GPS enhancement end */
96 
97 /* Function prototypes */
98 
99 SWI_API SWI_RCODE SwiGetLbsLocNotifyStatus(
100  SWI_STRUCT_LbsLocNotifyStatus *psNotifyStatus,
101  swi_uint32 timeout);
102 
103 SWI_API SWI_RCODE SwiSetLbsLocNotifyStatus(
104  const SWI_STRUCT_LbsLocNotifyStatus *psNotifyStatus,
105  swi_uint32 timeout);
106 
107 SWI_API SWI_RCODE SwiGetLbsDloadNotifyStatus(
108  SWI_STRUCT_LbsDloadNotifyStatus *psNotifyStatus,
109  swi_uint32 timeout);
110 
111 SWI_API SWI_RCODE SwiSetLbsDloadNotifyStatus(
112  const SWI_STRUCT_LbsDloadNotifyStatus *psNotifyStatus,
113  swi_uint32 timeout);
114 
115 SWI_API SWI_RCODE SwiGetLbsParamNotifyStatus(
116  SWI_STRUCT_LbsParamNotifyStatus *psNotifyStatus,
117  swi_uint32 timeout);
118 
119 SWI_API SWI_RCODE SwiSetLbsParamNotifyStatus(
120  const SWI_STRUCT_LbsParamNotifyStatus *psNotifyStatus,
121  swi_uint32 timeout);
122 
123 SWI_API SWI_RCODE SwiSetLbsPdDownload(
124  const SWI_STRUCT_LbsPdDownload *psLbsPdDownload,
125  swi_uint32 timeout);
126 
127 SWI_API SWI_RCODE SwiGetLbsPaGpsLock(
128  SWI_STRUCT_LbsPaGpsLock *psPaGpsLock,
129  swi_uint32 timeout);
130 
131 SWI_API SWI_RCODE SwiSetLbsPaGpsLock(
132  const SWI_STRUCT_LbsPaGpsLock *psPaGpsLock,
133  swi_uint32 timeout);
134 
135 SWI_API SWI_RCODE SwiGetLbsPaPtlmMode(
136  SWI_STRUCT_LbsPaPtlmMode *psPaPtlmMode,
137  swi_uint32 timeout);
138 
139 SWI_API SWI_RCODE SwiSetLbsPaPtlmMode(
140  const SWI_STRUCT_LbsPaPtlmMode *psPaPtlmMode,
141  swi_uint32 timeout);
142 
143 SWI_API SWI_RCODE SwiGetLbsPaPrivacy(
144  SWI_STRUCT_LbsPaPrivacy *psPaPrivacy,
145  swi_uint32 timeout);
146 
147 SWI_API SWI_RCODE SwiSetLbsPaPrivacy(
148  const SWI_STRUCT_LbsPaPrivacy *psPaPrivacy,
149  swi_uint32 timeout);
150 
151 SWI_API SWI_RCODE SwiGetLbsPaNetAccess(
152  SWI_STRUCT_LbsPaNetAccess *psPaNetAccess,
153  swi_uint32 timeout);
154 
155 SWI_API SWI_RCODE SwiSetLbsPaNetAccess(
156  const SWI_STRUCT_LbsPaNetAccess *psPaNetAccess,
157  swi_uint32 timeout);
158 
159 SWI_API SWI_RCODE SwiGetLbsPaBsInfo(
160  SWI_STRUCT_LbsPaBsInfo *psBsInfo,
161  swi_uint32 timeout);
162 
163 SWI_API SWI_RCODE SwiGetLbsSmartModeControl(swi_uint8 *pnMask,
164  swi_uint32 timeout);
165 
166 SWI_API SWI_RCODE SwiSetLbsSmartModeControl(swi_uint8 nMask,
167  swi_uint32 timeout);
168 
169 SWI_API SWI_RCODE SwiGetLbsSWSmartModeControl(swi_uint8 *pnMask,
170  swi_uint32 timeout);
171 
172 SWI_API SWI_RCODE SwiSetLbsSWSmartModeControl(swi_uint8 nMask,
173  swi_uint32 timeout);
174 
175 SWI_API SWI_RCODE SwiGetLbsFixTypeControl(
176  SWI_STRUCT_LBS_FixTypeControl *pFixTypeControl,
177  swi_uint32 timeout);
178 
179 SWI_API SWI_RCODE SwiSetLbsFixTypeControl(
180  const SWI_STRUCT_LBS_FixTypeControl *pFixTypeControl,
181  swi_uint32 timeout);
182 
183 SWI_API SWI_RCODE SwiGetLbsCLMControl(swi_uint8 *pnMask, swi_uint32 timeout);
184 SWI_API SWI_RCODE SwiSetLbsCLMControl(swi_uint8 nMask, swi_uint32 timeout);
185 
186 SWI_API SWI_RCODE SwiGetLbsNemaOutputMessageControl(swi_uint8 *pnMask,
187  swi_uint32 timeout);
188 
189 SWI_API SWI_RCODE SwiSetLbsNemaOutputMessageControl(swi_uint8 nMask,
190  swi_uint32 timeout);
191 
192 SWI_API SWI_RCODE SwiGetLbsAutoStart(SWI_STRUCT_LbsAutoStart *psLbsAutoStart,
193  swi_uint32 timeout);
194 
195 SWI_API SWI_RCODE SwiSetLbsAutoStart(
196  const SWI_STRUCT_LbsAutoStart *psLbsAutoStart,
197  swi_uint32 timeout);
198 
199 SWI_API SWI_RCODE SwiGetLbsFixTypeSupportStatus(swi_uint8 *pStatus,
200  swi_uint32 nLen,
201  swi_uint32 timeout);
202 
203 /* === GPS One Xtra === */
204 
205 typedef enum LBS_XTRA_ASSIST_DATA_OP_ASSISTANCE_STATUS
206 {
207  LBS_XTRA_ASSIST_DATA_OP_ASSISTANCE_STATUS_INVALID = 0x00,
208  LBS_XTRA_ASSIST_DATA_OP_ASSISTANCE_STATUS_VALID,
209 } LBS_XTRA_ASSIST_DATA_OP_ASSISTANCE_STATUS;
210 
211 typedef enum LBS_XTRA_ASSIST_DATA_OP
212 {
214  LBS_XTRA_ASSIST_DATA_OP_ASSISTANCE_DATA_DOWNLOAD = 0x00,
215 
216  LBS_XTRA_ASSIST_DATA_OP_ASSISTANCE_EFS_FILE,
217  LBS_XTRA_ASSIST_DATA_OP_ASSISTANCE_DOWNLOAD_FAILED,
218 } LBS_XTRA_ASSIST_DATA_OP;
219 
220 typedef enum LBS_XTRA_ASSIST_DATA_RESULT
221 {
222  LBS_XTRA_ASSIST_DATA_RESULT_NO_ERROR = 0x00,
223  LBS_XTRA_ASSIST_DATA_RESULT_NOT_SUPPORTED,
224  LBS_XTRA_ASSIST_DATA_RESULT_UNABLE_TO_ACCESS_EFS,
225  LBS_XTRA_ASSIST_DATA_RESULT_IN_PROGRESS,
226  LBS_XTRA_ASSIST_DATA_RESULT_INCORRECT_PARAMETER,
227  LBS_XTRA_ASSIST_DATA_RESULT_DOWNLOAD_NOT_PERMITTED,
228 } LBS_XTRA_ASSIST_DATA_RESULT;
229 
230 typedef enum LBS_XTRA_ASSIST_DATA_NOTIFY_STATUS
231 {
232  LBS_XTRA_ASSIST_DATA_NOTIFY_STATUS_SUCCESS = 0x00,
233  LBS_XTRA_ASSIST_DATA_NOTIFY_STATUS_BAD_CRC,
236  LBS_XTRA_ASSIST_DATA_NOTIFY_STATUS_BAD_BUFFER_LENGTH,
237 
238  LBS_XTRA_ASSIST_DATA_NOTIFY_STATUS_BAD_TIME_RANGE,
239  LBS_XTRA_ASSIST_DATA_NOTIFY_STATUS_FAILURE,
240  LBS_XTRA_ASSIST_DATA_NOTIFY_STATUS_GPS_BUSY,
243  LBS_XTRA_ASSIST_DATA_NOTIFY_STATUS_E911_IN_PROGRESS,
244 
245  LBS_XTRA_ASSIST_DATA_NOTIFY_STATUS_RETRY_EXCEEDED,
246  LBS_XTRA_ASSIST_DATA_NOTIFY_STATUS_DATA_TIMEOUT,
249  LBS_XTRA_ASSIST_DATA_NOTIFY_STATUS_FILE_TIME_UNCHANGED,
250 } LBS_XTRA_ASSIST_DATA_NOTIFY_STATUS;
251 
252 typedef enum LBS_XTRA_TIME_INFO_SET_OP
253 {
254  LBS_XTRA_TIME_INFO_SET_SNTP_SERVER = 0x00,
255  LBS_XTRA_TIME_INFO_SET_GSM_UMTS_NETWORK,
256  LBS_XTRA_TIME_INFO_SET_HOST,
257 } LBS_XTRA_TIME_INFO_SET_OP;
258 
259 typedef enum LBS_XTRA_TIME_INFO_SET_TIME_REF
260 {
261  LBS_XTRA_TIME_INFO_SET_GPS = 0x00,
262  LBS_XTRA_TIME_INFO_SET_UTC,
263 } LBS_XTRA_TIME_INFO_SET_TIME_REF;
264 
265 typedef enum LBS_XTRA_DLOAD_TRIGGER_OP
266 {
267  LBS_XTRA_DLOAD_TRIGGER_OP_HTTP = 0x00,
268  LBS_XTRA_DLOAD_TRIGGER_OP_SNTP,
269 } LBS_XTRA_DLOAD_TRIGGER_OP;
270 
271 typedef struct SWI_STRUCT_LBS_XTRA_ASSIST_DATA_GET
272 {
274  LBS_XTRA_ASSIST_DATA_OP_ASSISTANCE_STATUS assistanceDataStatus;
275 
277  swi_char assistanceDataTimeStamp[16];
278 
280  swi_char assistanceDataTimeStampExpiry[16];
281 } SWI_STRUCT_LBS_XTRA_ASSIST_DATA_GET;
282 
283 typedef struct SWI_STRUCT_LBS_XTRA_ASSIST_DATA_SET
284 {
285  LBS_XTRA_ASSIST_DATA_OP operation;
286  swi_char assistanceDataFilename[8];
287 } SWI_STRUCT_LBS_XTRA_ASSIST_DATA_SET;
288 
289 typedef struct SWI_STRUCT_LBS_XTRA_TIME_INFO_SET
290 {
291  LBS_XTRA_TIME_INFO_SET_OP operation;
292  swi_uint64 time;
293  swi_uint32 timeUncertainty;
294  LBS_XTRA_TIME_INFO_SET_TIME_REF timeReference;
297  swi_uint16 timeForce;
298 } SWI_STRUCT_LBS_XTRA_TIME_INFO_SET;
299 
300 typedef struct SWI_STRUCT_LBS_XTRA_SERVER_URL
301 {
302  swi_uint8 numberOfRetries;
303  swi_char serverURL[128];
306  swi_uint8 moreURLs;
307 } SWI_STRUCT_LBS_XTRA_SERVER_URL;
308 
309 typedef struct SWI_STRUCT_LbsXtraAssist
310 {
311  swi_uint32 sizeStruct;
312  LBS_XTRA_ASSIST_DATA_NOTIFY_STATUS status;
313 } SWI_STRUCT_LbsXtraAssist;
314 
315 typedef struct SWI_STRUCT_LbsXtraDloadTrigger
316 {
317  swi_uint32 sizeStruct;
318  LBS_XTRA_DLOAD_TRIGGER_OP operation;
322  swi_uint32 failoverThreshold;
323 } SWI_STRUCT_LbsXtraDloadTrigger; // LBS_XTRA_DLOAD_TRIGGER_NOTIFY_Packed;
324 
325 SWI_API SWI_RCODE SwiGetLbsXtraAssistData( SWI_STRUCT_LBS_XTRA_ASSIST_DATA_GET *data,
326  swi_uint32 timeout );
327 
328 SWI_API SWI_RCODE SwiSetLbsXtraAssistData( SWI_STRUCT_LBS_XTRA_ASSIST_DATA_SET *data,
329  LBS_XTRA_ASSIST_DATA_RESULT *response,
330  swi_uint32 timeout );
331 
332 SWI_API SWI_RCODE SwiSetLbsXtraTimeInfo( SWI_STRUCT_LBS_XTRA_TIME_INFO_SET *data,
333  LBS_XTRA_ASSIST_DATA_RESULT *response,
334  swi_uint32 timeout );
335 
336 SWI_API SWI_RCODE SwiGetLbsXtraDataServerURL( SWI_STRUCT_LBS_XTRA_SERVER_URL *data,
337  swi_uint32 timeout );
338 
339 SWI_API SWI_RCODE SwiGetLbsXtraTimeServerURL( SWI_STRUCT_LBS_XTRA_SERVER_URL *data,
340  swi_uint32 timeout );
341 
342 #ifdef __cplusplus
343 } /* extern "C" { */
344 #endif
345 
346 #endif /* __SWIAPICDMALBS_H__ */
347 
348 /*
349  * $Log: SwiApiCdmaLbs.h,v $
350  */
351 
Linux SDK V1.4.0.5
Copyright (c) 2011 Sierra Wireless, Inc. All rights reserved