gnss/1.1/vts/functional/gnss_hal_test.cpp - platform/hardware/interfaces - Git at Google

 /*
  * Copyright (C) 2017 The Android Open Source Project
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *      http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */

 #define LOG_TAG "GnssHalTest"

 #include <android/hidl/manager/1.2/IServiceManager.h>
 #include <gtest/gtest.h>
 #include <hidl/GtestPrinter.h>
 #include <hidl/ServiceManagement.h>

 #include <gnss_hal_test.h>
 #include <chrono>
 #include "Utils.h"

 using ::android::hardware::hidl_string;
 using ::android::hardware::hidl_vec;

 using ::android::hardware::gnss::common::Utils;

 void GnssHalTest::SetUp() {
     gnss_hal_ = IGnss::getService(GetParam());
     ASSERT_NE(gnss_hal_, nullptr);

     SetUpGnssCallback();
 }

 void GnssHalTest::TearDown() {
     if (gnss_hal_ != nullptr) {
         gnss_hal_->cleanup();
         gnss_hal_ = nullptr;
     }

     // Set to nullptr to destruct the callback event queues and warn of any unprocessed events.
     gnss_cb_ = nullptr;
 }

 void GnssHalTest::SetUpGnssCallback() {
     gnss_cb_ = new GnssCallback();
     ASSERT_NE(gnss_cb_, nullptr);

     auto result = gnss_hal_->setCallback_1_1(gnss_cb_);
     if (!result.isOk()) {
         ALOGE("result of failed setCallback %s", result.description().c_str());
     }

     ASSERT_TRUE(result.isOk());
     ASSERT_TRUE(result);

     /*
      * All capabilities, name and systemInfo callbacks should trigger
      */
     EXPECT_TRUE(gnss_cb_->capabilities_cbq_.retrieve(gnss_cb_->last_capabilities_, TIMEOUT_SEC));
     EXPECT_TRUE(gnss_cb_->info_cbq_.retrieve(gnss_cb_->last_info_, TIMEOUT_SEC));
     EXPECT_TRUE(gnss_cb_->name_cbq_.retrieve(gnss_cb_->last_name_, TIMEOUT_SEC));

     EXPECT_EQ(gnss_cb_->capabilities_cbq_.calledCount(), 1);
     EXPECT_EQ(gnss_cb_->info_cbq_.calledCount(), 1);
     EXPECT_EQ(gnss_cb_->name_cbq_.calledCount(), 1);
 }

 void GnssHalTest::StopAndClearLocations() {
     auto result = gnss_hal_->stop();

     EXPECT_TRUE(result.isOk());
     EXPECT_TRUE(result);

     /*
      * Clear notify/waiting counter, allowing up till the timeout after
      * the last reply for final startup messages to arrive (esp. system
      * info.)
      */
     while (gnss_cb_->location_cbq_.retrieve(gnss_cb_->last_location_, TIMEOUT_SEC)) {
     }
     gnss_cb_->location_cbq_.reset();
 }

 void GnssHalTest::SetPositionMode(const int min_interval_msec, const bool low_power_mode) {
     const int kPreferredAccuracy = 0;  // Ideally perfect (matches GnssLocationProvider)
     const int kPreferredTimeMsec = 0;  // Ideally immediate

     auto result = gnss_hal_->setPositionMode_1_1(
         IGnss::GnssPositionMode::MS_BASED, IGnss::GnssPositionRecurrence::RECURRENCE_PERIODIC,
         min_interval_msec, kPreferredAccuracy, kPreferredTimeMsec, low_power_mode);

     ASSERT_TRUE(result.isOk());
     EXPECT_TRUE(result);
 }

 bool GnssHalTest::StartAndCheckFirstLocation(const bool strict, const int min_interval_msec,
                                              const bool low_power_mode) {
     SetPositionMode(min_interval_msec, low_power_mode);
     auto result = gnss_hal_->start();

     EXPECT_TRUE(result.isOk());
     EXPECT_TRUE(result);

     /*
      * GnssLocationProvider support of AGPS SUPL & XtraDownloader is not available in VTS,
      * so allow time to demodulate ephemeris over the air.
      */
     const int kFirstGnssLocationTimeoutSeconds = 75;
     int locationCalledCount = 0;

     if (strict) {
         EXPECT_TRUE(gnss_cb_->location_cbq_.retrieve(gnss_cb_->last_location_,
                                                      kFirstGnssLocationTimeoutSeconds));
         locationCalledCount = gnss_cb_->location_cbq_.calledCount();
         EXPECT_EQ(locationCalledCount, 1);
     }

     if (locationCalledCount > 0) {
         // don't require speed on first fix
         CheckLocation(gnss_cb_->last_location_, false);
         return true;
     }
     return false;
 }

 void GnssHalTest::CheckLocation(GnssLocation& location, bool check_speed) {
     const bool check_more_accuracies =
             (gnss_cb_->info_cbq_.calledCount() > 0 && gnss_cb_->last_info_.yearOfHw >= 2017);

     Utils::checkLocation(location, check_speed, check_more_accuracies);
 }

 void GnssHalTest::StartAndCheckLocations(int count) {
     const int kMinIntervalMsec = 500;
     const int kLocationTimeoutSubsequentSec = 2;
     const bool kLowPowerMode = false;

     SetPositionMode(kMinIntervalMsec, kLowPowerMode);

     EXPECT_TRUE(StartAndCheckFirstLocation(/* strict= */ true,
                                            /* min_interval_msec= */ 1000,
                                            /* low_power_mode= */ false));

     for (int i = 1; i < count; i++) {
         EXPECT_TRUE(gnss_cb_->location_cbq_.retrieve(gnss_cb_->last_location_,
                                                      kLocationTimeoutSubsequentSec));
         int locationCalledCount = gnss_cb_->location_cbq_.calledCount();
         EXPECT_EQ(locationCalledCount, i + 1);
         // Don't cause confusion by checking details if no location yet
         if (locationCalledCount > 0) {
             // Should be more than 1 location by now, but if not, still don't check first fix speed
             CheckLocation(gnss_cb_->last_location_, locationCalledCount > 1);
         }
     }
 }

 bool GnssHalTest::IsGnssHalVersion_1_1() const {
     using ::android::hidl::manager::V1_2::IServiceManager;
     sp<IServiceManager> manager = ::android::hardware::defaultServiceManager1_2();

     bool hasGnssHalVersion_1_1 = false;
     manager->listManifestByInterface(
             "[email protected]::IGnss",
             [&hasGnssHalVersion_1_1](const hidl_vec<hidl_string>& registered) {
                 ASSERT_EQ(1, registered.size());
                 hasGnssHalVersion_1_1 = true;
             });

     bool hasGnssHalVersion_2_0 = false;
     manager->listManifestByInterface(
             "[email protected]::IGnss",
             [&hasGnssHalVersion_2_0](const hidl_vec<hidl_string>& registered) {
                 hasGnssHalVersion_2_0 = registered.size() != 0;
             });

     bool hasGnssHalVersion_2_1 = false;
     manager->listManifestByInterface(
             "[email protected]::IGnss",
             [&hasGnssHalVersion_2_1](const hidl_vec<hidl_string>& registered) {
                 hasGnssHalVersion_2_1 = registered.size() != 0;
             });

     return hasGnssHalVersion_1_1 && !hasGnssHalVersion_2_0 && !hasGnssHalVersion_2_1;
 }

 GnssConstellationType GnssHalTest::startLocationAndGetNonGpsConstellation(
         const int locations_to_await, const int gnss_sv_info_list_timeout) {
     gnss_cb_->location_cbq_.reset();
     StartAndCheckLocations(locations_to_await);
     const int location_called_count = gnss_cb_->location_cbq_.calledCount();

     // Tolerate 1 less sv status to handle edge cases in reporting.
     int sv_status_cbq_size = gnss_cb_->sv_status_cbq_.size();
     EXPECT_GE(sv_status_cbq_size + 1, locations_to_await);
     ALOGD("Observed %d GnssSvStatus, while awaiting %d Locations (%d received)", sv_status_cbq_size,
           locations_to_await, location_called_count);

     // Find first non-GPS constellation to blacklist
     GnssConstellationType constellation_to_blacklist = GnssConstellationType::UNKNOWN;
     for (int i = 0; i < sv_status_cbq_size; ++i) {
         IGnssCallback::GnssSvStatus gnss_sv_status;
         gnss_cb_->sv_status_cbq_.retrieve(gnss_sv_status, gnss_sv_info_list_timeout);
         for (uint32_t iSv = 0; iSv < gnss_sv_status.numSvs; iSv++) {
             const auto& gnss_sv = gnss_sv_status.gnssSvList[iSv];
             if ((gnss_sv.svFlag & IGnssCallback::GnssSvFlags::USED_IN_FIX) &&
                 (gnss_sv.constellation != GnssConstellationType::UNKNOWN) &&
                 (gnss_sv.constellation != GnssConstellationType::GPS)) {
                 // found a non-GPS constellation
                 constellation_to_blacklist = gnss_sv.constellation;
                 break;
             }
         }
         if (constellation_to_blacklist != GnssConstellationType::UNKNOWN) {
             break;
         }
     }

     if (constellation_to_blacklist == GnssConstellationType::UNKNOWN) {
         ALOGI("No non-GPS constellations found, constellation blacklist test less effective.");
         // Proceed functionally to blacklist something.
         constellation_to_blacklist = GnssConstellationType::GLONASS;
     }
     return constellation_to_blacklist;
 }

 GnssHalTest::GnssCallback::GnssCallback()
     : info_cbq_("system_info"),
       name_cbq_("name"),
       capabilities_cbq_("capabilities"),
       location_cbq_("location"),
       sv_status_cbq_("sv_status") {}

 Return<void> GnssHalTest::GnssCallback::gnssSetSystemInfoCb(
     const IGnssCallback::GnssSystemInfo& info) {
     ALOGI("Info received, year %d", info.yearOfHw);
     info_cbq_.store(info);
     return Void();
 }

 Return<void> GnssHalTest::GnssCallback::gnssSetCapabilitesCb(uint32_t capabilities) {
     ALOGI("Capabilities received %d", capabilities);
     capabilities_cbq_.store(capabilities);
     return Void();
 }

 Return<void> GnssHalTest::GnssCallback::gnssNameCb(const android::hardware::hidl_string& name) {
     ALOGI("Name received: %s", name.c_str());
     name_cbq_.store(name);
     return Void();
 }

 Return<void> GnssHalTest::GnssCallback::gnssLocationCb(const GnssLocation& location) {
     ALOGI("Location received");
     location_cbq_.store(location);
     return Void();
 }

 Return<void> GnssHalTest::GnssCallback::gnssSvStatusCb(
     const IGnssCallback::GnssSvStatus& svStatus) {
     ALOGI("GnssSvStatus received");
     sv_status_cbq_.store(svStatus);
     return Void();
 }
	/*
	* Copyright (C) 2017 The Android Open Source Project
	*
	* Licensed under the Apache License, Version 2.0 (the "License");
	* you may not use this file except in compliance with the License.
	* You may obtain a copy of the License at
	*
	* http://www.apache.org/licenses/LICENSE-2.0
	*
	* Unless required by applicable law or agreed to in writing, software
	* distributed under the License is distributed on an "AS IS" BASIS,
	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	* See the License for the specific language governing permissions and
	* limitations under the License.
	*/

	#define LOG_TAG "GnssHalTest"

	#include <android/hidl/manager/1.2/IServiceManager.h>
	#include <gtest/gtest.h>
	#include <hidl/GtestPrinter.h>
	#include <hidl/ServiceManagement.h>

	#include <gnss_hal_test.h>
	#include <chrono>
	#include "Utils.h"

	using ::android::hardware::hidl_string;
	using ::android::hardware::hidl_vec;

	using ::android::hardware::gnss::common::Utils;

	void GnssHalTest::SetUp() {
	gnss_hal_ = IGnss::getService(GetParam());
	ASSERT_NE(gnss_hal_, nullptr);

	SetUpGnssCallback();
	}

	void GnssHalTest::TearDown() {
	if (gnss_hal_ != nullptr) {
	gnss_hal_->cleanup();
	gnss_hal_ = nullptr;
	}

	// Set to nullptr to destruct the callback event queues and warn of any unprocessed events.
	gnss_cb_ = nullptr;
	}

	void GnssHalTest::SetUpGnssCallback() {
	gnss_cb_ = new GnssCallback();
	ASSERT_NE(gnss_cb_, nullptr);

	auto result = gnss_hal_->setCallback_1_1(gnss_cb_);
	if (!result.isOk()) {
	ALOGE("result of failed setCallback %s", result.description().c_str());
	}

	ASSERT_TRUE(result.isOk());
	ASSERT_TRUE(result);

	/*
	* All capabilities, name and systemInfo callbacks should trigger
	*/
	EXPECT_TRUE(gnss_cb_->capabilities_cbq_.retrieve(gnss_cb_->last_capabilities_, TIMEOUT_SEC));
	EXPECT_TRUE(gnss_cb_->info_cbq_.retrieve(gnss_cb_->last_info_, TIMEOUT_SEC));
	EXPECT_TRUE(gnss_cb_->name_cbq_.retrieve(gnss_cb_->last_name_, TIMEOUT_SEC));

	EXPECT_EQ(gnss_cb_->capabilities_cbq_.calledCount(), 1);
	EXPECT_EQ(gnss_cb_->info_cbq_.calledCount(), 1);
	EXPECT_EQ(gnss_cb_->name_cbq_.calledCount(), 1);
	}

	void GnssHalTest::StopAndClearLocations() {
	auto result = gnss_hal_->stop();

	EXPECT_TRUE(result.isOk());
	EXPECT_TRUE(result);

	/*
	* Clear notify/waiting counter, allowing up till the timeout after
	* the last reply for final startup messages to arrive (esp. system
	* info.)
	*/
	while (gnss_cb_->location_cbq_.retrieve(gnss_cb_->last_location_, TIMEOUT_SEC)) {
	}
	gnss_cb_->location_cbq_.reset();
	}

	void GnssHalTest::SetPositionMode(const int min_interval_msec, const bool low_power_mode) {
	const int kPreferredAccuracy = 0; // Ideally perfect (matches GnssLocationProvider)
	const int kPreferredTimeMsec = 0; // Ideally immediate

	auto result = gnss_hal_->setPositionMode_1_1(
	IGnss::GnssPositionMode::MS_BASED, IGnss::GnssPositionRecurrence::RECURRENCE_PERIODIC,
	min_interval_msec, kPreferredAccuracy, kPreferredTimeMsec, low_power_mode);

	ASSERT_TRUE(result.isOk());
	EXPECT_TRUE(result);
	}

	bool GnssHalTest::StartAndCheckFirstLocation(const bool strict, const int min_interval_msec,
	const bool low_power_mode) {
	SetPositionMode(min_interval_msec, low_power_mode);
	auto result = gnss_hal_->start();

	EXPECT_TRUE(result.isOk());
	EXPECT_TRUE(result);

	/*
	* GnssLocationProvider support of AGPS SUPL & XtraDownloader is not available in VTS,
	* so allow time to demodulate ephemeris over the air.
	*/
	const int kFirstGnssLocationTimeoutSeconds = 75;
	int locationCalledCount = 0;

	if (strict) {
	EXPECT_TRUE(gnss_cb_->location_cbq_.retrieve(gnss_cb_->last_location_,
	kFirstGnssLocationTimeoutSeconds));
	locationCalledCount = gnss_cb_->location_cbq_.calledCount();
	EXPECT_EQ(locationCalledCount, 1);
	}

	if (locationCalledCount > 0) {
	// don't require speed on first fix
	CheckLocation(gnss_cb_->last_location_, false);
	return true;
	}
	return false;
	}

	void GnssHalTest::CheckLocation(GnssLocation& location, bool check_speed) {
	const bool check_more_accuracies =
	(gnss_cb_->info_cbq_.calledCount() > 0 && gnss_cb_->last_info_.yearOfHw >= 2017);

	Utils::checkLocation(location, check_speed, check_more_accuracies);
	}

	void GnssHalTest::StartAndCheckLocations(int count) {
	const int kMinIntervalMsec = 500;
	const int kLocationTimeoutSubsequentSec = 2;
	const bool kLowPowerMode = false;

	SetPositionMode(kMinIntervalMsec, kLowPowerMode);

	EXPECT_TRUE(StartAndCheckFirstLocation(/* strict= */ true,
	/* min_interval_msec= */ 1000,
	/* low_power_mode= */ false));

	for (int i = 1; i < count; i++) {
	EXPECT_TRUE(gnss_cb_->location_cbq_.retrieve(gnss_cb_->last_location_,
	kLocationTimeoutSubsequentSec));
	int locationCalledCount = gnss_cb_->location_cbq_.calledCount();
	EXPECT_EQ(locationCalledCount, i + 1);
	// Don't cause confusion by checking details if no location yet
	if (locationCalledCount > 0) {
	// Should be more than 1 location by now, but if not, still don't check first fix speed
	CheckLocation(gnss_cb_->last_location_, locationCalledCount > 1);
	}
	}
	}

	bool GnssHalTest::IsGnssHalVersion_1_1() const {
	using ::android::hidl::manager::V1_2::IServiceManager;
	sp<IServiceManager> manager = ::android::hardware::defaultServiceManager1_2();

	bool hasGnssHalVersion_1_1 = false;
	manager->listManifestByInterface(
	"[email protected]::IGnss",
	[&hasGnssHalVersion_1_1](const hidl_vec<hidl_string>& registered) {
	ASSERT_EQ(1, registered.size());
	hasGnssHalVersion_1_1 = true;
	});

	bool hasGnssHalVersion_2_0 = false;
	manager->listManifestByInterface(
	"[email protected]::IGnss",
	[&hasGnssHalVersion_2_0](const hidl_vec<hidl_string>& registered) {
	hasGnssHalVersion_2_0 = registered.size() != 0;
	});

	bool hasGnssHalVersion_2_1 = false;
	manager->listManifestByInterface(
	"[email protected]::IGnss",
	[&hasGnssHalVersion_2_1](const hidl_vec<hidl_string>& registered) {
	hasGnssHalVersion_2_1 = registered.size() != 0;
	});

	return hasGnssHalVersion_1_1 && !hasGnssHalVersion_2_0 && !hasGnssHalVersion_2_1;
	}

	GnssConstellationType GnssHalTest::startLocationAndGetNonGpsConstellation(
	const int locations_to_await, const int gnss_sv_info_list_timeout) {
	gnss_cb_->location_cbq_.reset();
	StartAndCheckLocations(locations_to_await);
	const int location_called_count = gnss_cb_->location_cbq_.calledCount();

	// Tolerate 1 less sv status to handle edge cases in reporting.
	int sv_status_cbq_size = gnss_cb_->sv_status_cbq_.size();
	EXPECT_GE(sv_status_cbq_size + 1, locations_to_await);
	ALOGD("Observed %d GnssSvStatus, while awaiting %d Locations (%d received)", sv_status_cbq_size,
	locations_to_await, location_called_count);

	// Find first non-GPS constellation to blacklist
	GnssConstellationType constellation_to_blacklist = GnssConstellationType::UNKNOWN;
	for (int i = 0; i < sv_status_cbq_size; ++i) {
	IGnssCallback::GnssSvStatus gnss_sv_status;
	gnss_cb_->sv_status_cbq_.retrieve(gnss_sv_status, gnss_sv_info_list_timeout);
	for (uint32_t iSv = 0; iSv < gnss_sv_status.numSvs; iSv++) {
	const auto& gnss_sv = gnss_sv_status.gnssSvList[iSv];
	if ((gnss_sv.svFlag & IGnssCallback::GnssSvFlags::USED_IN_FIX) &&
	(gnss_sv.constellation != GnssConstellationType::UNKNOWN) &&
	(gnss_sv.constellation != GnssConstellationType::GPS)) {
	// found a non-GPS constellation
	constellation_to_blacklist = gnss_sv.constellation;
	break;
	}
	}
	if (constellation_to_blacklist != GnssConstellationType::UNKNOWN) {
	break;
	}
	}

	if (constellation_to_blacklist == GnssConstellationType::UNKNOWN) {
	ALOGI("No non-GPS constellations found, constellation blacklist test less effective.");
	// Proceed functionally to blacklist something.
	constellation_to_blacklist = GnssConstellationType::GLONASS;
	}
	return constellation_to_blacklist;
	}

	GnssHalTest::GnssCallback::GnssCallback()
	: info_cbq_("system_info"),
	name_cbq_("name"),
	capabilities_cbq_("capabilities"),
	location_cbq_("location"),
	sv_status_cbq_("sv_status") {}

	Return<void> GnssHalTest::GnssCallback::gnssSetSystemInfoCb(
	const IGnssCallback::GnssSystemInfo& info) {
	ALOGI("Info received, year %d", info.yearOfHw);
	info_cbq_.store(info);
	return Void();
	}

	Return<void> GnssHalTest::GnssCallback::gnssSetCapabilitesCb(uint32_t capabilities) {
	ALOGI("Capabilities received %d", capabilities);
	capabilities_cbq_.store(capabilities);
	return Void();
	}

	Return<void> GnssHalTest::GnssCallback::gnssNameCb(const android::hardware::hidl_string& name) {
	ALOGI("Name received: %s", name.c_str());
	name_cbq_.store(name);
	return Void();
	}

	Return<void> GnssHalTest::GnssCallback::gnssLocationCb(const GnssLocation& location) {
	ALOGI("Location received");
	location_cbq_.store(location);
	return Void();
	}

	Return<void> GnssHalTest::GnssCallback::gnssSvStatusCb(
	const IGnssCallback::GnssSvStatus& svStatus) {
	ALOGI("GnssSvStatus received");
	sv_status_cbq_.store(svStatus);
	return Void();
	}