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 ~RecoveryUI()29 virtual ~RecoveryUI() { } 30 31 // Initialize the object; called before anything else. 32 virtual void Init(); 33 34 // After calling Init(), you can tell the UI what locale it is operating in. SetLocale(const char * locale)35 virtual void SetLocale(const char* locale) { } 36 37 // Set the overall recovery state ("background image"). 38 enum Icon { NONE, INSTALLING_UPDATE, ERASING, NO_COMMAND, ERROR }; 39 virtual void SetBackground(Icon icon) = 0; 40 41 // --- progress indicator --- 42 enum ProgressType { EMPTY, INDETERMINATE, DETERMINATE }; 43 virtual void SetProgressType(ProgressType determinate) = 0; 44 45 // 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. 69 virtual int WaitKey(); 70 71 virtual bool IsKeyPressed(int key); 72 73 // Erase any queued-up keys. 74 virtual void FlushKeys(); 75 76 // 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. 80 enum KeyAction { ENQUEUE, TOGGLE, REBOOT, IGNORE }; 81 virtual KeyAction CheckKey(int key); 82 83 virtual void NextCheckKeyIsLong(bool is_long_press); 84 85 // --- menu display --- 86 87 // Display some header text followed by a menu of items, which appears 88 // at the top of the screen (in place of any scrolling ui_print() 89 // output, if necessary). 90 virtual void StartMenu(const char* const * headers, const char* const * items, 91 int initial_selection) = 0; 92 93 // Set the menu highlight to the given index, and return it (capped to 94 // the range [0..numitems). 95 virtual int SelectMenu(int sel) = 0; 96 97 // End menu mode, resetting the text overlay so that ui_print() 98 // statements will be displayed. 99 virtual void EndMenu() = 0; 100 101 protected: 102 void EnqueueKey(int key_code); 103 104 private: 105 // Key event input queue 106 pthread_mutex_t key_queue_mutex; 107 pthread_cond_t key_queue_cond; 108 int key_queue[256], key_queue_len; 109 char key_pressed[KEY_MAX + 1]; // under key_queue_mutex 110 int key_last_down; // under key_queue_mutex 111 clock_t key_down_time; // under key_queue_mutex 112 int rel_sum; 113 114 pthread_t input_t; 115 116 static void* input_thread(void* cookie); 117 static int input_callback(int fd, short revents, void* data); 118 void process_key(int key_code, int updown); 119 bool usb_connected(); 120 }; 121 122 #endif // RECOVERY_UI_H 123