efi_loader: comments EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
[oweals/u-boot.git] / lib / efi_loader / efi_disk.c
index 7a6b06821a477895354807722c6d0dd36c046c04..670bf2b8ef0185961662d14db1a0a1fc3d51c0c7 100644 (file)
@@ -9,9 +9,12 @@
 #include <blk.h>
 #include <dm.h>
 #include <efi_loader.h>
+#include <fs.h>
 #include <part.h>
 #include <malloc.h>
 
+struct efi_system_partition efi_system_partition;
+
 const efi_guid_t efi_block_io_guid = EFI_BLOCK_IO_PROTOCOL_GUID;
 
 /**
@@ -41,11 +44,26 @@ struct efi_disk_obj {
        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 {
@@ -69,12 +87,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);
@@ -84,7 +102,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;
@@ -92,6 +110,21 @@ static efi_status_t efi_disk_rw_blocks(struct efi_block_io *this,
        return EFI_SUCCESS;
 }
 
+/**
+ * efi_disk_read_blocks() - reads blocks from device
+ *
+ * This function implements the ReadBlocks service of the EFI_BLOCK_IO_PROTOCOL.
+ *
+ * See the Unified Extensible Firmware Interface (UEFI) specification for
+ * details.
+ *
+ * @this:                      pointer to the BLOCK_IO_PROTOCOL
+ * @media_id:                  id of the medium to be read from
+ * @lba:                       starting logical block for reading
+ * @buffer_size:               size of the read buffer
+ * @buffer:                    pointer to the destination buffer
+ * Return:                     status code
+ */
 static efi_status_t EFIAPI efi_disk_read_blocks(struct efi_block_io *this,
                        u32 media_id, u64 lba, efi_uintn_t buffer_size,
                        void *buffer)
@@ -99,6 +132,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,
@@ -127,6 +174,22 @@ static efi_status_t EFIAPI efi_disk_read_blocks(struct efi_block_io *this,
        return EFI_EXIT(r);
 }
 
+/**
+ * efi_disk_write_blocks() - writes blocks to device
+ *
+ * This function implements the WriteBlocks service of the
+ * EFI_BLOCK_IO_PROTOCOL.
+ *
+ * See the Unified Extensible Firmware Interface (UEFI) specification for
+ * details.
+ *
+ * @this:                      pointer to the BLOCK_IO_PROTOCOL
+ * @media_id:                  id of the medium to be written to
+ * @lba:                       starting logical block for writing
+ * @buffer_size:               size of the write buffer
+ * @buffer:                    pointer to the source buffer
+ * Return:                     status code
+ */
 static efi_status_t EFIAPI efi_disk_write_blocks(struct efi_block_io *this,
                        u32 media_id, u64 lba, efi_uintn_t buffer_size,
                        void *buffer)
@@ -134,6 +197,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,
@@ -162,9 +241,22 @@ static efi_status_t EFIAPI efi_disk_write_blocks(struct efi_block_io *this,
        return EFI_EXIT(r);
 }
 
+/**
+ * efi_disk_flush_blocks() - flushes modified data to the device
+ *
+ * This function implements the FlushBlocks service of the
+ * EFI_BLOCK_IO_PROTOCOL.
+ *
+ * As we always write synchronously nothing is done here.
+ *
+ * See the Unified Extensible Firmware Interface (UEFI) specification for
+ * details.
+ *
+ * @this:                      pointer to the BLOCK_IO_PROTOCOL
+ * Return:                     status code
+ */
 static efi_status_t EFIAPI efi_disk_flush_blocks(struct efi_block_io *this)
 {
-       /* We always write synchronously */
        EFI_ENTRY("%p", this);
        return EFI_EXIT(EFI_SUCCESS);
 }
@@ -176,15 +268,17 @@ static const struct efi_block_io block_io_disk_template = {
        .flush_blocks = &efi_disk_flush_blocks,
 };
 
