1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
|
/*
* Copyright (C) 2013 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.android.server.location;
import android.hardware.location.GeofenceHardware;
import android.hardware.location.GeofenceHardwareImpl;
import android.hardware.location.GeofenceHardwareRequestParcelable;
import android.hardware.location.IFusedLocationHardware;
import android.hardware.location.IFusedLocationHardwareSink;
import android.location.IFusedGeofenceHardware;
import android.location.FusedBatchOptions;
import android.location.Location;
import android.location.LocationListener;
import android.location.LocationManager;
import android.location.LocationRequest;
import android.content.Context;
import android.os.Bundle;
import android.os.Looper;
import android.os.RemoteException;
import android.os.SystemClock;
import android.util.Log;
/**
* This class is an interop layer for JVM types and the JNI code that interacts
* with the FLP HAL implementation.
*
* {@hide}
*/
public class FlpHardwareProvider {
private GeofenceHardwareImpl mGeofenceHardwareSink = null;
private IFusedLocationHardwareSink mLocationSink = null;
// Capabilities provided by FlpCallbacks
private boolean mHaveBatchingCapabilities;
private int mBatchingCapabilities;
private static FlpHardwareProvider sSingletonInstance = null;
private final static String TAG = "FlpHardwareProvider";
private final Context mContext;
private final Object mLocationSinkLock = new Object();
// FlpHal result codes, they must be equal to the ones in fused_location.h
private static final int FLP_RESULT_SUCCESS = 0;
private static final int FLP_RESULT_ERROR = -1;
private static final int FLP_RESULT_INSUFFICIENT_MEMORY = -2;
private static final int FLP_RESULT_TOO_MANY_GEOFENCES = -3;
private static final int FLP_RESULT_ID_EXISTS = -4;
private static final int FLP_RESULT_ID_UNKNOWN = -5;
private static final int FLP_RESULT_INVALID_GEOFENCE_TRANSITION = -6;
// FlpHal monitor status codes, they must be equal to the ones in fused_location.h
private static final int FLP_GEOFENCE_MONITOR_STATUS_UNAVAILABLE = 1<<0;
private static final int FLP_GEOFENCE_MONITOR_STATUS_AVAILABLE = 1<<1;
public static FlpHardwareProvider getInstance(Context context) {
if (sSingletonInstance == null) {
sSingletonInstance = new FlpHardwareProvider(context);
sSingletonInstance.nativeInit();
}
return sSingletonInstance;
}
private FlpHardwareProvider(Context context) {
mContext = context;
// register for listening for passive provider data
LocationManager manager = (LocationManager) mContext.getSystemService(
Context.LOCATION_SERVICE);
final long minTime = 0;
final float minDistance = 0;
final boolean oneShot = false;
LocationRequest request = LocationRequest.createFromDeprecatedProvider(
LocationManager.PASSIVE_PROVIDER,
minTime,
minDistance,
oneShot);
// Don't keep track of this request since it's done on behalf of other clients
// (which are kept track of separately).
request.setHideFromAppOps(true);
manager.requestLocationUpdates(
request,
new NetworkLocationListener(),
Looper.myLooper());
}
public static boolean isSupported() {
return nativeIsSupported();
}
/**
* Private callback functions used by FLP HAL.
*/
// FlpCallbacks members
private void onLocationReport(Location[] locations) {
for (Location location : locations) {
location.setProvider(LocationManager.FUSED_PROVIDER);
// set the elapsed time-stamp just as GPS provider does
location.setElapsedRealtimeNanos(SystemClock.elapsedRealtimeNanos());
}
IFusedLocationHardwareSink sink;
synchronized (mLocationSinkLock) {
sink = mLocationSink;
}
try {
if (sink != null) {
sink.onLocationAvailable(locations);
}
} catch (RemoteException e) {
Log.e(TAG, "RemoteException calling onLocationAvailable");
}
}
private void onBatchingCapabilities(int capabilities) {
synchronized (mLocationSinkLock) {
mHaveBatchingCapabilities = true;
mBatchingCapabilities = capabilities;
}
maybeSendCapabilities();
}
private void onBatchingStatus(int status) {
IFusedLocationHardwareSink sink;
synchronized (mLocationSinkLock) {
sink = mLocationSink;
}
try {
if (sink != null) {
sink.onStatusChanged(status);
}
} catch (RemoteException e) {
Log.e(TAG, "RemoteException calling onBatchingStatus");
}
}
private void maybeSendCapabilities() {
IFusedLocationHardwareSink sink;
boolean haveBatchingCapabilities;
int batchingCapabilities;
synchronized (mLocationSinkLock) {
sink = mLocationSink;
haveBatchingCapabilities = mHaveBatchingCapabilities;
batchingCapabilities = mBatchingCapabilities;
}
try {
if (sink != null && haveBatchingCapabilities) {
sink.onCapabilities(batchingCapabilities);
}
} catch (RemoteException e) {
Log.e(TAG, "RemoteException calling onLocationAvailable");
}
}
// FlpDiagnosticCallbacks members
private void onDataReport(String data) {
IFusedLocationHardwareSink sink;
synchronized (mLocationSinkLock) {
sink = mLocationSink;
}
try {
if (mLocationSink != null) {
sink.onDiagnosticDataAvailable(data);
}
} catch (RemoteException e) {
Log.e(TAG, "RemoteException calling onDiagnosticDataAvailable");
}
}
// FlpGeofenceCallbacks members
private void onGeofenceTransition(
int geofenceId,
Location location,
int transition,
long timestamp,
int sourcesUsed) {
// the transition Id does not require translation because the values in fused_location.h
// and GeofenceHardware are in sync
getGeofenceHardwareSink().reportGeofenceTransition(
geofenceId,
updateLocationInformation(location),
transition,
timestamp,
GeofenceHardware.MONITORING_TYPE_FUSED_HARDWARE,
sourcesUsed);
}
private void onGeofenceMonitorStatus(int status, int source, Location location) {
// allow the location to be optional in this event
Location updatedLocation = null;
if(location != null) {
updatedLocation = updateLocationInformation(location);
}
int monitorStatus;
switch (status) {
case FLP_GEOFENCE_MONITOR_STATUS_UNAVAILABLE:
monitorStatus = GeofenceHardware.MONITOR_CURRENTLY_UNAVAILABLE;
break;
case FLP_GEOFENCE_MONITOR_STATUS_AVAILABLE:
monitorStatus = GeofenceHardware.MONITOR_CURRENTLY_AVAILABLE;
break;
default:
Log.e(TAG, "Invalid FlpHal Geofence monitor status: " + status);
monitorStatus = GeofenceHardware.MONITOR_CURRENTLY_UNAVAILABLE;
break;
}
getGeofenceHardwareSink().reportGeofenceMonitorStatus(
GeofenceHardware.MONITORING_TYPE_FUSED_HARDWARE,
monitorStatus,
updatedLocation,
source);
}
private void onGeofenceAdd(int geofenceId, int result) {
getGeofenceHardwareSink().reportGeofenceAddStatus(
geofenceId,
translateToGeofenceHardwareStatus(result));
}
private void onGeofenceRemove(int geofenceId, int result) {
getGeofenceHardwareSink().reportGeofenceRemoveStatus(
geofenceId,
translateToGeofenceHardwareStatus(result));
}
private void onGeofencePause(int geofenceId, int result) {
getGeofenceHardwareSink().reportGeofencePauseStatus(
geofenceId,
translateToGeofenceHardwareStatus(result));
}
private void onGeofenceResume(int geofenceId, int result) {
getGeofenceHardwareSink().reportGeofenceResumeStatus(
geofenceId,
translateToGeofenceHardwareStatus(result));
}
private void onGeofencingCapabilities(int capabilities) {
getGeofenceHardwareSink().onCapabilities(capabilities);
}
/**
* Private native methods accessing FLP HAL.
*/
static { nativeClassInit(); }
// Core members
private static native void nativeClassInit();
private static native boolean nativeIsSupported();
// FlpLocationInterface members
private native void nativeInit();
private native int nativeGetBatchSize();
private native void nativeStartBatching(int requestId, FusedBatchOptions options);
private native void nativeUpdateBatchingOptions(int requestId, FusedBatchOptions optionsObject);
private native void nativeStopBatching(int id);
private native void nativeRequestBatchedLocation(int lastNLocations);
private native void nativeFlushBatchedLocations();
private native void nativeInjectLocation(Location location);
// TODO [Fix] sort out the lifetime of the instance
private native void nativeCleanup();
// FlpDiagnosticsInterface members
private native boolean nativeIsDiagnosticSupported();
private native void nativeInjectDiagnosticData(String data);
// FlpDeviceContextInterface members
private native boolean nativeIsDeviceContextSupported();
private native void nativeInjectDeviceContext(int deviceEnabledContext);
// FlpGeofencingInterface members
private native boolean nativeIsGeofencingSupported();
private native void nativeAddGeofences(
GeofenceHardwareRequestParcelable[] geofenceRequestsArray);
private native void nativePauseGeofence(int geofenceId);
private native void nativeResumeGeofence(int geofenceId, int monitorTransitions);
private native void nativeModifyGeofenceOption(
int geofenceId,
int lastTransition,
int monitorTransitions,
int notificationResponsiveness,
int unknownTimer,
int sourcesToUse);
private native void nativeRemoveGeofences(int[] geofenceIdsArray);
/**
* Interface implementations for services built on top of this functionality.
*/
public static final String LOCATION = "Location";
public static final String GEOFENCING = "Geofencing";
public IFusedLocationHardware getLocationHardware() {
return mLocationHardware;
}
public IFusedGeofenceHardware getGeofenceHardware() {
return mGeofenceHardwareService;
}
private final IFusedLocationHardware mLocationHardware = new IFusedLocationHardware.Stub() {
@Override
public void registerSink(IFusedLocationHardwareSink eventSink) {
synchronized (mLocationSinkLock) {
// only one sink is allowed at the moment
if (mLocationSink != null) {
Log.e(TAG, "Replacing an existing IFusedLocationHardware sink");
}
mLocationSink = eventSink;
}
maybeSendCapabilities();
}
@Override
public void unregisterSink(IFusedLocationHardwareSink eventSink) {
synchronized (mLocationSinkLock) {
// don't throw if the sink is not registered, simply make it a no-op
if (mLocationSink == eventSink) {
mLocationSink = null;
}
}
}
@Override
public int getSupportedBatchSize() {
return nativeGetBatchSize();
}
@Override
public void startBatching(int requestId, FusedBatchOptions options) {
nativeStartBatching(requestId, options);
}
@Override
public void stopBatching(int requestId) {
nativeStopBatching(requestId);
}
@Override
public void updateBatchingOptions(int requestId, FusedBatchOptions options) {
nativeUpdateBatchingOptions(requestId, options);
}
@Override
public void requestBatchOfLocations(int batchSizeRequested) {
nativeRequestBatchedLocation(batchSizeRequested);
}
@Override
public void flushBatchedLocations() {
nativeFlushBatchedLocations();
}
@Override
public boolean supportsDiagnosticDataInjection() {
return nativeIsDiagnosticSupported();
}
@Override
public void injectDiagnosticData(String data) {
nativeInjectDiagnosticData(data);
}
@Override
public boolean supportsDeviceContextInjection() {
return nativeIsDeviceContextSupported();
}
@Override
public void injectDeviceContext(int deviceEnabledContext) {
nativeInjectDeviceContext(deviceEnabledContext);
}
};
private final IFusedGeofenceHardware mGeofenceHardwareService =
new IFusedGeofenceHardware.Stub() {
@Override
public boolean isSupported() {
return nativeIsGeofencingSupported();
}
@Override
public void addGeofences(GeofenceHardwareRequestParcelable[] geofenceRequestsArray) {
nativeAddGeofences(geofenceRequestsArray);
}
@Override
public void removeGeofences(int[] geofenceIds) {
nativeRemoveGeofences(geofenceIds);
}
@Override
public void pauseMonitoringGeofence(int geofenceId) {
nativePauseGeofence(geofenceId);
}
@Override
public void resumeMonitoringGeofence(int geofenceId, int monitorTransitions) {
nativeResumeGeofence(geofenceId, monitorTransitions);
}
@Override
public void modifyGeofenceOptions(int geofenceId,
int lastTransition,
int monitorTransitions,
int notificationResponsiveness,
int unknownTimer,
int sourcesToUse) {
nativeModifyGeofenceOption(
geofenceId,
lastTransition,
monitorTransitions,
notificationResponsiveness,
unknownTimer,
sourcesToUse);
}
};
/**
* Internal classes and functions used by the provider.
*/
private final class NetworkLocationListener implements LocationListener {
@Override
public void onLocationChanged(Location location) {
if (
!LocationManager.NETWORK_PROVIDER.equals(location.getProvider()) ||
!location.hasAccuracy()
) {
return;
}
nativeInjectLocation(location);
}
@Override
public void onStatusChanged(String provider, int status, Bundle extras) { }
@Override
public void onProviderEnabled(String provider) { }
@Override
public void onProviderDisabled(String provider) { }
}
private GeofenceHardwareImpl getGeofenceHardwareSink() {
if (mGeofenceHardwareSink == null) {
mGeofenceHardwareSink = GeofenceHardwareImpl.getInstance(mContext);
}
return mGeofenceHardwareSink;
}
private static int translateToGeofenceHardwareStatus(int flpHalResult) {
switch(flpHalResult) {
case FLP_RESULT_SUCCESS:
return GeofenceHardware.GEOFENCE_SUCCESS;
case FLP_RESULT_ERROR:
return GeofenceHardware.GEOFENCE_FAILURE;
case FLP_RESULT_INSUFFICIENT_MEMORY:
return GeofenceHardware.GEOFENCE_ERROR_INSUFFICIENT_MEMORY;
case FLP_RESULT_TOO_MANY_GEOFENCES:
return GeofenceHardware.GEOFENCE_ERROR_TOO_MANY_GEOFENCES;
case FLP_RESULT_ID_EXISTS:
return GeofenceHardware.GEOFENCE_ERROR_ID_EXISTS;
case FLP_RESULT_ID_UNKNOWN:
return GeofenceHardware.GEOFENCE_ERROR_ID_UNKNOWN;
case FLP_RESULT_INVALID_GEOFENCE_TRANSITION:
return GeofenceHardware.GEOFENCE_ERROR_INVALID_TRANSITION;
default:
Log.e(TAG, String.format("Invalid FlpHal result code: %d", flpHalResult));
return GeofenceHardware.GEOFENCE_FAILURE;
}
}
private Location updateLocationInformation(Location location) {
location.setProvider(LocationManager.FUSED_PROVIDER);
// set the elapsed time-stamp just as GPS provider does
location.setElapsedRealtimeNanos(SystemClock.elapsedRealtimeNanos());
return location;
}
}
|