1 /* 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 20 #include <linux/input.h> 21 #include <pthread.h> 22 #include <time.h> 23 24 // Abstract class for controlling the user interface during recovery. 25 class RecoveryUI { 26 public: 27 RecoveryUI(); 28 29 virtual ~RecoveryUI() { } 30 31 // Initialize the object; called before anything else. 32 virtual void Init(); 33 // Show a stage indicator. Call immediately after Init(). 34 virtual void SetStage(int current, int max) = 0; 35 36 // After calling Init(), you can tell the UI what locale it is operating in. 37 virtual void SetLocale(const char* locale) = 0; 38 39 // Set the overall recovery state ("background image"). 40 enum Icon { NONE, INSTALLING_UPDATE, ERASING, NO_COMMAND, ERROR }; 41 virtual void SetBackground(Icon icon) = 0; 42 43 // --- progress indicator --- 44 enum ProgressType { EMPTY, INDETERMINATE, DETERMINATE }; 45 virtual void SetProgressType(ProgressType determinate) = 0; 46 47 // 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, ...) __printflike(2, 3) = 0; 67 68 virtual void ShowFile(const char* filename) = 0; 69 70 // --- key handling --- 71 72 // Wait for a key and return it. May return -1 after timeout. 73 virtual int WaitKey(); 74 75 virtual bool IsKeyPressed(int key); 76 virtual bool IsLongPress(); 77 78 // 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 82 // Erase any queued-up keys. 83 virtual void FlushKeys(); 84 85 // Called on each key press, even while operations are in progress. 86 // 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. 89 enum KeyAction { ENQUEUE, TOGGLE, REBOOT, IGNORE }; 90 virtual KeyAction CheckKey(int key, bool is_long_press); 91 92 // 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 95 // keys being pressed in the meantime), CheckKey will be called with 96 // 'is_long_press' true. 97 virtual void KeyLongPress(int key); 98 99 // 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 106 // --- 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 114 // Set the menu highlight to the given index, wrapping if necessary. 115 // Returns the actual item selected. 116 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; 121 122 protected: 123 void EnqueueKey(int key_code); 124 125 private: 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 132 bool key_long_press; // under key_queue_mutex 133 int key_down_count; // under key_queue_mutex 134 bool enable_reboot; // under key_queue_mutex 135 int rel_sum; 136 137 int consecutive_power_keys; 138 int last_key; 139 140 bool has_power_key; 141 bool has_up_key; 142 bool has_down_key; 143 144 struct key_timer_t { 145 RecoveryUI* ui; 146 int key_code; 147 int count; 148 }; 149 150 pthread_t input_thread_; 151 152 void OnKeyDetected(int key_code); 153 154 static int InputCallback(int fd, uint32_t epevents, void* data); 155 int OnInputEvent(int fd, uint32_t epevents); 156 void ProcessKey(int key_code, int updown); 157 158 bool IsUsbConnected(); 159 160 static void* time_key_helper(void* cookie); 161 void time_key(int key_code, int count); 162 }; 163 164 #endif // RECOVERY_UI_H 165
