From 920d2c23a160b14b13283944477bb9e164884274 Mon Sep 17 00:00:00 2001 From: lgao4 Date: Wed, 17 Jun 2009 08:46:49 +0000 Subject: Update header file comments. git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8583 6f19259b-4bc3-4df7-8a09-765794883524 --- IntelFrameworkPkg/ChangeLog.txt | 8 +++++ .../FrameworkInternalFormRepresentation.h | 23 +------------ .../Include/Protocol/FirmwareVolume.h | 40 +++++++++++++--------- .../Include/Protocol/SectionExtraction.h | 5 +-- 4 files changed, 35 insertions(+), 41 deletions(-) (limited to 'IntelFrameworkPkg') diff --git a/IntelFrameworkPkg/ChangeLog.txt b/IntelFrameworkPkg/ChangeLog.txt index 08d46ce..3044ada 100644 --- a/IntelFrameworkPkg/ChangeLog.txt +++ b/IntelFrameworkPkg/ChangeLog.txt @@ -68,3 +68,11 @@ EDK_5216: Non-Compatible: qwang12 Possible Impacts: 1) Modules that may reference this definitions need to be updated. +EDK_8583: Non-Compatible: lgao4 + Retire the following framework HII opcodes, which are not defined in FrameworkHii specification. + #define FRAMEWORK_EFI_IFR_TRUE_OP 0x27 + #define FRAMEWORK_EFI_IFR_FALSE_OP 0x28 + #define FRAMEWORK_EFI_IFR_GT_OP 0x29 + #define FRAMEWORK_EFI_IFR_GE_OP 0x2A + #define FRAMEWORK_EFI_IFR_OEM_DEFINED_OP 0x2B + \ No newline at end of file diff --git a/IntelFrameworkPkg/Include/Framework/FrameworkInternalFormRepresentation.h b/IntelFrameworkPkg/Include/Framework/FrameworkInternalFormRepresentation.h index 7f7512a..6ea3d39 100644 --- a/IntelFrameworkPkg/Include/Framework/FrameworkInternalFormRepresentation.h +++ b/IntelFrameworkPkg/Include/Framework/FrameworkInternalFormRepresentation.h @@ -62,12 +62,7 @@ #define FRAMEWORK_EFI_IFR_VARSTORE_OP 0x24 #define FRAMEWORK_EFI_IFR_VARSTORE_SELECT_OP 0x25 #define FRAMEWORK_EFI_IFR_VARSTORE_SELECT_PAIR_OP 0x26 -#define FRAMEWORK_EFI_IFR_TRUE_OP 0x27 -#define FRAMEWORK_EFI_IFR_FALSE_OP 0x28 -#define FRAMEWORK_EFI_IFR_GT_OP 0x29 -#define FRAMEWORK_EFI_IFR_GE_OP 0x2A -#define FRAMEWORK_EFI_IFR_OEM_DEFINED_OP 0x2B -#define FRAMEWORK_EFI_IFR_LAST_OPCODE FRAMEWORK_EFI_IFR_OEM_DEFINED_OP +#define FRAMEWORK_EFI_IFR_LAST_OPCODE FRAMEWORK_EFI_IFR_VARSTORE_SELECT_PAIR_OP #define FRAMEWORK_EFI_IFR_OEM_OP 0xFE #define FRAMEWORK_EFI_IFR_NV_ACCESS_COMMAND 0xFF @@ -378,22 +373,6 @@ typedef struct { UINT16 SecondaryVarId; // variable store ID, as referenced elsewhere in the form } FRAMEWORK_EFI_IFR_VARSTORE_SELECT_PAIR; -typedef struct { - FRAMEWORK_EFI_IFR_OP_HEADER Header; -} FRAMEWORK_EFI_IFR_TRUE; - -typedef struct { - FRAMEWORK_EFI_IFR_OP_HEADER Header; -} FRAMEWORK_EFI_IFR_FALSE; - -typedef struct { - FRAMEWORK_EFI_IFR_OP_HEADER Header; -} FRAMEWORK_EFI_IFR_GT; - -typedef struct { - FRAMEWORK_EFI_IFR_OP_HEADER Header; -} FRAMEWORK_EFI_IFR_GE; - // // Save defaults and restore defaults have same structure // diff --git a/IntelFrameworkPkg/Include/Protocol/FirmwareVolume.h b/IntelFrameworkPkg/Include/Protocol/FirmwareVolume.h index 98f2909..86bcc8c 100644 --- a/IntelFrameworkPkg/Include/Protocol/FirmwareVolume.h +++ b/IntelFrameworkPkg/Include/Protocol/FirmwareVolume.h @@ -188,12 +188,13 @@ EFI_STATUS required to complete the read @param AuthenticationStatus pointer to the authentication status of the data - @retval EFI_SUCCESS - @retval EFI_WARN_BUFFER_TOO_SMALL - @retval EFI_OUT_OF_RESOURCES - @retval EFI_NOT_FOUND - @retval EFI_DEVICE_ERROR - @retval EFI_ACCESS_DENIED + @retval EFI_SUCCESS The call completed successfully. + @retval EFI_WARN_BUFFER_TOO_SMALL The buffer is too small to contain the requested output. + The buffer is filled and the output is truncated. + @retval EFI_OUT_OF_RESOURCES An allocation failure occurred. + @retval EFI_NOT_FOUND Name was not found in the firmware volume. + @retval EFI_DEVICE_ERROR A hardware error occurred when attempting to access the firmware volume. + @retval EFI_ACCESS_DENIED The firmware volume is configured to disallow reads. **/ typedef @@ -232,13 +233,16 @@ typedef struct { element in the array indicates a file to write, and there are NumberOfFiles elements in the input array. - @retval EFI_SUCCESS - @retval EFI_OUT_OF_RESOURCES - @retval EFI_DEVICE_ERROR - @retval EFI_WRITE_PROTECTED - @retval EFI_NOT_FOUND - @retval EFI_INVALID_PARAMETER - + @retval EFI_SUCCESS The write completed successfully. + @retval EFI_OUT_OF_RESOURCES The firmware volume does not have enough free space to store file(s). + @retval EFI_DEVICE_ERROR A hardware error occurred when attempting to access the firmware volume. + @retval EFI_WRITE_PROTECTED The firmware volume is configured to disallow writes. + @retval EFI_NOT_FOUND A delete was requested, but the requested file was not + found in the firmware volume. + @retval EFI_INVALID_PARAMETER A delete was requested with a multiple file write. + An unsupported WritePolicy was requested. + An unknown file type was specified. + A file system specific error has occurred. **/ typedef EFI_STATUS @@ -261,10 +265,12 @@ EFI_STATUS @param Attributes pointer to Attributes of the file found @param Size pointer to Size in bytes of the file found - @retval EFI_SUCCESS - @retval EFI_NOT_FOUND - @retval EFI_DEVICE_ERROR - @retval EFI_ACCESS_DENIED + @retval EFI_SUCCESS The output parameters are filled with data obtained from + the first matching file that was found. + @retval EFI_NOT_FOUND No files of type FileType were found. + @retval EFI_DEVICE_ERROR A hardware error occurred when attempting to access + the firmware volume. + @retval EFI_ACCESS_DENIED The firmware volume is configured to disallow reads. **/ typedef diff --git a/IntelFrameworkPkg/Include/Protocol/SectionExtraction.h b/IntelFrameworkPkg/Include/Protocol/SectionExtraction.h index 18074ec..a20f0df 100644 --- a/IntelFrameworkPkg/Include/Protocol/SectionExtraction.h +++ b/IntelFrameworkPkg/Include/Protocol/SectionExtraction.h @@ -26,6 +26,7 @@ #define _SECTION_EXTRACTION_PROTOCOL_H_ #include +#include // // Protocol GUID definition @@ -101,8 +102,8 @@ EFI_STATUS @retval EFI_OUT_OF_RESOURCES The system has insufficient resources to process the request. @retval EFI_INVALID_PARAMETER The SectionStreamHandle does not exist. - @retval EFI_BUFFER_TOO_SMALL The size of the input buffer is insufficient to - contain the requested section. + @retval EFI_WARN_BUFFER_TOO_SMALL The size of the input buffer is insufficient to contain the requested + section. The input buffer is filled and section contents are truncated. **/ typedef -- cgit v1.1