blob: e5edbb5e090d3cc8dc7eec1f65700944e1fb8ed9 [file] [log] [blame]
Masahisa Kojima87d79142022-09-12 17:33:50 +09001/* SPDX-License-Identifier: GPL-2.0+ */
2/*
3 * Menu-driven UEFI Variable maintenance
4 *
5 * Copyright (c) 2022 Masahisa Kojima, Linaro Limited
6 */
7
8#ifndef _EFI_CONFIG_H
9#define _EFI_CONFIG_H
10
11#include <efi_loader.h>
Masahisa Kojimacd160b22023-01-24 15:56:13 +090012#include <menu.h>
Masahisa Kojima87d79142022-09-12 17:33:50 +090013
Masahisa Kojima23aa0502023-01-24 15:56:16 +090014#define EFICONFIG_ENTRY_NUM_MAX INT_MAX
Masahisa Kojimae34158b2022-09-12 17:33:51 +090015#define EFICONFIG_VOLUME_PATH_MAX 512
Masahisa Kojima87d79142022-09-12 17:33:50 +090016#define EFICONFIG_FILE_PATH_MAX 512
17#define EFICONFIG_FILE_PATH_BUF_SIZE (EFICONFIG_FILE_PATH_MAX * sizeof(u16))
18
Masahisa Kojimacd160b22023-01-24 15:56:13 +090019extern const char *eficonfig_menu_desc;
Masahisa Kojima87d79142022-09-12 17:33:50 +090020typedef efi_status_t (*eficonfig_entry_func)(void *data);
21
22/**
23 * struct eficonfig_entry - menu entry structure
24 *
25 * @num: menu entry index
26 * @title: title of entry
27 * @key: unique key
28 * @efi_menu: pointer to the menu structure
29 * @func: callback function to be called when this entry is selected
30 * @data: data to be passed to the callback function, caller must free() this pointer
31 * @list: list structure
32 */
33struct eficonfig_entry {
34 u32 num;
35 char *title;
36 char key[3];
37 struct efimenu *efi_menu;
38 eficonfig_entry_func func;
39 void *data;
40 struct list_head list;
41};
42
43/**
44 * struct efimenu - efi menu structure
45 *
46 * @delay: delay for autoboot
47 * @active: active menu entry index
48 * @count: total count of menu entry
49 * @menu_header: menu header string
Masahisa Kojimacd160b22023-01-24 15:56:13 +090050 * @menu_desc: menu description string
Masahisa Kojima87d79142022-09-12 17:33:50 +090051 * @list: menu entry list structure
Masahisa Kojima8dbd0a02023-01-24 15:56:15 +090052 * @start: top menu index to draw
53 * @end: bottom menu index to draw
Masahisa Kojima87d79142022-09-12 17:33:50 +090054 */
55struct efimenu {
56 int delay;
57 int active;
58 int count;
59 char *menu_header;
Masahisa Kojimacd160b22023-01-24 15:56:13 +090060 const char *menu_desc;
Masahisa Kojima87d79142022-09-12 17:33:50 +090061 struct list_head list;
Masahisa Kojima8dbd0a02023-01-24 15:56:15 +090062 int start;
63 int end;
Masahisa Kojima87d79142022-09-12 17:33:50 +090064};
65
66/**
67 * struct eficonfig_item - structure to construct eficonfig_entry
68 *
69 * @title: title of entry
70 * @func: callback function to be called when this entry is selected
71 * @data: data to be passed to the callback function
72 */
73struct eficonfig_item {
74 char *title;
75 eficonfig_entry_func func;
76 void *data;
77};
78
79/**
80 * struct eficonfig_select_file_info - structure to be used for file selection
81 *
82 * @current_volume: pointer to the efi_simple_file_system_protocol
83 * @dp_volume: pointer to device path of the selected device
84 * @current_path: pointer to the selected file path string
85 * @filepath_list: list_head structure for file path list
86 * @file_selectred: flag indicates file selecting status
87 */
88struct eficonfig_select_file_info {
89 struct efi_simple_file_system_protocol *current_volume;
90 struct efi_device_path *dp_volume;
91 u16 *current_path;
92 struct list_head filepath_list;
93 bool file_selected;
94};
95
96void eficonfig_print_msg(char *msg);
Masahisa Kojimacd160b22023-01-24 15:56:13 +090097void eficonfig_print_entry(void *data);
98void eficonfig_display_statusline(struct menu *m);
99char *eficonfig_choice_entry(void *data);
Masahisa Kojima87d79142022-09-12 17:33:50 +0900100void eficonfig_destroy(struct efimenu *efi_menu);
101efi_status_t eficonfig_process_quit(void *data);
Masahisa Kojimacd160b22023-01-24 15:56:13 +0900102efi_status_t eficonfig_process_common(struct efimenu *efi_menu,
103 char *menu_header, const char *menu_desc,
104 void (*display_statusline)(struct menu *),
105 void (*item_data_print)(void *),
106 char *(*item_choice)(void *));
Masahisa Kojimaa84040a2022-11-20 09:21:13 +0900107efi_status_t eficonfig_process_select_file(void *data);
Masahisa Kojima87d79142022-09-12 17:33:50 +0900108efi_status_t eficonfig_get_unused_bootoption(u16 *buf,
109 efi_uintn_t buf_size, u32 *index);
110efi_status_t eficonfig_append_bootorder(u16 index);
Masahisa Kojimac416f1c2022-09-12 17:33:54 +0900111efi_status_t eficonfig_generate_media_device_boot_option(void);
Masahisa Kojima87d79142022-09-12 17:33:50 +0900112
Masahisa Kojima8961e932022-11-20 09:21:14 +0900113efi_status_t eficonfig_append_menu_entry(struct efimenu *efi_menu,
114 char *title, eficonfig_entry_func func,
115 void *data);
116efi_status_t eficonfig_append_quit_entry(struct efimenu *efi_menu);
Masahisa Kojimad6566112022-11-20 09:21:16 +0900117struct efi_device_path *eficonfig_create_device_path(struct efi_device_path *dp_volume,
118 u16 *current_path);
Masahisa Kojimac3b5af62022-11-20 09:21:18 +0900119void *eficonfig_create_fixed_menu(const struct eficonfig_item *items, int count);
120#ifdef CONFIG_EFI_SECURE_BOOT
121efi_status_t eficonfig_process_secure_boot_config(void *data);
122#endif
Masahisa Kojima8961e932022-11-20 09:21:14 +0900123
Masahisa Kojima87d79142022-09-12 17:33:50 +0900124#endif