Correct typo in comments, clean IfrSupportLib.h

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@7494 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
lgao4 2009-02-10 13:32:19 +00:00
parent 9e5acfd583
commit b998288321
25 changed files with 99 additions and 112 deletions

View File

@ -1,6 +1,6 @@
/** @file
This file defines capsule vendor guid for capsule variable and hob.
It also defines capsule varialbe name and capsule guid hob data structure,
It also defines capsule variable name and capsule guid hob data structure,
which can be used to store the capsule image start address and length.
They are used by EDKII implementation of capsule update across a system reset.

View File

@ -1,7 +1,7 @@
/** @file
This file defines the memory type information guid for its variable and guid.
It also defines memory type info varialbe name and data structure for varialbe and hob both,
which can be used to store the information for each memory type in EFI varialbe or HOB.
It also defines memory type info variable name and data structure for variable and hob both,
which can be used to store the information for each memory type in EFI variable or HOB.
Copyright (c) 2006 - 2008, Intel Corporation. <BR>
All rights reserved. This program and the accompanying materials

View File

@ -51,6 +51,7 @@ CreateBannerOpCode (
**/
EFI_STATUS
EFIAPI
IfrLibInitUpdateData (
IN OUT EFI_HII_UPDATE_DATA *UpdateData,
IN UINT32 BufferSize
@ -65,6 +66,7 @@ IfrLibInitUpdateData (
**/
VOID
EFIAPI
IfrLibFreeUpdateData (
IN EFI_HII_UPDATE_DATA *UpdateData
)
@ -104,7 +106,7 @@ IfrLibUpdateForm (
);
/**
Extract formset class for given HII handle.
Extract EDKII extended formset class for a given HII handle.
If Handle is not a valid EFI_HII_HANDLE in the default HII database, then
ASSERT.
@ -134,7 +136,7 @@ IfrLibExtractClassFromHiiHandle (
/**
Configure the buffer accrording to ConfigBody strings in the format of
<Length:4 bytes>, <Offset: 2 bytes>, <Width:2 bytes>, <Data:n bytes>.
This ConfigBody strings is generated by UEFI VfrCompiler for the default
This ConfigBody strings is generated by EDKII UEFI VfrCompiler for the default
values in a Form Set. The name of the ConfigBody strings is VfrMyIfrNVDataDefault0000
constructed following this rule:
"Vfr" + varstore.name + "Default" + defaultstore.attributes.

View File

@ -363,7 +363,7 @@ BdsLibConnectAllDriversToAllControllers (
/**
This function will connect all the system driver to controller
first, and then special connect the default console, this make
sure all the system controller avialbe and the platform default
sure all the system controller available and the platform default
console connected.
**/

View File

@ -35,7 +35,8 @@ HiiLibPreparePackageList (
IN UINTN NumberOfPackages,
IN CONST EFI_GUID *GuidId,
...
);
)
;
/**
This function allocates pool for an EFI_HII_PACKAGE_LIST structure
@ -69,7 +70,8 @@ HiiLibAddPackages (
IN EFI_HANDLE DriverHandle, OPTIONAL
OUT EFI_HII_HANDLE *HiiHandle,
...
);
)
;
/**
Removes a package list from the default HII database.
@ -85,7 +87,8 @@ VOID
EFIAPI
HiiLibRemovePackages (
IN EFI_HII_HANDLE HiiHandle
);
)
;
/**
This function adds the string into String Package of each language
@ -111,7 +114,8 @@ HiiLibNewString (
IN EFI_HII_HANDLE PackageList,
OUT EFI_STRING_ID *StringId,
IN CONST EFI_STRING String
);
)
;
/**
This function update the specified string in String Package of each language
@ -136,7 +140,8 @@ HiiLibSetString (
IN EFI_HII_HANDLE PackageList,
IN EFI_STRING_ID StringId,
IN CONST EFI_STRING String
);
)
;
/**
This function try to retrieve string from String package of current language.
@ -169,7 +174,8 @@ HiiLibGetString (
IN EFI_STRING_ID StringId,
OUT EFI_STRING String,
IN OUT UINTN *StringSize
);
)
;
/**
Get string specified by StringId form the HiiHandle. The caller
@ -194,7 +200,8 @@ HiiLibGetStringFromHandle (
IN EFI_HII_HANDLE HiiHandle,
IN EFI_STRING_ID StringId,
OUT EFI_STRING *String
);
)
;
/**
Get the string given the StringId and String package Producer's Guid. The caller
@ -218,7 +225,8 @@ HiiLibGetStringFromToken (
IN EFI_GUID *ProducerGuid,
IN EFI_STRING_ID StringId,
OUT EFI_STRING *String
);
)
;
/**
Determines the handles that are currently active in the database.
@ -240,7 +248,8 @@ EFIAPI
HiiLibGetHiiHandles (
IN OUT UINTN *HandleBufferLength,
OUT EFI_HII_HANDLE **HiiHandleBuffer
);
)
;
/**
Extract Hii package list GUID for given HII handle.
@ -259,7 +268,8 @@ EFIAPI
HiiLibExtractGuidFromHiiHandle (
IN EFI_HII_HANDLE Handle,
OUT EFI_GUID *Guid
);
)
;
/**
Find HII Handle in the default HII database associated with given Device Path.
@ -278,7 +288,8 @@ EFI_HII_HANDLE
EFIAPI
HiiLibDevicePathToHiiHandle (
IN EFI_DEVICE_PATH_PROTOCOL *DevicePath
);
)
;
/**
@ -298,7 +309,8 @@ EFIAPI
HiiLibGetNextLanguage (
IN OUT CHAR8 **LangCode,
OUT CHAR8 *Lang
);
)
;
/**
This function returns the list of supported languages, in the format specified
@ -316,7 +328,8 @@ CHAR8 *
EFIAPI
HiiLibGetSupportedLanguages (
IN EFI_HII_HANDLE HiiHandle
);
)
;
/**
This function returns the list of supported 2nd languages, in the format specified
@ -336,7 +349,8 @@ EFIAPI
HiiLibGetSupportedSecondaryLanguages (
IN EFI_HII_HANDLE HiiHandle,
IN CONST CHAR8 *FirstLanguage
);
)
;
/**
@ -354,7 +368,8 @@ UINT16
EFIAPI
HiiLibGetSupportedLanguageNumber (
IN EFI_HII_HANDLE HiiHandle
);
)
;
/**
Exports the contents of one or all package lists in the HII database into a buffer.
@ -380,7 +395,8 @@ HiiLibExportPackageLists (
IN EFI_HII_HANDLE Handle,
OUT EFI_HII_PACKAGE_LIST_HEADER **PackageListHeader,
OUT UINTN *PackageListSize
);
)
;
/**
@ -426,7 +442,8 @@ HiiLibListPackageLists (
IN CONST EFI_GUID *PackageGuid,
IN OUT UINTN *HandleBufferLength,
OUT EFI_HII_HANDLE **Handle
);
)
;
/**
Convert language code from RFC3066 to ISO639-2.
@ -452,7 +469,8 @@ EFIAPI
ConvertRfc3066LanguageToIso639Language (
IN CHAR8 *LanguageRfc3066,
OUT CHAR8 *LanguageIso639
);
)
;
/**
Convert language code from ISO639-2 to RFC3066.
@ -478,7 +496,8 @@ EFIAPI
ConvertIso639LanguageToRfc3066Language (
IN CONST CHAR8 *LanguageIso639,
OUT CHAR8 *LanguageRfc3066
);
)
;
/**
Convert language code list from RFC3066 to ISO639-2, e.g. "en-US;fr-FR" will
@ -495,7 +514,8 @@ CHAR8 *
EFIAPI
Rfc3066ToIso639 (
CHAR8 *SupportedLanguages
);
)
;
/**
@ -517,6 +537,7 @@ EFI_STATUS
EFIAPI
GetCurrentLanguage (
OUT CHAR8 *Lang
);
)
;
#endif

View File

@ -16,34 +16,6 @@
#ifndef _IFR_SUPPORT_LIBRARY_H_
#define _IFR_SUPPORT_LIBRARY_H_
#include <Protocol/HiiFont.h>
#include <Protocol/HiiImage.h>
#include <Protocol/HiiString.h>
#include <Protocol/HiiDatabase.h>
#include <Protocol/HiiConfigRouting.h>
#include <Protocol/HiiConfigAccess.h>
#include <Protocol/FormBrowser2.h>
#include <Protocol/SimpleTextOut.h>
#include <Guid/GlobalVariable.h>
//
// The architectural variable "Lang" and "LangCodes" are deprecated in UEFI
// specification. While, UEFI specification also states that these deprecated
// variables may be provided for backwards compatibility.
#define EFI_LANGUAGE_VARIABLE L"Lang"
#define EFI_LANGUAGE_CODES_VARIABLE L"LangCodes"
#define UEFI_LANGUAGE_VARIABLE L"PlatformLang"
#define UEFI_LANGUAGE_CODES_VARIABLE L"PlatformLangCodes"
#define INVALID_VARSTORE_ID 0
#define QUESTION_FLAGS (EFI_IFR_FLAG_READ_ONLY | EFI_IFR_FLAG_CALLBACK | EFI_IFR_FLAG_RESET_REQUIRED | EFI_IFR_FLAG_OPTIONS_ONLY)
#define QUESTION_FLAGS_MASK (~QUESTION_FLAGS)
#pragma pack(1)
typedef struct {
EFI_STRING_ID StringToken;
@ -632,6 +604,7 @@ ConstructConfigHdr (
**/
BOOLEAN
EFIAPI
IsConfigHdrMatch (
IN EFI_STRING ConfigString,
IN EFI_GUID *StorageGuid, OPTIONAL

View File

@ -31,7 +31,8 @@ EFI_STATUS
EFIAPI
FreeMappingDatabase (
IN OUT LIST_ENTRY *MappingDataBase
);
)
;
/**
Read the NV environment variable(s) that contain the override mappings from Controller Device Path to
@ -49,7 +50,8 @@ EFI_STATUS
EFIAPI
InitOverridesMapping (
OUT LIST_ENTRY *MappingDataBase
);
)
;
/**
Save the memory mapping database into NV environment variable(s).
@ -65,7 +67,8 @@ EFI_STATUS
EFIAPI
SaveOverridesMapping (
IN LIST_ENTRY *MappingDataBase
);
)
;
/**
Retrieves the image handle of the platform override driver for a controller in the system from the memory mapping database.
@ -98,7 +101,8 @@ GetDriverFromMapping (
IN OUT EFI_HANDLE *DriverImageHandle,
IN LIST_ENTRY *MappingDataBase,
IN EFI_HANDLE CallerImageHandle
);
)
;
/**
Check mapping database whether already has the mapping info which
@ -125,7 +129,8 @@ CheckMapping (
IN LIST_ENTRY *MappingDataBase,
OUT UINT32 *DriverInfoNum OPTIONAL,
OUT UINT32 *DriverImageNO OPTIONAL
);
)
;
/**
Insert a driver image as a controller's override driver into the mapping database.
@ -153,7 +158,8 @@ InsertDriverImage (
IN EFI_DEVICE_PATH_PROTOCOL *DriverImageDevicePath,
IN LIST_ENTRY *MappingDataBase,
IN UINT32 DriverImageNO
);
)
;
/**
Delete a controller's override driver from the mapping database.
@ -176,6 +182,7 @@ DeleteDriverImage (
IN EFI_DEVICE_PATH_PROTOCOL *ControllerDevicePath,
IN EFI_DEVICE_PATH_PROTOCOL *DriverImageDevicePath,
IN LIST_ENTRY *MappingDataBase
);
)
;
#endif

View File

@ -23,8 +23,8 @@ typedef struct _EFI_CONSOLE_CONTROL_PROTOCOL EFI_CONSOLE_CONTROL_PROTOCOL;
typedef enum {
EfiConsoleControlScreenText, /// Text Mode
EfiConsoleControlScreenGraphics, /// Graphics Mode
EfiConsoleControlScreenText, ///> Text Mode
EfiConsoleControlScreenGraphics, ///> Graphics Mode
EfiConsoleControlScreenMaxValue
} EFI_CONSOLE_CONTROL_SCREEN_MODE;

View File

@ -144,7 +144,7 @@ extern EFI_GUID gEfiDiskInfoUsbInterfaceGuid;
extern EFI_GUID gEfiDiskInfoAhciInterfaceGuid;
struct _EFI_DISK_INFO_PROTOCOL {
EFI_GUID Interface; /// The format of the buffers returned by member functions.
EFI_GUID Interface; ///> The format of the buffers returned by member functions.
EFI_DISK_INFO_INQUIRY Inquiry;
EFI_DISK_INFO_IDENTIFY Identify;
EFI_DISK_INFO_SENSE_DATA SenseData;

View File

@ -87,7 +87,9 @@ EFI_STATUS
@param This Protocol instance pointer.
@retval EFI_SUCCESS Successful.
@retval EFI_SUCCESS Success. Then free all the generic memory test driver
allocated resource and notify to platform memory
test driver that memory test finished.
**/
typedef
@ -106,7 +108,7 @@ EFI_STATUS
@param Length The compatible memory range's length.
@retval EFI_SUCCESS The compatible memory range pass the memory test.
@retval EFI_INVALID_PARAMETER The compatible memory range must be below 16M.
@retval EFI_INVALID_PARAMETER The compatible memory range are not below Low 16M.
**/
typedef

View File

@ -1,6 +1,6 @@
/** @file
This guid is used to specify the device is the hot plug device.
If the device is the hot plug device, this guid as the protocol guid
This protocol guid is used to specify the device is the hot plug device.
If the device is the hot plug device, this protocol guid
will be installed into this device handle.
Copyright (c) 2006 - 2008, Intel Corporation

View File

@ -1,9 +1,7 @@
/** @file
Load Pe32 Image protocol provides capability to load and unload EFI image into memory and execute it.
This protocol supports the additional new boot devices that do not map well to file system.
UEFI can boot from any device (including Network boot) that produces a LoadFile protocol.
This protocol bases on File Device Path to get EFI image.
Copyright (c) 2006 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials

View File

@ -46,17 +46,17 @@ typedef struct _PERFORMANCE_PROTOCOL PERFORMANCE_PROTOCOL;
typedef struct {
EFI_PHYSICAL_ADDRESS Handle;
CHAR8 Token[DXE_PERFORMANCE_STRING_SIZE]; /// Measured token string name
CHAR8 Module[DXE_PERFORMANCE_STRING_SIZE]; /// Module string name
UINT64 StartTimeStamp; /// Start time point
UINT64 EndTimeStamp; /// End time point
CHAR8 Token[DXE_PERFORMANCE_STRING_SIZE]; ///> Measured token string name
CHAR8 Module[DXE_PERFORMANCE_STRING_SIZE]; ///> Module string name
UINT64 StartTimeStamp; ///> Start time point
UINT64 EndTimeStamp; ///> End time point
} GAUGE_DATA_ENTRY;
//
// The header must be aligned at 8 bytes
//
typedef struct {
UINT32 NumberOfEntries; /// The number of all performance guage entries
UINT32 NumberOfEntries; ///> The number of all performance guage entries
UINT32 Reserved;
} GAUGE_DATA_HEADER;

View File

@ -27,7 +27,7 @@
#endif
//
// Define GET_PAD_SIZE to optimize compiler
// GET_PAD_SIZE to calculate miminal pad bytes to make current size satisfy the alignment requirement
//
#if ((ALIGNMENT == 0) || (ALIGNMENT == 1))
#define GET_PAD_SIZE(a) (0)

View File

@ -32,6 +32,10 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#include <Library/MemoryAllocationLib.h>
#include <Library/IfrSupportLib.h>
#define INVALID_VARSTORE_ID 0
#define QUESTION_FLAGS (EFI_IFR_FLAG_READ_ONLY | EFI_IFR_FLAG_CALLBACK | EFI_IFR_FLAG_RESET_REQUIRED | EFI_IFR_FLAG_OPTIONS_ONLY)
#define QUESTION_FLAGS_MASK (~QUESTION_FLAGS)
#endif

View File

@ -33,7 +33,7 @@ IsValidQuestionFlags (
IN UINT8 Flags
)
{
return (BOOLEAN) (((Flags & (~QUESTION_FLAGS)) != 0) ? FALSE : TRUE);
return (BOOLEAN) (((Flags & QUESTION_FLAGS_MASK) != 0) ? FALSE : TRUE);
}
/**

View File

@ -32,6 +32,7 @@ Revision History
#include <Protocol/HiiDatabase.h>
#include <Protocol/HiiString.h>
#include <MdeModuleHii.h>
#include <Library/DebugLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/UefiRuntimeServicesTableLib.h>
@ -43,9 +44,6 @@ Revision History
#include <Library/HiiLib.h>
#include <Library/ExtendedHiiLib.h>
#include <MdeModuleHii.h>
#include "NVDataStruc.h"
//

View File

@ -28,6 +28,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#include <Protocol/SimpleTextOut.h>
#include <Guid/HiiKeyBoardLayout.h>
#include <Guid/GlobalVariable.h>
#include <Library/DebugLib.h>

View File

@ -15,6 +15,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#ifndef _ISCSI_CONFIG_H_
#define _ISCSI_CONFIG_H_
#include <Protocol/HiiConfigRouting.h>
#include <Library/HiiLib.h>
#include <Library/ExtendedHiiLib.h>
#include <Library/IfrSupportLib.h>

View File

@ -11,9 +11,6 @@ http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name: Pcd.c
**/
#include "Service.h"

View File

@ -3,7 +3,7 @@
# PEI phase, DXE phase and produce the implementation of PCD protocol.
# PCD database structure is generated at autogen.h/autogen.c in build time.
#
# Copyright (c) 2006 - 2007, Intel Corporation
# Copyright (c) 2006 - 2009, Intel Corporation
#
# All rights reserved. This program and the accompanying materials
# are licensed and made available under the terms and conditions of the BSD License
@ -52,10 +52,10 @@
PcdLib
[Guids]
gPcdDataBaseHobGuid # ALWAYS_CONSUMES Hob: GUID_EXTENSION
gPcdDataBaseHobGuid ## CONSUMES ## Hob: GUID_EXTENSION
[Protocols]
gPcdProtocolGuid # PROTOCOL ALWAYS_PRODUCES
gPcdProtocolGuid ## PRODUCES
[FeaturePcd.common]
gEfiMdeModulePkgTokenSpaceGuid.PcdDxePcdDatabaseTraverseEnabled

View File

@ -1018,7 +1018,7 @@ SetHiiVariable (
space guid: token number} to local token number.
@param Guid Token space guid for dynamic-ex PCD entry.
@param ExTokenNumber EDES_TODO: Add parameter description
@param ExTokenNumber Dynamic-ex PCD token number.
@return local token number for dynamic-ex PCD.
@ -1049,7 +1049,6 @@ GetExPcdTokenNumber (
if ((ExTokenNumber == ExMap[Index].ExTokenNumber) &&
(MatchGuidIdx == ExMap[Index].ExGuidIndex)) {
return ExMap[Index].LocalTokenNumber;
}
}
}

