[U-Boot,1/1,for,v2018.03] efi_driver: comment struct efi_driver_ops

Message ID 20180212115528.12691-1-xypron.glpk@gmx.de
State Accepted
Delegated to: Tom Rini
Headers show
Series
  • [U-Boot,1/1,for,v2018.03] efi_driver: comment struct efi_driver_ops
Related show

Commit Message

Heinrich Schuchardt Feb. 12, 2018, 11:55 a.m.
Provide description for struct efi_driver_ops.

Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
---
 include/efi_driver.h | 12 ++++++++++++
 1 file changed, 12 insertions(+)

Comments

Tom Rini Feb. 14, 2018, 4:43 p.m. | #1
On Mon, Feb 12, 2018 at 12:55:28PM +0100, Heinrich Schuchardt wrote:

> Provide description for struct efi_driver_ops.
> 
> Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>

Applied to u-boot/master, thanks!

Patch

diff --git a/include/efi_driver.h b/include/efi_driver.h
index 2bbe26c6e31..010e55a4739 100644
--- a/include/efi_driver.h
+++ b/include/efi_driver.h
@@ -13,6 +13,18 @@ 
 #include <dm.h>
 #include <efi_loader.h>
 
+/*
+ * Operations supported by an EFI driver with respect to the EFI uclass
+ *
+ * @protocol		The GUID of the protocol which is consumed by the
+ *			driver. This GUID is used by the EFI uclass in the
+ *			supports() and start() methods of the
+ *			EFI_DRIVER_BINDING_PROTOCOL.
+ * @child_protocol	Protocol supported by the child handles generated by
+ *			the EFI driver.
+ * @bind		Function called by the EFI uclass to attach the
+ *			driver to EFI driver to a handle.
+ */
 struct efi_driver_ops {
 	const efi_guid_t *protocol;
 	const efi_guid_t *child_protocol;