doc: documentation of EFI driver binding protocol

* Convert code comments in include/efi_driver.h to Sphinx style.
* Add include/efi_driver.h to the HTML documentation.

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
Reviewed-by: Ilias Apalodimas <ilias.apalodimas@linaro.org>

diff --git a/doc/api/efi.rst b/doc/api/efi.rst
index 2b96783828bb0ad2081bf3aca1de0b9299abc127..43d6f936fb001db994dcd4eac60f85557cd8330e 100644 (file)
--- a/doc/api/efi.rst
+++ b/doc/api/efi.rst
@@ -172,6 +172,12 @@ Firmware management protocol
 .. kernel-doc:: lib/efi_loader/efi_firmware.c
    :internal:
 
+Driver binding protocol
+~~~~~~~~~~~~~~~~~~~~~~~
+
+.. kernel-doc:: include/efi_driver.h
+   :internal:
+
 Unit testing
 ------------
 

diff --git a/include/efi_driver.h b/include/efi_driver.h
index dc0c1c7ac07f32119067b50975fbca80fc907c0e..de38abe83bd400b22f19521b17ccc4fb3044e305 100644 (file)
--- a/include/efi_driver.h
+++ b/include/efi_driver.h
@@ -1,6 +1,6 @@
 /* SPDX-License-Identifier: GPL-2.0+ */
 /*
- *  EFI application loader
+ *  Internal structures for the EFI driver binding protocol
  *
  *  Copyright (c) 2017 Heinrich Schuchardt
  */
@@ -10,16 +10,16 @@
 
 #include <efi_loader.h>
 
-/*
- * Operations supported by an EFI driver with respect to the EFI uclass
+/**
+ * struct efi_driver_ops - operations support by an EFI driver
  *
- * @protocol           The GUID of the protocol which is consumed by the
+ * @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
+ * @child_protocol:    Protocol supported by the child handles generated by
  *                     the EFI driver.
- * @bind               Function called by the EFI uclass to attach the
+ * @bind:              Function called by the EFI uclass to attach the
  *                     driver to EFI driver to a handle.
  */
 struct efi_driver_ops {
@@ -28,8 +28,13 @@ struct efi_driver_ops {
        efi_status_t (*bind)(efi_handle_t handle, void *interface);
 };
 
-/*
+/**
+ * struct efi_driver_binding_extended_protocol - extended driver binding protocol
+ *
  * This structure adds internal fields to the driver binding protocol.
+ *
+ * @bp:                driver binding protocol
+ * @ops:       operations supported by the driver
  */
 struct efi_driver_binding_extended_protocol {
        struct efi_driver_binding_protocol bp;