tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update header file comments. 

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8583 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
lgao4 2009-06-17 08:46:49 +00:00
parent 39157531c8
commit 920d2c23a1
9 changed files with 56 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
IntelFrameworkModulePkg/Include/Library/GenericBdsLib.h
View File

@ -1,7 +1,10 @@
/** @file /** @file
Generic BDS library definition, include the data structure and function. Generic BDS library defines general interfaces for BDS driver including:
1) BDS boot policy interface;
2) BDS boot device connect interface;
3) BDS Misc interfaces for mainting boot variable, ouput string.
Copyright (c) 2004 - 2008, Intel Corporation. <BR> Copyright (c) 2004 - 2009, Intel Corporation. <BR>
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at

5
IntelFrameworkModulePkg/Include/Library/OemHookStatusCodeLib.h
View File

@ -1,7 +1,8 @@
/** @file /** @file
OEM hook status code library functions with no library constructor/destructor OEM hook status code library. Platform can implement an instance to
initialize the OEM devices to report status code information.
Copyright (c) 2006, Intel Corporation Copyright (c) 2006 - 2009, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at

17
IntelFrameworkModulePkg/Include/Library/PciIncompatibleDeviceSupportLib.h
View File

@ -1,7 +1,8 @@
/** @file /** @file
PCI Incompatible device support Libary. PCI Incompatible device support Libary. Platform can implement an
instance to support the incompatible PCI devices.
Copyright (c) 2006 - 2007, Intel Corporation Copyright (c) 2006 - 2009, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at
@ -74,8 +75,8 @@ typedef struct {
@param PciDeviceInfo A pointer to PCI device information. @param PciDeviceInfo A pointer to PCI device information.
@param Configuration Returned information. @param Configuration Returned information.
@retval returns EFI_SUCCESS if check incompatible device ok. @retval EFI_SUCCESS The incompatible device is supported.
Otherwise return EFI_UNSUPPORTED. @retval EFI_UNSUPPORTED The incompatible device is not supported.
**/ **/
RETURN_STATUS RETURN_STATUS
EFIAPI EFIAPI
@ -96,8 +97,8 @@ PciResourceUpdateCheck (
@param Offset The address within the PCI configuration space. @param Offset The address within the PCI configuration space.
@param Configuration Returned information. @param Configuration Returned information.
@retval returns EFI_SUCCESS if check incompatible device ok. @retval EFI_SUCCESS The incompatible device is supported.
Otherwise return EFI_UNSUPPORTED. @retval EFI_UNSUPPORTED The incompatible device is not supported.
**/ **/
RETURN_STATUS RETURN_STATUS
EFIAPI EFIAPI
@ -123,8 +124,8 @@ PciRegisterUpdateCheck (
@param AccessWidth Access width needs to check incompatibility. @param AccessWidth Access width needs to check incompatibility.
@param Configuration Returned information. @param Configuration Returned information.
@retval returns EFI_SUCCESS if check incompatible device ok. @retval EFI_SUCCESS The incompatible device is supported.
Otherwise return EFI_UNSUPPORTED. @retval EFI_UNSUPPORTED The incompatible device is not supported.
**/ **/
RETURN_STATUS RETURN_STATUS
EFIAPI EFIAPI

6
IntelFrameworkModulePkg/Include/Library/PlatformBdsLib.h
View File

@ -1,8 +1,8 @@
/** @file /** @file
Platform BDS library definition. Platform package can provide hook library Platform BDS library definition. Platform can implement an
instances to implement platform specific behavior. instances to support the platform specific behavior.
Copyright (c) 2008, Intel Corporation. <BR> Copyright (c) 2008 - 2009, Intel Corporation. <BR>
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at

2
IntelFrameworkModulePkg/Library/GenericBdsLib/GenericBdsLib.inf
View File

@ -107,7 +107,7 @@
gEfiUgaDrawProtocolGuid |PcdUgaConsumeSupport # PROTOCOL SOMETIMES_CONSUMES gEfiUgaDrawProtocolGuid |PcdUgaConsumeSupport # PROTOCOL SOMETIMES_CONSUMES
gEfiOEMBadgingProtocolGuid # PROTOCOL CONSUMES gEfiOEMBadgingProtocolGuid # PROTOCOL CONSUMES
gEfiHiiFontProtocolGuid # PROTOCOL CONSUMES gEfiHiiFontProtocolGuid # PROTOCOL CONSUMES
gEfiSecurityArchProtocolGuid gEfiSecurityArchProtocolGuid # PROTOCOL CONSUMES
[FeaturePcd.common] [FeaturePcd.common]
gEfiMdePkgTokenSpaceGuid.PcdUgaConsumeSupport gEfiMdePkgTokenSpaceGuid.PcdUgaConsumeSupport

8
IntelFrameworkPkg/ChangeLog.txt
View File

@ -68,3 +68,11 @@ EDK_5216: Non-Compatible: qwang12
Possible Impacts: Possible Impacts:
1) Modules that may reference this definitions need to be updated. 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

23
IntelFrameworkPkg/Include/Framework/FrameworkInternalFormRepresentation.h
View File

@ -62,12 +62,7 @@
#define FRAMEWORK_EFI_IFR_VARSTORE_OP 0x24 #define FRAMEWORK_EFI_IFR_VARSTORE_OP 0x24
#define FRAMEWORK_EFI_IFR_VARSTORE_SELECT_OP 0x25 #define FRAMEWORK_EFI_IFR_VARSTORE_SELECT_OP 0x25
#define FRAMEWORK_EFI_IFR_VARSTORE_SELECT_PAIR_OP 0x26 #define FRAMEWORK_EFI_IFR_VARSTORE_SELECT_PAIR_OP 0x26
#define FRAMEWORK_EFI_IFR_TRUE_OP 0x27 #define FRAMEWORK_EFI_IFR_LAST_OPCODE FRAMEWORK_EFI_IFR_VARSTORE_SELECT_PAIR_OP
#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_OEM_OP 0xFE #define FRAMEWORK_EFI_IFR_OEM_OP 0xFE
#define FRAMEWORK_EFI_IFR_NV_ACCESS_COMMAND 0xFF #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 UINT16 SecondaryVarId; // variable store ID, as referenced elsewhere in the form
} FRAMEWORK_EFI_IFR_VARSTORE_SELECT_PAIR; } 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 // Save defaults and restore defaults have same structure
// //

40
IntelFrameworkPkg/Include/Protocol/FirmwareVolume.h
View File

@ -188,12 +188,13 @@ EFI_STATUS
required to complete the read required to complete the read
@param AuthenticationStatus pointer to the authentication status of the data @param AuthenticationStatus pointer to the authentication status of the data
@retval EFI_SUCCESS @retval EFI_SUCCESS The call completed successfully.
@retval EFI_WARN_BUFFER_TOO_SMALL @retval EFI_WARN_BUFFER_TOO_SMALL The buffer is too small to contain the requested output.
@retval EFI_OUT_OF_RESOURCES The buffer is filled and the output is truncated.
@retval EFI_NOT_FOUND @retval EFI_OUT_OF_RESOURCES An allocation failure occurred.
@retval EFI_DEVICE_ERROR @retval EFI_NOT_FOUND Name was not found in the firmware volume.
@retval EFI_ACCESS_DENIED @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 typedef
@ -232,13 +233,16 @@ typedef struct {
element in the array indicates a file to write, and there are element in the array indicates a file to write, and there are
NumberOfFiles elements in the input array. NumberOfFiles elements in the input array.
@retval EFI_SUCCESS @retval EFI_SUCCESS The write completed successfully.
@retval EFI_OUT_OF_RESOURCES @retval EFI_OUT_OF_RESOURCES The firmware volume does not have enough free space to store file(s).
@retval EFI_DEVICE_ERROR @retval EFI_DEVICE_ERROR A hardware error occurred when attempting to access the firmware volume.
@retval EFI_WRITE_PROTECTED @retval EFI_WRITE_PROTECTED The firmware volume is configured to disallow writes.
@retval EFI_NOT_FOUND @retval EFI_NOT_FOUND A delete was requested, but the requested file was not
@retval EFI_INVALID_PARAMETER 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 typedef
EFI_STATUS EFI_STATUS
@ -261,10 +265,12 @@ EFI_STATUS
@param Attributes pointer to Attributes of the file found @param Attributes pointer to Attributes of the file found
@param Size pointer to Size in bytes of the file found @param Size pointer to Size in bytes of the file found
@retval EFI_SUCCESS @retval EFI_SUCCESS The output parameters are filled with data obtained from
@retval EFI_NOT_FOUND the first matching file that was found.
@retval EFI_DEVICE_ERROR @retval EFI_NOT_FOUND No files of type FileType were found.
@retval EFI_ACCESS_DENIED @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 typedef

5
IntelFrameworkPkg/Include/Protocol/SectionExtraction.h
View File

@ -26,6 +26,7 @@
#define _SECTION_EXTRACTION_PROTOCOL_H_ #define _SECTION_EXTRACTION_PROTOCOL_H_
#include <PiDxe.h> #include <PiDxe.h>
#include <Framework/FirmwareVolumeImageFormat.h>
// //
// Protocol GUID definition // Protocol GUID definition
@ -101,8 +102,8 @@ EFI_STATUS
@retval EFI_OUT_OF_RESOURCES The system has insufficient resources to process @retval EFI_OUT_OF_RESOURCES The system has insufficient resources to process
the request. the request.
@retval EFI_INVALID_PARAMETER The SectionStreamHandle does not exist. @retval EFI_INVALID_PARAMETER The SectionStreamHandle does not exist.
@retval EFI_BUFFER_TOO_SMALL The size of the input buffer is insufficient to @retval EFI_WARN_BUFFER_TOO_SMALL The size of the input buffer is insufficient to contain the requested
contain the requested section. section. The input buffer is filled and section contents are truncated.
**/ **/
typedef typedef