efi_loader: add missing doc comments in efi_disk.c

Add missing descriptions for functions in efi_disk.c.

Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>

diff --git a/lib/efi_loader/efi_disk.c b/lib/efi_loader/efi_disk.c
index fc0682bc48ca5f2da348e1edf4376d674fb10f43..fd8fe175670989086f28343b607d2dcee8658683 100644 (file)
--- a/lib/efi_loader/efi_disk.c
+++ b/lib/efi_loader/efi_disk.c
@@ -108,6 +108,21 @@ static efi_status_t efi_disk_rw_blocks(struct efi_block_io *this,
        return EFI_SUCCESS;
 }
 
        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)
 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)


@@ -157,6 +172,22 @@ static efi_status_t EFIAPI efi_disk_read_blocks(struct efi_block_io *this,
        return EFI_EXIT(r);
 }
 
        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)
 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)


@@ -208,9 +239,22 @@ static efi_status_t EFIAPI efi_disk_write_blocks(struct efi_block_io *this,
        return EFI_EXIT(r);
 }
 
        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)
 {
 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);
 }
        EFI_ENTRY("%p", this);
        return EFI_EXIT(EFI_SUCCESS);
 }


@@ -286,7 +330,7 @@ static int efi_fs_exists(struct blk_desc *desc, int part)
        return 1;
 }
 
        return 1;
 }
 

-/*
+/**

  * efi_disk_add_dev() - create a handle for a partition or disk
  *
  * @parent:            parent handle
  * efi_disk_add_dev() - create a handle for a partition or disk
  *
  * @parent:            parent handle


@@ -295,6 +339,8 @@ static int efi_fs_exists(struct blk_desc *desc, int part)
  * @desc:              internal block device
  * @dev_index:         device index for block device
  * @offset:            offset into disk for simple partitions
  * @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(
  * Return:             disk object
  */
 static efi_status_t efi_disk_add_dev(


@@ -381,7 +427,7 @@ static efi_status_t efi_disk_add_dev(
  * Create handles and protocols for the partitions of a block device.
  *
  * @parent:            handle of the parent disk
  * Create handles and protocols for the partitions of a block device.
  *
  * @parent:            handle of the parent disk

- * @blk_desc:          block device
+ * @desc:              block device

  * @if_typename:       interface type
  * @diskid:            device number
  * @pdevname:          device name
  * @if_typename:       interface type
  * @diskid:            device number
  * @pdevname:          device name