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
|
/* 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_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. */
vb2_error_t (*init)(struct vb2_ui_context *ui);
/* Action function runs repeatedly while on the screen. */
vb2_error_t (*action)(struct vb2_ui_context *ui);
/* Number of menu items */
uint16_t num_items;
/* List of menu items */
const struct vb2_menu_item *items;
};
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);
};
struct vb2_screen_state {
const struct vb2_screen_info *screen;
uint32_t selected_item;
uint32_t disabled_item_mask;
};
struct vb2_ui_context {
struct vb2_context *ctx;
const struct vb2_screen_info *root_screen;
struct vb2_screen_state state;
uint32_t locale_id;
uint32_t key;
int key_trusted;
};
vb2_error_t vb2_ui_change_screen(struct vb2_ui_context *ui, enum vb2_screen id);
vb2_error_t vb2_ui_back_action(struct vb2_ui_context *ui);
vb2_error_t vb2_ui_recovery_to_dev_action(struct vb2_ui_context *ui);
/**
* Get info struct of a screen.
*
* @param screen 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);
/*****************************************************************************/
/* 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);
#endif /* VBOOT_REFERENCE_2UI_H_ */
|
