diff options
author | qwang12 <qwang12@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-07-14 05:30:21 +0000 |
---|---|---|
committer | qwang12 <qwang12@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-07-14 05:30:21 +0000 |
commit | 6ca46b63d200fdbc939959d18d31936c1c48b4d9 (patch) | |
tree | 3c82e6fde26fc1a8f30ea70be901d0c0cf3798fe /MdeModulePkg | |
parent | ad1b36195a8b1ec3831fcf34cc0448c1266ec521 (diff) | |
download | edk2-6ca46b63d200fdbc939959d18d31936c1c48b4d9.zip edk2-6ca46b63d200fdbc939959d18d31936c1c48b4d9.tar.gz edk2-6ca46b63d200fdbc939959d18d31936c1c48b4d9.tar.bz2 |
Clean up ExtendedHiiLib, HiiLib, IfrSupportLib, ExtendedIfrSupportLib for Doxygen comments requirement.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5459 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdeModulePkg')
6 files changed, 110 insertions, 26 deletions
diff --git a/MdeModulePkg/Include/Library/ExtendedHiiLib.h b/MdeModulePkg/Include/Library/ExtendedHiiLib.h index 2b7003f..d2bfb4a 100644 --- a/MdeModulePkg/Include/Library/ExtendedHiiLib.h +++ b/MdeModulePkg/Include/Library/ExtendedHiiLib.h @@ -21,7 +21,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. that there should be DevicePath Protocol installed on it.
This routine create a virtual Driver Handle by installing a vendor device
path on it, so as to use it to invoke HiiDatabase.NewPackageList().
- The Device Path created is a Vendor Device Path specific to Intel's implemenation.
+ The Device Path created is a Vendor Device Path specific to Intel's implemenation
+ and it is defined as HII_VENDOR_DEVICE_PATH_NODE.
+
@param DriverHandle Handle to be returned
diff --git a/MdeModulePkg/Library/ExtendedHiiLib/ExtendedHiiLib.c b/MdeModulePkg/Library/ExtendedHiiLib/ExtendedHiiLib.c index 1b13da7..bfaf49e 100644 --- a/MdeModulePkg/Library/ExtendedHiiLib/ExtendedHiiLib.c +++ b/MdeModulePkg/Library/ExtendedHiiLib/ExtendedHiiLib.c @@ -51,7 +51,21 @@ HII_VENDOR_DEVICE_PATH mHiiVendorDevicePathTemplate = { }
};
+/**
+ The HII driver handle passed in for HiiDatabase.NewPackageList() requires
+ that there should be DevicePath Protocol installed on it.
+ This routine create a virtual Driver Handle by installing a vendor device
+ path on it, so as to use it to invoke HiiDatabase.NewPackageList().
+ The Device Path created is a Vendor Device Path specific to Intel's implemenation
+ and it is defined as HII_VENDOR_DEVICE_PATH_NODE.
+
+ @param DriverHandle Handle to be returned
+
+ @retval EFI_SUCCESS Handle destroy success.
+ @retval EFI_OUT_OF_RESOURCES Not enough memory.
+
+**/
EFI_STATUS
EFIAPI
HiiLibCreateHiiDriverHandle (
@@ -85,6 +99,16 @@ HiiLibCreateHiiDriverHandle ( }
+/**
+ Destroy the Driver Handle created by CreateHiiDriverHandle().
+
+ If no Device Path protocol is installed on the DriverHandle, then ASSERT.
+ If this Device Path protocol is failed to be uninstalled, then ASSERT.
+
+ @param DriverHandle Handle returned by CreateHiiDriverHandle()
+
+
+**/
VOID
EFIAPI
HiiLibDestroyHiiDriverHandle (
diff --git a/MdeModulePkg/Library/ExtendedIfrSupportLib/Common.c b/MdeModulePkg/Library/ExtendedIfrSupportLib/Common.c index 6f8926b..65acd0c 100644 --- a/MdeModulePkg/Library/ExtendedIfrSupportLib/Common.c +++ b/MdeModulePkg/Library/ExtendedIfrSupportLib/Common.c @@ -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;
diff --git a/MdeModulePkg/Library/ExtendedIfrSupportLib/Form.c b/MdeModulePkg/Library/ExtendedIfrSupportLib/Form.c index a2891de..ea9079e 100644 --- a/MdeModulePkg/Library/ExtendedIfrSupportLib/Form.c +++ b/MdeModulePkg/Library/ExtendedIfrSupportLib/Form.c @@ -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.
diff --git a/MdeModulePkg/Library/ExtendedIfrSupportLib/IfrOpCodeCreation.c b/MdeModulePkg/Library/ExtendedIfrSupportLib/IfrOpCodeCreation.c index 686765b..1a9926e 100644 --- a/MdeModulePkg/Library/ExtendedIfrSupportLib/IfrOpCodeCreation.c +++ b/MdeModulePkg/Library/ExtendedIfrSupportLib/IfrOpCodeCreation.c @@ -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 (
diff --git a/MdeModulePkg/Library/ExtendedIfrSupportLib/LibraryInternal.h b/MdeModulePkg/Library/ExtendedIfrSupportLib/LibraryInternal.h index d379268..2ec3f5e 100644 --- a/MdeModulePkg/Library/ExtendedIfrSupportLib/LibraryInternal.h +++ b/MdeModulePkg/Library/ExtendedIfrSupportLib/LibraryInternal.h @@ -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>
|