]> git.sur5r.net Git - u-boot/blobdiff - lib/efi_loader/efi_boottime.c
efi_loader: helper function to add EFI object to list
[u-boot] / lib / efi_loader / efi_boottime.c
index e372c8bb94f05e2df55b1a540abe0ef687e8ca0d..a37fb25638ce35aea864a6d7c0ae92b18bdaaafd 100644 (file)
@@ -321,6 +321,23 @@ static efi_status_t EFIAPI efi_free_pool_ext(void *buffer)
        return EFI_EXIT(r);
 }
 
+/*
+ * Add a new object to the object list.
+ *
+ * The protocols list is initialized.
+ * The object handle is set.
+ *
+ * @obj        object to be added
+ */
+void efi_add_handle(struct efi_object *obj)
+{
+       if (!obj)
+               return;
+       INIT_LIST_HEAD(&obj->protocols);
+       obj->handle = obj;
+       list_add_tail(&obj->link, &efi_obj_list);
+}
+
 /*
  * Create handle.
  *
@@ -337,10 +354,8 @@ efi_status_t efi_create_handle(void **handle)
                              (void **)&obj);
        if (r != EFI_SUCCESS)
                return r;
-       memset(obj, 0, sizeof(struct efi_object));
-       obj->handle = obj;
-       list_add_tail(&obj->link, &efi_obj_list);
-       *handle = obj;
+       efi_add_handle(obj);
+       *handle = obj->handle;
        return r;
 }
 
@@ -715,18 +730,17 @@ efi_status_t efi_search_protocol(const void *handle,
                                 struct efi_handler **handler)
 {
        struct efi_object *efiobj;
-       size_t i;
-       struct efi_handler *protocol;
+       struct list_head *lhandle;
 
        if (!handle || !protocol_guid)
                return EFI_INVALID_PARAMETER;
        efiobj = efi_search_obj(handle);
        if (!efiobj)
                return EFI_INVALID_PARAMETER;
-       for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
-               protocol = &efiobj->protocols[i];
-               if (!protocol->guid)
-                       continue;
+       list_for_each(lhandle, &efiobj->protocols) {
+               struct efi_handler *protocol;
+
+               protocol = list_entry(lhandle, struct efi_handler, link);
                if (!guidcmp(protocol->guid, protocol_guid)) {
                        if (handler)
                                *handler = protocol;
@@ -750,7 +764,6 @@ efi_status_t efi_add_protocol(const void *handle, const efi_guid_t *protocol,
        struct efi_object *efiobj;
        struct efi_handler *handler;
        efi_status_t ret;
-       size_t i;
 
        efiobj = efi_search_obj(handle);
        if (!efiobj)
@@ -761,16 +774,10 @@ efi_status_t efi_add_protocol(const void *handle, const efi_guid_t *protocol,
        handler = calloc(1, sizeof(struct efi_handler));
        if (!handler)
                return EFI_OUT_OF_RESOURCES;
-       /* Install protocol in first empty slot. */
-       for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
-               handler = &efiobj->protocols[i];
-               if (handler->guid)
-                       continue;
-               handler->guid = protocol;
-               handler->protocol_interface = protocol_interface;
-               return EFI_SUCCESS;
-       }
-       return EFI_OUT_OF_RESOURCES;
+       handler->guid = protocol;
+       handler->protocol_interface = protocol_interface;
+       list_add_tail(&handler->link, &efiobj->protocols);
+       return EFI_SUCCESS;
 }
 
 /*
@@ -790,10 +797,10 @@ efi_status_t efi_remove_protocol(const void *handle, const efi_guid_t *protocol,
        ret = efi_search_protocol(handle, protocol, &handler);
        if (ret != EFI_SUCCESS)
                return ret;
-       if (handler->protocol_interface != protocol_interface)
-               return EFI_NOT_FOUND;
-       handler->guid = NULL;
-       handler->protocol_interface = NULL;
+       if (guidcmp(handler->guid, protocol))
+               return EFI_INVALID_PARAMETER;
+       list_del(&handler->link);
+       free(handler);
        return EFI_SUCCESS;
 }
 
@@ -806,17 +813,22 @@ efi_status_t efi_remove_protocol(const void *handle, const efi_guid_t *protocol,
 efi_status_t efi_remove_all_protocols(const void *handle)
 {
        struct efi_object *efiobj;
-       struct efi_handler *handler;
-       size_t i;
+       struct list_head *lhandle;
+       struct list_head *pos;
 
        efiobj = efi_search_obj(handle);
        if (!efiobj)
                return EFI_INVALID_PARAMETER;
+       list_for_each_safe(lhandle, pos, &efiobj->protocols) {
+               struct efi_handler *protocol;
+               efi_status_t ret;
+
+               protocol = list_entry(lhandle, struct efi_handler, link);
 
-       for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
-               handler = &efiobj->protocols[i];
-               handler->guid = NULL;
-               handler->protocol_interface = NULL;
+               ret = efi_remove_protocol(handle, protocol->guid,
+                                         protocol->protocol_interface);
+               if (ret != EFI_SUCCESS)
+                       return ret;
        }
        return EFI_SUCCESS;
 }
@@ -839,8 +851,6 @@ static efi_status_t EFIAPI efi_install_protocol_interface(
                        void **handle, const efi_guid_t *protocol,
                        int protocol_interface_type, void *protocol_interface)
 {
-       struct list_head *lhandle;
-       int i;
        efi_status_t r;
 
        EFI_ENTRY("%p, %pUl, %d, %p", handle, protocol, protocol_interface_type,
@@ -863,40 +873,8 @@ static efi_status_t EFIAPI efi_install_protocol_interface(
                debug("%sEFI: handle %p\n", indent_string(nesting_level),
                      *handle);
        }
-       /* Find object. */
-       list_for_each(lhandle, &efi_obj_list) {
-               struct efi_object *efiobj;
-               efiobj = list_entry(lhandle, struct efi_object, link);
-
-               if (efiobj->handle != *handle)
-                       continue;
-               /* Check if protocol is already installed on the handle. */
-               for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
-                       struct efi_handler *handler = &efiobj->protocols[i];
-
-                       if (!handler->guid)
-                               continue;
-                       if (!guidcmp(handler->guid, protocol)) {
-                               r = EFI_INVALID_PARAMETER;
-                               goto out;
-                       }
-               }
-               /* Install protocol in first empty slot. */
-               for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
-                       struct efi_handler *handler = &efiobj->protocols[i];
-
-                       if (handler->guid)
-                               continue;
-
-                       handler->guid = protocol;
-                       handler->protocol_interface = protocol_interface;
-                       r = EFI_SUCCESS;
-                       goto out;
-               }
-               r = EFI_OUT_OF_RESOURCES;
-               goto out;
-       }
-       r = EFI_INVALID_PARAMETER;
+       /* Add new protocol */
+       r = efi_add_protocol(*handle, protocol, protocol_interface);
 out:
        return EFI_EXIT(r);
 }
