1 // SPDX-License-Identifier: GPL-2.0+
5 * Copyright (c) 2018 Linaro Limited
6 * Author: AKASHI Takahiro
9 #define LOG_CATEGORY LOGC_EFI
12 #include <efi_loader.h>
13 #include <efi_variable.h>
22 #include <asm/global_data.h>
24 #include <crypto/pkcs7.h>
25 #include <crypto/pkcs7_parser.h>
26 #include <linux/err.h>
28 DECLARE_GLOBAL_DATA_PTR;
30 const efi_guid_t efi_guid_capsule_report = EFI_CAPSULE_REPORT_GUID;
31 static const efi_guid_t efi_guid_firmware_management_capsule_id =
32 EFI_FIRMWARE_MANAGEMENT_CAPSULE_ID_GUID;
33 const efi_guid_t efi_guid_firmware_management_protocol =
34 EFI_FIRMWARE_MANAGEMENT_PROTOCOL_GUID;
36 #ifdef CONFIG_EFI_CAPSULE_ON_DISK
37 /* for file system access */
38 static struct efi_file_handle *bootdev_root;
42 * get_last_capsule - get the last capsule index
44 * Retrieve the index of the capsule invoked last time from "CapsuleLast"
48 * * > 0 - the last capsule index invoked
49 * * 0xffff - on error, or no capsule invoked yet
51 static __maybe_unused unsigned int get_last_capsule(void)
53 u16 value16[11]; /* "CapsuleXXXX": non-null-terminated */
56 unsigned long index = 0xffff;
60 size = sizeof(value16);
61 ret = efi_get_variable_int(u"CapsuleLast", &efi_guid_capsule_report,
62 NULL, &size, value16, NULL);
63 if (ret != EFI_SUCCESS || size != 22 ||
64 u16_strncmp(value16, u"Capsule", 7))
66 for (i = 0; i < 4; ++i) {
67 u16 c = value16[i + 7];
74 if (strict_strtoul(value, 16, &index))
81 * set_capsule_result - set a result variable
83 * @return_status: Return status
85 * Create and set a result variable, "CapsuleXXXX", for the capsule,
89 void set_capsule_result(int index, struct efi_capsule_header *capsule,
90 efi_status_t return_status)
92 u16 variable_name16[12];
93 struct efi_capsule_result_variable_header result;
97 efi_create_indexed_name(variable_name16, sizeof(variable_name16),
99 result.variable_total_size = sizeof(result);
100 result.capsule_guid = capsule->capsule_guid;
101 ret = EFI_CALL((*efi_runtime_services.get_time)(&time, NULL));
102 if (ret == EFI_SUCCESS)
103 memcpy(&result.capsule_processed, &time, sizeof(time));
105 memset(&result.capsule_processed, 0, sizeof(time));
106 result.capsule_status = return_status;
107 ret = efi_set_variable_int(variable_name16, &efi_guid_capsule_report,
108 EFI_VARIABLE_NON_VOLATILE |
109 EFI_VARIABLE_BOOTSERVICE_ACCESS |
110 EFI_VARIABLE_RUNTIME_ACCESS,
111 sizeof(result), &result, false);
112 if (ret != EFI_SUCCESS) {
113 log_err("Setting %ls failed\n", variable_name16);
117 /* Variable CapsuleLast must not include terminating 0x0000 */
118 ret = efi_set_variable_int(u"CapsuleLast", &efi_guid_capsule_report,
119 EFI_VARIABLE_READ_ONLY |
120 EFI_VARIABLE_NON_VOLATILE |
121 EFI_VARIABLE_BOOTSERVICE_ACCESS |
122 EFI_VARIABLE_RUNTIME_ACCESS,
123 22, variable_name16, false);
124 if (ret != EFI_SUCCESS)
125 log_err("Setting %ls failed\n", u"CapsuleLast");
128 #ifdef CONFIG_EFI_CAPSULE_FIRMWARE_MANAGEMENT
130 * efi_fmp_find - search for Firmware Management Protocol drivers
131 * @image_type: Image type guid
132 * @instance: Instance number
133 * @handles: Handles of FMP drivers
134 * @no_handles: Number of handles
136 * Search for Firmware Management Protocol drivers, matching the image
137 * type, @image_type and the machine instance, @instance, from the list,
141 * * Protocol instance - on success
142 * * NULL - on failure
144 static struct efi_firmware_management_protocol *
145 efi_fmp_find(efi_guid_t *image_type, u64 instance, efi_handle_t *handles,
146 efi_uintn_t no_handles)
148 efi_handle_t *handle;
149 struct efi_firmware_management_protocol *fmp;
150 struct efi_firmware_image_descriptor *image_info, *desc;
151 efi_uintn_t info_size, descriptor_size;
152 u32 descriptor_version;
155 u16 *package_version_name;
160 for (i = 0, handle = handles; i < no_handles; i++, handle++) {
161 ret = EFI_CALL(efi_handle_protocol(
163 &efi_guid_firmware_management_protocol,
165 if (ret != EFI_SUCCESS)
168 /* get device's image info */
171 descriptor_version = 0;
172 descriptor_count = 0;
175 package_version_name = NULL;
176 ret = EFI_CALL(fmp->get_image_info(fmp, &info_size,
182 &package_version_name));
183 if (ret != EFI_BUFFER_TOO_SMALL)
186 image_info = malloc(info_size);
190 ret = EFI_CALL(fmp->get_image_info(fmp, &info_size,
196 &package_version_name));
197 if (ret != EFI_SUCCESS ||
198 descriptor_version != EFI_FIRMWARE_IMAGE_DESCRIPTOR_VERSION)
202 for (j = 0, desc = image_info; j < descriptor_count;
203 j++, desc = (void *)desc + descriptor_size) {
204 log_debug("+++ desc[%d] index: %d, name: %ls\n",
205 j, desc->image_index, desc->image_id_name);
206 if (!guidcmp(&desc->image_type_id, image_type) &&
208 !desc->hardware_instance ||
209 desc->hardware_instance == instance))
214 efi_free_pool(package_version_name);
216 EFI_CALL(efi_close_protocol(
218 &efi_guid_firmware_management_protocol,
228 * efi_remove_auth_hdr - remove authentication data from image
229 * @image: Pointer to pointer to Image
230 * @image_size: Pointer to Image size
232 * Remove the authentication data from image if possible.
233 * Update @image and @image_size.
235 * Return: status code
237 static efi_status_t efi_remove_auth_hdr(void **image, efi_uintn_t *image_size)
239 struct efi_firmware_image_authentication *auth_hdr;
240 efi_status_t ret = EFI_INVALID_PARAMETER;
242 auth_hdr = (struct efi_firmware_image_authentication *)*image;
243 if (*image_size < sizeof(*auth_hdr))
246 if (auth_hdr->auth_info.hdr.dwLength <=
247 offsetof(struct win_certificate_uefi_guid, cert_data))
250 *image = (uint8_t *)*image + sizeof(auth_hdr->monotonic_count) +
251 auth_hdr->auth_info.hdr.dwLength;
252 *image_size = *image_size - auth_hdr->auth_info.hdr.dwLength -
253 sizeof(auth_hdr->monotonic_count);
260 #if defined(CONFIG_EFI_CAPSULE_AUTHENTICATE)
261 int efi_get_public_key_data(void **pkey, efi_uintn_t *pkey_len)
263 const void *fdt_blob = gd->fdt_blob;
265 const char *cnode_name = "capsule-key";
266 const char *snode_name = "signature";
270 sig_node = fdt_subnode_offset(fdt_blob, 0, snode_name);
272 log_err("Unable to get signature node offset\n");
274 return -FDT_ERR_NOTFOUND;
277 blob = fdt_getprop(fdt_blob, sig_node, cnode_name, &len);
279 if (!blob || len < 0) {
280 log_err("Unable to get capsule-key value\n");
284 return -FDT_ERR_NOTFOUND;
287 *pkey = (void *)blob;
293 efi_status_t efi_capsule_authenticate(const void *capsule, efi_uintn_t capsule_size,
294 void **image, efi_uintn_t *image_size)
298 void *fdt_pkey, *pkey;
299 efi_uintn_t pkey_len;
300 uint64_t monotonic_count;
301 struct efi_signature_store *truststore;
302 struct pkcs7_message *capsule_sig;
303 struct efi_image_regions *regs;
304 struct efi_firmware_image_authentication *auth_hdr;
307 status = EFI_SECURITY_VIOLATION;
313 if (capsule == NULL || capsule_size == 0)
316 *image = (uint8_t *)capsule;
317 *image_size = capsule_size;
318 if (efi_remove_auth_hdr(image, image_size) != EFI_SUCCESS)
321 auth_hdr = (struct efi_firmware_image_authentication *)capsule;
322 if (guidcmp(&auth_hdr->auth_info.cert_type, &efi_guid_cert_type_pkcs7))
325 memcpy(&monotonic_count, &auth_hdr->monotonic_count,
326 sizeof(monotonic_count));
328 /* data to be digested */
329 regs = calloc(sizeof(*regs) + sizeof(struct image_region) * 2, 1);
334 efi_image_region_add(regs, (uint8_t *)*image,
335 (uint8_t *)*image + *image_size, 1);
337 efi_image_region_add(regs, (uint8_t *)&monotonic_count,
338 (uint8_t *)&monotonic_count + sizeof(monotonic_count),
341 capsule_sig = efi_parse_pkcs7_header(auth_hdr->auth_info.cert_data,
342 auth_hdr->auth_info.hdr.dwLength
343 - sizeof(auth_hdr->auth_info),
345 if (IS_ERR(capsule_sig)) {
346 debug("Parsing variable's pkcs7 header failed\n");
351 ret = efi_get_public_key_data(&fdt_pkey, &pkey_len);
355 pkey = malloc(pkey_len);
359 memcpy(pkey, fdt_pkey, pkey_len);
360 truststore = efi_build_signature_store(pkey, pkey_len);
364 /* verify signature */
365 if (efi_signature_verify(regs, capsule_sig, truststore, NULL)) {
368 debug("Verifying variable's signature failed\n");
372 status = EFI_SUCCESS;
375 efi_sigstore_free(truststore);
376 pkcs7_free_message(capsule_sig);
382 efi_status_t efi_capsule_authenticate(const void *capsule, efi_uintn_t capsule_size,
383 void **image, efi_uintn_t *image_size)
385 return EFI_UNSUPPORTED;
387 #endif /* CONFIG_EFI_CAPSULE_AUTHENTICATE */
391 * efi_capsule_update_firmware - update firmware from capsule
392 * @capsule_data: Capsule
394 * Update firmware, using a capsule, @capsule_data. Loading any FMP
395 * drivers embedded in a capsule is not supported.
397 * Return: status code
399 static efi_status_t efi_capsule_update_firmware(
400 struct efi_capsule_header *capsule_data)
402 struct efi_firmware_management_capsule_header *capsule;
403 struct efi_firmware_management_capsule_image_header *image;
404 size_t capsule_size, image_binary_size;
405 void *image_binary, *vendor_code;
406 efi_handle_t *handles;
407 efi_uintn_t no_handles;
409 struct efi_firmware_management_protocol *fmp;
411 efi_status_t ret = EFI_SUCCESS;
414 if (capsule_data->header_size < sizeof(*capsule) ||
415 capsule_data->header_size >= capsule_data->capsule_image_size)
416 return EFI_INVALID_PARAMETER;
418 capsule = (void *)capsule_data + capsule_data->header_size;
419 capsule_size = capsule_data->capsule_image_size
420 - capsule_data->header_size;
422 if (capsule->version != 0x00000001)
423 return EFI_UNSUPPORTED;
426 ret = EFI_CALL(efi_locate_handle_buffer(
428 &efi_guid_firmware_management_protocol,
429 NULL, &no_handles, (efi_handle_t **)&handles));
430 if (ret != EFI_SUCCESS)
431 return EFI_UNSUPPORTED;
434 for (item = capsule->embedded_driver_count;
435 item < capsule->embedded_driver_count
436 + capsule->payload_item_count; item++) {
438 if ((capsule->item_offset_list[item] + sizeof(*image)
440 log_err("Capsule does not have enough data\n");
441 ret = EFI_INVALID_PARAMETER;
445 image = (void *)capsule + capsule->item_offset_list[item];
447 if (image->version != 0x00000003) {
448 ret = EFI_UNSUPPORTED;
452 /* find a device for update firmware */
453 /* TODO: should we pass index as well, or nothing but type? */
454 fmp = efi_fmp_find(&image->update_image_type_id,
455 image->update_hardware_instance,
456 handles, no_handles);
458 log_err("FMP driver not found for firmware type %pUs, hardware instance %lld\n",
459 &image->update_image_type_id,
460 image->update_hardware_instance);
461 ret = EFI_UNSUPPORTED;
466 if (IS_ENABLED(CONFIG_EFI_CAPSULE_AUTHENTICATE) &&
467 !(image->image_capsule_support &
468 CAPSULE_SUPPORT_AUTHENTICATION)) {
470 ret = EFI_SECURITY_VIOLATION;
474 image_binary = (void *)image + sizeof(*image);
475 image_binary_size = image->update_image_size;
476 vendor_code = image_binary + image_binary_size;
477 if (!IS_ENABLED(CONFIG_EFI_CAPSULE_AUTHENTICATE) &&
478 (image->image_capsule_support &
479 CAPSULE_SUPPORT_AUTHENTICATION)) {
480 ret = efi_remove_auth_hdr(&image_binary,
482 if (ret != EFI_SUCCESS)
487 ret = EFI_CALL(fmp->set_image(fmp, image->update_image_index,
492 if (ret != EFI_SUCCESS) {
493 log_err("Firmware update failed: %ls\n",
495 efi_free_pool(abort_reason);
501 efi_free_pool(handles);
506 static efi_status_t efi_capsule_update_firmware(
507 struct efi_capsule_header *capsule_data)
509 return EFI_UNSUPPORTED;
511 #endif /* CONFIG_EFI_CAPSULE_FIRMWARE_MANAGEMENT */
514 * efi_update_capsule() - process information from operating system
515 * @capsule_header_array: Array of virtual address pointers
516 * @capsule_count: Number of pointers in capsule_header_array
517 * @scatter_gather_list: Array of physical address pointers
519 * This function implements the UpdateCapsule() runtime service.
521 * See the Unified Extensible Firmware Interface (UEFI) specification for
524 * Return: status code
526 efi_status_t EFIAPI efi_update_capsule(
527 struct efi_capsule_header **capsule_header_array,
528 efi_uintn_t capsule_count,
529 u64 scatter_gather_list)
531 struct efi_capsule_header *capsule;
535 EFI_ENTRY("%p, %zu, %llu\n", capsule_header_array, capsule_count,
536 scatter_gather_list);
538 if (!capsule_count) {
539 ret = EFI_INVALID_PARAMETER;
544 for (i = 0, capsule = *capsule_header_array; i < capsule_count;
545 i++, capsule = *(++capsule_header_array)) {
547 if (capsule->header_size < sizeof(*capsule) ||
548 capsule->capsule_image_size < sizeof(*capsule)) {
549 log_err("Capsule does not have enough data\n");
553 log_debug("Capsule[%d] (guid:%pUs)\n",
554 i, &capsule->capsule_guid);
555 if (!guidcmp(&capsule->capsule_guid,
556 &efi_guid_firmware_management_capsule_id)) {
557 ret = efi_capsule_update_firmware(capsule);
559 log_err("Unsupported capsule type: %pUs\n",
560 &capsule->capsule_guid);
561 ret = EFI_UNSUPPORTED;
564 if (ret != EFI_SUCCESS)
568 if (IS_ENABLED(CONFIG_EFI_ESRT)) {
569 /* Rebuild the ESRT to reflect any updated FW images. */
570 ret = efi_esrt_populate();
571 if (ret != EFI_SUCCESS)
572 log_warning("ESRT update failed\n");
576 return EFI_EXIT(ret);
580 * efi_query_capsule_caps() - check if capsule is supported
581 * @capsule_header_array: Array of virtual pointers
582 * @capsule_count: Number of pointers in capsule_header_array
583 * @maximum_capsule_size: Maximum capsule size
584 * @reset_type: Type of reset needed for capsule update
586 * This function implements the QueryCapsuleCapabilities() runtime service.
588 * See the Unified Extensible Firmware Interface (UEFI) specification for
591 * Return: status code
593 efi_status_t EFIAPI efi_query_capsule_caps(
594 struct efi_capsule_header **capsule_header_array,
595 efi_uintn_t capsule_count,
596 u64 *maximum_capsule_size,
599 struct efi_capsule_header *capsule __attribute__((unused));
603 EFI_ENTRY("%p, %zu, %p, %p\n", capsule_header_array, capsule_count,
604 maximum_capsule_size, reset_type);
606 if (!maximum_capsule_size) {
607 ret = EFI_INVALID_PARAMETER;
611 *maximum_capsule_size = U64_MAX;
612 *reset_type = EFI_RESET_COLD;
615 for (i = 0, capsule = *capsule_header_array; i < capsule_count;
616 i++, capsule = *(++capsule_header_array)) {
620 return EFI_EXIT(ret);
624 * efi_load_capsule_drivers - initialize capsule drivers
626 * Generic FMP drivers backed by DFU
628 * Return: status code
630 efi_status_t __weak efi_load_capsule_drivers(void)
632 __maybe_unused efi_handle_t handle;
633 efi_status_t ret = EFI_SUCCESS;
635 if (IS_ENABLED(CONFIG_EFI_CAPSULE_FIRMWARE_FIT)) {
637 ret = EFI_CALL(efi_install_multiple_protocol_interfaces(
638 &handle, &efi_guid_firmware_management_protocol,
639 &efi_fmp_fit, NULL));
642 if (IS_ENABLED(CONFIG_EFI_CAPSULE_FIRMWARE_RAW)) {
644 ret = EFI_CALL(efi_install_multiple_protocol_interfaces(
646 &efi_guid_firmware_management_protocol,
647 &efi_fmp_raw, NULL));
653 #ifdef CONFIG_EFI_CAPSULE_ON_DISK
655 * get_dp_device - retrieve a device path from boot variable
656 * @boot_var: Boot variable name
657 * @device_dp Device path
659 * Retrieve a device patch from boot variable, @boot_var.
661 * Return: status code
663 static efi_status_t get_dp_device(u16 *boot_var,
664 struct efi_device_path **device_dp)
668 struct efi_load_option lo;
669 struct efi_device_path *file_dp;
673 ret = efi_get_variable_int(boot_var, &efi_global_variable_guid,
674 NULL, &size, NULL, NULL);
675 if (ret == EFI_BUFFER_TOO_SMALL) {
678 return EFI_OUT_OF_RESOURCES;
679 ret = efi_get_variable_int(boot_var, &efi_global_variable_guid,
680 NULL, &size, buf, NULL);
682 if (ret != EFI_SUCCESS)
685 efi_deserialize_load_option(&lo, buf, &size);
687 if (lo.attributes & LOAD_OPTION_ACTIVE) {
688 efi_dp_split_file_path(lo.file_path, device_dp, &file_dp);
689 efi_free_pool(file_dp);
702 * device_is_present_and_system_part - check if a device exists
704 * Check if a device pointed to by the device path, @dp, exists and is
705 * located in UEFI system partition.
708 * Return: true - yes, false - no
710 static bool device_is_present_and_system_part(struct efi_device_path *dp)
713 struct efi_device_path *rem;
715 /* Check device exists */
716 handle = efi_dp_find_obj(dp, NULL, NULL);
720 /* Check device is on system partition */
721 handle = efi_dp_find_obj(dp, &efi_system_partition_guid, &rem);
729 * find_boot_device - identify the boot device
731 * Identify the boot device from boot-related variables as UEFI
732 * specification describes and put its handle into bootdev_root.
734 * Return: status code
736 static efi_status_t find_boot_device(void)
739 u16 boot_var16[9], *p, bootnext, *boot_order = NULL;
742 struct efi_simple_file_system_protocol *volume;
743 struct efi_device_path *boot_dev = NULL;
746 /* find active boot device in BootNext */
748 size = sizeof(bootnext);
749 ret = efi_get_variable_int(u"BootNext",
750 (efi_guid_t *)&efi_global_variable_guid,
751 NULL, &size, &bootnext, NULL);
752 if (ret == EFI_SUCCESS || ret == EFI_BUFFER_TOO_SMALL) {
753 /* BootNext does exist here */
754 if (ret == EFI_BUFFER_TOO_SMALL || size != sizeof(u16)) {
755 log_err("BootNext must be 16-bit integer\n");
758 sprintf((char *)boot_var, "Boot%04X", bootnext);
760 utf8_utf16_strcpy(&p, boot_var);
762 ret = get_dp_device(boot_var16, &boot_dev);
763 if (ret == EFI_SUCCESS) {
764 if (device_is_present_and_system_part(boot_dev)) {
767 efi_free_pool(boot_dev);
774 /* find active boot device in BootOrder */
776 ret = efi_get_variable_int(u"BootOrder", &efi_global_variable_guid,
777 NULL, &size, NULL, NULL);
778 if (ret == EFI_BUFFER_TOO_SMALL) {
779 boot_order = malloc(size);
781 ret = EFI_OUT_OF_RESOURCES;
785 ret = efi_get_variable_int(u"BootOrder",
786 &efi_global_variable_guid,
787 NULL, &size, boot_order, NULL);
789 if (ret != EFI_SUCCESS)
792 /* check in higher order */
793 num = size / sizeof(u16);
794 for (i = 0; i < num; i++) {
795 sprintf((char *)boot_var, "Boot%04X", boot_order[i]);
797 utf8_utf16_strcpy(&p, boot_var);
798 ret = get_dp_device(boot_var16, &boot_dev);
799 if (ret != EFI_SUCCESS)
802 if (device_is_present_and_system_part(boot_dev))
805 efi_free_pool(boot_dev);
810 log_debug("Boot device %pD\n", boot_dev);
812 volume = efi_fs_from_path(boot_dev);
814 ret = EFI_DEVICE_ERROR;
816 ret = EFI_CALL(volume->open_volume(volume,
818 efi_free_pool(boot_dev);
829 * efi_capsule_scan_dir - traverse a capsule directory in boot device
830 * @files: Array of file names
831 * @num: Number of elements in @files
833 * Traverse a capsule directory in boot device.
834 * Called by initialization code, and returns an array of capsule file
837 * Return: status code
839 static efi_status_t efi_capsule_scan_dir(u16 ***files, unsigned int *num)
841 struct efi_file_handle *dirh;
842 struct efi_file_info *dirent;
843 efi_uintn_t dirent_size, tmp_size;
848 ret = find_boot_device();
849 if (ret == EFI_NOT_FOUND) {
850 log_debug("Boot device is not set\n");
853 } else if (ret != EFI_SUCCESS) {
854 return EFI_DEVICE_ERROR;
857 /* count capsule files */
858 ret = EFI_CALL((*bootdev_root->open)(bootdev_root, &dirh,
860 EFI_FILE_MODE_READ, 0));
861 if (ret != EFI_SUCCESS) {
867 dirent = malloc(dirent_size);
869 return EFI_OUT_OF_RESOURCES;
873 tmp_size = dirent_size;
874 ret = EFI_CALL((*dirh->read)(dirh, &tmp_size, dirent));
875 if (ret == EFI_BUFFER_TOO_SMALL) {
876 struct efi_file_info *old_dirent = dirent;
878 dirent = realloc(dirent, tmp_size);
881 ret = EFI_OUT_OF_RESOURCES;
884 dirent_size = tmp_size;
885 ret = EFI_CALL((*dirh->read)(dirh, &tmp_size, dirent));
887 if (ret != EFI_SUCCESS)
892 if (!(dirent->attribute & EFI_FILE_DIRECTORY))
896 ret = EFI_CALL((*dirh->setpos)(dirh, 0));
897 if (ret != EFI_SUCCESS)
901 tmp_files = malloc(count * sizeof(*tmp_files));
903 ret = EFI_OUT_OF_RESOURCES;
909 tmp_size = dirent_size;
910 ret = EFI_CALL((*dirh->read)(dirh, &tmp_size, dirent));
911 if (ret != EFI_SUCCESS)
916 if (!(dirent->attribute & EFI_FILE_DIRECTORY) &&
917 u16_strcmp(dirent->file_name, u".") &&
918 u16_strcmp(dirent->file_name, u".."))
919 tmp_files[count++] = u16_strdup(dirent->file_name);
921 /* ignore an error */
922 EFI_CALL((*dirh->close)(dirh));
925 /* FIXME: u16 version of strcasecmp */
926 qsort(tmp_files, count, sizeof(*tmp_files),
927 (int (*)(const void *, const void *))strcasecmp);
938 * efi_capsule_read_file - read in a capsule file
939 * @filename: File name
940 * @capsule: Pointer to buffer for capsule
942 * Read a capsule file and put its content in @capsule.
944 * Return: status code
946 static efi_status_t efi_capsule_read_file(const u16 *filename,
947 struct efi_capsule_header **capsule)
949 struct efi_file_handle *dirh, *fh;
950 struct efi_file_info *file_info = NULL;
951 struct efi_capsule_header *buf = NULL;
955 ret = EFI_CALL((*bootdev_root->open)(bootdev_root, &dirh,
957 EFI_FILE_MODE_READ, 0));
958 if (ret != EFI_SUCCESS)
960 ret = EFI_CALL((*dirh->open)(dirh, &fh, (u16 *)filename,
961 EFI_FILE_MODE_READ, 0));
962 /* ignore an error */
963 EFI_CALL((*dirh->close)(dirh));
964 if (ret != EFI_SUCCESS)
969 ret = EFI_CALL((*fh->getinfo)(fh, &efi_file_info_guid,
971 if (ret == EFI_BUFFER_TOO_SMALL) {
972 file_info = malloc(size);
974 ret = EFI_OUT_OF_RESOURCES;
977 ret = EFI_CALL((*fh->getinfo)(fh, &efi_file_info_guid,
980 if (ret != EFI_SUCCESS)
982 size = file_info->file_size;
986 ret = EFI_OUT_OF_RESOURCES;
991 ret = EFI_CALL((*fh->read)(fh, &size, buf));
992 if (ret == EFI_SUCCESS) {
993 if (size >= buf->capsule_image_size) {
997 ret = EFI_INVALID_PARAMETER;
1003 EFI_CALL((*fh->close)(fh));
1009 * efi_capsule_delete_file - delete a capsule file
1010 * @filename: File name
1012 * Delete a capsule file from capsule directory.
1014 * Return: status code
1016 static efi_status_t efi_capsule_delete_file(const u16 *filename)
1018 struct efi_file_handle *dirh, *fh;
1021 ret = EFI_CALL((*bootdev_root->open)(bootdev_root, &dirh,
1023 EFI_FILE_MODE_READ, 0));
1024 if (ret != EFI_SUCCESS)
1026 ret = EFI_CALL((*dirh->open)(dirh, &fh, (u16 *)filename,
1027 EFI_FILE_MODE_READ, 0));
1028 /* ignore an error */
1029 EFI_CALL((*dirh->close)(dirh));
1031 if (ret == EFI_SUCCESS)
1032 ret = EFI_CALL((*fh->delete)(fh));
1038 * efi_capsule_scan_done - reset a scan help function
1040 * Reset a scan help function
1042 static void efi_capsule_scan_done(void)
1044 EFI_CALL((*bootdev_root->close)(bootdev_root));
1045 bootdev_root = NULL;
1049 * check_run_capsules() - check whether capsule update should run
1051 * The spec says OsIndications must be set in order to run the capsule update
1052 * on-disk. Since U-Boot doesn't support runtime SetVariable, allow capsules to
1053 * run explicitly if CONFIG_EFI_IGNORE_OSINDICATIONS is selected
1055 * Return: EFI_SUCCESS if update to run, EFI_NOT_FOUND otherwise
1057 static efi_status_t check_run_capsules(void)
1063 size = sizeof(os_indications);
1064 r = efi_get_variable_int(u"OsIndications", &efi_global_variable_guid,
1065 NULL, &size, &os_indications, NULL);
1066 if (r != EFI_SUCCESS || size != sizeof(os_indications))
1067 return EFI_NOT_FOUND;
1069 if (os_indications &
1070 EFI_OS_INDICATIONS_FILE_CAPSULE_DELIVERY_SUPPORTED) {
1072 ~EFI_OS_INDICATIONS_FILE_CAPSULE_DELIVERY_SUPPORTED;
1073 r = efi_set_variable_int(u"OsIndications",
1074 &efi_global_variable_guid,
1075 EFI_VARIABLE_NON_VOLATILE |
1076 EFI_VARIABLE_BOOTSERVICE_ACCESS |
1077 EFI_VARIABLE_RUNTIME_ACCESS,
1078 sizeof(os_indications),
1079 &os_indications, false);
1080 if (r != EFI_SUCCESS)
1081 log_err("Setting %ls failed\n", L"OsIndications");
1083 } else if (IS_ENABLED(CONFIG_EFI_IGNORE_OSINDICATIONS)) {
1086 return EFI_NOT_FOUND;
1091 * efi_launch_capsule - launch capsules
1093 * Launch all the capsules in system at boot time.
1094 * Called by efi init code
1096 * Return: status codde
1098 efi_status_t efi_launch_capsules(void)
1100 struct efi_capsule_header *capsule = NULL;
1102 unsigned int nfiles, index, i;
1105 if (check_run_capsules() != EFI_SUCCESS)
1108 index = get_last_capsule();
1111 * Find capsules on disk.
1112 * All the capsules are collected at the beginning because
1113 * capsule files will be removed instantly.
1117 ret = efi_capsule_scan_dir(&files, &nfiles);
1118 if (ret != EFI_SUCCESS)
1123 /* Launch capsules */
1124 for (i = 0, ++index; i < nfiles; i++, index++) {
1125 log_debug("Applying %ls\n", files[i]);
1128 ret = efi_capsule_read_file(files[i], &capsule);
1129 if (ret == EFI_SUCCESS) {
1130 ret = efi_capsule_update_firmware(capsule);
1131 if (ret != EFI_SUCCESS)
1132 log_err("Applying capsule %ls failed.\n",
1135 log_info("Applying capsule %ls succeeded.\n",
1138 /* create CapsuleXXXX */
1139 set_capsule_result(index, capsule, ret);
1143 log_err("Reading capsule %ls failed\n", files[i]);
1145 /* delete a capsule either in case of success or failure */
1146 ret = efi_capsule_delete_file(files[i]);
1147 if (ret != EFI_SUCCESS)
1148 log_err("Deleting capsule %ls failed\n",
1151 efi_capsule_scan_done();
1153 for (i = 0; i < nfiles; i++)
1158 * UEFI spec requires to reset system after complete processing capsule
1159 * update on the storage.
1161 log_info("Reboot after firmware update.\n");
1162 /* Cold reset is required for loading the new firmware. */
1163 sysreset_walk_halt(SYSRESET_COLD);
1165 /* not reach here */
1169 #endif /* CONFIG_EFI_CAPSULE_ON_DISK */