When an EFI application runs, it has access to a few descriptor and callback tables to instruct the EFI compliant firmware to do things for it. The bulk of those interfaces are "boot time services". They handle all object management, and memory allocation.

This patch adds support for the boot time services and also exposes a system table, which is the point of entry descriptor table for EFI payloads.

Signed-off-by: Alexander Graf agraf@suse.de Reviewed-by: Simon Glass sjg@chromium.org

---

v1 -> v2:

- Fix typo s/does now/does not/ - Add #ifdefs around header to allow inclusion when efi_loader is disabled - Add stub efi_restore_gd() function when efi_loader is disabled - Disable debug - Mark runtime region as such - Fix up memory map - Allow efi_restore_gd to be called before first efi entry - Add 32bit arm cache workaround - Move memory map to separate patch - Change BTS version to 2.5 - Fix return values for a few callbacks to more EFI compliant ones - Change vendor to "Das U-Boot" - Add warning when truncating timer trigger - Move to GPLv2+

v2 -> v3:

- Use external efi_memory helpers - Add EFIAPI to function prototypes - Initialize event timer to -1ULL to prevent early firing - Document header - Move obj list to lib - Remove implicit guid table - Add guid compare function - Fix return values - Implement efi_wait_for_event - Implement efi_install_configuration_table --- include/efi_loader.h | 84 +++++ lib/efi_loader/efi_boottime.c | 781 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 865 insertions(+) create mode 100644 lib/efi_loader/efi_boottime.c

diff --git a/include/efi_loader.h b/include/efi_loader.h index 5618185..a7f033e 100644 --- a/include/efi_loader.h +++ b/include/efi_loader.h @@ -6,15 +6,99 @@ * SPDX-License-Identifier: GPL-2.0+ */

+#include <common.h> #include <part_efi.h> #include <efi_api.h> + +#ifdef CONFIG_EFI_LOADER + #include <linux/list.h>

+/* #define DEBUG_EFI */ + +#ifdef DEBUG_EFI +#define EFI_ENTRY(format, ...) do { \ + efi_restore_gd(); \ + printf("EFI: Entry %s(" format ")\n", __func__, ##__VA_ARGS__); \ + } while(0) +#else +#define EFI_ENTRY(format, ...) do { \ + efi_restore_gd(); \ + } while(0) +#endif + +#define EFI_EXIT(ret) efi_exit_func(ret); + +extern struct efi_system_table systab; + extern const efi_guid_t efi_guid_device_path; extern const efi_guid_t efi_guid_loaded_image;

