blob: cbecc4371f68b040f55e5b22bbf37d39fb11a959 [file] [log] [blame]
Doug Zongkerdaefc1d2011-10-31 09:34:15 -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_DEVICE_H
18#define _RECOVERY_DEVICE_H
19
Tao Bao1fe1afe2018-05-01 15:56:05 -070020#include <stddef.h>
21
Tao Bao551d2c32018-05-09 20:53:13 -070022#include <memory>
Tao Bao1fe1afe2018-05-01 15:56:05 -070023#include <string>
24#include <vector>
25
Tao Baoc16fd8a2018-04-30 17:12:03 -070026// Forward declaration to avoid including "ui.h".
27class RecoveryUI;
Doug Zongkerdaefc1d2011-10-31 09:34:15 -070028
29class Device {
Tao Baofc5499f2017-02-23 19:06:53 -080030 public:
Tao Bao1fe1afe2018-05-01 15:56:05 -070031 static constexpr const int kNoAction = -1;
32 static constexpr const int kHighlightUp = -2;
33 static constexpr const int kHighlightDown = -3;
34 static constexpr const int kInvokeItem = -4;
35
36 enum BuiltinAction {
37 NO_ACTION = 0,
38 REBOOT = 1,
39 APPLY_SDCARD = 2,
40 // APPLY_CACHE was 3.
41 APPLY_ADB_SIDELOAD = 4,
42 WIPE_DATA = 5,
43 WIPE_CACHE = 6,
44 REBOOT_BOOTLOADER = 7,
45 SHUTDOWN = 8,
46 VIEW_RECOVERY_LOGS = 9,
47 MOUNT_SYSTEM = 10,
48 RUN_GRAPHICS_TEST = 11,
49 RUN_LOCALE_TEST = 12,
Jerry Zhangb76af932018-05-22 12:08:35 -070050 KEY_INTERRUPTED = 13,
Tao Bao1fe1afe2018-05-01 15:56:05 -070051 };
52
Tao Baoe5d2c252018-05-09 11:05:44 -070053 explicit Device(RecoveryUI* ui);
Tao Baofc5499f2017-02-23 19:06:53 -080054 virtual ~Device() {}
Doug Zongkerdaefc1d2011-10-31 09:34:15 -070055
Tao Bao551d2c32018-05-09 20:53:13 -070056 // Returns a raw pointer to the RecoveryUI object.
Tao Baofc5499f2017-02-23 19:06:53 -080057 virtual RecoveryUI* GetUI() {
Tao Bao551d2c32018-05-09 20:53:13 -070058 return ui_.get();
Tao Baofc5499f2017-02-23 19:06:53 -080059 }
Doug Zongkerdaefc1d2011-10-31 09:34:15 -070060
Tao Bao551d2c32018-05-09 20:53:13 -070061 // Resets the UI object to the given UI. Used to override the default UI in case initialization
62 // failed, or we want a different UI for some reason. The device object will take the ownership.
63 virtual void ResetUI(RecoveryUI* ui) {
64 ui_.reset(ui);
Jerry Zhang2dea53e2018-05-02 17:15:03 -070065 }
66
Tao Baofc5499f2017-02-23 19:06:53 -080067 // Called when recovery starts up (after the UI has been obtained and initialized and after the
68 // arguments have been parsed, but before anything else).
69 virtual void StartRecovery() {};
Doug Zongkerdaefc1d2011-10-31 09:34:15 -070070
Tao Baofc5499f2017-02-23 19:06:53 -080071 // Called from the main thread when recovery is at the main menu and waiting for input, and a key
72 // is pressed. (Note that "at" the main menu does not necessarily mean the menu is visible;
Tao Bao551d2c32018-05-09 20:53:13 -070073 // recovery will be at the main menu with it invisible after an unsuccessful operation, such as
74 // failed to install an OTA package, or if recovery is started with no command.)
Tao Baofc5499f2017-02-23 19:06:53 -080075 //
76 // 'key' is the code of the key just pressed. (You can call IsKeyPressed() on the RecoveryUI
Tao Bao551d2c32018-05-09 20:53:13 -070077 // object you returned from GetUI() if you want to find out if other keys are held down.)
Tao Baofc5499f2017-02-23 19:06:53 -080078 //
79 // 'visible' is true if the menu is visible.
80 //
81 // Returns one of the defined constants below in order to:
Tao Bao1fe1afe2018-05-01 15:56:05 -070082 // - move the menu highlight (kHighlight{Up,Down}: negative value)
83 // - invoke the highlighted item (kInvokeItem: negative value)
84 // - do nothing (kNoAction: negative value)
85 // - invoke a specific action (a menu position: non-negative value)
Tao Baofc5499f2017-02-23 19:06:53 -080086 virtual int HandleMenuKey(int key, bool visible);
Doug Zongkerdaefc1d2011-10-31 09:34:15 -070087
Tao Bao1fe1afe2018-05-01 15:56:05 -070088 // Returns the list of menu items (a vector of strings). The menu_position passed to
Tao Bao551d2c32018-05-09 20:53:13 -070089 // InvokeMenuItem() will correspond to the indexes into this array.
Tao Bao1fe1afe2018-05-01 15:56:05 -070090 virtual const std::vector<std::string>& GetMenuItems();
Doug Zongkerdaefc1d2011-10-31 09:34:15 -070091
Tao Bao1fe1afe2018-05-01 15:56:05 -070092 // Performs a recovery action selected from the menu. 'menu_position' will be the index of the
93 // selected menu item, or a non-negative value returned from HandleMenuKey(). The menu will be
94 // hidden when this is called; implementations can call ui_print() to print information to the
Tao Baofc5499f2017-02-23 19:06:53 -080095 // screen. If the menu position is one of the builtin actions, you can just return the
96 // corresponding enum value. If it is an action specific to your device, you actually perform it
97 // here and return NO_ACTION.
Tao Bao1fe1afe2018-05-01 15:56:05 -070098 virtual BuiltinAction InvokeMenuItem(size_t menu_position);
Doug Zongkerdaefc1d2011-10-31 09:34:15 -070099
Tao Baoe5d2c252018-05-09 11:05:44 -0700100 // Removes the menu item for the given action. This allows tailoring the menu based on the
101 // runtime info, such as the availability of /cache or /sdcard.
102 virtual void RemoveMenuItemForAction(Device::BuiltinAction action);
103
Tao Baofc5499f2017-02-23 19:06:53 -0800104 // Called before and after we do a wipe data/factory reset operation, either via a reboot from the
105 // main system with the --wipe_data flag, or when the user boots into recovery image manually and
106 // selects the option from the menu, to perform whatever device-specific wiping actions as needed.
107 // Returns true on success; returning false from PreWipeData will prevent the regular wipe, and
108 // returning false from PostWipeData will cause the wipe to be considered a failure.
109 virtual bool PreWipeData() {
110 return true;
111 }
Doug Zongkerdaefc1d2011-10-31 09:34:15 -0700112
Tao Baofc5499f2017-02-23 19:06:53 -0800113 virtual bool PostWipeData() {
114 return true;
115 }
116
117 private:
Tao Bao551d2c32018-05-09 20:53:13 -0700118 // The RecoveryUI object that should be used to display the user interface for this device.
119 std::unique_ptr<RecoveryUI> ui_;
Doug Zongkerdaefc1d2011-10-31 09:34:15 -0700120};
121
Tao Baofc5499f2017-02-23 19:06:53 -0800122// The device-specific library must define this function (or the default one will be used, if there
123// is no device-specific library). It returns the Device object that recovery should use.
Doug Zongkerdaefc1d2011-10-31 09:34:15 -0700124Device* make_device();
125
126#endif // _DEVICE_H