diagnostics/cros_healthd/cros_healthd_routine_service.h

// Copyright 2019 The Chromium OS Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef DIAGNOSTICS_CROS_HEALTHD_CROS_HEALTHD_ROUTINE_SERVICE_H_
#define DIAGNOSTICS_CROS_HEALTHD_CROS_HEALTHD_ROUTINE_SERVICE_H_

#include <string>
#include <vector>

#include <base/optional.h>
#include <base/time/time.h>

#include "mojo/cros_healthd.mojom.h"

namespace diagnostics {

// Service responsible for controlling and managing the lifecycle of diagnostic
// routines.
class CrosHealthdRoutineService {
 public:
  using MojomCrosHealthdDiagnosticRoutineEnum =
      chromeos::cros_healthd::mojom::DiagnosticRoutineEnum;
  using MojomCrosHealthdDiagnosticRoutineCommandEnum =
      chromeos::cros_healthd::mojom::DiagnosticRoutineCommandEnum;
  using MojomCrosHealthdDiagnosticRoutineStatusEnum =
      chromeos::cros_healthd::mojom::DiagnosticRoutineStatusEnum;
  using MojomCrosHealthdAcPowerStatusEnum =
      chromeos::cros_healthd::mojom::AcPowerStatusEnum;
  using MojomCrosHealthdNvmeSelfTestTypeEnum =
      chromeos::cros_healthd::mojom::NvmeSelfTestTypeEnum;

  virtual ~CrosHealthdRoutineService() = default;

  // Fetch all of the routines that the device supports.
  virtual std::vector<MojomCrosHealthdDiagnosticRoutineEnum>
  GetAvailableRoutines() = 0;

  // Each of the following methods creates a new instance of the specified
  // diagnostic routine, and starts that instance. See
  // diagnostics/mojo/cros_healthd_diagnostics.mojom for details on each
  // routine.
  virtual void RunBatteryCapacityRoutine(
      uint32_t low_mah,
      uint32_t high_mah,
      int32_t* id,
      MojomCrosHealthdDiagnosticRoutineStatusEnum* status) = 0;
  virtual void RunBatteryHealthRoutine(
      uint32_t maximum_cycle_count,
      uint32_t percent_battery_wear_allowed,
      int32_t* id,
      MojomCrosHealthdDiagnosticRoutineStatusEnum* status) = 0;
  virtual void RunUrandomRoutine(
      uint32_t length_seconds,
      int32_t* id,
      MojomCrosHealthdDiagnosticRoutineStatusEnum* status) = 0;
  virtual void RunSmartctlCheckRoutine(
      int32_t* id, MojomCrosHealthdDiagnosticRoutineStatusEnum* status) = 0;
  virtual void RunAcPowerRoutine(
      MojomCrosHealthdAcPowerStatusEnum expected_status,
      const base::Optional<std::string>& expected_power_type,
      int32_t* id,
      MojomCrosHealthdDiagnosticRoutineStatusEnum* status) = 0;
  virtual void RunCpuCacheRoutine(
      base::TimeDelta exec_duration,
      int32_t* id,
      MojomCrosHealthdDiagnosticRoutineStatusEnum* status) = 0;
  virtual void RunCpuStressRoutine(
      base::TimeDelta exec_duration,
      int32_t* id,
      MojomCrosHealthdDiagnosticRoutineStatusEnum* status) = 0;
  virtual void RunFloatingPointAccuracyRoutine(
      base::TimeDelta exec_duration,
      int32_t* id,
      MojomCrosHealthdDiagnosticRoutineStatusEnum* status) = 0;
  virtual void RunNvmeWearLevelRoutine(
      uint32_t wear_level_threshold,
      int32_t* id,
      MojomCrosHealthdDiagnosticRoutineStatusEnum* status) = 0;
  virtual void RunNvmeSelfTestRoutine(
      MojomCrosHealthdNvmeSelfTestTypeEnum nvme_self_test_type,
      int32_t* id,
      MojomCrosHealthdDiagnosticRoutineStatusEnum* status) = 0;
  virtual void RunDiskReadRoutine(
      chromeos::cros_healthd::mojom::DiskReadRoutineTypeEnum type,
      base::TimeDelta exec_duration,
      uint32_t file_size_mb,
      int32_t* id,
      MojomCrosHealthdDiagnosticRoutineStatusEnum* status) = 0;
  virtual void RunPrimeSearchRoutine(
      base::TimeDelta exec_duration,
      uint64_t max_num,
      int32_t* id,
      MojomCrosHealthdDiagnosticRoutineStatusEnum* status) = 0;
  virtual void RunBatteryDischargeRoutine(
      base::TimeDelta exec_duration,
      uint32_t maximum_discharge_percent_allowed,
      int32_t* id,
      MojomCrosHealthdDiagnosticRoutineStatusEnum* status) = 0;
  virtual void GetRoutineUpdate(
      int32_t id,
      MojomCrosHealthdDiagnosticRoutineCommandEnum command,
      bool include_output,
      chromeos::cros_healthd::mojom::RoutineUpdate* response) = 0;
};

}  // namespace diagnostics

#endif  // DIAGNOSTICS_CROS_HEALTHD_CROS_HEALTHD_ROUTINE_SERVICE_H_