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