rmad/constants.h

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

#ifndef RMAD_CONSTANTS_H_
#define RMAD_CONSTANTS_H_

#include <array>
#include <map>
#include <string>
#include <utility>

#include <base/containers/fixed_flat_map.h>
#include <base/containers/fixed_flat_set.h>
#include <base/strings/string_piece.h>

#include "rmad/proto_bindings/rmad.pb.h"

namespace rmad {

// Pipe name for internal mojo connection between D-Bus daemon and executor.
inline constexpr char kRmadInternalMojoPipeName[] = "rmad_internal";

inline constexpr char kDefaultWorkingDirPath[] = "/var/lib/rmad/";
inline constexpr char kDefaultJsonStoreFilePath[] =
    "/mnt/stateful_partition/unencrypted/rma-data/state";
inline constexpr char kDefaultUnencryptedPreservePath[] =
    "/mnt/stateful_partition/unencrypted/preserve";

// Files for testing purpose.
inline constexpr char kTestDirPath[] = ".test";
inline constexpr char kDisablePowerwashFilePath[] = ".disable_powerwash";
inline constexpr char kDisableCalibrationFilePath[] = ".disable_calibration";

// We currently treat InitialState as WelcomeState.
inline constexpr RmadState::StateCase kInitialStateCase = RmadState::kWelcome;

// JsonStore rmad_interface keys.
// Update go/shimless-state-preservation when adding new fields.
inline constexpr char kStateHistory[] = "state_history";
inline constexpr char kStateMap[] = "state_map";
inline constexpr char kNetworkConnected[] = "network_connected";
inline constexpr char kReplacedComponentNames[] = "replaced_component_names";
inline constexpr char kSameOwner[] = "same_owner";
inline constexpr char kWpDisableRequired[] = "wp_disable_required";
inline constexpr char kCcdBlocked[] = "ccd_blocked";
inline constexpr char kWipeDevice[] = "wipe_device";
inline constexpr char kWpDisableMethod[] = "wp_disable_method";
inline constexpr char kMlbRepair[] = "mlb_repair";
inline constexpr char kEcRebooted[] = "ec_rebooted";
inline constexpr char kFirmwareUpdated[] = "firmware_updated";
inline constexpr char kCalibrationMap[] = "calibration_map";
inline constexpr char kCalibrationInstruction[] = "calibration_instruction";
inline constexpr char kProvisionFinishedStatus[] = "provision_finished_status";
inline constexpr char kPowerwashCount[] = "powerwash_count";
inline constexpr char kRoFirmwareVerified[] = "ro_firmware_verified";

// States that requires daemon to quit and restart when entering.
inline constexpr auto kQuitDaemonStates =
    base::MakeFixedFlatSet<RmadState::StateCase>(
        {RmadState::StateCase::kWpDisableComplete});

// Component traits.
inline constexpr auto kComponentsNeedManualCalibration =
    base::MakeFixedFlatSet<RmadComponent>(
        {RMAD_COMPONENT_BASE_ACCELEROMETER, RMAD_COMPONENT_LID_ACCELEROMETER,
         RMAD_COMPONENT_BASE_GYROSCOPE, RMAD_COMPONENT_LID_GYROSCOPE});
inline constexpr auto kComponentsNeedUpdateCbi =
    base::MakeFixedFlatSet<RmadComponent>(
        {RMAD_COMPONENT_BASE_GYROSCOPE, RMAD_COMPONENT_LID_GYROSCOPE});

// We map RmadState::StateCase (enum) to std::string to represent state in a
// more readable way.
inline constexpr auto kStateNames =
    base::MakeFixedFlatMap<RmadState::StateCase, base::StringPiece>({
        {RmadState::kWelcome, "Welcome"},
        {RmadState::kComponentsRepair, "ComponentsRepair"},
        {RmadState::kDeviceDestination, "DeviceDestination"},
        {RmadState::kWipeSelection, "WipeSelection"},
        {RmadState::kWpDisableMethod, "WpDisableMethod"},
        {RmadState::kWpDisableRsu, "WpDisableRsu"},
        {RmadState::kWpDisablePhysical, "WpDisablePhysical"},
        {RmadState::kWpDisableComplete, "WpDisableComplete"},
        {RmadState::kUpdateRoFirmware, "UpdateRoFirmware"},
        {RmadState::kRestock, "Restock"},
        {RmadState::kUpdateDeviceInfo, "UpdateDeviceInfo"},
        {RmadState::kProvisionDevice, "ProvisionDevice"},
        {RmadState::kSetupCalibration, "SetupCalibration"},
        {RmadState::kRunCalibration, "RunCalibration"},
        {RmadState::kCheckCalibration, "CheckCalibration"},
        {RmadState::kWpEnablePhysical, "WpEnablePhysical"},
        {RmadState::kFinalize, "Finalize"},
        {RmadState::kRepairComplete, "RepairComplete"},
    });

}  // namespace rmad

#endif  // RMAD_CONSTANTS_H_