1//
2// Copyright (C) 2013 The Android Open Source Project
3//
4// Licensed under the Apache License, Version 2.0 (the "License");
5// you may not use this file except in compliance with the License.
6// You may obtain a copy of the License at
7//
8//      http://www.apache.org/licenses/LICENSE-2.0
9//
10// Unless required by applicable law or agreed to in writing, software
11// distributed under the License is distributed on an "AS IS" BASIS,
12// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13// See the License for the specific language governing permissions and
14// limitations under the License.
15//
16
17#ifndef UPDATE_ENGINE_COMMON_HARDWARE_INTERFACE_H_
18#define UPDATE_ENGINE_COMMON_HARDWARE_INTERFACE_H_
19
20#include <stdint.h>
21
22#include <string>
23#include <vector>
24
25#include <base/files/file_path.h>
26#include <base/time/time.h>
27
28namespace chromeos_update_engine {
29
30// The hardware interface allows access to the crossystem exposed properties,
31// such as the firmware version, hwid, verified boot mode.
32// These stateless functions are tied together in this interface to facilitate
33// unit testing.
34class HardwareInterface {
35 public:
36  virtual ~HardwareInterface() {}
37
38  // Returns whether this is an official build. Official build means that the
39  // server maintains and updates the build, so update_engine should run and
40  // periodically check for updates.
41  virtual bool IsOfficialBuild() const = 0;
42
43  // Returns true if the boot mode is normal or if it's unable to
44  // determine the boot mode. Returns false if the boot mode is
45  // developer. A dev-mode boot will allow the user to access developer-only
46  // features.
47  virtual bool IsNormalBootMode() const = 0;
48
49  // Returns whether the developer features are enabled.
50  virtual bool AreDevFeaturesEnabled() const = 0;
51
52  // Returns whether the device has an OOBE flow that the user must go through
53  // before getting non-critical updates. Use IsOOBEComplete() to determine if
54  // that flow is complete.
55  virtual bool IsOOBEEnabled() const = 0;
56
57  // Returns true if the OOBE process has been completed and EULA accepted,
58  // False otherwise. If True is returned, and |out_time_of_oobe| isn't null,
59  // the time-stamp of when OOBE happened is stored at |out_time_of_oobe|.
60  virtual bool IsOOBEComplete(base::Time* out_time_of_oobe) const = 0;
61
62  // Returns the HWID or an empty string on error.
63  virtual std::string GetHardwareClass() const = 0;
64
65  // Returns the firmware version or an empty string if the system is
66  // not running chrome os firmware.
67  virtual std::string GetFirmwareVersion() const = 0;
68
69  // Returns the ec version or an empty string if the system is not
70  // running a custom chrome os ec.
71  virtual std::string GetECVersion() const = 0;
72
73  // Returns the powerwash_count from the stateful. If the file is not found
74  // or is invalid, returns -1. Brand new machines out of the factory or after
75  // recovery don't have this value set.
76  virtual int GetPowerwashCount() const = 0;
77
78  // Signals that a powerwash (stateful partition wipe) should be performed
79  // after reboot.
80  virtual bool SchedulePowerwash() = 0;
81
82  // Cancel the powerwash operation scheduled to be performed on next boot.
83  virtual bool CancelPowerwash() = 0;
84
85  // Store in |path| the path to a non-volatile directory (persisted across
86  // reboots) available for this daemon. In case of an error, such as no
87  // directory available, returns false.
88  virtual bool GetNonVolatileDirectory(base::FilePath* path) const = 0;
89
90  // Store in |path| the path to a non-volatile directory persisted across
91  // powerwash cycles. In case of an error, such as no directory available,
92  // returns false.
93  virtual bool GetPowerwashSafeDirectory(base::FilePath* path) const = 0;
94
95  // Returns the timestamp of the current OS build.
96  virtual int64_t GetBuildTimestamp() const = 0;
97
98  // Returns whether the first active ping was sent to Omaha at some point, and
99  // that the value is persisted across recovery (and powerwash) once set with
100  // |SetFirstActiveOmahaPingSent()|.
101  virtual bool GetFirstActiveOmahaPingSent() const = 0;
102
103  // Persist the fact that first active ping was sent to omaha. It bails out if
104  // it fails.
105  virtual void SetFirstActiveOmahaPingSent() = 0;
106};
107
108}  // namespace chromeos_update_engine
109
110#endif  // UPDATE_ENGINE_COMMON_HARDWARE_INTERFACE_H_
111