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

@@ -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