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

Minor grammatical work--mostly adding periods. Items with ONLY period added did not have the heading date changed, but Items with content changes had heading copyright dates updated. Sending separately a list of files missing Doxygen @param and @return information. (PENDING)

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10615 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
myronporter
2010-06-30 00:13:25 +00:00
parent 3b33c6d65d
commit 58380e9c61
62 changed files with 1190 additions and 979 deletions
Download Patch File Download Diff File Expand all files Collapse all files

153
MdePkg/Library/DxeServicesLib/DxeServicesLib.c
View File

@@ -40,7 +40,7 @@
@param ImageHandle The firmware allocated handle for UEFI image.
@retval EFI_HANDLE The device handle from which the Image is loaded from.
@retval EFI_HANDLE The device handle from which the Image is loaded from.
**/
EFI_HANDLE
@@ -88,18 +88,25 @@ InternalImageHandleToFvHandle (
If Buffer is NULL, then ASSERT();
If Size is NULL, then ASSERT().
@param FvHandle The device handle that contains a instance of EFI_FIRMWARE_VOLUME2_PROTOCOL instance.
@param FvHandle The device handle that contains a instance of
EFI_FIRMWARE_VOLUME2_PROTOCOL instance.
@param NameGuid The GUID name of a Firmware File.
@param SectionType The Firmware Section type.
@param SectionInstance The instance number of Firmware Section to read from starting from 0.
@param Buffer On output, Buffer contains the the data read from the section in the Firmware File found.
@param SectionInstance The instance number of Firmware Section to
read from starting from 0.
@param Buffer On output, Buffer contains the the data read
from the section in the Firmware File found.
@param Size On output, the size of Buffer.
@retval EFI_SUCCESS The image is found and data and size is returned.
@retval EFI_NOT_FOUND The image specified by NameGuid and SectionType can't be found.
@retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the output data buffer or complete the operations.
@retval EFI_DEVICE_ERROR A hardware error occurs during reading from the Firmware Volume.
@retval EFI_ACCESS_DENIED The firmware volume containing the searched Firmware File is configured to disallow reads.
@retval EFI_NOT_FOUND The image specified by NameGuid and SectionType
can't be found.
@retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the
output data buffer or complete the operations.
@retval EFI_DEVICE_ERROR A hardware error occurs during reading from the
Firmware Volume.
@retval EFI_ACCESS_DENIED The firmware volume containing the searched
Firmware File is configured to disallow reads.
**/
EFI_STATUS
@@ -187,22 +194,31 @@ InternalGetSectionFromFv (
If Buffer is NULL, then ASSERT().
If Size is NULL, then ASSERT().
@param FileType Indicates the FV file type to search for within all available FVs.
@param FileInstance Indicates which file instance within all available FVs specified by FileType.
@param FileType Indicates the FV file type to search for within all
available FVs.
@param FileInstance Indicates which file instance within all available
FVs specified by FileType.
FileInstance starts from zero.
@param SectionType Indicates the FFS section type to search for within the FFS file
@param SectionType Indicates the FFS section type to search for
within the FFS file
specified by FileType with FileInstance.
@param SectionInstance Indicates which section instance within the FFS file
specified by FileType with FileInstance to retrieve. SectionInstance starts from zero.
@param Buffer On output, a pointer to a callee allocated buffer containing the FFS file section that was found.
Is it the caller's responsibility to free this buffer using FreePool().
specified by FileType with FileInstance to retrieve.
SectionInstance starts from zero.
@param Buffer On output, a pointer to a callee allocated buffer
containing the FFS file section that was found.
Is it the caller's responsibility to free this
buffer using FreePool().
@param Size On output, a pointer to the size, in bytes, of Buffer.
@retval EFI_SUCCESS The specified FFS section was returned.
@retval EFI_NOT_FOUND The specified FFS section could not be found.
@retval EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve the matching FFS section.
@retval EFI_DEVICE_ERROR The FFS section could not be retrieves due to a device error.
@retval EFI_ACCESS_DENIED The FFS section could not be retrieves because the firmware volume that
@retval EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve
the matching FFS section.
@retval EFI_DEVICE_ERROR The FFS section could not be retrieves due to a
device error.
@retval EFI_ACCESS_DENIED The FFS section could not be retrieves because
the firmware volume that
contains the matching FFS section does not allow reads.
**/
EFI_STATUS
@@ -323,19 +339,26 @@ Done:
If Size is NULL, then ASSERT().
@param NameGuid A pointer to to the FFS filename GUID to search for within
any of the firmware volumes in the platform.
@param SectionType Indicates the FFS section type to search for within the FFS file specified by NameGuid.
@param SectionInstance Indicates which section instance within the FFS file specified by NameGuid to retrieve.
@param Buffer On output, a pointer to a callee allocated buffer containing the FFS file section that was found.
Is it the caller's responsibility to free this buffer using FreePool().
@param NameGuid A pointer to to the FFS filename GUID to search for
within any of the firmware volumes in the platform.
@param SectionType Indicates the FFS section type to search for within
the FFS file specified by NameGuid.
@param SectionInstance Indicates which section instance within the FFS file
specified by NameGuid to retrieve.
@param Buffer On output, a pointer to a callee allocated buffer
containing the FFS file section that was found.
Is it the caller's responsibility to free this buffer
using FreePool().
@param Size On output, a pointer to the size, in bytes, of Buffer.
@retval EFI_SUCCESS The specified FFS section was returned.
@retval EFI_NOT_FOUND The specified FFS section could not be found.
@retval EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve the matching FFS section.
@retval EFI_DEVICE_ERROR The FFS section could not be retrieves due to a device error.
@retval EFI_ACCESS_DENIED The FFS section could not be retrieves because the firmware volume that
@retval EFI_OUT_OF_RESOURCES There are not enough resources available to
retrieve the matching FFS section.
@retval EFI_DEVICE_ERROR The FFS section could not be retrieves due to a
device error.
@retval EFI_ACCESS_DENIED The FFS section could not be retrieves because the
firmware volume that
contains the matching FFS section does not allow reads.
**/
EFI_STATUS
@@ -440,21 +463,29 @@ Done:
If Buffer is NULL, then ASSERT().
If Size is NULL, then ASSERT().
@param NameGuid A pointer to to the FFS filename GUID to search for within
the firmware volumes that the currently executing module was loaded from.
@param SectionType Indicates the FFS section type to search for within the FFS file specified by NameGuid.
@param SectionInstance Indicates which section instance within the FFS file specified by NameGuid to retrieve.
@param Buffer On output, a pointer to a callee allocated buffer containing the FFS file section that was found.
Is it the caller's responsibility to free this buffer using FreePool().
@param NameGuid A pointer to to the FFS filename GUID to search for
within the firmware volumes that the currently
executing module was loaded from.
@param SectionType Indicates the FFS section type to search for within
the FFS file specified by NameGuid.
@param SectionInstance Indicates which section instance within the FFS file
specified by NameGuid to retrieve.
@param Buffer On output, a pointer to a callee allocated buffer
containing the FFS file section that was found.
Is it the caller's responsibility to free this buffer
using FreePool().
@param Size On output, a pointer to the size, in bytes, of Buffer.
@retval EFI_SUCCESS The specified FFS section was returned.
@retval EFI_NOT_FOUND The specified FFS section could not be found.
@retval EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve the matching FFS section.
@retval EFI_DEVICE_ERROR The FFS section could not be retrieves due to a device error.
@retval EFI_ACCESS_DENIED The FFS section could not be retrieves because the firmware volume that
contains the matching FFS section does not allow reads.
@retval EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve
the matching FFS section.
@retval EFI_DEVICE_ERROR The FFS section could not be retrieves due to a
device error.
@retval EFI_ACCESS_DENIED The FFS section could not be retrieves because the
firmware volume that contains the matching FFS
section does not allow reads.
**/
EFI_STATUS
EFIAPI
@@ -496,20 +527,27 @@ GetSectionFromFv (
If Size is NULL, then ASSERT().
@param SectionType Indicates the FFS section type to search for within the FFS file
that the currently executing module was loaded from.
@param SectionInstance Indicates which section instance to retrieve within the FFS file
that the currently executing module was loaded from.
@param Buffer On output, a pointer to a callee allocated buffer containing the FFS file section that was found.
Is it the caller's responsibility to free this buffer using FreePool().
@param SectionType Indicates the FFS section type to search for within
the FFS file that the currently executing module
was loaded from.
@param SectionInstance Indicates which section instance to retrieve within
the FFS file that the currently executing module
was loaded from.
@param Buffer On output, a pointer to a callee allocated buffer
containing the FFS file section that was found.
Is it the caller's responsibility to free this buffer
using FreePool().
@param Size On output, a pointer to the size, in bytes, of Buffer.
@retval EFI_SUCCESS The specified FFS section was returned.
@retval EFI_NOT_FOUND The specified FFS section could not be found.
@retval EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve the matching FFS section.
@retval EFI_DEVICE_ERROR The FFS section could not be retrieves due to a device error.
@retval EFI_ACCESS_DENIED The FFS section could not be retrieves because the firmware volume that
contains the matching FFS section does not allow reads.
@retval EFI_OUT_OF_RESOURCES There are not enough resources available to retrieve
the matching FFS section.
@retval EFI_DEVICE_ERROR The FFS section could not be retrieves due to a
device error.
@retval EFI_ACCESS_DENIED The FFS section could not be retrieves because the
firmware volume that contains the matching FFS
section does not allow reads.
**/
EFI_STATUS
@@ -544,17 +582,20 @@ GetSectionFromFfs (
If FileSize is NULL, then NULL is returned.
If AuthenticationStatus is NULL, then NULL is returned.
@param[in] BootPolicy Policy for Open Image File.If TRUE, indicates that the request
originates from the boot manager, and that the boot manager is
attempting to load FilePath as a boot selection. If FALSE,
then FilePath must match an exact file to be loaded.
@param[in] FilePath The pointer to the device path of the file that is absracted to
the file buffer.
@param[out] FileSize The pointer to the size of the abstracted file buffer.
@param[out] AuthenticationStatus The pointer to a caller-allocated UINT32 in which the authentication
status is returned.
@param[in] BootPolicy Policy for Open Image File.If TRUE, indicates
that the request originates from the boot
manager, and that the boot manager is
attempting to load FilePath as a boot
selection. If FALSE, then FilePath must
match an exact file to be loaded.
@param[in] FilePath The pointer to the device path of the file
that is absracted to the file buffer.
@param[out] FileSize The pointer to the size of the abstracted
file buffer.
@param[out] AuthenticationStatus The pointer to a caller-allocated UINT32
in which the authentication status is returned.
@retval NULL File is NULL, or FileSize is NULL. Or the file can't be found.
@retval NULL File is NULL, or FileSize is NULL. Or, the file can't be found.
@retval other The abstracted file buffer. The caller is responsible to free memory.
**/
VOID *