Merge lp:~thomas-voss/location-service/add-quirk-handling-for-gps-drivers into lp:location-service/15.04

[Thomas Voß]

Add handling of driver-specific quirks.

Add handling of driver-specific quirks.

Unmerged revisions

216. By Thomas Voß on 2016-01-25

Add handling of driver-specific quirks.

=== modified file 'src/location_service/com/ubuntu/location/providers/gps/android_hardware_abstraction_layer.cpp'
--- src/location_service/com/ubuntu/location/providers/gps/android_hardware_abstraction_layer.cpp	2015-11-13 10:19:29 +0000
+++ src/location_service/com/ubuntu/location/providers/gps/android_hardware_abstraction_layer.cpp	2016-01-25 16:17:56 +0000
@@ -30,10 +30,13 @@
 
 #include <com/ubuntu/location/connectivity/manager.h>
 
+#include <core/posix/this_process.h>
+
 #include <boost/property_tree/ini_parser.hpp>
 
 #include <random>
 
+namespace env = core::posix::this_process::env;
 namespace gps = com::ubuntu::location::providers::gps;
 namespace android = com::ubuntu::location::providers::gps::android;
 
@@ -328,7 +331,7 @@
     if (thiz->impl.utc_time_request_handler)
     {
         thiz->impl.utc_time_request_handler();
-    } else
+    } else if (not thiz->impl.quirks.avoid_reference_time_injection)
     {
         auto now = location::Clock::now().time_since_epoch();
         auto ms_since_epoch = std::chrono::duration_cast<std::chrono::milliseconds>(now);
@@ -515,6 +518,9 @@
 
 bool android::HardwareAbstractionLayer::inject_reference_position(const location::Position& position)
 {
+    if (impl.quirks.avoid_reference_location_injection)
+        return false;
+
     // TODO(tvoss): We should expose the int return type of the underyling
     //  Android HAL to capture errors here.
     UHardwareGpsLocation loc;
@@ -553,7 +559,8 @@
 android::HardwareAbstractionLayer::Impl::Impl(
         android::HardwareAbstractionLayer* parent,
         const android::HardwareAbstractionLayer::Configuration& configuration)
-    : capabilities(0),
+    : quirks(configuration.quirks),
+      capabilities(0),
       assistance_mode(gps::AssistanceMode::mobile_station_based),
       position_mode(gps::PositionMode::periodic),
       supl_assistant(*parent),
@@ -664,6 +671,11 @@
         {
             create_xtra_downloader(),
             gps_xtra_downloader_configuration((in_system_gps_conf ? in_system_gps_conf : in_gps_conf))
+        },
+        android::HardwareAbstractionLayer::Quirks
+        {
+            env::get("UBUNTU_LOCATION_SERVICE_GPS_QUIRK_AVOID_TIME_INJECTION", "false") == "true",
+            env::get("UBUNTU_LOCATION_SERVICE_GPS_QUIRK_AVOID_LOCATION_INJECTION", "false") == "true",
         }
     };
 
 
=== modified file 'src/location_service/com/ubuntu/location/providers/gps/android_hardware_abstraction_layer.h'
--- src/location_service/com/ubuntu/location/providers/gps/android_hardware_abstraction_layer.h	2015-11-13 10:19:29 +0000
+++ src/location_service/com/ubuntu/location/providers/gps/android_hardware_abstraction_layer.h	2016-01-25 16:17:56 +0000
@@ -179,6 +179,15 @@
      */
     static void on_request_utc_time(void* context);
 
+    /// @brief Quirks summarizes chip/driver-specific knobs and dials.
+    struct Quirks
+    {
+        /// @brief Some chipsets are known to fail with reference time injection.
+        bool avoid_reference_time_injection;
+        /// @brief Some chipsets are known to fail for injected reference locations.
+        bool avoid_reference_location_injection;
+    };
+
     struct Configuration
     {
         struct
@@ -186,6 +195,7 @@
             std::shared_ptr<GpsXtraDownloader> downloader;
             GpsXtraDownloader::Configuration configuration;
         } gps_xtra;
+        Quirks quirks;
     };
 
     HardwareAbstractionLayer(const Configuration& configuration);
@@ -237,6 +247,8 @@
         // Adjusts the assistance and positioning mode in one go, returning false in case of issues.
         bool dispatch_updated_modes_to_driver();
 
+        // Hw/driver-specific quirks.
+        Quirks quirks;
         // The parameter bundle for the hardware GPS instance.
         UHardwareGpsParams gps_params;
         // The actual handle to the hardware GPS instance.