]> git.sur5r.net Git - u-boot/blobdiff - lib/efi_loader/efi_boottime.c
efi_loader: check interface when uninstalling protocol
[u-boot] / lib / efi_loader / efi_boottime.c
index 1a2154591cb90c86b1b98690fdd03ecb940c4853..91c923f560903ac3612a40f9d3678044815509f3 100644 (file)
@@ -1,9 +1,8 @@
+// SPDX-License-Identifier: GPL-2.0+
 /*
  *  EFI application boot time services
  *
  *  Copyright (c) 2016 Alexander Graf
- *
- *  SPDX-License-Identifier:     GPL-2.0+
  */
 
 #include <common.h>
@@ -11,7 +10,6 @@
 #include <efi_loader.h>
 #include <environment.h>
 #include <malloc.h>
-#include <asm/global_data.h>
 #include <linux/libfdt_env.h>
 #include <u-boot/crc.h>
 #include <bootm.h>
@@ -26,6 +24,9 @@ static efi_uintn_t efi_tpl = TPL_APPLICATION;
 /* This list contains all the EFI objects our payload has access to */
 LIST_HEAD(efi_obj_list);
 
+/* List of all events */
+LIST_HEAD(efi_events);
+
 /*
  * 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
@@ -62,6 +63,22 @@ const efi_guid_t efi_guid_fdt = EFI_FDT_GUID;
 const efi_guid_t efi_guid_driver_binding_protocol =
                        EFI_DRIVER_BINDING_PROTOCOL_GUID;
 
+/* event group ExitBootServices() invoked */
+const efi_guid_t efi_guid_event_group_exit_boot_services =
+                       EFI_EVENT_GROUP_EXIT_BOOT_SERVICES;
+/* event group SetVirtualAddressMap() invoked */
+const efi_guid_t efi_guid_event_group_virtual_address_change =
+                       EFI_EVENT_GROUP_VIRTUAL_ADDRESS_CHANGE;
+/* event group memory map changed */
+const efi_guid_t efi_guid_event_group_memory_map_change =
+                       EFI_EVENT_GROUP_MEMORY_MAP_CHANGE;
+/* event group boot manager about to boot */
+const efi_guid_t efi_guid_event_group_ready_to_boot =
+                       EFI_EVENT_GROUP_READY_TO_BOOT;
+/* event group ResetSystem() invoked (before ExitBootServices) */
+const efi_guid_t efi_guid_event_group_reset_system =
+                       EFI_EVENT_GROUP_RESET_SYSTEM;
+
 static efi_status_t EFIAPI efi_disconnect_controller(
                                        efi_handle_t controller_handle,
                                        efi_handle_t driver_image_handle,
@@ -157,7 +174,7 @@ const char *__efi_nesting_dec(void)
  * @event      event to signal
  * @check_tpl  check the TPL level
  */
-void efi_signal_event(struct efi_event *event, bool check_tpl)
+static void efi_queue_event(struct efi_event *event, bool check_tpl)
 {
        if (event->notify_function) {
                event->is_queued = true;
@@ -170,6 +187,50 @@ void efi_signal_event(struct efi_event *event, bool check_tpl)
        event->is_queued = false;
 }
 
+/*
+ * Signal an EFI event.
+ *
+ * This function signals an event. If the event belongs to an event group
+ * all events of the group are signaled. If they are of type EVT_NOTIFY_SIGNAL
+ * their notification function is queued.
+ *
+ * For the SignalEvent service see efi_signal_event_ext.
+ *
+ * @event      event to signal
+ * @check_tpl  check the TPL level
+ */
+void efi_signal_event(struct efi_event *event, bool check_tpl)
+{
+       if (event->group) {
+               struct efi_event *evt;
+
+               /*
+                * The signaled state has to set before executing any
+                * notification function
+                */
+               list_for_each_entry(evt, &efi_events, link) {
+                       if (!evt->group || guidcmp(evt->group, event->group))
+                               continue;
+                       if (evt->is_signaled)
+                               continue;
+                       evt->is_signaled = true;
+                       if (evt->type & EVT_NOTIFY_SIGNAL &&
+                           evt->notify_function)
+                               evt->is_queued = true;
+               }
+               list_for_each_entry(evt, &efi_events, link) {
+                       if (!evt->group || guidcmp(evt->group, event->group))
+                               continue;
+                       if (evt->is_queued)
+                               efi_queue_event(evt, check_tpl);
+               }
+       } else if (!event->is_signaled) {
+               event->is_signaled = true;
+               if (event->type & EVT_NOTIFY_SIGNAL)
+                       efi_queue_event(event, check_tpl);
+       }
+}
+
 /*
  * Raise the task priority level.
  *
@@ -215,6 +276,11 @@ static void EFIAPI efi_restore_tpl(efi_uintn_t old_tpl)
        if (efi_tpl > TPL_HIGH_LEVEL)
                efi_tpl = TPL_HIGH_LEVEL;
 
+       /*
+        * Lowering the TPL may have made queued events eligible for execution.
+        */
+       efi_timer_check();
+
        EFI_EXIT(EFI_SUCCESS);
 }
 
@@ -427,6 +493,8 @@ efi_status_t efi_remove_protocol(const efi_handle_t handle,
                return ret;
        if (guidcmp(handler->guid, protocol))
                return EFI_INVALID_PARAMETER;
+       if (handler->protocol_interface != protocol_interface)
+               return EFI_INVALID_PARAMETER;
        list_del(&handler->link);
        free(handler);
        return EFI_SUCCESS;
@@ -473,10 +541,23 @@ void efi_delete_handle(struct efi_object *obj)
 }
 
 /*
- * Our event capabilities are very limited. Only a small limited
- * number of events is allowed to coexist.
+ * Check if a pointer is a valid event.
+ *
+ * @event              pointer to check
+ * @return             status code
  */
-static struct efi_event efi_events[16];
+static efi_status_t efi_is_event(const struct efi_event *event)
+{
+       const struct efi_event *evt;
+
+       if (!event)
+               return EFI_INVALID_PARAMETER;
+       list_for_each_entry(evt, &efi_events, link) {
+               if (evt == event)
+                       return EFI_SUCCESS;
+       }
+       return EFI_INVALID_PARAMETER;
+}
 
 /*
  * Create an event.
@@ -497,9 +578,10 @@ efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
                              void (EFIAPI *notify_function) (
                                        struct efi_event *event,
                                        void *context),
-                             void *notify_context, struct efi_event **event)
+                             void *notify_context, efi_guid_t *group,
+                             struct efi_event **event)
 {
-       int i;
+       struct efi_event *evt;
 
        if (event == NULL)
                return EFI_INVALID_PARAMETER;
@@ -507,25 +589,25 @@ efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
        if ((type & EVT_NOTIFY_SIGNAL) && (type & EVT_NOTIFY_WAIT))
                return EFI_INVALID_PARAMETER;
 
-       if ((type & (EVT_NOTIFY_SIGNAL|EVT_NOTIFY_WAIT)) &&
+       if ((type & (EVT_NOTIFY_SIGNAL | EVT_NOTIFY_WAIT)) &&
            notify_function == NULL)
                return EFI_INVALID_PARAMETER;
 
-       for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
-               if (efi_events[i].type)
-                       continue;
-               efi_events[i].type = type;
-               efi_events[i].notify_tpl = notify_tpl;
-               efi_events[i].notify_function = notify_function;
-               efi_events[i].notify_context = notify_context;
-               /* Disable timers on bootup */
-               efi_events[i].trigger_next = -1ULL;
-               efi_events[i].is_queued = false;
-               efi_events[i].is_signaled = false;
-               *event = &efi_events[i];
-               return EFI_SUCCESS;
-       }
-       return EFI_OUT_OF_RESOURCES;
+       evt = calloc(1, sizeof(struct efi_event));
+       if (!evt)
+               return EFI_OUT_OF_RESOURCES;
+       evt->type = type;
+       evt->notify_tpl = notify_tpl;
+       evt->notify_function = notify_function;
+       evt->notify_context = notify_context;
+       evt->group = group;
+       /* Disable timers on bootup */
+       evt->trigger_next = -1ULL;
+       evt->is_queued = false;
+       evt->is_signaled = false;
+       list_add_tail(&evt->link, &efi_events);
+       *event = evt;
+       return EFI_SUCCESS;
 }
 
 /*
@@ -554,10 +636,8 @@ efi_status_t EFIAPI efi_create_event_ex(uint32_t type, efi_uintn_t notify_tpl,
 {
        EFI_ENTRY("%d, 0x%zx, %p, %p, %pUl", type, notify_tpl, notify_function,
                  notify_context, event_group);
-       if (event_group)
-               return EFI_EXIT(EFI_UNSUPPORTED);
        return EFI_EXIT(efi_create_event(type, notify_tpl, notify_function,
-                                        notify_context, event));
+                                        notify_context, event_group, event));
 }
 
 /*
@@ -584,7 +664,7 @@ static efi_status_t EFIAPI efi_create_event_ext(
        EFI_ENTRY("%d, 0x%zx, %p, %p", type, notify_tpl, notify_function,
                  notify_context);
        return EFI_EXIT(efi_create_event(type, notify_tpl, notify_function,
-                                        notify_context, event));
+                                        notify_context, NULL, event));
 }
 
 /*
@@ -596,30 +676,26 @@ static efi_status_t EFIAPI efi_create_event_ext(
  */
 void efi_timer_check(void)
 {
-       int i;
+       struct efi_event *evt;
        u64 now = timer_get_us();
 
-       for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
-               if (!efi_events[i].type)
-                       continue;
-               if (efi_events[i].is_queued)
-                       efi_signal_event(&efi_events[i], true);
-               if (!(efi_events[i].type & EVT_TIMER) ||
-                   now < efi_events[i].trigger_next)
+       list_for_each_entry(evt, &efi_events, link) {
+               if (evt->is_queued)
+                       efi_queue_event(evt, true);
+               if (!(evt->type & EVT_TIMER) || now < evt->trigger_next)
                        continue;
-               switch (efi_events[i].trigger_type) {
+               switch (evt->trigger_type) {
                case EFI_TIMER_RELATIVE:
-                       efi_events[i].trigger_type = EFI_TIMER_STOP;
+                       evt->trigger_type = EFI_TIMER_STOP;
                        break;
                case EFI_TIMER_PERIODIC:
-                       efi_events[i].trigger_next +=
-                               efi_events[i].trigger_time;
+                       evt->trigger_next += evt->trigger_time;
                        break;
                default:
                        continue;
                }
-               efi_events[i].is_signaled = true;
-               efi_signal_event(&efi_events[i], true);
+               evt->is_signaled = false;
+               efi_signal_event(evt, true);
        }
        WATCHDOG_RESET();
 }
@@ -638,7 +714,9 @@ void efi_timer_check(void)
 efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
                           uint64_t trigger_time)
 {
-       int i;
+       /* Check that the event is valid */
+       if (efi_is_event(event) != EFI_SUCCESS || !(event->type & EVT_TIMER))
+               return EFI_INVALID_PARAMETER;
 
        /*
         * The parameter defines a multiple of 100ns.
@@ -646,30 +724,21 @@ efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
         */
        do_div(trigger_time, 10);
 
-       for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
-               if (event != &efi_events[i])
-                       continue;
-
-               if (!(event->type & EVT_TIMER))
-                       break;
-               switch (type) {
-               case EFI_TIMER_STOP:
-                       event->trigger_next = -1ULL;
-                       break;
-               case EFI_TIMER_PERIODIC:
-               case EFI_TIMER_RELATIVE:
-                       event->trigger_next =
-                               timer_get_us() + trigger_time;
-                       break;
-               default:
-                       return EFI_INVALID_PARAMETER;
-               }
-               event->trigger_type = type;
-               event->trigger_time = trigger_time;
-               event->is_signaled = false;
-               return EFI_SUCCESS;
+       switch (type) {
+       case EFI_TIMER_STOP:
+               event->trigger_next = -1ULL;
+               break;
+       case EFI_TIMER_PERIODIC:
+       case EFI_TIMER_RELATIVE:
+               event->trigger_next = timer_get_us() + trigger_time;
+               break;
+       default:
+               return EFI_INVALID_PARAMETER;
        }
-       return EFI_INVALID_PARAMETER;
+       event->trigger_type = type;
+       event->trigger_time = trigger_time;
+       event->is_signaled = false;
+       return EFI_SUCCESS;
 }
 
 /*
@@ -708,7 +777,7 @@ static efi_status_t EFIAPI efi_wait_for_event(efi_uintn_t num_events,
                                              struct efi_event **event,
                                              efi_uintn_t *index)
 {
-       int i, j;
+       int i;
 
        EFI_ENTRY("%zd, %p, %p", num_events, event, index);
 
@@ -719,16 +788,12 @@ static efi_status_t EFIAPI efi_wait_for_event(efi_uintn_t num_events,
        if (efi_tpl != TPL_APPLICATION)
                return EFI_EXIT(EFI_UNSUPPORTED);
        for (i = 0; i < num_events; ++i) {
-               for (j = 0; j < ARRAY_SIZE(efi_events); ++j) {
-                       if (event[i] == &efi_events[j])
-                               goto known_event;
-               }
-               return EFI_EXIT(EFI_INVALID_PARAMETER);
-known_event:
+               if (efi_is_event(event[i]) != EFI_SUCCESS)
+                       return EFI_EXIT(EFI_INVALID_PARAMETER);
                if (!event[i]->type || event[i]->type & EVT_NOTIFY_SIGNAL)
                        return EFI_EXIT(EFI_INVALID_PARAMETER);
                if (!event[i]->is_signaled)
-                       efi_signal_event(event[i], true);
+                       efi_queue_event(event[i], true);
        }
 
        /* Wait for signal */
