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