dany/u-boot-megous
1
0
Fork 0
mirror of https://xff.cz/git/u-boot/ synced 2025-09-02 09:12:08 +02:00
Code Issues Packages Projects Releases Wiki Activity

efi_loader: fix function descriptions in efi_disk.c

Browse Source 
Use Sphinx style for function descriptions.

Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
This commit is contained in:
Heinrich Schuchardt
2020-03-19 13:49:34 +01:00
parent f0b0f7fe0e
commit 47a9596354
1 changed files with 30 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
lib/efi_loader/efi_disk.c
View File

@@ -222,15 +222,17 @@ static const struct efi_block_io block_io_disk_template = {
.flush_blocks = &efi_disk_flush_blocks, .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 * 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 * part. The device part is used to find the handle on which the
* simple file system protocol is installed. * simple file system protocol is installed.
* *
* @full_path device path including device and file * @full_path: device path including device and file
* @return simple file system protocol * Return: simple file system protocol
*/ */
struct efi_simple_file_system_protocol * struct efi_simple_file_system_protocol *
efi_fs_from_path(struct efi_device_path *full_path) efi_fs_from_path(struct efi_device_path *full_path)
@@ -285,15 +287,15 @@ static int efi_fs_exists(struct blk_desc *desc, int part)
} }
/* /*
* Create a handle for a partition or disk * efi_disk_add_dev() - create a handle for a partition or disk
* *
* @parent parent handle * @parent: parent handle
* @dp_parent parent device path * @dp_parent: parent device path
* @if_typename interface name for block device * @if_typename: interface name for block device
* @desc internal block device * @desc: internal block device
* @dev_index device index for block device * @dev_index: device index for block device
* @offset offset into disk for simple partitions * @offset: offset into disk for simple partitions
* @return disk object * Return: disk object
*/ */
static efi_status_t efi_disk_add_dev( static efi_status_t efi_disk_add_dev(
efi_handle_t parent, efi_handle_t parent,
@@ -373,15 +375,17 @@ static efi_status_t efi_disk_add_dev(
return EFI_SUCCESS; return EFI_SUCCESS;
} }
/* /**
* Create handles and protocols for the partitions of a block device * efi_disk_create_partitions() - create handles and protocols for partitions
* *
* @parent handle of the parent disk * Create handles and protocols for the partitions of a block device.
* @blk_desc block device *
* @if_typename interface type * @parent: handle of the parent disk
* @diskid device number * @blk_desc: block device
* @pdevname device name * @if_typename: interface type
* @return number of partitions created * @diskid: device number
* @pdevname: device name
* Return: number of partitions created
*/ */
int efi_disk_create_partitions(efi_handle_t parent, struct blk_desc *desc, int efi_disk_create_partitions(efi_handle_t parent, struct blk_desc *desc,
const char *if_typename, int diskid, const char *if_typename, int diskid,
@@ -418,16 +422,20 @@ int efi_disk_create_partitions(efi_handle_t parent, struct blk_desc *desc,
return disks; return disks;
} }
/* /**
* efi_disk_register() - register block devices
*
* U-Boot doesn't have a list of all online disk devices. So when running our * 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 * EFI payload, we scan through all of the potentially available ones and
* store them in our object pool. * 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. * 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 * Consider converting the code to look up devices as needed. The EFI device
* could be a child of the UCLASS_BLK block device, perhaps. * 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) efi_status_t efi_disk_register(void)
{ {