blob: d4f61f2c9e366d3822e35a5e2b6057c322baf807 [file] [log] [blame]
rjw6c1fd8f2022-11-30 14:33:01 +08001/******************************************************************************
2* Copyright Statement:
3* --------------------
4* This software is protected by Copyright and the information contained
5* herein is confidential. The software may not be copied and the information
6* contained herein may not be used or disclosed except with the written
7* permission of MediaTek Inc. (C) 2016
8*
9* BY OPENING THIS FILE, BUYER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
10* THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("MEDIATEK SOFTWARE")
11* RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO BUYER ON
12* AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES,
13* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
14* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
15* NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
16* SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
17* SUPPLIED WITH THE MEDIATEK SOFTWARE, AND BUYER AGREES TO LOOK ONLY TO SUCH
18* THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. MEDIATEK SHALL ALSO
19* NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE RELEASES MADE TO BUYER'S
20* SPECIFICATION OR TO CONFORM TO A PARTICULAR STANDARD OR OPEN FORUM.
21*
22* BUYER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND CUMULATIVE
23* LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
24* AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE MEDIATEK SOFTWARE AT ISSUE,
25* OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY BUYER TO
26* MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
27*
28* THE TRANSACTION CONTEMPLATED HEREUNDER SHALL BE CONSTRUED IN ACCORDANCE
29* WITH THE LAWS OF THE STATE OF CALIFORNIA, USA, EXCLUDING ITS CONFLICT OF
30* LAWS PRINCIPLES. ANY DISPUTES, CONTROVERSIES OR CLAIMS ARISING THEREOF AND
31* RELATED THERETO SHALL BE SETTLED BY ARBITRATION IN SAN FRANCISCO, CA, UNDER
32* THE RULES OF THE INTERNATIONAL CHAMBER OF COMMERCE (ICC).
33*
34*******************************************************************************/
35
36/******************************************************************************
37 * Filename:
38 * --------------------------------------------------------
39 * lpp_lppe_enum.h
40 *
41 * Project:
42 * --------------------------------------------------------
43 *
44 *
45 * Description:
46 * --------------------------------------------------------
47 * LPP/LPP Extension Interface - Structure Enumeration
48 *
49 * Author:
50 * --------------------------------------------------------
51 * -------
52 *
53 * --------------------------------------------------------
54 * $Log$
55 *
56 * 10 20 2017 jie-yu.wang
57 * [MOLY00284367] [LPP] LR12 Earlyfix Development
58 * [LPP] Earlyfix Modification.
59 *
60 * 10 04 2016 doug.shih
61 * [LPPe] interface design
62 * Fix enum type redefinition
63 * .
64 *
65 * 09 30 2016 doug.shih
66 * [LPPe] interface design
67 * .
68 *
69 * 08 24 2016 doug.shih
70 * [LPPe] interface design
71 * .
72 *
73 *
74 *****************************************************************************/
75
76#ifndef _LPP_LPPE_ENUM_H
77#define _LPP_LPPE_ENUM_H
78
79#include "kal_public_api.h"
80#include "kal_public_defs.h"
81#include "kal_general_types.h"
82
83#include "lpp_lppe_def.h"
84
85typedef enum
86{
87 LPP_LPPE_MSG_TYPE_NULL,
88 LPP_LPPE_MSG_TYPE_REQUEST_CAPABILITIES,
89 LPP_LPPE_MSG_TYPE_PROVIDE_CAPABILITIES,
90 LPP_LPPE_MSG_TYPE_REQUEST_ASSISTANCE_DATA,
91 LPP_LPPE_MSG_TYPE_PROVIDE_ASSISTANCE_DATA,
92 LPP_LPPE_MSG_TYPE_REQUEST_LOCATION_INFORMATION,
93 LPP_LPPE_MSG_TYPE_PROVIDE_LOCATION_INFORMATION,
94 LPP_LPPE_MSG_TYPE_ABORT,
95 LPP_LPPE_MSG_TYPE_ERROR
96} lpp_lppe_msg_type_enum;
97
98typedef enum
99{
100 LPPE_LOC_RESULT_NULL,
101 LPPE_LOC_RESULT_NO_ERROR,
102 LPPE_LOC_RESULT_UNDEFINED,
103 LPPE_LOC_RESULT_REQ_TIMEOUT,
104 LPPE_LOC_RESULT_EARLY_FIX, /* Early fix result */
105 LPPE_LOC_RESULT_EARLY_FIX_NO_RESULT /* Early fix no result */
106} lppe_result_enum;
107
108typedef enum
109{
110 LPP_LPPE_POS_TYPE_INVALID,
111 LPP_LPPE_POS_TYPE_HA_GNSS,
112 LPP_LPPE_POS_TYPE_WLAN_AP,
113 LPP_LPPE_POS_TYPE_SENSOR_PRESSURE,
114 LPP_LPPE_POS_TYPE_SRN_BT,
115
116 //... below are not supported pos tech
117 //LPP_LPPE_POS_TYPE_EUTRA_OTDOA,
118 //LPP_LPPE_POS_TYPE_GSM_EOTD,
119 //LPP_LPPE_POS_TYPE_UTRA_OTDOA,
120 //LPP_LPPE_POS_TYPE_LTE_ECID,
121 //LPP_LPPE_POS_TYPE_GSM_ECID,
122 //LPP_LPPE_POS_TYPE_UTRA_ECID
123} lpp_lppe_pos_type_enum;
124
125
126typedef enum
127{
128 LPP_LPPE_HA_GNSS_AD_TYPE_COMMON,
129 LPP_LPPE_HA_GNSS_AD_TYPE_GENERIC
130} lpp_lppe_ha_gnss_ad_type_enum;
131
132typedef enum
133{
134 LPP_LPPE_GNSS_HA_ASSIST_DATA_TYPE_NULL,
135 LPP_LPPE_GNSS_HA_COMMON_ASSIST_DATA_TYPE_IONO_MODEL,
136 LPP_LPPE_GNSS_HA_COMMON_ASSIST_DATA_TYPE_TROPO_MODEL,
137 LPP_LPPE_GNSS_HA_COMMON_ASSIST_DATA_TYPE_ALTITUDE,
138 LPP_LPPE_GNSS_HA_COMMON_ASSIST_DATA_TYPE_SOLAR_RAD,
139 LPP_LPPE_GNSS_HA_COMMON_ASSIST_DATA_TYPE_CCP_ASSIST,
140
141 LPP_LPPE_GNSS_HA_GENERIC_ASSIST_DATA_TYPE_WA_ION_SURF,
142 LPP_LPPE_GNSS_HA_GENERIC_ASSIST_DATA_TYPE_SV_MECHANICS,
143 LPP_LPPE_GNSS_HA_GENERIC_ASSIST_DATA_TYPE_SV_DCB,
144 LPP_LPPE_GNSS_HA_GENERIC_ASSIST_DATA_TYPE_DEGRAD_MODEL,
145 LPP_LPPE_GNSS_HA_GENERIC_ASSIST_DATA_TYPE_CCP_ASSIST,
146 LPP_LPPE_GNSS_HA_GENERIC_ASSIST_DATA_TYPE_NAV_MODEL,
147} lpp_lppe_ha_gnss_assist_data_type_enum;
148
149
150typedef enum
151{
152 LPP_LPPE_ABORT_CAUSE_UNDEFINED,
153 LPP_LPPE_ABORT_CAUSE_TARGET_DEVICE_ABORT,
154 LPP_LPPE_ABORT_CAUSE_NETWORK_ABORT,
155 LPP_LPPE_ABORT_CAUSE_STOP_PERIODIC_REPORTING
156} lpp_lppe_abort_cause_enum;
157
158typedef enum
159{
160 LPP_LPPE_ERROR_CAUSE_UNDEFINED,
161 LPP_LPPE_ERROR_CAUSE_TARGET_DEVICE_ERROR,
162 LPP_LPPE_ERROR_CAUSE_NETWORK_ERROR
163} lpp_lppe_error_cause_enum;
164
165
166typedef enum
167{
168 WLAN_AP_ERROR_TYPE_LOCATION_SERVER_CAUSE,
169 WLAN_AP_ERROR_TYPE_TARGET_DEVICE_CAUSE
170} wlan_ap_error_type_enum;
171
172
173typedef enum
174{
175 WLAN_AP_LOC_SRV_ERR_CAUSE_UNDEFINED,
176 WLAN_AP_LOC_SRV_ERR_CAUSE_REQ_AD_NOT_AVAILABLE,
177 WLAN_AP_LOC_SRV_ERR_CAUSE_NOT_ALL_REQ_AD_AVAILABLE
178} wlan_ap_loc_srv_err_cause_enum;
179
180
181typedef enum
182{
183 WLAN_AP_TGT_DEV_ERR_CAUSE_CAUSE_UNDEFINED,
184 WLAN_AP_TGT_DEV_ERR_CAUSE_CAUSE_REQ_MEASUREMENT_NOT_AVAILABLE,
185 WLAN_AP_TGT_DEV_ERR_CAUSE_CAUSE_NOT_ALL_REQ_MEASUREMENT_POSSIBLE
186} wlan_ap_tgt_dev_err_cause_enum;
187
188
189typedef enum
190{
191 WLAN_AP_TYPE_IEEE802_11A,
192 WLAN_AP_TYPE_IEEE802_11B,
193 WLAN_AP_TYPE_IEEE802_11G,
194 WLAN_AP_TYPE_IEEE802_11N,
195 WLAN_AP_TYPE_IEEE802_11AC,
196 WLAN_AP_TYPE_IEEE802_11AD
197} wlan_ap_type_enum;
198
199
200typedef enum
201{
202 WLAN_AP_PHY_TYPE_UNKNOWN,
203 WLAN_AP_PHY_TYPE_ANY,
204 WLAN_AP_PHY_TYPE_FHSS,
205 WLAN_AP_PHY_TYPE_DSSS,
206 WLAN_AP_PHY_TYPE_IRBASEBAND,
207 WLAN_AP_PHY_TYPE_OFDM,
208 WLAN_AP_PHY_TYPE_HRDSSS,
209 WLAN_AP_PHY_TYPE_ERP,
210 WLAN_AP_PHY_TYPE_HT,
211 WLAN_AP_PHY_TYPE_IHV
212} wlan_ap_phy_type_enum;
213
214
215typedef enum
216{
217 WLAN_AP_RTD_UNIT_MICROSECONDS,
218 WLAN_AP_RTD_UNIT_HUNDREDS_OF_NANOSECONDS,
219 WLAN_AP_RTD_UNIT_TENS_OF_NANOSECONDS,
220 WLAN_AP_RTD_UNIT_NANOSECONDS,
221 WLAN_AP_RTD_UNIT_TENTHS_OF_NANOSECONDS,
222 WLAN_AP_RTD_UNIT_MAX = MAX_ENUM_VALUE,
223} wlan_ap_rtd_unit_enum;
224
225
226typedef enum
227{
228 WLAN_FEMTO_COVER_AREA_TYPE_GAUSSIAN,
229 WLAN_FEMTO_COVER_AREA_TYPE_BINARY_DISTRIBUTION
230} wlan_femto_cover_area_type_enum;
231
232
233typedef enum
234{
235 WLAN_FEMTO_COVER_AREA_ELEMENT_TYPE_INDOOR,
236 WLAN_FEMTO_COVER_AREA_ELEMENT_TYPE_OUTDOOR,
237 WLAN_FEMTO_COVER_AREA_ELEMENT_TYPE_MIXED
238} wlan_femto_cover_area_element_type_enum;
239
240
241typedef enum
242{
243 WLAN_FEMTO_COVER_AREA_REF_LOC_TYPE_ANTENNA,
244 WLAN_FEMTO_COVER_AREA_REF_LOC_TYPE_REF_POINT
245} wlan_femto_cover_area_ref_loc_type_enum;
246
247
248typedef enum
249{
250 SRN_GROUP_TYPE_GROUP_LIST,
251 SRN_GROUP_TYPE_GROUP_UPDATE_RESPONSE
252} srn_group_type_enum;
253
254
255typedef enum
256{
257 SRN_ID_TYPE_MAC_ADDR, /* BT, BT LE */
258 //... below are not supported id type
259 //SRN_ID_TYPE_NFC,
260 //SRN_ID_TYPE_MOBILECODE,
261 //SRN_ID_TYPE_OTHER
262} srn_id_type_enum;
263
264
265typedef enum
266{
267 SRN_TECH_TYPE_BT,
268 SRN_TECH_TYPE_BTLE,
269 //... below are not supported pos tech
270 //SRN_TECH_TYPE_NFC,
271 //SRN_TECH_TYPE_MOBILECODE,
272 //SRN_TECH_TYPE_OTHER
273} srn_tech_type_enum;
274
275typedef enum
276{
277 BLUETOOTH_RTD_UNIT_MICROSECONDS,
278 BLUETOOTH_RTD_UNIT_HUNDREDS_OF_NANOSECONDS,
279 BLUETOOTH_RTD_UNIT_TENS_OF_NANOSECONDS,
280 BLUETOOTH_RTD_UNIT_NANOSECONDS,
281 BLUETOOTH_RTD_UNIT_TENTHS_OF_NANOSECONDS,
282 BLUETOOTH_RTD_UNIT_MAX = MAX_ENUM_VALUE,
283}bt_rtd_unit_enum;
284
285typedef enum
286{
287 SRN_TARGET_DATA_VALID_TYPE_VALID,
288 SRN_TARGET_DATA_VALID_TYPE_VALID_UPDATED_DATA_WILL_BE_PROVIDED,
289 SRN_TARGET_DATA_VALID_TYPE_VALID_BUT_SERVER_WILL_NOT_PROVIDE_NEW_DATA
290} srn_target_data_valid_type_enum;
291
292
293typedef enum
294{
295 SRN_ERROR_TYPE_LOCATION_SERVER_CAUSE,
296 SRN_ERROR_TYPE_TARGET_DEVICE_CAUSE
297} srn_error_type_enum;
298
299
300typedef enum
301{
302 SRN_LOCATION_SERVER_GROUP_ERR_CAUSE_UNDEFINED,
303 SRN_LOCATION_SERVER_GROUP_ERR_CAUSE_SOME_GROUP_CATEGORY_SRNID_UNKNOWN_UNSUPPORTED,
304 SRN_LOCATION_SERVER_GROUP_ERR_CAUSE_ALL_GROUP_CATEGORY_SRNID_UNKNOWN_UNSUPPORTED,
305 SRN_LOCATION_SERVER_GROUP_ERR_CAUSE_NO_SRN_GROUPS_NEARBY
306} srn_loc_server_group_err_cause_enum;
307
308
309typedef enum
310{
311 SRN_LOC_SERVER_GROUP_UPT_ERR_CAUSE_UNDEFINED,
312 SRN_LOC_SERVER_GROUP_UPT_ERR_CAUSE_ALL_SRN_GROUPIDS_UNKNOWN,
313 SRN_LOC_SERVER_GROUP_UPT_ERR_CAUSE_ALL_SRN_GROUPIDS_KNOWN_SOME_SRN_GROUP_VERSIONS_UNKNOWN,
314 SRN_LOC_SERVER_GROUP_UPT_ERR_CAUSE_ALL_SRN_GROUPIDS_KNOWN_ALL_SRN_GROUP_VERSIONS_UNKNOWN,
315 SRN_LOC_SERVER_GROUP_UPT_ERR_CAUSE_SOME_SRN_GROUPIDS_UNKNOWN,
316 SRN_LOC_SERVER_GROUP_UPT_ERR_CAUSE_SOME_SRN_GROUP_VERSIONS_UNKNOWN_ALL_SRN_GROUP_VERSIONS_UNKNOWN,
317 SRN_LOC_SERVER_GROUP_UPT_ERR_CAUSE_SOME_SRN_GROUPIDS_SOME_SRN_GROUP_VERSIONS_UNKNOWN,
318 SRN_LOC_SERVER_GROUP_UPT_ERR_CAUSE_INFO_NOT_MATCH_WITH_GROUPID
319} srn_loc_server_group_upt_err_cause_enum;
320
321
322typedef enum
323{
324 SRN_LOC_SERVER_ANTENNA_ERR_CAUSE_UNDEFINED,
325 SRN_LOC_SERVER_ANTENNA_ERR_CAUSE_SOME_ANTENNA_PATTERNIDS_UNKNOWN,
326 SRN_LOC_SERVER_ANTENNA_ERR_CAUSE_ALL_ANTENNA_PATTERNIDS_UNKNOWN
327} srn_loc_server_antenna_err_cause_enum;
328
329
330typedef enum
331{
332 SRN_TARGET_DEVICE_ERR_CAUSE_UNDEFINED,
333 SRN_TARGET_DEVICE_ERR_CAUSE_REQUESTED_MEASUREMENTS_NOT_AVAILABLE,
334 SRN_TARGET_DEVICE_ERR_CAUSE_NOT_ALL_REQUESTED_MEASUREMENTS_POSSIBLE,
335 SRN_TARGET_DEVICE_ERR_CAUSE_CATEGORY_NOT_SUPPORTED
336} srn_target_device_err_cause_enum;
337
338#if 0
339/* under construction !*/
340/* under construction !*/
341/* under construction !*/
342/* under construction !*/
343/* under construction !*/
344/* under construction !*/
345#endif
346
347/*Mapping to LPPeBluetooth_BluetoothMultipleMeasurement*/
348typedef enum
349{
350 SRN_REQ_LOC_MULTI_MEAS_FORBIDDEN,
351 SRN_REQ_LOC_MULTI_MEAS_ALLOWED,
352 SRN_REQ_LOC_MULTI_MEAS_REQUESTED,
353 SRN_REQ_LOC_MULTI_MEAS_MAX = MAX_ENUM_VALUE,
354} srn_req_loc_multi_meas_enum;
355
356
357typedef enum
358{
359 IP_ADDRESS_TYPE_IP_V4,
360 IP_ADDRESS_TYPE_IP_V6
361} ip_address_type_enum;
362
363
364/* Mapping to LPPeIpAddress_Bearer*/
365typedef enum
366{
367 DATA_BEARER_TYPE_UNKNOWN,
368 DATA_BEARER_TYPE_GSM,
369 DATA_BEARER_TYPE_UTRAN,
370 DATA_BEARER_TYPE_LTE,
371 DATA_BEARER_TYPE_WLAN,
372 /* others type will not be used in mobile devices */
373 DATA_BEARER_TYPE_MAX = MAX_ENUM_VALUE,
374} data_bearer_type_enum;
375
376
377typedef enum
378{
379 SCHEDULED_LOC_DISPOS_TYPE_WITHIN_WINDOW,
380 SCHEDULED_LOC_DISPOS_TYPE_OUTSIDE_WINDOW_NOWINDOW,
381 SCHEDULED_LOC_DISPOS_TYPE_NOT_SUPPORTED_NO_CAPABILITY,
382 SCHEDULED_LOC_DISPOS_TYPE_NOT_SUPPORTED_NO_TIME_REFERENCE,
383 SCHEDULED_LOC_DISPOS_TYPE_NOT_SUPPORTED__CONFLICT_ANOTHER_REQUEST,
384 SCHEDULED_LOC_DISPOS_TYPE_NOT_SUPPORTED_OTHER_REASONS
385} scheduled_loc_dispos_type_enum;
386
387
388typedef enum
389{
390 LOC_TIME_STAMP_TYPE_GNSS_TIME,
391 LOC_TIME_STAMP_TYPE_NETWORK_TIME,
392 LOC_TIME_STAMP_TYPE_RELATIVE_TIME,
393} loc_time_stamp_type_enum;
394
395
396typedef enum
397{
398 SENSOR_PRIMARY_MOTION_STATE_UNKNOWN,
399 SENSOR_PRIMARY_MOTION_STATE_STATIONARY,
400 SENSOR_PRIMARY_MOTION_STATE_PEDESTRIAN,
401 SENSOR_PRIMARY_MOTION_STATE_RUNNING,
402 SENSOR_PRIMARY_MOTION_STATE_CYCLING,
403 SENSOR_PRIMARY_MOTION_STATE_CAR,
404 SENSOR_PRIMARY_MOTION_STATE_TRAIN,
405 SENSOR_PRIMARY_MOTION_STATE_AEROPLANE,
406 SENSOR_PRIMARY_MOTION_STATE_BOAT,
407 SENSOR_PRIMARY_MOTION_STATE_FIDGETING
408} sensor_primary_motion_state_enum;
409
410
411typedef enum
412{
413 SENSOR_TGT_PRI_MOTION_STATE_ERR_CAUSE_NOT_AVAILABLE,
414 SENSOR_TGT_PRI_MOTION_STATE_ERR_CAUSE_NOT_SUPPORTED
415} sensor_tgt_pri_motion_state_err_cause_enum;
416
417
418typedef enum
419{
420 SENSOR_TGT_SEC_MOTION_STATE_ERR_CAUSE_NOT_AVAILABLE,
421 SENSOR_TGT_SEC_MOTION_STATE_ERR_CAUSE_NOT_SUPPORTED
422} sensor_tgt_sec_motion_state_err_cause_enum;
423
424
425typedef enum
426{
427 SENSOR_TGT_PRESSURE_ERR_CAUSE_NOT_AVAILABLE,
428 SENSOR_TGT_PRESSURE_ERR_CAUSE_NOT_SUPPORTED
429} sensor_tgt_pressure_err_cause_enum;
430
431
432typedef enum
433{
434 LPPE_SERVICE_SUPPORT_TYPE_NULL,
435 LPPE_SERVICE_SUPPORT_TYPE_WLAN,
436 LPPE_SERVICE_SUPPORT_TYPE_BT,
437 LPPE_SERVICE_SUPPORT_TYPE_SENSOR,
438 LPPE_SERVICE_SUPPORT_TYPE_NETWORK,
439 LPPE_SERVICE_SUPPORT_TYPE_IPADDRESS,
440} lppe_service_support_type_enum;
441
442
443
444#endif /* _LPP_LPPE_ENUM_H */