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