blob: 53ce0602f2f9b20fab9a40af1dcd245508f90ca3 [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 {
28 public:
Doug Zongker32a0a472011-11-01 11:00:20 -070029 RecoveryUI();
30
Doug Zongker211aebc2011-10-28 15:13:10 -070031 virtual ~RecoveryUI() { }
Doug Zongker28ce47c2011-10-28 10:33:05 -070032
Tao Bao736d59c2017-01-03 10:15:33 -080033 // Initialize the object; called before anything else. UI texts will be
34 // initialized according to the given locale. Returns true on success.
35 virtual bool Init(const std::string& locale);
36
Doug Zongkerc87bab12013-11-25 13:53:25 -080037 // Show a stage indicator. Call immediately after Init().
Elliott Hughes8de52072015-04-08 20:06:50 -070038 virtual void SetStage(int current, int max) = 0;
Doug Zongker28ce47c2011-10-28 10:33:05 -070039
Doug Zongker211aebc2011-10-28 15:13:10 -070040 // Set the overall recovery state ("background image").
Doug Zongker02ec6b82012-08-22 17:26:40 -070041 enum Icon { NONE, INSTALLING_UPDATE, ERASING, NO_COMMAND, ERROR };
Doug Zongker211aebc2011-10-28 15:13:10 -070042 virtual void SetBackground(Icon icon) = 0;
Tianjie Xu35926c42016-04-28 18:06:26 -070043 virtual void SetSystemUpdateText(bool security_update) = 0;
Doug Zongker28ce47c2011-10-28 10:33:05 -070044
Doug Zongker211aebc2011-10-28 15:13:10 -070045 // --- progress indicator ---
46 enum ProgressType { EMPTY, INDETERMINATE, DETERMINATE };
47 virtual void SetProgressType(ProgressType determinate) = 0;
Doug Zongker28ce47c2011-10-28 10:33:05 -070048
Doug Zongker211aebc2011-10-28 15:13:10 -070049 // Show a progress bar and define the scope of the next operation:
50 // 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;
53
54 // Set progress bar position (0.0 - 1.0 within the scope defined
55 // by the last call to ShowProgress).
56 virtual void SetProgress(float fraction) = 0;
57
58 // --- text log ---
59
60 virtual void ShowText(bool visible) = 0;
61
62 virtual bool IsTextVisible() = 0;
63
64 virtual bool WasTextEverVisible() = 0;
65
66 // Write a message to the on-screen log (shown if the user has
Tao Baob6918c72015-05-19 17:02:16 -070067 // toggled on the text display). Print() will also dump the message
68 // to stdout / log file, while PrintOnScreenOnly() not.
Elliott Hughes018ed312015-04-08 16:51:36 -070069 virtual void Print(const char* fmt, ...) __printflike(2, 3) = 0;
Tao Baob6918c72015-05-19 17:02:16 -070070 virtual void PrintOnScreenOnly(const char* fmt, ...) __printflike(2, 3) = 0;
Doug Zongker211aebc2011-10-28 15:13:10 -070071
Elliott Hughes8de52072015-04-08 20:06:50 -070072 virtual void ShowFile(const char* filename) = 0;
73
Doug Zongker211aebc2011-10-28 15:13:10 -070074 // --- key handling ---
75
Elliott Hughes642aaa72015-04-10 12:47:46 -070076 // Wait for a key and return it. May return -1 after timeout.
Doug Zongker32a0a472011-11-01 11:00:20 -070077 virtual int WaitKey();
Doug Zongker211aebc2011-10-28 15:13:10 -070078
Doug Zongker32a0a472011-11-01 11:00:20 -070079 virtual bool IsKeyPressed(int key);
Elliott Hughes642aaa72015-04-10 12:47:46 -070080 virtual bool IsLongPress();
Doug Zongker211aebc2011-10-28 15:13:10 -070081
Elliott Hughes4af215b2015-04-10 15:00:34 -070082 // Returns true if you have the volume up/down and power trio typical
83 // of phones and tablets, false otherwise.
84 virtual bool HasThreeButtons();
85
Doug Zongker211aebc2011-10-28 15:13:10 -070086 // Erase any queued-up keys.
Doug Zongker32a0a472011-11-01 11:00:20 -070087 virtual void FlushKeys();
Doug Zongker211aebc2011-10-28 15:13:10 -070088
Elliott Hughes642aaa72015-04-10 12:47:46 -070089 // Called on each key press, even while operations are in progress.
Doug Zongkerdaefc1d2011-10-31 09:34:15 -070090 // Return value indicates whether an immediate operation should be
91 // triggered (toggling the display, rebooting the device), or if
92 // the key should be enqueued for use by the main thread.
Elliott Hughesec283402015-04-10 10:01:53 -070093 enum KeyAction { ENQUEUE, TOGGLE, REBOOT, IGNORE };
Elliott Hughes642aaa72015-04-10 12:47:46 -070094 virtual KeyAction CheckKey(int key, bool is_long_press);
Doug Zongkerbb01d0c2012-12-17 10:52:58 -080095
Doug Zongkerc0441d12013-07-31 11:28:24 -070096 // Called when a key is held down long enough to have been a
97 // long-press (but before the key is released). This means that
98 // if the key is eventually registered (released without any other
Elliott Hughes642aaa72015-04-10 12:47:46 -070099 // keys being pressed in the meantime), CheckKey will be called with
100 // 'is_long_press' true.
Doug Zongkerc0441d12013-07-31 11:28:24 -0700101 virtual void KeyLongPress(int key);
102
Doug Zongkerc704e062014-05-23 08:40:35 -0700103 // Normally in recovery there's a key sequence that triggers
104 // immediate reboot of the device, regardless of what recovery is
105 // doing (with the default CheckKey implementation, it's pressing
106 // the power button 7 times in row). Call this to enable or
107 // disable that feature. It is enabled by default.
108 virtual void SetEnableReboot(bool enabled);
109
Doug Zongker211aebc2011-10-28 15:13:10 -0700110 // --- menu display ---
111
112 // Display some header text followed by a menu of items, which appears
113 // at the top of the screen (in place of any scrolling ui_print()
114 // output, if necessary).
115 virtual void StartMenu(const char* const * headers, const char* const * items,
116 int initial_selection) = 0;
117
Elliott Hughes642aaa72015-04-10 12:47:46 -0700118 // Set the menu highlight to the given index, wrapping if necessary.
119 // Returns the actual item selected.
Doug Zongker211aebc2011-10-28 15:13:10 -0700120 virtual int SelectMenu(int sel) = 0;
121
122 // End menu mode, resetting the text overlay so that ui_print()
123 // statements will be displayed.
124 virtual void EndMenu() = 0;
Doug Zongker32a0a472011-11-01 11:00:20 -0700125
Tao Bao736d59c2017-01-03 10:15:33 -0800126 protected:
Doug Zongkerbb01d0c2012-12-17 10:52:58 -0800127 void EnqueueKey(int key_code);
128
Tao Bao736d59c2017-01-03 10:15:33 -0800129 // The locale that's used to show the rendered texts.
130 std::string locale_;
131 bool rtl_locale_;
132
133 private:
Doug Zongker32a0a472011-11-01 11:00:20 -0700134 // Key event input queue
135 pthread_mutex_t key_queue_mutex;
136 pthread_cond_t key_queue_cond;
137 int key_queue[256], key_queue_len;
138 char key_pressed[KEY_MAX + 1]; // under key_queue_mutex
139 int key_last_down; // under key_queue_mutex
Doug Zongkerc0441d12013-07-31 11:28:24 -0700140 bool key_long_press; // under key_queue_mutex
141 int key_down_count; // under key_queue_mutex
Doug Zongkerc704e062014-05-23 08:40:35 -0700142 bool enable_reboot; // under key_queue_mutex
Doug Zongker32a0a472011-11-01 11:00:20 -0700143 int rel_sum;
144
Doug Zongker9e805d62013-09-04 13:44:38 -0700145 int consecutive_power_keys;
Doug Zongker9e805d62013-09-04 13:44:38 -0700146 int last_key;
147
Elliott Hughes642aaa72015-04-10 12:47:46 -0700148 bool has_power_key;
149 bool has_up_key;
150 bool has_down_key;
151
152 struct key_timer_t {
Doug Zongkerc0441d12013-07-31 11:28:24 -0700153 RecoveryUI* ui;
154 int key_code;
155 int count;
Elliott Hughes642aaa72015-04-10 12:47:46 -0700156 };
Doug Zongkerc0441d12013-07-31 11:28:24 -0700157
Elliott Hughes985022a2015-04-13 13:04:32 -0700158 pthread_t input_thread_;
Doug Zongker32a0a472011-11-01 11:00:20 -0700159
Elliott Hughes642aaa72015-04-10 12:47:46 -0700160 void OnKeyDetected(int key_code);
Elliott Hughes985022a2015-04-13 13:04:32 -0700161 int OnInputEvent(int fd, uint32_t epevents);
162 void ProcessKey(int key_code, int updown);
163
164 bool IsUsbConnected();
Doug Zongkerc0441d12013-07-31 11:28:24 -0700165
166 static void* time_key_helper(void* cookie);
167 void time_key(int key_code, int count);
Tao Bao736d59c2017-01-03 10:15:33 -0800168
169 void SetLocale(const std::string&);
Doug Zongker28ce47c2011-10-28 10:33:05 -0700170};
Doug Zongker28ce47c2011-10-28 10:33:05 -0700171
172#endif // RECOVERY_UI_H