-/*
- * Get the simple file system protocol for a file device path.
+/**
+ * efi_fs_from_path() - retrieve simple file system protocol
+ *
+ * Gets the simple file system protocol for a file device path.
  *
  * The full path provided is split into device part and into a file
  * part. The device part is used to find the handle on which the
  * simple file system protocol is installed.
  *
- * @full_path  device path including device and file
- * @return     simple file system protocol
+ * @full_path: device path including device and file
+ * Return:     simple file system protocol
  */
 struct efi_simple_file_system_protocol *
 efi_fs_from_path(struct efi_device_path *full_path)
@@ -217,16 +311,39 @@ efi_fs_from_path(struct efi_device_path *full_path)
        return handler->protocol_interface;
 }
 
-/*
- * Create a handle for a partition or disk
+/**
+ * efi_fs_exists() - check if a partition bears a file system
+ *
+ * @desc:      block device descriptor
+ * @part:      partition number
+ * Return:     1 if a file system exists on the partition
+ *             0 otherwise
+ */
+static int efi_fs_exists(struct blk_desc *desc, int part)
+{
+       if (fs_set_blk_dev_with_part(desc, part))
+               return 0;
+
+       if (fs_get_type() == FS_TYPE_ANY)
+               return 0;
+
+       fs_close();
+
+       return 1;
+}
+
+/**
+ * efi_disk_add_dev() - create a handle for a partition or disk
  *
- * @parent     parent handle
- * @dp_parent  parent device path
- * @if_typename interface name for block device
- * @desc       internal block device
- * @dev_index   device index for block device
- * @offset     offset into disk for simple partitions
- * @return     disk object
+ * @parent:            parent handle
+ * @dp_parent:         parent device path
+ * @if_typename:       interface name for block device
+ * @desc:              internal block device
+ * @dev_index:         device index for block device
+ * @offset:            offset into disk for simple partitions
+ * @part:              partition
+ * @disk:              pointer to receive the created handle
+ * Return:             disk object
  */
 static efi_status_t efi_disk_add_dev(
                                efi_handle_t parent,
@@ -239,6 +356,7 @@ static efi_status_t efi_disk_add_dev(
                                struct efi_disk_obj **disk)
 {
        struct efi_disk_obj *diskobj;
+       struct efi_object *handle;
        efi_status_t ret;
 
        /* Don't add empty devices */
@@ -262,15 +380,27 @@ static efi_status_t efi_disk_add_dev(
                diskobj->dp = efi_dp_from_part(desc, part);
        }
        diskobj->part = part;
-       ret = efi_add_protocol(&diskobj->header, &efi_block_io_guid,
-                              &diskobj->ops);
-       if (ret != EFI_SUCCESS)
-               return ret;
-       ret = efi_add_protocol(&diskobj->header, &efi_guid_device_path,
-                              diskobj->dp);
+
+       /*
+        * Install the device path and the block IO protocol.
+        *
+        * InstallMultipleProtocolInterfaces() checks if the device path is
+        * already installed on an other handle and returns EFI_ALREADY_STARTED
+        * in this case.
+        */
+       handle = &diskobj->header;
+       ret = EFI_CALL(efi_install_multiple_protocol_interfaces(
+                       &handle, &efi_guid_device_path, diskobj->dp,
+                       &efi_block_io_guid, &diskobj->ops, NULL));
        if (ret != EFI_SUCCESS)
                return ret;
-       if (part >= 1) {
+
+       /*
+        * On partitions or whole disks without partitions install the
+        * simple file system protocol if a file system is available.
+        */
+       if ((part || desc->part_type == PART_TYPE_UNKNOWN) &&
+           efi_fs_exists(desc, part)) {
                diskobj->volume = efi_simple_file_system(desc, part,
                                                         diskobj->dp);
                ret = efi_add_protocol(&diskobj->header,
@@ -288,26 +418,51 @@ 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;
-       if (part != 0)
+       if (part)
                diskobj->media.logical_partition = 1;
        diskobj->ops.media = &diskobj->media;
        if (disk)
                *disk = diskobj;
+
+       /* Store first EFI system partition */
+       if (part && !efi_system_partition.if_type) {
+               int r;
+               struct disk_partition info;
+
+               r = part_get_info(desc, part, &info);
+               if (r)
+                       return EFI_DEVICE_ERROR;
+               if (info.bootable & PART_EFI_SYSTEM_PARTITION) {
+                       efi_system_partition.if_type = desc->if_type;
+                       efi_system_partition.devnum = desc->devnum;
+                       efi_system_partition.part = part;
+                       EFI_PRINT("EFI system partition: %s %d:%d\n",
+                                 blk_get_if_type_name(desc->if_type),
+                                 desc->devnum, part);
+               }
+       }
        return EFI_SUCCESS;
 }
 
-/*
- * Create handles and protocols for the partitions of a block device
+/**
+ * efi_disk_create_partitions() - create handles and protocols for partitions
+ *
+ * Create handles and protocols for the partitions of a block device.
  *
- * @parent             handle of the parent disk
- * @blk_desc           block device
- * @if_typename                interface type
- * @diskid             device number
- * @pdevname           device name
- * @return             number of partitions created
+ * @parent:            handle of the parent disk
+ * @desc:              block device
+ * @if_typename:       interface type
+ * @diskid:            device number
+ * @pdevname:          device name
+ * Return:             number of partitions created
  */
 int efi_disk_create_partitions(efi_handle_t parent, struct blk_desc *desc,
                               const char *if_typename, int diskid,
@@ -315,7 +470,7 @@ int efi_disk_create_partitions(efi_handle_t parent, struct blk_desc *desc,
 {
        int disks = 0;
        char devname[32] = { 0 }; /* dp->str is u16[32] long */
-       disk_partition_t info;
+       struct disk_partition info;
        int part;
        struct efi_device_path *dp = NULL;
        efi_status_t ret;
@@ -344,16 +499,20 @@ int efi_disk_create_partitions(efi_handle_t parent, struct blk_desc *desc,
        return disks;
 }
 
-/*
+/**
+ * efi_disk_register() - register block devices
+ *
  * U-Boot doesn't have a list of all online disk devices. So when running our
  * EFI payload, we scan through all of the potentially available ones and
  * store them in our object pool.
  *
+ * This function is called in efi_init_obj_list().
+ *
  * TODO(sjg@chromium.org): Actually with CONFIG_BLK, U-Boot does have this.
  * Consider converting the code to look up devices as needed. The EFI device
  * could be a child of the UCLASS_BLK block device, perhaps.
  *
- * This gets called from do_bootefi_exec().
+ * Return:     status code
  */
 efi_status_t efi_disk_register(void)
 {
@@ -440,3 +599,32 @@ efi_status_t efi_disk_register(void)
 
        return EFI_SUCCESS;
 }
+
+/**
+ * efi_disk_is_system_part() - check if handle refers to an EFI system partition
+ *
+ * @handle:    handle of partition
+ *
+ * Return:     true if handle refers to an EFI system partition
+ */
+bool efi_disk_is_system_part(efi_handle_t handle)
+{
+       struct efi_handler *handler;
+       struct efi_disk_obj *diskobj;
+       struct disk_partition info;
+       efi_status_t ret;
+       int r;
+
+       /* check if this is a block device */
+       ret = efi_search_protocol(handle, &efi_block_io_guid, &handler);
+       if (ret != EFI_SUCCESS)
+               return false;
+
+       diskobj = container_of(handle, struct efi_disk_obj, header);
+
+       r = part_get_info(diskobj->desc, diskobj->part, &info);
+       if (r)
+               return false;
+
+       return !!(info.bootable & PART_EFI_SYSTEM_PARTITION);
+}