Merge tag 'efi-2019-10-rc4-4' of https://gitlab.denx.de/u-boot/custodians/u-boot-efi
[oweals/u-boot.git] / lib / efi_loader / efi_disk.c
index 13fcc1b471c52e9a09cb378c82825676624b142f..9007a5f77f3d05950cf37e066c03f43ff1c295e7 100644 (file)
 #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;
 };
 
+/**
+ * efi_disk_reset() - reset block device
+ *
+ * This function implements the Reset service of the EFI_BLOCK_IO_PROTOCOL.
+ *
+ * As U-Boot's block devices do not have a reset function simply return
+ * EFI_SUCCESS.
+ *
+ * See the Unified Extensible Firmware Interface (UEFI) specification for
+ * details.
+ *
+ * @this:                      pointer to the BLOCK_IO_PROTOCOL
+ * @extended_verification:     extended verification
+ * Return:                     status code
+ */
 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);
+       return EFI_EXIT(EFI_SUCCESS);
 }
 
 enum efi_disk_direction {
@@ -65,12 +84,12 @@ 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=%llx blksz=%x dir=%d\n", __func__,
-             __LINE__, blocks, lba, blksz, direction);
+       EFI_PRINT("blocks=%x lba=%llx blksz=%x dir=%d\n",
+                 blocks, lba, blksz, direction);
 
        /* We only support full block access */
        if (buffer_size & (blksz - 1))
-               return EFI_DEVICE_ERROR;
+               return EFI_BAD_BUFFER_SIZE;
 
        if (direction == EFI_DISK_READ)
                n = blk_dread(desc, lba, blocks, buffer);
@@ -80,7 +99,7 @@ static efi_status_t efi_disk_rw_blocks(struct efi_block_io *this,
        /* We don't do interrupts, so check for timers cooperatively */
        efi_timer_check();
 
-       debug("EFI: %s:%d n=%lx blocks=%x\n", __func__, __LINE__, n, blocks);
+       EFI_PRINT("n=%lx blocks=%x\n", n, blocks);
 
        if (n != blocks)
                return EFI_DEVICE_ERROR;
@@ -95,6 +114,20 @@ static efi_status_t EFIAPI efi_disk_read_blocks(struct efi_block_io *this,
        void *real_buffer = buffer;
        efi_status_t r;
 
+       if (!this)
+               return EFI_INVALID_PARAMETER;
+       /* TODO: check for media changes */
+       if (media_id != this->media->media_id)
+               return EFI_MEDIA_CHANGED;
+       if (!this->media->media_present)
+               return EFI_NO_MEDIA;
+       /* media->io_align is a power of 2 */
+       if ((uintptr_t)buffer & (this->media->io_align - 1))
+               return EFI_INVALID_PARAMETER;
+       if (lba * this->media->block_size + buffer_size >
+           this->media->last_block * this->media->block_size)
+               return EFI_INVALID_PARAMETER;
+
 #ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
        if (buffer_size > EFI_LOADER_BOUNCE_BUFFER_SIZE) {
                r = efi_disk_read_blocks(this, media_id, lba,
@@ -130,6 +163,22 @@ static efi_status_t EFIAPI efi_disk_write_blocks(struct efi_block_io *this,
        void *real_buffer = buffer;
        efi_status_t r;
 
+       if (!this)
+               return EFI_INVALID_PARAMETER;
+       if (this->media->read_only)
+               return EFI_WRITE_PROTECTED;
+       /* TODO: check for media changes */
+       if (media_id != this->media->media_id)
+               return EFI_MEDIA_CHANGED;
+       if (!this->media->media_present)
+               return EFI_NO_MEDIA;
+       /* media->io_align is a power of 2 */
+       if ((uintptr_t)buffer & (this->media->io_align - 1))
+               return EFI_INVALID_PARAMETER;
+       if (lba * this->media->block_size + buffer_size >
+           this->media->last_block * this->media->block_size)
+               return EFI_INVALID_PARAMETER;
+
 #ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
        if (buffer_size > EFI_LOADER_BOUNCE_BUFFER_SIZE) {
                r = efi_disk_write_blocks(this, media_id, lba,
@@ -246,7 +295,7 @@ static efi_status_t efi_disk_add_dev(
                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) {
@@ -258,18 +307,18 @@ static efi_status_t 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)
                return ret;
-       ret = efi_add_protocol(diskobj->parent.handle, &efi_guid_device_path,
+       ret = efi_add_protocol(&diskobj->header, &efi_guid_device_path,
                               diskobj->dp);
        if (ret != EFI_SUCCESS)
                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)
@@ -284,6 +333,11 @@ static efi_status_t efi_disk_add_dev(
        /* Fill in EFI IO Media info (for read/write callbacks) */
        diskobj->media.removable_media = desc->removable;
        diskobj->media.media_present = 1;
+       /*
+        * MediaID is just an arbitrary counter.
+        * We have to change it if the medium is removed or changed.
+        */
+       diskobj->media.media_id = 1;
        diskobj->media.block_size = desc->blksz;
        diskobj->media.io_align = desc->blksz;
        diskobj->media.last_block = desc->lba - offset;
@@ -381,7 +435,7 @@ efi_status_t efi_disk_register(void)
 
                /* 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
@@ -426,9 +480,9 @@ efi_status_t efi_disk_register(void)
                        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