efi_loader: fix comments for variable services
[oweals/u-boot.git] / lib / efi_loader / efi_disk.c
index ac39a65ee893e0af57eee18dd24b82d0847e043d..7a6b06821a477895354807722c6d0dd36c046c04 100644 (file)
@@ -1,41 +1,43 @@
+// SPDX-License-Identifier: GPL-2.0+
 /*
  *  EFI application disk support
  *
  *  Copyright (c) 2016 Alexander Graf
- *
- *  SPDX-License-Identifier:     GPL-2.0+
  */
 
 #include <common.h>
 #include <blk.h>
 #include <dm.h>
 #include <efi_loader.h>
-#include <inttypes.h>
 #include <part.h>
 #include <malloc.h>
 
-const efi_guid_t efi_block_io_guid = BLOCK_IO_GUID;
+const efi_guid_t efi_block_io_guid = EFI_BLOCK_IO_PROTOCOL_GUID;
 
+/**
+ * struct efi_disk_obj - EFI disk object
+ *
+ * @header:    EFI object header
+ * @ops:       EFI disk I/O protocol interface
+ * @ifname:    interface name for block device
+ * @dev_index: device index of block device
+ * @media:     block I/O media information
+ * @dp:                device path to the block device
+ * @part:      partition
+ * @volume:    simple file system protocol of the partition
+ * @offset:    offset into disk for simple partition
+ * @desc:      internal block device descriptor
+ */
 struct efi_disk_obj {
-       /* Generic EFI object parent class data */
-       struct efi_object parent;
-       /* EFI Interface callback struct for block I/O */
+       struct efi_object header;
        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 *dp;
-       /* partition # */
        unsigned int part;
-       /* handle to filesys proto (for partition objects) */
        struct efi_simple_file_system_protocol *volume;
-       /* Offset into disk for simple partitions */
        lbaint_t offset;
-       /* Internal block device */
        struct blk_desc *desc;
 };
 
