platform/include/chre/platform/platform_gnss.h

/*
 * 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.
 */

#ifndef CHRE_PLATFORM_PLATFORM_GNSS_H_
#define CHRE_PLATFORM_PLATFORM_GNSS_H_

#include "chre/target_platform/platform_gnss_base.h"
#include "chre/util/time.h"

namespace chre {

class PlatformGnss : public PlatformGnssBase {
 public:
  /**
   * Performs platform-specific deinitialization of the PlatformGnss instance.
   */
  ~PlatformGnss();

  /**
   * Initializes the platform-specific GNSS implementation. This is potentially
   * called at a later stage of initialization than the constructor, so platform
   * implementations are encouraged to put any blocking initialization here.
   */
  void init();

  /**
   * Returns the set of GNSS capabilities that the platform has exposed. This
   * may return CHRE_GNSS_CAPABILITIES_NONE if GNSS is not supported.
   *
   * @return the GNSS capabilities exposed by this platform.
   */
  uint32_t getCapabilities();

  /**
   * Starts/stops/modifies the GNSS location session. This is an asynchronous
   * request and the result is delivered through an async call into the
   * GNSS manager.
   *
   * @param enable Whether to enable/disable the location session.
   * @param minInterval The minimum reporting interval.
   * @param minTimeToNextFix The minimum time to the next fix.
   *
   * @return true if the request was accepted.
   */
  bool controlLocationSession(bool enable, Milliseconds minInterval,
                              Milliseconds minTimeToNextFix);

  /**
   * Releases a location event that was previously provided to the GNSS manager.
   *
   * @param event the event to release.
   */
  void releaseLocationEvent(chreGnssLocationEvent *event);

  /**
   * Starts/stops/modifies the GNSS measurement session. This is an asynchronous
   * request and the result is delivered through an async call into the
   * GNSS manager.
   *
   * @param enable Whether to enable/disable the measurement session.
   * @param minInterval The minimum reporting interval.
   *
   * @return true if the request was accepted.
   */
  bool controlMeasurementSession(bool enable, Milliseconds minInterval);

  /**
   * Releases a measurement data event that was previously provided to the GNSS
   * manager.
   *
   * @param event the event to release.
   */
  void releaseMeasurementDataEvent(chreGnssDataEvent *event);

  /**
   * @param enable true to enable the configuration.
   *
   * @return true if the request was received.
   */
  bool configurePassiveLocationListener(bool enable);
};

}  // namespace chre

#endif  // CHRE_PLATFORM_PLATFORM_GNSS_H_