1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
|
/* Copyright 2020 The Chromium OS Authors. All rights reserved.
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*
* User interfaces for developer and recovery mode menus.
*/
#ifndef VBOOT_REFERENCE_2UI_H_
#define VBOOT_REFERENCE_2UI_H_
#include <2api.h>
#include <2sysincludes.h>
/*****************************************************************************/
/* Data structures */
struct vb2_ui_context; /* Forward declaration */
struct vb2_menu_item {
/* Text description */
const char *text;
/* Target screen */
enum vb2_screen target;
/* Action function takes precedence over target screen if non-NULL. */
vb2_error_t (*action)(struct vb2_ui_context *ui);
/* Whether the item is language selection */
int is_language_select;
};
struct vb2_menu {
/* Number of menu items */
uint16_t num_items;
/* List of menu items */
const struct vb2_menu_item *items;
};
struct vb2_screen_info {
/* Screen id */
enum vb2_screen id;
/* Screen name for printing to console only */
const char *name;
/*
* Init function runs once when changing to the screen which is not in
* the history stack.
*/
vb2_error_t (*init)(struct vb2_ui_context *ui);
/*
* Re-init function runs once when changing to the screen which is
* already in the history stack, for example, when going back to the
* screen. Exactly one of init() and reinit() will be called.
*/
vb2_error_t (*reinit)(struct vb2_ui_context *ui);
/* Action function runs repeatedly while on the screen. */
vb2_error_t (*action)(struct vb2_ui_context *ui);
/* Menu items. */
struct vb2_menu menu;
/*
* Custom function for getting menu items. If non-null, field 'menu'
* will be ignored.
*/
const struct vb2_menu *(*get_menu)(struct vb2_ui_context *ui);
/*
* Indices of menu items;
* used by log_page_* functions in 2ui_screens.c.
*/
uint32_t page_up_item;
uint32_t page_down_item;
uint32_t back_item;
uint32_t cancel_item;
};
struct vb2_screen_state {
const struct vb2_screen_info *screen;
uint32_t selected_item;
uint32_t disabled_item_mask;
uint32_t hidden_item_mask;
/* For log screen. */
uint32_t page_count;
uint32_t current_page;
/* For memory check screen. */
int test_finished; /* Do not update screen if the content is done */
struct vb2_screen_state *prev;
};
enum vb2_power_button {
VB2_POWER_BUTTON_HELD_SINCE_BOOT = 0,
VB2_POWER_BUTTON_RELEASED,
VB2_POWER_BUTTON_PRESSED, /* Must have been previously released */
};
struct vb2_ui_context {
struct vb2_context *ctx;
struct vb2_screen_state *state;
uint32_t locale_id;
uint32_t key;
int key_trusted;
/* For check_shutdown_request. */
enum vb2_power_button power_button;
/* For developer mode. */
int disable_timer;
uint32_t start_time_ms;
int beep_count;
/* For manual recovery. */
vb2_error_t recovery_rv;
/* For to_dev transition flow. */
int physical_presence_button_pressed;
/* For language selection screen. */
struct vb2_menu language_menu;
/* For bootloader selection screen. */
struct vb2_menu bootloader_menu;
/* For error beep sound. */
int error_beep;
/* For displaying error messages. */
enum vb2_ui_error error_code;
/* Force calling vb2ex_display_ui for refreshing the screen. This flag
will be reset after done. */
int force_display;
};
vb2_error_t vb2_ui_developer_mode_boot_internal_action(
struct vb2_ui_context *ui);
vb2_error_t vb2_ui_developer_mode_boot_external_action(
struct vb2_ui_context *ui);
vb2_error_t vb2_ui_developer_mode_boot_altfw_action(
struct vb2_ui_context *ui);
/**
* Get info struct of a screen.
*
* @param id Screen from enum vb2_screen
*
* @return screen info struct on success, NULL on error.
*/
const struct vb2_screen_info *vb2_get_screen_info(enum vb2_screen id);
/*****************************************************************************/
/* Menu navigation functions */
/**
* Move selection to the previous menu item.
*
* Update selected_item, taking into account hidden indices (from
* hidden_item_mask). The selection does not wrap, meaning that we block
* on 0 when we hit the start of the menu.
*
* @param ui UI context pointer
* @return VB2_SUCCESS, or error code on error.
*/
vb2_error_t vb2_ui_menu_prev(struct vb2_ui_context *ui);
/**
* Move selection to the next menu item.
*
* Update selected_item, taking into account hidden indices (from
* hidden_item_mask). The selection does not wrap, meaning that we block
* on the max index when we hit the end of the menu.
*
* @param ui UI context pointer
* @return VB2_SUCCESS, or error code on error.
*/
vb2_error_t vb2_ui_menu_next(struct vb2_ui_context *ui);
/**
* Select the current menu item.
*
* The caller should take care of returning after this function, and should not
* continue executing under the assumption that the screen has *not* changed.
*
* If the current menu item has an action associated with it, run the action.
* Otherwise, navigate to the target screen. If neither of these are set, then
* selecting the menu item is a no-op.
*
* @param ui UI context pointer
* @return VB2_SUCCESS, or error code on error.
*/
vb2_error_t vb2_ui_menu_select(struct vb2_ui_context *ui);
/*****************************************************************************/
/* Screen navigation functions */
/**
* After these functions are called, no assumptions may be made about which
* screen is currently displayed, and thus execution should return to ui_loop.
* VB2_REQUEST_UI_CONTINUE is returned rather than VB2_SUCCESS, so VB2_TRY can
* be used to wrapped to these functions and the callers of these functions.
*/
/**
* Return back to the previous screen.
*
* The caller should take care of returning after this function, and should not
* continue executing under the assumption that the screen has *not* changed.
*
* If the current screen is already the root screen, the request is ignored.
*
* TODO(b/157625765): Consider falling into recovery mode (BROKEN screen) when
* the current screen is already the root screen.
*
* @param ui UI context pointer
* @return VB2_REQUEST_UI_CONTINUE, or error code on error.
*/
vb2_error_t vb2_ui_screen_back(struct vb2_ui_context *ui);
/**
* Change to the given screen.
*
* The caller should take care of returning after this function, and should not
* continue executing under the assumption that the screen has *not* changed.
*
* If the screen is not found, the request is ignored.
*
* TODO(b/157625765): Consider falling into recovery mode (BROKEN screen) when
* the target screen is not found.
*
* @param ui UI context pointer
* @param id Screen from enum vb2_screen
* @return VB2_REQUEST_UI_CONTINUE, or error code on error.
*/
vb2_error_t vb2_ui_screen_change(struct vb2_ui_context *ui, enum vb2_screen id);
/*****************************************************************************/
/* UI loops */
/**
* UI for a developer-mode boot.
*
* Enter the developer menu, which provides options to switch out of developer
* mode, boot from external media, use legacy bootloader, or boot Chrome OS from
* disk.
*
* If a timeout occurs, take the default boot action.
*
* @param ctx Vboot context
* @returns VB2_SUCCESS, or non-zero error code.
*/
vb2_error_t vb2_developer_menu(struct vb2_context *ctx);
/**
* UI for a non-manual recovery ("BROKEN").
*
* Enter the recovery menu, which shows that an unrecoverable error was
* encountered last boot. Wait for the user to physically reset or shut down.
*
* @param ctx Vboot context
* @returns VB2_SUCCESS, or non-zero error code.
*/
vb2_error_t vb2_broken_recovery_menu(struct vb2_context *ctx);
/**
* UI for a manual recovery-mode boot.
*
* Enter the recovery menu, which prompts the user to insert recovery media,
* navigate the step-by-step recovery, or enter developer mode if allowed.
*
* @param ctx Vboot context
* @returns VB2_SUCCESS, or non-zero error code.
*/
vb2_error_t vb2_manual_recovery_menu(struct vb2_context *ctx);
/**
* UI for a diagnostic tools boot.
*
* Enter the diagnostic tools menu, which provides debug information and
* diagnostic tests of various hardware components.
*
* @param ctx Vboot context
* @returns VB2_SUCCESS, or non-zero error code.
*/
vb2_error_t vb2_diagnostic_menu(struct vb2_context *ctx);
#endif /* VBOOT_REFERENCE_2UI_H_ */
|
