blob: e451bdfa2b9065685ed697ea0b194f0525edcffe [file] [log] [blame]
Doug Zongkerddd6a282009-06-09 12:22:33 -07001/*
2 * Copyright (C) 2009 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
Doug Zongkerefa1bab2010-02-01 15:59:12 -080020// Called when recovery starts up. Returns 0.
21extern int device_recovery_start();
22
Doug Zongkerddd6a282009-06-09 12:22:33 -070023// Called in the input thread when a new key (key_code) is pressed.
24// *key_pressed is an array of KEY_MAX+1 bytes indicating which other
25// keys are already pressed. Return true if the text display should
26// be toggled.
Doug Zongker23412e62009-07-23 10:16:07 -070027extern int device_toggle_display(volatile char* key_pressed, int key_code);
Doug Zongkerddd6a282009-06-09 12:22:33 -070028
29// Called in the input thread when a new key (key_code) is pressed.
30// *key_pressed is an array of KEY_MAX+1 bytes indicating which other
31// keys are already pressed. Return true if the device should reboot
32// immediately.
Doug Zongker23412e62009-07-23 10:16:07 -070033extern int device_reboot_now(volatile char* key_pressed, int key_code);
Doug Zongkerddd6a282009-06-09 12:22:33 -070034
35// Called from the main thread when recovery is waiting for input and
36// a key is pressed. key is the code of the key pressed; visible is
37// true if the recovery menu is being shown. Implementations can call
38// ui_key_pressed() to discover if other keys are being held down.
39// Return one of the defined constants below in order to:
40//
41// - move the menu highlight (HIGHLIGHT_*)
42// - invoke the highlighted item (SELECT_ITEM)
43// - do nothing (NO_ACTION)
44// - invoke a specific action (a menu position: any non-negative number)
45extern int device_handle_key(int key, int visible);
46
47// Perform a recovery action selected from the menu. 'which' will be
48// the item number of the selected menu item, or a non-negative number
49// returned from device_handle_key(). The menu will be hidden when
50// this is called; implementations can call ui_print() to print
51// information to the screen.
52extern int device_perform_action(int which);
53
Doug Zongkerb128f542009-06-18 15:07:14 -070054// Called when we do a wipe data/factory reset operation (either via a
55// reboot from the main system with the --wipe_data flag, or when the
56// user boots into recovery manually and selects the option from the
57// menu.) Can perform whatever device-specific wiping actions are
58// needed. Return 0 on success. The userdata and cache partitions
59// are erased after this returns (whether it returns success or not).
60int device_wipe_data();
61
Doug Zongkerddd6a282009-06-09 12:22:33 -070062#define NO_ACTION -1
63
64#define HIGHLIGHT_UP -2
65#define HIGHLIGHT_DOWN -3
66#define SELECT_ITEM -4
67
68#define ITEM_REBOOT 0
69#define ITEM_APPLY_SDCARD 1
70#define ITEM_WIPE_DATA 2
71#define ITEM_WIPE_CACHE 3
72
73// Header text to display above the main menu.
74extern char* MENU_HEADERS[];
75
76// Text of menu items.
77extern char* MENU_ITEMS[];
78
79#endif