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