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 #include <string>
25 
26 // Abstract class for controlling the user interface during recovery.
27 class RecoveryUI {
28   public:
29     RecoveryUI();
30 
~RecoveryUI()31     virtual ~RecoveryUI() { }
32 
33     // Initialize the object; called before anything else. UI texts will be
34     // initialized according to the given locale. Returns true on success.
35     virtual bool Init(const std::string& locale);
36 
37     // Show a stage indicator.  Call immediately after Init().
38     virtual void SetStage(int current, int max) = 0;
39 
40     // Set the overall recovery state ("background image").
41     enum Icon { NONE, INSTALLING_UPDATE, ERASING, NO_COMMAND, ERROR };
42     virtual void SetBackground(Icon icon) = 0;
43     virtual void SetSystemUpdateText(bool security_update) = 0;
44 
45     // --- progress indicator ---
46     enum ProgressType { EMPTY, INDETERMINATE, DETERMINATE };
47     virtual void SetProgressType(ProgressType determinate) = 0;
48 
49     // Show a progress bar and define the scope of the next operation:
50     //   portion - fraction of the progress bar the next operation will use
51     //   seconds - expected time interval (progress bar moves at this minimum rate)
52     virtual void ShowProgress(float portion, float seconds) = 0;
53 
54     // Set progress bar position (0.0 - 1.0 within the scope defined
55     // by the last call to ShowProgress).
56     virtual void SetProgress(float fraction) = 0;
57 
58     // --- text log ---
59 
60     virtual void ShowText(bool visible) = 0;
61 
62     virtual bool IsTextVisible() = 0;
63 
64     virtual bool WasTextEverVisible() = 0;
65 
66     // Write a message to the on-screen log (shown if the user has
67     // toggled on the text display). Print() will also dump the message
68     // to stdout / log file, while PrintOnScreenOnly() not.
69     virtual void Print(const char* fmt, ...) __printflike(2, 3) = 0;
70     virtual void PrintOnScreenOnly(const char* fmt, ...) __printflike(2, 3) = 0;
71 
72     virtual void ShowFile(const char* filename) = 0;
73 
74     // --- key handling ---
75 
76     // Wait for a key and return it.  May return -1 after timeout.
77     virtual int WaitKey();
78 
79     virtual bool IsKeyPressed(int key);
80     virtual bool IsLongPress();
81 
82     // Returns true if you have the volume up/down and power trio typical
83     // of phones and tablets, false otherwise.
84     virtual bool HasThreeButtons();
85 
86     // Erase any queued-up keys.
87     virtual void FlushKeys();
88 
89     // Called on each key press, even while operations are in progress.
90     // Return value indicates whether an immediate operation should be
91     // triggered (toggling the display, rebooting the device), or if
92     // the key should be enqueued for use by the main thread.
93     enum KeyAction { ENQUEUE, TOGGLE, REBOOT, IGNORE };
94     virtual KeyAction CheckKey(int key, bool is_long_press);
95 
96     // Called when a key is held down long enough to have been a
97     // long-press (but before the key is released).  This means that
98     // if the key is eventually registered (released without any other
99     // keys being pressed in the meantime), CheckKey will be called with
100     // 'is_long_press' true.
101     virtual void KeyLongPress(int key);
102 
103     // Normally in recovery there's a key sequence that triggers
104     // immediate reboot of the device, regardless of what recovery is
105     // doing (with the default CheckKey implementation, it's pressing
106     // the power button 7 times in row).  Call this to enable or
107     // disable that feature.  It is enabled by default.
108     virtual void SetEnableReboot(bool enabled);
109 
110     // --- menu display ---
111 
112     // Display some header text followed by a menu of items, which appears
113     // at the top of the screen (in place of any scrolling ui_print()
114     // output, if necessary).
115     virtual void StartMenu(const char* const * headers, const char* const * items,
116                            int initial_selection) = 0;
117 
118     // Set the menu highlight to the given index, wrapping if necessary.
119     // Returns the actual item selected.
120     virtual int SelectMenu(int sel) = 0;
121 
122     // End menu mode, resetting the text overlay so that ui_print()
123     // statements will be displayed.
124     virtual void EndMenu() = 0;
125 
126   protected:
127     void EnqueueKey(int key_code);
128 
129     // The locale that's used to show the rendered texts.
130     std::string locale_;
131     bool rtl_locale_;
132 
133     // The normal and dimmed brightness percentages (default: 50 and 25, which means 50% and 25%
134     // of the max_brightness). Because the absolute values may vary across devices. These two
135     // values can be configured via subclassing. Setting brightness_normal_ to 0 to disable
136     // screensaver.
137     unsigned int brightness_normal_;
138     unsigned int brightness_dimmed_;
139 
140   private:
141     // Key event input queue
142     pthread_mutex_t key_queue_mutex;
143     pthread_cond_t key_queue_cond;
144     int key_queue[256], key_queue_len;
145     char key_pressed[KEY_MAX + 1];     // under key_queue_mutex
146     int key_last_down;                 // under key_queue_mutex
147     bool key_long_press;               // under key_queue_mutex
148     int key_down_count;                // under key_queue_mutex
149     bool enable_reboot;                // under key_queue_mutex
150     int rel_sum;
151 
152     int consecutive_power_keys;
153     int last_key;
154 
155     bool has_power_key;
156     bool has_up_key;
157     bool has_down_key;
158 
159     struct key_timer_t {
160         RecoveryUI* ui;
161         int key_code;
162         int count;
163     };
164 
165     pthread_t input_thread_;
166 
167     void OnKeyDetected(int key_code);
168     int OnInputEvent(int fd, uint32_t epevents);
169     void ProcessKey(int key_code, int updown);
170 
171     bool IsUsbConnected();
172 
173     static void* time_key_helper(void* cookie);
174     void time_key(int key_code, int count);
175 
176     void SetLocale(const std::string&);
177 
178     enum class ScreensaverState { DISABLED, NORMAL, DIMMED, OFF };
179     ScreensaverState screensaver_state_;
180     // The following two contain the absolute values computed from brightness_normal_ and
181     // brightness_dimmed_ respectively.
182     unsigned int brightness_normal_value_;
183     unsigned int brightness_dimmed_value_;
184     bool InitScreensaver();
185 };
186 
187 #endif  // RECOVERY_UI_H
188