Skip to contentSkip to conversation

doc/efi: add firmware management protocol to the documentation

PATCH In review Vincent Stehlé 2 participants 4 messages May 25, 2022

lore
Share & tools
lore
#0 lore raw

PATCH 1/2 doc/efi: add firmware management protocol to the documentation

The firmware management protocol can be used to manage device firmware. U-Boot can be configured to provide an implementation.

Document the related functions in the API section.

Cc Heinrich Schuchardt <[email protected]>
---
 doc/api/efi.rst | 6 ++++++
 1 file changed, 6 insertions(+)
doc/api/efi.rst +6 -0
index cb2a1c897e6..2b96783828b 100644
@@ -166,6 +166,12 @@ Unicode Collation protocol
 .. kernel-doc:: lib/efi_loader/efi_unicode_collation.c
    :internal:
 
+Firmware management protocol
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. kernel-doc:: lib/efi_loader/efi_firmware.c
+   :internal:
+
 Unit testing
 ------------
 
Signature · 1 line
2.35.1
#1 lore raw

PATCH 2/2 efi: fix documentation warnings

This fixes the following warnings:

./lib/efi_loader/efi_firmware.c:283: warning: Function parameter or member 'package_version' not described in 'efi_firmware_fit_get_image_info' ./lib/efi_loader/efi_firmware.c:283: warning: Function parameter or member 'package_version_name' not described in 'efi_firmware_fit_get_image_info' ./lib/efi_loader/efi_firmware.c:369: warning: bad line: firmware image
./lib/efi_loader/efi_firmware.c:395: warning: Function parameter or member 'package_version' not described in 'efi_firmware_raw_get_image_info' ./lib/efi_loader/efi_firmware.c:395: warning: Function parameter or member 'package_version_name' not described in 'efi_firmware_raw_get_image_info'

Cc Heinrich Schuchardt <[email protected]>
---
 lib/efi_loader/efi_firmware.c | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)
lib/efi_loader/efi_firmware.c +5 -5
index 27953fe7699..fe4e084106d 100644
@@ -197,8 +197,8 @@ static efi_status_t efi_fill_image_desc_array(
  * @descriptor_version:		Pointer to version number
  * @descriptor_count:		Pointer to number of descriptors
  * @descriptor_size:		Pointer to descriptor size
- * package_version:		Package version
- * package_version_name:	Package version's name
+ * @package_version:		Package version
+ * @package_version_name:	Package version's name
  *
  * Return information bout the current firmware image in @image_info.
  * @image_info will consist of a number of descriptors.
@@ -296,15 +296,15 @@ const struct efi_firmware_management_protocol efi_fmp_fit = {
 
 /**
  * efi_firmware_raw_get_image_info - return information about the current
-				     firmware image
+ *				     firmware image
  * @this:			Protocol instance
  * @image_info_size:		Size of @image_info
  * @image_info:			Image information
  * @descriptor_version:		Pointer to version number
  * @descriptor_count:		Pointer to number of descriptors
  * @descriptor_size:		Pointer to descriptor size
- * package_version:		Package version
- * package_version_name:	Package version's name
+ * @package_version:		Package version
+ * @package_version_name:	Package version's name
  *
  * Return information bout the current firmware image in @image_info.
  * @image_info will consist of a number of descriptors.
Signature · 1 line
2.35.1
Reviewed-by on v1 2/2
#2 lore raw

Re: [PATCH 2/2] efi: fix documentation warnings

Quoted 10 lines · Vincent Stehlé

This fixes the following warnings:

./lib/efi_loader/efi_firmware.c:283: warning: Function parameter or member 'package_version' not described in 'efi_firmware_fit_get_image_info' ./lib/efi_loader/efi_firmware.c:283: warning: Function parameter or member 'package_version_name' not described in 'efi_firmware_fit_get_image_info' ./lib/efi_loader/efi_firmware.c:369: warning: bad line: firmware image
./lib/efi_loader/efi_firmware.c:395: warning: Function parameter or member 'package_version' not described in 'efi_firmware_raw_get_image_info' ./lib/efi_loader/efi_firmware.c:395: warning: Function parameter or member 'package_version_name' not described in 'efi_firmware_raw_get_image_info'

Cc Heinrich Schuchardt <[email protected]>

We don't want to see any build errors when bisecting. Therefore this match should be merged before patch 1/2.

Quoted 38 lines
---
  lib/efi_loader/efi_firmware.c | 10 +++++-----
  1 file changed, 5 insertions(+), 5 deletions(-)
lib/efi_loader/efi_firmware.c +5 -5
index 27953fe7699..fe4e084106d 100644
@@ -197,8 +197,8 @@ static efi_status_t efi_fill_image_desc_array(
   * @descriptor_version:		Pointer to version number
   * @descriptor_count:		Pointer to number of descriptors
   * @descriptor_size:		Pointer to descriptor size
- * package_version:		Package version
- * package_version_name:	Package version's name
+ * @package_version:		Package version
+ * @package_version_name:	Package version's name
   *
   * Return information bout the current firmware image in @image_info.
   * @image_info will consist of a number of descriptors.
@@ -296,15 +296,15 @@ const struct efi_firmware_management_protocol efi_fmp_fit = {
 
  /**
   * efi_firmware_raw_get_image_info - return information about the current
-				     firmware image
+ *				     firmware image
   * @this:			Protocol instance
   * @image_info_size:		Size of @image_info
   * @image_info:			Image information
   * @descriptor_version:		Pointer to version number
   * @descriptor_count:		Pointer to number of descriptors
   * @descriptor_size:		Pointer to descriptor size
- * package_version:		Package version
- * package_version_name:	Package version's name
+ * @package_version:		Package version
+ * @package_version_name:	Package version's name
   *
   * Return information bout the current firmware image in @image_info.
   * @image_info will consist of a number of descriptors.
Reviewed-by on v1 1/2
#3 lore raw
In reply to Vincent Stehlé
Quoted 7 lines · Vincent Stehlé

The firmware management protocol can be used to manage device firmware. U-Boot can be configured to provide an implementation.

Document the related functions in the API section.

Cc Heinrich Schuchardt <[email protected]>

When merging this patch should succeed 2/2 to avoid build failures.

Quoted 21 lines
---
  doc/api/efi.rst | 6 ++++++
  1 file changed, 6 insertions(+)
doc/api/efi.rst +6 -0
index cb2a1c897e6..2b96783828b 100644
@@ -166,6 +166,12 @@ Unicode Collation protocol
  .. kernel-doc:: lib/efi_loader/efi_unicode_collation.c
     :internal:
 
+Firmware management protocol
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. kernel-doc:: lib/efi_loader/efi_firmware.c
+   :internal:
+
  Unit testing
  ------------