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