@@ -940,9 +918,8 @@ static efi_status_t EFIAPI efi_uninstall_protocol_interface(
                                void *handle, const efi_guid_t *protocol,
                                void *protocol_interface)
 {
-       struct list_head *lhandle;
-       int i;
-       efi_status_t r = EFI_NOT_FOUND;
+       struct efi_handler *handler;
+       efi_status_t r;
 
        EFI_ENTRY("%p, %pUl, %p", handle, protocol, protocol_interface);
 
@@ -951,31 +928,16 @@ static efi_status_t EFIAPI efi_uninstall_protocol_interface(
                goto out;
        }
 
-       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)
-                               continue;
-                       if (!guidcmp(hprotocol, protocol)) {
-                               if (handler->protocol_interface) {
-                                       r = EFI_ACCESS_DENIED;
-                               } else {
-                                       handler->guid = 0;
-                                       r = EFI_SUCCESS;
-                               }
-                               goto out;
-                       }
-               }
+       /* Find the protocol on the handle */
+       r = efi_search_protocol(handle, protocol, &handler);
+       if (r != EFI_SUCCESS)
+               goto out;
+       if (handler->protocol_interface) {
+               /* TODO disconnect controllers */
+               r =  EFI_ACCESS_DENIED;
+       } else {
+               r = efi_remove_protocol(handle, protocol, protocol_interface);
        }
-
 out:
        return EFI_EXIT(r);
 }
@@ -1017,24 +979,21 @@ static int efi_search(enum efi_locate_search_type search_type,
                      const efi_guid_t *protocol, void *search_key,
                      struct efi_object *efiobj)
 {
-       int i;
+       efi_status_t ret;
 
        switch (search_type) {
        case ALL_HANDLES:
                return 0;
        case BY_REGISTER_NOTIFY:
-               /* RegisterProtocolNotify is not implemented yet */
+               /* TODO: RegisterProtocolNotify is not implemented yet */
                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;
-               }
+               ret = efi_search_protocol(efiobj->handle, protocol, NULL);
+               return (ret != EFI_SUCCESS);
+       default:
+               /* Invalid search type */
                return -1;
        }
