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 typedef struct { 75 /** set to sizeof(UlpLocation) */ 76 size_t size; 77 GpsLocation gpsLocation; 78 /* Provider indicator for HYBRID or GPS */ 79 uint16_t position_source; 80 /*allows HAL to pass additional information related to the location */ 81 int rawDataSize; /* in # of bytes */ 82 void * rawData; 83 bool is_indoor; 84 float floor_number; 85 char map_url[GPS_LOCATION_MAP_URL_SIZE]; 86 unsigned char map_index[GPS_LOCATION_MAP_INDEX_SIZE]; 87 } UlpLocation; 88 89 /** AGPS type */ 90 typedef int16_t AGpsExtType; 91 #define AGPS_TYPE_INVALID -1 92 #define AGPS_TYPE_ANY 0 93 #define AGPS_TYPE_SUPL 1 94 #define AGPS_TYPE_C2K 2 95 #define AGPS_TYPE_WWAN_ANY 3 96 #define AGPS_TYPE_WIFI 4 97 #define AGPS_TYPE_SUPL_ES 5 98 99 /** SSID length */ 100 #define SSID_BUF_SIZE (32+1) 101 102 typedef int16_t AGpsBearerType; 103 #define AGPS_APN_BEARER_INVALID -1 104 #define AGPS_APN_BEARER_IPV4 0 105 #define AGPS_APN_BEARER_IPV6 1 106 #define AGPS_APN_BEARER_IPV4V6 2 107 108 #define GPS_DELETE_ALMANAC_CORR 0x00001000 109 #define GPS_DELETE_FREQ_BIAS_EST 0x00002000 110 #define GPS_DELETE_EPHEMERIS_GLO 0x00004000 111 #define GPS_DELETE_ALMANAC_GLO 0x00008000 112 #define GPS_DELETE_SVDIR_GLO 0x00010000 113 #define GPS_DELETE_SVSTEER_GLO 0x00020000 114 #define GPS_DELETE_ALMANAC_CORR_GLO 0x00040000 115 #define GPS_DELETE_TIME_GPS 0x00080000 116 #define GPS_DELETE_TIME_GLO 0x00100000 117 118 /** GPS extended callback structure. */ 119 typedef struct { 120 /** set to sizeof(GpsCallbacks) */ 121 size_t size; 122 gps_set_capabilities set_capabilities_cb; 123 gps_acquire_wakelock acquire_wakelock_cb; 124 gps_release_wakelock release_wakelock_cb; 125 gps_create_thread create_thread_cb; 126 gps_request_utc_time request_utc_time_cb; 127 } GpsExtCallbacks; 128 129 /** GPS extended batch options */ 130 typedef struct { 131 double max_power_allocation_mW; 132 uint32_t sources_to_use; 133 uint32_t flags; 134 int64_t period_ns; 135 } GpsExtBatchOptions; 136 137 /** Callback to report the xtra server url to the client. 138 * The client should use this url when downloading xtra unless overwritten 139 * in the gps.conf file 140 */ 141 typedef void (* report_xtra_server)(const char*, const char*, const char*); 142 143 /** Callback structure for the XTRA interface. */ 144 typedef struct { 145 gps_xtra_download_request download_request_cb; 146 gps_create_thread create_thread_cb; 147 report_xtra_server report_xtra_server_cb; 148 } GpsXtraExtCallbacks; 149 150 /** Represents the status of AGPS. */ 151 typedef struct { 152 /** set to sizeof(AGpsExtStatus) */ 153 size_t size; 154 155 AGpsExtType type; 156 AGpsStatusValue status; 157 uint32_t ipv4_addr; 158 struct sockaddr_storage addr; 159 char ssid[SSID_BUF_SIZE]; 160 char password[SSID_BUF_SIZE]; 161 } AGpsExtStatus; 162 163 /** Callback with AGPS status information. 164 * Can only be called from a thread created by create_thread_cb. 165 */ 166 typedef void (* agps_status_extended)(AGpsExtStatus* status); 167 168 /** Callback structure for the AGPS interface. */ 169 typedef struct { 170 agps_status_extended status_cb; 171 gps_create_thread create_thread_cb; 172 } AGpsExtCallbacks; 173 174 175 /** GPS NI callback structure. */ 176 typedef struct 177 { 178 /** 179 * Sends the notification request from HAL to GPSLocationProvider. 180 */ 181 gps_ni_notify_callback notify_cb; 182 gps_create_thread create_thread_cb; 183 } GpsNiExtCallbacks; 184 185 typedef enum loc_server_type { 186 LOC_AGPS_CDMA_PDE_SERVER, 187 LOC_AGPS_CUSTOM_PDE_SERVER, 188 LOC_AGPS_MPC_SERVER, 189 LOC_AGPS_SUPL_SERVER 190 } LocServerType; 191 192 typedef enum loc_position_mode_type { 193 LOC_POSITION_MODE_INVALID = -1, 194 LOC_POSITION_MODE_STANDALONE = 0, 195 LOC_POSITION_MODE_MS_BASED, 196 LOC_POSITION_MODE_MS_ASSISTED, 197 LOC_POSITION_MODE_RESERVED_1, 198 LOC_POSITION_MODE_RESERVED_2, 199 LOC_POSITION_MODE_RESERVED_3, 200 LOC_POSITION_MODE_RESERVED_4, 201 LOC_POSITION_MODE_RESERVED_5 202 203 } LocPositionMode; 204 205 #define MIN_POSSIBLE_FIX_INTERVAL 1000 /* msec */ 206 207 /** GpsLocationExtended has valid latitude and longitude. */ 208 #define GPS_LOCATION_EXTENDED_HAS_LAT_LONG (1U<<0) 209 /** GpsLocationExtended has valid altitude. */ 210 #define GPS_LOCATION_EXTENDED_HAS_ALTITUDE (1U<<1) 211 /** GpsLocationExtended has valid speed. */ 212 #define GPS_LOCATION_EXTENDED_HAS_SPEED (1U<<2) 213 /** GpsLocationExtended has valid bearing. */ 214 #define GPS_LOCATION_EXTENDED_HAS_BEARING (1U<<4) 215 /** GpsLocationExtended has valid accuracy. */ 216 #define GPS_LOCATION_EXTENDED_HAS_ACCURACY (1U<<8) 217 218 /** GPS extended supports geofencing */ 219 #define GPS_EXTENDED_CAPABILITY_GEOFENCE 0x0000001 220 /** GPS extended supports batching */ 221 #define GPS_EXTENDED_CAPABILITY_BATCHING 0x0000002 222 223 /** Flags to indicate which values are valid in a GpsLocationExtended. */ 224 typedef uint16_t GpsLocationExtendedFlags; 225 /** GpsLocationExtended has valid pdop, hdop, vdop. */ 226 #define GPS_LOCATION_EXTENDED_HAS_DOP 0x0001 227 /** GpsLocationExtended has valid altitude mean sea level. */ 228 #define GPS_LOCATION_EXTENDED_HAS_ALTITUDE_MEAN_SEA_LEVEL 0x0002 229 /** UlpLocation has valid magnetic deviation. */ 230 #define GPS_LOCATION_EXTENDED_HAS_MAG_DEV 0x0004 231 /** UlpLocation has valid mode indicator. */ 232 #define GPS_LOCATION_EXTENDED_HAS_MODE_IND 0x0008 233 /** GpsLocationExtended has valid vertical uncertainty */ 234 #define GPS_LOCATION_EXTENDED_HAS_VERT_UNC 0x0010 235 /** GpsLocationExtended has valid speed uncertainty */ 236 #define GPS_LOCATION_EXTENDED_HAS_SPEED_UNC 0x0020 237 238 /** Represents gps location extended. */ 239 typedef struct { 240 /** set to sizeof(GpsLocationExtended) */ 241 size_t size; 242 /** Contains GpsLocationExtendedFlags bits. */ 243 uint16_t flags; 244 /** Contains the Altitude wrt mean sea level */ 245 float altitudeMeanSeaLevel; 246 /** Contains Position Dilusion of Precision. */ 247 float pdop; 248 /** Contains Horizontal Dilusion of Precision. */ 249 float hdop; 250 /** Contains Vertical Dilusion of Precision. */ 251 float vdop; 252 /** Contains Magnetic Deviation. */ 253 float magneticDeviation; 254 /** vertical uncertainty in meters */ 255 float vert_unc; 256 /** speed uncertainty in m/s */ 257 float speed_unc; 258 } GpsLocationExtended; 259 260 typedef struct GpsExtLocation_s { 261 size_t size; 262 uint16_t flags; 263 double latitude; 264 double longitude; 265 double altitude; 266 float speed; 267 float bearing; 268 float accuracy; 269 int64_t timestamp; 270 uint32_t sources_used; 271 } GpsExtLocation; 272 273 enum loc_sess_status { 274 LOC_SESS_SUCCESS, 275 LOC_SESS_INTERMEDIATE, 276 LOC_SESS_FAILURE 277 }; 278 279 typedef uint32_t LocPosTechMask; 280 #define LOC_POS_TECH_MASK_DEFAULT ((LocPosTechMask)0x00000000) 281 #define LOC_POS_TECH_MASK_SATELLITE ((LocPosTechMask)0x00000001) 282 #define LOC_POS_TECH_MASK_CELLID ((LocPosTechMask)0x00000002) 283 #define LOC_POS_TECH_MASK_WIFI ((LocPosTechMask)0x00000004) 284 #define LOC_POS_TECH_MASK_SENSORS ((LocPosTechMask)0x00000008) 285 #define LOC_POS_TECH_MASK_REFERENCE_LOCATION ((LocPosTechMask)0x00000010) 286 #define LOC_POS_TECH_MASK_INJECTED_COARSE_POSITION ((LocPosTechMask)0x00000020) 287 #define LOC_POS_TECH_MASK_AFLT ((LocPosTechMask)0x00000040) 288 #define LOC_POS_TECH_MASK_HYBRID ((LocPosTechMask)0x00000080) 289 290 typedef enum { 291 LOC_ENG_IF_REQUEST_SENDER_ID_QUIPC = 0, 292 LOC_ENG_IF_REQUEST_SENDER_ID_MSAPM, 293 LOC_ENG_IF_REQUEST_SENDER_ID_MSAPU, 294 LOC_ENG_IF_REQUEST_SENDER_ID_GPSONE_DAEMON, 295 LOC_ENG_IF_REQUEST_SENDER_ID_MODEM, 296 LOC_ENG_IF_REQUEST_SENDER_ID_UNKNOWN 297 } loc_if_req_sender_id_e_type; 298 299 300 #define smaller_of(a, b) (((a) > (b)) ? (b) : (a)) 301 #define MAX_APN_LEN 100 302 303 // This will be overridden by the individual adapters 304 // if necessary. 305 #define DEFAULT_IMPL(rtv) \ 306 { \ 307 LOC_LOGD("%s: default implementation invoked", __func__); \ 308 return rtv; \ 309 } 310 311 enum loc_api_adapter_err { 312 LOC_API_ADAPTER_ERR_SUCCESS = 0, 313 LOC_API_ADAPTER_ERR_GENERAL_FAILURE = 1, 314 LOC_API_ADAPTER_ERR_UNSUPPORTED = 2, 315 LOC_API_ADAPTER_ERR_INVALID_HANDLE = 4, 316 LOC_API_ADAPTER_ERR_INVALID_PARAMETER = 5, 317 LOC_API_ADAPTER_ERR_ENGINE_BUSY = 6, 318 LOC_API_ADAPTER_ERR_PHONE_OFFLINE = 7, 319 LOC_API_ADAPTER_ERR_TIMEOUT = 8, 320 LOC_API_ADAPTER_ERR_SERVICE_NOT_PRESENT = 9, 321 322 LOC_API_ADAPTER_ERR_ENGINE_DOWN = 100, 323 LOC_API_ADAPTER_ERR_FAILURE, 324 LOC_API_ADAPTER_ERR_UNKNOWN 325 }; 326 327 enum loc_api_adapter_event_index { 328 LOC_API_ADAPTER_REPORT_POSITION = 0, // Position report comes in loc_parsed_position_s_type 329 LOC_API_ADAPTER_REPORT_SATELLITE, // Satellite in view report 330 LOC_API_ADAPTER_REPORT_NMEA_1HZ, // NMEA report at 1HZ rate 331 LOC_API_ADAPTER_REPORT_NMEA_POSITION, // NMEA report at position report rate 332 LOC_API_ADAPTER_REQUEST_NI_NOTIFY_VERIFY, // NI notification/verification request 333 LOC_API_ADAPTER_REQUEST_ASSISTANCE_DATA, // Assistance data, eg: time, predicted orbits request 334 LOC_API_ADAPTER_REQUEST_LOCATION_SERVER, // Request for location server 335 LOC_API_ADAPTER_REPORT_IOCTL, // Callback report for loc_ioctl 336 LOC_API_ADAPTER_REPORT_STATUS, // Misc status report: eg, engine state 337 LOC_API_ADAPTER_REQUEST_WIFI, // 338 LOC_API_ADAPTER_SENSOR_STATUS, // 339 LOC_API_ADAPTER_REQUEST_TIME_SYNC, // 340 LOC_API_ADAPTER_REPORT_SPI, // 341 LOC_API_ADAPTER_REPORT_NI_GEOFENCE, // 342 LOC_API_ADAPTER_GEOFENCE_GEN_ALERT, // 343 LOC_API_ADAPTER_REPORT_GENFENCE_BREACH, // 344 LOC_API_ADAPTER_PEDOMETER_CTRL, // 345 LOC_API_ADAPTER_MOTION_CTRL, // 346 LOC_API_ADAPTER_REQUEST_WIFI_AP_DATA, // Wifi ap data 347 LOC_API_ADAPTER_BATCH_FULL, // Batching on full 348 LOC_API_ADAPTER_BATCHED_POSITION_REPORT, // Batching on fix 349 LOC_API_ADAPTER_BATCHED_GENFENCE_BREACH_REPORT, // 350 351 LOC_API_ADAPTER_EVENT_MAX 352 }; 353 354 #define LOC_API_ADAPTER_BIT_PARSED_POSITION_REPORT (1<<LOC_API_ADAPTER_REPORT_POSITION) 355 #define LOC_API_ADAPTER_BIT_SATELLITE_REPORT (1<<LOC_API_ADAPTER_REPORT_SATELLITE) 356 #define LOC_API_ADAPTER_BIT_NMEA_1HZ_REPORT (1<<LOC_API_ADAPTER_REPORT_NMEA_1HZ) 357 #define LOC_API_ADAPTER_BIT_NMEA_POSITION_REPORT (1<<LOC_API_ADAPTER_REPORT_NMEA_POSITION) 358 #define LOC_API_ADAPTER_BIT_NI_NOTIFY_VERIFY_REQUEST (1<<LOC_API_ADAPTER_REQUEST_NI_NOTIFY_VERIFY) 359 #define LOC_API_ADAPTER_BIT_ASSISTANCE_DATA_REQUEST (1<<LOC_API_ADAPTER_REQUEST_ASSISTANCE_DATA) 360 #define LOC_API_ADAPTER_BIT_LOCATION_SERVER_REQUEST (1<<LOC_API_ADAPTER_REQUEST_LOCATION_SERVER) 361 #define LOC_API_ADAPTER_BIT_IOCTL_REPORT (1<<LOC_API_ADAPTER_REPORT_IOCTL) 362 #define LOC_API_ADAPTER_BIT_STATUS_REPORT (1<<LOC_API_ADAPTER_REPORT_STATUS) 363 #define LOC_API_ADAPTER_BIT_REQUEST_WIFI (1<<LOC_API_ADAPTER_REQUEST_WIFI) 364 #define LOC_API_ADAPTER_BIT_SENSOR_STATUS (1<<LOC_API_ADAPTER_SENSOR_STATUS) 365 #define LOC_API_ADAPTER_BIT_REQUEST_TIME_SYNC (1<<LOC_API_ADAPTER_REQUEST_TIME_SYNC) 366 #define LOC_API_ADAPTER_BIT_REPORT_SPI (1<<LOC_API_ADAPTER_REPORT_SPI) 367 #define LOC_API_ADAPTER_BIT_REPORT_NI_GEOFENCE (1<<LOC_API_ADAPTER_REPORT_NI_GEOFENCE) 368 #define LOC_API_ADAPTER_BIT_GEOFENCE_GEN_ALERT (1<<LOC_API_ADAPTER_GEOFENCE_GEN_ALERT) 369 #define LOC_API_ADAPTER_BIT_REPORT_GENFENCE_BREACH (1<<LOC_API_ADAPTER_REPORT_GENFENCE_BREACH) 370 #define LOC_API_ADAPTER_BIT_BATCHED_GENFENCE_BREACH_REPORT (1<<LOC_API_ADAPTER_BATCHED_GENFENCE_BREACH_REPORT) 371 #define LOC_API_ADAPTER_BIT_PEDOMETER_CTRL (1<<LOC_API_ADAPTER_PEDOMETER_CTRL) 372 #define LOC_API_ADAPTER_BIT_MOTION_CTRL (1<<LOC_API_ADAPTER_MOTION_CTRL) 373 #define LOC_API_ADAPTER_BIT_REQUEST_WIFI_AP_DATA (1<<LOC_API_ADAPTER_REQUEST_WIFI_AP_DATA) 374 #define LOC_API_ADAPTER_BIT_BATCH_FULL (1<<LOC_API_ADAPTER_BATCH_FULL) 375 #define LOC_API_ADAPTER_BIT_BATCHED_POSITION_REPORT (1<<LOC_API_ADAPTER_BATCHED_POSITION_REPORT) 376 377 typedef unsigned int LOC_API_ADAPTER_EVENT_MASK_T; 378 379 typedef uint32_t LOC_GPS_LOCK_MASK; 380 #define isGpsLockNone(lock) ((lock) == 0) 381 #define isGpsLockMO(lock) ((lock) & ((LOC_GPS_LOCK_MASK)1)) 382 #define isGpsLockMT(lock) ((lock) & ((LOC_GPS_LOCK_MASK)2)) 383 #define isGpsLockAll(lock) (((lock) & ((LOC_GPS_LOCK_MASK)3)) == 3) 384 385 #ifdef __cplusplus 386 } 387 #endif /* __cplusplus */ 388 389 #endif /* GPS_EXTENDED_C_H */ 390 391