+/* + * While UEFI objects can have callbacks, you can also call functions on + * protocols (classes) themselves. This struct maps a protocol GUID to its + * interface (usually a struct with callback functions). + */ +struct efi_class_map { + const efi_guid_t *guid; + const void *interface; +}; + +/* + * When the UEFI payload wants to open a protocol on an object to get its + * interface (usually a struct with callback functions), this struct maps the + * protocol GUID to the respective protocol handler open function for that + * object protocol combination. + */ +struct efi_handler { + const efi_guid_t *guid; + efi_status_t (EFIAPI *open)(void *handle, + efi_guid_t *protocol, void **protocol_interface, + void *agent_handle, void *controller_handle, + uint32_t attributes); +}; + +/* + * UEFI has a poor man's OO model where one "object" can be polimorphic and have + * multiple different protocols (classes) attached to it. + * + * This struct is the parent struct for all of our actual implementation objects + * that can include it to make themselves an EFI object + */ +struct efi_object { + /* Every UEFI object is part of a global object list */ + struct list_head link; + /* We support up to 4 "protocols" an object can be accessed through */ + struct efi_handler protocols[4]; + /* The object spawner can either use this for data or as identifier */ + void *handle; +}; + +/* This list contains all UEFI objects we know of */ +extern struct list_head efi_obj_list; + +/* + * Stub implementation for a protocol opener that just returns the handle as + * interface + */ efi_status_t efi_return_handle(void *handle, efi_guid_t *protocol, void **protocol_interface, void *agent_handle, void *controller_handle, uint32_t attributes); +/* Called from places to check whether a timer expired */ +void efi_timer_check(void); +/* PE loader implementation */ void *efi_load_pe(void *efi, struct efi_loaded_image *loaded_image_info); +/* Called once to store the pristine gd pointer */ +void efi_save_gd(void); +/* Called from EFI_ENTRY on callback entry to put gd into the gd register */ +void efi_restore_gd(void); +/* Called from EFI_EXIT on callback exit to restore the gd register */ +efi_status_t efi_exit_func(efi_status_t ret); + +#else /* defined(EFI_LOADER) */ + +/* No loader configured, stub out EFI_ENTRY */ +static inline void efi_restore_gd(void) { } + +#endif diff --git a/lib/efi_loader/efi_boottime.c b/lib/efi_loader/efi_boottime.c new file mode 100644 index 0000000..e60fae9 --- /dev/null +++ b/lib/efi_loader/efi_boottime.c @@ -0,0 +1,781 @@ +/* + * EFI application boot time services + * + * Copyright (c) 2016 Alexander Graf + * + * SPDX-License-Identifier: GPL-2.0+ + */ + +/* #define DEBUG_EFI */ + +#include <common.h> +#include <efi_loader.h> +#include <malloc.h> +#include <asm/global_data.h> +#include <libfdt_env.h> +#include <u-boot/crc.h> +#include <bootm.h> +#include <inttypes.h> +#include <watchdog.h> + +DECLARE_GLOBAL_DATA_PTR; + +/* This list contains all the EFI objects our payload has access to */ +LIST_HEAD(efi_obj_list); + +/* + * If we're running on nasty systems (32bit ARM booting into non-EFI Linux) + * we need to do trickery with caches. Since we don't want to break the EFI + * aware boot path, only apply hacks when loading exiting directly (breaking + * direct Linux EFI booting along the way - oh well). + */ +static bool efi_is_direct_boot = true; + +/* + * EFI can pass arbitrary additional "tables" containing vendor specific + * information to the payload. One such table is the FDT table which contains + * a pointer to a flattened device tree blob. + * + * In most cases we want to pass an FDT to the payload, so reserve one slot of + * config table space for it. The pointer gets populated by do_bootefi_exec(). + */ +static struct efi_configuration_table efi_conf_table[1]; + +/* + * The "gd" pointer lives in a register on ARM and AArch64 that we declare + * fixed when compiling U-Boot. However, the payload does not know about that + * restriction so we need to manually swap its and our view of that register on + * EFI callback entry/exit. + */ +static volatile void *efi_gd, *app_gd; + +/* Called from do_bootefi_exec() */ +void efi_save_gd(void) +{ + efi_gd = gd; +} + +/* Called on every callback entry */ +void efi_restore_gd(void) +{ + /* Only restore if we're already in EFI context */ + if (!efi_gd) + return; + + if (gd != efi_gd) + app_gd = gd; + gd = efi_gd; +} + +/* Called on every callback exit */ +efi_status_t efi_exit_func(efi_status_t ret) +{ + gd = app_gd; + return ret; +} + +static efi_status_t efi_unsupported(const char *funcname) +{ +#ifdef DEBUG_EFI + printf("EFI: App called into unimplemented function %s\n", funcname); +#endif + return EFI_EXIT(EFI_UNSUPPORTED); +} + +static int guidcmp(const efi_guid_t *g1, const efi_guid_t *g2) +{ + return memcmp(g1, g2, sizeof(efi_guid_t)); +} + +static unsigned long EFIAPI efi_raise_tpl(unsigned long new_tpl) +{ + EFI_ENTRY("0x%lx", new_tpl); + return EFI_EXIT(0); +} + +static void EFIAPI efi_restore_tpl(unsigned long old_tpl) +{ + EFI_ENTRY("0x%lx", old_tpl); + EFI_EXIT(efi_unsupported(__func__)); +} + +efi_status_t EFIAPI efi_allocate_pages_ext(int type, int memory_type, + unsigned long pages, + uint64_t *memory) +{ + efi_status_t r; + + EFI_ENTRY("%d, %d, 0x%lx, %p", type, memory_type, pages, memory); + r = efi_allocate_pages(type, memory_type, pages, memory); + return EFI_EXIT(r); +} + +efi_status_t EFIAPI efi_free_pages_ext(uint64_t memory, unsigned long pages) +{ + efi_status_t r; + + EFI_ENTRY("%"PRIx64", 0x%lx", memory, pages); + r = efi_free_pages(memory, pages); + return EFI_EXIT(r); +} + +efi_status_t EFIAPI efi_get_memory_map_ext(unsigned long *memory_map_size, + struct efi_mem_desc *memory_map, + unsigned long *map_key, + unsigned long *descriptor_size, + uint32_t *descriptor_version) +{ + efi_status_t r; + + EFI_ENTRY("%p, %p, %p, %p, %p", memory_map_size, memory_map, + map_key, descriptor_size, descriptor_version); + r = efi_get_memory_map(memory_map_size, memory_map, map_key, + descriptor_size, descriptor_version); + return EFI_EXIT(r); +} + +static efi_status_t EFIAPI efi_allocate_pool(int pool_type, unsigned long size, + void **buffer) +{ + return efi_allocate_pages(0, pool_type, (size + 0xfff) >> 12, (void*)buffer); +} + +static efi_status_t EFIAPI efi_free_pool(void *buffer) +{ + return efi_free_pages((ulong)buffer, 0); +} + +/* + * Our event capabilities are very limited. Only support a single + * event to exist, so we don't need to maintain lists. + */ +static struct { + enum efi_event_type type; + u32 trigger_type; + u32 trigger_time; + u64 trigger_next; + unsigned long notify_tpl; + void (*notify_function) (void *event, void *context); + void *notify_context; +} efi_event = { + /* Disable timers on bootup */ + .trigger_next = -1ULL, +}; + +static efi_status_t EFIAPI efi_create_event( + enum efi_event_type type, ulong notify_tpl, + void (*notify_function) (void *event, void *context), + void *notify_context, void **event) +{ + EFI_ENTRY("%d, 0x%lx, %p, %p", type, notify_tpl, notify_function, + notify_context); + if (efi_event.notify_function) { + /* We only support one event at a time */ + return EFI_EXIT(EFI_OUT_OF_RESOURCES); + } + + efi_event.type = type; + efi_event.notify_tpl = notify_tpl; + efi_event.notify_function = notify_function; + efi_event.notify_context = notify_context; + *event = &efi_event; + + return EFI_EXIT(EFI_SUCCESS); +} + +/* + * Our timers have to work without interrupts, so we check whenever keyboard + * input or disk accesses happen if enough time elapsed for it to fire. + */ +void efi_timer_check(void) +{ + u64 now = timer_get_us(); + + if (now >= efi_event.trigger_next) { + /* Triggering! */ + if (efi_event.trigger_type == EFI_TIMER_PERIODIC) + efi_event.trigger_next += efi_event.trigger_time / 10; + efi_event.notify_function(&efi_event, efi_event.notify_context); + } + + WATCHDOG_RESET(); +} + +static efi_status_t EFIAPI efi_set_timer(void *event, int type, + uint64_t trigger_time) +{ + /* We don't have 64bit division available everywhere, so limit timer + * distances to 32bit bits. */ + u32 trigger32 = trigger_time; + + EFI_ENTRY("%p, %d, %"PRIx64, event, type, trigger_time); + + if (trigger32 < trigger_time) { + printf("WARNING: Truncating timer from %"PRIx64" to %x\n", + trigger_time, trigger32); + } + + if (event != &efi_event) { + /* We only support one event at a time */ + return EFI_EXIT(EFI_INVALID_PARAMETER); + } + + switch (type) { + case EFI_TIMER_STOP: + efi_event.trigger_next = -1ULL; + break; + case EFI_TIMER_PERIODIC: + case EFI_TIMER_RELATIVE: + efi_event.trigger_next = timer_get_us() + (trigger32 / 10); + break; + default: + return EFI_EXIT(EFI_INVALID_PARAMETER); + } + efi_event.trigger_type = type; + efi_event.trigger_time = trigger_time; + + return EFI_EXIT(EFI_SUCCESS); +} + +static efi_status_t EFIAPI efi_wait_for_event(unsigned long num_events, + void *event, unsigned long *index) +{ + u64 now; + + EFI_ENTRY("%ld, %p, %p", num_events, event, index); + + now = timer_get_us(); + while (now < efi_event.trigger_next) { } + efi_timer_check(); + + return EFI_EXIT(EFI_SUCCESS); +} + +static efi_status_t EFIAPI efi_signal_event(void *event) +{ + EFI_ENTRY("%p", event); + return EFI_EXIT(EFI_SUCCESS); +} + +static efi_status_t EFIAPI efi_close_event(void *event) +{ + EFI_ENTRY("%p", event); + efi_event.trigger_next = -1ULL; + return EFI_EXIT(EFI_SUCCESS); +} + +static efi_status_t EFIAPI efi_check_event(void *event) +{ + EFI_ENTRY("%p", event); + return EFI_EXIT(EFI_NOT_READY); +} + +static efi_status_t EFIAPI efi_install_protocol_interface(void **handle, + efi_guid_t *protocol, int protocol_interface_type, + void *protocol_interface) +{ + EFI_ENTRY("%p, %p, %d, %p", handle, protocol, protocol_interface_type, + protocol_interface); + return EFI_EXIT(EFI_OUT_OF_RESOURCES); +} +static efi_status_t EFIAPI efi_reinstall_protocol_interface(void *handle, + efi_guid_t *protocol, void *old_interface, + void *new_interface) +{ + EFI_ENTRY("%p, %p, %p, %p", handle, protocol, old_interface, + new_interface); + return EFI_EXIT(EFI_ACCESS_DENIED); +} + +static efi_status_t EFIAPI efi_uninstall_protocol_interface(void *handle, + efi_guid_t *protocol, void *protocol_interface) +{ + EFI_ENTRY("%p, %p, %p", handle, protocol, protocol_interface); + return EFI_EXIT(EFI_NOT_FOUND); +} + +static efi_status_t EFIAPI efi_register_protocol_notify(efi_guid_t *protocol, + void *event, + void **registration) +{ + EFI_ENTRY("%p, %p, %p", protocol, event, registration); + return EFI_EXIT(EFI_OUT_OF_RESOURCES); +} + +static int efi_search(enum efi_locate_search_type search_type, + efi_guid_t *protocol, void *search_key, + struct efi_object *efiobj) +{ + int i; + + switch (search_type) { + case all_handles: + return 0; + case by_register_notify: + return -1; + case by_protocol: + for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) { + const efi_guid_t *guid = efiobj->protocols[i].guid; + if (guid && !guidcmp(guid, protocol)) + return 0; + } + return -1; + } + + return -1; +} + +static efi_status_t EFIAPI efi_locate_handle( + enum efi_locate_search_type search_type, + efi_guid_t *protocol, void *search_key, + unsigned long *buffer_size, efi_handle_t *buffer) +{ + struct list_head *lhandle; + unsigned long size = 0; + + EFI_ENTRY("%d, %p, %p, %p, %p", search_type, protocol, search_key, + buffer_size, buffer); + + /* Count how much space we need */ + list_for_each(lhandle, &efi_obj_list) { + struct efi_object *efiobj; + efiobj = list_entry(lhandle, struct efi_object, link); + if (!efi_search(search_type, protocol, search_key, efiobj)) { + size += sizeof(void*); + } + } + + if (*buffer_size < size) { + *buffer_size = size; + return EFI_EXIT(EFI_BUFFER_TOO_SMALL); + } + + /* Then fill the array */ + list_for_each(lhandle, &efi_obj_list) { + struct efi_object *efiobj; + efiobj = list_entry(lhandle, struct efi_object, link); + if (!efi_search(search_type, protocol, search_key, efiobj)) { + *(buffer++) = efiobj->handle; + } + } + + *buffer_size = size; + return EFI_EXIT(EFI_SUCCESS); +} + +static efi_status_t EFIAPI efi_locate_device_path(efi_guid_t *protocol, + struct efi_device_path **device_path, + efi_handle_t *device) +{ + EFI_ENTRY("%p, %p, %p", protocol, device_path, device); + return EFI_EXIT(EFI_NOT_FOUND); +} + +static efi_status_t EFIAPI efi_install_configuration_table(efi_guid_t *guid, + void *table) +{ + int i; + + EFI_ENTRY("%p, %p", guid, table); + + /* Check for guid override */ + for (i = 0; i < systab.nr_tables; i++) { + if (!guidcmp(guid, &efi_conf_table[i].guid)) { + efi_conf_table[i].table = table; + return EFI_EXIT(EFI_SUCCESS); + } + } + + /* No override, check for overflow */ + if (i >= ARRAY_SIZE(efi_conf_table)) + return EFI_EXIT(EFI_OUT_OF_RESOURCES); + + /* Add a new entry */ + memcpy(&efi_conf_table[i].guid, guid, sizeof(*guid)); + efi_conf_table[i].table = table; + systab.nr_tables = i; + + return EFI_EXIT(EFI_SUCCESS); +} + +static efi_status_t EFIAPI efi_load_image(bool boot_policy, + efi_handle_t parent_image, + struct efi_device_path *file_path, + void *source_buffer, + unsigned long source_size, + efi_handle_t *image_handle) +{ + static struct efi_object loaded_image_info_obj = { + .protocols = { + { + .guid = &efi_guid_loaded_image, + .open = &efi_return_handle, + }, + }, + }; + struct efi_loaded_image *info; + struct efi_object *obj; + + EFI_ENTRY("%d, %p, %p, %p, %ld, %p", boot_policy, parent_image, + file_path, source_buffer, source_size, image_handle); + info = malloc(sizeof(*info)); + obj = malloc(sizeof(loaded_image_info_obj)); + memset(info, 0, sizeof(*info)); + memcpy(obj, &loaded_image_info_obj, sizeof(loaded_image_info_obj)); + obj->handle = info; + info->file_path = file_path; + info->reserved = efi_load_pe(source_buffer, info); + if (!info->reserved) { + free(info); + free(obj); + return EFI_EXIT(EFI_UNSUPPORTED); + } + + *image_handle = info; + list_add_tail(&obj->link, &efi_obj_list); + + return EFI_EXIT(EFI_SUCCESS); +} + +static efi_status_t EFIAPI efi_start_image(efi_handle_t image_handle, + unsigned long *exit_data_size, + s16 **exit_data) +{ + ulong (*entry)(void *image_handle, struct efi_system_table *st); + struct efi_loaded_image *info = image_handle; + + EFI_ENTRY("%p, %p, %p", image_handle, exit_data_size, exit_data); + entry = info->reserved; + + efi_is_direct_boot = false; + + /* call the image! */ + entry(image_handle, &systab); + + /* Should usually never get here */ + return EFI_EXIT(EFI_SUCCESS); +} + +static efi_status_t EFIAPI efi_exit(void *image_handle, long exit_status, + unsigned long exit_data_size, + uint16_t *exit_data) +{ + EFI_ENTRY("%p, %ld, %ld, %p", image_handle, exit_status, + exit_data_size, exit_data); + return EFI_EXIT(efi_unsupported(__func__)); +} + +static struct efi_object *efi_search_obj(void *handle) +{ + struct list_head *lhandle; + + list_for_each(lhandle, &efi_obj_list) { + struct efi_object *efiobj; + efiobj = list_entry(lhandle, struct efi_object, link); + if (efiobj->handle == handle) + return efiobj; + } + + return NULL; +} + +static efi_status_t EFIAPI efi_unload_image(void *image_handle) +{ + struct efi_object *efiobj; + + EFI_ENTRY("%p", image_handle); + efiobj = efi_search_obj(image_handle); + if (efiobj) + list_del(&efiobj->link); + + return EFI_EXIT(EFI_SUCCESS); +} + +static void efi_exit_caches(void) +{ +#if defined(CONFIG_ARM) && !defined(CONFIG_ARM64) + /* + * Grub on 32bit ARM needs to have caches disabled before jumping into + * a zImage, but does not know of all cache layers. Give it a hand. + */ + if (efi_is_direct_boot) + cleanup_before_linux(); +#endif +} + +static efi_status_t EFIAPI efi_exit_boot_services(void *image_handle, + unsigned long map_key) +{ + EFI_ENTRY("%p, %ld", image_handle, map_key); + + /* Fix up caches for EFI payloads if necessary */ + efi_exit_caches(); + + /* This stops all lingering devices */ + bootm_disable_interrupts(); + + /* Give the payload some time to boot */ + WATCHDOG_RESET(); + + return EFI_EXIT(EFI_SUCCESS); +} + +static efi_status_t EFIAPI efi_get_next_monotonic_count(uint64_t *count) +{ + static uint64_t mono = 0; + EFI_ENTRY("%p", count); + *count = mono++; + return EFI_EXIT(EFI_SUCCESS); +} + +static efi_status_t EFIAPI efi_stall(unsigned long microseconds) +{ + EFI_ENTRY("%ld", microseconds); + udelay(microseconds); + return EFI_EXIT(EFI_SUCCESS); +} + +static efi_status_t EFIAPI efi_set_watchdog_timer(unsigned long timeout, + uint64_t watchdog_code, + unsigned long data_size, + uint16_t *watchdog_data) +{ + EFI_ENTRY("%ld, 0x%"PRIx64", %ld, %p", timeout, watchdog_code, + data_size, watchdog_data); + return EFI_EXIT(efi_unsupported(__func__)); +} + +static efi_status_t EFIAPI efi_connect_controller( + efi_handle_t controller_handle, + efi_handle_t *driver_image_handle, + struct efi_device_path *remain_device_path, + bool recursive) +{ + EFI_ENTRY("%p, %p, %p, %d", controller_handle, driver_image_handle, + remain_device_path, recursive); + return EFI_EXIT(EFI_NOT_FOUND); +} + +static efi_status_t EFIAPI efi_disconnect_controller(void *controller_handle, + void *driver_image_handle, + void *child_handle) +{ + EFI_ENTRY("%p, %p, %p", controller_handle, driver_image_handle, + child_handle); + return EFI_EXIT(EFI_INVALID_PARAMETER); +} + +static efi_status_t EFIAPI efi_close_protocol(void *handle, + efi_guid_t *protocol, + void *agent_handle, + void *controller_handle) +{ + EFI_ENTRY("%p, %p, %p, %p", handle, protocol, agent_handle, + controller_handle); + return EFI_EXIT(EFI_NOT_FOUND); +} + +static efi_status_t EFIAPI efi_open_protocol_information(efi_handle_t handle, + efi_guid_t *protocol, + struct efi_open_protocol_info_entry **entry_buffer, + unsigned long *entry_count) +{ + EFI_ENTRY("%p, %p, %p, %p", handle, protocol, entry_buffer, + entry_count); + return EFI_EXIT(EFI_NOT_FOUND); +} + +static efi_status_t EFIAPI efi_protocols_per_handle(void *handle, + efi_guid_t ***protocol_buffer, + unsigned long *protocol_buffer_count) +{ + EFI_ENTRY("%p, %p, %p", handle, protocol_buffer, + protocol_buffer_count); + return EFI_EXIT(EFI_OUT_OF_RESOURCES); +} + +static efi_status_t EFIAPI efi_locate_handle_buffer( + enum efi_locate_search_type search_type, + efi_guid_t *protocol, void *search_key, + unsigned long *no_handles, efi_handle_t **buffer) +{ + EFI_ENTRY("%d, %p, %p, %p, %p", search_type, protocol, search_key, + no_handles, buffer); + return EFI_EXIT(EFI_NOT_FOUND); +} + +static struct efi_class_map efi_class_maps[] = { + { + .guid = &efi_guid_console_control, + .interface = &efi_console_control + }, +}; + +static efi_status_t EFIAPI efi_locate_protocol(efi_guid_t *protocol, + void *registration, + void **protocol_interface) +{ + int i; + + EFI_ENTRY("%p, %p, %p", protocol, registration, protocol_interface); + for (i = 0; i < ARRAY_SIZE(efi_class_maps); i++) { + struct efi_class_map *curmap = &efi_class_maps[i]; + if (!guidcmp(protocol, curmap->guid)) { + *protocol_interface = (void*)curmap->interface; + return EFI_EXIT(EFI_SUCCESS); + } + } + + return EFI_EXIT(EFI_NOT_FOUND); +} + +static efi_status_t EFIAPI efi_install_multiple_protocol_interfaces( + void **handle, ...) +{ + EFI_ENTRY("%p", handle); + return EFI_EXIT(EFI_OUT_OF_RESOURCES); +} + +static efi_status_t EFIAPI efi_uninstall_multiple_protocol_interfaces( + void *handle, ...) +{ + EFI_ENTRY("%p", handle); + return EFI_EXIT(EFI_INVALID_PARAMETER); +} + +static efi_status_t EFIAPI efi_calculate_crc32(void *data, + unsigned long data_size, + uint32_t *crc32_p) +{ + EFI_ENTRY("%p, %ld", data, data_size); + *crc32_p = crc32(0, data, data_size); + return EFI_EXIT(EFI_SUCCESS); +} + +static void EFIAPI efi_copy_mem(void *destination, void *source, + unsigned long length) +{ + EFI_ENTRY("%p, %p, %ld", destination, source, length); + memcpy(destination, source, length); +} + +static void EFIAPI efi_set_mem(void *buffer, unsigned long size, uint8_t value) +{ + EFI_ENTRY("%p, %ld, 0x%x", buffer, size, value); + memset(buffer, value, size); +} + +static efi_status_t EFIAPI efi_open_protocol( + void *handle, efi_guid_t *protocol, + void **protocol_interface, void *agent_handle, + void *controller_handle, uint32_t attributes) +{ + struct list_head *lhandle; + int i; + efi_status_t r = EFI_UNSUPPORTED; + + EFI_ENTRY("%p, %p, %p, %p, %p, 0x%x", handle, protocol, + protocol_interface, agent_handle, controller_handle, + attributes); + list_for_each(lhandle, &efi_obj_list) { + struct efi_object *efiobj; + efiobj = list_entry(lhandle, struct efi_object, link); + + if (efiobj->handle != handle) + continue; + + for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) { + struct efi_handler *handler = &efiobj->protocols[i]; + const efi_guid_t *hprotocol = handler->guid; + if (!hprotocol) + break; + if (!guidcmp(hprotocol, protocol)) { + r = handler->open(handle, protocol, + protocol_interface, agent_handle, + controller_handle, attributes); + goto out; + } + } + } + +out: + return EFI_EXIT(r); +} + +static efi_status_t EFIAPI efi_handle_protocol(void *handle, + efi_guid_t *protocol, + void **protocol_interface) +{ + EFI_ENTRY("%p, %p, %p", handle, protocol, protocol_interface); + return efi_open_protocol(handle, protocol, protocol_interface, + NULL, NULL, 0); +} + +static const struct efi_boot_services efi_boot_services = { + .hdr = { + .headersize = sizeof(struct efi_table_hdr), + }, + .raise_tpl = efi_raise_tpl, + .restore_tpl = efi_restore_tpl, + .allocate_pages = efi_allocate_pages_ext, + .free_pages = efi_free_pages_ext, + .get_memory_map = efi_get_memory_map_ext, + .allocate_pool = efi_allocate_pool, + .free_pool = efi_free_pool, + .create_event = efi_create_event, + .set_timer = efi_set_timer, + .wait_for_event = efi_wait_for_event, + .signal_event = efi_signal_event, + .close_event = efi_close_event, + .check_event = efi_check_event, + .install_protocol_interface = efi_install_protocol_interface, + .reinstall_protocol_interface = efi_reinstall_protocol_interface, + .uninstall_protocol_interface = efi_uninstall_protocol_interface, + .handle_protocol = efi_handle_protocol, + .reserved = NULL, + .register_protocol_notify = efi_register_protocol_notify, + .locate_handle = efi_locate_handle, + .locate_device_path = efi_locate_device_path, + .install_configuration_table = efi_install_configuration_table, + .load_image = efi_load_image, + .start_image = efi_start_image, + .exit = (void*)efi_exit, + .unload_image = efi_unload_image, + .exit_boot_services = efi_exit_boot_services, + .get_next_monotonic_count = efi_get_next_monotonic_count, + .stall = efi_stall, + .set_watchdog_timer = efi_set_watchdog_timer, + .connect_controller = efi_connect_controller, + .disconnect_controller = efi_disconnect_controller, + .open_protocol = efi_open_protocol, + .close_protocol = efi_close_protocol, + .open_protocol_information = efi_open_protocol_information, + .protocols_per_handle = efi_protocols_per_handle, + .locate_handle_buffer = efi_locate_handle_buffer, + .locate_protocol = efi_locate_protocol, + .install_multiple_protocol_interfaces = efi_install_multiple_protocol_interfaces, + .uninstall_multiple_protocol_interfaces = efi_uninstall_multiple_protocol_interfaces, + .calculate_crc32 = efi_calculate_crc32, + .copy_mem = efi_copy_mem, + .set_mem = efi_set_mem, +}; + + +static uint16_t firmware_vendor[] = + { 'D','a','s',' ','U','-','b','o','o','t',0 }; + +struct efi_system_table systab = { + .hdr = { + .signature = EFI_SYSTEM_TABLE_SIGNATURE, + .revision = 0x20005, /* 2.5 */ + .headersize = sizeof(struct efi_table_hdr), + }, + .fw_vendor = (long)firmware_vendor, + .con_in = (void*)&efi_con_in, + .con_out = (void*)&efi_con_out, + .std_err = (void*)&efi_con_out, + .runtime = (void*)&efi_runtime_services, + .boottime = (void*)&efi_boot_services, + .nr_tables = 0, + .tables = (void*)efi_conf_table, +};

