blob: 9510fbedb051e768be4ca01d927d008bd8b486dc [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
22#include <string>
23#include <vector>
24
Tao Baoc16fd8a2018-04-30 17:12:03 -070025// Forward declaration to avoid including "ui.h".
26class RecoveryUI;
Doug Zongkerdaefc1d2011-10-31 09:34:15 -070027
28class Device {
Tao Baofc5499f2017-02-23 19:06:53 -080029 public:
Tao Bao1fe1afe2018-05-01 15:56:05 -070030 static constexpr const int kNoAction = -1;
31 static constexpr const int kHighlightUp = -2;
32 static constexpr const int kHighlightDown = -3;
33 static constexpr const int kInvokeItem = -4;
34
35 enum BuiltinAction {
36 NO_ACTION = 0,
37 REBOOT = 1,
38 APPLY_SDCARD = 2,
39 // APPLY_CACHE was 3.
40 APPLY_ADB_SIDELOAD = 4,
41 WIPE_DATA = 5,
42 WIPE_CACHE = 6,
43 REBOOT_BOOTLOADER = 7,
44 SHUTDOWN = 8,
45 VIEW_RECOVERY_LOGS = 9,
46 MOUNT_SYSTEM = 10,
47 RUN_GRAPHICS_TEST = 11,
48 RUN_LOCALE_TEST = 12,
49 };
50
Tao Baofc5499f2017-02-23 19:06:53 -080051 explicit Device(RecoveryUI* ui) : ui_(ui) {}
52 virtual ~Device() {}
Doug Zongkerdaefc1d2011-10-31 09:34:15 -070053
Tao Baofc5499f2017-02-23 19:06:53 -080054 // Called to obtain the UI object that should be used to display the recovery user interface for
55 // this device. You should not have called Init() on the UI object already, the caller will do
56 // that after this method returns.
57 virtual RecoveryUI* GetUI() {
58 return ui_;
59 }
Doug Zongkerdaefc1d2011-10-31 09:34:15 -070060
Jerry Zhang2dea53e2018-05-02 17:15:03 -070061 // Sets the UI object to the given UI. Used to override the default UI in case initialization
62 // failed, or we want a stub for some reason.
63 virtual void SetUI(RecoveryUI* ui) {
64 ui_ = ui;
65 }
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;
73 // recovery will be at the main menu with it invisible after an unsuccessful operation [ie OTA
74 // package failure], or if recovery is started with no command.)
75 //
76 // 'key' is the code of the key just pressed. (You can call IsKeyPressed() on the RecoveryUI
77 // object you returned from GetUI if you want to find out if other keys are held down.)
78 //
79 // 'visible' is true if the menu is visible.
80 //
81 // Returns one of the defined constants below in order to:
82 //
Tao Bao1fe1afe2018-05-01 15:56:05 -070083 // - move the menu highlight (kHighlight{Up,Down}: negative value)
84 // - invoke the highlighted item (kInvokeItem: negative value)
85 // - do nothing (kNoAction: negative value)
86 // - invoke a specific action (a menu position: non-negative value)
Tao Baofc5499f2017-02-23 19:06:53 -080087 virtual int HandleMenuKey(int key, bool visible);
Doug Zongkerdaefc1d2011-10-31 09:34:15 -070088
Tao Bao1fe1afe2018-05-01 15:56:05 -070089 // Returns the list of menu items (a vector of strings). The menu_position passed to
90 // InvokeMenuItem will correspond to the indexes into this array.
91 virtual const std::vector<std::string>& GetMenuItems();
Doug Zongkerdaefc1d2011-10-31 09:34:15 -070092
Tao Bao1fe1afe2018-05-01 15:56:05 -070093 // Performs a recovery action selected from the menu. 'menu_position' will be the index of the
94 // selected menu item, or a non-negative value returned from HandleMenuKey(). The menu will be
95 // hidden when this is called; implementations can call ui_print() to print information to the
Tao Baofc5499f2017-02-23 19:06:53 -080096 // screen. If the menu position is one of the builtin actions, you can just return the
97 // corresponding enum value. If it is an action specific to your device, you actually perform it
98 // here and return NO_ACTION.
Tao Bao1fe1afe2018-05-01 15:56:05 -070099 virtual BuiltinAction InvokeMenuItem(size_t menu_position);
Doug Zongkerdaefc1d2011-10-31 09:34:15 -0700100
Tao Baofc5499f2017-02-23 19:06:53 -0800101 // Called before and after we do a wipe data/factory reset operation, either via a reboot from the
102 // main system with the --wipe_data flag, or when the user boots into recovery image manually and
103 // selects the option from the menu, to perform whatever device-specific wiping actions as needed.
104 // Returns true on success; returning false from PreWipeData will prevent the regular wipe, and
105 // returning false from PostWipeData will cause the wipe to be considered a failure.
106 virtual bool PreWipeData() {
107 return true;
108 }
Doug Zongkerdaefc1d2011-10-31 09:34:15 -0700109
Tao Baofc5499f2017-02-23 19:06:53 -0800110 virtual bool PostWipeData() {
111 return true;
112 }
113
114 private:
115 RecoveryUI* ui_;
Doug Zongkerdaefc1d2011-10-31 09:34:15 -0700116};
117
Tao Baofc5499f2017-02-23 19:06:53 -0800118// The device-specific library must define this function (or the default one will be used, if there
119// is no device-specific library). It returns the Device object that recovery should use.
Doug Zongkerdaefc1d2011-10-31 09:34:15 -0700120Device* make_device();
121
122#endif // _DEVICE_H