1 /* Copyright (c) 2017-2018, 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 
30 #ifndef GNSS_API_CLINET_H
31 #define GNSS_API_CLINET_H
32 
33 
34 #include <mutex>
35 #include <android/hardware/gnss/1.0/IGnss.h>
36 #include <android/hardware/gnss/1.0/IGnssCallback.h>
37 #include <android/hardware/gnss/1.0/IGnssNiCallback.h>
38 #include <LocationAPIClientBase.h>
39 
40 namespace android {
41 namespace hardware {
42 namespace gnss {
43 namespace V1_0 {
44 namespace implementation {
45 
46 using ::android::sp;
47 
48 class GnssAPIClient : public LocationAPIClientBase
49 {
50 public:
51     GnssAPIClient(const sp<V1_0::IGnssCallback>& gpsCb,
52             const sp<V1_0::IGnssNiCallback>& niCb);
53     virtual ~GnssAPIClient();
54     GnssAPIClient(const GnssAPIClient&) = delete;
55     GnssAPIClient& operator=(const GnssAPIClient&) = delete;
56 
57     // for GpsInterface
58     void gnssUpdateCallbacks(const sp<V1_0::IGnssCallback>& gpsCb,
59             const sp<V1_0::IGnssNiCallback>& niCb);
60     bool gnssStart();
61     bool gnssStop();
62     bool gnssSetPositionMode(V1_0::IGnss::GnssPositionMode mode,
63             V1_0::IGnss::GnssPositionRecurrence recurrence,
64             uint32_t minIntervalMs,
65             uint32_t preferredAccuracyMeters,
66             uint32_t preferredTimeMs,
67             GnssPowerMode powerMode = GNSS_POWER_MODE_INVALID,
68             uint32_t timeBetweenMeasurement = 0);
69 
70     // for GpsNiInterface
71     void gnssNiRespond(int32_t notifId, V1_0::IGnssNiCallback::GnssUserResponseType userResponse);
72 
73     // these apis using LocationAPIControlClient
74     void gnssDeleteAidingData(V1_0::IGnss::GnssAidingData aidingDataFlags);
75     void gnssEnable(LocationTechnologyType techType);
76     void gnssDisable();
77     void gnssConfigurationUpdate(const GnssConfig& gnssConfig);
78 
gnssGetCapabilities()79     inline LocationCapabilitiesMask gnssGetCapabilities() const {
80         return mLocationCapabilitiesMask;
81     }
82     void requestCapabilities();
83 
84     // callbacks we are interested in
85     void onCapabilitiesCb(LocationCapabilitiesMask capabilitiesMask) final;
86     void onTrackingCb(Location location) final;
87     void onGnssNiCb(uint32_t id, GnssNiNotification gnssNiNotification) final;
88     void onGnssSvCb(GnssSvNotification gnssSvNotification) final;
89     void onGnssNmeaCb(GnssNmeaNotification gnssNmeaNotification) final;
90 
91     void onStartTrackingCb(LocationError error) final;
92     void onStopTrackingCb(LocationError error) final;
93 
94 private:
95     sp<V1_0::IGnssCallback> mGnssCbIface;
96     sp<V1_0::IGnssNiCallback> mGnssNiCbIface;
97     std::mutex mMutex;
98     LocationAPIControlClient* mControlClient;
99     LocationCapabilitiesMask mLocationCapabilitiesMask;
100     bool mLocationCapabilitiesCached;
101     TrackingOptions mTrackingOptions;
102 };
103 
104 }  // namespace implementation
105 }  // namespace V1_0
106 }  // namespace gnss
107 }  // namespace hardware
108 }  // namespace android
109 #endif // GNSS_API_CLINET_H
110