1.For EFI_FIRMWARE_MANAGEMENT_PROTOCOL.GetImage():
Add the following sentence at the end of the Image parameter
description. "May be NULL with a zero ImageSize in order to determine
the size of the buffer needed".
Modify the description of "EFI_INVALID_PARAMETER" return code as "The
ImageSize is not too small and Image is NULL."
2.For EFI_FIRMWARE_MANAGEMENT_PROTOCOL.GetImageInfo():
Add the following sentence at the end of the ImageInfo parameter
description."May be NULL with a zero ImageInfoSize in order to
determine the size of the buffer needed".
Modify the description of "EFI_INVALID_PARAMETER" return code as "The
ImageInfoSize is not too small and Image is NULL." and add new
descriptions for "EFI_INVALID_PARAMETER" return code.
REF: UEFI spec v2.10 23.1.2
Cc: Michael D Kinney <michael.d.kin...@intel.com>
Cc: Liming Gao <gaolim...@byosoft.com.cn>
Cc: Zhiguang Liu <zhiguang....@intel.com>
Cc: Yi Li <yi1...@intel.com>
Cc: GuoX Xu <guox...@intel.com>
Signed-off-by: Pethaiyan Madhan <madhan.pethai...@intel.com>
---
.../SystemFirmwareUpdate/SystemFirmwareCommonDxe.c | 13 +++++++++++--
.../SystemFirmwareUpdate/SystemFirmwareDxe.h | 13 +++++++++++--
2 files changed, 22 insertions(+), 4 deletions(-)
diff --git
a/SignedCapsulePkg/Universal/SystemFirmwareUpdate/SystemFirmwareCommonDxe.c
b/SignedCapsulePkg/Universal/SystemFirmwareUpdate/SystemFirmwareCommonDxe.c
index 077bd0cb31..6e394d85d4 100644
--- a/SignedCapsulePkg/Universal/SystemFirmwareUpdate/SystemFirmwareCommonDxe.c
+++ b/SignedCapsulePkg/Universal/SystemFirmwareUpdate/SystemFirmwareCommonDxe.c
@@ -34,6 +34,8 @@ EFI_FIRMWARE_MANAGEMENT_PROTOCOL mFirmwareManagementProtocol
= {
to contain the image(s) information if
the buffer was too small.
@param[in, out] ImageInfo A pointer to the buffer in which firmware
places the current image(s)
information. The information is an array
of EFI_FIRMWARE_IMAGE_DESCRIPTORs.
+ May be NULL with a zero ImageInfoSize in
order to determine the size of the
+ buffer needed.
@param[out] DescriptorVersion A pointer to the location in which
firmware returns the version number
associated with the
EFI_FIRMWARE_IMAGE_DESCRIPTOR.
@param[out] DescriptorCount A pointer to the location in which
firmware returns the number of
@@ -54,7 +56,12 @@ EFI_FIRMWARE_MANAGEMENT_PROTOCOL
mFirmwareManagementProtocol = {
@retval EFI_SUCCESS The device was successfully updated with
the new image.
@retval EFI_BUFFER_TOO_SMALL The ImageInfo buffer was too small. The
current buffer size
needed to hold the image(s) information
is returned in ImageInfoSize.
- @retval EFI_INVALID_PARAMETER ImageInfoSize is NULL.
+ @retval EFI_INVALID_PARAMETER ImageInfoSize is not too small and
ImageInfo is NULL.
+ @retval EFI_INVALID_PARAMETER ImageInfoSize is non-zero and
DescriptorVersion is NULL.
+ @retval EFI_INVALID_PARAMETER ImageInfoSize is non-zero and
DescriptorCount is NULL.
+ @retval EFI_INVALID_PARAMETER ImageInfoSize is non-zero and
DescriptorSize is NULL.
+ @retval EFI_INVALID_PARAMETER ImageInfoSize is non-zero and
PackageVersion is NULL.
+ @retval EFI_INVALID_PARAMETER ImageInfoSize is non-zero and
PackageVersionName is NULL.
@retval EFI_DEVICE_ERROR Valid information could not be returned.
Possible corrupted image.
**/
@@ -153,6 +160,8 @@ FmpGetImageInfo (
@param[in] ImageIndex A unique number identifying the firmware
image(s) within the device.
The number is between 1 and DescriptorCount.
@param[in,out] Image Points to the buffer where the current image
is copied to.
+ May be NULL with a zero ImageSize in order to
determine the size of the
+ buffer needed.
@param[in,out] ImageSize On entry, points to the size of the buffer
pointed to by Image, in bytes.
On return, points to the length of the image,
in bytes.
@@ -160,7 +169,7 @@ FmpGetImageInfo (
@retval EFI_BUFFER_TOO_SMALL The buffer specified by ImageSize is too
small to hold the
image. The current buffer size needed to hold
the image is returned
in ImageSize.
- @retval EFI_INVALID_PARAMETER The Image was NULL.
+ @retval EFI_INVALID_PARAMETER The ImageSize is not too small and Image is
NULL
@retval EFI_NOT_FOUND The current image is not copied to the buffer.
@retval EFI_UNSUPPORTED The operation is not supported.
@retval EFI_SECURITY_VIOLATION The operation could not be performed due to
an authentication failure.
diff --git
a/SignedCapsulePkg/Universal/SystemFirmwareUpdate/SystemFirmwareDxe.h
b/SignedCapsulePkg/Universal/SystemFirmwareUpdate/SystemFirmwareDxe.h
index c8443865cb..b2b2c78318 100644
--- a/SignedCapsulePkg/Universal/SystemFirmwareUpdate/SystemFirmwareDxe.h
+++ b/SignedCapsulePkg/Universal/SystemFirmwareUpdate/SystemFirmwareDxe.h
@@ -137,6 +137,8 @@ typedef struct {
to contain the image(s) information if
the buffer was too small.
@param[in, out] ImageInfo A pointer to the buffer in which firmware
places the current image(s)
information. The information is an array
of EFI_FIRMWARE_IMAGE_DESCRIPTORs.
+ May be NULL with a zero ImageInfoSize in
order to determine the size of the
+ buffer needed.
@param[out] DescriptorVersion A pointer to the location in which
firmware returns the version number
associated with the
EFI_FIRMWARE_IMAGE_DESCRIPTOR.
@param[out] DescriptorCount A pointer to the location in which
firmware returns the number of
@@ -157,7 +159,12 @@ typedef struct {
@retval EFI_SUCCESS The device was successfully updated with
the new image.
@retval EFI_BUFFER_TOO_SMALL The ImageInfo buffer was too small. The
current buffer size
needed to hold the image(s) information
is returned in ImageInfoSize.
- @retval EFI_INVALID_PARAMETER ImageInfoSize is NULL.
+ @retval EFI_INVALID_PARAMETER ImageInfoSize is not too small and
ImageInfo is NULL.
+ @retval EFI_INVALID_PARAMETER ImageInfoSize is non-zero and
DescriptorVersion is NULL.
+ @retval EFI_INVALID_PARAMETER ImageInfoSize is non-zero and
DescriptorCount is NULL.
+ @retval EFI_INVALID_PARAMETER ImageInfoSize is non-zero and
DescriptorSize is NULL.
+ @retval EFI_INVALID_PARAMETER ImageInfoSize is non-zero and
PackageVersion is NULL.
+ @retval EFI_INVALID_PARAMETER ImageInfoSize is non-zero and
PackageVersionName is NULL.
@retval EFI_DEVICE_ERROR Valid information could not be returned.
Possible corrupted image.
**/
@@ -184,6 +191,8 @@ FmpGetImageInfo (
@param[in] ImageIndex A unique number identifying the firmware
image(s) within the device.
The number is between 1 and DescriptorCount.
@param[in,out] Image Points to the buffer where the current image
is copied to.
+ May be NULL with a zero ImageSize in order to
determine the size of the
+ buffer needed.
@param[in,out] ImageSize On entry, points to the size of the buffer
pointed to by Image, in bytes.
On return, points to the length of the image,
in bytes.
@@ -191,7 +200,7 @@ FmpGetImageInfo (
@retval EFI_BUFFER_TOO_SMALL The buffer specified by ImageSize is too
small to hold the
image. The current buffer size needed to hold
the image is returned
in ImageSize.
- @retval EFI_INVALID_PARAMETER The Image was NULL.
+ @retval EFI_INVALID_PARAMETER The ImageSize is not too small and Image is
NULL
@retval EFI_NOT_FOUND The current image is not copied to the buffer.
@retval EFI_UNSUPPORTED The operation is not supported.
@retval EFI_SECURITY_VIOLATION The operation could not be performed due to
an authentication failure.
--
2.38.1.windows.1
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#116039): https://edk2.groups.io/g/devel/message/116039
Mute This Topic: https://groups.io/mt/104601543/21656
Group Owner: devel+ow...@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [arch...@mail-archive.com]
-=-=-=-=-=-=-=-=-=-=-=-
