diff options
Diffstat (limited to 'firmware')
-rw-r--r-- | firmware/2lib/2ui.c | 122 | ||||
-rw-r--r-- | firmware/2lib/2ui_screens.c | 68 | ||||
-rw-r--r-- | firmware/2lib/include/2ui.h | 12 |
3 files changed, 122 insertions, 80 deletions
diff --git a/firmware/2lib/2ui.c b/firmware/2lib/2ui.c index 4d363f68..81243ac2 100644 --- a/firmware/2lib/2ui.c +++ b/firmware/2lib/2ui.c @@ -95,11 +95,11 @@ const struct vb2_menu *get_menu(struct vb2_ui_context *ui) .num_items = 0, .items = NULL, }; - if (ui->state.screen->get_menu) { - menu = ui->state.screen->get_menu(ui); + if (ui->state->screen->get_menu) { + menu = ui->state->screen->get_menu(ui); return menu ? menu : &empty_menu; } else { - return &ui->state.screen->menu; + return &ui->state->screen->menu; } } @@ -125,7 +125,7 @@ vb2_error_t menu_navigation_action(struct vb2_ui_context *ui) case VB_KEY_ENTER: return vb2_ui_menu_select(ui); case VB_KEY_ESC: - return vb2_ui_change_root(ui); + return vb2_ui_screen_back(ui); default: if (key != 0) VB2_DEBUG("Pressed key %#x, trusted? %d\n", @@ -142,13 +142,13 @@ vb2_error_t vb2_ui_menu_prev(struct vb2_ui_context *ui) if (!DETACHABLE && ui->key == VB_BUTTON_VOL_UP_SHORT_PRESS) return VB2_REQUEST_UI_CONTINUE; - item = ui->state.selected_item - 1; + item = ui->state->selected_item - 1; while (item >= 0 && - ((1 << item) & ui->state.disabled_item_mask)) + ((1 << item) & ui->state->disabled_item_mask)) item--; /* Only update if item is valid */ if (item >= 0) - ui->state.selected_item = item; + ui->state->selected_item = item; return VB2_REQUEST_UI_CONTINUE; } @@ -162,13 +162,13 @@ vb2_error_t vb2_ui_menu_next(struct vb2_ui_context *ui) return VB2_REQUEST_UI_CONTINUE; menu = get_menu(ui); - item = ui->state.selected_item + 1; + item = ui->state->selected_item + 1; while (item < menu->num_items && - ((1 << item) & ui->state.disabled_item_mask)) + ((1 << item) & ui->state->disabled_item_mask)) item++; /* Only update if item is valid */ if (item < menu->num_items) - ui->state.selected_item = item; + ui->state->selected_item = item; return VB2_REQUEST_UI_CONTINUE; } @@ -185,7 +185,7 @@ vb2_error_t vb2_ui_menu_select(struct vb2_ui_context *ui) if (menu->num_items == 0) return VB2_REQUEST_UI_CONTINUE; - menu_item = &menu->items[ui->state.selected_item]; + menu_item = &menu->items[ui->state->selected_item]; if (menu_item->action) { VB2_DEBUG("Menu item <%s> run action\n", menu_item->text); @@ -193,7 +193,7 @@ vb2_error_t vb2_ui_menu_select(struct vb2_ui_context *ui) } else if (menu_item->target) { VB2_DEBUG("Menu item <%s> to target screen %#x\n", menu_item->text, menu_item->target); - return vb2_ui_change_screen(ui, menu_item->target); + return vb2_ui_screen_change(ui, menu_item->target); } VB2_DEBUG("Menu item <%s> no action or target screen\n", @@ -204,28 +204,35 @@ vb2_error_t vb2_ui_menu_select(struct vb2_ui_context *ui) /*****************************************************************************/ /* Screen navigation functions */ -vb2_error_t vb2_ui_change_root(struct vb2_ui_context *ui) +vb2_error_t vb2_ui_screen_back(struct vb2_ui_context *ui) { - return vb2_ui_change_screen(ui, ui->root_screen->id); + struct vb2_screen_state *tmp; + + if (ui->state && ui->state->prev) { + tmp = ui->state->prev; + free(ui->state); + ui->state = tmp; + } else { + VB2_DEBUG("ERROR: No previous screen; ignoring\n"); + } + + return VB2_REQUEST_UI_CONTINUE; } static vb2_error_t default_screen_init(struct vb2_ui_context *ui) { const struct vb2_menu *menu = get_menu(ui); - ui->state.selected_item = 0; + ui->state->selected_item = 0; if (menu->num_items > 1 && menu->items[0].is_language_select) - ui->state.selected_item = 1; + ui->state->selected_item = 1; return VB2_REQUEST_UI_CONTINUE; } -vb2_error_t vb2_ui_change_screen(struct vb2_ui_context *ui, enum vb2_screen id) +vb2_error_t vb2_ui_screen_change(struct vb2_ui_context *ui, enum vb2_screen id) { const struct vb2_screen_info *new_screen_info; - - if (ui->state.screen && ui->state.screen->id == id) { - VB2_DEBUG("WARNING: Already on screen %#x; ignoring\n", id); - return VB2_REQUEST_UI_CONTINUE; - } + struct vb2_screen_state *cur_state; + int state_exists = 0; new_screen_info = vb2_get_screen_info(id); if (new_screen_info == NULL) { @@ -233,13 +240,41 @@ vb2_error_t vb2_ui_change_screen(struct vb2_ui_context *ui, enum vb2_screen id) return VB2_REQUEST_UI_CONTINUE; } - memset(&ui->state, 0, sizeof(ui->state)); - ui->state.screen = new_screen_info; + /* Check to see if the screen state already exists in our stack. */ + cur_state = ui->state; + while (cur_state != NULL) { + if (cur_state->screen->id == id) { + state_exists = 1; + break; + } + cur_state = cur_state->prev; + } + + if (state_exists) { + /* Pop until the requested screen is at the top of stack. */ + while (ui->state->screen->id != id) { + cur_state = ui->state; + ui->state = cur_state->prev; + free(cur_state); + } + } else { + /* Allocate the requested screen on top of the stack. */ + cur_state = malloc(sizeof(*ui->state)); + memset(cur_state, 0, sizeof(*ui->state)); + if (cur_state == NULL) { + VB2_DEBUG("WARNING: malloc failed; ignoring\n"); + return VB2_REQUEST_UI_CONTINUE; + } + cur_state->prev = ui->state; + cur_state->screen = new_screen_info; + ui->state = cur_state; + if (ui->state->screen->init) + return ui->state->screen->init(ui); + else + return default_screen_init(ui); + } - if (ui->state.screen->init) - return ui->state.screen->init(ui); - else - return default_screen_init(ui); + return VB2_REQUEST_UI_CONTINUE; } /*****************************************************************************/ @@ -252,16 +287,17 @@ vb2_error_t ui_loop(struct vb2_context *ctx, enum vb2_screen root_screen_id, struct vb2_screen_state prev_state; enum vb2_ui_error prev_error_code; const struct vb2_menu *menu; + const struct vb2_screen_info *root_info; uint32_t key_flags; vb2_error_t rv; memset(&ui, 0, sizeof(ui)); ui.ctx = ctx; - ui.root_screen = vb2_get_screen_info(root_screen_id); - if (ui.root_screen == NULL) + root_info = vb2_get_screen_info(root_screen_id); + if (root_info == NULL) VB2_DIE("Root screen not found.\n"); ui.locale_id = vb2_nv_get(ctx, VB2_NV_LOCALIZATION_INDEX); - rv = vb2_ui_change_screen(&ui, ui.root_screen->id); + rv = vb2_ui_screen_change(&ui, root_screen_id); if (rv != VB2_REQUEST_UI_CONTINUE) return rv; memset(&prev_state, 0, sizeof(prev_state)); @@ -269,19 +305,19 @@ vb2_error_t ui_loop(struct vb2_context *ctx, enum vb2_screen root_screen_id, while (1) { /* Draw if there are state changes. */ - if (memcmp(&prev_state, &ui.state, sizeof(ui.state)) || + if (memcmp(&prev_state, ui.state, sizeof(*ui.state)) || /* we want to redraw/beep on a transition */ prev_error_code != ui.error_code) { menu = get_menu(&ui); VB2_DEBUG("<%s> menu item <%s>\n", - ui.state.screen->name, + ui.state->screen->name, menu->num_items ? - menu->items[ui.state.selected_item].text : + menu->items[ui.state->selected_item].text : "null"); - vb2ex_display_ui(ui.state.screen->id, ui.locale_id, - ui.state.selected_item, - ui.state.disabled_item_mask, + vb2ex_display_ui(ui.state->screen->id, ui.locale_id, + ui.state->selected_item, + ui.state->disabled_item_mask, ui.error_code); /* * Only beep if we're transitioning from no @@ -292,7 +328,7 @@ vb2_error_t ui_loop(struct vb2_context *ctx, enum vb2_screen root_screen_id, vb2ex_beep(250, 400); /* Update prev variables. */ - memcpy(&prev_state, &ui.state, sizeof(ui.state)); + memcpy(&prev_state, ui.state, sizeof(*ui.state)); prev_error_code = ui.error_code; } @@ -313,8 +349,8 @@ vb2_error_t ui_loop(struct vb2_context *ctx, enum vb2_screen root_screen_id, return rv; /* Run screen action. */ - if (ui.state.screen->action) { - rv = ui.state.screen->action(&ui); + if (ui.state->screen->action) { + rv = ui.state->screen->action(&ui); if (rv != VB2_REQUEST_UI_CONTINUE) return rv; } @@ -350,7 +386,7 @@ vb2_error_t developer_action(struct vb2_ui_context *ui) { /* Developer mode keyboard shortcuts */ if (ui->key == VB_KEY_CTRL('S')) - return vb2_ui_change_screen(ui, VB2_SCREEN_DEVELOPER_TO_NORM); + return vb2_ui_screen_change(ui, VB2_SCREEN_DEVELOPER_TO_NORM); if (ui->key == VB_KEY_CTRL('U') || (DETACHABLE && ui->key == VB_BUTTON_VOL_UP_LONG_PRESS)) return vb2_ui_developer_mode_boot_external_action(ui); @@ -402,7 +438,7 @@ vb2_error_t manual_recovery_action(struct vb2_ui_context *ui) VB2_DEBUG("Recovery VbTryLoadKernel %#x --> %#x\n", ui->recovery_rv, rv); ui->recovery_rv = rv; - return vb2_ui_change_screen(ui, + return vb2_ui_screen_change(ui, rv == VB2_ERROR_LK_NO_DISK_FOUND ? VB2_SCREEN_RECOVERY_SELECT : VB2_SCREEN_RECOVERY_INVALID); @@ -411,7 +447,7 @@ vb2_error_t manual_recovery_action(struct vb2_ui_context *ui) /* Manual recovery keyboard shortcuts */ if (ui->key == VB_KEY_CTRL('D') || (DETACHABLE && ui->key == VB_BUTTON_VOL_UP_DOWN_COMBO_PRESS)) - return vb2_ui_change_screen(ui, VB2_SCREEN_RECOVERY_TO_DEV); + return vb2_ui_screen_change(ui, VB2_SCREEN_RECOVERY_TO_DEV); /* TODO(b/144969088): Re-implement as debug info screen. */ if (ui->key == '\t') diff --git a/firmware/2lib/2ui_screens.c b/firmware/2lib/2ui_screens.c index c43abb8f..97c9b5e5 100644 --- a/firmware/2lib/2ui_screens.c +++ b/firmware/2lib/2ui_screens.c @@ -32,7 +32,7 @@ #define BACK_ITEM { \ .text = "Back", \ - .action = vb2_ui_change_root, \ + .action = vb2_ui_screen_back, \ } #define ADVANCED_OPTIONS_ITEM { \ @@ -65,7 +65,7 @@ static const struct vb2_screen_info blank_screen = { static vb2_error_t language_select_action(struct vb2_ui_context *ui) { vb2_error_t rv; - ui->locale_id = ui->state.selected_item; + ui->locale_id = ui->state->selected_item; VB2_DEBUG("Locale changed to %u\n", ui->locale_id); /* Write locale id back to nvdata. */ @@ -77,7 +77,7 @@ static vb2_error_t language_select_action(struct vb2_ui_context *ui) if (rv && !(ui->ctx->flags & VB2_CONTEXT_RECOVERY_MODE)) return rv; - return vb2_ui_change_root(ui); + return vb2_ui_screen_back(ui); } const struct vb2_menu *get_language_menu(struct vb2_ui_context *ui) @@ -117,14 +117,14 @@ static vb2_error_t language_select_init(struct vb2_ui_context *ui) if (menu->num_items == 0) { VB2_DEBUG("ERROR: No menu items found; " "rejecting entering language selection screen\n"); - return vb2_ui_change_root(ui); + return vb2_ui_screen_back(ui); } if (ui->locale_id < menu->num_items) { - ui->state.selected_item = ui->locale_id; + ui->state->selected_item = ui->locale_id; } else { VB2_DEBUG("WARNING: Current locale not found in menu items; " "initializing selected_item to 0\n"); - ui->state.selected_item = 0; + ui->state->selected_item = 0; } return VB2_REQUEST_UI_CONTINUE; } @@ -159,12 +159,12 @@ static const struct vb2_screen_info recovery_broken_screen = { vb2_error_t advanced_options_init(struct vb2_ui_context *ui) { - ui->state.selected_item = ADVANCED_OPTIONS_ITEM_DEVELOPER_MODE; + ui->state->selected_item = ADVANCED_OPTIONS_ITEM_DEVELOPER_MODE; if (vb2_get_sd(ui->ctx)->flags & VB2_SD_FLAG_DEV_MODE_ENABLED || !vb2_allow_recovery(ui->ctx)) { - ui->state.disabled_item_mask |= + ui->state->disabled_item_mask |= 1 << ADVANCED_OPTIONS_ITEM_DEVELOPER_MODE; - ui->state.selected_item = ADVANCED_OPTIONS_ITEM_BACK; + ui->state->selected_item = ADVANCED_OPTIONS_ITEM_BACK; } return VB2_REQUEST_UI_CONTINUE; @@ -195,12 +195,12 @@ static const struct vb2_screen_info advanced_options_screen = { vb2_error_t recovery_select_init(struct vb2_ui_context *ui) { - ui->state.selected_item = RECOVERY_SELECT_ITEM_PHONE; + ui->state->selected_item = RECOVERY_SELECT_ITEM_PHONE; if (!vb2api_phone_recovery_ui_enabled(ui->ctx)) { VB2_DEBUG("WARNING: Phone recovery not available\n"); - ui->state.disabled_item_mask |= + ui->state->disabled_item_mask |= 1 << RECOVERY_SELECT_ITEM_PHONE; - ui->state.selected_item = RECOVERY_SELECT_ITEM_EXTERNAL_DISK; + ui->state->selected_item = RECOVERY_SELECT_ITEM_EXTERNAL_DISK; } return VB2_REQUEST_UI_CONTINUE; } @@ -251,21 +251,21 @@ vb2_error_t recovery_to_dev_init(struct vb2_ui_context *ui) if (vb2_get_sd(ui->ctx)->flags & VB2_SD_FLAG_DEV_MODE_ENABLED) { /* We're in dev mode, so let user know they can't transition */ ui->error_code = VB2_UI_ERROR_DEV_MODE_ALREADY_ENABLED; - return vb2_ui_change_root(ui); + return vb2_ui_screen_back(ui); } if (!PHYSICAL_PRESENCE_KEYBOARD && vb2ex_physical_presence_pressed()) { VB2_DEBUG("Presence button stuck?\n"); - return vb2_ui_change_root(ui); + return vb2_ui_screen_back(ui); } - ui->state.selected_item = RECOVERY_TO_DEV_ITEM_CONFIRM; + ui->state->selected_item = RECOVERY_TO_DEV_ITEM_CONFIRM; /* Disable "Confirm" button for other physical presence types. */ if (!PHYSICAL_PRESENCE_KEYBOARD) { - ui->state.disabled_item_mask |= + ui->state->disabled_item_mask |= 1 << RECOVERY_TO_DEV_ITEM_CONFIRM; - ui->state.selected_item = RECOVERY_TO_DEV_ITEM_CANCEL; + ui->state->selected_item = RECOVERY_TO_DEV_ITEM_CANCEL; } ui->physical_presence_button_pressed = 0; @@ -278,7 +278,7 @@ static vb2_error_t recovery_to_dev_finalize(struct vb2_ui_context *ui) VB2_DEBUG("Physical presence confirmed!\n"); /* Sanity check, should never happen. */ - if (ui->state.screen->id != VB2_SCREEN_RECOVERY_TO_DEV || + if (ui->state->screen->id != VB2_SCREEN_RECOVERY_TO_DEV || (vb2_get_sd(ui->ctx)->flags & VB2_SD_FLAG_DEV_MODE_ENABLED) || !vb2_allow_recovery(ui->ctx)) { VB2_DEBUG("ERROR: Dev transition sanity check failed\n"); @@ -306,7 +306,7 @@ vb2_error_t recovery_to_dev_action(struct vb2_ui_context *ui) if (ui->key == ' ') { VB2_DEBUG("SPACE means cancel dev mode transition\n"); - return vb2_ui_change_root(ui); + return vb2_ui_screen_back(ui); } /* Keyboard physical presence case covered by "Confirm" action. */ @@ -335,7 +335,7 @@ static const struct vb2_menu_item recovery_to_dev_items[] = { }, [RECOVERY_TO_DEV_ITEM_CANCEL] = { .text = "Cancel", - .action = vb2_ui_change_root, + .action = vb2_ui_screen_back, }, POWER_OFF_ITEM, }; @@ -438,27 +438,27 @@ vb2_error_t developer_mode_init(struct vb2_ui_context *ui) enum vb2_dev_default_boot_target default_boot = vb2api_get_dev_default_boot_target(ui->ctx); - /* Get me outta here! */ + /* TODO(b/159579189): Split this case into a separate root screen */ if (!vb2_dev_boot_allowed(ui->ctx)) - vb2_ui_change_screen(ui, VB2_SCREEN_DEVELOPER_TO_NORM); + vb2_ui_screen_change(ui, VB2_SCREEN_DEVELOPER_TO_NORM); /* Don't show "Return to secure mode" button if GBB forces dev mode. */ if (vb2_get_gbb(ui->ctx)->flags & VB2_GBB_FLAG_FORCE_DEV_SWITCH_ON) - ui->state.disabled_item_mask |= + ui->state->disabled_item_mask |= 1 << DEVELOPER_MODE_ITEM_RETURN_TO_SECURE; /* Don't show "Boot from external disk" button if not allowed. */ if (!vb2_dev_boot_external_allowed(ui->ctx)) - ui->state.disabled_item_mask |= + ui->state->disabled_item_mask |= 1 << DEVELOPER_MODE_ITEM_BOOT_EXTERNAL; /* Choose the default selection. */ switch (default_boot) { case VB2_DEV_DEFAULT_BOOT_TARGET_EXTERNAL: - ui->state.selected_item = DEVELOPER_MODE_ITEM_BOOT_EXTERNAL; + ui->state->selected_item = DEVELOPER_MODE_ITEM_BOOT_EXTERNAL; break; default: - ui->state.selected_item = DEVELOPER_MODE_ITEM_BOOT_INTERNAL; + ui->state->selected_item = DEVELOPER_MODE_ITEM_BOOT_INTERNAL; break; } @@ -498,18 +498,20 @@ vb2_error_t vb2_ui_developer_mode_boot_external_action( if (rv == VB2_SUCCESS) { return VB2_SUCCESS; } else if (rv == VB2_ERROR_LK_NO_DISK_FOUND) { - if (ui->state.screen->id != VB2_SCREEN_DEVELOPER_BOOT_EXTERNAL) { + if (ui->state->screen->id != + VB2_SCREEN_DEVELOPER_BOOT_EXTERNAL) { VB2_DEBUG("No external disk found\n"); ui->error_code = VB2_UI_ERROR_DEV_EXTERNAL_BOOT_FAILED; } - return vb2_ui_change_screen( + return vb2_ui_screen_change( ui, VB2_SCREEN_DEVELOPER_BOOT_EXTERNAL); } else { - if (ui->state.screen->id != VB2_SCREEN_DEVELOPER_INVALID_DISK) { + if (ui->state->screen->id != + VB2_SCREEN_DEVELOPER_INVALID_DISK) { VB2_DEBUG("Invalid external disk: %#x\n", rv); ui->error_code = VB2_UI_ERROR_DEV_EXTERNAL_BOOT_FAILED; } - return vb2_ui_change_screen( + return vb2_ui_screen_change( ui, VB2_SCREEN_DEVELOPER_INVALID_DISK); } } @@ -519,6 +521,10 @@ vb2_error_t developer_mode_action(struct vb2_ui_context *ui) const int use_short = vb2api_use_short_dev_screen_delay(ui->ctx); uint64_t elapsed; + /* TODO(b/159579189): Split this case into a separate root screen */ + if (!vb2_dev_boot_allowed(ui->ctx)) + vb2_ui_screen_change(ui, VB2_SCREEN_DEVELOPER_TO_NORM); + /* Once any user interaction occurs, stop the timer. */ if (ui->key) ui->disable_timer = 1; @@ -600,7 +606,7 @@ static const struct vb2_menu_item developer_to_norm_items[] = { }, { .text = "Cancel", - .action = vb2_ui_change_root, + .action = vb2_ui_screen_back, }, POWER_OFF_ITEM, }; diff --git a/firmware/2lib/include/2ui.h b/firmware/2lib/include/2ui.h index 652362dc..35dddb89 100644 --- a/firmware/2lib/include/2ui.h +++ b/firmware/2lib/include/2ui.h @@ -56,6 +56,7 @@ struct vb2_screen_state { const struct vb2_screen_info *screen; uint32_t selected_item; uint32_t disabled_item_mask; + struct vb2_screen_state *prev; }; enum vb2_power_button { @@ -66,8 +67,7 @@ enum vb2_power_button { struct vb2_ui_context { struct vb2_context *ctx; - const struct vb2_screen_info *root_screen; - struct vb2_screen_state state; + struct vb2_screen_state *state; uint32_t locale_id; uint32_t key; int key_trusted; @@ -150,14 +150,14 @@ vb2_error_t vb2_ui_menu_select(struct vb2_ui_context *ui); /* Screen navigation functions */ /** - * Return back to the root screen. + * Return back to the previous screen. * - * Return to the root screen originally provided to the ui_loop() function. + * If the current screen is already the root scren, the request is ignored. * * @param ui UI context pointer * @return VB2_REQUEST_UI_CONTINUE, or error code on error. */ -vb2_error_t vb2_ui_change_root(struct vb2_ui_context *ui); +vb2_error_t vb2_ui_screen_back(struct vb2_ui_context *ui); /** * Change to the given screen. @@ -167,7 +167,7 @@ vb2_error_t vb2_ui_change_root(struct vb2_ui_context *ui); * @param ui UI context pointer * @return VB2_REQUEST_UI_CONTINUE, or error code on error. */ -vb2_error_t vb2_ui_change_screen(struct vb2_ui_context *ui, enum vb2_screen id); +vb2_error_t vb2_ui_screen_change(struct vb2_ui_context *ui, enum vb2_screen id); /*****************************************************************************/ /* UI loops */ |