blob: e56a24b298003471d5aae88c4c9ee7d157895cab [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 *
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 */
17#ifndef _RECOVERY_UI_H
18#define _RECOVERY_UI_H
Doug Zongker6809c512011-03-01 14:04:34 -080020#include "common.h"
22// Called before UI library is initialized. Can change things like
23// how many frames are included in various animations, etc.
24extern void device_ui_init(UIParameters* ui_parameters);
Doug Zongkerefa1bab2010-02-01 15:59:12 -080026// Called when recovery starts up. Returns 0.
27extern int device_recovery_start();
Doug Zongkerddd6a282009-06-09 12:22:33 -070029// 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 text display should
32// be toggled.
Doug Zongker23412e62009-07-23 10:16:07 -070033extern int device_toggle_display(volatile char* key_pressed, int key_code);
Doug Zongkerddd6a282009-06-09 12:22:33 -070034
35// Called in the input thread when a new key (key_code) is pressed.
36// *key_pressed is an array of KEY_MAX+1 bytes indicating which other
37// keys are already pressed. Return true if the device should reboot
38// immediately.
Doug Zongker23412e62009-07-23 10:16:07 -070039extern int device_reboot_now(volatile char* key_pressed, int key_code);
Doug Zongkerddd6a282009-06-09 12:22:33 -070040
41// Called from the main thread when recovery is waiting for input and
42// a key is pressed. key is the code of the key pressed; visible is
43// true if the recovery menu is being shown. Implementations can call
44// ui_key_pressed() to discover if other keys are being held down.
45// Return one of the defined constants below in order to:
47// - move the menu highlight (HIGHLIGHT_*)
48// - invoke the highlighted item (SELECT_ITEM)
49// - do nothing (NO_ACTION)
50// - invoke a specific action (a menu position: any non-negative number)
51extern int device_handle_key(int key, int visible);
53// Perform a recovery action selected from the menu. 'which' will be
54// the item number of the selected menu item, or a non-negative number
55// returned from device_handle_key(). The menu will be hidden when
56// this is called; implementations can call ui_print() to print
57// information to the screen.
58extern int device_perform_action(int which);
Doug Zongkerb128f542009-06-18 15:07:14 -070060// Called when we do a wipe data/factory reset operation (either via a
61// reboot from the main system with the --wipe_data flag, or when the
62// user boots into recovery manually and selects the option from the
63// menu.) Can perform whatever device-specific wiping actions are
64// needed. Return 0 on success. The userdata and cache partitions
65// are erased after this returns (whether it returns success or not).
66int device_wipe_data();
Doug Zongkerddd6a282009-06-09 12:22:33 -070068#define NO_ACTION -1
70#define HIGHLIGHT_UP -2
71#define HIGHLIGHT_DOWN -3
72#define SELECT_ITEM -4
74#define ITEM_REBOOT 0
Doug Zongkerdc9e87c2010-07-29 17:08:50 -070075#define ITEM_APPLY_EXT 1
76#define ITEM_APPLY_SDCARD 1 // historical synonym for ITEM_APPLY_EXT
Doug Zongkerddd6a282009-06-09 12:22:33 -070077#define ITEM_WIPE_DATA 2
78#define ITEM_WIPE_CACHE 3
80// Header text to display above the main menu.
81extern char* MENU_HEADERS[];
83// Text of menu items.
84extern char* MENU_ITEMS[];