blob: d85fc659b7ed84a3b14898af0d13019a1c626d91 [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 Zongker28ce47c2011-10-28 10:33:05 -070033
Doug Zongker5fa8c232012-09-18 12:37:02 -070034 // After calling Init(), you can tell the UI what locale it is operating in.
35 virtual void SetLocale(const char* locale) { }
36
Doug Zongker211aebc2011-10-28 15:13:10 -070037 // Set the overall recovery state ("background image").
Doug Zongker02ec6b82012-08-22 17:26:40 -070038 enum Icon { NONE, INSTALLING_UPDATE, ERASING, NO_COMMAND, ERROR };
Doug Zongker211aebc2011-10-28 15:13:10 -070039 virtual void SetBackground(Icon icon) = 0;
Doug Zongker28ce47c2011-10-28 10:33:05 -070040
Doug Zongker211aebc2011-10-28 15:13:10 -070041 // --- progress indicator ---
42 enum ProgressType { EMPTY, INDETERMINATE, DETERMINATE };
43 virtual void SetProgressType(ProgressType determinate) = 0;
Doug Zongker28ce47c2011-10-28 10:33:05 -070044
Doug Zongker211aebc2011-10-28 15:13:10 -070045 // Show a progress bar and define the scope of the next operation:
46 // portion - fraction of the progress bar the next operation will use
47 // seconds - expected time interval (progress bar moves at this minimum rate)
48 virtual void ShowProgress(float portion, float seconds) = 0;
49
50 // Set progress bar position (0.0 - 1.0 within the scope defined
51 // by the last call to ShowProgress).
52 virtual void SetProgress(float fraction) = 0;
53
54 // --- text log ---
55
56 virtual void ShowText(bool visible) = 0;
57
58 virtual bool IsTextVisible() = 0;
59
60 virtual bool WasTextEverVisible() = 0;
61
62 // Write a message to the on-screen log (shown if the user has
63 // toggled on the text display).
64 virtual void Print(const char* fmt, ...) = 0; // __attribute__((format(printf, 1, 2))) = 0;
65
66 // --- key handling ---
67
68 // Wait for keypress and return it. May return -1 after timeout.
Doug Zongker32a0a472011-11-01 11:00:20 -070069 virtual int WaitKey();
Doug Zongker211aebc2011-10-28 15:13:10 -070070
Doug Zongker32a0a472011-11-01 11:00:20 -070071 virtual bool IsKeyPressed(int key);
Doug Zongker211aebc2011-10-28 15:13:10 -070072
73 // Erase any queued-up keys.
Doug Zongker32a0a472011-11-01 11:00:20 -070074 virtual void FlushKeys();
Doug Zongker211aebc2011-10-28 15:13:10 -070075
Doug Zongkerdaefc1d2011-10-31 09:34:15 -070076 // Called on each keypress, even while operations are in progress.
77 // Return value indicates whether an immediate operation should be
78 // triggered (toggling the display, rebooting the device), or if
79 // the key should be enqueued for use by the main thread.
Doug Zongker4db31d22013-09-04 13:44:38 -070080 enum KeyAction { ENQUEUE, TOGGLE, REBOOT, IGNORE, MOUNT_SYSTEM };
Doug Zongker32a0a472011-11-01 11:00:20 -070081 virtual KeyAction CheckKey(int key);
Doug Zongkerdaefc1d2011-10-31 09:34:15 -070082
Doug Zongkerc0441d12013-07-31 11:28:24 -070083 // Called immediately before each call to CheckKey(), tell you if
84 // the key was long-pressed.
Doug Zongkerbb01d0c2012-12-17 10:52:58 -080085 virtual void NextCheckKeyIsLong(bool is_long_press);
86
Doug Zongkerc0441d12013-07-31 11:28:24 -070087 // Called when a key is held down long enough to have been a
88 // long-press (but before the key is released). This means that
89 // if the key is eventually registered (released without any other
90 // keys being pressed in the meantime), NextCheckKeyIsLong() will
91 // be called with "true".
92 virtual void KeyLongPress(int key);
93
Doug Zongker211aebc2011-10-28 15:13:10 -070094 // --- menu display ---
95
96 // Display some header text followed by a menu of items, which appears
97 // at the top of the screen (in place of any scrolling ui_print()
98 // output, if necessary).
99 virtual void StartMenu(const char* const * headers, const char* const * items,
100 int initial_selection) = 0;
101
102 // Set the menu highlight to the given index, and return it (capped to
103 // the range [0..numitems).
104 virtual int SelectMenu(int sel) = 0;
105
106 // End menu mode, resetting the text overlay so that ui_print()
107 // statements will be displayed.
108 virtual void EndMenu() = 0;
Doug Zongker32a0a472011-11-01 11:00:20 -0700109
Doug Zongkerbb01d0c2012-12-17 10:52:58 -0800110protected:
111 void EnqueueKey(int key_code);
112
Doug Zongker32a0a472011-11-01 11:00:20 -0700113private:
114 // Key event input queue
115 pthread_mutex_t key_queue_mutex;
116 pthread_cond_t key_queue_cond;
117 int key_queue[256], key_queue_len;
118 char key_pressed[KEY_MAX + 1]; // under key_queue_mutex
119 int key_last_down; // under key_queue_mutex
Doug Zongkerc0441d12013-07-31 11:28:24 -0700120 bool key_long_press; // under key_queue_mutex
121 int key_down_count; // under key_queue_mutex
Doug Zongker32a0a472011-11-01 11:00:20 -0700122 int rel_sum;
123
Doug Zongker4db31d22013-09-04 13:44:38 -0700124 int consecutive_power_keys;
125 int consecutive_alternate_keys;
126 int last_key;
127
Doug Zongkerc0441d12013-07-31 11:28:24 -0700128 typedef struct {
129 RecoveryUI* ui;
130 int key_code;
131 int count;
132 } key_timer_t;
133
Doug Zongker32a0a472011-11-01 11:00:20 -0700134 pthread_t input_t;
135
136 static void* input_thread(void* cookie);
137 static int input_callback(int fd, short revents, void* data);
138 void process_key(int key_code, int updown);
139 bool usb_connected();
Doug Zongkerc0441d12013-07-31 11:28:24 -0700140
141 static void* time_key_helper(void* cookie);
142 void time_key(int key_code, int count);
Doug Zongker28ce47c2011-10-28 10:33:05 -0700143};
Doug Zongker28ce47c2011-10-28 10:33:05 -0700144
145#endif // RECOVERY_UI_H