blob: 7eb04aec8cf3f9965f165687b0ec87d25399e4f5 [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 Bao736d59c2017-01-03 10:15:33 -080024#include <string>
25
Doug Zongker211aebc2011-10-28 15:13:10 -070026// Abstract class for controlling the user interface during recovery.
27class RecoveryUI {
Tao Bao5d2e3bd2017-06-23 22:23:50 -070028 public:
29 RecoveryUI();
Doug Zongker32a0a472011-11-01 11:00:20 -070030
Tao Bao5d2e3bd2017-06-23 22:23:50 -070031 virtual ~RecoveryUI() {}
Doug Zongker28ce47c2011-10-28 10:33:05 -070032
Tao Bao99b2d772017-06-23 22:47:03 -070033 // Initializes the object; called before anything else. UI texts will be initialized according to
34 // the given locale. Returns true on success.
Tao Bao5d2e3bd2017-06-23 22:23:50 -070035 virtual bool Init(const std::string& locale);
Tao Bao736d59c2017-01-03 10:15:33 -080036
Tao Bao99b2d772017-06-23 22:47:03 -070037 // Shows a stage indicator. Called immediately after Init().
Tao Bao5d2e3bd2017-06-23 22:23:50 -070038 virtual void SetStage(int current, int max) = 0;
Doug Zongker28ce47c2011-10-28 10:33:05 -070039
Tao Bao99b2d772017-06-23 22:47:03 -070040 // Sets the overall recovery state ("background image").
Tao Bao5d2e3bd2017-06-23 22:23:50 -070041 enum Icon { NONE, INSTALLING_UPDATE, ERASING, NO_COMMAND, ERROR };
42 virtual void SetBackground(Icon icon) = 0;
43 virtual void SetSystemUpdateText(bool security_update) = 0;
Doug Zongker28ce47c2011-10-28 10:33:05 -070044
Tao Bao5d2e3bd2017-06-23 22:23:50 -070045 // --- progress indicator ---
46 enum ProgressType { EMPTY, INDETERMINATE, DETERMINATE };
47 virtual void SetProgressType(ProgressType determinate) = 0;
Doug Zongker28ce47c2011-10-28 10:33:05 -070048
Tao Bao99b2d772017-06-23 22:47:03 -070049 // Shows a progress bar and define the scope of the next operation:
Tao Bao5d2e3bd2017-06-23 22:23:50 -070050 // portion - fraction of the progress bar the next operation will use
51 // seconds - expected time interval (progress bar moves at this minimum rate)
52 virtual void ShowProgress(float portion, float seconds) = 0;
Doug Zongker211aebc2011-10-28 15:13:10 -070053
Tao Bao99b2d772017-06-23 22:47:03 -070054 // Sets progress bar position (0.0 - 1.0 within the scope defined by the last call to
55 // ShowProgress).
Tao Bao5d2e3bd2017-06-23 22:23:50 -070056 virtual void SetProgress(float fraction) = 0;
Doug Zongker211aebc2011-10-28 15:13:10 -070057
Tao Bao5d2e3bd2017-06-23 22:23:50 -070058 // --- text log ---
Doug Zongker211aebc2011-10-28 15:13:10 -070059
Tao Bao5d2e3bd2017-06-23 22:23:50 -070060 virtual void ShowText(bool visible) = 0;
Doug Zongker211aebc2011-10-28 15:13:10 -070061
Tao Bao5d2e3bd2017-06-23 22:23:50 -070062 virtual bool IsTextVisible() = 0;
Doug Zongker211aebc2011-10-28 15:13:10 -070063
Tao Bao5d2e3bd2017-06-23 22:23:50 -070064 virtual bool WasTextEverVisible() = 0;
Doug Zongker211aebc2011-10-28 15:13:10 -070065
Tao Bao99b2d772017-06-23 22:47:03 -070066 // Writes a message to the on-screen log (shown if the user has toggled on the text display).
67 // Print() will also dump the message to stdout / log file, while PrintOnScreenOnly() not.
Tao Bao5d2e3bd2017-06-23 22:23:50 -070068 virtual void Print(const char* fmt, ...) __printflike(2, 3) = 0;
69 virtual void PrintOnScreenOnly(const char* fmt, ...) __printflike(2, 3) = 0;
Doug Zongker211aebc2011-10-28 15:13:10 -070070
Tao Bao5d2e3bd2017-06-23 22:23:50 -070071 virtual void ShowFile(const char* filename) = 0;
Elliott Hughes8de52072015-04-08 20:06:50 -070072
Tao Bao5d2e3bd2017-06-23 22:23:50 -070073 // --- key handling ---
Doug Zongker211aebc2011-10-28 15:13:10 -070074
Tao Bao99b2d772017-06-23 22:47:03 -070075 // Waits for a key and return it. May return -1 after timeout.
Tao Bao5d2e3bd2017-06-23 22:23:50 -070076 virtual int WaitKey();
Doug Zongker211aebc2011-10-28 15:13:10 -070077
Tao Bao5d2e3bd2017-06-23 22:23:50 -070078 virtual bool IsKeyPressed(int key);
79 virtual bool IsLongPress();
Doug Zongker211aebc2011-10-28 15:13:10 -070080
Tao Bao99b2d772017-06-23 22:47:03 -070081 // Returns true if you have the volume up/down and power trio typical of phones and tablets, false
82 // otherwise.
Tao Bao5d2e3bd2017-06-23 22:23:50 -070083 virtual bool HasThreeButtons();
Elliott Hughes4af215b2015-04-10 15:00:34 -070084
Tao Bao99b2d772017-06-23 22:47:03 -070085 // Erases any queued-up keys.
Tao Bao5d2e3bd2017-06-23 22:23:50 -070086 virtual void FlushKeys();
Doug Zongker211aebc2011-10-28 15:13:10 -070087
Tao Bao99b2d772017-06-23 22:47:03 -070088 // Called on each key press, even while operations are in progress. Return value indicates whether
89 // an immediate operation should be triggered (toggling the display, rebooting the device), or if
Tao Bao5d2e3bd2017-06-23 22:23:50 -070090 // the key should be enqueued for use by the main thread.
91 enum KeyAction { ENQUEUE, TOGGLE, REBOOT, IGNORE };
92 virtual KeyAction CheckKey(int key, bool is_long_press);
Doug Zongkerbb01d0c2012-12-17 10:52:58 -080093
Tao Bao99b2d772017-06-23 22:47:03 -070094 // Called when a key is held down long enough to have been a long-press (but before the key is
95 // released). This means that if the key is eventually registered (released without any other keys
96 // being pressed in the meantime), CheckKey will be called with 'is_long_press' true.
Tao Bao5d2e3bd2017-06-23 22:23:50 -070097 virtual void KeyLongPress(int key);
Doug Zongkerc0441d12013-07-31 11:28:24 -070098
Tao Bao99b2d772017-06-23 22:47:03 -070099 // Normally in recovery there's a key sequence that triggers immediate reboot of the device,
100 // regardless of what recovery is doing (with the default CheckKey implementation, it's pressing
101 // the power button 7 times in row). Call this to enable or disable that feature. It is enabled by
102 // default.
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700103 virtual void SetEnableReboot(bool enabled);
Doug Zongkerc704e062014-05-23 08:40:35 -0700104
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700105 // --- menu display ---
Doug Zongker211aebc2011-10-28 15:13:10 -0700106
Tao Bao99b2d772017-06-23 22:47:03 -0700107 // Display some header text followed by a menu of items, which appears at the top of the screen
108 // (in place of any scrolling ui_print() output, if necessary).
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700109 virtual void StartMenu(const char* const* headers, const char* const* items,
110 int initial_selection) = 0;
Doug Zongker211aebc2011-10-28 15:13:10 -0700111
Tao Bao99b2d772017-06-23 22:47:03 -0700112 // Sets the menu highlight to the given index, wrapping if necessary. Returns the actual item
113 // selected.
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700114 virtual int SelectMenu(int sel) = 0;
Doug Zongker211aebc2011-10-28 15:13:10 -0700115
Tao Bao99b2d772017-06-23 22:47:03 -0700116 // Ends menu mode, resetting the text overlay so that ui_print() statements will be displayed.
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700117 virtual void EndMenu() = 0;
Doug Zongker32a0a472011-11-01 11:00:20 -0700118
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700119 protected:
120 void EnqueueKey(int key_code);
Doug Zongkerbb01d0c2012-12-17 10:52:58 -0800121
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700122 // The locale that's used to show the rendered texts.
123 std::string locale_;
124 bool rtl_locale_;
Tao Bao736d59c2017-01-03 10:15:33 -0800125
Tao Bao99b2d772017-06-23 22:47:03 -0700126 // The normal and dimmed brightness percentages (default: 50 and 25, which means 50% and 25% of
127 // the max_brightness). Because the absolute values may vary across devices. These two values can
128 // be configured via subclassing. Setting brightness_normal_ to 0 to disable screensaver.
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700129 unsigned int brightness_normal_;
130 unsigned int brightness_dimmed_;
Tao Bao6278bdf2017-01-16 17:38:18 -0800131
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700132 private:
133 // Key event input queue
134 pthread_mutex_t key_queue_mutex;
135 pthread_cond_t key_queue_cond;
136 int key_queue[256], key_queue_len;
137 char key_pressed[KEY_MAX + 1]; // under key_queue_mutex
138 int key_last_down; // under key_queue_mutex
139 bool key_long_press; // under key_queue_mutex
140 int key_down_count; // under key_queue_mutex
141 bool enable_reboot; // under key_queue_mutex
142 int rel_sum;
Doug Zongker32a0a472011-11-01 11:00:20 -0700143
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700144 int consecutive_power_keys;
145 int last_key;
Doug Zongker9e805d62013-09-04 13:44:38 -0700146
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700147 bool has_power_key;
148 bool has_up_key;
149 bool has_down_key;
Elliott Hughes642aaa72015-04-10 12:47:46 -0700150
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700151 struct key_timer_t {
152 RecoveryUI* ui;
153 int key_code;
154 int count;
155 };
Doug Zongkerc0441d12013-07-31 11:28:24 -0700156
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700157 pthread_t input_thread_;
Doug Zongker32a0a472011-11-01 11:00:20 -0700158
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700159 void OnKeyDetected(int key_code);
160 int OnInputEvent(int fd, uint32_t epevents);
161 void ProcessKey(int key_code, int updown);
Elliott Hughes985022a2015-04-13 13:04:32 -0700162
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700163 bool IsUsbConnected();
Doug Zongkerc0441d12013-07-31 11:28:24 -0700164
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700165 static void* time_key_helper(void* cookie);
166 void time_key(int key_code, int count);
Tao Bao736d59c2017-01-03 10:15:33 -0800167
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700168 void SetLocale(const std::string&);
Tao Bao6278bdf2017-01-16 17:38:18 -0800169
Tao Bao5d2e3bd2017-06-23 22:23:50 -0700170 enum class ScreensaverState { DISABLED, NORMAL, DIMMED, OFF };
171 ScreensaverState screensaver_state_;
172 // The following two contain the absolute values computed from brightness_normal_ and
173 // brightness_dimmed_ respectively.
174 unsigned int brightness_normal_value_;
175 unsigned int brightness_dimmed_value_;
176 bool InitScreensaver();
Doug Zongker28ce47c2011-10-28 10:33:05 -0700177};
Doug Zongker28ce47c2011-10-28 10:33:05 -0700178
179#endif // RECOVERY_UI_H