sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Clean up ExtendedHiiLib, HiiLib, IfrSupportLib, ExtendedIfrSupportLib for Doxygen comments requirement.

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5459 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
qwang12
2008-07-14 05:30:21 +00:00
parent ad1b36195a
commit 6ca46b63d2
6 changed files with 110 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
MdeModulePkg/Library/ExtendedIfrSupportLib/Common.c
View File

@@ -22,6 +22,17 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
EFI_HII_DATABASE_PROTOCOL *gIfrLibHiiDatabase;
EFI_HII_STRING_PROTOCOL *gIfrLibHiiString;
/**
ExtendedIfrSupportLib's constructor. It locates the required protocol:
gEfiHiiDatabaseProtocolGuid and gEfiHiiStringProtocolGuid.
@param ImageHandle The firmware allocated handle for the EFI image.
@param SystemTable A pointer to the EFI System Table.
@retval EFI_SUCCESS This function always completes successfully.
**/
EFI_STATUS
EFIAPI
ExtendedIfrSupportLibConstructor (
@@ -44,6 +55,19 @@ ExtendedIfrSupportLibConstructor (
STATIC EFI_GUID mIfrVendorGuid = EFI_IFR_TIANO_GUID;
/**
Extract formset class for given HII handle.
@param Handle The HII handle.
@param Class Class of the formset.
@param FormSetTitle Formset title string.
@param FormSetHelp Formset help string.
@retval EFI_SUCCESS Successfully extract Class for specified Hii handle.
@return Other values if failed to export packages for the given HII handle.
**/
EFI_STATUS
EFIAPI
IfrLibExtractClassFromHiiHandle (
@@ -52,21 +76,6 @@ IfrLibExtractClassFromHiiHandle (
OUT EFI_STRING_ID *FormSetTitle,
OUT EFI_STRING_ID *FormSetHelp
)
/*++
Routine Description:
Extract formset class for given HII handle.
Arguments:
HiiHandle - Hii handle
Class - Class of the formset
FormSetTitle - Formset title string
FormSetHelp - Formset help string
Returns:
EFI_SUCCESS - Successfully extract Class for specified Hii handle.
--*/
{
EFI_STATUS Status;
UINTN BufferSize;

51
MdeModulePkg/Library/ExtendedIfrSupportLib/Form.c
View File

@@ -14,7 +14,20 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#include "LibraryInternal.h"
STATIC
/**
Get the specified package from a package list based on an index.
The Buffer on output is updated to point to a package header in
the HiiPackageList. This is an internal function.
@param HiiPackageList The Package List Header.
@param PackageIndex The index of the package to get.
@param BufferLen The length of the package.
@param Buffer The starting address of package.
@retval EFI_SUCCESS This function completes successfully.
@retval EFI_NOT_FOUND The package is not found.
**/
EFI_STATUS
GetPackageDataFromPackageList (
IN EFI_HII_PACKAGE_LIST_HEADER *HiiPackageList,
@@ -27,7 +40,10 @@ GetPackageDataFromPackageList (
EFI_HII_PACKAGE_HEADER *Package;
UINT32 Offset;
UINT32 PackageListLength;
EFI_HII_PACKAGE_HEADER PackageHeader = {0, 0};
EFI_HII_PACKAGE_HEADER PackageHeader;
PackageHeader.Length = 0;
PackageHeader.Type = 0;
ASSERT(HiiPackageList != NULL);
@@ -60,11 +76,29 @@ GetPackageDataFromPackageList (
return EFI_SUCCESS;
}
STATIC
/**
This is the internal worker function to update the data in
a form specified by FormSetGuid,
@param FormSetGuid The optional Formset GUID.
@param FormId The form ID>
@param Package The package header.
@param PackageLength The package length.
@param Label The label for the update.
@param Insert True if inserting opcode to the form.
@param Data The data payload.
@param TempBuffer The resultant package.
@param TempBufferSize The length of the resultant package.
@retval EFI_OUT_OF_RESOURCES If there is not enough memory to complete the operation.
@retval EFI_INVALID_PARAMETER If TempBuffer or TempBufferSize is NULL.
@retval EFI_SUCCESS The function completes successfully.
**/
EFI_STATUS
EFIAPI
UpdateFormPackageData (
IN EFI_GUID *FormSetGuid,
IN EFI_GUID *FormSetGuid, OPTIONAL
IN EFI_FORM_ID FormId,
IN EFI_HII_PACKAGE_HEADER *Package,
IN UINT32 PackageLength,
@@ -366,10 +400,11 @@ IfrLibUpdateForm (
/**
Configure the buffer accrording to ConfigBody strings.
@param DefaultId the ID of default.
@param Buffer the start address of buffer.
@param BufferSize the size of buffer.
@param Number the number of the strings.
@param Buffer The start address of buffer.
@param BufferSize The size of buffer.
@param Number The number of the strings.
@param ... Variable argument list for default value in <AltResp> format
generated by the tool.
@retval EFI_BUFFER_TOO_SMALL the BufferSize is too small to operate.
@retval EFI_INVALID_PARAMETER Buffer is NULL or BufferSize is 0.

14
MdeModulePkg/Library/ExtendedIfrSupportLib/IfrOpCodeCreation.c
View File

@@ -17,6 +17,20 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
STATIC EFI_GUID mIfrVendorGuid = EFI_IFR_TIANO_GUID;
/**
Create GUIDed opcode for banner. Banner opcode
EFI_IFR_EXTEND_OP_BANNER is extended opcode specific
to Intel's implementation.
@param Title String ID for title
@param LineNumber Line number for this banner
@param Alignment Alignment for this banner, left, center or right
@param Data Destination for the created opcode binary
@retval EFI_SUCCESS Opcode create success
@retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.
**/
EFI_STATUS
EFIAPI
CreateBannerOpCode (

4
MdeModulePkg/Library/ExtendedIfrSupportLib/LibraryInternal.h
View File

@@ -12,8 +12,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#ifndef _IFRLIBRARY_INTERNAL_H
#define _IFRLIBRARY_INTERNAL_H
#ifndef _IFRLIBRARY_INTERNAL_H_
#define _IFRLIBRARY_INTERNAL_H_
#include <PiDxe.h>