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

Refine the comments and code to follow spec. 

Signed-off-by: Eric Dong <eric.dong@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>


git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@14573 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
Eric Dong 2013-08-20 07:13:28 +00:00 committed by ydong10
parent 5795218e88
commit c0a3c3da98
5 changed files with 87 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
MdeModulePkg/Universal/HiiDatabaseDxe/ConfigRouting.c
View File

@ -3767,9 +3767,9 @@ Done:
instance. instance.
@param Results Null-terminated Unicode string in @param Results Null-terminated Unicode string in
<MultiConfigAltResp> format which has all values <MultiConfigAltResp> format which has all values
filled in for the names in the Request string. filled in for the entirety of the current HII
String to be allocated by the called function. database. String to be allocated by the called
De-allocation is up to the caller. function. De-allocation is up to the caller.
@retval EFI_SUCCESS The Results string is filled with the values @retval EFI_SUCCESS The Results string is filled with the values
corresponding to all requested names. corresponding to all requested names.
@ -4482,8 +4482,9 @@ Exit:
(see below) is returned. (see below) is returned.
@param BlockSize The length of the Block in units of UINT8. On @param BlockSize The length of the Block in units of UINT8. On
input, this is the size of the Block. On output, input, this is the size of the Block. On output,
if successful, contains the index of the last if successful, contains the largest index of the
modified byte in the Block. modified byte in the Block, or the required buffer
size if the Block is not large enough.
@param Progress On return, points to an element of the ConfigResp @param Progress On return, points to an element of the ConfigResp
string filled in with the offset of the most string filled in with the offset of the most
recent '&' before the first failing name / value recent '&' before the first failing name / value
@ -4503,7 +4504,8 @@ Exit:
value pair. Block is left updated and value pair. Block is left updated and
Progress points at the '&' preceding the first Progress points at the '&' preceding the first
non-<BlockName>. non-<BlockName>.
@retval EFI_DEVICE_ERROR Block not large enough. Progress undefined. @retval EFI_BUFFER_TOO_SMALL Block not large enough. Progress undefined.
BlockSize is updated with the required buffer size.
@retval EFI_NOT_FOUND Target for the specified routing data was not found. @retval EFI_NOT_FOUND Target for the specified routing data was not found.
Progress points to the "G" in "GUID" of the errant Progress points to the "G" in "GUID" of the errant
routing data. routing data.
@ -4680,7 +4682,7 @@ HiiConfigToBlock (
if (MaxBlockSize > BufferSize) { if (MaxBlockSize > BufferSize) {
*BlockSize = MaxBlockSize; *BlockSize = MaxBlockSize;
if (Block != NULL) { if (Block != NULL) {
return EFI_DEVICE_ERROR; return EFI_BUFFER_TOO_SMALL;
} }
} }

13
MdeModulePkg/Universal/HiiDatabaseDxe/Database.c
View File

@ -3106,8 +3106,9 @@ HiiUpdatePackageList (
handles. HandleBufferLength is updated with a handles. HandleBufferLength is updated with a
value that will enable the data to fit. value that will enable the data to fit.
@retval EFI_NOT_FOUND No matching handle could not be found in database. @retval EFI_NOT_FOUND No matching handle could not be found in database.
@retval EFI_INVALID_PARAMETER Handle or HandleBufferLength was NULL. @retval EFI_INVALID_PARAMETER HandleBufferLength was NULL.
@retval EFI_INVALID_PARAMETER The value referenced by HandleBufferLength was not
zero and Handle was NULL.
@retval EFI_INVALID_PARAMETER PackageType is not a EFI_HII_PACKAGE_TYPE_GUID but @retval EFI_INVALID_PARAMETER PackageType is not a EFI_HII_PACKAGE_TYPE_GUID but
PackageGuid is not NULL, PackageType is a EFI_HII_ PackageGuid is not NULL, PackageType is a EFI_HII_
PACKAGE_TYPE_GUID but PackageGuid is NULL. PACKAGE_TYPE_GUID but PackageGuid is NULL.
@ -3263,7 +3264,9 @@ HiiListPackageLists (
value that will enable the data to fit. value that will enable the data to fit.
@retval EFI_NOT_FOUND The specifiecd Handle could not be found in the @retval EFI_NOT_FOUND The specifiecd Handle could not be found in the
current database. current database.
@retval EFI_INVALID_PARAMETER Handle or Buffer or BufferSize was NULL. @retval EFI_INVALID_PARAMETER BufferSize was NULL.
@retval EFI_INVALID_PARAMETER The value referenced by BufferSize was not zero
and Buffer was NULL.
**/ **/
EFI_STATUS EFI_STATUS
@ -3525,7 +3528,9 @@ HiiUnregisterPackageNotify (
number of GUIDs. KeyGuidBufferLength is number of GUIDs. KeyGuidBufferLength is
updated with a value that will enable the data to updated with a value that will enable the data to
fit. fit.
@retval EFI_INVALID_PARAMETER The KeyGuidBuffer or KeyGuidBufferLength was NULL. @retval EFI_INVALID_PARAMETER The KeyGuidBufferLength is NULL.
@retval EFI_INVALID_PARAMETER The value referenced by KeyGuidBufferLength is not
zero and KeyGuidBuffer is NULL.
@retval EFI_NOT_FOUND There was no keyboard layout. @retval EFI_NOT_FOUND There was no keyboard layout.
**/ **/

17
MdeModulePkg/Universal/HiiDatabaseDxe/Font.c
View File

@ -2679,14 +2679,15 @@ Exit:
with the first font. On return, points to the with the first font. On return, points to the
returned font handle or points to NULL if there returned font handle or points to NULL if there
are no more matching fonts. are no more matching fonts.
@param StringInfoIn Upon entry, points to the font to return @param StringInfoIn Upon entry, points to the font to return information
information about. about. If NULL, then the information about the system
If NULL, then the information about the system default default font will be returned.
font will be returned. @param StringInfoOut Upon return, contains the matching font's information.
@param StringInfoOut Upon return, contains the matching font's If NULL, then no information is returned. This buffer
information. If NULL, then no information is is allocated with a call to the Boot Service AllocatePool().
returned. It's caller's responsibility to free It is the caller's responsibility to call the Boot
this buffer. Service FreePool() when the caller no longer requires
the contents of StringInfoOut.
@param String Points to the string which will be tested to @param String Points to the string which will be tested to
determine if all characters are available. If determine if all characters are available. If
NULL, then any font is acceptable. NULL, then any font is acceptable.

60
MdeModulePkg/Universal/HiiDatabaseDxe/HiiDatabase.h
View File

@ -725,13 +725,15 @@ HiiGetGlyph (
with the first font. On return, points to the with the first font. On return, points to the
returned font handle or points to NULL if there returned font handle or points to NULL if there
are no more matching fonts. are no more matching fonts.
@param StringInfoIn Upon entry, points to the font to return @param StringInfoIn Upon entry, points to the font to return information
information about. If NULL, then the information about the system default about. If NULL, then the information about the system
font will be returned. default font will be returned.
@param StringInfoOut Upon return, contains the matching font's @param StringInfoOut Upon return, contains the matching font's information.
information. If NULL, then no information is If NULL, then no information is returned. This buffer
returned. It's caller's responsibility to free is allocated with a call to the Boot Service AllocatePool().
this buffer. It is the caller's responsibility to call the Boot
Service FreePool() when the caller no longer requires
the contents of StringInfoOut.
@param String Points to the string which will be tested to @param String Points to the string which will be tested to
determine if all characters are available. If determine if all characters are available. If
NULL, then any font is acceptable. NULL, then any font is acceptable.
@ -1004,13 +1006,14 @@ HiiNewString (
@retval EFI_SUCCESS The string was returned successfully. @retval EFI_SUCCESS The string was returned successfully.
@retval EFI_NOT_FOUND The string specified by StringId is not @retval EFI_NOT_FOUND The string specified by StringId is not
available. available.
@retval EFI_NOT_FOUND The string specified by StringId is available but
not in the specified language.
The specified PackageList is not in the database. The specified PackageList is not in the database.
@retval EFI_INVALID_LANGUAGE - The string specified by StringId is available but @retval EFI_INVALID_LANGUAGE The string specified by StringId is available but
not in the specified language.
@retval EFI_BUFFER_TOO_SMALL The buffer specified by StringSize is too small @retval EFI_BUFFER_TOO_SMALL The buffer specified by StringSize is too small
to hold the string. to hold the string.
@retval EFI_INVALID_PARAMETER The String or Language or StringSize was NULL. @retval EFI_INVALID_PARAMETER The Language or StringSize was NULL.
@retval EFI_INVALID_PARAMETER The value referenced by StringSize was not zero
and String was NULL.
@retval EFI_OUT_OF_RESOURCES There were insufficient resources to complete the @retval EFI_OUT_OF_RESOURCES There were insufficient resources to complete the
request. request.
@ -1076,7 +1079,8 @@ HiiSetString (
points to the length of Languages, in bytes. points to the length of Languages, in bytes.
@retval EFI_SUCCESS The languages were returned successfully. @retval EFI_SUCCESS The languages were returned successfully.
@retval EFI_INVALID_PARAMETER The Languages or LanguagesSize was NULL. @retval EFI_INVALID_PARAMETER The LanguagesSize was NULL.
@retval EFI_INVALID_PARAMETER The value referenced by LanguagesSize is not zero and Languages is NULL.
@retval EFI_BUFFER_TOO_SMALL The LanguagesSize is too small to hold the list @retval EFI_BUFFER_TOO_SMALL The LanguagesSize is too small to hold the list
of supported languages. LanguageSize is updated of supported languages. LanguageSize is updated
to contain the required size. to contain the required size.
@ -1117,8 +1121,9 @@ HiiGetLanguages (
in bytes. in bytes.
@retval EFI_SUCCESS Secondary languages were correctly returned. @retval EFI_SUCCESS Secondary languages were correctly returned.
@retval EFI_INVALID_PARAMETER PrimaryLanguage or SecondaryLanguages or @retval EFI_INVALID_PARAMETER PrimaryLanguage or SecondaryLanguagesSize was NULL.
SecondaryLanguagesSize was NULL. @retval EFI_INVALID_PARAMETER The value referenced by SecondaryLanguagesSize is not
zero and SecondaryLanguages is NULL.
@retval EFI_BUFFER_TOO_SMALL The buffer specified by SecondaryLanguagesSize is @retval EFI_BUFFER_TOO_SMALL The buffer specified by SecondaryLanguagesSize is
too small to hold the returned information. too small to hold the returned information.
SecondaryLanguageSize is updated to hold the size of SecondaryLanguageSize is updated to hold the size of
@ -1251,12 +1256,13 @@ HiiUpdatePackageList (
value that will enable the data to fit. value that will enable the data to fit.
@retval EFI_NOT_FOUND No matching handle could not be found in @retval EFI_NOT_FOUND No matching handle could not be found in
database. database.
@retval EFI_INVALID_PARAMETER Handle or HandleBufferLength was NULL. @retval EFI_INVALID_PARAMETER HandleBufferLength was NULL.
@retval EFI_INVALID_PARAMETER The value referenced by HandleBufferLength was not
zero and Handle was NULL.
@retval EFI_INVALID_PARAMETER PackageType is not a EFI_HII_PACKAGE_TYPE_GUID but @retval EFI_INVALID_PARAMETER PackageType is not a EFI_HII_PACKAGE_TYPE_GUID but
PackageGuid is not NULL, PackageType is a EFI_HII_ PackageGuid is not NULL, PackageType is a EFI_HII_
PACKAGE_TYPE_GUID but PackageGuid is NULL. PACKAGE_TYPE_GUID but PackageGuid is NULL.
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI
@ -1293,7 +1299,9 @@ HiiListPackageLists (
a value that will enable the data to fit. a value that will enable the data to fit.
@retval EFI_NOT_FOUND The specifiecd Handle could not be found in the @retval EFI_NOT_FOUND The specifiecd Handle could not be found in the
current database. current database.
@retval EFI_INVALID_PARAMETER Handle or Buffer or BufferSize was NULL. @retval EFI_INVALID_PARAMETER BufferSize was NULL.
@retval EFI_INVALID_PARAMETER The value referenced by BufferSize was not zero
and Buffer was NULL.
**/ **/
EFI_STATUS EFI_STATUS
@ -1393,8 +1401,9 @@ HiiUnregisterPackageNotify (
number of GUIDs. KeyGuidBufferLength is number of GUIDs. KeyGuidBufferLength is
updated with a value that will enable the data to updated with a value that will enable the data to
fit. fit.
@retval EFI_INVALID_PARAMETER The KeyGuidBuffer or KeyGuidBufferLength was @retval EFI_INVALID_PARAMETER The KeyGuidBufferLength is NULL.
NULL. @retval EFI_INVALID_PARAMETER The value referenced by KeyGuidBufferLength is not
zero and KeyGuidBuffer is NULL.
@retval EFI_NOT_FOUND There was no keyboard layout. @retval EFI_NOT_FOUND There was no keyboard layout.
**/ **/
@ -1549,9 +1558,9 @@ HiiConfigRoutingExtractConfig (
instance. instance.
@param Results Null-terminated Unicode string in @param Results Null-terminated Unicode string in
<MultiConfigAltResp> format which has all values <MultiConfigAltResp> format which has all values
filled in for the names in the Request string. filled in for the entirety of the current HII
String to be allocated by the called function. database. String to be allocated by the called
De-allocation is up to the caller. function. De-allocation is up to the caller.
@retval EFI_SUCCESS The Results string is filled with the values @retval EFI_SUCCESS The Results string is filled with the values
corresponding to all requested names. corresponding to all requested names.
@ -1674,8 +1683,9 @@ HiiBlockToConfig (
(see below) is returned. (see below) is returned.
@param BlockSize The length of the Block in units of UINT8. On @param BlockSize The length of the Block in units of UINT8. On
input, this is the size of the Block. On output, input, this is the size of the Block. On output,
if successful, contains the index of the last if successful, contains the largest index of the
modified byte in the Block. modified byte in the Block, or the required buffer
size if the Block is not large enough.
@param Progress On return, points to an element of the ConfigResp @param Progress On return, points to an element of the ConfigResp
string filled in with the offset of the most string filled in with the offset of the most
recent '&' before the first failing name / value recent '&' before the first failing name / value
@ -1700,6 +1710,8 @@ HiiBlockToConfig (
value pair. Block is left updated and value pair. Block is left updated and
Progress points at the '&' preceding the first Progress points at the '&' preceding the first
non-<BlockName>. non-<BlockName>.
@retval EFI_BUFFER_TOO_SMALL Block not large enough. Progress undefined.
BlockSize is updated with the required buffer size.
**/ **/
EFI_STATUS EFI_STATUS

20
MdeModulePkg/Universal/HiiDatabaseDxe/String.c
View File

@ -1590,7 +1590,8 @@ Done:
@retval EFI_INVALID_LANGUAGE - The string specified by StringId is available but @retval EFI_INVALID_LANGUAGE - The string specified by StringId is available but
@retval EFI_BUFFER_TOO_SMALL The buffer specified by StringSize is too small to @retval EFI_BUFFER_TOO_SMALL The buffer specified by StringSize is too small to
hold the string. hold the string.
@retval EFI_INVALID_PARAMETER The String or Language or StringSize was NULL. @retval EFI_INVALID_PARAMETER The Language or StringSize was NULL.
@retval EFI_INVALID_PARAMETER The value referenced by StringSize was not zero and String was NULL.
@retval EFI_OUT_OF_RESOURCES There were insufficient resources to complete the @retval EFI_OUT_OF_RESOURCES There were insufficient resources to complete the
request. request.
@ -1775,7 +1776,8 @@ HiiSetString (
the length of Languages, in bytes. the length of Languages, in bytes.
@retval EFI_SUCCESS The languages were returned successfully. @retval EFI_SUCCESS The languages were returned successfully.
@retval EFI_INVALID_PARAMETER The Languages or LanguagesSize was NULL. @retval EFI_INVALID_PARAMETER The LanguagesSize was NULL.
@retval EFI_INVALID_PARAMETER The value referenced by LanguagesSize is not zero and Languages is NULL.
@retval EFI_BUFFER_TOO_SMALL The LanguagesSize is too small to hold the list of @retval EFI_BUFFER_TOO_SMALL The LanguagesSize is too small to hold the list of
supported languages. LanguageSize is updated to supported languages. LanguageSize is updated to
contain the required size. contain the required size.
@ -1799,7 +1801,10 @@ HiiGetLanguages (
HII_STRING_PACKAGE_INSTANCE *StringPackage; HII_STRING_PACKAGE_INSTANCE *StringPackage;
UINTN ResultSize; UINTN ResultSize;
if (This == NULL || Languages == NULL || LanguagesSize == NULL || PackageList == NULL) { if (This == NULL || LanguagesSize == NULL || PackageList == NULL) {
return EFI_INVALID_PARAMETER;
}
if (*LanguagesSize != 0 && Languages == NULL) {
return EFI_INVALID_PARAMETER; return EFI_INVALID_PARAMETER;
} }
if (!IsHiiHandleValid (PackageList)) { if (!IsHiiHandleValid (PackageList)) {
@ -1871,8 +1876,9 @@ HiiGetLanguages (
points to the length of SecondaryLanguages in bytes. points to the length of SecondaryLanguages in bytes.
@retval EFI_SUCCESS Secondary languages were correctly returned. @retval EFI_SUCCESS Secondary languages were correctly returned.
@retval EFI_INVALID_PARAMETER PrimaryLanguage or SecondaryLanguages or @retval EFI_INVALID_PARAMETER PrimaryLanguage or SecondaryLanguagesSize was NULL.
SecondaryLanguagesSize was NULL. @retval EFI_INVALID_PARAMETER The value referenced by SecondaryLanguagesSize is not
zero and SecondaryLanguages is NULL.
@retval EFI_BUFFER_TOO_SMALL The buffer specified by SecondaryLanguagesSize is @retval EFI_BUFFER_TOO_SMALL The buffer specified by SecondaryLanguagesSize is
too small to hold the returned information. too small to hold the returned information.
SecondaryLanguageSize is updated to hold the size of SecondaryLanguageSize is updated to hold the size of
@ -1901,10 +1907,10 @@ HiiGetSecondaryLanguages (
CHAR8 *Languages; CHAR8 *Languages;
UINTN ResultSize; UINTN ResultSize;
if (This == NULL || PackageList == NULL || PrimaryLanguage == NULL) { if (This == NULL || PackageList == NULL || PrimaryLanguage == NULL || SecondaryLanguagesSize == NULL) {
return EFI_INVALID_PARAMETER; return EFI_INVALID_PARAMETER;
} }
if (SecondaryLanguages == NULL || SecondaryLanguagesSize == NULL) { if (SecondaryLanguages == NULL && *SecondaryLanguagesSize != 0) {
return EFI_INVALID_PARAMETER; return EFI_INVALID_PARAMETER;
} }
if (!IsHiiHandleValid (PackageList)) { if (!IsHiiHandleValid (PackageList)) {