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) { } 35 36 // After calling Init(), you can tell the UI what locale it is operating in. 37 virtual void SetLocale(const char* locale) { } 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, ...) = 0; // __attribute__((format(printf, 1, 2))) = 0; 67 68 // --- key handling --- 69 70 // Wait for keypress and return it. May return -1 after timeout. 71 virtual int WaitKey(); 72 73 virtual bool IsKeyPressed(int key); 74 75 // Erase any queued-up keys. 76 virtual void FlushKeys(); 77 78 // 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. 82 enum KeyAction { ENQUEUE, TOGGLE, REBOOT, IGNORE, MOUNT_SYSTEM }; 83 virtual KeyAction CheckKey(int key); 84 85 // Called immediately before each call to CheckKey(), tell you if 86 // the key was long-pressed. 87 virtual void NextCheckKeyIsLong(bool is_long_press); 88 89 // 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 96 // Normally in recovery there's a key sequence that triggers 97 // immediate reboot of the device, regardless of what recovery is 98 // doing (with the default CheckKey implementation, it's pressing 99 // the power button 7 times in row). Call this to enable or 100 // disable that feature. It is enabled by default. 101 virtual void SetEnableReboot(bool enabled); 102 103 // --- menu display --- 104 105 // Display some header text followed by a menu of items, which appears 106 // at the top of the screen (in place of any scrolling ui_print() 107 // output, if necessary). 108 virtual void StartMenu(const char* const * headers, const char* const * items, 109 int initial_selection) = 0; 110 111 // Set the menu highlight to the given index, and return it (capped to 112 // the range [0..numitems). 113 virtual int SelectMenu(int sel) = 0; 114 115 // End menu mode, resetting the text overlay so that ui_print() 116 // statements will be displayed. 117 virtual void EndMenu() = 0; 118 119 protected: 120 void EnqueueKey(int key_code); 121 122 private: 123 // Key event input queue 124 pthread_mutex_t key_queue_mutex; 125 pthread_cond_t key_queue_cond; 126 int key_queue[256], key_queue_len; 127 char key_pressed[KEY_MAX + 1]; // under key_queue_mutex 128 int key_last_down; // under key_queue_mutex 129 bool key_long_press; // under key_queue_mutex 130 int key_down_count; // under key_queue_mutex 131 bool enable_reboot; // under key_queue_mutex 132 int rel_sum; 133 134 int consecutive_power_keys; 135 int consecutive_alternate_keys; 136 int last_key; 137 138 typedef struct { 139 RecoveryUI* ui; 140 int key_code; 141 int count; 142 } key_timer_t; 143 144 pthread_t input_t; 145 146 static void* input_thread(void* cookie); 147 static int input_callback(int fd, uint32_t epevents, void* data); 148 void process_key(int key_code, int updown); 149 bool usb_connected(); 150 151 static void* time_key_helper(void* cookie); 152 void time_key(int key_code, int count); 153 }; 154 155 #endif // RECOVERY_UI_H 156