@@ -768,19 +833,10 @@ out:
  */
 static efi_status_t EFIAPI efi_signal_event_ext(struct efi_event *event)
 {
-       int i;
-
        EFI_ENTRY("%p", event);
-       for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
-               if (event != &efi_events[i])
-                       continue;
-               if (event->is_signaled)
-                       break;
-               event->is_signaled = true;
-               if (event->type & EVT_NOTIFY_SIGNAL)
-                       efi_signal_event(event, true);
-               break;
-       }
+       if (efi_is_event(event) != EFI_SUCCESS)
+               return EFI_EXIT(EFI_INVALID_PARAMETER);
+       efi_signal_event(event, true);
        return EFI_EXIT(EFI_SUCCESS);
 }
 
@@ -796,19 +852,12 @@ static efi_status_t EFIAPI efi_signal_event_ext(struct efi_event *event)
  */
 static efi_status_t EFIAPI efi_close_event(struct efi_event *event)
 {
-       int i;
-
        EFI_ENTRY("%p", event);
-       for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
-               if (event == &efi_events[i]) {
-                       event->type = 0;
-                       event->trigger_next = -1ULL;
-                       event->is_queued = false;
-                       event->is_signaled = false;
-                       return EFI_EXIT(EFI_SUCCESS);
-               }
-       }
-       return EFI_EXIT(EFI_INVALID_PARAMETER);
+       if (efi_is_event(event) != EFI_SUCCESS)
+               return EFI_EXIT(EFI_INVALID_PARAMETER);
+       list_del(&event->link);
+       free(event);
+       return EFI_EXIT(EFI_SUCCESS);
 }
 
 /*
@@ -826,24 +875,18 @@ static efi_status_t EFIAPI efi_close_event(struct efi_event *event)
  */
 static efi_status_t EFIAPI efi_check_event(struct efi_event *event)
 {
-       int i;
-
        EFI_ENTRY("%p", event);
        efi_timer_check();
-       for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
-               if (event != &efi_events[i])
-                       continue;
-               if (!event->type || event->type & EVT_NOTIFY_SIGNAL)
-                       break;
-               if (!event->is_signaled)
-                       efi_signal_event(event, true);
-               if (event->is_signaled) {
-                       event->is_signaled = false;
-                       return EFI_EXIT(EFI_SUCCESS);
-               }
-               return EFI_EXIT(EFI_NOT_READY);
+       if (efi_is_event(event) != EFI_SUCCESS ||
+           event->type & EVT_NOTIFY_SIGNAL)
+               return EFI_EXIT(EFI_INVALID_PARAMETER);
+       if (!event->is_signaled)
+               efi_queue_event(event, true);
+       if (event->is_signaled) {
+               event->is_signaled = false;
+               return EFI_EXIT(EFI_SUCCESS);
        }
-       return EFI_EXIT(EFI_INVALID_PARAMETER);
+       return EFI_EXIT(EFI_NOT_READY);
 }
 
 /*
@@ -1335,6 +1378,7 @@ static void efi_remove_configuration_table(int i)
 efi_status_t efi_install_configuration_table(const efi_guid_t *guid,
                                             void *table)
 {
+       struct efi_event *evt;
        int i;
 
        if (!guid)
@@ -1347,7 +1391,7 @@ efi_status_t efi_install_configuration_table(const efi_guid_t *guid,
                                efi_conf_table[i].table = table;
                        else
                                efi_remove_configuration_table(i);
-                       return EFI_SUCCESS;
+                       goto out;
                }
        }
 
@@ -1363,6 +1407,15 @@ efi_status_t efi_install_configuration_table(const efi_guid_t *guid,
        efi_conf_table[i].table = table;
        systab.nr_tables = i + 1;
 
+out:
+       /* Notify that the configuration table was changed */
+       list_for_each_entry(evt, &efi_events, link) {
+               if (evt->group && !guidcmp(evt->group, guid)) {
+                       efi_signal_event(evt, false);
+                       break;
+               }
+       }
+
        return EFI_SUCCESS;
 }
 
