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