MdePkg: Update the comments of GetInformation function

Refer to Uefi spec 2.10 section 11.11.2, add a new retval
EFI_NOT_FOUND to EFI_ADAPTER_INFORMATION_PROTOCOL.GetInformation().
Reference: [mantis #1866] - GetInfo() of Adapter Information
Protocol should have a provision for IHV to return no data.

Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Zhiguang Liu <zhiguang.liu@intel.com>
Signed-off-by: Qingyu <qingyu.shang@intel.com>
Signed-off-by: Gahan Saraiya <gahan.saraiya@intel.com>
This commit is contained in:
Qingyu 2024-04-08 16:56:47 +08:00 committed by Liming Gao
parent 98f150a954
commit e25808f501
2 changed files with 8 additions and 2 deletions

View File

@ -140,7 +140,9 @@ typedef struct {
This function returns information of type InformationType from the adapter. This function returns information of type InformationType from the adapter.
If an adapter does not support the requested informational type, then If an adapter does not support the requested informational type, then
EFI_UNSUPPORTED is returned. EFI_UNSUPPORTED is returned. If an adapter does not contain Information for
the requested InformationType, it fills InformationBlockSize with 0 and
returns EFI_NOT_FOUND.
@param[in] This A pointer to the EFI_ADAPTER_INFORMATION_PROTOCOL instance. @param[in] This A pointer to the EFI_ADAPTER_INFORMATION_PROTOCOL instance.
@param[in] InformationType A pointer to an EFI_GUID that defines the contents of InformationBlock. @param[in] InformationType A pointer to an EFI_GUID that defines the contents of InformationBlock.
@ -150,6 +152,7 @@ typedef struct {
@retval EFI_SUCCESS The InformationType information was retrieved. @retval EFI_SUCCESS The InformationType information was retrieved.
@retval EFI_UNSUPPORTED The InformationType is not known. @retval EFI_UNSUPPORTED The InformationType is not known.
@retval EFI_NOT_FOUND Information is not available for the requested information type.
@retval EFI_DEVICE_ERROR The device reported an error. @retval EFI_DEVICE_ERROR The device reported an error.
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
@retval EFI_INVALID_PARAMETER This is NULL. @retval EFI_INVALID_PARAMETER This is NULL.

View File

@ -12,7 +12,9 @@
This function returns information of type InformationType from the adapter. This function returns information of type InformationType from the adapter.
If an adapter does not support the requested informational type, then If an adapter does not support the requested informational type, then
EFI_UNSUPPORTED is returned. EFI_UNSUPPORTED is returned. If an adapter does not contain Information for
the requested InformationType, it fills InformationBlockSize with 0 and
returns EFI_NOT_FOUND.
@param[in] This A pointer to the EFI_ADAPTER_INFORMATION_PROTOCOL instance. @param[in] This A pointer to the EFI_ADAPTER_INFORMATION_PROTOCOL instance.
@param[in] InformationType A pointer to an EFI_GUID that defines the contents of InformationBlock. @param[in] InformationType A pointer to an EFI_GUID that defines the contents of InformationBlock.
@ -22,6 +24,7 @@
@retval EFI_SUCCESS The InformationType information was retrieved. @retval EFI_SUCCESS The InformationType information was retrieved.
@retval EFI_UNSUPPORTED The InformationType is not known. @retval EFI_UNSUPPORTED The InformationType is not known.
@retval EFI_NOT_FOUND Information is not available for the requested information type.
@retval EFI_DEVICE_ERROR The device reported an error. @retval EFI_DEVICE_ERROR The device reported an error.
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
@retval EFI_INVALID_PARAMETER This is NULL. @retval EFI_INVALID_PARAMETER This is NULL.