blob: a74b14f85117d72d30440db185277fd75d83c39c [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
Doug Zongker32a0a472011-11-01 11:00:20 -070020#include <linux/input.h>
21#include <pthread.h>
Doug Zongkerbb01d0c2012-12-17 10:52:58 -080022#include <time.h>
Doug Zongker32a0a472011-11-01 11:00:20 -070023
Tao Bao3aec6962018-04-20 09:24:58 -070024#include <functional>
Tao Bao736d59c2017-01-03 10:15:33 -080025#include <string>
Tao Bao1fe1afe2018-05-01 15:56:05 -070026#include <vector>
Tao Bao736d59c2017-01-03 10:15:33 -080027
Doug Zongker211aebc2011-10-28 15:13:10 -070028// Abstract class for controlling the user interface during recovery.
29class RecoveryUI {
Tao Bao5d2e3bd2017-06-23 22:23:50 -070030 public:
Tao Bao75779652017-09-10 11:28:32 -070031 enum Icon {
32 NONE,
33 INSTALLING_UPDATE,
34 ERASING,
35 NO_COMMAND,
36 ERROR
37 };
38
39 enum ProgressType {
40 EMPTY,
41 INDETERMINATE,
42 DETERMINATE
43 };
44
45 enum KeyAction {
46 ENQUEUE,
47 TOGGLE,
48 REBOOT,
49 IGNORE
50 };
51
Tao Bao5d2e3bd2017-06-23 22:23:50 -070052 RecoveryUI();
Doug Zongker32a0a472011-11-01 11:00:20 -070053
Tao Bao5d2e3bd2017-06-23 22:23:50 -070054 virtual ~RecoveryUI() {}
Doug Zongker28ce47c2011-10-28 10:33:05 -070055
Tao Bao99b2d772017-06-23 22:47:03 -070056 // Initializes the object; called before anything else. UI texts will be initialized according to
57 // the given locale. Returns true on success.
Tao Bao5d2e3bd2017-06-23 22:23:50 -070058 virtual bool Init(const std::string& locale);
Tao Bao736d59c2017-01-03 10:15:33 -080059
Tao Bao551d2c32018-05-09 20:53:13 -070060 virtual std::string GetLocale() const = 0;
Jerry Zhang2dea53e2018-05-02 17:15:03 -070061
Tao Bao99b2d772017-06-23 22:47:03 -070062 // Shows a stage indicator. Called immediately after Init().
Tao Bao5d2e3bd2017-06-23 22:23:50 -070063 virtual void SetStage(int current, int max) = 0;
Doug Zongker28ce47c2011-10-28 10:33:05 -070064
Tao Bao99b2d772017-06-23 22:47:03 -070065 // Sets the overall recovery state ("background image").
Tao Bao5d2e3bd2017-06-23 22:23:50 -070066 virtual void SetBackground(Icon icon) = 0;
67 virtual void SetSystemUpdateText(bool security_update) = 0;
Doug Zongker28ce47c2011-10-28 10:33:05 -070068
Tao Bao5d2e3bd2017-06-23 22:23:50 -070069 // --- progress indicator ---
Tao Bao5d2e3bd2017-06-23 22:23:50 -070070 virtual void SetProgressType(ProgressType determinate) = 0;
Doug Zongker28ce47c2011-10-28 10:33:05 -070071
Tao Bao99b2d772017-06-23 22:47:03 -070072 // Shows a progress bar and define the scope of the next operation:
Tao Bao5d2e3bd2017-06-23 22:23:50 -070073 // portion - fraction of the progress bar the next operation will use
74 // seconds - expected time interval (progress bar moves at this minimum rate)
75 virtual void ShowProgress(float portion, float seconds) = 0;
Doug Zongker211aebc2011-10-28 15:13:10 -070076
Tao Bao99b2d772017-06-23 22:47:03 -070077 // Sets progress bar position (0.0 - 1.0 within the scope defined by the last call to
78 // ShowProgress).
Tao Bao5d2e3bd2017-06-23 22:23:50 -070079 virtual void SetProgress(float fraction) = 0;
Doug Zongker211aebc2011-10-28 15:13:10 -070080
Tao Bao5d2e3bd2017-06-23 22:23:50 -070081 // --- text log ---
Doug Zongker211aebc2011-10-28 15:13:10 -070082
Tao Bao5d2e3bd2017-06-23 22:23:50 -070083 virtual void ShowText(bool visible) = 0;
Doug Zongker211aebc2011-10-28 15:13:10 -070084
Tao Bao5d2e3bd2017-06-23 22:23:50 -070085 virtual bool IsTextVisible() = 0;
Doug Zongker211aebc2011-10-28 15:13:10 -070086
Tao Bao5d2e3bd2017-06-23 22:23:50 -070087 virtual bool WasTextEverVisible() = 0;
Doug Zongker211aebc2011-10-28 15:13:10 -070088
Tao Bao99b2d772017-06-23 22:47:03 -070089 // Writes a message to the on-screen log (shown if the user has toggled on the text display).
90 // Print() will also dump the message to stdout / log file, while PrintOnScreenOnly() not.
Tao Bao5d2e3bd2017-06-23 22:23:50 -070091 virtual void Print(const char* fmt, ...) __printflike(2, 3) = 0;
92 virtual void PrintOnScreenOnly(const char* fmt, ...) __printflike(2, 3) = 0;
Doug Zongker211aebc2011-10-28 15:13:10 -070093
Tao Bao1d156b92018-05-02 12:43:18 -070094 // Shows the contents of the given file. Caller ensures the patition that contains the file has
95 // been mounted.
96 virtual void ShowFile(const std::string& filename) = 0;
Elliott Hughes8de52072015-04-08 20:06:50 -070097
Tao Bao5d2e3bd2017-06-23 22:23:50 -070098 // --- key handling ---
Doug Zongker211aebc2011-10-28 15:13:10 -070099
Tao Bao99b2d772017-06-23 22:47:03 -0700100 // Waits for a key and return it. May return -1 after timeout.
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700101 virtual int WaitKey();
Doug Zongker211aebc2011-10-28 15:13:10 -0700102
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700103 virtual bool IsKeyPressed(int key);
104 virtual bool IsLongPress();
Doug Zongker211aebc2011-10-28 15:13:10 -0700105
Tao Bao99b2d772017-06-23 22:47:03 -0700106 // Returns true if you have the volume up/down and power trio typical of phones and tablets, false
107 // otherwise.
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700108 virtual bool HasThreeButtons();
Elliott Hughes4af215b2015-04-10 15:00:34 -0700109
Tao Bao5f8dd992017-07-28 00:05:40 -0700110 // Returns true if it has a power key.
111 virtual bool HasPowerKey() const;
112
113 // Returns true if it supports touch inputs.
114 virtual bool HasTouchScreen() const;
115
Tao Bao99b2d772017-06-23 22:47:03 -0700116 // Erases any queued-up keys.
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700117 virtual void FlushKeys();
Doug Zongker211aebc2011-10-28 15:13:10 -0700118
Tao Bao99b2d772017-06-23 22:47:03 -0700119 // Called on each key press, even while operations are in progress. Return value indicates whether
120 // an immediate operation should be triggered (toggling the display, rebooting the device), or if
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700121 // the key should be enqueued for use by the main thread.
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700122 virtual KeyAction CheckKey(int key, bool is_long_press);
Doug Zongkerbb01d0c2012-12-17 10:52:58 -0800123
Tao Bao99b2d772017-06-23 22:47:03 -0700124 // Called when a key is held down long enough to have been a long-press (but before the key is
125 // released). This means that if the key is eventually registered (released without any other keys
126 // being pressed in the meantime), CheckKey will be called with 'is_long_press' true.
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700127 virtual void KeyLongPress(int key);
Doug Zongkerc0441d12013-07-31 11:28:24 -0700128
Tao Bao99b2d772017-06-23 22:47:03 -0700129 // Normally in recovery there's a key sequence that triggers immediate reboot of the device,
130 // regardless of what recovery is doing (with the default CheckKey implementation, it's pressing
131 // the power button 7 times in row). Call this to enable or disable that feature. It is enabled by
132 // default.
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700133 virtual void SetEnableReboot(bool enabled);
Doug Zongkerc704e062014-05-23 08:40:35 -0700134
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700135 // --- menu display ---
Doug Zongker211aebc2011-10-28 15:13:10 -0700136
Jerry Zhang0e577ee2018-05-07 11:21:10 -0700137 virtual void SetTitle(const std::vector<std::string>& lines) = 0;
138
Tao Bao3aec6962018-04-20 09:24:58 -0700139 // Displays a menu with the given 'headers' and 'items'. The supplied 'key_handler' callback,
140 // which is typically bound to Device::HandleMenuKey(), should return the expected action for the
141 // given key code and menu visibility (e.g. to move the cursor or to select an item). Caller sets
142 // 'menu_only' to true to ensure only a menu item gets selected and returned. Otherwise if
143 // 'menu_only' is false, ShowMenu() will forward any non-negative value returned from the
144 // key_handler, which may be beyond the range of menu items. This could be used to trigger a
145 // device-specific action, even without that being listed in the menu. Caller needs to handle
146 // such a case accordingly (e.g. by calling Device::InvokeMenuItem() to process the action).
Tao Bao1fe1afe2018-05-01 15:56:05 -0700147 // Returns a non-negative value (the chosen item number or device-specific action code), or
148 // static_cast<size_t>(-1) if timed out waiting for input.
149 virtual size_t ShowMenu(const std::vector<std::string>& headers,
150 const std::vector<std::string>& items, size_t initial_selection,
151 bool menu_only, const std::function<int(int, bool)>& key_handler) = 0;
Doug Zongker32a0a472011-11-01 11:00:20 -0700152
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700153 protected:
154 void EnqueueKey(int key_code);
Doug Zongkerbb01d0c2012-12-17 10:52:58 -0800155
Tao Bao99b2d772017-06-23 22:47:03 -0700156 // The normal and dimmed brightness percentages (default: 50 and 25, which means 50% and 25% of
157 // the max_brightness). Because the absolute values may vary across devices. These two values can
158 // be configured via subclassing. Setting brightness_normal_ to 0 to disable screensaver.
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700159 unsigned int brightness_normal_;
160 unsigned int brightness_dimmed_;
kataoc35c1b02017-12-08 11:02:43 +0800161 std::string brightness_file_;
162 std::string max_brightness_file_;
Tao Bao6278bdf2017-01-16 17:38:18 -0800163
Tao Bao5f8dd992017-07-28 00:05:40 -0700164 // Whether we should listen for touch inputs (default: false).
165 bool touch_screen_allowed_;
166
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700167 private:
Tao Bao75779652017-09-10 11:28:32 -0700168 enum class ScreensaverState {
169 DISABLED,
170 NORMAL,
171 DIMMED,
172 OFF
173 };
174
175 struct key_timer_t {
176 RecoveryUI* ui;
177 int key_code;
178 int count;
179 };
180
Tao Bao5f8dd992017-07-28 00:05:40 -0700181 // The sensitivity when detecting a swipe.
182 const int kTouchLowThreshold;
183 const int kTouchHighThreshold;
184
Tao Bao75779652017-09-10 11:28:32 -0700185 void OnKeyDetected(int key_code);
186 void OnTouchDetected(int dx, int dy);
187 int OnInputEvent(int fd, uint32_t epevents);
188 void ProcessKey(int key_code, int updown);
189
190 bool IsUsbConnected();
191
192 static void* time_key_helper(void* cookie);
193 void time_key(int key_code, int count);
194
Tao Bao75779652017-09-10 11:28:32 -0700195 bool InitScreensaver();
196
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700197 // Key event input queue
198 pthread_mutex_t key_queue_mutex;
199 pthread_cond_t key_queue_cond;
200 int key_queue[256], key_queue_len;
201 char key_pressed[KEY_MAX + 1]; // under key_queue_mutex
202 int key_last_down; // under key_queue_mutex
203 bool key_long_press; // under key_queue_mutex
204 int key_down_count; // under key_queue_mutex
205 bool enable_reboot; // under key_queue_mutex
206 int rel_sum;
Doug Zongker32a0a472011-11-01 11:00:20 -0700207
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700208 int consecutive_power_keys;
209 int last_key;
Doug Zongker9e805d62013-09-04 13:44:38 -0700210
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700211 bool has_power_key;
212 bool has_up_key;
213 bool has_down_key;
Tao Bao5f8dd992017-07-28 00:05:40 -0700214 bool has_touch_screen;
215
216 // Touch event related variables. See the comments in RecoveryUI::OnInputEvent().
217 int touch_slot_;
218 int touch_X_;
219 int touch_Y_;
220 int touch_start_X_;
221 int touch_start_Y_;
222 bool touch_finger_down_;
223 bool touch_swiping_;
Tao Bao046aae22017-07-31 23:15:09 -0700224 bool is_bootreason_recovery_ui_;
Elliott Hughes642aaa72015-04-10 12:47:46 -0700225
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700226 pthread_t input_thread_;
Doug Zongker32a0a472011-11-01 11:00:20 -0700227
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700228 ScreensaverState screensaver_state_;
Tao Bao75779652017-09-10 11:28:32 -0700229
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700230 // The following two contain the absolute values computed from brightness_normal_ and
231 // brightness_dimmed_ respectively.
232 unsigned int brightness_normal_value_;
233 unsigned int brightness_dimmed_value_;
Doug Zongker28ce47c2011-10-28 10:33:05 -0700234};
Doug Zongker28ce47c2011-10-28 10:33:05 -0700235
236#endif // RECOVERY_UI_H