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