blob: c5c65c247a0ee97ec054d712270915d0a32ce67a [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
Doug Zongker211aebc2011-10-28 15:13:10 -070024// Abstract class for controlling the user interface during recovery.
25class RecoveryUI {
26 public:
Doug Zongker32a0a472011-11-01 11:00:20 -070027 RecoveryUI();
28
Doug Zongker211aebc2011-10-28 15:13:10 -070029 virtual ~RecoveryUI() { }
Doug Zongker28ce47c2011-10-28 10:33:05 -070030
Doug Zongker211aebc2011-10-28 15:13:10 -070031 // Initialize the object; called before anything else.
Doug Zongker32a0a472011-11-01 11:00:20 -070032 virtual void Init();
Doug Zongkerc87bab12013-11-25 13:53:25 -080033 // Show a stage indicator. Call immediately after Init().
Elliott Hughes8de52072015-04-08 20:06:50 -070034 virtual void SetStage(int current, int max) = 0;
Doug Zongker28ce47c2011-10-28 10:33:05 -070035
Doug Zongker5fa8c232012-09-18 12:37:02 -070036 // After calling Init(), you can tell the UI what locale it is operating in.
Elliott Hughes8de52072015-04-08 20:06:50 -070037 virtual void SetLocale(const char* locale) = 0;
Doug Zongker5fa8c232012-09-18 12:37:02 -070038
Doug Zongker211aebc2011-10-28 15:13:10 -070039 // Set the overall recovery state ("background image").
Doug Zongker02ec6b82012-08-22 17:26:40 -070040 enum Icon { NONE, INSTALLING_UPDATE, ERASING, NO_COMMAND, ERROR };
Doug Zongker211aebc2011-10-28 15:13:10 -070041 virtual void SetBackground(Icon icon) = 0;
Doug Zongker28ce47c2011-10-28 10:33:05 -070042
Doug Zongker211aebc2011-10-28 15:13:10 -070043 // --- progress indicator ---
44 enum ProgressType { EMPTY, INDETERMINATE, DETERMINATE };
45 virtual void SetProgressType(ProgressType determinate) = 0;
Doug Zongker28ce47c2011-10-28 10:33:05 -070046
Doug Zongker211aebc2011-10-28 15:13:10 -070047 // Show a progress bar and define the scope of the next operation:
48 // portion - fraction of the progress bar the next operation will use
49 // seconds - expected time interval (progress bar moves at this minimum rate)
50 virtual void ShowProgress(float portion, float seconds) = 0;
51
52 // Set progress bar position (0.0 - 1.0 within the scope defined
53 // by the last call to ShowProgress).
54 virtual void SetProgress(float fraction) = 0;
55
56 // --- text log ---
57
58 virtual void ShowText(bool visible) = 0;
59
60 virtual bool IsTextVisible() = 0;
61
62 virtual bool WasTextEverVisible() = 0;
63
64 // Write a message to the on-screen log (shown if the user has
65 // toggled on the text display).
Elliott Hughes018ed312015-04-08 16:51:36 -070066 virtual void Print(const char* fmt, ...) __printflike(2, 3) = 0;
Doug Zongker211aebc2011-10-28 15:13:10 -070067
Elliott Hughes8de52072015-04-08 20:06:50 -070068 virtual void ShowFile(const char* filename) = 0;
69
Doug Zongker211aebc2011-10-28 15:13:10 -070070 // --- key handling ---
71
Elliott Hughes642aaa72015-04-10 12:47:46 -070072 // Wait for a key and return it. May return -1 after timeout.
Doug Zongker32a0a472011-11-01 11:00:20 -070073 virtual int WaitKey();
Doug Zongker211aebc2011-10-28 15:13:10 -070074
Doug Zongker32a0a472011-11-01 11:00:20 -070075 virtual bool IsKeyPressed(int key);
Elliott Hughes642aaa72015-04-10 12:47:46 -070076 virtual bool IsLongPress();
Doug Zongker211aebc2011-10-28 15:13:10 -070077
Elliott Hughes4af215b2015-04-10 15:00:34 -070078 // Returns true if you have the volume up/down and power trio typical
79 // of phones and tablets, false otherwise.
80 virtual bool HasThreeButtons();
81
Doug Zongker211aebc2011-10-28 15:13:10 -070082 // Erase any queued-up keys.
Doug Zongker32a0a472011-11-01 11:00:20 -070083 virtual void FlushKeys();
Doug Zongker211aebc2011-10-28 15:13:10 -070084
Elliott Hughes642aaa72015-04-10 12:47:46 -070085 // Called on each key press, even while operations are in progress.
Doug Zongkerdaefc1d2011-10-31 09:34:15 -070086 // Return value indicates whether an immediate operation should be
87 // triggered (toggling the display, rebooting the device), or if
88 // the key should be enqueued for use by the main thread.
Elliott Hughesec283402015-04-10 10:01:53 -070089 enum KeyAction { ENQUEUE, TOGGLE, REBOOT, IGNORE };
Elliott Hughes642aaa72015-04-10 12:47:46 -070090 virtual KeyAction CheckKey(int key, bool is_long_press);
Doug Zongkerbb01d0c2012-12-17 10:52:58 -080091
Doug Zongkerc0441d12013-07-31 11:28:24 -070092 // Called when a key is held down long enough to have been a
93 // long-press (but before the key is released). This means that
94 // if the key is eventually registered (released without any other
Elliott Hughes642aaa72015-04-10 12:47:46 -070095 // keys being pressed in the meantime), CheckKey will be called with
96 // 'is_long_press' true.
Doug Zongkerc0441d12013-07-31 11:28:24 -070097 virtual void KeyLongPress(int key);
98
Doug Zongkerc704e062014-05-23 08:40:35 -070099 // Normally in recovery there's a key sequence that triggers
100 // immediate reboot of the device, regardless of what recovery is
101 // doing (with the default CheckKey implementation, it's pressing
102 // the power button 7 times in row). Call this to enable or
103 // disable that feature. It is enabled by default.
104 virtual void SetEnableReboot(bool enabled);
105
Doug Zongker211aebc2011-10-28 15:13:10 -0700106 // --- menu display ---
107
108 // Display some header text followed by a menu of items, which appears
109 // at the top of the screen (in place of any scrolling ui_print()
110 // output, if necessary).
111 virtual void StartMenu(const char* const * headers, const char* const * items,
112 int initial_selection) = 0;
113
Elliott Hughes642aaa72015-04-10 12:47:46 -0700114 // Set the menu highlight to the given index, wrapping if necessary.
115 // Returns the actual item selected.
Doug Zongker211aebc2011-10-28 15:13:10 -0700116 virtual int SelectMenu(int sel) = 0;
117
118 // End menu mode, resetting the text overlay so that ui_print()
119 // statements will be displayed.
120 virtual void EndMenu() = 0;
Doug Zongker32a0a472011-11-01 11:00:20 -0700121
Doug Zongkerbb01d0c2012-12-17 10:52:58 -0800122protected:
123 void EnqueueKey(int key_code);
124
Doug Zongker32a0a472011-11-01 11:00:20 -0700125private:
126 // Key event input queue
127 pthread_mutex_t key_queue_mutex;
128 pthread_cond_t key_queue_cond;
129 int key_queue[256], key_queue_len;
130 char key_pressed[KEY_MAX + 1]; // under key_queue_mutex
131 int key_last_down; // under key_queue_mutex
Doug Zongkerc0441d12013-07-31 11:28:24 -0700132 bool key_long_press; // under key_queue_mutex
133 int key_down_count; // under key_queue_mutex
Doug Zongkerc704e062014-05-23 08:40:35 -0700134 bool enable_reboot; // under key_queue_mutex
Doug Zongker32a0a472011-11-01 11:00:20 -0700135 int rel_sum;
136
Doug Zongker9e805d62013-09-04 13:44:38 -0700137 int consecutive_power_keys;
Doug Zongker9e805d62013-09-04 13:44:38 -0700138 int last_key;
139
Elliott Hughes642aaa72015-04-10 12:47:46 -0700140 bool has_power_key;
141 bool has_up_key;
142 bool has_down_key;
143
144 struct key_timer_t {
Doug Zongkerc0441d12013-07-31 11:28:24 -0700145 RecoveryUI* ui;
146 int key_code;
147 int count;
Elliott Hughes642aaa72015-04-10 12:47:46 -0700148 };
Doug Zongkerc0441d12013-07-31 11:28:24 -0700149
Doug Zongker32a0a472011-11-01 11:00:20 -0700150 pthread_t input_t;
151
Elliott Hughes642aaa72015-04-10 12:47:46 -0700152 void OnKeyDetected(int key_code);
153
Doug Zongker32a0a472011-11-01 11:00:20 -0700154 static void* input_thread(void* cookie);
Todd Poynora5ef19f2013-09-17 13:39:10 -0700155 static int input_callback(int fd, uint32_t epevents, void* data);
Doug Zongker32a0a472011-11-01 11:00:20 -0700156 void process_key(int key_code, int updown);
157 bool usb_connected();
Doug Zongkerc0441d12013-07-31 11:28:24 -0700158
159 static void* time_key_helper(void* cookie);
160 void time_key(int key_code, int count);
Doug Zongker28ce47c2011-10-28 10:33:05 -0700161};
Doug Zongker28ce47c2011-10-28 10:33:05 -0700162
163#endif // RECOVERY_UI_H