blob: ccbb466ac658e2cd67656ad76a1ec56f3dc2a605 [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>
22
Doug Zongker211aebc2011-10-28 15:13:10 -070023// Abstract class for controlling the user interface during recovery.
24class RecoveryUI {
25 public:
Doug Zongker32a0a472011-11-01 11:00:20 -070026 RecoveryUI();
27
Doug Zongker211aebc2011-10-28 15:13:10 -070028 virtual ~RecoveryUI() { }
Doug Zongker28ce47c2011-10-28 10:33:05 -070029
Doug Zongker211aebc2011-10-28 15:13:10 -070030 // Initialize the object; called before anything else.
Doug Zongker32a0a472011-11-01 11:00:20 -070031 virtual void Init();
Doug Zongker28ce47c2011-10-28 10:33:05 -070032
Doug Zongker211aebc2011-10-28 15:13:10 -070033 // Set the overall recovery state ("background image").
Doug Zongker02ec6b82012-08-22 17:26:40 -070034 enum Icon { NONE, INSTALLING_UPDATE, ERASING, NO_COMMAND, ERROR };
Doug Zongker211aebc2011-10-28 15:13:10 -070035 virtual void SetBackground(Icon icon) = 0;
Doug Zongker28ce47c2011-10-28 10:33:05 -070036
Doug Zongker211aebc2011-10-28 15:13:10 -070037 // --- progress indicator ---
38 enum ProgressType { EMPTY, INDETERMINATE, DETERMINATE };
39 virtual void SetProgressType(ProgressType determinate) = 0;
Doug Zongker28ce47c2011-10-28 10:33:05 -070040
Doug Zongker211aebc2011-10-28 15:13:10 -070041 // Show a progress bar and define the scope of the next operation:
42 // portion - fraction of the progress bar the next operation will use
43 // seconds - expected time interval (progress bar moves at this minimum rate)
44 virtual void ShowProgress(float portion, float seconds) = 0;
45
46 // Set progress bar position (0.0 - 1.0 within the scope defined
47 // by the last call to ShowProgress).
48 virtual void SetProgress(float fraction) = 0;
49
50 // --- text log ---
51
52 virtual void ShowText(bool visible) = 0;
53
54 virtual bool IsTextVisible() = 0;
55
56 virtual bool WasTextEverVisible() = 0;
57
58 // Write a message to the on-screen log (shown if the user has
59 // toggled on the text display).
60 virtual void Print(const char* fmt, ...) = 0; // __attribute__((format(printf, 1, 2))) = 0;
61
62 // --- key handling ---
63
64 // Wait for keypress and return it. May return -1 after timeout.
Doug Zongker32a0a472011-11-01 11:00:20 -070065 virtual int WaitKey();
Doug Zongker211aebc2011-10-28 15:13:10 -070066
Doug Zongker32a0a472011-11-01 11:00:20 -070067 virtual bool IsKeyPressed(int key);
Doug Zongker211aebc2011-10-28 15:13:10 -070068
69 // Erase any queued-up keys.
Doug Zongker32a0a472011-11-01 11:00:20 -070070 virtual void FlushKeys();
Doug Zongker211aebc2011-10-28 15:13:10 -070071
Doug Zongkerdaefc1d2011-10-31 09:34:15 -070072 // Called on each keypress, even while operations are in progress.
73 // Return value indicates whether an immediate operation should be
74 // triggered (toggling the display, rebooting the device), or if
75 // the key should be enqueued for use by the main thread.
Doug Zongker48b5b072012-01-18 13:46:26 -080076 enum KeyAction { ENQUEUE, TOGGLE, REBOOT, IGNORE };
Doug Zongker32a0a472011-11-01 11:00:20 -070077 virtual KeyAction CheckKey(int key);
Doug Zongkerdaefc1d2011-10-31 09:34:15 -070078
Doug Zongker211aebc2011-10-28 15:13:10 -070079 // --- menu display ---
80
81 // Display some header text followed by a menu of items, which appears
82 // at the top of the screen (in place of any scrolling ui_print()
83 // output, if necessary).
84 virtual void StartMenu(const char* const * headers, const char* const * items,
85 int initial_selection) = 0;
86
87 // Set the menu highlight to the given index, and return it (capped to
88 // the range [0..numitems).
89 virtual int SelectMenu(int sel) = 0;
90
91 // End menu mode, resetting the text overlay so that ui_print()
92 // statements will be displayed.
93 virtual void EndMenu() = 0;
Doug Zongker32a0a472011-11-01 11:00:20 -070094
95private:
96 // Key event input queue
97 pthread_mutex_t key_queue_mutex;
98 pthread_cond_t key_queue_cond;
99 int key_queue[256], key_queue_len;
100 char key_pressed[KEY_MAX + 1]; // under key_queue_mutex
101 int key_last_down; // under key_queue_mutex
102 int rel_sum;
103
104 pthread_t input_t;
105
106 static void* input_thread(void* cookie);
107 static int input_callback(int fd, short revents, void* data);
108 void process_key(int key_code, int updown);
109 bool usb_connected();
Doug Zongker28ce47c2011-10-28 10:33:05 -0700110};
Doug Zongker28ce47c2011-10-28 10:33:05 -0700111
112#endif // RECOVERY_UI_H