leandrof/u-boot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: documentation of EFI driver binding protocol

Browse Source 
* 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>
This commit is contained in:
Heinrich Schuchardt 2022-10-04 18:28:24 +02:00
parent a6d4f704ad
commit df31fedd39
2 changed files with 18 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/api/efi.rst
View File

@ -172,6 +172,12 @@ Firmware management protocol
.. kernel-doc:: lib/efi_loader/efi_firmware.c .. kernel-doc:: lib/efi_loader/efi_firmware.c
:internal: :internal:
Driver binding protocol
~~~~~~~~~~~~~~~~~~~~~~~
.. kernel-doc:: include/efi_driver.h
:internal:
Unit testing Unit testing
------------ ------------

19
include/efi_driver.h
View File

@ -1,6 +1,6 @@
/* SPDX-License-Identifier: GPL-2.0+ */ /* SPDX-License-Identifier: GPL-2.0+ */
/* /*
* EFI application loader * Internal structures for the EFI driver binding protocol
* *
* Copyright (c) 2017 Heinrich Schuchardt * Copyright (c) 2017 Heinrich Schuchardt
*/ */
@ -10,16 +10,16 @@
#include <efi_loader.h> #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 * driver. This GUID is used by the EFI uclass in the
* supports() and start() methods of the * supports() and start() methods of the
* EFI_DRIVER_BINDING_PROTOCOL. * 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. * 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. * driver to EFI driver to a handle.
*/ */
struct efi_driver_ops { struct efi_driver_ops {
@ -28,8 +28,13 @@ struct efi_driver_ops {
efi_status_t (*bind)(efi_handle_t handle, void *interface); 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. * 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_extended_protocol {
struct efi_driver_binding_protocol bp; struct efi_driver_binding_protocol bp;