diagnostics/base/paths.h

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

#ifndef DIAGNOSTICS_BASE_PATHS_H_
#define DIAGNOSTICS_BASE_PATHS_H_

#include "diagnostics/base/path_literal.h"

// VAR_ put the paths before the variable names so it is easier to read.
#define VAR_(path, var) inline constexpr auto var = path
#define PATH_(...) MakePathLiteral(__VA_ARGS__)

namespace diagnostics::paths {

// TODO(b/308731445): Use this file to define paths.

namespace sysfs {

// Used to determine whether a device has a Google EC.
VAR_(PATH_("sys", "class", "chromeos", "cros_ec"), kCrosEc);

}  // namespace sysfs

namespace usr {

// Used to determine whether mmc utility program exists.
VAR_(PATH_("usr", "bin", "mmc"), kMmc);

}  // namespace usr

namespace run {

// Used to resolve host name.
VAR_(PATH_("run", "dns-proxy"), kDnsProxy);

}  // namespace run

namespace cros_config {

VAR_(PATH_("run", "chromeos-config", "v1"), kRoot);
VAR_(PATH_("run", "chromeos-config", "test"), kTestRoot);

VAR_(PATH_("hardware-properties", "has-backlight"), kHasBacklight);
VAR_(PATH_("hardware-properties", "psu-type"), kPsuType);
VAR_(PATH_("hardware-properties", "has-privacy-screen"), kHasPrivacyScreen);
VAR_(PATH_("hardware-properties", "has-base-accelerometer"),
     kHasBaseAccelerometer);
VAR_(PATH_("hardware-properties", "has-base-gyroscope"), kHasBaseGyroscope);
VAR_(PATH_("hardware-properties", "has-base-magnetometer"),
     kHasBaseMagnetometer);
VAR_(PATH_("hardware-properties", "has-lid-accelerometer"),
     kHasLidAccelerometer);
VAR_(PATH_("hardware-properties", "has-lid-gyroscope"), kHasLidGyroscope);
VAR_(PATH_("hardware-properties", "has-lid-magnetometer"), kHasLidMagnetometer);
VAR_(PATH_("hardware-properties", "form-factor"), kFormFactor);
VAR_(PATH_("hardware-properties", "stylus-category"), kStylusCategory);
VAR_(PATH_("hardware-properties", "has-touchscreen"), kHasTouchscreen);
VAR_(PATH_("hardware-properties", "has-hdmi"), kHasHdmi);
VAR_(PATH_("hardware-properties", "has-audio-jack"), kHasAudioJack);
VAR_(PATH_("hardware-properties", "has-sd-reader"), kHasSdReader);
VAR_(PATH_("hardware-properties", "has-side-volume-button"),
     kHasSideVolumeButton);
VAR_(PATH_("hardware-properties", "storage-type"), kStorageType);
VAR_(PATH_("hardware-properties", "fan-count"), kFanCount);
VAR_(PATH_("camera", "count"), kCameraCount);
VAR_(PATH_("cros-healthd", "cached-vpd", "has-sku-number"), kHasSkuNumber);
VAR_(PATH_("cros-healthd", "battery", "has-smart-battery-info"),
     kHasSmartBatteryInfo);
VAR_(PATH_("cros-healthd", "routines", "battery-capacity", "low-mah"),
     kBatteryCapacityLowMah);
VAR_(PATH_("cros-healthd", "routines", "battery-capacity", "high-mah"),
     kBatteryCapacityHighMah);
VAR_(PATH_("cros-healthd", "routines", "battery-health", "maximum-cycle-count"),
     kBatteryHealthMaximumCycleCount);
VAR_(PATH_("cros-healthd",
           "routines",
           "battery-health",
           "percent-battery-wear-allowed"),
     kBatteryHealthPercentBatteryWearAllowed);
VAR_(PATH_("cros-healthd", "routines", "prime-search", "max-num"),
     kPrimeSearchMaxNum);

namespace fingerprint {

VAR_(PATH_("cros-healthd", "routines", "fingerprint-diag"), kFingerprintDiag);

VAR_(PATH_(kFingerprintDiag, "routine-enable"), kRoutineEnable);
VAR_(PATH_(kFingerprintDiag, "max-dead-pixels"), kMaxDeadPixels);
VAR_(PATH_(kFingerprintDiag, "max-dead-pixels-in-detect-zone"),
     kMaxDeadPixelsInDetectZone);
VAR_(PATH_(kFingerprintDiag, "max-pixel-dev"), kMaxPixelDev);
VAR_(PATH_(kFingerprintDiag, "max-error-reset-pixels"), kMaxErrorResetPixels);
VAR_(PATH_(kFingerprintDiag, "max-reset-pixel-dev"), kMaxResetPixelDev);
VAR_(PATH_(kFingerprintDiag, "pixel-median", "cb-type1-lower"), kCbType1Lower);
VAR_(PATH_(kFingerprintDiag, "pixel-median", "cb-type1-upper"), kCbType1Upper);
VAR_(PATH_(kFingerprintDiag, "pixel-median", "cb-type2-lower"), kCbType2Lower);
VAR_(PATH_(kFingerprintDiag, "pixel-median", "cb-type2-upper"), kCbType2Upper);
VAR_(PATH_(kFingerprintDiag, "pixel-median", "icb-type1-lower"),
     kIcbType1Lower);
VAR_(PATH_(kFingerprintDiag, "pixel-median", "icb-type1-upper"),
     kIcbType1Upper);
VAR_(PATH_(kFingerprintDiag, "pixel-median", "icb-type2-lower"),
     kIcbType2Lower);
VAR_(PATH_(kFingerprintDiag, "pixel-median", "icb-type2-upper"),
     kIcbType2Upper);
VAR_(PATH_(kFingerprintDiag, "num-detect-zone"), kNumDetectZone);
VAR_(PATH_(kFingerprintDiag, "detect-zones"), kDetectZones);
inline constexpr char kX1[] = "x1";
inline constexpr char kY1[] = "y1";
inline constexpr char kX2[] = "x2";
inline constexpr char kY2[] = "y2";

}  // namespace fingerprint

VAR_(PATH_("branding", "oem-name"), kOemName);
VAR_(PATH_("branding", "marketing-name"), kMarketingName);
VAR_(PATH_("name"), kCodeName);

}  // namespace cros_config

namespace dev {

// The path to the psr device node.
VAR_(PATH_("dev", "mei0"), kMei0);

}  // namespace dev

}  // namespace diagnostics::paths

#undef PATH_
#undef VAR_

#endif  // DIAGNOSTICS_BASE_PATHS_H_