biod/biod_config.h

// Copyright 2020 The ChromiumOS Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef BIOD_BIOD_CONFIG_H_
#define BIOD_BIOD_CONFIG_H_

#include <optional>
#include <string>

#include <cros_config/cros_config_interface.h>

namespace biod {

inline constexpr char kCrosConfigFPPath[] = "/fingerprint";
inline constexpr char kCrosConfigFPBoard[] = "board";
inline constexpr char kCrosConfigFPLocation[] = "sensor-location";

inline constexpr char kFpBoardDartmonkey[] = "dartmonkey";
inline constexpr char kFpBoardNami[] = "nami_fp";
inline constexpr char kFpBoardNocturne[] = "nocturne_fp";
inline constexpr char kFpBoardBloonchipper[] = "bloonchipper";

/**
 * @brief Deduce if fingerprint is explicitly supported.
 *
 * This will only register as supported if cros_config explicitly
 * indicates that fingerprint is supported on the model.
 *
 * @return true if fingerprint is supported on this platform,
 *         false if fingerprint may not be supported on this platform
 */
bool FingerprintSupported(brillo::CrosConfigInterface* cros_config);

/**
 * @brief Fetch the fingerprint board name (dartmonkey, bloonchipper, etc).
 *
 * @return no value if cros_config does not report the fingerprint board,
 *         else the fingerprint board as a string
 */
std::optional<std::string> FingerprintBoard(
    brillo::CrosConfigInterface* cros_config);

}  // namespace biod

#endif  // BIOD_BIOD_CONFIG_H_