-
-       return -1;
 }
 
 /*
@@ -1133,36 +1092,6 @@ static efi_status_t EFIAPI efi_locate_handle_ext(
                        buffer_size, buffer));
 }
 
-/*
- * Get the device path and handle of an device implementing a protocol.
- *
- * This function implements the LocateDevicePath service.
- * See the Unified Extensible Firmware Interface (UEFI) specification
- * for details.
- *
- * @protocol           GUID of the protocol
- * @device_path                device path
- * @device             handle of the device
- * @return             status code
- */
-static efi_status_t EFIAPI efi_locate_device_path(
-                       const efi_guid_t *protocol,
-                       struct efi_device_path **device_path,
-                       efi_handle_t *device)
-{
-       struct efi_object *efiobj;
-
-       EFI_ENTRY("%pUl, %p, %p", protocol, device_path, device);
-
-       efiobj = efi_dp_find_obj(*device_path, device_path);
-       if (!efiobj)
-               return EFI_EXIT(EFI_NOT_FOUND);
-
-       *device = efiobj->handle;
-
-       return EFI_EXIT(EFI_SUCCESS);
-}
-
 /* Collapses configuration table entries, removing index i */
 static void efi_remove_configuration_table(int i)
 {
@@ -1246,34 +1175,47 @@ void efi_setup_loaded_image(struct efi_loaded_image *info, struct efi_object *ob
                            struct efi_device_path *device_path,
                            struct efi_device_path *file_path)
 {
+       efi_status_t ret;
+
+       /* Add internal object to object list */
+       efi_add_handle(obj);
+       /* efi_exit() assumes that the handle points to the info */
        obj->handle = info;
 
+       info->file_path = file_path;
+       if (device_path)
+               info->device_handle = efi_dp_find_obj(device_path, NULL);
+
        /*
         * When asking for the device path interface, return
         * bootefi_device_path
         */
-       obj->protocols[0].guid = &efi_guid_device_path;
-       obj->protocols[0].protocol_interface = device_path;
+       ret = efi_add_protocol(obj->handle, &efi_guid_device_path, device_path);
+       if (ret != EFI_SUCCESS)
+               goto failure;
 
        /*
         * When asking for the loaded_image interface, just
         * return handle which points to loaded_image_info
         */
-       obj->protocols[1].guid = &efi_guid_loaded_image;
-       obj->protocols[1].protocol_interface = info;
-
-       obj->protocols[2].guid = &efi_guid_console_control;
-       obj->protocols[2].protocol_interface = (void *)&efi_console_control;
+       ret = efi_add_protocol(obj->handle, &efi_guid_loaded_image, info);
+       if (ret != EFI_SUCCESS)
+               goto failure;
 
-       obj->protocols[3].guid = &efi_guid_device_path_to_text_protocol;
-       obj->protocols[3].protocol_interface =
-               (void *)&efi_device_path_to_text;
+       ret = efi_add_protocol(obj->handle, &efi_guid_console_control,
+                              (void *)&efi_console_control);
+       if (ret != EFI_SUCCESS)
+               goto failure;
 
-       info->file_path = file_path;
-       if (device_path)
-               info->device_handle = efi_dp_find_obj(device_path, NULL);
+       ret = efi_add_protocol(obj->handle,
+                              &efi_guid_device_path_to_text_protocol,
+                              (void *)&efi_device_path_to_text);
+       if (ret != EFI_SUCCESS)
+               goto failure;
 
-       list_add_tail(&obj->link, &efi_obj_list);
+       return;
+failure:
+       printf("ERROR: Failure to install protocols for loaded image\n");
 }
 
 /*
@@ -1390,7 +1332,7 @@ static efi_status_t EFIAPI efi_load_image(bool boot_policy,
 
        info->system_table = &systab;
        info->parent_handle = parent_image;
-       *image_handle = info;
+       *image_handle = obj->handle;
 
        return EFI_EXIT(EFI_SUCCESS);
 }
@@ -1452,6 +1394,17 @@ static efi_status_t EFIAPI efi_exit(efi_handle_t image_handle,
                        efi_status_t exit_status, unsigned long exit_data_size,
                        int16_t *exit_data)
 {
+       /*
+        * We require that the handle points to the original loaded
+        * image protocol interface.
+        *
+        * For getting the longjmp address this is safer than locating
+        * the protocol because the protocol may have been reinstalled
+        * pointing to another memory location.
+        *
+        * TODO: We should call the unload procedure of the loaded
+        *       image protocol.
+        */
        struct efi_loaded_image *loaded_image_info = (void*)image_handle;
 
        EFI_ENTRY("%p, %ld, %ld, %p", image_handle, exit_status,
@@ -1720,8 +1673,7 @@ static efi_status_t EFIAPI efi_protocols_per_handle(void *handle,
 {
        unsigned long buffer_size;
        struct efi_object *efiobj;
-       unsigned long i, j;
-       struct list_head *lhandle;
+       struct list_head *protocol_handle;
        efi_status_t r;
 
        EFI_ENTRY("%p, %p, %p", handle, protocol_buffer,
@@ -1732,36 +1684,33 @@ static efi_status_t EFIAPI efi_protocols_per_handle(void *handle,
 
        *protocol_buffer = NULL;
        *protocol_buffer_count = 0;
-       list_for_each(lhandle, &efi_obj_list) {
-               efiobj = list_entry(lhandle, struct efi_object, link);
 
-               if (efiobj->handle != handle)
-                       continue;
+       efiobj = efi_search_obj(handle);
+       if (!efiobj)
+               return EFI_EXIT(EFI_INVALID_PARAMETER);
 
-               /* Count protocols */
-               for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
-                       if (efiobj->protocols[i].guid)
-                               ++*protocol_buffer_count;
-               }
-               /* Copy guids */
-               if (*protocol_buffer_count) {
-                       buffer_size = sizeof(efi_guid_t *) *
-                                       *protocol_buffer_count;
-                       r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES,
-                                             buffer_size,
-                                             (void **)protocol_buffer);
-                       if (r != EFI_SUCCESS)
-                               return EFI_EXIT(r);
-                       j = 0;
-                       for (i = 0; i < ARRAY_SIZE(efiobj->protocols); ++i) {
-                               if (efiobj->protocols[i].guid) {
-                                       (*protocol_buffer)[j] = (void *)
-                                               efiobj->protocols[i].guid;
-                                       ++j;
-                               }
-                       }
+       /* Count protocols */
+       list_for_each(protocol_handle, &efiobj->protocols) {
+               ++*protocol_buffer_count;
+       }
+
+       /* Copy guids */
+       if (*protocol_buffer_count) {
+               size_t j = 0;
+
+               buffer_size = sizeof(efi_guid_t *) * *protocol_buffer_count;
+               r = efi_allocate_pool(EFI_ALLOCATE_ANY_PAGES, buffer_size,
+                                     (void **)protocol_buffer);
+               if (r != EFI_SUCCESS)
+                       return EFI_EXIT(r);
+               list_for_each(protocol_handle, &efiobj->protocols) {
+                       struct efi_handler *protocol;
+
+                       protocol = list_entry(protocol_handle,
+                                             struct efi_handler, link);
+                       (*protocol_buffer)[j] = (void *)protocol->guid;
+                       ++j;
                }
-               break;
        }
 
        return EFI_EXIT(EFI_SUCCESS);
@@ -1831,29 +1780,23 @@ static efi_status_t EFIAPI efi_locate_protocol(const efi_guid_t *protocol,
                                               void **protocol_interface)
 {
        struct list_head *lhandle;
-       int i;
+       efi_status_t ret;
 
        EFI_ENTRY("%pUl, %p, %p", protocol, registration, protocol_interface);
 
        if (!protocol || !protocol_interface)
                return EFI_EXIT(EFI_INVALID_PARAMETER);
 
-       EFI_PRINT_GUID("protocol", protocol);
-
        list_for_each(lhandle, &efi_obj_list) {
                struct efi_object *efiobj;
+               struct efi_handler *handler;
 
                efiobj = list_entry(lhandle, struct efi_object, link);
-               for (i = 0; i < ARRAY_SIZE(efiobj->protocols); i++) {
-                       struct efi_handler *handler = &efiobj->protocols[i];
-
-                       if (!handler->guid)
-                               continue;
-                       if (!guidcmp(handler->guid, protocol)) {
-                               *protocol_interface =
-                                       handler->protocol_interface;
-                               return EFI_EXIT(EFI_SUCCESS);
-                       }
+
+               ret = efi_search_protocol(efiobj->handle, protocol, &handler);
+               if (ret == EFI_SUCCESS) {
+                       *protocol_interface = handler->protocol_interface;
+                       return EFI_EXIT(EFI_SUCCESS);
                }
        }
        *protocol_interface = NULL;
@@ -1861,6 +1804,82 @@ static efi_status_t EFIAPI efi_locate_protocol(const efi_guid_t *protocol,
        return EFI_EXIT(EFI_NOT_FOUND);
 }
 
+/*
+ * Get the device path and handle of an device implementing a protocol.
+ *
+ * This function implements the LocateDevicePath service.
+ * See the Unified Extensible Firmware Interface (UEFI) specification
+ * for details.
+ *
+ * @protocol           GUID of the protocol
+ * @device_path                device path
+ * @device             handle of the device
+ * @return             status code
+ */
+static efi_status_t EFIAPI efi_locate_device_path(
+                       const efi_guid_t *protocol,
+                       struct efi_device_path **device_path,
+                       efi_handle_t *device)
+{
+       struct efi_device_path *dp;
+       size_t i;
+       struct efi_handler *handler;
+       efi_handle_t *handles;
+       size_t len, len_dp;
+       size_t len_best = 0;
+       efi_uintn_t no_handles;
+       u8 *remainder;
+       efi_status_t ret;
+
+       EFI_ENTRY("%pUl, %p, %p", protocol, device_path, device);
+
+       if (!protocol || !device_path || !*device_path || !device) {
+               ret = EFI_INVALID_PARAMETER;
+               goto out;
+       }
+
+       /* Find end of device path */
+       len = efi_dp_size(*device_path);
+
+       /* Get all handles implementing the protocol */
+       ret = EFI_CALL(efi_locate_handle_buffer(BY_PROTOCOL, protocol, NULL,
+                                               &no_handles, &handles));
+       if (ret != EFI_SUCCESS)
+               goto out;
+
+       for (i = 0; i < no_handles; ++i) {
+               /* Find the device path protocol */
+               ret = efi_search_protocol(handles[i], &efi_guid_device_path,
+                                         &handler);
+               if (ret != EFI_SUCCESS)
+                       continue;
+               dp = (struct efi_device_path *)handler->protocol_interface;
+               len_dp = efi_dp_size(dp);
+               /*
+                * This handle can only be a better fit
+                * if its device path length is longer than the best fit and
+                * if its device path length is shorter of equal the searched
+                * device path.
+                */
+               if (len_dp <= len_best || len_dp > len)
+                       continue;
+               /* Check if dp is a subpath of device_path */
+               if (memcmp(*device_path, dp, len_dp))
+                       continue;
+               *device = handles[i];
+               len_best = len_dp;
+       }
+       if (len_best) {
+               remainder = (u8 *)*device_path + len_best;
+               *device_path = (struct efi_device_path *)remainder;
+               ret = EFI_SUCCESS;
+       } else {
+               ret = EFI_NOT_FOUND;
+       }
+out:
+       return EFI_EXIT(ret);
+}
+
 /*
  * Install multiple protocol interfaces.
  *
@@ -2053,8 +2072,7 @@ static efi_status_t EFIAPI efi_open_protocol(
                        void **protocol_interface, void *agent_handle,
                        void *controller_handle, uint32_t attributes)
 {
-       struct list_head *lhandle;
-       int i;
+       struct efi_handler *handler;
        efi_status_t r = EFI_INVALID_PARAMETER;
 
        EFI_ENTRY("%p, %pUl, %p, %p, %p, 0x%x", handle, protocol,
@@ -2067,8 +2085,6 @@ static efi_status_t EFIAPI efi_open_protocol(
                goto out;
        }
 
-       EFI_PRINT_GUID("protocol", protocol);
-
        switch (attributes) {
        case EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL:
        case EFI_OPEN_PROTOCOL_GET_PROTOCOL:
@@ -2089,33 +2105,12 @@ static efi_status_t EFIAPI efi_open_protocol(
                goto out;
        }
 
-       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)
-                               continue;
-                       if (!guidcmp(hprotocol, protocol)) {
-                               if (attributes !=
-                                   EFI_OPEN_PROTOCOL_TEST_PROTOCOL) {
-                                       *protocol_interface =
-                                               handler->protocol_interface;
-                               }
-                               r = EFI_SUCCESS;
-                               goto out;
-                       }
-               }
-               goto unsupported;
-       }
+       r = efi_search_protocol(handle, protocol, &handler);
+       if (r != EFI_SUCCESS)
+               goto out;
 
-unsupported:
-       r = EFI_UNSUPPORTED;
+       if (attributes != EFI_OPEN_PROTOCOL_TEST_PROTOCOL)
+               *protocol_interface = handler->protocol_interface;
 out:
        return EFI_EXIT(r);
 }