One of the basic EFI interfaces is the console interface. Using it an EFI application can interface with the user. This patch implements an EFI console interface using getc() and putc().

Today, we only implement text based consoles. We also convert the EFI Unicode characters to UTF-8 on the fly, hoping that everyone managed to jump on the train by now.

Signed-off-by: Alexander Graf agraf@suse.de Reviewed-by: Simon Glass sjg@chromium.org

---

v1 -> v2:

- Move to GPLv2+

v2 -> v3:

- Add EFIAPI to function prototypes --- include/efi_loader.h | 5 + lib/efi_loader/efi_console.c | 360 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 365 insertions(+) create mode 100644 lib/efi_loader/efi_console.c

diff --git a/include/efi_loader.h b/include/efi_loader.h index a7f033e..46cd714 100644 --- a/include/efi_loader.h +++ b/include/efi_loader.h @@ -31,6 +31,11 @@

extern struct efi_system_table systab;

+extern const struct efi_simple_text_output_protocol efi_con_out; +extern const struct efi_simple_input_interface efi_con_in; +extern const struct efi_console_control_protocol efi_console_control; + +extern const efi_guid_t efi_guid_console_control; extern const efi_guid_t efi_guid_device_path; extern const efi_guid_t efi_guid_loaded_image;

diff --git a/lib/efi_loader/efi_console.c b/lib/efi_loader/efi_console.c new file mode 100644 index 0000000..5110c0a --- /dev/null +++ b/lib/efi_loader/efi_console.c @@ -0,0 +1,360 @@ +/* + * EFI application console interface + * + * Copyright (c) 2016 Alexander Graf + * + * SPDX-License-Identifier: GPL-2.0+ + */ + +#include <common.h> +#include <efi_loader.h> + +/* If we can't determine the console size, default to 80x24 */ +static int console_columns = 80; +static int console_rows = 24; +static bool console_size_queried; + +const efi_guid_t efi_guid_console_control = CONSOLE_CONTROL_GUID; + +#define cESC '\x1b' +#define ESC "\x1b" + +static efi_status_t EFIAPI efi_cin_get_mode( + struct efi_console_control_protocol *this, + int *mode, char *uga_exists, char *std_in_locked) +{ + EFI_ENTRY("%p, %p, %p, %p", this, mode, uga_exists, std_in_locked); + + if (mode) + *mode = EFI_CONSOLE_MODE_TEXT; + if (uga_exists) + *uga_exists = 0; + if (std_in_locked) + *std_in_locked = 0; + + return EFI_EXIT(EFI_SUCCESS); +} + +static efi_status_t EFIAPI efi_cin_set_mode( + struct efi_console_control_protocol *this, int mode) +{ + EFI_ENTRY("%p, %d", this, mode); + return EFI_EXIT(EFI_UNSUPPORTED); +} + +static efi_status_t EFIAPI efi_cin_lock_std_in( + struct efi_console_control_protocol *this, + uint16_t *password) +{ + EFI_ENTRY("%p, %p", this, password); + return EFI_EXIT(EFI_UNSUPPORTED); +} + +const struct efi_console_control_protocol efi_console_control = { + .get_mode = efi_cin_get_mode, + .set_mode = efi_cin_set_mode, + .lock_std_in = efi_cin_lock_std_in, +}; + +static struct simple_text_output_mode efi_con_mode = { + .max_mode = 0, + .mode = 0, + .attribute = 0, + .cursor_column = 0, + .cursor_row = 0, + .cursor_visible = 1, +}; + +static int term_read_reply(int *n, int maxnum, char end_char) +{ + char c; + int i = 0; + + c = getc(); + if (c != cESC) + return -1; + c = getc(); + if (c != '[') + return -1; + + n[0] = 0; + while (1) { + c = getc(); + if (c == ';') { + i++; + if (i >= maxnum) + return -1; + n[i] = 0; + continue; + } else if (c == end_char) { + break; + } else if (c > '9' || c < '0') { + return -1; + } + + /* Read one more decimal position */ + n[i] *= 10; + n[i] += c - '0'; + } + + return 0; +} + +static efi_status_t EFIAPI efi_cout_reset( + struct efi_simple_text_output_protocol *this, + char extended_verification) +{ + EFI_ENTRY("%p, %d", this, extended_verification); + return EFI_EXIT(EFI_UNSUPPORTED); +} + +static void print_unicode_in_utf8(u16 c) +{ + char utf8[4] = { 0 }; + char *b = utf8; + + if (c < 0x80) { + *(b++) = c; + } else if (c < 0x800) { + *(b++) = 192 + c / 64; + *(b++) = 128 + c % 64; + } else { + *(b++) = 224 + c / 4096; + *(b++) = 128 + c / 64 % 64; + *(b++) = 128 + c % 64; + } + + puts(utf8); +} + +static efi_status_t EFIAPI efi_cout_output_string( + struct efi_simple_text_output_protocol *this, + const unsigned short *string) +{ + u16 ch; + + EFI_ENTRY("%p, %p", this, string); + for (;(ch = *string); string++) { + print_unicode_in_utf8(ch); + efi_con_mode.cursor_column++; + if (ch == '\n') { + efi_con_mode.cursor_column = 1; + efi_con_mode.cursor_row++; + } else if (efi_con_mode.cursor_column > console_columns) { + efi_con_mode.cursor_column = 1; + efi_con_mode.cursor_row++; + } + if (efi_con_mode.cursor_row > console_rows) { + efi_con_mode.cursor_row = console_rows; + } + } + + return EFI_EXIT(EFI_SUCCESS); +} + +static efi_status_t EFIAPI efi_cout_test_string( + struct efi_simple_text_output_protocol *this, + const unsigned short *string) +{ + EFI_ENTRY("%p, %p", this, string); + return EFI_EXIT(EFI_SUCCESS); +} + +static efi_status_t EFIAPI efi_cout_query_mode( + struct efi_simple_text_output_protocol *this, + unsigned long mode_number, unsigned long *columns, + unsigned long *rows) +{ + EFI_ENTRY("%p, %ld, %p, %p", this, mode_number, columns, rows); + + if (!console_size_queried) { + /* Ask the terminal about its size */ + int n[3]; + u64 timeout; + + console_size_queried = true; + + /* Empty input buffer */ + while (tstc()) + getc(); + + printf(ESC"[18t"); + + /* Check if we have a terminal that understands */ + timeout = timer_get_us() + 1000000; + while (!tstc()) + if (timer_get_us() > timeout) + goto out; + + /* Read {depth,rows,cols} */ + if (term_read_reply(n, 3, 't')) { + goto out; + } + + console_columns = n[2]; + console_rows = n[1]; + } + +out: + if (columns) + *columns = console_columns; + if (rows) + *rows = console_rows; + + return EFI_EXIT(EFI_SUCCESS); +} + +static efi_status_t EFIAPI efi_cout_set_mode( + struct efi_simple_text_output_protocol *this, + unsigned long mode_number) +{ + EFI_ENTRY("%p, %ld", this, mode_number); + + /* We only support text output for now */ + if (mode_number == EFI_CONSOLE_MODE_TEXT) + return EFI_EXIT(EFI_SUCCESS); + + return EFI_EXIT(EFI_UNSUPPORTED); +} + +static efi_status_t EFIAPI efi_cout_set_attribute( + struct efi_simple_text_output_protocol *this, + unsigned long attribute) +{ + EFI_ENTRY("%p, %lx", this, attribute); + + /* Just ignore attributes (colors) for now */ + return EFI_EXIT(EFI_UNSUPPORTED); +} + +static efi_status_t EFIAPI efi_cout_clear_screen( + struct efi_simple_text_output_protocol *this) +{ + EFI_ENTRY("%p", this); + + printf(ESC"[2J"); + + return EFI_EXIT(EFI_SUCCESS); +} + +static efi_status_t EFIAPI efi_cout_set_cursor_position( + struct efi_simple_text_output_protocol *this, + unsigned long column, unsigned long row) +{ + EFI_ENTRY("%p, %ld, %ld", this, column, row); + + printf(ESC"[%d;%df", (int)row, (int)column); + efi_con_mode.cursor_column = column; + efi_con_mode.cursor_row = row; + + return EFI_EXIT(EFI_SUCCESS); +} + +static efi_status_t EFIAPI efi_cout_enable_cursor( + struct efi_simple_text_output_protocol *this, + bool enable) +{ + EFI_ENTRY("%p, %d", this, enable); + + printf(ESC"[?25%c", enable ? 'h' : 'l'); + + return EFI_EXIT(EFI_UNSUPPORTED); +} + +const struct efi_simple_text_output_protocol efi_con_out = { + .reset = efi_cout_reset, + .output_string = efi_cout_output_string, + .test_string = efi_cout_test_string, + .query_mode = efi_cout_query_mode, + .set_mode = efi_cout_set_mode, + .set_attribute = efi_cout_set_attribute, + .clear_screen = efi_cout_clear_screen, + .set_cursor_position = efi_cout_set_cursor_position, + .enable_cursor = efi_cout_enable_cursor, + .mode = (void*)&efi_con_mode, +}; + +static efi_status_t EFIAPI efi_cin_reset( + struct efi_simple_input_interface *this, + bool extended_verification) +{ + EFI_ENTRY("%p, %d", this, extended_verification); + return EFI_EXIT(EFI_UNSUPPORTED); +} + +static efi_status_t EFIAPI efi_cin_read_key_stroke( + struct efi_simple_input_interface *this, + struct efi_input_key *key) +{ + struct efi_input_key pressed_key = { + .scan_code = 0, + .unicode_char = 0, + }; + char ch; + + EFI_ENTRY("%p, %p", this, key); + + /* We don't do interrupts, so check for timers cooperatively */ + efi_timer_check(); + + if (!tstc()) { + /* No key pressed */ + return EFI_EXIT(EFI_NOT_READY); + } + + ch = getc(); + if (ch == cESC) { + /* Escape Sequence */ + ch = getc(); + switch (ch) { + case cESC: /* ESC */ + pressed_key.scan_code = 23; + break; + case 'O': /* F1 - F4 */ + pressed_key.scan_code = getc() - 'P' + 11; + break; + case 'a'...'z': + ch = ch - 'a'; + break; + case '[': + ch = getc(); + switch (ch) { + case 'A'...'D': /* up, down right, left */ + pressed_key.scan_code = ch - 'A' + 1; + break; + case 'F': /* End */ + pressed_key.scan_code = 6; + break; + case 'H': /* Home */ + pressed_key.scan_code = 5; + break; + case '1': /* F5 - F8 */ + pressed_key.scan_code = getc() - '0' + 11; + getc(); + break; + case '2': /* F9 - F12 */ + pressed_key.scan_code = getc() - '0' + 19; + getc(); + break; + case '3': /* DEL */ + pressed_key.scan_code = 8; + getc(); + break; + } + break; + } + } else if (ch == 0x7f) { + /* Backspace */ + ch = 0x08; + } + pressed_key.unicode_char = ch; + *key = pressed_key; + + return EFI_EXIT(EFI_SUCCESS); +} + +const struct efi_simple_input_interface efi_con_in = { + .reset = efi_cin_reset, + .read_key_stroke = efi_cin_read_key_stroke, + .wait_for_key = NULL, +};

