Merge tag 'efi-2020-01-rc2' of https://gitlab.denx.de/u-boot/custodians/u-boot-efi

[oweals/u-boot.git] / include / efi_driver.h

diff --git a/include/efi_driver.h b/include/efi_driver.h
index 2bbe26c6e31a002113b7e6ad04de9817417d5cea..840483a416a454155aad70b9515459e7d2cc3953 100644 (file)
--- a/include/efi_driver.h
+++ b/include/efi_driver.h
@@ -1,9 +1,8 @@
+/* SPDX-License-Identifier: GPL-2.0+ */
 /*
  *  EFI application loader
  *
  *  Copyright (c) 2017 Heinrich Schuchardt
- *
- *  SPDX-License-Identifier:     GPL-2.0+
  */
 
 #ifndef _EFI_DRIVER_H
@@ -13,6 +12,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;