blob: 1e6186a11f180fda10e86bd43c6de494c5bca250 [file] [log] [blame]
Doug Zongker28ce47c2011-10-28 10:33:05 -07001/*
2 * Copyright (C) 2011 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 RECOVERY_UI_H
18#define RECOVERY_UI_H
19
Tao Bao26ea9592018-05-09 16:32:02 -070020#include <linux/input.h> // KEY_MAX
Doug Zongker32a0a472011-11-01 11:00:20 -070021
Tao Bao26ea9592018-05-09 16:32:02 -070022#include <atomic>
Jerry Zhangb31f9ce2018-05-21 16:04:57 -070023#include <condition_variable>
Tao Bao3aec6962018-04-20 09:24:58 -070024#include <functional>
Jerry Zhangb31f9ce2018-05-21 16:04:57 -070025#include <mutex>
Tao Bao736d59c2017-01-03 10:15:33 -080026#include <string>
Tao Bao26ea9592018-05-09 16:32:02 -070027#include <thread>
Tao Bao1fe1afe2018-05-01 15:56:05 -070028#include <vector>
Tao Bao736d59c2017-01-03 10:15:33 -080029
Doug Zongker211aebc2011-10-28 15:13:10 -070030// Abstract class for controlling the user interface during recovery.
31class RecoveryUI {
Tao Bao5d2e3bd2017-06-23 22:23:50 -070032 public:
Tao Bao75779652017-09-10 11:28:32 -070033 enum Icon {
34 NONE,
35 INSTALLING_UPDATE,
36 ERASING,
37 NO_COMMAND,
38 ERROR
39 };
40
41 enum ProgressType {
42 EMPTY,
43 INDETERMINATE,
44 DETERMINATE
45 };
46
47 enum KeyAction {
48 ENQUEUE,
49 TOGGLE,
50 REBOOT,
51 IGNORE
52 };
53
Jerry Zhangb76af932018-05-22 12:08:35 -070054 enum class KeyError : int {
55 TIMED_OUT = -1,
56 INTERRUPTED = -2,
57 };
58
Tao Bao5d2e3bd2017-06-23 22:23:50 -070059 RecoveryUI();
Doug Zongker32a0a472011-11-01 11:00:20 -070060
Tao Bao26ea9592018-05-09 16:32:02 -070061 virtual ~RecoveryUI();
Doug Zongker28ce47c2011-10-28 10:33:05 -070062
Tao Bao99b2d772017-06-23 22:47:03 -070063 // Initializes the object; called before anything else. UI texts will be initialized according to
64 // the given locale. Returns true on success.
Tao Bao5d2e3bd2017-06-23 22:23:50 -070065 virtual bool Init(const std::string& locale);
Tao Bao736d59c2017-01-03 10:15:33 -080066
Tao Bao551d2c32018-05-09 20:53:13 -070067 virtual std::string GetLocale() const = 0;
Jerry Zhang2dea53e2018-05-02 17:15:03 -070068
Tao Bao99b2d772017-06-23 22:47:03 -070069 // Shows a stage indicator. Called immediately after Init().
Tao Bao5d2e3bd2017-06-23 22:23:50 -070070 virtual void SetStage(int current, int max) = 0;
Doug Zongker28ce47c2011-10-28 10:33:05 -070071
Tao Bao99b2d772017-06-23 22:47:03 -070072 // Sets the overall recovery state ("background image").
Tao Bao5d2e3bd2017-06-23 22:23:50 -070073 virtual void SetBackground(Icon icon) = 0;
74 virtual void SetSystemUpdateText(bool security_update) = 0;
Doug Zongker28ce47c2011-10-28 10:33:05 -070075
Tao Bao5d2e3bd2017-06-23 22:23:50 -070076 // --- progress indicator ---
Tao Bao5d2e3bd2017-06-23 22:23:50 -070077 virtual void SetProgressType(ProgressType determinate) = 0;
Doug Zongker28ce47c2011-10-28 10:33:05 -070078
Tao Bao99b2d772017-06-23 22:47:03 -070079 // Shows a progress bar and define the scope of the next operation:
Tao Bao5d2e3bd2017-06-23 22:23:50 -070080 // portion - fraction of the progress bar the next operation will use
81 // seconds - expected time interval (progress bar moves at this minimum rate)
82 virtual void ShowProgress(float portion, float seconds) = 0;
Doug Zongker211aebc2011-10-28 15:13:10 -070083
Tao Bao99b2d772017-06-23 22:47:03 -070084 // Sets progress bar position (0.0 - 1.0 within the scope defined by the last call to
85 // ShowProgress).
Tao Bao5d2e3bd2017-06-23 22:23:50 -070086 virtual void SetProgress(float fraction) = 0;
Doug Zongker211aebc2011-10-28 15:13:10 -070087
Tao Bao5d2e3bd2017-06-23 22:23:50 -070088 // --- text log ---
Doug Zongker211aebc2011-10-28 15:13:10 -070089
Tao Bao5d2e3bd2017-06-23 22:23:50 -070090 virtual void ShowText(bool visible) = 0;
Doug Zongker211aebc2011-10-28 15:13:10 -070091
Tao Bao5d2e3bd2017-06-23 22:23:50 -070092 virtual bool IsTextVisible() = 0;
Doug Zongker211aebc2011-10-28 15:13:10 -070093
Tao Bao5d2e3bd2017-06-23 22:23:50 -070094 virtual bool WasTextEverVisible() = 0;
Doug Zongker211aebc2011-10-28 15:13:10 -070095
Tao Bao99b2d772017-06-23 22:47:03 -070096 // Writes a message to the on-screen log (shown if the user has toggled on the text display).
97 // Print() will also dump the message to stdout / log file, while PrintOnScreenOnly() not.
Tao Bao5d2e3bd2017-06-23 22:23:50 -070098 virtual void Print(const char* fmt, ...) __printflike(2, 3) = 0;
99 virtual void PrintOnScreenOnly(const char* fmt, ...) __printflike(2, 3) = 0;
Doug Zongker211aebc2011-10-28 15:13:10 -0700100
Tao Bao1d156b92018-05-02 12:43:18 -0700101 // Shows the contents of the given file. Caller ensures the patition that contains the file has
102 // been mounted.
103 virtual void ShowFile(const std::string& filename) = 0;
Elliott Hughes8de52072015-04-08 20:06:50 -0700104
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700105 // --- key handling ---
Doug Zongker211aebc2011-10-28 15:13:10 -0700106
Jerry Zhangb76af932018-05-22 12:08:35 -0700107 // Waits for a key and return it. May return TIMED_OUT after timeout and
108 // KeyError::INTERRUPTED on a key interrupt.
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700109 virtual int WaitKey();
Doug Zongker211aebc2011-10-28 15:13:10 -0700110
Jerry Zhangb76af932018-05-22 12:08:35 -0700111 // Wakes up the UI if it is waiting on key input, causing WaitKey to return KeyError::INTERRUPTED.
112 virtual void InterruptKey();
113
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700114 virtual bool IsKeyPressed(int key);
115 virtual bool IsLongPress();
Doug Zongker211aebc2011-10-28 15:13:10 -0700116
Tao Bao99b2d772017-06-23 22:47:03 -0700117 // Returns true if you have the volume up/down and power trio typical of phones and tablets, false
118 // otherwise.
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700119 virtual bool HasThreeButtons();
Elliott Hughes4af215b2015-04-10 15:00:34 -0700120
Tao Bao5f8dd992017-07-28 00:05:40 -0700121 // Returns true if it has a power key.
122 virtual bool HasPowerKey() const;
123
124 // Returns true if it supports touch inputs.
125 virtual bool HasTouchScreen() const;
126
Tao Bao99b2d772017-06-23 22:47:03 -0700127 // Erases any queued-up keys.
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700128 virtual void FlushKeys();
Doug Zongker211aebc2011-10-28 15:13:10 -0700129
Tao Bao99b2d772017-06-23 22:47:03 -0700130 // Called on each key press, even while operations are in progress. Return value indicates whether
131 // an immediate operation should be triggered (toggling the display, rebooting the device), or if
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700132 // the key should be enqueued for use by the main thread.
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700133 virtual KeyAction CheckKey(int key, bool is_long_press);
Doug Zongkerbb01d0c2012-12-17 10:52:58 -0800134
Tao Bao99b2d772017-06-23 22:47:03 -0700135 // Called when a key is held down long enough to have been a long-press (but before the key is
136 // released). This means that if the key is eventually registered (released without any other keys
137 // being pressed in the meantime), CheckKey will be called with 'is_long_press' true.
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700138 virtual void KeyLongPress(int key);
Doug Zongkerc0441d12013-07-31 11:28:24 -0700139
Tao Bao99b2d772017-06-23 22:47:03 -0700140 // Normally in recovery there's a key sequence that triggers immediate reboot of the device,
141 // regardless of what recovery is doing (with the default CheckKey implementation, it's pressing
142 // the power button 7 times in row). Call this to enable or disable that feature. It is enabled by
143 // default.
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700144 virtual void SetEnableReboot(bool enabled);
Doug Zongkerc704e062014-05-23 08:40:35 -0700145
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700146 // --- menu display ---
Doug Zongker211aebc2011-10-28 15:13:10 -0700147
Jerry Zhang0e577ee2018-05-07 11:21:10 -0700148 virtual void SetTitle(const std::vector<std::string>& lines) = 0;
149
Tao Bao3aec6962018-04-20 09:24:58 -0700150 // Displays a menu with the given 'headers' and 'items'. The supplied 'key_handler' callback,
151 // which is typically bound to Device::HandleMenuKey(), should return the expected action for the
152 // given key code and menu visibility (e.g. to move the cursor or to select an item). Caller sets
153 // 'menu_only' to true to ensure only a menu item gets selected and returned. Otherwise if
154 // 'menu_only' is false, ShowMenu() will forward any non-negative value returned from the
155 // key_handler, which may be beyond the range of menu items. This could be used to trigger a
156 // device-specific action, even without that being listed in the menu. Caller needs to handle
157 // such a case accordingly (e.g. by calling Device::InvokeMenuItem() to process the action).
Tao Bao1fe1afe2018-05-01 15:56:05 -0700158 // Returns a non-negative value (the chosen item number or device-specific action code), or
Jerry Zhangb76af932018-05-22 12:08:35 -0700159 // static_cast<size_t>(TIMED_OUT) if timed out waiting for input or
160 // static_cast<size_t>(ERR_KEY_INTERTUPT) if interrupted, such as by InterruptKey().
Tao Bao1fe1afe2018-05-01 15:56:05 -0700161 virtual size_t ShowMenu(const std::vector<std::string>& headers,
162 const std::vector<std::string>& items, size_t initial_selection,
163 bool menu_only, const std::function<int(int, bool)>& key_handler) = 0;
Doug Zongker32a0a472011-11-01 11:00:20 -0700164
Tianjie Xub99e6062018-10-16 15:13:09 -0700165 // Displays the localized wipe data menu with pre-generated graphs. If there's an issue
166 // with the graphs, falls back to use the backup string headers and items instead. The initial
167 // selection is the 0th item in the menu, which is expected to reboot the device without a wipe.
168 virtual size_t ShowPromptWipeDataMenu(const std::vector<std::string>& backup_headers,
169 const std::vector<std::string>& backup_items,
170 const std::function<int(int, bool)>& key_handler) = 0;
171
Jerry Zhangb76af932018-05-22 12:08:35 -0700172 // Resets the key interrupt status.
173 void ResetKeyInterruptStatus() {
174 key_interrupted_ = false;
175 }
176
177 // Returns the key interrupt status.
178 bool IsKeyInterrupted() const {
179 return key_interrupted_;
180 }
181
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700182 protected:
183 void EnqueueKey(int key_code);
Doug Zongkerbb01d0c2012-12-17 10:52:58 -0800184
Tao Bao99b2d772017-06-23 22:47:03 -0700185 // The normal and dimmed brightness percentages (default: 50 and 25, which means 50% and 25% of
186 // the max_brightness). Because the absolute values may vary across devices. These two values can
187 // be configured via subclassing. Setting brightness_normal_ to 0 to disable screensaver.
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700188 unsigned int brightness_normal_;
189 unsigned int brightness_dimmed_;
kataoc35c1b02017-12-08 11:02:43 +0800190 std::string brightness_file_;
191 std::string max_brightness_file_;
Tao Bao6278bdf2017-01-16 17:38:18 -0800192
Tao Bao5f8dd992017-07-28 00:05:40 -0700193 // Whether we should listen for touch inputs (default: false).
194 bool touch_screen_allowed_;
195
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700196 private:
Tao Bao75779652017-09-10 11:28:32 -0700197 enum class ScreensaverState {
198 DISABLED,
199 NORMAL,
200 DIMMED,
201 OFF
202 };
203
Tao Bao5f8dd992017-07-28 00:05:40 -0700204 // The sensitivity when detecting a swipe.
Tao Bao0bc88de2018-07-31 14:53:16 -0700205 const int touch_low_threshold_;
206 const int touch_high_threshold_;
Tao Bao5f8dd992017-07-28 00:05:40 -0700207
Tao Bao75779652017-09-10 11:28:32 -0700208 void OnKeyDetected(int key_code);
209 void OnTouchDetected(int dx, int dy);
210 int OnInputEvent(int fd, uint32_t epevents);
211 void ProcessKey(int key_code, int updown);
Tao Bao26ea9592018-05-09 16:32:02 -0700212 void TimeKey(int key_code, int count);
Tao Bao75779652017-09-10 11:28:32 -0700213
214 bool IsUsbConnected();
215
Tao Bao75779652017-09-10 11:28:32 -0700216 bool InitScreensaver();
Jerry Zhangb76af932018-05-22 12:08:35 -0700217 void SetScreensaverState(ScreensaverState state);
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700218 // Key event input queue
Jerry Zhangb31f9ce2018-05-21 16:04:57 -0700219 std::mutex key_queue_mutex;
220 std::condition_variable key_queue_cond;
Jerry Zhangb76af932018-05-22 12:08:35 -0700221 bool key_interrupted_;
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700222 int key_queue[256], key_queue_len;
223 char key_pressed[KEY_MAX + 1]; // under key_queue_mutex
224 int key_last_down; // under key_queue_mutex
225 bool key_long_press; // under key_queue_mutex
226 int key_down_count; // under key_queue_mutex
227 bool enable_reboot; // under key_queue_mutex
228 int rel_sum;
Doug Zongker32a0a472011-11-01 11:00:20 -0700229
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700230 int consecutive_power_keys;
231 int last_key;
Doug Zongker9e805d62013-09-04 13:44:38 -0700232
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700233 bool has_power_key;
234 bool has_up_key;
235 bool has_down_key;
Tao Bao5f8dd992017-07-28 00:05:40 -0700236 bool has_touch_screen;
237
238 // Touch event related variables. See the comments in RecoveryUI::OnInputEvent().
239 int touch_slot_;
240 int touch_X_;
241 int touch_Y_;
242 int touch_start_X_;
243 int touch_start_Y_;
244 bool touch_finger_down_;
245 bool touch_swiping_;
Tao Bao046aae22017-07-31 23:15:09 -0700246 bool is_bootreason_recovery_ui_;
Elliott Hughes642aaa72015-04-10 12:47:46 -0700247
Tao Bao26ea9592018-05-09 16:32:02 -0700248 std::thread input_thread_;
249 std::atomic<bool> input_thread_stopped_{ false };
Doug Zongker32a0a472011-11-01 11:00:20 -0700250
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700251 ScreensaverState screensaver_state_;
Tao Bao75779652017-09-10 11:28:32 -0700252
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700253 // The following two contain the absolute values computed from brightness_normal_ and
254 // brightness_dimmed_ respectively.
255 unsigned int brightness_normal_value_;
256 unsigned int brightness_dimmed_value_;
Doug Zongker28ce47c2011-10-28 10:33:05 -0700257};
Doug Zongker28ce47c2011-10-28 10:33:05 -0700258
259#endif // RECOVERY_UI_H