After booting has finished, EFI allows firmware to still interact with the OS using the "runtime services". These callbacks live in a separate address space, since they are available long after U-Boot has been overwritten by the OS.

This patch adds enough framework for arbitrary code inside of U-Boot to become a runtime service with the right section attributes set. For now, we don't make use of it yet though.

We could maybe in the future map U-boot environment variables to EFI variables here.

Signed-off-by: Alexander Graf agraf@suse.de

---

v1 -> v2:

- Fix runtime service sections - Add runtime detach - Enable runtime relocations - Add get_time - Fix relocation - Fix 32bit - Add am335x support - Move section definition to header - Add systab to runtime section - Add self-relocation hook table - Fix self-relocation - Relocate efi_runtime section early during bootup - Fix return values for a number of callbacks to be more UEFI compliant - Move to GPLv2+

v2 -> v3:

- Patch reset to NULL - Add EFIAPI to function prototypes - Document header - Add dm.h include - Remove non-dm rtc support - Return DEVICE_ERROR in rtc path --- arch/arm/config.mk | 4 + arch/arm/cpu/armv8/u-boot.lds | 16 +++ arch/arm/cpu/u-boot.lds | 30 +++++ arch/arm/lib/sections.c | 4 + board/ti/am335x/u-boot.lds | 30 +++++ common/board_r.c | 4 + include/efi_loader.h | 17 +++ lib/efi_loader/efi_boottime.c | 6 +- lib/efi_loader/efi_runtime.c | 290 ++++++++++++++++++++++++++++++++++++++++++ 9 files changed, 398 insertions(+), 3 deletions(-) create mode 100644 lib/efi_loader/efi_runtime.c

diff --git a/arch/arm/config.mk b/arch/arm/config.mk index a3e14a8..99c5187 100644 --- a/arch/arm/config.mk +++ b/arch/arm/config.mk @@ -121,6 +121,10 @@ ifdef CONFIG_OF_EMBED OBJCOPYFLAGS += -j .dtb.init.rodata endif

+ifdef CONFIG_EFI_LOADER +OBJCOPYFLAGS += -j .efi_runtime -j .efi_runtime_rel +endif + ifneq ($(CONFIG_IMX_CONFIG),) ifdef CONFIG_SPL ifndef CONFIG_SPL_BUILD diff --git a/arch/arm/cpu/armv8/u-boot.lds b/arch/arm/cpu/armv8/u-boot.lds index 4c12222..fd15ad5 100644 --- a/arch/arm/cpu/armv8/u-boot.lds +++ b/arch/arm/cpu/armv8/u-boot.lds @@ -42,6 +42,22 @@ SECTIONS

. = ALIGN(8);