@@ -67,7 +69,7 @@ static efi_status_t efi_disk_rw_blocks(struct efi_block_io *this,
        blocks = buffer_size / blksz;
        lba += diskobj->offset;
 
-       debug("EFI: %s:%d blocks=%x lba=%"PRIx64" blksz=%x dir=%d\n", __func__,
+       debug("EFI: %s:%d blocks=%x lba=%llx blksz=%x dir=%d\n", __func__,
              __LINE__, blocks, lba, blksz, direction);
 
        /* We only support full block access */
@@ -112,7 +114,7 @@ static efi_status_t EFIAPI efi_disk_read_blocks(struct efi_block_io *this,
        real_buffer = efi_bounce_buffer;
 #endif
 
-       EFI_ENTRY("%p, %x, %" PRIx64 ", %zx, %p", this, media_id, lba,
+       EFI_ENTRY("%p, %x, %llx, %zx, %p", this, media_id, lba,
                  buffer_size, buffer);
 
        r = efi_disk_rw_blocks(this, media_id, lba, buffer_size, real_buffer,
@@ -147,7 +149,7 @@ static efi_status_t EFIAPI efi_disk_write_blocks(struct efi_block_io *this,
        real_buffer = efi_bounce_buffer;
 #endif
 
-       EFI_ENTRY("%p, %x, %" PRIx64 ", %zx, %p", this, media_id, lba,
+       EFI_ENTRY("%p, %x, %llx, %zx, %p", this, media_id, lba,
                  buffer_size, buffer);
 
        /* Populate bounce buffer if necessary */
@@ -226,28 +228,29 @@ efi_fs_from_path(struct efi_device_path *full_path)
  * @offset     offset into disk for simple partitions
  * @return     disk object
  */
-static struct efi_disk_obj *efi_disk_add_dev(
+static efi_status_t efi_disk_add_dev(
                                efi_handle_t parent,
                                struct efi_device_path *dp_parent,
                                const char *if_typename,
                                struct blk_desc *desc,
                                int dev_index,
                                lbaint_t offset,
-                               unsigned int part)
+                               unsigned int part,
+                               struct efi_disk_obj **disk)
 {
        struct efi_disk_obj *diskobj;
        efi_status_t ret;
 
        /* Don't add empty devices */
        if (!desc->lba)
-               return NULL;
+               return EFI_NOT_READY;
 
        diskobj = calloc(1, sizeof(*diskobj));
        if (!diskobj)
-               goto out_of_memory;
+               return EFI_OUT_OF_RESOURCES;
 
        /* Hook up to the device list */
-       efi_add_handle(&diskobj->parent);
+       efi_add_handle(&diskobj->header);
 
        /* Fill in object data */
        if (part) {
@@ -259,22 +262,22 @@ static struct efi_disk_obj *efi_disk_add_dev(
                diskobj->dp = efi_dp_from_part(desc, part);
        }
        diskobj->part = part;
-       ret = efi_add_protocol(diskobj->parent.handle, &efi_block_io_guid,
+       ret = efi_add_protocol(&diskobj->header, &efi_block_io_guid,
                               &diskobj->ops);
        if (ret != EFI_SUCCESS)
-               goto out_of_memory;
-       ret = efi_add_protocol(diskobj->parent.handle, &efi_guid_device_path,
+               return ret;
+       ret = efi_add_protocol(&diskobj->header, &efi_guid_device_path,
                               diskobj->dp);
        if (ret != EFI_SUCCESS)
-               goto out_of_memory;
+               return ret;
        if (part >= 1) {
                diskobj->volume = efi_simple_file_system(desc, part,
                                                         diskobj->dp);
-               ret = efi_add_protocol(diskobj->parent.handle,
+               ret = efi_add_protocol(&diskobj->header,
                                       &efi_simple_file_system_protocol_guid,
                                       diskobj->volume);
                if (ret != EFI_SUCCESS)
-                       goto out_of_memory;
+                       return ret;
        }
        diskobj->ops = block_io_disk_template;
        diskobj->ifname = if_typename;
@@ -291,10 +294,9 @@ static struct efi_disk_obj *efi_disk_add_dev(
        if (part != 0)
                diskobj->media.logical_partition = 1;
        diskobj->ops.media = &diskobj->media;
-       return diskobj;
-out_of_memory:
-       printf("ERROR: Out of memory\n");
-       return NULL;
+       if (disk)
+               *disk = diskobj;
+       return EFI_SUCCESS;
 }
 
 /*
@@ -330,8 +332,12 @@ int efi_disk_create_partitions(efi_handle_t parent, struct blk_desc *desc,
                        continue;
                snprintf(devname, sizeof(devname), "%s:%d", pdevname,
                         part);
-               efi_disk_add_dev(parent, dp, if_typename, desc, diskid,
-                                info.start, part);
+               ret = efi_disk_add_dev(parent, dp, if_typename, desc, diskid,
+                                      info.start, part, NULL);
+               if (ret != EFI_SUCCESS) {
+                       printf("Adding partition %s failed\n", pdevname);
+                       continue;
+               }
                disks++;
        }
 
@@ -349,31 +355,37 @@ int efi_disk_create_partitions(efi_handle_t parent, struct blk_desc *desc,
  *
  * This gets called from do_bootefi_exec().
  */
-int efi_disk_register(void)
+efi_status_t efi_disk_register(void)
 {
        struct efi_disk_obj *disk;
        int disks = 0;
+       efi_status_t ret;
 #ifdef CONFIG_BLK
        struct udevice *dev;
 
-       for (uclass_first_device_check(UCLASS_BLK, &dev);
-            dev;
+       for (uclass_first_device_check(UCLASS_BLK, &dev); dev;
             uclass_next_device_check(&dev)) {
                struct blk_desc *desc = dev_get_uclass_platdata(dev);
                const char *if_typename = blk_get_if_type_name(desc->if_type);
 
-               printf("Scanning disk %s...\n", dev->name);
-
                /* Add block device for the full device */
-               disk = efi_disk_add_dev(NULL, NULL, if_typename,
-                                       desc, desc->devnum, 0, 0);
-               if (!disk)
-                       return -ENOMEM;
+               printf("Scanning disk %s...\n", dev->name);
+               ret = efi_disk_add_dev(NULL, NULL, if_typename,
+                                       desc, desc->devnum, 0, 0, &disk);
+               if (ret == EFI_NOT_READY) {
+                       printf("Disk %s not ready\n", dev->name);
+                       continue;
+               }
+               if (ret) {
+                       printf("ERROR: failure to add disk device %s, r = %lu\n",
+                              dev->name, ret & ~EFI_ERROR_MASK);
+                       return ret;
+               }
                disks++;
 
                /* Partitions show up as block devices in EFI */
                disks += efi_disk_create_partitions(
-                                       disk->parent.handle, desc, if_typename,
+                                       &disk->header, desc, if_typename,
                                        desc->devnum, dev->name);
        }
 #else
@@ -404,20 +416,27 @@ int efi_disk_register(void)
                                 if_typename, i);
 
                        /* Add block device for the full device */
-                       disk = efi_disk_add_dev(NULL, NULL, if_typename, desc,
-                                               i, 0, 0);
-                       if (!disk)
-                               return -ENOMEM;
+                       ret = efi_disk_add_dev(NULL, NULL, if_typename, desc,
+                                              i, 0, 0, &disk);
+                       if (ret == EFI_NOT_READY) {
+                               printf("Disk %s not ready\n", devname);
+                               continue;
+                       }
+                       if (ret) {
+                               printf("ERROR: failure to add disk device %s, r = %lu\n",
+                                      devname, ret & ~EFI_ERROR_MASK);
+                               return ret;
+                       }
                        disks++;
 
                        /* Partitions show up as block devices in EFI */
-                       disks += efi_disk_create_partitions(
-                                               disk->parent.handle, desc,
-                                               if_typename, i, devname);
+                       disks += efi_disk_create_partitions
+                                               (&disk->header, desc,
+                                                if_typename, i, devname);
                }
        }
 #endif
        printf("Found %d disks\n", disks);
 
-       return 0;
+       return EFI_SUCCESS;
 }