@@ -1460,7 +1513,7 @@ efi_status_t efi_load_image_from_path(struct efi_device_path *file_path,
        struct efi_file_info *info = NULL;
        struct efi_file_handle *f;
        static efi_status_t ret;
-       uint64_t bs;
+       efi_uintn_t bs;
 
        f = efi_file_from_path(file_path);
        if (!f)
@@ -1481,7 +1534,8 @@ efi_status_t efi_load_image_from_path(struct efi_device_path *file_path,
        if (ret)
                goto error;
 
-       EFI_CALL(ret = f->read(f, &info->file_size, *buffer));
+       bs = info->file_size;
+       EFI_CALL(ret = f->read(f, &bs, *buffer));
 
 error:
        free(info);
@@ -1515,14 +1569,14 @@ 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_uintn_t source_size,
                                          efi_handle_t *image_handle)
 {
        struct efi_loaded_image *info;
        struct efi_object *obj;
        efi_status_t ret;
 
-       EFI_ENTRY("%d, %p, %pD, %p, %ld, %p", boot_policy, parent_image,
+       EFI_ENTRY("%d, %p, %pD, %p, %zd, %p", boot_policy, parent_image,
                  file_path, source_buffer, source_size, image_handle);
 
        if (!image_handle || !parent_image) {
@@ -1755,7 +1809,7 @@ static void efi_exit_caches(void)
 static efi_status_t EFIAPI efi_exit_boot_services(efi_handle_t image_handle,
                                                  unsigned long map_key)
 {
-       int i;
+       struct efi_event *evt;
 
        EFI_ENTRY("%p, %ld", image_handle, map_key);
 
@@ -1766,12 +1820,19 @@ static efi_status_t EFIAPI efi_exit_boot_services(efi_handle_t image_handle,
        if (!systab.boottime)
                return EFI_EXIT(EFI_SUCCESS);
 
+       /* Add related events to the event group */
+       list_for_each_entry(evt, &efi_events, link) {
+               if (evt->type == EVT_SIGNAL_EXIT_BOOT_SERVICES)
+                       evt->group = &efi_guid_event_group_exit_boot_services;
+       }
        /* Notify that ExitBootServices is invoked. */
-       for (i = 0; i < ARRAY_SIZE(efi_events); ++i) {
-               if (efi_events[i].type != EVT_SIGNAL_EXIT_BOOT_SERVICES)
-                       continue;
-               efi_events[i].is_signaled = true;
-               efi_signal_event(&efi_events[i], false);
+       list_for_each_entry(evt, &efi_events, link) {
+               if (evt->group &&
+                   !guidcmp(evt->group,
+                            &efi_guid_event_group_exit_boot_services)) {
+                       efi_signal_event(evt, false);
+                       break;
+               }
        }
 
        /* TODO Should persist EFI variables here */
@@ -2158,7 +2219,7 @@ static efi_status_t EFIAPI efi_locate_device_path(
        }
 
        /* Find end of device path */
-       len = efi_dp_size(*device_path);
+       len = efi_dp_instance_size(*device_path);
 
        /* Get all handles implementing the protocol */
        ret = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL, protocol, NULL,
@@ -2173,7 +2234,7 @@ static efi_status_t EFIAPI efi_locate_device_path(
                if (ret != EFI_SUCCESS)
                        continue;
                dp = (struct efi_device_path *)handler->protocol_interface;
-               len_dp = efi_dp_size(dp);
+               len_dp = efi_dp_instance_size(dp);
                /*
                 * This handle can only be a better fit
                 * if its device path length is longer than the best fit and