1 /* Copyright (c) 2013-2014, The Linux Foundation. All rights reserved. 2 * 3 * Redistribution and use in source and binary forms, with or without 4 * modification, are permitted provided that the following conditions are 5 * met: 6 * * Redistributions of source code must retain the above copyright 7 * notice, this list of conditions and the following disclaimer. 8 * * Redistributions in binary form must reproduce the above 9 * copyright notice, this list of conditions and the following 10 * disclaimer in the documentation and/or other materials provided 11 * with the distribution. 12 * * Neither the name of The Linux Foundation nor the names of its 13 * contributors may be used to endorse or promote products derived 14 * from this software without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED 17 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS 20 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR 23 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 24 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 25 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN 26 * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27 */ 28 29 #ifndef GPS_EXTENDED_C_H 30 #define GPS_EXTENDED_C_H 31 32 #ifdef __cplusplus 33 extern "C" { 34 #endif /* __cplusplus */ 35 36 #include <ctype.h> 37 #include <stdbool.h> 38 #include <hardware/gps.h> 39 40 /** Location has valid source information. */ 41 #define LOCATION_HAS_SOURCE_INFO 0x0020 42 /** GpsLocation has valid "is indoor?" flag */ 43 #define GPS_LOCATION_HAS_IS_INDOOR 0x0040 44 /** GpsLocation has valid floor number */ 45 #define GPS_LOCATION_HAS_FLOOR_NUMBER 0x0080 46 /** GpsLocation has valid map URL*/ 47 #define GPS_LOCATION_HAS_MAP_URL 0x0100 48 /** GpsLocation has valid map index */ 49 #define GPS_LOCATION_HAS_MAP_INDEX 0x0200 50 51 /** Sizes for indoor fields */ 52 #define GPS_LOCATION_MAP_URL_SIZE 400 53 #define GPS_LOCATION_MAP_INDEX_SIZE 16 54 55 /** Position source is ULP */ 56 #define ULP_LOCATION_IS_FROM_HYBRID 0x0001 57 /** Position source is GNSS only */ 58 #define ULP_LOCATION_IS_FROM_GNSS 0x0002 59 /** Position source is ZPP only */ 60 #define ULP_LOCATION_IS_FROM_ZPP 0x0004 61 /** Position is from a Geofence Breach Event */ 62 #define ULP_LOCATION_IS_FROM_GEOFENCE 0X0008 63 /** Positioin is from Hardware FLP */ 64 #define ULP_LOCATION_IS_FROM_HW_FLP 0x0010 65 66 #define ULP_MIN_INTERVAL_INVALID 0xffffffff 67 68 /*Emergency SUPL*/ 69 #define GPS_NI_TYPE_EMERGENCY_SUPL 4 70 71 #define AGPS_CERTIFICATE_MAX_LENGTH 2000 72 #define AGPS_CERTIFICATE_MAX_SLOTS 10 73 74 enum loc_registration_mask_status { 75 LOC_REGISTRATION_MASK_ENABLED, 76 LOC_REGISTRATION_MASK_DISABLED 77 }; 78 79 typedef struct { 80 /** set to sizeof(UlpLocation) */ 81 size_t size; 82 GpsLocation gpsLocation; 83 /* Provider indicator for HYBRID or GPS */ 84 uint16_t position_source; 85 /*allows HAL to pass additional information related to the location */ 86 int rawDataSize; /* in # of bytes */ 87 void * rawData; 88 bool is_indoor; 89 float floor_number; 90 char map_url[GPS_LOCATION_MAP_URL_SIZE]; 91 unsigned char map_index[GPS_LOCATION_MAP_INDEX_SIZE]; 92 } UlpLocation; 93 94 /** AGPS type */ 95 typedef int16_t AGpsExtType; 96 #define AGPS_TYPE_INVALID -1 97 #define AGPS_TYPE_ANY 0 98 #define AGPS_TYPE_SUPL 1 99 #define AGPS_TYPE_C2K 2 100 #define AGPS_TYPE_WWAN_ANY 3 101 #define AGPS_TYPE_WIFI 4 102 #define AGPS_TYPE_SUPL_ES 5 103 104 /** SSID length */ 105 #define SSID_BUF_SIZE (32+1) 106 107 typedef int16_t AGpsBearerType; 108 #define AGPS_APN_BEARER_INVALID -1 109 #define AGPS_APN_BEARER_IPV4 0 110 #define AGPS_APN_BEARER_IPV6 1 111 #define AGPS_APN_BEARER_IPV4V6 2 112 113 #define GPS_DELETE_ALMANAC_CORR 0x00001000 114 #define GPS_DELETE_FREQ_BIAS_EST 0x00002000 115 #define GPS_DELETE_EPHEMERIS_GLO 0x00004000 116 #define GPS_DELETE_ALMANAC_GLO 0x00008000 117 #define GPS_DELETE_SVDIR_GLO 0x00010000 118 #define GPS_DELETE_SVSTEER_GLO 0x00020000 119 #define GPS_DELETE_ALMANAC_CORR_GLO 0x00040000 120 #define GPS_DELETE_TIME_GPS 0x00080000 121 #define GPS_DELETE_TIME_GLO 0x00100000 122 123 /** GPS extended callback structure. */ 124 typedef struct { 125 /** set to sizeof(GpsCallbacks) */ 126 size_t size; 127 gps_set_capabilities set_capabilities_cb; 128 gps_acquire_wakelock acquire_wakelock_cb; 129 gps_release_wakelock release_wakelock_cb; 130 gps_create_thread create_thread_cb; 131 gps_request_utc_time request_utc_time_cb; 132 } GpsExtCallbacks; 133 134 /** GPS extended batch options */ 135 typedef struct { 136 double max_power_allocation_mW; 137 uint32_t sources_to_use; 138 uint32_t flags; 139 int64_t period_ns; 140 } GpsExtBatchOptions; 141 142 /** Callback to report the xtra server url to the client. 143 * The client should use this url when downloading xtra unless overwritten 144 * in the gps.conf file 145 */ 146 typedef void (* report_xtra_server)(const char*, const char*, const char*); 147 148 /** Callback structure for the XTRA interface. */ 149 typedef struct { 150 gps_xtra_download_request download_request_cb; 151 gps_create_thread create_thread_cb; 152 report_xtra_server report_xtra_server_cb; 153 } GpsXtraExtCallbacks; 154 155 /** Represents the status of AGPS. */ 156 typedef struct { 157 /** set to sizeof(AGpsExtStatus) */ 158 size_t size; 159 160 AGpsExtType type; 161 AGpsStatusValue status; 162 uint32_t ipv4_addr; 163 struct sockaddr_storage addr; 164 char ssid[SSID_BUF_SIZE]; 165 char password[SSID_BUF_SIZE]; 166 } AGpsExtStatus; 167 168 /** Callback with AGPS status information. 169 * Can only be called from a thread created by create_thread_cb. 170 */ 171 typedef void (* agps_status_extended)(AGpsExtStatus* status); 172 173 /** Callback structure for the AGPS interface. */ 174 typedef struct { 175 agps_status_extended status_cb; 176 gps_create_thread create_thread_cb; 177 } AGpsExtCallbacks; 178 179 180 /** GPS NI callback structure. */ 181 typedef struct 182 { 183 /** 184 * Sends the notification request from HAL to GPSLocationProvider. 185 */ 186 gps_ni_notify_callback notify_cb; 187 gps_create_thread create_thread_cb; 188 } GpsNiExtCallbacks; 189 190 typedef enum loc_server_type { 191 LOC_AGPS_CDMA_PDE_SERVER, 192 LOC_AGPS_CUSTOM_PDE_SERVER, 193 LOC_AGPS_MPC_SERVER, 194 LOC_AGPS_SUPL_SERVER 195 } LocServerType; 196 197 typedef enum loc_position_mode_type { 198 LOC_POSITION_MODE_INVALID = -1, 199 LOC_POSITION_MODE_STANDALONE = 0, 200 LOC_POSITION_MODE_MS_BASED, 201 LOC_POSITION_MODE_MS_ASSISTED, 202 LOC_POSITION_MODE_RESERVED_1, 203 LOC_POSITION_MODE_RESERVED_2, 204 LOC_POSITION_MODE_RESERVED_3, 205 LOC_POSITION_MODE_RESERVED_4, 206 LOC_POSITION_MODE_RESERVED_5 207 208 } LocPositionMode; 209 210 #define MIN_POSSIBLE_FIX_INTERVAL 1000 /* msec */ 211 212 /** GpsLocationExtended has valid latitude and longitude. */ 213 #define GPS_LOCATION_EXTENDED_HAS_LAT_LONG (1U<<0) 214 /** GpsLocationExtended has valid altitude. */ 215 #define GPS_LOCATION_EXTENDED_HAS_ALTITUDE (1U<<1) 216 /** GpsLocationExtended has valid speed. */ 217 #define GPS_LOCATION_EXTENDED_HAS_SPEED (1U<<2) 218 /** GpsLocationExtended has valid bearing. */ 219 #define GPS_LOCATION_EXTENDED_HAS_BEARING (1U<<4) 220 /** GpsLocationExtended has valid accuracy. */ 221 #define GPS_LOCATION_EXTENDED_HAS_ACCURACY (1U<<8) 222 223 /** GPS extended supports geofencing */ 224 #define GPS_EXTENDED_CAPABILITY_GEOFENCE 0x0000001 225 /** GPS extended supports batching */ 226 #define GPS_EXTENDED_CAPABILITY_BATCHING 0x0000002 227 228 /** Flags to indicate which values are valid in a GpsLocationExtended. */ 229 typedef uint16_t GpsLocationExtendedFlags; 230 /** GpsLocationExtended has valid pdop, hdop, vdop. */ 231 #define GPS_LOCATION_EXTENDED_HAS_DOP 0x0001 232 /** GpsLocationExtended has valid altitude mean sea level. */ 233 #define GPS_LOCATION_EXTENDED_HAS_ALTITUDE_MEAN_SEA_LEVEL 0x0002 234 /** UlpLocation has valid magnetic deviation. */ 235 #define GPS_LOCATION_EXTENDED_HAS_MAG_DEV 0x0004 236 /** UlpLocation has valid mode indicator. */ 237 #define GPS_LOCATION_EXTENDED_HAS_MODE_IND 0x0008 238 /** GpsLocationExtended has valid vertical uncertainty */ 239 #define GPS_LOCATION_EXTENDED_HAS_VERT_UNC 0x0010 240 /** GpsLocationExtended has valid speed uncertainty */ 241 #define GPS_LOCATION_EXTENDED_HAS_SPEED_UNC 0x0020 242 243 /** Represents gps location extended. */ 244 typedef struct { 245 /** set to sizeof(GpsLocationExtended) */ 246 size_t size; 247 /** Contains GpsLocationExtendedFlags bits. */ 248 uint16_t flags; 249 /** Contains the Altitude wrt mean sea level */ 250 float altitudeMeanSeaLevel; 251 /** Contains Position Dilusion of Precision. */ 252 float pdop; 253 /** Contains Horizontal Dilusion of Precision. */ 254 float hdop; 255 /** Contains Vertical Dilusion of Precision. */ 256 float vdop; 257 /** Contains Magnetic Deviation. */ 258 float magneticDeviation; 259 /** vertical uncertainty in meters */ 260 float vert_unc; 261 /** speed uncertainty in m/s */ 262 float speed_unc; 263 } GpsLocationExtended; 264 265 typedef struct GpsExtLocation_s { 266 size_t size; 267 uint16_t flags; 268 double latitude; 269 double longitude; 270 double altitude; 271 float speed; 272 float bearing; 273 float accuracy; 274 int64_t timestamp; 275 uint32_t sources_used; 276 } GpsExtLocation; 277 278 enum loc_sess_status { 279 LOC_SESS_SUCCESS, 280 LOC_SESS_INTERMEDIATE, 281 LOC_SESS_FAILURE 282 }; 283 284 typedef uint32_t LocPosTechMask; 285 #define LOC_POS_TECH_MASK_DEFAULT ((LocPosTechMask)0x00000000) 286 #define LOC_POS_TECH_MASK_SATELLITE ((LocPosTechMask)0x00000001) 287 #define LOC_POS_TECH_MASK_CELLID ((LocPosTechMask)0x00000002) 288 #define LOC_POS_TECH_MASK_WIFI ((LocPosTechMask)0x00000004) 289 #define LOC_POS_TECH_MASK_SENSORS ((LocPosTechMask)0x00000008) 290 #define LOC_POS_TECH_MASK_REFERENCE_LOCATION ((LocPosTechMask)0x00000010) 291 #define LOC_POS_TECH_MASK_INJECTED_COARSE_POSITION ((LocPosTechMask)0x00000020) 292 #define LOC_POS_TECH_MASK_AFLT ((LocPosTechMask)0x00000040) 293 #define LOC_POS_TECH_MASK_HYBRID ((LocPosTechMask)0x00000080) 294 295 typedef enum { 296 LOC_ENG_IF_REQUEST_SENDER_ID_QUIPC = 0, 297 LOC_ENG_IF_REQUEST_SENDER_ID_MSAPM, 298 LOC_ENG_IF_REQUEST_SENDER_ID_MSAPU, 299 LOC_ENG_IF_REQUEST_SENDER_ID_GPSONE_DAEMON, 300 LOC_ENG_IF_REQUEST_SENDER_ID_MODEM, 301 LOC_ENG_IF_REQUEST_SENDER_ID_UNKNOWN 302 } loc_if_req_sender_id_e_type; 303 304 305 #define smaller_of(a, b) (((a) > (b)) ? (b) : (a)) 306 #define MAX_APN_LEN 100 307 308 // This will be overridden by the individual adapters 309 // if necessary. 310 #define DEFAULT_IMPL(rtv) \ 311 { \ 312 LOC_LOGD("%s: default implementation invoked", __func__); \ 313 return rtv; \ 314 } 315 316 enum loc_api_adapter_err { 317 LOC_API_ADAPTER_ERR_SUCCESS = 0, 318 LOC_API_ADAPTER_ERR_GENERAL_FAILURE = 1, 319 LOC_API_ADAPTER_ERR_UNSUPPORTED = 2, 320 LOC_API_ADAPTER_ERR_INVALID_HANDLE = 4, 321 LOC_API_ADAPTER_ERR_INVALID_PARAMETER = 5, 322 LOC_API_ADAPTER_ERR_ENGINE_BUSY = 6, 323 LOC_API_ADAPTER_ERR_PHONE_OFFLINE = 7, 324 LOC_API_ADAPTER_ERR_TIMEOUT = 8, 325 LOC_API_ADAPTER_ERR_SERVICE_NOT_PRESENT = 9, 326 327 LOC_API_ADAPTER_ERR_ENGINE_DOWN = 100, 328 LOC_API_ADAPTER_ERR_FAILURE, 329 LOC_API_ADAPTER_ERR_UNKNOWN 330 }; 331 332 enum loc_api_adapter_event_index { 333 LOC_API_ADAPTER_REPORT_POSITION = 0, // Position report comes in loc_parsed_position_s_type 334 LOC_API_ADAPTER_REPORT_SATELLITE, // Satellite in view report 335 LOC_API_ADAPTER_REPORT_NMEA_1HZ, // NMEA report at 1HZ rate 336 LOC_API_ADAPTER_REPORT_NMEA_POSITION, // NMEA report at position report rate 337 LOC_API_ADAPTER_REQUEST_NI_NOTIFY_VERIFY, // NI notification/verification request 338 LOC_API_ADAPTER_REQUEST_ASSISTANCE_DATA, // Assistance data, eg: time, predicted orbits request 339 LOC_API_ADAPTER_REQUEST_LOCATION_SERVER, // Request for location server 340 LOC_API_ADAPTER_REPORT_IOCTL, // Callback report for loc_ioctl 341 LOC_API_ADAPTER_REPORT_STATUS, // Misc status report: eg, engine state 342 LOC_API_ADAPTER_REQUEST_WIFI, // 343 LOC_API_ADAPTER_SENSOR_STATUS, // 344 LOC_API_ADAPTER_REQUEST_TIME_SYNC, // 345 LOC_API_ADAPTER_REPORT_SPI, // 346 LOC_API_ADAPTER_REPORT_NI_GEOFENCE, // 347 LOC_API_ADAPTER_GEOFENCE_GEN_ALERT, // 348 LOC_API_ADAPTER_REPORT_GENFENCE_BREACH, // 349 LOC_API_ADAPTER_PEDOMETER_CTRL, // 350 LOC_API_ADAPTER_MOTION_CTRL, // 351 LOC_API_ADAPTER_REQUEST_WIFI_AP_DATA, // Wifi ap data 352 LOC_API_ADAPTER_BATCH_FULL, // Batching on full 353 LOC_API_ADAPTER_BATCHED_POSITION_REPORT, // Batching on fix 354 LOC_API_ADAPTER_BATCHED_GENFENCE_BREACH_REPORT, // 355 LOC_API_ADAPTER_GNSS_MEASUREMENT, // GNSS Measurement report 356 357 LOC_API_ADAPTER_EVENT_MAX 358 }; 359 360 #define LOC_API_ADAPTER_BIT_PARSED_POSITION_REPORT (1<<LOC_API_ADAPTER_REPORT_POSITION) 361 #define LOC_API_ADAPTER_BIT_SATELLITE_REPORT (1<<LOC_API_ADAPTER_REPORT_SATELLITE) 362 #define LOC_API_ADAPTER_BIT_NMEA_1HZ_REPORT (1<<LOC_API_ADAPTER_REPORT_NMEA_1HZ) 363 #define LOC_API_ADAPTER_BIT_NMEA_POSITION_REPORT (1<<LOC_API_ADAPTER_REPORT_NMEA_POSITION) 364 #define LOC_API_ADAPTER_BIT_NI_NOTIFY_VERIFY_REQUEST (1<<LOC_API_ADAPTER_REQUEST_NI_NOTIFY_VERIFY) 365 #define LOC_API_ADAPTER_BIT_ASSISTANCE_DATA_REQUEST (1<<LOC_API_ADAPTER_REQUEST_ASSISTANCE_DATA) 366 #define LOC_API_ADAPTER_BIT_LOCATION_SERVER_REQUEST (1<<LOC_API_ADAPTER_REQUEST_LOCATION_SERVER) 367 #define LOC_API_ADAPTER_BIT_IOCTL_REPORT (1<<LOC_API_ADAPTER_REPORT_IOCTL) 368 #define LOC_API_ADAPTER_BIT_STATUS_REPORT (1<<LOC_API_ADAPTER_REPORT_STATUS) 369 #define LOC_API_ADAPTER_BIT_REQUEST_WIFI (1<<LOC_API_ADAPTER_REQUEST_WIFI) 370 #define LOC_API_ADAPTER_BIT_SENSOR_STATUS (1<<LOC_API_ADAPTER_SENSOR_STATUS) 371 #define LOC_API_ADAPTER_BIT_REQUEST_TIME_SYNC (1<<LOC_API_ADAPTER_REQUEST_TIME_SYNC) 372 #define LOC_API_ADAPTER_BIT_REPORT_SPI (1<<LOC_API_ADAPTER_REPORT_SPI) 373 #define LOC_API_ADAPTER_BIT_REPORT_NI_GEOFENCE (1<<LOC_API_ADAPTER_REPORT_NI_GEOFENCE) 374 #define LOC_API_ADAPTER_BIT_GEOFENCE_GEN_ALERT (1<<LOC_API_ADAPTER_GEOFENCE_GEN_ALERT) 375 #define LOC_API_ADAPTER_BIT_REPORT_GENFENCE_BREACH (1<<LOC_API_ADAPTER_REPORT_GENFENCE_BREACH) 376 #define LOC_API_ADAPTER_BIT_BATCHED_GENFENCE_BREACH_REPORT (1<<LOC_API_ADAPTER_BATCHED_GENFENCE_BREACH_REPORT) 377 #define LOC_API_ADAPTER_BIT_PEDOMETER_CTRL (1<<LOC_API_ADAPTER_PEDOMETER_CTRL) 378 #define LOC_API_ADAPTER_BIT_MOTION_CTRL (1<<LOC_API_ADAPTER_MOTION_CTRL) 379 #define LOC_API_ADAPTER_BIT_REQUEST_WIFI_AP_DATA (1<<LOC_API_ADAPTER_REQUEST_WIFI_AP_DATA) 380 #define LOC_API_ADAPTER_BIT_BATCH_FULL (1<<LOC_API_ADAPTER_BATCH_FULL) 381 #define LOC_API_ADAPTER_BIT_BATCHED_POSITION_REPORT (1<<LOC_API_ADAPTER_BATCHED_POSITION_REPORT) 382 #define LOC_API_ADAPTER_BIT_GNSS_MEASUREMENT (1<<LOC_API_ADAPTER_GNSS_MEASUREMENT) 383 384 typedef unsigned int LOC_API_ADAPTER_EVENT_MASK_T; 385 386 typedef uint32_t LOC_GPS_LOCK_MASK; 387 #define isGpsLockNone(lock) ((lock) == 0) 388 #define isGpsLockMO(lock) ((lock) & ((LOC_GPS_LOCK_MASK)1)) 389 #define isGpsLockMT(lock) ((lock) & ((LOC_GPS_LOCK_MASK)2)) 390 #define isGpsLockAll(lock) (((lock) & ((LOC_GPS_LOCK_MASK)3)) == 3) 391 392 #ifdef __cplusplus 393 } 394 #endif /* __cplusplus */ 395 396 #endif /* GPS_EXTENDED_C_H */ 397 398