+ .efi_runtime : { + __efi_runtime_start = .; + *(efi_runtime_text) + *(efi_runtime_data) + __efi_runtime_stop = .; + } + + .efi_runtime_rel : { + __efi_runtime_rel_start = .; + *(.relaefi_runtime_text) + *(.relaefi_runtime_data) + __efi_runtime_rel_stop = .; + } + + . = ALIGN(8); + .image_copy_end : { *(.__image_copy_end) diff --git a/arch/arm/cpu/u-boot.lds b/arch/arm/cpu/u-boot.lds index d48a905..596a17d 100644 --- a/arch/arm/cpu/u-boot.lds +++ b/arch/arm/cpu/u-boot.lds @@ -89,6 +89,36 @@ SECTIONS

. = ALIGN(4);

+ .__efi_runtime_start : { + *(.__efi_runtime_start) + } + + .efi_runtime : { + *(efi_runtime_text) + *(efi_runtime_data) + } + + .__efi_runtime_stop : { + *(.__efi_runtime_stop) + } + + .efi_runtime_rel_start : + { + *(.__efi_runtime_rel_start) + } + + .efi_runtime_rel : { + *(.relefi_runtime_text) + *(.relefi_runtime_data) + } + + .efi_runtime_rel_stop : + { + *(.__efi_runtime_rel_stop) + } + + . = ALIGN(4); + .image_copy_end : { *(.__image_copy_end) diff --git a/arch/arm/lib/sections.c b/arch/arm/lib/sections.c index a1205c3..6a94522 100644 --- a/arch/arm/lib/sections.c +++ b/arch/arm/lib/sections.c @@ -27,4 +27,8 @@ char __rel_dyn_start[0] __attribute__((section(".__rel_dyn_start"))); char __rel_dyn_end[0] __attribute__((section(".__rel_dyn_end"))); char __secure_start[0] __attribute__((section(".__secure_start"))); char __secure_end[0] __attribute__((section(".__secure_end"))); +char __efi_runtime_start[0] __attribute__((section(".__efi_runtime_start"))); +char __efi_runtime_stop[0] __attribute__((section(".__efi_runtime_stop"))); +char __efi_runtime_rel_start[0] __attribute__((section(".__efi_runtime_rel_start"))); +char __efi_runtime_rel_stop[0] __attribute__((section(".__efi_runtime_rel_stop"))); char _end[0] __attribute__((section(".__end"))); diff --git a/board/ti/am335x/u-boot.lds b/board/ti/am335x/u-boot.lds index 78f294a..a56cc82 100644 --- a/board/ti/am335x/u-boot.lds +++ b/board/ti/am335x/u-boot.lds @@ -59,6 +59,36 @@ SECTIONS

. = ALIGN(4);

+ .__efi_runtime_start : { + *(.__efi_runtime_start) + } + + .efi_runtime : { + *(efi_runtime_text) + *(efi_runtime_data) + } + + .__efi_runtime_stop : { + *(.__efi_runtime_stop) + } + + .efi_runtime_rel_start : + { + *(.__efi_runtime_rel_start) + } + + .efi_runtime_rel : { + *(.relefi_runtime_text) + *(.relefi_runtime_data) + } + + .efi_runtime_rel_stop : + { + *(.__efi_runtime_rel_stop) + } + + . = ALIGN(4); + .image_copy_end : { *(.__image_copy_end) diff --git a/common/board_r.c b/common/board_r.c index 75ee43e..420e2c8 100644 --- a/common/board_r.c +++ b/common/board_r.c @@ -64,6 +64,7 @@ #ifdef CONFIG_AVR32 #include <asm/arch/mmu.h> #endif +#include <efi_loader.h>

DECLARE_GLOBAL_DATA_PTR;

@@ -176,6 +177,9 @@ static int initr_reloc_global_data(void) */ gd->fdt_blob += gd->reloc_off; #endif +#ifdef CONFIG_EFI_LOADER + efi_runtime_relocate(gd->relocaddr, NULL); +#endif

return 0; } diff --git a/include/efi_loader.h b/include/efi_loader.h index 46cd714..640e703 100644 --- a/include/efi_loader.h +++ b/include/efi_loader.h @@ -29,6 +29,7 @@

#define EFI_EXIT(ret) efi_exit_func(ret);

+extern struct efi_runtime_services efi_runtime_services; extern struct efi_system_table systab;

extern const struct efi_simple_text_output_protocol efi_con_out; @@ -39,6 +40,9 @@ extern const efi_guid_t efi_guid_console_control; extern const efi_guid_t efi_guid_device_path; extern const efi_guid_t efi_guid_loaded_image;

+extern unsigned int __efi_runtime_start, __efi_runtime_stop; +extern unsigned int __efi_runtime_rel_start, __efi_runtime_rel_stop; + /* * While UEFI objects can have callbacks, you can also call functions on * protocols (classes) themselves. This struct maps a protocol GUID to its @@ -100,9 +104,22 @@ void efi_save_gd(void); void efi_restore_gd(void); /* Called from EFI_EXIT on callback exit to restore the gd register */ efi_status_t efi_exit_func(efi_status_t ret); +/* Call this to relocate the runtime section to an address space */ +void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map); + +/* + * Use these to indicate that your code / data should go into the EFI runtime + * section and thus still be available when the OS is running + */ +#define EFI_RUNTIME_DATA __attribute__ ((section ("efi_runtime_data"))) +#define EFI_RUNTIME_TEXT __attribute__ ((section ("efi_runtime_text")))

#else /* defined(EFI_LOADER) */

+/* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */ +#define EFI_RUNTIME_DATA +#define EFI_RUNTIME_TEXT + /* No loader configured, stub out EFI_ENTRY */ static inline void efi_restore_gd(void) { }

diff --git a/lib/efi_loader/efi_boottime.c b/lib/efi_loader/efi_boottime.c index e60fae9..87400de 100644 --- a/lib/efi_loader/efi_boottime.c +++ b/lib/efi_loader/efi_boottime.c @@ -39,7 +39,7 @@ static bool efi_is_direct_boot = true; * In most cases we want to pass an FDT to the payload, so reserve one slot of * config table space for it. The pointer gets populated by do_bootefi_exec(). */ -static struct efi_configuration_table efi_conf_table[1]; +static struct efi_configuration_table EFI_RUNTIME_DATA efi_conf_table[1];

/* * The "gd" pointer lives in a register on ARM and AArch64 that we declare @@ -761,10 +761,10 @@ static const struct efi_boot_services efi_boot_services = { };

-static uint16_t firmware_vendor[] = +static uint16_t EFI_RUNTIME_DATA firmware_vendor[] = { 'D','a','s',' ','U','-','b','o','o','t',0 };

-struct efi_system_table systab = { +struct efi_system_table EFI_RUNTIME_DATA systab = { .hdr = { .signature = EFI_SYSTEM_TABLE_SIGNATURE, .revision = 0x20005, /* 2.5 */ diff --git a/lib/efi_loader/efi_runtime.c b/lib/efi_loader/efi_runtime.c new file mode 100644 index 0000000..22bcd08 --- /dev/null +++ b/lib/efi_loader/efi_runtime.c @@ -0,0 +1,290 @@ +/* + * EFI application runtime services + * + * Copyright (c) 2016 Alexander Graf + * + * SPDX-License-Identifier: GPL-2.0+ + */ + +#include <common.h> +#include <command.h> +#include <dm.h> +#include <efi_loader.h> +#include <rtc.h> +#include <asm/global_data.h> + +/* For manual relocation support */ +DECLARE_GLOBAL_DATA_PTR; + +static efi_status_t EFI_RUNTIME_TEXT EFIAPI efi_unimplemented(void); +static efi_status_t EFI_RUNTIME_TEXT EFIAPI efi_device_error(void); +static efi_status_t EFI_RUNTIME_TEXT EFIAPI efi_invalid_parameter(void); + +#if defined(CONFIG_ARM64) +#define R_RELATIVE 1027 +#define R_MASK 0xffffffffULL +#define IS_RELA 1 +#elif defined(CONFIG_ARM) +#define R_RELATIVE 23 +#define R_MASK 0xffULL +#else +#error Need to add relocation awareness +#endif + +struct elf_rel { + ulong *offset; + ulong info; +}; + +struct elf_rela { + ulong *offset; + ulong info; + long addend; +}; + +/* + * EFI Runtime code lives in 2 stages. In the first stage, U-Boot and an EFI + * payload are running concurrently at the same time. In this mode, we can + * handle a good number of runtime callbacks + */ + +static void EFIAPI efi_reset_system(enum efi_reset_type reset_type, + efi_status_t reset_status, + unsigned long data_size, void *reset_data) +{ + EFI_ENTRY("%d %lx %lx %p", reset_type, reset_status, data_size, + reset_data); + + switch (reset_type) { + case EFI_RESET_COLD: + case EFI_RESET_WARM: + do_reset(NULL, 0, 0, NULL); + break; + case EFI_RESET_SHUTDOWN: + /* We don't have anything to map this to */ + break; + } + + EFI_EXIT(EFI_SUCCESS); +} + +static efi_status_t EFIAPI efi_get_time(struct efi_time *time, + struct efi_time_cap *capabilities) +{ +#if defined(CONFIG_CMD_DATE) && defined(CONFIG_DM_RTC) + struct rtc_time tm; + int r; + struct udevice *dev; + + EFI_ENTRY("%p %p", time, capabilities); + + r = uclass_get_device(UCLASS_RTC, 0, &dev); + if (r) + return EFI_EXIT(EFI_DEVICE_ERROR); + + r = dm_rtc_get(dev, &tm); + if (r) + return EFI_EXIT(EFI_DEVICE_ERROR); + + memset(time, 0, sizeof(*time)); + time->year = tm.tm_year; + time->month = tm.tm_mon; + time->day = tm.tm_mday; + time->hour = tm.tm_hour; + time->minute = tm.tm_min; + time->daylight = tm.tm_isdst; + + return EFI_EXIT(EFI_SUCCESS); +#else + return EFI_DEVICE_ERROR; +#endif +} + +struct efi_runtime_detach_list_struct { + void *ptr; + void *patchto; +}; + +static const struct efi_runtime_detach_list_struct efi_runtime_detach_list[] = { + { + /* do_reset is gone */ + .ptr = &efi_runtime_services.reset_system, + .patchto = NULL, + }, { + /* invalidate_*cache_all are gone */ + .ptr = &efi_runtime_services.set_virtual_address_map, + .patchto = &efi_invalid_parameter, + }, { + /* RTC accessors are gone */ + .ptr = &efi_runtime_services.get_time, + .patchto = &efi_device_error, + }, +}; + +static bool efi_runtime_tobedetached(void *p) +{ + int i; + + for (i = 0; i < ARRAY_SIZE(efi_runtime_detach_list); i++) + if (efi_runtime_detach_list[i].ptr == p) + return true; + + return false; +} + +static void efi_runtime_detach(ulong offset) +{ + int i; + ulong patchoff = offset - (ulong)gd->relocaddr; + + for (i = 0; i < ARRAY_SIZE(efi_runtime_detach_list); i++) { + ulong patchto = (ulong)efi_runtime_detach_list[i].patchto; + ulong *p = efi_runtime_detach_list[i].ptr; + ulong newaddr = patchto ? (patchto + patchoff) : 0; + +#ifdef DEBUG_EFI + printf("%s: Setting %p to %lx\n", __func__, p, newaddr); +#endif + *p = newaddr; + } +} + +/* Relocate EFI runtime to uboot_reloc_base = offset */ +void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map) +{ +#ifdef IS_RELA + struct elf_rela *rel = (void*)&__efi_runtime_rel_start; +#else + struct elf_rel *rel = (void*)&__efi_runtime_rel_start; + static ulong lastoff = CONFIG_SYS_TEXT_BASE; +#endif + +#ifdef DEBUG_EFI + printf("%s: Relocating to offset=%lx\n", __func__, offset); +#endif + + for (; (ulong)rel < (ulong)&__efi_runtime_rel_stop; rel++) { + ulong base = CONFIG_SYS_TEXT_BASE; + ulong *p; + ulong newaddr; + + p = (void*)((ulong)rel->offset - base) + gd->relocaddr; + + if ((rel->info & R_MASK) != R_RELATIVE) { + continue; + } + +#ifdef IS_RELA + newaddr = rel->addend + offset - CONFIG_SYS_TEXT_BASE; +#else + newaddr = *p - lastoff + offset; +#endif + + /* Check if the relocation is inside bounds */ + if (map && ((newaddr < map->virtual_start) || + newaddr > (map->virtual_start + (map->num_pages << 12)))) { + if (!efi_runtime_tobedetached(p)) + printf("U-Boot EFI: Relocation at %p is out of " + "range (%lx)\n", p, newaddr); + continue; + } + +#ifdef DEBUG_EFI + printf("%s: Setting %p to %lx\n", __func__, p, newaddr); +#endif + + *p = newaddr; + flush_dcache_range((ulong)p, (ulong)&p[1]); + } + +#ifndef IS_RELA + lastoff = offset; +#endif + + invalidate_icache_all(); +} + +static efi_status_t EFIAPI efi_set_virtual_address_map( + unsigned long memory_map_size, + unsigned long descriptor_size, + uint32_t descriptor_version, + struct efi_mem_desc *virtmap) +{ + ulong runtime_start = (ulong)&__efi_runtime_start & ~0xfffULL; + int n = memory_map_size / descriptor_size; + int i; + + EFI_ENTRY("%lx %lx %x %p", memory_map_size, descriptor_size, + descriptor_version, virtmap); + + for (i = 0; i < n; i++) { + struct efi_mem_desc *map; + + map = (void*)virtmap + (descriptor_size * i); + if (map->type == EFI_RUNTIME_SERVICES_CODE) { + ulong new_offset = map->virtual_start - (runtime_start - gd->relocaddr); + + efi_runtime_relocate(new_offset, map); + /* Once we're virtual, we can no longer handle + complex callbacks */ + efi_runtime_detach(new_offset); + return EFI_EXIT(EFI_SUCCESS); + } + } + + return EFI_EXIT(EFI_INVALID_PARAMETER); +} + +/* + * In the second stage, U-Boot has disappeared. To isolate our runtime code + * that at this point still exists from the rest, we put it into a special + * section. + * + * !!WARNING!! + * + * This means that we can not rely on any code outside of this file in any + * function or variable below this line. + * + * Please keep everything fully self-contained and annotated with + * EFI_RUNTIME_TEXT and EFI_RUNTIME_DATA markers. + */ + +/* + * Relocate the EFI runtime stub to a different place. We need to call this + * the first time we expose the runtime interface to a user and on set virtual + * address map calls. + */ + +static efi_status_t EFI_RUNTIME_TEXT EFIAPI efi_unimplemented(void) +{ + return EFI_UNSUPPORTED; +} + +static efi_status_t EFI_RUNTIME_TEXT EFIAPI efi_device_error(void) +{ + return EFI_DEVICE_ERROR; +} + +static efi_status_t EFI_RUNTIME_TEXT EFIAPI efi_invalid_parameter(void) +{ + return EFI_INVALID_PARAMETER; +} + +struct efi_runtime_services EFI_RUNTIME_DATA efi_runtime_services = { + .hdr = { + .signature = EFI_RUNTIME_SERVICES_SIGNATURE, + .revision = EFI_RUNTIME_SERVICES_REVISION, + .headersize = sizeof(struct efi_table_hdr), + }, + .get_time = &efi_get_time, + .set_time = (void *)&efi_device_error, + .get_wakeup_time = (void *)&efi_unimplemented, + .set_wakeup_time = (void *)&efi_unimplemented, + .set_virtual_address_map = &efi_set_virtual_address_map, + .convert_pointer = (void *)&efi_invalid_parameter, + .get_variable = (void *)&efi_device_error, + .get_next_variable = (void *)&efi_device_error, + .set_variable = (void *)&efi_device_error, + .get_next_high_mono_count = (void *)&efi_device_error, + .reset_system = &efi_reset_system, +};

A EFI applications usually want to access storage devices to load data from.

This patch adds support for EFI disk interfaces. It loops through all block storage interfaces known to U-Boot and creates an EFI object for each existing one. EFI applications can then through these objects call U-Boot's read and write functions.

Signed-off-by: Alexander Graf agraf@suse.de Reviewed-by: Simon Glass sjg@chromium.org

---

v1 -> v2:

- Move to block_drvr array - Move to GPLv2+ - Fix header order - Document efi block object struct - Use calloc rather than malloc & memset

v2 -> v3:

- Adapt to newer u-boot block API - Add EFIAPI to function prototypes - Document header - Check for DEV_TYPE_UNKNOWN - Document 16byte limit for dp string --- include/efi_loader.h | 2 + lib/efi_loader/efi_disk.c | 218 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 220 insertions(+) create mode 100644 lib/efi_loader/efi_disk.c

diff --git a/include/efi_loader.h b/include/efi_loader.h index 640e703..91ab6cb 100644 --- a/include/efi_loader.h +++ b/include/efi_loader.h @@ -86,6 +86,8 @@ struct efi_object { /* This list contains all UEFI objects we know of */ extern struct list_head efi_obj_list;

+/* Called by bootefi to make all disk storage accessible as EFI objects */ +int efi_disk_register(void); /* * Stub implementation for a protocol opener that just returns the handle as * interface diff --git a/lib/efi_loader/efi_disk.c b/lib/efi_loader/efi_disk.c new file mode 100644 index 0000000..f93fcb2 --- /dev/null +++ b/lib/efi_loader/efi_disk.c @@ -0,0 +1,218 @@ +/* + * EFI application disk support + * + * Copyright (c) 2016 Alexander Graf + * + * SPDX-License-Identifier: GPL-2.0+ + */ + +#include <common.h> +#include <efi_loader.h> +#include <inttypes.h> +#include <part.h> +#include <malloc.h> + +static const efi_guid_t efi_block_io_guid = BLOCK_IO_GUID; + +struct efi_disk_obj { + /* Generic EFI object parent class data */ + struct efi_object parent; + /* EFI Interface callback struct for block I/O */ + struct efi_block_io ops; + /* U-Boot ifname for block device */ + const char *ifname; + /* U-Boot dev_index for block device */ + int dev_index; + /* EFI Interface Media descriptor struct, referenced by ops */ + struct efi_block_io_media media; + /* EFI device path to this block device */ + struct efi_device_path_file_path *dp; +}; + +static void ascii2unicode(u16 *unicode, char *ascii) +{ + while (*ascii) + *(unicode++) = *(ascii++); +} + +static efi_status_t efi_disk_open_block(void *handle, efi_guid_t *protocol, + void **protocol_interface, void *agent_handle, + void *controller_handle, uint32_t attributes) +{ + struct efi_disk_obj *diskobj = handle; + + *protocol_interface = &diskobj->ops; + + return EFI_SUCCESS; +} + +static efi_status_t efi_disk_open_dp(void *handle, efi_guid_t *protocol, + void **protocol_interface, void *agent_handle, + void *controller_handle, uint32_t attributes) +{ + struct efi_disk_obj *diskobj = handle; + + *protocol_interface = diskobj->dp; + + return EFI_SUCCESS; +} + +static efi_status_t EFIAPI efi_disk_reset(struct efi_block_io *this, + char extended_verification) +{ + EFI_ENTRY("%p, %x", this, extended_verification); + return EFI_EXIT(EFI_DEVICE_ERROR); +} + +enum efi_disk_direction { + EFI_DISK_READ, + EFI_DISK_WRITE, +}; + +static efi_status_t EFIAPI efi_disk_rw_blocks(struct efi_block_io *this, + u32 media_id, u64 lba, unsigned long buffer_size, + void *buffer, enum efi_disk_direction direction) +{ + struct efi_disk_obj *diskobj; + struct block_dev_desc *desc; + int blksz; + int blocks; + unsigned long n; + + EFI_ENTRY("%p, %x, %"PRIx64", %lx, %p", this, media_id, lba, + buffer_size, buffer); + + diskobj = container_of(this, struct efi_disk_obj, ops); + if (!(desc = get_dev(diskobj->ifname, diskobj->dev_index))) + return EFI_EXIT(EFI_DEVICE_ERROR); + blksz = desc->blksz; + blocks = buffer_size / blksz; + +#ifdef DEBUG_EFI + printf("EFI: %s:%d blocks=%x lba=%"PRIx64" blksz=%x dir=%d\n", __func__, + __LINE__, blocks, lba, blksz, direction); +#endif + + /* We only support full block access */ + if (buffer_size & (blksz - 1)) + return EFI_EXIT(EFI_DEVICE_ERROR); + + if (direction == EFI_DISK_READ) + n = desc->block_read(desc, lba, blocks, buffer); + else + n = desc->block_write(desc, lba, blocks, buffer); + + /* We don't do interrupts, so check for timers cooperatively */ + efi_timer_check(); + +#ifdef DEBUG_EFI + printf("EFI: %s:%d n=%lx blocks=%x\n", __func__, __LINE__, n, blocks); +#endif + if (n != blocks) + return EFI_EXIT(EFI_DEVICE_ERROR); + + return EFI_EXIT(EFI_SUCCESS); +} + +static efi_status_t efi_disk_read_blocks(struct efi_block_io *this, + u32 media_id, u64 lba, unsigned long buffer_size, + void *buffer) +{ + return efi_disk_rw_blocks(this, media_id, lba, buffer_size, buffer, + EFI_DISK_READ); +} + +static efi_status_t efi_disk_write_blocks(struct efi_block_io *this, + u32 media_id, u64 lba, unsigned long buffer_size, + void *buffer) +{ + return efi_disk_rw_blocks(this, media_id, lba, buffer_size, buffer, + EFI_DISK_WRITE); +} + +static efi_status_t EFIAPI efi_disk_flush_blocks(struct efi_block_io *this) +{ + /* We always write synchronously */ + EFI_ENTRY("%p", this); + return EFI_EXIT(EFI_SUCCESS); +} + +static const struct efi_block_io block_io_disk_template = { + .reset = &efi_disk_reset, + .read_blocks = &efi_disk_read_blocks, + .write_blocks = &efi_disk_write_blocks, + .flush_blocks = &efi_disk_flush_blocks, +}; + +/* + * U-Boot doesn't have a list of all online disk devices. So when running our + * EFI payload, we scan through all of the potentially available ones and + * store them in our object pool. + * + * This gets called from do_bootefi_exec(). + */ +int efi_disk_register(void) +{ + const struct block_drvr *cur_drvr; + int i; + int disks = 0; + + /* Search for all available disk devices */ + for (cur_drvr = block_drvr; cur_drvr->name; cur_drvr++) { + printf("Scanning disks on %s...\n", cur_drvr->name); + for (i = 0; i < 4; i++) { + block_dev_desc_t *desc; + struct efi_disk_obj *diskobj; + struct efi_device_path_file_path *dp; + int objlen = sizeof(*diskobj) + (sizeof(*dp) * 2); + char devname[16] = { 0 }; /* dp->str is u16[16] long */ + + desc = get_dev(cur_drvr->name, i); + if (!desc) + continue; + if (desc->type == DEV_TYPE_UNKNOWN) + continue; + + diskobj = calloc(1, objlen); + + /* Fill in object data */ + diskobj->parent.protocols[0].guid = &efi_block_io_guid; + diskobj->parent.protocols[0].open = efi_disk_open_block; + diskobj->parent.protocols[1].guid = &efi_guid_device_path; + diskobj->parent.protocols[1].open = efi_disk_open_dp; + diskobj->parent.handle = diskobj; + diskobj->ops = block_io_disk_template; + diskobj->ifname = cur_drvr->name; + diskobj->dev_index = i; + + /* Fill in EFI IO Media info (for read/write callbacks) */ + diskobj->media.removable_media = desc->removable; + diskobj->media.media_present = 1; + diskobj->media.block_size = desc->blksz; + diskobj->media.io_align = desc->blksz; + diskobj->media.last_block = desc->lba; + diskobj->ops.media = &diskobj->media; + + /* Fill in device path */ + dp = (void*)&diskobj[1]; + diskobj->dp = dp; + dp[0].dp.type = DEVICE_PATH_TYPE_MEDIA_DEVICE; + dp[0].dp.sub_type = DEVICE_PATH_SUB_TYPE_FILE_PATH; + dp[0].dp.length = sizeof(*dp); + snprintf(devname, sizeof(devname), "%s%d", + cur_drvr->name, i); + ascii2unicode(dp[0].str, devname); + + dp[1].dp.type = DEVICE_PATH_TYPE_END; + dp[1].dp.sub_type = DEVICE_PATH_SUB_TYPE_END; + dp[1].dp.length = sizeof(*dp); + + /* Hook up to the device list */ + list_add_tail(&diskobj->parent.link, &efi_obj_list); + disks++; + } + } + printf("Found %d disks\n", disks); + + return 0; +}

In order to execute an EFI application, we need to bridge the gap between U-Boot's notion of executing images and EFI's notion of doing the same.

The best path forward IMHO here is to stick completely to the way U-Boot deals with payloads. You manually load them using whatever method to RAM and then have a simple boot command to execute them. So in our case, you would do

# load mmc 0:1 $loadaddr grub.efi # bootefi $loadaddr

which then gets you into a grub shell. Fdt information known to U-boot via the fdt addr command is also passed to the EFI payload.

Signed-off-by: Alexander Graf agraf@suse.de Reviewed-by: Simon Glass sjg@chromium.org

---

v1 -> v2:

- Move to GPLv2+

v2 -> v3:

- Move to new cmd directory - Add kconfig option - Fix comment style - Add help text - s/-1/-ENOENT - Move obj list to lib

XXX bootefi: make dtb conf table more explicit --- cmd/Kconfig | 7 +++ cmd/Makefile | 1 + cmd/bootefi.c | 167 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 175 insertions(+) create mode 100644 cmd/bootefi.c

diff --git a/cmd/Kconfig b/cmd/Kconfig index 2ed0263..7cdff04 100644 --- a/cmd/Kconfig +++ b/cmd/Kconfig @@ -148,6 +148,13 @@ config CMD_BOOTM help Boot an application image from the memory.

+config CMD_BOOTEFI + bool "bootefi" + depends on EFI_LOADER + default y + help + Boot an EFI image from memory. + config CMD_ELF bool "bootelf, bootvx" default y diff --git a/cmd/Makefile b/cmd/Makefile index 03f7e0a..7604621 100644 --- a/cmd/Makefile +++ b/cmd/Makefile @@ -21,6 +21,7 @@ obj-$(CONFIG_CMD_SOURCE) += source.o obj-$(CONFIG_CMD_BDI) += bdinfo.o obj-$(CONFIG_CMD_BEDBUG) += bedbug.o obj-$(CONFIG_CMD_BMP) += bmp.o +obj-$(CONFIG_CMD_BOOTEFI) += bootefi.o obj-$(CONFIG_CMD_BOOTMENU) += bootmenu.o obj-$(CONFIG_CMD_BOOTLDR) += bootldr.o obj-$(CONFIG_CMD_BOOTSTAGE) += bootstage.o diff --git a/cmd/bootefi.c b/cmd/bootefi.c new file mode 100644 index 0000000..e3e51d4 --- /dev/null +++ b/cmd/bootefi.c @@ -0,0 +1,167 @@ +/* + * EFI application loader + * + * Copyright (c) 2016 Alexander Graf + * + * SPDX-License-Identifier: GPL-2.0+ + */ + +#include <common.h> +#include <command.h> +#include <efi_loader.h> +#include <errno.h> +#include <libfdt_env.h> + +/* + * When booting using the "bootefi" command, we don't know which + * physical device the file came from. So we create a pseudo-device + * called "bootefi" with the device path /bootefi. + * + * In addition to the originating device we also declare the file path + * of "bootefi" based loads to be /bootefi. + */ +static struct efi_device_path_file_path bootefi_dummy_path[] = { + { + .dp.type = DEVICE_PATH_TYPE_MEDIA_DEVICE, + .dp.sub_type = DEVICE_PATH_SUB_TYPE_FILE_PATH, + .dp.length = sizeof(bootefi_dummy_path[0]), + .str = { 'b','o','o','t','e','f','i' }, + }, { + .dp.type = DEVICE_PATH_TYPE_END, + .dp.sub_type = DEVICE_PATH_SUB_TYPE_END, + .dp.length = sizeof(bootefi_dummy_path[0]), + } +}; + +static efi_status_t bootefi_open_dp(void *handle, efi_guid_t *protocol, + void **protocol_interface, void *agent_handle, + void *controller_handle, uint32_t attributes) +{ + *protocol_interface = bootefi_dummy_path; + return EFI_SUCCESS; +} + +/* The EFI loaded_image interface for the image executed via "bootefi" */ +static struct efi_loaded_image loaded_image_info = { + .device_handle = bootefi_dummy_path, + .file_path = bootefi_dummy_path, +}; + +/* The EFI object struct for the image executed via "bootefi" */ +static struct efi_object loaded_image_info_obj = { + .handle = &loaded_image_info, + .protocols = { + { + /* + * When asking for the loaded_image interface, just + * return handle which points to loaded_image_info + */ + .guid = &efi_guid_loaded_image, + .open = &efi_return_handle, + }, + { + /* + * When asking for the device path interface, return + * bootefi_dummy_path + */ + .guid = &efi_guid_device_path, + .open = &bootefi_open_dp, + }, + }, +}; + +/* The EFI object struct for the device the "bootefi" image was loaded from */ +static struct efi_object bootefi_device_obj = { + .handle = bootefi_dummy_path, + .protocols = { + { + /* When asking for the device path interface, return + * bootefi_dummy_path */ + .guid = &efi_guid_device_path, + .open = &bootefi_open_dp, + } + }, +}; + +/* + * Load an EFI payload into a newly allocated piece of memory, register all + * EFI objects it would want to access and jump to it. + */ +static unsigned long do_bootefi_exec(void *efi) +{ + ulong (*entry)(void *image_handle, struct efi_system_table *st); + + /* + * gd lives in a fixed register which may get clobbered while we execute + * the payload. So save it here and restore it on every callback entry + */ + efi_save_gd(); + + /* Update system table to point to our currently loaded FDT */ + + if (working_fdt) { + systab.tables[0].guid = EFI_FDT_GUID; + systab.tables[0].table = working_fdt; + systab.nr_tables = 1; + } else { + printf("WARNING: No device tree loaded, expect boot to fail\n"); + systab.nr_tables = 0; + } + + /* Load the EFI payload */ + entry = efi_load_pe(efi, &loaded_image_info); + if (!entry) + return -ENOENT; + + /* Initialize and populate EFI object list */ + INIT_LIST_HEAD(&efi_obj_list); + list_add_tail(&loaded_image_info_obj.link, &efi_obj_list); + list_add_tail(&bootefi_device_obj.link, &efi_obj_list); +#ifdef CONFIG_PARTITIONS + efi_disk_register(); +#endif + + /* Call our payload! */ +#ifdef DEBUG_EFI + printf("%s:%d Jumping to 0x%lx\n", __func__, __LINE__, (long)entry); +#endif + return entry(&loaded_image_info, &systab); +} + + +/* Interpreter command to boot an arbitrary EFI image from memory */ +static int do_bootefi(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]) +{ + char *saddr; + unsigned long addr; + int r = 0; + + if (argc < 2) + return 1; + saddr = argv[1]; + + addr = simple_strtoul(saddr, NULL, 16); + + printf("## Starting EFI application at 0x%08lx ...\n", addr); + r = do_bootefi_exec((void *)addr); + printf("## Application terminated, r = %d\n", r); + + if (r != 0) + r = 1; + + return r; +} + +static char bootefi_help_text[] = + "<image address>\n" + " - boot EFI payload stored at address <image address>\n" + "\n" + "Since most EFI payloads want to have a device tree provided, please\n" + "make sure you load a device tree using the fdt addr command before\n" + "executing bootefi.\n"; + +U_BOOT_CMD( + bootefi, 2, 0, do_bootefi, + "Boots an EFI payload from memory\n", + bootefi_help_text +);

The EFI loader needs to maintain views of memory - general system memory windows as well as used locations inside those and potential runtime service MMIO windows.

To manage all of these, add a few helpers that maintain an internal representation of the map the similar to how the EFI API later on reports it to the application.

For allocations, the scheme is very simple. We basically allow allocations to replace chunks of previously done maps, so that a new LOADER_DATA allocation for example can remove a piece of the RAM map. When no specific address is given, we just take the highest possible address in the lowest RAM map that fits the allocation size.

Signed-off-by: Alexander Graf agraf@suse.de

---

v2 -> v3:

- Rewrite memory allocation and map - Document header --- common/board_r.c | 3 + include/efi_loader.h | 19 +++ lib/efi_loader/efi_memory.c | 314 ++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 336 insertions(+) create mode 100644 lib/efi_loader/efi_memory.c

diff --git a/common/board_r.c b/common/board_r.c index 420e2c8..2ed8e4b 100644 --- a/common/board_r.c +++ b/common/board_r.c @@ -785,6 +785,9 @@ init_fnc_t init_sequence_r[] = { #ifdef CONFIG_CLOCKS set_cpu_clk_info, /* Setup clock information */ #endif +#ifdef CONFIG_EFI_LOADER + efi_memory_init, +#endif stdio_init_tables, initr_serial, initr_announce, diff --git a/include/efi_loader.h b/include/efi_loader.h index 91ab6cb..e38be12 100644 --- a/include/efi_loader.h +++ b/include/efi_loader.h @@ -109,6 +109,25 @@ efi_status_t efi_exit_func(efi_status_t ret); /* Call this to relocate the runtime section to an address space */ void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);

+/* Generic EFI memory allocator, call this to get memory */ +void *efi_alloc(uint64_t len, int memory_type); +/* More specific EFI memory allocator, called by EFI payloads */ +efi_status_t efi_allocate_pages(int type, int memory_type, unsigned long pages, + uint64_t *memory); +/* EFI memory free function. Not implemented today */ +efi_status_t efi_free_pages(uint64_t memory, unsigned long pages); +/* Returns the EFI memory map */ +efi_status_t efi_get_memory_map(unsigned long *memory_map_size, + struct efi_mem_desc *memory_map, + unsigned long *map_key, + unsigned long *descriptor_size, + uint32_t *descriptor_version); +/* Adds a range into the EFI memory map */ +uint64_t efi_add_memory_map(uint64_t start, uint64_t pages, int memory_type, + bool overlap_only_ram); +/* Called by board init to initialize the EFI memory map */ +int efi_memory_init(void); + /* * Use these to indicate that your code / data should go into the EFI runtime * section and thus still be available when the OS is running diff --git a/lib/efi_loader/efi_memory.c b/lib/efi_loader/efi_memory.c new file mode 100644 index 0000000..e58d190 --- /dev/null +++ b/lib/efi_loader/efi_memory.c @@ -0,0 +1,314 @@ +/* + * EFI application memory management + * + * Copyright (c) 2016 Alexander Graf + * + * SPDX-License-Identifier: GPL-2.0+ + */ + +/* #define DEBUG_EFI */ + +#include <common.h> +#include <efi_loader.h> +#include <malloc.h> +#include <asm/global_data.h> +#include <libfdt_env.h> +#include <inttypes.h> +#include <watchdog.h> + +DECLARE_GLOBAL_DATA_PTR; + +struct efi_mem_list { + struct list_head link; + struct efi_mem_desc desc; +}; + +/* This list contains all memory map items */ +LIST_HEAD(efi_mem); + +/* + * Unmaps all memory occupied by the carve_desc region from the + * list entry pointed to by map. + * + * Returns 1 if carving was performed or 0 if the regions don't overlap. + * Returns -1 if it would affect non-RAM regions but overlap_only_ram is set. + * Carving is only guaranteed to complete when all regions return 0. + */ +static int efi_mem_carve_out(struct efi_mem_list *map, + struct efi_mem_desc *carve_desc, + bool overlap_only_ram) +{ + struct efi_mem_list *newmap; + struct efi_mem_desc *map_desc = &map->desc; + uint64_t map_start = map_desc->physical_start; + uint64_t map_end = map_start + (map_desc->num_pages << 12); + uint64_t carve_start = carve_desc->physical_start; + uint64_t carve_end = carve_start + (carve_desc->num_pages << 12); + + /* check whether we're overlapping */ + if ((carve_end <= map_start) || (carve_start >= map_end)) + return 0; + + /* We're overlapping with non-RAM, warn the caller if desired */ + if (overlap_only_ram && (map_desc->type != EFI_CONVENTIONAL_MEMORY)) + return -1; + + /* Sanitize carve_start and carve_end to lie within our bounds */ + carve_start = max(carve_start, map_start); + carve_end = min(carve_end, map_end); + + /* Carving at the beginning of our map? Just move it! */ + if (carve_start == map_start) { + if (map_end == carve_end) { + /* Full overlap, just remove map */ + list_del(&map->link); + } + + map_desc->physical_start = carve_end; + map_desc->num_pages = (map_end - carve_end) >> 12; + return 1; + } + + /* + * Overlapping maps, just split the list map at carve_start, + * it will get moved or removed in the next iteration. + * + * [ map_desc |__carve_start__| newmap ] + */ + + /* Create a new map from [ carve_start ... map_end ] */ + newmap = calloc(1, sizeof(*newmap)); + newmap->desc = map->desc; + newmap->desc.physical_start = carve_start; + newmap->desc.num_pages = (map_end - carve_start) >> 12; + list_add_tail(&newmap->link, &efi_mem); + + /* Shrink the map to [ map_start ... carve_start ] */ + map_desc->num_pages = (carve_start - map_start) >> 12; + + return 1; +} + +uint64_t efi_add_memory_map(uint64_t start, uint64_t pages, int memory_type, + bool overlap_only_ram) +{ + struct list_head *lhandle; + struct efi_mem_list *newlist; + bool do_carving; + + if (!pages) + return start; + + newlist = calloc(1, sizeof(*newlist)); + newlist->desc.type = memory_type; + newlist->desc.physical_start = start; + newlist->desc.virtual_start = start; + newlist->desc.num_pages = pages; + + switch (memory_type) { + case EFI_RUNTIME_SERVICES_CODE: + case EFI_RUNTIME_SERVICES_DATA: + newlist->desc.attribute = (1 << EFI_MEMORY_WB_SHIFT) | + (1ULL << EFI_MEMORY_RUNTIME_SHIFT); + break; + case EFI_MMAP_IO: + newlist->desc.attribute = 1ULL << EFI_MEMORY_RUNTIME_SHIFT; + break; + default: + newlist->desc.attribute = 1 << EFI_MEMORY_WB_SHIFT; + break; + } + + /* Add our new map */ + do { + do_carving = false; + list_for_each(lhandle, &efi_mem) { + struct efi_mem_list *lmem; + int r; + + lmem = list_entry(lhandle, struct efi_mem_list, link); + r = efi_mem_carve_out(lmem, &newlist->desc, + overlap_only_ram); + if (r < 0) { + return 0; + } else if (r) { + do_carving = true; + break; + } + } + } while (do_carving); + + /* Add our new map */ + list_add_tail(&newlist->link, &efi_mem); + + return start; +} + +static uint64_t efi_find_free_memory(uint64_t len, uint64_t max_addr) +{ + struct list_head *lhandle; + + list_for_each(lhandle, &efi_mem) { + struct efi_mem_list *lmem = list_entry(lhandle, + struct efi_mem_list, link); + struct efi_mem_desc *desc = &lmem->desc; + uint64_t desc_len = desc->num_pages << 12; + uint64_t desc_end = desc->physical_start + desc_len; + uint64_t curmax = min(max_addr, desc_end); + uint64_t ret = curmax - len; + + /* We only take memory from free RAM */ + if (desc->type != EFI_CONVENTIONAL_MEMORY) + continue; + + /* Out of bounds for max_addr */ + if ((ret + len) > max_addr) + continue; + + /* Out of bounds for upper map limit */ + if ((ret + len) > desc_end) + continue; + + /* Out of bounds for lower map limit */ + if (ret < desc->physical_start) + continue; + + /* Return the highest address in this map within bounds */ + return ret; + } + + return 0; +} + +efi_status_t efi_allocate_pages(int type, int memory_type, + unsigned long pages, uint64_t *memory) +{ + u64 len = pages << 12; + efi_status_t r = EFI_SUCCESS; + uint64_t addr; + + switch (type) { + case 0: + /* Any page */ + addr = efi_find_free_memory(len, gd->ram_top); + if (!addr) { + r = EFI_NOT_FOUND; + break; + } + break; + case 1: + /* Max address */ + addr = efi_find_free_memory(len, *memory); + if (!addr) { + r = EFI_NOT_FOUND; + break; + } + break; + case 2: + /* Exact address, reserve it. The addr is already in *memory. */ + addr = *memory; + break; + default: + /* UEFI doesn't specify other allocation types */ + r = EFI_INVALID_PARAMETER; + break; + } + + if (r == EFI_SUCCESS) { + uint64_t ret; + + /* Reserve that map in our memory maps */ + ret = efi_add_memory_map(addr, pages, memory_type, true); + if (ret == addr) { + *memory = addr; + } else { + /* Map would overlap, bail out */ + r = EFI_NOT_FOUND; + } + } + + return r; +} + +void *efi_alloc(uint64_t len, int memory_type) +{ + uint64_t ret = 0; + efi_status_t r; + + r = efi_allocate_pages(0, memory_type, (len + 0xfff) >> 12, &ret); + if (r == EFI_SUCCESS) + return (void*)(uintptr_t)ret; + + return NULL; +} + +efi_status_t efi_free_pages(uint64_t memory, unsigned long pages) +{ + /* We don't free, let's cross our fingers we have plenty RAM */ + return EFI_SUCCESS; +} + +efi_status_t efi_get_memory_map(unsigned long *memory_map_size, + struct efi_mem_desc *memory_map, + unsigned long *map_key, + unsigned long *descriptor_size, + uint32_t *descriptor_version) +{ + ulong map_size = 0; + struct list_head *lhandle; + + list_for_each(lhandle, &efi_mem) + map_size += sizeof(struct efi_mem_desc); + + *memory_map_size = map_size; + + if (descriptor_size) + *descriptor_size = sizeof(struct efi_mem_desc); + + if (*memory_map_size < map_size) + return EFI_BUFFER_TOO_SMALL; + + /* Copy list into array */ + if (memory_map) { + list_for_each(lhandle, &efi_mem) { + struct efi_mem_list *lmem; + + lmem = list_entry(lhandle, struct efi_mem_list, link); + *memory_map = lmem->desc; + memory_map++; + } + } + + return EFI_SUCCESS; +} + +int efi_memory_init(void) +{ + uint64_t runtime_start, runtime_end, runtime_pages; + uint64_t uboot_start, uboot_pages; + uint64_t uboot_stack_size = 16 * 1024 * 1024; + int i; + + /* Add RAM */ + for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) { + ulong start = (gd->bd->bi_dram[i].start + 0xfff) & ~0xfffULL; + ulong pages = (gd->bd->bi_dram[i].size + 0xfff) >> 12; + + efi_add_memory_map(start, pages, EFI_CONVENTIONAL_MEMORY, + false); + } + + /* Add U-Boot */ + uboot_start = (gd->start_addr_sp - uboot_stack_size) & ~0xfffULL; + uboot_pages = (gd->ram_top - uboot_start) >> 12; + efi_add_memory_map(uboot_start, uboot_pages, EFI_LOADER_DATA, false); + + /* Add Runtime Services */ + runtime_start = (ulong)&__efi_runtime_start & ~0xfffULL; + runtime_end = ((ulong)&__efi_runtime_stop + 0xfff) & ~0xfffULL; + runtime_pages = (runtime_end - runtime_start) >> 12; + efi_add_memory_map(runtime_start, runtime_pages, + EFI_RUNTIME_SERVICES_CODE, false); + + return 0; +}

There are 2 ways an EFI payload could return into u-boot:

- Callback function - Exception

While in EFI payload mode, x18 is owned by the payload and may not contain a valid pointer to gd, so we need to fix it up. We do that properly for the payload to callback path already.

This patch also adds gd pointer restoral for the exception path.

Signed-off-by: Alexander Graf agraf@suse.de --- arch/arm/lib/interrupts_64.c | 9 +++++++++ 1 file changed, 9 insertions(+)

diff --git a/arch/arm/lib/interrupts_64.c b/arch/arm/lib/interrupts_64.c index b476722..7c9cfce 100644 --- a/arch/arm/lib/interrupts_64.c +++ b/arch/arm/lib/interrupts_64.c @@ -7,6 +7,7 @@

#include <common.h> #include <linux/compiler.h> +#include <efi_loader.h>

int interrupt_init(void) @@ -41,6 +42,7 @@ void show_regs(struct pt_regs *regs) */ void do_bad_sync(struct pt_regs *pt_regs, unsigned int esr) { + efi_restore_gd(); printf("Bad mode in "Synchronous Abort" handler, esr 0x%08x\n", esr); show_regs(pt_regs); panic("Resetting CPU ...\n"); @@ -51,6 +53,7 @@ void do_bad_sync(struct pt_regs *pt_regs, unsigned int esr) */ void do_bad_irq(struct pt_regs *pt_regs, unsigned int esr) { + efi_restore_gd(); printf("Bad mode in "Irq" handler, esr 0x%08x\n", esr); show_regs(pt_regs); panic("Resetting CPU ...\n"); @@ -61,6 +64,7 @@ void do_bad_irq(struct pt_regs *pt_regs, unsigned int esr) */ void do_bad_fiq(struct pt_regs *pt_regs, unsigned int esr) { + efi_restore_gd(); printf("Bad mode in "Fiq" handler, esr 0x%08x\n", esr); show_regs(pt_regs); panic("Resetting CPU ...\n"); @@ -71,6 +75,7 @@ void do_bad_fiq(struct pt_regs *pt_regs, unsigned int esr) */ void do_bad_error(struct pt_regs *pt_regs, unsigned int esr) { + efi_restore_gd(); printf("Bad mode in "Error" handler, esr 0x%08x\n", esr); show_regs(pt_regs); panic("Resetting CPU ...\n"); @@ -81,6 +86,7 @@ void do_bad_error(struct pt_regs *pt_regs, unsigned int esr) */ void do_sync(struct pt_regs *pt_regs, unsigned int esr) { + efi_restore_gd(); printf(""Synchronous Abort" handler, esr 0x%08x\n", esr); show_regs(pt_regs); panic("Resetting CPU ...\n"); @@ -91,6 +97,7 @@ void do_sync(struct pt_regs *pt_regs, unsigned int esr) */ void do_irq(struct pt_regs *pt_regs, unsigned int esr) { + efi_restore_gd(); printf(""Irq" handler, esr 0x%08x\n", esr); show_regs(pt_regs); panic("Resetting CPU ...\n"); @@ -101,6 +108,7 @@ void do_irq(struct pt_regs *pt_regs, unsigned int esr) */ void do_fiq(struct pt_regs *pt_regs, unsigned int esr) { + efi_restore_gd(); printf(""Fiq" handler, esr 0x%08x\n", esr); show_regs(pt_regs); panic("Resetting CPU ...\n"); @@ -114,6 +122,7 @@ void do_fiq(struct pt_regs *pt_regs, unsigned int esr) */ void __weak do_error(struct pt_regs *pt_regs, unsigned int esr) { + efi_restore_gd(); printf(""Error" handler, esr 0x%08x\n", esr); show_regs(pt_regs); panic("Resetting CPU ...\n");