View File

@ -10,9 +10,6 @@ http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name: Service.h
**/
#ifndef _PCD_DXE_SERVICE_H_
@ -31,20 +28,6 @@ Module Name: Service.h
#include <Library/BaseMemoryLib.h>
#include <Library/UefiRuntimeServicesTableLib.h>
//
// Please make sure the PCD Service PEIM Version is consistent with
// the version of PCD Database generation tool
//
#define PCD_SERVICE_DXE_DRIVER_VERSION 2
//
// PCD_DXE_DATABASE_GENTOOL_VERSION is defined in Autogen.h
// and generated by PCD Database generation tool.
//
//#if (PCD_SERVICE_DXE_DRIVER_VERSION != PCD_DXE_SERVICE_DRIVER_AUTOGEN_VERSION)
// #error "Please make sure the version of PCD Service DXE Driver and PCD DXE Database Generation Tool matches"
//#endif
//
// Protocol Interface function declaration.
//
@ -997,7 +980,7 @@ BuildPcdDxeDataBase (
space guid: token number} to local token number.
@param Guid Token space guid for dynamic-ex PCD entry.
@param ExTokenNumber EDES_TODO: Add parameter description
@param ExTokenNumber Dynamic-ex PCD token number.
@return local token number for dynamic-ex PCD.

View File

@ -48,12 +48,12 @@
[Guids]
gPcdPeiCallbackFnTableHobGuid ## RPIVATE ## Hob
gPcdDataBaseHobGuid ## PRODUCED ## Hob
gPcdDataBaseHobGuid ## CONSUMED ## Hob
gPcdDataBaseHobGuid ## PRODUCES ## Hob
gPcdDataBaseHobGuid ## CONSUMES ## Hob
[Ppis]
gEfiPeiReadOnlyVariable2PpiGuid ## CONSUMED
gPcdPpiGuid ## PRODUCED
gEfiPeiReadOnlyVariable2PpiGuid ## CONSUMES
gPcdPpiGuid ## PRODUCES
[FeaturePcd.common]
gEfiMdeModulePkgTokenSpaceGuid.PcdPeiPcdDatabaseSetEnabled

View File

@ -36,6 +36,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#include <Protocol/ComponentName2.h>
#include <Protocol/ComponentName.h>
#include <Protocol/DriverBinding.h>
#include <Guid/GlobalVariable.h>
#include <Library/BaseLib.h>
#include <Library/DebugLib.h>