blob: 2dfe848e21df4532132ed9ec00981b9ec732ce7d [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().
34 virtual void SetStage(int current, int max) { }
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.
37 virtual void SetLocale(const char* locale) { }
38
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).
66 virtual void Print(const char* fmt, ...) = 0; // __attribute__((format(printf, 1, 2))) = 0;
67
68 // --- key handling ---
69
70 // Wait for keypress and return it. May return -1 after timeout.
Doug Zongker32a0a472011-11-01 11:00:20 -070071 virtual int WaitKey();
Doug Zongker211aebc2011-10-28 15:13:10 -070072
Doug Zongker32a0a472011-11-01 11:00:20 -070073 virtual bool IsKeyPressed(int key);
Doug Zongker211aebc2011-10-28 15:13:10 -070074
75 // Erase any queued-up keys.
Doug Zongker32a0a472011-11-01 11:00:20 -070076 virtual void FlushKeys();
Doug Zongker211aebc2011-10-28 15:13:10 -070077
Doug Zongkerdaefc1d2011-10-31 09:34:15 -070078 // Called on each keypress, even while operations are in progress.
79 // Return value indicates whether an immediate operation should be
80 // triggered (toggling the display, rebooting the device), or if
81 // the key should be enqueued for use by the main thread.
Doug Zongker4db31d22013-09-04 13:44:38 -070082 enum KeyAction { ENQUEUE, TOGGLE, REBOOT, IGNORE, MOUNT_SYSTEM };
Doug Zongker32a0a472011-11-01 11:00:20 -070083 virtual KeyAction CheckKey(int key);
Doug Zongkerdaefc1d2011-10-31 09:34:15 -070084
Doug Zongkerc0441d12013-07-31 11:28:24 -070085 // Called immediately before each call to CheckKey(), tell you if
86 // the key was long-pressed.
Doug Zongkerbb01d0c2012-12-17 10:52:58 -080087 virtual void NextCheckKeyIsLong(bool is_long_press);
88
Doug Zongkerc0441d12013-07-31 11:28:24 -070089 // Called when a key is held down long enough to have been a
90 // long-press (but before the key is released). This means that
91 // if the key is eventually registered (released without any other
92 // keys being pressed in the meantime), NextCheckKeyIsLong() will
93 // be called with "true".
94 virtual void KeyLongPress(int key);
95
Doug Zongker211aebc2011-10-28 15:13:10 -070096 // --- menu display ---
97
98 // Display some header text followed by a menu of items, which appears
99 // at the top of the screen (in place of any scrolling ui_print()
100 // output, if necessary).
101 virtual void StartMenu(const char* const * headers, const char* const * items,
102 int initial_selection) = 0;
103
104 // Set the menu highlight to the given index, and return it (capped to
105 // the range [0..numitems).
106 virtual int SelectMenu(int sel) = 0;
107
108 // End menu mode, resetting the text overlay so that ui_print()
109 // statements will be displayed.
110 virtual void EndMenu() = 0;
Doug Zongker32a0a472011-11-01 11:00:20 -0700111
Doug Zongkerbb01d0c2012-12-17 10:52:58 -0800112protected:
113 void EnqueueKey(int key_code);
114
Doug Zongker32a0a472011-11-01 11:00:20 -0700115private:
116 // Key event input queue
117 pthread_mutex_t key_queue_mutex;
118 pthread_cond_t key_queue_cond;
119 int key_queue[256], key_queue_len;
120 char key_pressed[KEY_MAX + 1]; // under key_queue_mutex
121 int key_last_down; // under key_queue_mutex
Doug Zongkerc0441d12013-07-31 11:28:24 -0700122 bool key_long_press; // under key_queue_mutex
123 int key_down_count; // under key_queue_mutex
Doug Zongker32a0a472011-11-01 11:00:20 -0700124 int rel_sum;
125
Doug Zongker4db31d22013-09-04 13:44:38 -0700126 int consecutive_power_keys;
127 int consecutive_alternate_keys;
128 int last_key;
129
Doug Zongkerc0441d12013-07-31 11:28:24 -0700130 typedef struct {
131 RecoveryUI* ui;
132 int key_code;
133 int count;
134 } key_timer_t;
135
Doug Zongker32a0a472011-11-01 11:00:20 -0700136 pthread_t input_t;
137
138 static void* input_thread(void* cookie);
139 static int input_callback(int fd, short revents, void* data);
140 void process_key(int key_code, int updown);
141 bool usb_connected();
Doug Zongkerc0441d12013-07-31 11:28:24 -0700142
143 static void* time_key_helper(void* cookie);
144 void time_key(int key_code, int count);
Doug Zongker28ce47c2011-10-28 10:33:05 -0700145};
Doug Zongker28ce47c2011-10-28 10:33:05 -0700146
147#endif // RECOVERY_UI_H