diff options
| author | myronporter <myronporter@6f19259b-4bc3-4df7-8a09-765794883524> | 2010-06-30 00:13:25 +0000 |
|---|---|---|
| committer | myronporter <myronporter@6f19259b-4bc3-4df7-8a09-765794883524> | 2010-06-30 00:13:25 +0000 |
| commit | 58380e9c6174f23df78f777b4209c0fd75245cda (patch) | |
| tree | a13a3c7c1bd697268c1742659d7148a5d76a55da /MdePkg/Library | |
| parent | 3b33c6d65d88da47fe059eff5cd92b39b6d0f42e (diff) | |
| download | edk2-platforms-58380e9c6174f23df78f777b4209c0fd75245cda.tar.xz | |
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)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10615 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg/Library')
62 files changed, 1191 insertions, 980 deletions
diff --git a/MdePkg/Library/BaseExtractGuidedSectionLib/BaseExtractGuidedSectionLib.c b/MdePkg/Library/BaseExtractGuidedSectionLib/BaseExtractGuidedSectionLib.c index ce289d2d6c..c3978c9b50 100644 --- a/MdePkg/Library/BaseExtractGuidedSectionLib/BaseExtractGuidedSectionLib.c +++ b/MdePkg/Library/BaseExtractGuidedSectionLib/BaseExtractGuidedSectionLib.c @@ -34,7 +34,7 @@ typedef struct { the registered guid and Handler list. When it is initialized, it will be directly returned.
Or, HandlerInfo table will be initialized in this function.
- @param[in, out] InfoPointer The pointer to the handler info structure.
+ @param[in, out] InfoPointer The pointer to the handler information structure.
@retval RETURN_SUCCESS HandlerInfo table can be used to store guid and function tables.
@retval RETURN_OUT_OF_RESOURCES HandlerInfo table address is not writable.
@@ -52,23 +52,23 @@ GetExtractGuidedSectionHandlerInfo ( HandlerInfo = (EXTRACT_GUIDED_SECTION_HANDLER_INFO*)(VOID*)(UINTN) PcdGet64 (PcdGuidedExtractHandlerTableAddress);
//
- // First check whether the handler info structure is initialized.
+ // First check whether the handler information structure is initialized.
//
if (HandlerInfo->Signature == EXTRACT_HANDLER_INFO_SIGNATURE) {
//
- // The handler info has been initialized and is returned.
+ // The handler information has been initialized and is returned.
//
*InfoPointer = HandlerInfo;
return RETURN_SUCCESS;
}
//
- // Try to initialize the handler info structure
+ // Try to initialize the handler information structure
//
HandlerInfo->Signature = EXTRACT_HANDLER_INFO_SIGNATURE;
if (HandlerInfo->Signature != EXTRACT_HANDLER_INFO_SIGNATURE) {
//
- // The handler info structure was not writeable because the memory is not ready.
+ // The handler information structure was not writeable because the memory is not ready.
//
*InfoPointer = NULL;
return RETURN_OUT_OF_RESOURCES;
@@ -284,7 +284,7 @@ ExtractGuidedSectionGetInfo ( for (Index = 0; Index < HandlerInfo->NumberOfExtractHandler; Index ++) {
if (CompareGuid (HandlerInfo->ExtractHandlerGuidTable + Index, &(((EFI_GUID_DEFINED_SECTION *) InputSection)->SectionDefinitionGuid))) {
//
- // Call the match handler to get info for the input section data.
+ // Call the match handler to get information for the input section data.
//
return HandlerInfo->ExtractGetInfoHandlerTable [Index] (
InputSection,
diff --git a/MdePkg/Library/BasePcdLibNull/PcdLib.c b/MdePkg/Library/BasePcdLibNull/PcdLib.c index ad1dcf63e6..4823f5ad67 100644 --- a/MdePkg/Library/BasePcdLibNull/PcdLib.c +++ b/MdePkg/Library/BasePcdLibNull/PcdLib.c @@ -404,7 +404,7 @@ LibPcdGetExSize ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 8-bit value to set.
- @return Return the value been set.
+ @return Return the value that was set.
**/
UINT8
@@ -430,7 +430,7 @@ LibPcdSet8 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 16-bit value to set.
- @return Return the value been set.
+ @return Return the value that was set.
**/
UINT16
@@ -456,7 +456,7 @@ LibPcdSet16 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 32-bit value to set.
- @return Return the value been set.
+ @return Return the value that was set.
**/
UINT32
@@ -482,7 +482,7 @@ LibPcdSet32 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 64-bit value to set.
- @return Return the value been set.
+ @return Return the value that was set.
**/
UINT64
@@ -545,7 +545,7 @@ LibPcdSetPtr ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The boolean value to set.
- @return Return the value been set.
+ @return Return the value that was set.
**/
BOOLEAN
@@ -575,7 +575,7 @@ LibPcdSetBool ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 8-bit value to set.
- @return Return the value been set.
+ @return Return the value that was set.
**/
UINT8
@@ -606,7 +606,7 @@ LibPcdSetEx8 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 16-bit value to set.
- @return Return the value been set.
+ @return Return the value that was set.
**/
UINT16
@@ -637,7 +637,7 @@ LibPcdSetEx16 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 32-bit value to set.
- @return Return the value been set.
+ @return Return the value that was set.
**/
UINT32
@@ -667,7 +667,7 @@ LibPcdSetEx32 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 64-bit value to set.
- @return Return the value been set.
+ @return Return the value that was set.
**/
UINT64
@@ -736,7 +736,7 @@ LibPcdSetExPtr ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The Boolean value to set.
- @return Return the value been set.
+ @return Return the value that was set.
**/
BOOLEAN
diff --git a/MdePkg/Library/BasePeCoffLib/BasePeCoff.c b/MdePkg/Library/BasePeCoffLib/BasePeCoff.c index af8af8a0a8..7337bc359a 100644 --- a/MdePkg/Library/BasePeCoffLib/BasePeCoff.c +++ b/MdePkg/Library/BasePeCoffLib/BasePeCoff.c @@ -270,7 +270,7 @@ PeCoffLoaderGetImageInfo ( // Obviously having base relocations with RELOCS_STRIPPED==1 is invalid.
//
// Look at the file header to determine if relocations have been stripped, and
- // save this info in the image context for later use.
+ // save this information in the image context for later use.
//
if ((!(ImageContext->IsTeImage)) && ((Hdr.Pe32->FileHeader.Characteristics & EFI_IMAGE_FILE_RELOCS_STRIPPED) != 0)) {
ImageContext->RelocationsStripped = TRUE;
@@ -831,7 +831,7 @@ PeCoffLoaderLoadImage ( ImageContext->ImageError = IMAGE_ERROR_SUCCESS;
//
- // Copy the provided context info into our local version, get what we
+ // Copy the provided context information into our local version, get what we
// can from the original image, and then use that to make sure everything
// is legit.
//
@@ -1079,7 +1079,7 @@ PeCoffLoaderLoadImage ( ImageContext->FixupData = NULL;
//
- // Load the Codeview info if present
+ // Load the Codeview information if present
//
if (ImageContext->DebugDirectoryEntryRva != 0) {
if (!(ImageContext->IsTeImage)) {
diff --git a/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLib.c b/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLib.c index cd5d8c8d8b..15c3325cd4 100644 --- a/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLib.c +++ b/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLib.c @@ -27,7 +27,7 @@ Shift mBitBuf NumOfBits left. Read in NumOfBits of bits from source.
- @param Sd The global scratch data
+ @param Sd The global scratch data.
@param NumOfBits The number of bits to shift and read.
**/
@@ -119,10 +119,10 @@ GetBits ( and Position Set according to code length array.
If TableBits > 16, then ASSERT ().
- @param Sd The global scratch data
- @param NumOfChar The number of symbols in the symbol set
- @param BitLen Code length array
- @param TableBits The width of the mapping table
+ @param Sd The global scratch data.
+ @param NumOfChar The number of symbols in the symbol set.
+ @param BitLen Code length array.
+ @param TableBits The width of the mapping table.
@param Table The table to be created.
@retval 0 OK.
@@ -262,7 +262,7 @@ MakeTable ( Get a position value according to Position Huffman Table.
- @param Sd the global scratch data
+ @param Sd The global scratch data.
@return The position value decoded.
@@ -401,7 +401,7 @@ ReadPTLen ( Read in and decode the Char&Len Set Code Length Array, then
generate the Huffman Code mapping table for the Char&Len Set.
- @param Sd the global scratch data
+ @param Sd The global scratch data.
**/
VOID
@@ -561,7 +561,7 @@ DecodeC ( /**
Decode the source data and put the resulting data into the destination buffer.
- @param Sd The global scratch data
+ @param Sd The global scratch data.
**/
VOID
@@ -659,13 +659,13 @@ Done: @param SourceSize The size, in bytes, of the source buffer.
@param DestinationSize A pointer to the size, in bytes, of the uncompressed buffer
that will be generated when the compressed buffer specified
- by Source and SourceSize is decompressed..
+ by Source and SourceSize is decompressed.
@param ScratchSize A pointer to the size, in bytes, of the scratch buffer that
is required to decompress the compressed buffer specified
by Source and SourceSize.
@retval RETURN_SUCCESS The size of the uncompressed data was returned
- in DestinationSize and the size of the scratch
+ in DestinationSize, and the size of the scratch
buffer was returned in ScratchSize.
@retval RETURN_INVALID_PARAMETER
The size of the uncompressed data or the size of
@@ -721,7 +721,7 @@ UefiDecompressGetInfo ( If the required scratch buffer size > 0 and Scratch is NULL, then ASSERT().
@param Source The source buffer containing the compressed data.
- @param Destination The destination buffer to store the decompressed data
+ @param Destination The destination buffer to store the decompressed data.
@param Scratch A temporary scratch buffer that is used to perform the decompression.
This is an optional parameter that may be NULL if the
required scratch buffer size is 0.
diff --git a/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLibInternals.h b/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLibInternals.h index 8e5143db7d..358c598c04 100644 --- a/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLibInternals.h +++ b/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLibInternals.h @@ -63,7 +63,7 @@ typedef struct { ///
/// The length of the field 'Position Set Code Length Array Size' in Block Header.
- /// For UEFI 2.0 de/compression algorithm, mPBit = 4
+ /// For UEFI 2.0 de/compression algorithm, mPBit = 4.
///
UINT8 mPBit;
} SCRATCH_DATA;
@@ -73,7 +73,7 @@ typedef struct { Shift mBitBuf NumOfBits left. Read in NumOfBits of bits from source.
- @param Sd The global scratch data
+ @param Sd The global scratch data.
@param NumOfBits The number of bits to shift and read.
**/
@@ -109,10 +109,10 @@ GetBits ( and Position Set according to code length array.
If TableBits > 16, then ASSERT ().
- @param Sd The global scratch data
- @param NumOfChar The number of symbols in the symbol set
- @param BitLen Code length array
- @param TableBits The width of the mapping table
+ @param Sd The global scratch data.
+ @param NumOfChar The number of symbols in the symbol set.
+ @param BitLen Code length array.
+ @param TableBits The width of the mapping table.
@param Table The table to be created.
@retval 0 OK.
@@ -133,7 +133,7 @@ MakeTable ( Get a position value according to Position Huffman Table.
- @param Sd the global scratch data
+ @param Sd The global scratch data.
@return The position value decoded.
@@ -172,7 +172,7 @@ ReadPTLen ( Read in and decode the Char&Len Set Code Length Array, then
generate the Huffman Code mapping table for the Char&Len Set.
- @param Sd the global scratch data
+ @param Sd The global scratch data.
**/
VOID
@@ -200,7 +200,7 @@ DecodeC ( /**
Decode the source data and put the resulting data into the destination buffer.
- @param Sd The global scratch data
+ @param Sd The global scratch data.
**/
VOID
diff --git a/MdePkg/Library/DxeCoreEntryPoint/DxeCoreEntryPoint.c b/MdePkg/Library/DxeCoreEntryPoint/DxeCoreEntryPoint.c index e2ffd3ff89..d3d8c4c47c 100644 --- a/MdePkg/Library/DxeCoreEntryPoint/DxeCoreEntryPoint.c +++ b/MdePkg/Library/DxeCoreEntryPoint/DxeCoreEntryPoint.c @@ -5,7 +5,7 @@ Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR> This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
-http://opensource.org/licenses/bsd-license.php
+http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
diff --git a/MdePkg/Library/DxeCoreHobLib/HobLib.c b/MdePkg/Library/DxeCoreHobLib/HobLib.c index 5ffaf069fc..9fdb2b448a 100644 --- a/MdePkg/Library/DxeCoreHobLib/HobLib.c +++ b/MdePkg/Library/DxeCoreHobLib/HobLib.c @@ -5,7 +5,7 @@ Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR> This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
-http://opensource.org/licenses/bsd-license.php
+http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@@ -116,10 +116,10 @@ GetFirstHob ( This function searches the first instance of a HOB from the starting HOB pointer.
Such HOB should satisfy two conditions:
- its HOB type is EFI_HOB_TYPE_GUID_EXTENSION and its GUID Name equals to the input Guid.
- If there does not exist such HOB from the starting HOB pointer, it will return NULL.
+ its HOB type is EFI_HOB_TYPE_GUID_EXTENSION, and its GUID Name equals to the input Guid.
+ If such a HOB from the starting HOB pointer does not exist, it will return NULL.
Caller is required to apply GET_GUID_HOB_DATA () and GET_GUID_HOB_DATA_SIZE ()
- to extract the data section and its size info respectively.
+ to extract the data section and its size information, respectively.
In contrast with macro GET_NEXT_HOB(), this function does not skip the starting HOB pointer
unconditionally: it returns HobStart back if HobStart itself meets the requirement;
caller is required to use GET_NEXT_HOB() if it wishes to skip current HobStart.
@@ -158,9 +158,9 @@ GetNextGuidHob ( This function searches the first instance of a HOB among the whole HOB list.
Such HOB should satisfy two conditions:
its HOB type is EFI_HOB_TYPE_GUID_EXTENSION and its GUID Name equals to the input Guid.
- If there does not exist such HOB from the starting HOB pointer, it will return NULL.
+ If such a HOB from the starting HOB pointer does not exist, it will return NULL.
Caller is required to apply GET_GUID_HOB_DATA () and GET_GUID_HOB_DATA_SIZE ()
- to extract the data section and its size info respectively.
+ to extract the data section and its size information, respectively.
If the pointer to the HOB list is NULL, then ASSERT().
If Guid is NULL, then ASSERT().
@@ -213,7 +213,7 @@ GetBootModeHob ( This function builds a HOB for a loaded PE32 module.
It can only be invoked during PEI phase;
- for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
+ for DXE phase, it will ASSERT() because PEI HOB is read-only for DXE phase.
If ModuleName is NULL, then ASSERT().
If there is no additional space for HOB creation, then ASSERT().
@@ -244,7 +244,7 @@ BuildModuleHob ( This function builds a HOB that describes a chunk of system memory.
It can only be invoked during PEI phase;
- for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
+ for DXE phase, it will ASSERT() because PEI HOB is read-only for DXE phase.
If there is no additional space for HOB creation, then ASSERT().
@@ -276,8 +276,8 @@ BuildResourceDescriptorHob ( This function builds a customized HOB tagged with a GUID for identification
and returns the start address of GUID HOB data so that caller can fill the customized data.
The HOB Header and Name field is already stripped.
- It can only be invoked during PEI phase;
- for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
+ It can only be invoked during PEI phase.
+ For DXE phase, it will ASSERT() because PEI HOB is read-only for DXE phase.
If Guid is NULL, then ASSERT().
If there is no additional space for HOB creation, then ASSERT().
@@ -309,10 +309,10 @@ BuildGuidHob ( This function builds a customized HOB tagged with a GUID for identification and copies the input
data to the HOB data field and returns the start address of the GUID HOB data. It can only be
- invoked during PEI phase; for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
+ invoked during PEI phase; for DXE phase, it will ASSERT() because PEI HOB is read-only for DXE phase.
The HOB Header and Name field is already stripped.
- It can only be invoked during PEI phase;
- for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
+ It can only be invoked during PEI phase.
+ For DXE phase, it will ASSERT() because PEI HOB is read-only for DXE phase.
If Guid is NULL, then ASSERT().
If Data is NULL and DataLength > 0, then ASSERT().
@@ -346,7 +346,7 @@ BuildGuidDataHob ( This function builds a Firmware Volume HOB.
It can only be invoked during PEI phase;
- for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
+ for DXE phase, it will ASSERT() because PEI HOB is read-only for DXE phase.
If there is no additional space for HOB creation, then ASSERT().
@@ -372,7 +372,7 @@ BuildFvHob ( This function builds a EFI_HOB_TYPE_FV2 HOB.
It can only be invoked during PEI phase;
- for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
+ for DXE phase, it will ASSERT() because PEI HOB is read-only for DXE phase.
If there is no additional space for HOB creation, then ASSERT().
@@ -399,7 +399,7 @@ BuildFv2Hob ( This function builds a Capsule Volume HOB.
It can only be invoked during PEI phase;
- for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
+ for DXE phase, it will ASSERT() because PEI HOB is read-only for DXE phase.
If the platform does not support Capsule Volume HOBs, then ASSERT().
If there is no additional space for HOB creation, then ASSERT().
@@ -426,7 +426,7 @@ BuildCvHob ( This function builds a HOB for the CPU.
It can only be invoked during PEI phase;
- for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
+ for DXE phase, it will ASSERT() because PEI HOB is read-only for DXE phase.
If there is no additional space for HOB creation, then ASSERT().
@@ -452,7 +452,7 @@ BuildCpuHob ( This function builds a HOB for the stack.
It can only be invoked during PEI phase;
- for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
+ for DXE phase, it will ASSERT() because PEI HOB is read-only for DXE phase.
If there is no additional space for HOB creation, then ASSERT().
@@ -478,7 +478,7 @@ BuildStackHob ( This function builds a HOB for BSP store.
It can only be invoked during PEI phase;
- for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
+ for DXE phase, it will ASSERT() because PEI HOB is read-only for DXE phase.
If there is no additional space for HOB creation, then ASSERT().
@@ -506,7 +506,7 @@ BuildBspStoreHob ( This function builds a HOB for the memory allocation.
It can only be invoked during PEI phase;
- for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase.
+ for DXE phase, it will ASSERT() because PEI HOB is read-only for DXE phase.
If there is no additional space for HOB creation, then ASSERT().
diff --git a/MdePkg/Library/DxeExtractGuidedSectionLib/DxeExtractGuidedSectionLib.c b/MdePkg/Library/DxeExtractGuidedSectionLib/DxeExtractGuidedSectionLib.c index c9cb612835..1587e872fa 100644 --- a/MdePkg/Library/DxeExtractGuidedSectionLib/DxeExtractGuidedSectionLib.c +++ b/MdePkg/Library/DxeExtractGuidedSectionLib/DxeExtractGuidedSectionLib.c @@ -1,7 +1,7 @@ /** @file
Provide generic extract guided section functions for Dxe phase.
- Copyright (c) 2007 - 2008, Intel Corporation. All rights reserved.<BR>
+ Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
@@ -31,8 +31,8 @@ EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER *mExtractGetInfoHandlerTable = NULL; /**
Reallocates more global memory to store the registered guid and Handler list.
- @retval RETURN_SUCCESS Reallocate more global memory space to store guid and function tables.
- @retval RETURN_OUT_OF_RESOURCES No enough memory to allocated.
+ @retval RETURN_SUCCESS Reallocated more global memory space to store guid and function tables.
+ @retval RETURN_OUT_OF_RESOURCES Not enough memory to allocate.
**/
RETURN_STATUS
EFIAPI
@@ -103,8 +103,8 @@ Done: @param ImageHandle The firmware allocated handle for the EFI image.
@param SystemTable A pointer to the EFI System Table.
- @retval RETURN_SUCCESS Allocate the global memory space to store guid and function tables.
- @retval RETURN_OUT_OF_RESOURCES No enough memory to allocated.
+ @retval RETURN_SUCCESS Allocated the global memory space to store guid and function tables.
+ @retval RETURN_OUT_OF_RESOURCES Not enough memory to allocate.
**/
RETURN_STATUS
EFIAPI
@@ -127,7 +127,7 @@ DxeExtractGuidedSectionLibConstructor ( @param[out] ExtractHandlerGuidTable A pointer to the array of GUIDs that have been registered through
ExtractGuidedSectionRegisterHandlers().
- @return the number of the supported extract guided Handler.
+ @return The number of the supported extract guided Handler.
**/
UINTN
@@ -242,7 +242,7 @@ ExtractGuidedSectionRegisterHandlers ( @param[out] SectionAttribute A pointer to the attributes of the GUIDed section. See the Attributes field of
EFI_GUID_DEFINED_SECTION in the PI Specification.
- @retval RETURN_SUCCESS Get the required information successfully.
+ @retval RETURN_SUCCESS Successfully obtained the required information.
@retval RETURN_UNSUPPORTED The GUID from the section specified by InputSection does not match any of
the GUIDs registered with ExtractGuidedSectionRegisterHandlers().
@retval Others The return status from the handler associated with the GUID retrieved from
diff --git a/MdePkg/Library/DxeHobLib/HobLib.c b/MdePkg/Library/DxeHobLib/HobLib.c index e01dc80c62..dfd4bed67a 100644 --- a/MdePkg/Library/DxeHobLib/HobLib.c +++ b/MdePkg/Library/DxeHobLib/HobLib.c @@ -152,7 +152,7 @@ GetFirstHob ( its HOB type is EFI_HOB_TYPE_GUID_EXTENSION and its GUID Name equals to the input Guid.
If there does not exist such HOB from the starting HOB pointer, it will return NULL.
Caller is required to apply GET_GUID_HOB_DATA () and GET_GUID_HOB_DATA_SIZE ()
- to extract the data section and its size info respectively.
+ to extract the data section and its size information, respectively.
In contrast with macro GET_NEXT_HOB(), this function does not skip the starting HOB pointer
unconditionally: it returns HobStart back if HobStart itself meets the requirement;
caller is required to use GET_NEXT_HOB() if it wishes to skip current HobStart.
@@ -193,7 +193,7 @@ GetNextGuidHob ( its HOB type is EFI_HOB_TYPE_GUID_EXTENSION and its GUID Name equals to the input Guid.
If there does not exist such HOB from the starting HOB pointer, it will return NULL.
Caller is required to apply GET_GUID_HOB_DATA () and GET_GUID_HOB_DATA_SIZE ()
- to extract the data section and its size info respectively.
+ to extract the data section and its size information, respectively.
If the pointer to the HOB list is NULL, then ASSERT().
If Guid is NULL, then ASSERT().
diff --git a/MdePkg/Library/DxeIoLibCpuIo2/IoHighLevel.c b/MdePkg/Library/DxeIoLibCpuIo2/IoHighLevel.c index aeeec98f8a..29d4af58d6 100644 --- a/MdePkg/Library/DxeIoLibCpuIo2/IoHighLevel.c +++ b/MdePkg/Library/DxeIoLibCpuIo2/IoHighLevel.c @@ -1237,7 +1237,7 @@ MmioAndThenOr8 ( If EndBit is greater than 7, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to read.
+ @param Address The MMIO register to read.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..7.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1269,7 +1269,7 @@ MmioBitFieldRead8 ( If EndBit is greater than 7, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..7.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1310,7 +1310,7 @@ MmioBitFieldWrite8 ( If EndBit is greater than 7, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..7.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1351,7 +1351,7 @@ MmioBitFieldOr8 ( If EndBit is greater than 7, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..7.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1393,7 +1393,7 @@ MmioBitFieldAnd8 ( If EndBit is greater than 7, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..7.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1519,7 +1519,7 @@ MmioAndThenOr16 ( If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to read.
+ @param Address The MMIO register to read.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..15.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1551,7 +1551,7 @@ MmioBitFieldRead16 ( If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..15.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1592,7 +1592,7 @@ MmioBitFieldWrite16 ( If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..15.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1633,7 +1633,7 @@ MmioBitFieldOr16 ( If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..15.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1675,7 +1675,7 @@ MmioBitFieldAnd16 ( If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..15.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1801,7 +1801,7 @@ MmioAndThenOr32 ( If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to read.
+ @param Address The MMIO register to read.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..31.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1833,7 +1833,7 @@ MmioBitFieldRead32 ( If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..31.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1874,7 +1874,7 @@ MmioBitFieldWrite32 ( If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..31.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1915,7 +1915,7 @@ MmioBitFieldOr32 ( If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..31.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1957,7 +1957,7 @@ MmioBitFieldAnd32 ( If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..31.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -2083,7 +2083,7 @@ MmioAndThenOr64 ( If EndBit is greater than 63, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to read.
+ @param Address The MMIO register to read.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..63.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -2115,7 +2115,7 @@ MmioBitFieldRead64 ( If EndBit is greater than 63, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..63.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -2156,7 +2156,7 @@ MmioBitFieldWrite64 ( If EndBit is greater than 63, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..63.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -2197,7 +2197,7 @@ MmioBitFieldOr64 ( If EndBit is greater than 63, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..63.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -2239,7 +2239,7 @@ MmioBitFieldAnd64 ( If EndBit is greater than 63, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..63.
@param EndBit The ordinal of the most significant bit in the bit field.
diff --git a/MdePkg/Library/DxeIoLibCpuIo2/IoLibMmioBuffer.c b/MdePkg/Library/DxeIoLibCpuIo2/IoLibMmioBuffer.c index 82afc17e38..9e14c258c6 100644 --- a/MdePkg/Library/DxeIoLibCpuIo2/IoLibMmioBuffer.c +++ b/MdePkg/Library/DxeIoLibCpuIo2/IoLibMmioBuffer.c @@ -74,7 +74,7 @@ MmioReadBuffer8 ( @param Length The size in bytes of the copy.
@param Buffer The pointer to a system memory buffer receiving the data read.
- @return Buffer
+ @return Buffer.
**/
UINT16 *
@@ -125,7 +125,7 @@ MmioReadBuffer16 ( @param Length The size in bytes of the copy.
@param Buffer The pointer to a system memory buffer receiving the data read.
- @return Buffer
+ @return Buffer.
**/
UINT32 *
@@ -177,7 +177,7 @@ MmioReadBuffer32 ( @param Length The size in bytes of the copy.
@param Buffer The pointer to a system memory buffer receiving the data read.
- @return Buffer
+ @return Buffer.
**/
UINT64 *
@@ -222,10 +222,10 @@ MmioReadBuffer64 ( @param StartAddress The starting address for the MMIO region to be copied to.
- @param Length The size in bytes of the copy.
+ @param Length The size in bytes of the copy.
@param Buffer The pointer to a system memory buffer containing the data to write.
- @return Buffer
+ @return Buffer.
**/
UINT8 *
@@ -268,10 +268,10 @@ MmioWriteBuffer8 ( If Buffer is not aligned on a 16-bit boundary, then ASSERT().
@param StartAddress The starting address for the MMIO region to be copied to.
- @param Length The size in bytes of the copy.
+ @param Length The size in bytes of the copy.
@param Buffer The pointer to a system memory buffer containing the data to write.
- @return Buffer
+ @return Buffer.
**/
UINT16 *
@@ -322,10 +322,10 @@ MmioWriteBuffer16 ( If Buffer is not aligned on a 32-bit boundary, then ASSERT().
@param StartAddress The starting address for the MMIO region to be copied to.
- @param Length The size in bytes of the copy.
+ @param Length The size in bytes of the copy.
@param Buffer The pointer to a system memory buffer containing the data to write.
- @return Buffer
+ @return Buffer.
**/
UINT32 *
@@ -375,10 +375,10 @@ MmioWriteBuffer32 ( If Buffer is not aligned on a 64-bit boundary, then ASSERT().
@param StartAddress The starting address for the MMIO region to be copied to.
- @param Length The size in bytes of the copy.
+ @param Length The size in bytes of the copy.
@param Buffer The pointer to a system memory buffer containing the data to write.
- @return Buffer
+ @return Buffer.
**/
UINT64 *
diff --git a/MdePkg/Library/DxePcdLib/DxePcdLib.c b/MdePkg/Library/DxePcdLib/DxePcdLib.c index 958f58a0d6..3ab27f4483 100644 --- a/MdePkg/Library/DxePcdLib/DxePcdLib.c +++ b/MdePkg/Library/DxePcdLib/DxePcdLib.c @@ -444,7 +444,7 @@ LibPcdGetExSize ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 8-bit value to set.
- @return Return the value been set.
+ @return Return the value that was set.
**/
UINT8
@@ -475,7 +475,7 @@ LibPcdSet8 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 16-bit value to set.
- @return Return the value been set.
+ @return Return the value that was set.
**/
UINT16
@@ -506,7 +506,7 @@ LibPcdSet16 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 32-bit value to set.
- @return Return the value been set.
+ @return Return the value that was set.
**/
UINT32
@@ -537,7 +537,7 @@ LibPcdSet32 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 64-bit value to set.
- @return Return the value been set.
+ @return Return the value that was set.
**/
UINT64
@@ -618,7 +618,7 @@ LibPcdSetPtr ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The boolean value to set.
- @return Return the value been set.
+ @return Return the value that was set.
**/
BOOLEAN
@@ -653,7 +653,7 @@ LibPcdSetBool ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 8-bit value to set.
- @return Return the value been set.
+ @return Return the value that was set.
**/
UINT8
@@ -690,7 +690,7 @@ LibPcdSetEx8 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 16-bit value to set.
- @return Return the value been set.
+ @return Return the value that was set.
**/
UINT16
@@ -727,7 +727,7 @@ LibPcdSetEx16 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 32-bit value to set.
- @return Return the value been set.
+ @return Return the value that was set.
**/
UINT32
@@ -763,7 +763,7 @@ LibPcdSetEx32 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 64-bit value to set.
- @return Return the value been set.
+ @return Return the value that was set.
**/
UINT64
@@ -852,7 +852,7 @@ LibPcdSetExPtr ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The Boolean value to set.
- @return Return the value been set.
+ @return Return the value that was set.
**/
BOOLEAN
@@ -992,7 +992,7 @@ LibPcdGetNextToken ( If TokenSpaceGuid is NULL, then a pointer to the first PCD token spaces returned.
If TokenSpaceGuid is the last PCD token space GUID in the list, then NULL is returned.
- @param TokenSpaceGuid The pointer to the a PCD token space GUID
+ @param TokenSpaceGuid The pointer to the a PCD token space GUID.
@return The next valid token namespace.
diff --git a/MdePkg/Library/DxeRuntimePciExpressLib/PciExpressLib.c b/MdePkg/Library/DxeRuntimePciExpressLib/PciExpressLib.c index 2ca30dd598..fc276d583e 100644 --- a/MdePkg/Library/DxeRuntimePciExpressLib/PciExpressLib.c +++ b/MdePkg/Library/DxeRuntimePciExpressLib/PciExpressLib.c @@ -5,7 +5,7 @@ All assertions for I/O operations are handled in MMIO functions in the IoLib
Library.
- Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>
+ Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
@@ -45,22 +45,22 @@ typedef struct { EFI_EVENT mDxeRuntimePciExpressLibVirtualNotifyEvent = NULL;
///
-/// Module global that contains the base physical address of the PCI Express MMIO range
+/// Module global that contains the base physical address of the PCI Express MMIO range.
///
UINTN mDxeRuntimePciExpressLibPciExpressBaseAddress = 0;
///
-/// The number of PCI devices that have been registered for runtime access
+/// The number of PCI devices that have been registered for runtime access.
///
UINTN mDxeRuntimePciExpressLibNumberOfRuntimeRanges = 0;
///
-/// The table of PCI devices that have been registered for runtime access
+/// The table of PCI devices that have been registered for runtime access.
///
PCI_EXPRESS_RUNTIME_REGISTRATION_TABLE *mDxeRuntimePciExpressLibRegistrationTable = NULL;
///
-/// The table index of the most recent virtual address lookup
+/// The table index of the most recent virtual address lookup.
///
UINTN mDxeRuntimePciExpressLibLastRuntimeRange = 0;
@@ -69,8 +69,8 @@ UINTN mDxeRuntimePciExpressLibLastRuntimeRange Convert the physical PCI Express MMIO addresses for all registered PCI devices
to virtual addresses.
- @param[in] Event The Event that is being processed
- @param[in] Context Event Context
+ @param[in] Event The event that is being processed.
+ @param[in] Context The Event Context.
**/
VOID
EFIAPI
diff --git a/MdePkg/Library/DxeServicesLib/DxeServicesLib.c b/MdePkg/Library/DxeServicesLib/DxeServicesLib.c index dc45b99845..d8e6b5cc4e 100644 --- a/MdePkg/Library/DxeServicesLib/DxeServicesLib.c +++ b/MdePkg/Library/DxeServicesLib/DxeServicesLib.c @@ -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.
-
- @retval NULL File is NULL, or FileSize is NULL. Or the file can't be found.
+ @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 other The abstracted file buffer. The caller is responsible to free memory.
**/
VOID *
diff --git a/MdePkg/Library/DxeSmbusLib/DxeSmbusLib.c b/MdePkg/Library/DxeSmbusLib/DxeSmbusLib.c index ab3bd47aa0..985085c136 100644 --- a/MdePkg/Library/DxeSmbusLib/DxeSmbusLib.c +++ b/MdePkg/Library/DxeSmbusLib/DxeSmbusLib.c @@ -1,11 +1,11 @@ /** @file
Implementation of SmBusLib class library for DXE phase.
-Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
-http://opensource.org/licenses/bsd-license.php
+http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@@ -57,14 +57,16 @@ SmbusLibConstructor ( as defined in the SmBus Specification. The data can either be of
the Length byte, word, or a block of data.
- @param SmbusOperation Signifies which particular SMBus hardware protocol instance that it will use to
- execute the SMBus transactions.
+ @param SmbusOperation Signifies which particular SMBus hardware protocol instance
+ that it will use to execute the SMBus transactions.
@param SmBusAddress The address that encodes the SMBUS Slave Address,
SMBUS Command, SMBUS Data Length, and PEC.
- @param Length Signifies the number of bytes that this operation will do. The maximum number of
- bytes can be revision specific and operation specific.
- @param Buffer Contains the value of data to execute to the SMBus slave device. Not all operations
- require this argument. The length of this buffer is identified by Length.
+ @param Length Signifies the number of bytes that this operation will do.
+ The maximum number of bytes can be revision specific
+ and operation specific.
+ @param Buffer Contains the value of data to execute to the SMBus slave
+ device. Not all operations require this argument. The
+ length of this buffer is identified by Length.
@param Status Return status for the executed command.
This is an optional parameter and may be NULL.
diff --git a/MdePkg/Library/DxeSmbusLib/InternalSmbusLib.h b/MdePkg/Library/DxeSmbusLib/InternalSmbusLib.h index 203ca50855..da7e58fc78 100644 --- a/MdePkg/Library/DxeSmbusLib/InternalSmbusLib.h +++ b/MdePkg/Library/DxeSmbusLib/InternalSmbusLib.h @@ -1,11 +1,11 @@ /** @file
Internal header file for Smbus library.
-Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
-http://opensource.org/licenses/bsd-license.php
+http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@@ -38,14 +38,16 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. as defined in the SmBus Specification. The data can either be of
the Length byte, word, or a block of data.
- @param SmbusOperation Signifies which particular SMBus hardware protocol instance that it will use to
- execute the SMBus transactions.
+ @param SmbusOperation Signifies which particular SMBus hardware protocol instance
+ that it will use toexecute the SMBus transactions.
@param SmBusAddress The address that encodes the SMBUS Slave Address,
SMBUS Command, SMBUS Data Length, and PEC.
- @param Length Signifies the number of bytes that this operation will do. The maximum number of
- bytes can be revision specific and operation specific.
- @param Buffer Contains the value of data to execute to the SMBus slave device. Not all operations
- require this argument. The length of this buffer is identified by Length.
+ @param Length Signifies the number of bytes that this operation will
+ do. The maximum number of bytes can be revision specific
+ and operation specific.
+ @param Buffer Contains the value of data to execute to the SMBus slave
+ device. Not all operations require this argument. The
+ length of this buffer is identified by Length.
@param Status Return status for the executed command.
This is an optional parameter and may be NULL.
diff --git a/MdePkg/Library/DxeSmbusLib/SmbusLib.c b/MdePkg/Library/DxeSmbusLib/SmbusLib.c index 58733e6ee4..fe1a0944dc 100644 --- a/MdePkg/Library/DxeSmbusLib/SmbusLib.c +++ b/MdePkg/Library/DxeSmbusLib/SmbusLib.c @@ -1,11 +1,11 @@ /** @file
Implementation of SmBusLib class library for DXE phase.
-Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
-http://opensource.org/licenses/bsd-license.php
+http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@@ -30,13 +30,15 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. SMBUS Command, SMBUS Data Length, and PEC.
@param Status Return status for the executed command.
This is an optional parameter and may be NULL.
- RETURN_SUCCESS The SMBUS command was executed.
- RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.
- RETURN_DEVICE_ERROR The request was not completed because a failure
- reflected in the Host Status Register bit. Device errors are a result
- of a transaction collision, illegal command field, unclaimed cycle
- (host initiated), or bus errors (collisions).
- RETURN_UNSUPPORTED The SMBus operation is not supported.
+ RETURN_SUCCESS: The SMBUS command was executed.
+ RETURN_TIMEOUT: A timeout occurred while executing the
+ SMBUS command.
+ RETURN_DEVICE_ERROR: The request was not
+ completed because a failure reflected in the Host Status
+ Register bit. Device errors are a result of a transaction
+ collision, illegal command field, unclaimed cycle (host
+ initiated), or bus errors (collisions).
+ RETURN_UNSUPPORTED: The SMBus operation is not supported.
**/
VOID
@@ -69,13 +71,15 @@ SmBusQuickRead ( SMBUS Command, SMBUS Data Length, and PEC.
@param Status Return status for the executed command.
This is an optional parameter and may be NULL.
- RETURN_SUCCESS The SMBUS command was executed.
- RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.
- RETURN_DEVICE_ERROR The request was not completed because a failure
- reflected in the Host Status Register bit. Device errors are a result
- of a transaction collision, illegal command field, unclaimed cycle
- (host initiated), or bus errors (collisions).
- RETURN_UNSUPPORTED The SMBus operation is not supported.
+ RETURN_SUCCESS: The SMBUS command was executed.
+ RETURN_TIMEOUT: A timeout occurred while executing the
+ SMBUS command.
+ RETURN_DEVICE_ERROR: The request was not completed because
+ a failure reflected in the Host Status Register bit.
+ Device errors are a result of a transaction collision,
+ illegal command field, unclaimed cycle (host initiated),
+ or bus errors (collisions).
+ RETURN_UNSUPPORTED: The SMBus operation is not supported.
**/
VOID
@@ -108,14 +112,16 @@ SmBusQuickWrite ( SMBUS Command, SMBUS Data Length, and PEC.
@param Status Return status for the executed command.
This is an optional parameter and may be NULL.
- RETURN_SUCCESS The SMBUS command was executed.
- RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.
- RETURN_DEVICE_ERROR The request was not completed because a failure
- reflected in the Host Status Register bit. Device errors are a result
- of a transaction collision, illegal command field, unclaimed cycle
- (host initiated), or bus errors (collisions).
- RETURN_CRC_ERROR The checksum is not correct (PEC is incorrect)
- RETURN_UNSUPPORTED The SMBus operation is not supported.
+ RETURN_SUCCESS: The SMBUS command was executed.
+ RETURN_TIMEOUT: A timeout occurred while executing the
+ SMBUS command.
+ RETURN_DEVICE_ERROR: The request was not completed because
+ a failure reflected in the Host Status Register bit. Device
+ errors are a result of a transaction collision, illegal
+ command field, unclaimed cycle(host initiated), or bus
+ errors (collisions).
+ RETURN_CRC_ERROR: The checksum is not correct. (PEC is incorrect.)
+ RETURN_UNSUPPORTED: The SMBus operation is not supported.
@return The byte received from the SMBUS.
@@ -154,14 +160,16 @@ SmBusReceiveByte ( @param Value The 8-bit value to send.
@param Status Return status for the executed command.
This is an optional parameter and may be NULL.
- RETURN_SUCCESS The SMBUS command was executed.
- RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.
- RETURN_DEVICE_ERROR The request was not completed because a failure
- reflected in the Host Status Register bit. Device errors are a result
- of a transaction collision, illegal command field, unclaimed cycle
- (host initiated), or bus errors (collisions).
- RETURN_CRC_ERROR The checksum is not correct (PEC is incorrect)
- RETURN_UNSUPPORTED The SMBus operation is not supported.
+ RETURN_SUCCESS: The SMBUS command was executed.
+ RETURN_TIMEOUT: A timeout occurred while executing the
+ SMBUS command.
+ RETURN_DEVICE_ERROR: The request was not completed because
+ a failure reflected in the Host Status Register bit. Device
+ errors are a result of a transaction collision, illegal
+ command field, unclaimed cycle(host initiated), or bus
+ errors (collisions).
+ RETURN_CRC_ERROR: The checksum is not correct (PEC is incorrect)
+ RETURN_UNSUPPORTED: The SMBus operation is not supported.
@return The parameter of Value.
@@ -196,18 +204,20 @@ SmBusSendByte ( If Length in SmBusAddress is not zero, then ASSERT().
If any reserved bits of SmBusAddress are set, then ASSERT().
- @param SmBusAddress The address that encodes the SMBUS Slave Address,
- SMBUS Command, SMBUS Data Length, and PEC.
+ @param SmBusAddress The address that encodes the SMBUS Slave Address,
+ SMBUS Command, SMBUS Data Length, and PEC.
@param Status Return status for the executed command.
This is an optional parameter and may be NULL.
- RETURN_SUCCESS The SMBUS command was executed.
- RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.
- RETURN_DEVICE_ERROR The request was not completed because a failure
- reflected in the Host Status Register bit. Device errors are a result
- of a transaction collision, illegal command field, unclaimed cycle
- (host initiated), or bus errors (collisions).
- RETURN_CRC_ERROR The checksum is not correct (PEC is incorrect)
- RETURN_UNSUPPORTED The SMBus operation is not supported.
+ RETURN_SUCCESS: The SMBUS command was executed.
+ RETURN_TIMEOUT: A timeout occurred while executing the
+ SMBUS command.
+ RETURN_DEVICE_ERROR: The request was not completed because
+ a failurereflected in the Host Status Register bit. Device
+ errors are a result of a transaction collision, illegal
+ command field, unclaimed cycle (host initiated), or bus
+ errors (collisions).
+ RETURN_CRC_ERROR: The checksum is not correct (PEC is incorrect)
+ RETURN_UNSUPPORTED: The SMBus operation is not supported.
@return The byte read from the SMBUS.
@@ -245,14 +255,16 @@ SmBusReadDataByte ( @param Value The 8-bit value to write.
@param Status Return status for the executed command.
This is an optional parameter and may be NULL.
- RETURN_SUCCESS The SMBUS command was executed.
- RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.
- RETURN_DEVICE_ERROR The request was not completed because a failure
- reflected in the Host Status Register bit. Device errors are a result
- of a transaction collision, illegal command field, unclaimed cycle
- (host initiated), or bus errors (collisions).
- RETURN_CRC_ERROR The checksum is not correct (PEC is incorrect)
- RETURN_UNSUPPORTED The SMBus operation is not supported.
+ RETURN_SUCCESS: The SMBUS command was executed.
+ RETURN_TIMEOUT: A timeout occurred while executing the
+ SMBUS command.
+ RETURN_DEVICE_ERROR: The request was not completed because
+ a failure reflected in the Host Status Register bit. Device
+ errors are a result of a transaction collision, illegal
+ command field, unclaimed cycle host initiated), or bus
+ errors (collisions).
+ RETURN_CRC_ERROR: The checksum is not correct. (PEC is incorrect.)
+ RETURN_UNSUPPORTED: The SMBus operation is not supported.
@return The parameter of Value.
@@ -290,14 +302,17 @@ SmBusWriteDataByte ( SMBUS Command, SMBUS Data Length, and PEC.
@param Status Return status for the executed command.
This is an optional parameter and may be NULL.
- RETURN_SUCCESS The SMBUS command was executed.
- RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.
- RETURN_DEVICE_ERROR The request was not completed because a failure
- reflected in the Host Status Register bit. Device errors are a result
- of a transaction collision, illegal command field, unclaimed cycle
- (host initiated), or bus errors (collisions).
- RETURN_CRC_ERROR The checksum is not correct (PEC is incorrect)
- RETURN_UNSUPPORTED The SMBus operation is not supported.
+ RETURN_SUCCESS: The SMBUS command was executed.
+ RETURN_TIMEOUT: A timeout occurred while executing the
+ SMBUS command.
+ RETURN_DEVICE_ERROR: The request was not completed because
+ a failure reflected in the Host Status Register bit.
+ Device errors are a result of a transaction collision,
+ illegal command field, unclaimed cycle (host initiated),
+ or bus errors (collisions).
+ RETURN_CRC_ERROR: The checksum is not correct. (PEC is
+ incorrect.)
+ RETURN_UNSUPPORTED: The SMBus operation is not supported.
@return The byte read from the SMBUS.
@@ -335,14 +350,17 @@ SmBusReadDataWord ( @param Value The 16-bit value to write.
@param Status Return status for the executed command.
This is an optional parameter and may be NULL.
- RETURN_SUCCESS The SMBUS command was executed.
- RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.
- RETURN_DEVICE_ERROR The request was not completed because a failure
- reflected in the Host Status Register bit. Device errors are a result
- of a transaction collision, illegal command field, unclaimed cycle
- (host initiated), or bus errors (collisions).
- RETURN_CRC_ERROR The checksum is not correct (PEC is incorrect)
- RETURN_UNSUPPORTED The SMBus operation is not supported.
+ RETURN_SUCCESS: The SMBUS command was executed.
+ RETURN_TIMEOUT: A timeout occurred while executing the SMBUS
+ command.
+ RETURN_DEVICE_ERROR: The request was not completed because
+ a failure reflected in the Host Status Register bit.
+ Device errors are a result of a transaction collision,
+ illegal command field, unclaimed cycle (host initiated),
+ or bus errors (collisions).
+ RETURN_CRC_ERROR: The checksum is not correct.
+ (PEC is incorrect.)
+ RETURN_UNSUPPORTED: The SMBus operation is not supported.
@return The parameter of Value.
@@ -382,14 +400,17 @@ SmBusWriteDataWord ( @param Value The 16-bit value to write.
@param Status Return status for the executed command.
This is an optional parameter and may be NULL.
- RETURN_SUCCESS The SMBUS command was executed.
- RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.
- RETURN_DEVICE_ERROR The request was not completed because a failure
- reflected in the Host Status Register bit. Device errors are a result
- of a transaction collision, illegal command field, unclaimed cycle
- (host initiated), or bus errors (collisions).
- RETURN_CRC_ERROR The checksum is not correct (PEC is incorrect)
- RETURN_UNSUPPORTED The SMBus operation is not supported.
+ RETURN_SUCCESS: The SMBUS command was executed.
+ RETURN_TIMEOUT: A timeout occurred while executing the
+ SMBUS command.
+ RETURN_DEVICE_ERROR: The request was not completed because
+ a failure reflected in the Host Status Register bit.
+ Device errors are a result of a transaction collision,
+ illegal command field, unclaimed cycle (host initiated),
+ or bus errors (collisions).
+ RETURN_CRC_ERROR: The checksum is not correct. (PEC is
+ incorrect.)
+ RETURN_UNSUPPORTED: The SMBus operation is not supported.
@return The 16-bit value returned by the process call command.
@@ -426,17 +447,21 @@ SmBusProcessCall ( @param SmBusAddress The address that encodes the SMBUS Slave Address,
SMBUS Command, SMBUS Data Length, and PEC.
- @param Buffer The pointer to the buffer to store the bytes read from the SMBUS.
+ @param Buffer The pointer to the buffer to store the bytes read from
+ the SMBUS.
@param Status Return status for the executed command.
This is an optional parameter and may be NULL.
- RETURN_SUCCESS The SMBUS command was executed.
- RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.
- RETURN_DEVICE_ERROR The request was not completed because a failure
- reflected in the Host Status Register bit. Device errors are a result
- of a transaction collision, illegal command field, unclaimed cycle
- (host initiated), or bus errors (collisions).
- RETURN_CRC_ERROR The checksum is not correct (PEC is incorrect)
- RETURN_UNSUPPORTED The SMBus operation is not supported.
+ RETURN_SUCCESS: The SMBUS command was executed.
+ RETURN_TIMEOUT: A timeout occurred while executing the SMBUS
+ command.
+ RETURN_DEVICE_ERROR: The request was not completed because
+ a failure reflected in the Host Status Register bit. Device
+ errors are a result of a transaction collision, illegal
+ command field, unclaimed cycle (host initiated), or bus
+ errors (collisions).
+ RETURN_CRC_ERROR: The checksum is not correct. (PEC is
+ incorrect.)
+ RETURN_UNSUPPORTED: The SMBus operation is not supported.
@return The number of bytes read.
@@ -470,16 +495,20 @@ SmBusReadBlock ( @param SmBusAddress The address that encodes the SMBUS Slave Address,
MBUS Command, SMBUS Data Length, and PEC.
- @param Buffer The pointer to the buffer to store the bytes read from the SMBUS.
+ @param Buffer The pointer to the buffer to store the bytes read from
+ the SMBUS.
@param Status Return status for the executed command.
This is an optional parameter and may be NULL.
- RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.
- RETURN_DEVICE_ERROR The request was not completed because a failure
- reflected in the Host Status Register bit. Device errors are a result
- of a transaction collision, illegal command field, unclaimed cycle
- (host initiated), or bus errors (collisions).
- RETURN_CRC_ERROR The checksum is not correct (PEC is incorrect)
- RETURN_UNSUPPORTED The SMBus operation is not supported.
+ RETURN_TIMEOUT: A timeout occurred while executing the
+ SMBUS command.
+ RETURN_DEVICE_ERROR: The request was not completed because
+ a failure reflected in the Host Status Register bit. Device
+ errors are a result of a transaction collision, illegal
+ command field, unclaimed cycle (host initiated), or bus
+ errors (collisions).
+ RETURN_CRC_ERROR: The checksum is not correct. (PEC is
+ incorrect.)
+ RETURN_UNSUPPORTED: The SMBus operation is not supported.
@return The number of bytes written.
@@ -523,13 +552,16 @@ SmBusWriteBlock ( @param ReadBuffer The pointer to the buffer of bytes to read from the SMBUS.
@param Status Return status for the executed command.
This is an optional parameter and may be NULL.
- RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.
- RETURN_DEVICE_ERROR The request was not completed because a failure
- reflected in the Host Status Register bit. Device errors are a result
- of a transaction collision, illegal command field, unclaimed cycle
- (host initiated), or bus errors (collisions).
- RETURN_CRC_ERROR The checksum is not correct (PEC is incorrect)
- RETURN_UNSUPPORTED The SMBus operation is not supported.
+ RETURN_TIMEOUT: A timeout occurred while executing the
+ SMBUS command.
+ RETURN_DEVICE_ERROR: The request was not completed because
+ a failure reflected in the Host Status Register bit. Device
+ errors are a result of a transaction collision, illegal
+ command field, unclaimed cycle (host initiated), or bus
+ errors (collisions).
+ RETURN_CRC_ERROR: The checksum is not correct. (PEC is
+ incorrect.)
+ RETURN_UNSUPPORTED: The SMBus operation is not supported.
@return The number of bytes written.
diff --git a/MdePkg/Library/PeiCoreEntryPoint/PeiCoreEntryPoint.c b/MdePkg/Library/PeiCoreEntryPoint/PeiCoreEntryPoint.c index 698739825c..5662ccff15 100644 --- a/MdePkg/Library/PeiCoreEntryPoint/PeiCoreEntryPoint.c +++ b/MdePkg/Library/PeiCoreEntryPoint/PeiCoreEntryPoint.c @@ -1,11 +1,11 @@ /** @file
Entry point to a the PEI Core.
-Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
-http://opensource.org/licenses/bsd-license.php
+http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@@ -39,17 +39,19 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. the PEI Services Table and the file handle for the PEI Core itself have been established.
If ProcessModuleEntryPointList() returns, then ASSERT() and halt the system.
- @param SecCoreData Points to a data structure containing information about the PEI
- core's operating environment, such as the size and location of
- temporary RAM, the stack location and the BFV location.
-
- @param PpiList Points to a list of one or more PPI descriptors to be installed
- initially by the PEI core. An empty PPI list consists of a single
- descriptor with the end-tag EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST.
- As part of its initialization phase, the PEI Foundation will add
- these SEC-hosted PPIs to its PPI database such that both the PEI
- Foundation and any modules can leverage the associated service calls
- and/or code in these early PPIs.
+ @param SecCoreData Points to a data structure containing information about the
+ PEI core's operating environment, such as the size and
+ location of temporary RAM, the stack location and the BFV
+ location.
+
+ @param PpiList Points to a list of one or more PPI descriptors to be
+ installed initially by the PEI core. An empty PPI list
+ consists of a single descriptor with the end-tag
+ EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST.
+ As part of its initialization phase, the PEI Foundation will
+ add these SEC-hosted PPIs to its PPI database, such that both
+ the PEI Foundation and any modules can leverage the associated
+ service calls and/or code in these early PPIs.
**/
VOID
@@ -79,12 +81,13 @@ _ModuleEntryPoint( the stack location and the BFV location.
@param PpiList Points to a list of one or more PPI descriptors to be installed
- initially by the PEI core. An empty PPI list consists of a single
- descriptor with the end-tag EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST.
- As part of its initialization phase, the PEI Foundation will add these
- SEC-hosted PPIs to its PPI database such that both the PEI Foundation
- and any modules can leverage the associated service calls and/or code
- in these early PPIs.
+ initially by the PEI core. An empty PPI list consists of
+ a single descriptor with the end-tag
+ EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST.
+ As part of its initialization phase, the PEI Foundation will
+ add these SEC-hosted PPIs to its PPI database, such that both
+ the PEI Foundationand any modules can leverage the associated
+ service calls and/or code in these early PPIs.
**/
VOID
diff --git a/MdePkg/Library/PeiDxePostCodeLibReportStatusCode/PostCode.c b/MdePkg/Library/PeiDxePostCodeLibReportStatusCode/PostCode.c index 42cd8bde35..e4a05d091b 100644 --- a/MdePkg/Library/PeiDxePostCodeLibReportStatusCode/PostCode.c +++ b/MdePkg/Library/PeiDxePostCodeLibReportStatusCode/PostCode.c @@ -2,7 +2,7 @@ Post code library instace bases on report status code library
PostCode Library for PEIMs and DXE drivers that send PostCode to ReportStatusCode
- Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>
+ Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
diff --git a/MdePkg/Library/PeiExtractGuidedSectionLib/PeiExtractGuidedSectionLib.c b/MdePkg/Library/PeiExtractGuidedSectionLib/PeiExtractGuidedSectionLib.c index f23e25a2a1..099d7cc24c 100644 --- a/MdePkg/Library/PeiExtractGuidedSectionLib/PeiExtractGuidedSectionLib.c +++ b/MdePkg/Library/PeiExtractGuidedSectionLib/PeiExtractGuidedSectionLib.c @@ -34,7 +34,7 @@ typedef struct { Build guid hob for the global memory to store the registered guid and Handler list.
If GuidHob exists, HandlerInfo will be directly got from Guid hob data.
- @param[in, out] InfoPointer The pointer to pei handler info structure.
+ @param[in, out] InfoPointer The pointer to pei handler information structure.
@retval RETURN_SUCCESS Build Guid hob for the global memory space to store guid and function tables.
@retval RETURN_OUT_OF_RESOURCES No enough memory to allocated.
@@ -48,7 +48,7 @@ PeiGetExtractGuidedSectionHandlerInfo ( EFI_PEI_HOB_POINTERS Hob;
//
- // First try to get handler info from guid hob specified by CallerId.
+ // First try to get handler information from guid hob specified by CallerId.
//
Hob.Raw = GetNextHob (EFI_HOB_TYPE_GUID_EXTENSION, GetHobList ());
while (Hob.Raw != NULL) {
@@ -313,7 +313,7 @@ ExtractGuidedSectionGetInfo ( for (Index = 0; Index < HandlerInfo->NumberOfExtractHandler; Index ++) {
if (CompareGuid (HandlerInfo->ExtractHandlerGuidTable + Index, &(((EFI_GUID_DEFINED_SECTION *) InputSection)->SectionDefinitionGuid))) {
//
- // Call the match handler to get info for the input section data.
+ // Call the match handler to get information for the input section data.
//
return HandlerInfo->ExtractGetInfoHandlerTable [Index] (
InputSection,
diff --git a/MdePkg/Library/PeiHobLib/HobLib.c b/MdePkg/Library/PeiHobLib/HobLib.c index 6e3de1f598..8e1eddcce6 100644 --- a/MdePkg/Library/PeiHobLib/HobLib.c +++ b/MdePkg/Library/PeiHobLib/HobLib.c @@ -1,11 +1,11 @@ /** @file
Provide Hob Library functions for Pei phase.
-Copyright (c) 2007 - 2009, Intel Corporation. All rights reserved.<BR>
+Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
-http://opensource.org/licenses/bsd-license.php
+http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@@ -127,7 +127,7 @@ GetFirstHob ( its HOB type is EFI_HOB_TYPE_GUID_EXTENSION and its GUID Name equals to the input Guid.
If there does not exist such HOB from the starting HOB pointer, it will return NULL.
Caller is required to apply GET_GUID_HOB_DATA () and GET_GUID_HOB_DATA_SIZE ()
- to extract the data section and its size info respectively.
+ to extract the data section and its size information, respectively.
In contrast with macro GET_NEXT_HOB(), this function does not skip the starting HOB pointer
unconditionally: it returns HobStart back if HobStart itself meets the requirement;
caller is required to use GET_NEXT_HOB() if it wishes to skip current HobStart.
@@ -168,7 +168,7 @@ GetNextGuidHob ( its HOB type is EFI_HOB_TYPE_GUID_EXTENSION and its GUID Name equals to the input Guid.
If there does not exist such HOB from the starting HOB pointer, it will return NULL.
Caller is required to apply GET_GUID_HOB_DATA () and GET_GUID_HOB_DATA_SIZE ()
- to extract the data section and its size info respectively.
+ to extract the data section and its size information, respectively.
If the pointer to the HOB list is NULL, then ASSERT().
If Guid is NULL, then ASSERT().
@@ -198,7 +198,7 @@ GetFirstGuidHob ( If the pointer to the HOB list is NULL, then ASSERT().
- @param VOID
+ @param VOID.
@return The Boot Mode.
@@ -579,7 +579,7 @@ BuildStackHob ( @param BaseAddress The 64 bit physical address of the BSP.
@param Length The length of the BSP store in bytes.
- @param MemoryType Type of memory allocated by this HOB.
+ @param MemoryType The type of memory allocated by this HOB.
**/
VOID
@@ -619,7 +619,7 @@ BuildBspStoreHob ( @param BaseAddress The 64 bit physical address of the memory.
@param Length The length of the memory allocation in bytes.
- @param MemoryType Type of memory allocated by this HOB.
+ @param MemoryType The type of memory allocated by this HOB.
**/
VOID
diff --git a/MdePkg/Library/PeiIoLibCpuIo/IoHighLevel.c b/MdePkg/Library/PeiIoLibCpuIo/IoHighLevel.c index 9a0adaf142..f5e554f9e8 100644 --- a/MdePkg/Library/PeiIoLibCpuIo/IoHighLevel.c +++ b/MdePkg/Library/PeiIoLibCpuIo/IoHighLevel.c @@ -1265,7 +1265,7 @@ MmioAndThenOr8 ( If EndBit is greater than 7, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to read.
+ @param Address The MMIO register to read.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..7.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1297,7 +1297,7 @@ MmioBitFieldRead8 ( If EndBit is greater than 7, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..7.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1338,7 +1338,7 @@ MmioBitFieldWrite8 ( If EndBit is greater than 7, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..7.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1379,7 +1379,7 @@ MmioBitFieldOr8 ( If EndBit is greater than 7, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..7.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1421,7 +1421,7 @@ MmioBitFieldAnd8 ( If EndBit is greater than 7, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..7.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1550,7 +1550,7 @@ MmioAndThenOr16 ( If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to read.
+ @param Address The MMIO register to read.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..15.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1583,7 +1583,7 @@ MmioBitFieldRead16 ( If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..15.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1625,7 +1625,7 @@ MmioBitFieldWrite16 ( If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..15.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1667,7 +1667,7 @@ MmioBitFieldOr16 ( If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..15.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1710,7 +1710,7 @@ MmioBitFieldAnd16 ( If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..15.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1839,7 +1839,7 @@ MmioAndThenOr32 ( If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to read.
+ @param Address The MMIO register to read.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..31.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1872,7 +1872,7 @@ MmioBitFieldRead32 ( If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..31.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1914,7 +1914,7 @@ MmioBitFieldWrite32 ( If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..31.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1956,7 +1956,7 @@ MmioBitFieldOr32 ( If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..31.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1999,7 +1999,7 @@ MmioBitFieldAnd32 ( If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..31.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -2128,7 +2128,7 @@ MmioAndThenOr64 ( If EndBit is greater than 63, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to read.
+ @param Address The MMIO register to read.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..63.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -2161,7 +2161,7 @@ MmioBitFieldRead64 ( If EndBit is greater than 63, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..63.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -2288,7 +2288,7 @@ MmioBitFieldAnd64 ( If EndBit is greater than 63, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..63.
@param EndBit The ordinal of the most significant bit in the bit field.
diff --git a/MdePkg/Library/PeiMemoryAllocationLib/MemoryAllocationLib.c b/MdePkg/Library/PeiMemoryAllocationLib/MemoryAllocationLib.c index d4e3c22885..531ad7472f 100644 --- a/MdePkg/Library/PeiMemoryAllocationLib/MemoryAllocationLib.c +++ b/MdePkg/Library/PeiMemoryAllocationLib/MemoryAllocationLib.c @@ -2,7 +2,7 @@ Support routines for memory allocation routines
based on PeiService for PEI phase drivers.
- Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>
+ Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
@@ -163,7 +163,8 @@ FreePages ( @param MemoryType The type of memory to allocate.
@param Pages The number of 4 KB pages to allocate.
- @param Alignment The requested alignment of the allocation. Must be a power of two.
+ @param Alignment The requested alignment of the allocation.
+ Must be a power of two.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
@@ -214,7 +215,8 @@ InternalAllocateAlignedPages ( If Alignment is not a power of two and Alignment is not zero, then ASSERT().
@param Pages The number of 4 KB pages to allocate.
- @param Alignment The requested alignment of the allocation. Must be a power of two.
+ @param Alignment The requested alignment of the allocation.
+ Must be a power of two.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
@@ -241,7 +243,8 @@ AllocateAlignedPages ( If Alignment is not a power of two and Alignment is not zero, then ASSERT().
@param Pages The number of 4 KB pages to allocate.
- @param Alignment The requested alignment of the allocation. Must be a power of two.
+ @param Alignment The requested alignment of the allocation.
+ Must be a power of two.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
@@ -268,7 +271,8 @@ AllocateAlignedRuntimePages ( If Alignment is not a power of two and Alignment is not zero, then ASSERT().
@param Pages The number of 4 KB pages to allocate.
- @param Alignment The requested alignment of the allocation. Must be a power of two.
+ @param Alignment The requested alignment of the allocation.
+ Must be a power of two.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
@@ -654,8 +658,8 @@ AllocateReservedCopyPool ( @param PoolType The type of pool to allocate.
@param OldSize The size, in bytes, of OldBuffer.
@param NewSize The size, in bytes, of the buffer to reallocate.
- @param OldBuffer The buffer to copy to the allocated buffer. This is an optional
- parameter that may be NULL.
+ @param OldBuffer The buffer to copy to the allocated buffer. This is an
+ optional parameter that may be NULL.
@return A pointer to the allocated buffer or NULL if allocation fails.
@@ -757,8 +761,8 @@ ReallocateRuntimePool ( @param OldSize The size, in bytes, of OldBuffer.
@param NewSize The size, in bytes, of the buffer to reallocate.
- @param OldBuffer The buffer to copy to the allocated buffer. This is an optional
- parameter that may be NULL.
+ @param OldBuffer The buffer to copy to the allocated buffer. This is an
+ optional parameter that may be NULL.
@return A pointer to the allocated buffer or NULL if allocation fails.
diff --git a/MdePkg/Library/PeiMemoryLib/CompareMemWrapper.c b/MdePkg/Library/PeiMemoryLib/CompareMemWrapper.c index 3e74647aa3..f525c17bae 100644 --- a/MdePkg/Library/PeiMemoryLib/CompareMemWrapper.c +++ b/MdePkg/Library/PeiMemoryLib/CompareMemWrapper.c @@ -11,7 +11,7 @@ PeiMemoryLib
UefiMemoryLib
-Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
diff --git a/MdePkg/Library/PeiMemoryLib/CopyMemWrapper.c b/MdePkg/Library/PeiMemoryLib/CopyMemWrapper.c index 21ea2d4ef4..9b76f0f1e1 100644 --- a/MdePkg/Library/PeiMemoryLib/CopyMemWrapper.c +++ b/MdePkg/Library/PeiMemoryLib/CopyMemWrapper.c @@ -12,7 +12,7 @@ PeiMemoryLib
UefiMemoryLib
- Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>
+ Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
diff --git a/MdePkg/Library/PeiMemoryLib/MemLib.c b/MdePkg/Library/PeiMemoryLib/MemLib.c index fc86964b18..4f1f01749c 100644 --- a/MdePkg/Library/PeiMemoryLib/MemLib.c +++ b/MdePkg/Library/PeiMemoryLib/MemLib.c @@ -1,7 +1,7 @@ /** @file
Base Memory Library functions implementation bases on PeiServcie.
- Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>
+ Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
@@ -48,7 +48,7 @@ InternalMemCopyMem ( This function wraps the gPS->SetMem ().
@param Buffer Memory to set.
- @param Size The number of bytes to set.
+ @param Size The number of bytes to set.
@param Value Value of the set operation.
@return Buffer.
diff --git a/MdePkg/Library/PeiMemoryLib/MemLibGeneric.c b/MdePkg/Library/PeiMemoryLib/MemLibGeneric.c index f68272f2ae..db56b503d5 100644 --- a/MdePkg/Library/PeiMemoryLib/MemLibGeneric.c +++ b/MdePkg/Library/PeiMemoryLib/MemLibGeneric.c @@ -6,7 +6,7 @@ PeiMemoryLib
UefiMemoryLib
- Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>
+ Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
@@ -26,7 +26,7 @@ @param Length The count of 16-bit value to fill.
@param Value The value with which to fill Length bytes of Buffer.
- @return Buffer
+ @return Buffer.
**/
VOID *
@@ -50,7 +50,7 @@ InternalMemSetMem16 ( @param Length The count of 32-bit value to fill.
@param Value The value with which to fill Length bytes of Buffer.
- @return Buffer
+ @return Buffer.
**/
VOID *
@@ -74,7 +74,7 @@ InternalMemSetMem32 ( @param Length The count of 64-bit value to fill.
@param Value The value with which to fill Length bytes of Buffer.
- @return Buffer
+ @return Buffer.
**/
VOID *
@@ -94,10 +94,10 @@ InternalMemSetMem64 ( /**
Set Buffer to 0 for Size bytes.
- @param Buffer Memory to set.
+ @param Buffer The memory to set.
@param Length The number of bytes to set
- @return Buffer
+ @return Buffer.
**/
VOID *
@@ -113,9 +113,9 @@ InternalMemZeroMem ( /**
Compares two memory buffers of a given length.
- @param DestinationBuffer First memory buffer
- @param SourceBuffer Second memory buffer
- @param Length Length of DestinationBuffer and SourceBuffer memory
+ @param DestinationBuffer The first memory buffer
+ @param SourceBuffer The second memory buffer
+ @param Length The length of DestinationBuffer and SourceBuffer memory
regions to compare. Must be non-zero.
@return 0 All Length bytes of the two buffers are identical.
@@ -147,7 +147,7 @@ InternalMemCompareMem ( @param Length The count of 8-bit value to scan. Must be non-zero.
@param Value The value to search for in the target buffer.
- @return The pointer to the first occurrence or NULL if not found.
+ @return The pointer to the first occurrence, or NULL if not found.
**/
CONST VOID *
@@ -177,7 +177,7 @@ InternalMemScanMem8 ( @param Length The count of 16-bit value to scan. Must be non-zero.
@param Value The value to search for in the target buffer.
- @return The pointer to the first occurrence or NULL if not found.
+ @return The pointer to the first occurrence, or NULL if not found.
**/
CONST VOID *
@@ -207,7 +207,7 @@ InternalMemScanMem16 ( @param Length The count of 32-bit value to scan. Must be non-zero.
@param Value The value to search for in the target buffer.
- @return The pointer to the first occurrence or NULL if not found.
+ @return The pointer to the first occurrence, or NULL if not found.
**/
CONST VOID *
@@ -237,7 +237,7 @@ InternalMemScanMem32 ( @param Length The count of 64-bit value to scan. Must be non-zero.
@param Value The value to search for in the target buffer.
- @return The pointer to the first occurrence or NULL if not found.
+ @return The pointer to the first occurrence, or NULL if not found.
**/
CONST VOID *
diff --git a/MdePkg/Library/PeiMemoryLib/MemLibGuid.c b/MdePkg/Library/PeiMemoryLib/MemLibGuid.c index 6f6edd0d8f..c04af6e112 100644 --- a/MdePkg/Library/PeiMemoryLib/MemLibGuid.c +++ b/MdePkg/Library/PeiMemoryLib/MemLibGuid.c @@ -12,7 +12,7 @@ PeiMemoryLib
UefiMemoryLib
- Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>
+ Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
diff --git a/MdePkg/Library/PeiMemoryLib/MemLibInternals.h b/MdePkg/Library/PeiMemoryLib/MemLibInternals.h index 131d17d26e..8a1e1dff90 100644 --- a/MdePkg/Library/PeiMemoryLib/MemLibInternals.h +++ b/MdePkg/Library/PeiMemoryLib/MemLibInternals.h @@ -1,7 +1,7 @@ /** @file
Declaration of internal functions for Base Memory Library.
- Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>
+ Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
@@ -47,7 +47,7 @@ InternalMemCopyMem ( This function wraps the (*PeiServices)->SetMem ().
- @param Buffer Memory to set.
+ @param Buffer The memory to set.
@param Size The number of bytes to set.
@param Value Value of the set operation.
@@ -119,7 +119,7 @@ InternalMemSetMem64 ( /**
Set Buffer to 0 for Size bytes.
- @param Buffer Memory to set.
+ @param Buffer The memory to set.
@param Length The number of bytes to set
@return Buffer
@@ -135,9 +135,9 @@ InternalMemZeroMem ( /**
Compares two memory buffers of a given length.
- @param DestinationBuffer First memory buffer
- @param SourceBuffer Second memory buffer
- @param Length Length of DestinationBuffer and SourceBuffer memory
+ @param DestinationBuffer The first memory buffer
+ @param SourceBuffer The second memory buffer
+ @param Length The length of DestinationBuffer and SourceBuffer memory
regions to compare. Must be non-zero.
@return 0 All Length bytes of the two buffers are identical.
@@ -161,7 +161,7 @@ InternalMemCompareMem ( @param Length The count of 8-bit value to scan. Must be non-zero.
@param Value The value to search for in the target buffer.
- @return The pointer to the first occurrence or NULL if not found.
+ @return The pointer to the first occurrence, or NULL if not found.
**/
CONST VOID *
@@ -180,7 +180,7 @@ InternalMemScanMem8 ( @param Length The count of 16-bit value to scan. Must be non-zero.
@param Value The value to search for in the target buffer.
- @return The pointer to the first occurrence or NULL if not found.
+ @return The pointer to the first occurrence, or NULL if not found.
**/
CONST VOID *
@@ -199,7 +199,7 @@ InternalMemScanMem16 ( @param Length The count of 32-bit value to scan. Must be non-zero.
@param Value The value to search for in the target buffer.
- @return The pointer to the first occurrence or NULL if not found.
+ @return The pointer to the first occurrence, or NULL if not found.
**/
CONST VOID *
@@ -218,7 +218,7 @@ InternalMemScanMem32 ( @param Length The count of 64-bit value to scan. Must be non-zero.
@param Value The value to search for in the target buffer.
- @return The pointer to the first occurrence or NULL if not found.
+ @return The pointer to the first occurrence, or NULL if not found.
**/
CONST VOID *
diff --git a/MdePkg/Library/PeiMemoryLib/ScanMem8Wrapper.c b/MdePkg/Library/PeiMemoryLib/ScanMem8Wrapper.c index 7fee8ae6d8..efbbe20a70 100644 --- a/MdePkg/Library/PeiMemoryLib/ScanMem8Wrapper.c +++ b/MdePkg/Library/PeiMemoryLib/ScanMem8Wrapper.c @@ -12,7 +12,7 @@ PeiMemoryLib
UefiMemoryLib
- Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>
+ Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
diff --git a/MdePkg/Library/PeiMemoryLib/SetMemWrapper.c b/MdePkg/Library/PeiMemoryLib/SetMemWrapper.c index 6efa407d3d..8a3392718f 100644 --- a/MdePkg/Library/PeiMemoryLib/SetMemWrapper.c +++ b/MdePkg/Library/PeiMemoryLib/SetMemWrapper.c @@ -12,7 +12,7 @@ PeiMemoryLib
UefiMemoryLib
- Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>
+ Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
@@ -32,7 +32,7 @@ If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
- @param Buffer Memory to set.
+ @param Buffer The memory to set.
@param Length The number of bytes to set.
@param Value The value with which to fill Length bytes of Buffer.
diff --git a/MdePkg/Library/PeiPcdLib/PeiPcdLib.c b/MdePkg/Library/PeiPcdLib/PeiPcdLib.c index 817764c4ca..4d91799025 100644 --- a/MdePkg/Library/PeiPcdLib/PeiPcdLib.c +++ b/MdePkg/Library/PeiPcdLib/PeiPcdLib.c @@ -78,8 +78,8 @@ GetPiPcdPpiPointer ( Sets the current SKU in the PCD database to the value specified by SkuId. SkuId is returned.
If SkuId >= PCD_MAX_SKU_ID, then ASSERT().
- @param SkuId The SKU value that will be used when the PCD service retrieves and sets values
- associated with a PCD token.
+ @param SkuId The SKU value that will be used when the PCD service retrieves
+ and sets values associated with a PCD token.
@return Return the SKU ID that just be set.
@@ -446,7 +446,7 @@ LibPcdGetExSize ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 8-bit value to set.
- @return Return the value been set.
+ @return Return the value that was set.
**/
UINT8
@@ -476,7 +476,7 @@ LibPcdSet8 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 16-bit value to set.
- @return Return the value been set.
+ @return Return the value that was set.
**/
UINT16
@@ -506,7 +506,7 @@ LibPcdSet16 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 32-bit value to set.
- @return Return the value been set.
+ @return Return the value that was set.
**/
UINT32
@@ -536,7 +536,7 @@ LibPcdSet32 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 64-bit value to set.
- @return Return the value been set.
+ @return Return the value that was set.
**/
UINT64
@@ -615,7 +615,7 @@ LibPcdSetPtr ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The boolean value to set.
- @return Return the value been set.
+ @return Return the value that was set.
**/
BOOLEAN
@@ -649,7 +649,7 @@ LibPcdSetBool ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 8-bit value to set.
- @return Return the value been set.
+ @return Return the value that was set.
**/
UINT8
@@ -686,7 +686,7 @@ LibPcdSetEx8 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 16-bit value to set.
- @return Return the value been set.
+ @return Return the value that was set.
**/
UINT16
@@ -721,7 +721,7 @@ LibPcdSetEx16 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 32-bit value to set.
- @return Return the value been set.
+ @return Return the value that was set.
**/
UINT32
@@ -757,7 +757,7 @@ LibPcdSetEx32 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 64-bit value to set.
- @return Return the value been set.
+ @return Return the value that was set.
**/
UINT64
@@ -842,7 +842,7 @@ LibPcdSetExPtr ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The Boolean value to set.
- @return Return the value been set.
+ @return Return the value that was set.
**/
BOOLEAN
@@ -873,9 +873,9 @@ LibPcdSetExBool ( If Guid is NULL, then the default token space is used.
If NotificationFunction is NULL, then ASSERT().
- @param[in] Guid The pointer to a 128-bit unique value that designates which
- namespace to set a value from. If NULL, then the default
- token space is used.
+ @param[in] Guid The pointer to a 128-bit unique value that
+ designates which namespace to set a value from.
+ If NULL, then the default token space is used.
@param[in] TokenNumber The PCD token number to monitor.
@param[in] NotificationFunction The function to call when the token
specified by Guid and TokenNumber is set.
diff --git a/MdePkg/Library/PeiPciLibPciCfg2/PciLib.c b/MdePkg/Library/PeiPciLibPciCfg2/PciLib.c index 98ac205933..0eef525261 100644 --- a/MdePkg/Library/PeiPciLibPciCfg2/PciLib.c +++ b/MdePkg/Library/PeiPciLibPciCfg2/PciLib.c @@ -1,7 +1,7 @@ /** @file
PCI Library using PCI CFG2 PPI.
- Copyright (c) 2007 - 2009, Intel Corporation. All rights reserved.<BR>
+ Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are
licensed and made available under the terms and conditions of
the BSD License which accompanies this distribution. The full
@@ -53,7 +53,7 @@ @param Address The address that encodes the PCI Bus, Device, Function and
Register.
- @param Width Width of data to read
+ @param Width The width of data to read
@return The value read from the PCI configuration register.
@@ -95,7 +95,7 @@ PeiPciLibPciCfg2ReadWorker ( @param Address The address that encodes the PCI Bus, Device, Function and
Register.
- @param Width Width of data to write
+ @param Width The width of data to write
@param Data The value to write.
@return The value written to the PCI configuration register.
diff --git a/MdePkg/Library/PeiPciSegmentLibPciCfg2/PciSegmentLib.c b/MdePkg/Library/PeiPciSegmentLibPciCfg2/PciSegmentLib.c index 0d960c5b93..8330243b1e 100644 --- a/MdePkg/Library/PeiPciSegmentLibPciCfg2/PciSegmentLib.c +++ b/MdePkg/Library/PeiPciSegmentLibPciCfg2/PciSegmentLib.c @@ -49,7 +49,8 @@ This internal function retrieves PCI CFG2 PPI from PPI database.
- @param Address The address that encodes the PCI Segment, Bus, Device, Function and Register.
+ @param Address The address that encodes the PCI Segment, Bus, Device,
+ Function and Register.
@return The pointer to PCI CFG2 PPI.
@@ -94,7 +95,7 @@ InternalGetPciCfg2Ppi ( @param Address The address that encodes the PCI Bus, Device, Function and
Register.
- @param Width Width of data to read
+ @param Width The width of data to read
@return The value read from the PCI configuration register.
@@ -132,7 +133,7 @@ PeiPciSegmentLibPciCfg2ReadWorker ( @param Address The address that encodes the PCI Bus, Device, Function and
Register.
- @param Width Width of data to write
+ @param Width The width of data to write
@param Data The value to write.
@return The value written to the PCI configuration register.
@@ -197,7 +198,8 @@ PciSegmentRegisterForRuntimeAccess ( If any reserved bits in Address are set, then ASSERT().
- @param Address The address that encodes the PCI Segment, Bus, Device, Function, and Register.
+ @param Address The address that encodes the PCI Segment, Bus, Device, Function,
+ and Register.
@return The 8-bit PCI configuration register specified by Address.
@@ -646,7 +648,7 @@ PciSegmentAnd16 ( If Address is not aligned on a 16-bit boundary, then ASSERT().
@param Address The address that encodes the PCI Segment, Bus, Device, Function, and Register.
- @param AndData The value to AND with the PCI configuration register.
+ @param AndData The value to AND with the PCI configuration register.
@param OrData The value to OR with the PCI configuration register.
@return The value written to the PCI configuration register.
@@ -867,7 +869,8 @@ PciSegmentBitFieldAndThenOr16 ( If any reserved bits in Address are set, then ASSERT().
If Address is not aligned on a 32-bit boundary, then ASSERT().
- @param Address The address that encodes the PCI Segment, Bus, Device, Function, and Register.
+ @param Address The address that encodes the PCI Segment, Bus, Device, Function,
+ and Register.
@return The 32-bit PCI configuration register specified by Address.
@@ -892,7 +895,8 @@ PciSegmentRead32 ( If any reserved bits in Address are set, then ASSERT().
If Address is not aligned on a 32-bit boundary, then ASSERT().
- @param Address The address that encodes the PCI Segment, Bus, Device, Function, and Register.
+ @param Address The address that encodes the PCI Segment, Bus, Device,
+ Function, and Register.
@param Value The value to write.
@return The parameter of Value.
@@ -950,7 +954,8 @@ PciSegmentOr32 ( If any reserved bits in Address are set, then ASSERT().
If Address is not aligned on a 32-bit boundary, then ASSERT().
- @param Address The address that encodes the PCI Segment, Bus, Device, Function, and Register.
+ @param Address The address that encodes the PCI Segment, Bus, Device, Function,
+ and Register.
@param AndData The value to AND with the PCI configuration register.
@return The value written to the PCI configuration register.
@@ -980,7 +985,8 @@ PciSegmentAnd32 ( If any reserved bits in Address are set, then ASSERT().
If Address is not aligned on a 32-bit boundary, then ASSERT().
- @param Address The address that encodes the PCI Segment, Bus, Device, Function, and Register.
+ @param Address The address that encodes the PCI Segment, Bus, Device, Function,
+ and Register.
@param AndData The value to AND with the PCI configuration register.
@param OrData The value to OR with the PCI configuration register.
@@ -1213,8 +1219,8 @@ PciSegmentBitFieldAndThenOr32 ( If ((StartAddress & 0xFFF) + Size) > 0x1000, then ASSERT().
If Size > 0 and Buffer is NULL, then ASSERT().
- @param StartAddress The starting address that encodes the PCI Segment, Bus, Device,
- Function and Register.
+ @param StartAddress The starting address that encodes the PCI Segment, Bus,
+ Device, Function and Register.
@param Size The size in bytes of the transfer.
@param Buffer The pointer to a buffer receiving the data read.
@@ -1312,8 +1318,8 @@ PciSegmentReadBuffer ( If ((StartAddress & 0xFFF) + Size) > 0x1000, then ASSERT().
If Size > 0 and Buffer is NULL, then ASSERT().
- @param StartAddress The starting address that encodes the PCI Segment, Bus, Device,
- Function and Register.
+ @param StartAddress The starting address that encodes the PCI Segment, Bus,
+ Device, Function and Register.
@param Size The size in bytes of the transfer.
@param Buffer The pointer to a buffer containing the data to write.
diff --git a/MdePkg/Library/PeiServicesLib/PeiServicesLib.c b/MdePkg/Library/PeiServicesLib/PeiServicesLib.c index b47bc3ca4b..835325cc38 100644 --- a/MdePkg/Library/PeiServicesLib/PeiServicesLib.c +++ b/MdePkg/Library/PeiServicesLib/PeiServicesLib.c @@ -1,7 +1,7 @@ /** @file
Implementation for PEI Services Library.
- Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>
+ Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
@@ -117,13 +117,14 @@ PeiServicesLocatePpi ( This service enables PEIMs to register a given service to be invoked when another service is
installed or reinstalled.
- @param NotifyList A pointer to the list of notification interfaces that the caller
- shall install.
+ @param NotifyList A pointer to the list of notification interfaces
+ that the caller shall install.
@retval EFI_SUCCESS The interface was successfully installed.
@retval EFI_INVALID_PARAMETER The NotifyList pointer is NULL.
- @retval EFI_INVALID_PARAMETER Any of the PEI notify descriptors in the list do not have the
- EFI_PEI_PPI_DESCRIPTOR_NOTIFY_TYPES bit set in the Flags field.
+ @retval EFI_INVALID_PARAMETER Any of the PEI notify descriptors in the list do
+ not have the EFI_PEI_PPI_DESCRIPTOR_NOTIFY_TYPES
+ bit set in the Flags field.
@retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.
**/
@@ -183,8 +184,9 @@ PeiServicesSetBootMode ( /**
This service enables a PEIM to ascertain the address of the list of HOBs in memory.
- @param HobList A pointer to the list of HOBs that the PEI Foundation will initialize.
-
+ @param HobList A pointer to the list of HOBs that the PEI Foundation
+ will initialize.
+
@retval EFI_SUCCESS The list was successfully returned.
@retval EFI_NOT_AVAILABLE_YET The HOB list is not yet published.
@@ -206,7 +208,8 @@ PeiServicesGetHobList ( @param Type The type of HOB to be installed.
@param Length The length of the HOB to be added.
- @param Hob The address of a pointer that will contain the HOB header.
+ @param Hob The address of a pointer that will contain the
+ HOB header.
@retval EFI_SUCCESS The HOB was successfully created.
@retval EFI_OUT_OF_RESOURCES There is no additional space for HOB creation.
@@ -229,9 +232,10 @@ PeiServicesCreateHob ( /**
This service enables PEIMs to discover additional firmware volumes.
- @param Instance This instance of the firmware volume to find. The value 0 is the
- Boot Firmware Volume (BFV).
- @param VolumeHandle Handle of the firmware volume header of the volume to return.
+ @param Instance This instance of the firmware volume to find. The
+ value 0 is the Boot Firmware Volume (BFV).
+ @param VolumeHandle Handle of the firmware volume header of the volume
+ to return.
@retval EFI_SUCCESS The volume was found.
@retval EFI_NOT_FOUND The volume was not found.
@@ -255,8 +259,9 @@ PeiServicesFfsFindNextVolume ( This service enables PEIMs to discover additional firmware files.
@param SearchType A filter to find files only of this type.
- @param VolumeHandle The pointer to the firmware volume header of the volume to search.
- This parameter must point to a valid FFS volume.
+ @param VolumeHandle The pointer to the firmware volume header of the
+ volume to search. This parameter must point to a
+ valid FFS volume.
@param FileHandle Handle of the current file from which to begin searching.
@retval EFI_SUCCESS The file was found.
@@ -282,8 +287,8 @@ PeiServicesFfsFindNextFile ( This service enables PEIMs to discover sections of a given type within a valid FFS file.
@param SectionType The value of the section type to find.
- @param FileHandle A pointer to the file header that contains the set of sections to
- be searched.
+ @param FileHandle A pointer to the file header that contains the set
+ of sections to be searched.
@param SectionData A pointer to the discovered section, if successful.
@retval EFI_SUCCESS The section was found.
@@ -330,8 +335,8 @@ PeiServicesInstallPeiMemory ( }
/**
- This service enables PEIMs to allocate memory after the permanent memory has been installed by a
- PEIM.
+ This service enables PEIMs to allocate memory after the permanent memory has been
+ installed by a PEIM.
@param MemoryType Type of memory to allocate.
@param Pages The number of pages to allocate.
@@ -361,8 +366,8 @@ PeiServicesAllocatePages ( This service allocates memory from the Hand-Off Block (HOB) heap.
@param Size The number of bytes to allocate from the pool.
- @param Buffer If the call succeeds, a pointer to a pointer to the allocate
- buffer; undefined otherwise.
+ @param Buffer If the call succeeds, a pointer to a pointer to
+ the allocate buffer; otherwise, undefined.
@retval EFI_SUCCESS The allocation was successful
@retval EFI_OUT_OF_RESOURCES There is not enough heap to allocate the requested size.
@@ -401,21 +406,21 @@ PeiServicesResetSystem ( }
/**
- This service is a wrapper for the PEI Service RegisterForShadow(), except the pointer to the PEI Services
- Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface
- Specification for details.
+ This service is a wrapper for the PEI Service RegisterForShadow(), except the
+ pointer to the PEI Services Table has been removed. See the Platform
+ Initialization Pre-EFI Initialization Core Interface Specification for details.
- @param FileHandle PEIM's file handle. Must be the currently
- executing PEIM.
+ @param FileHandle PEIM's file handle. Must be the currently
+ executing PEIM.
- @retval EFI_SUCCESS The PEIM was successfully registered for
- shadowing.
+ @retval EFI_SUCCESS The PEIM was successfully registered for
+ shadowing.
@retval EFI_ALREADY_STARTED The PEIM was previously
registered for shadowing.
- @retval EFI_NOT_FOUND The FileHandle does not refer to a
- valid file handle.
+ @retval EFI_NOT_FOUND The FileHandle does not refer to a
+ valid file handle.
**/
EFI_STATUS
EFIAPI
@@ -431,17 +436,17 @@ PeiServicesRegisterForShadow ( Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface
Specification for details.
- @param FileHandle Handle of the file.
+ @param FileHandle The handle of the file.
- @param FileInfo Upon exit, points to the file's
- information.
+ @param FileInfo Upon exit, points to the file's
+ information.
@retval EFI_SUCCESS File information returned.
@retval EFI_INVALID_PARAMETER If FileHandle does not
represent a valid file.
- @retval EFI_INVALID_PARAMETER If FileInfo is NULL.
+ @retval EFI_INVALID_PARAMETER FileInfo is NULL.
**/
EFI_STATUS
@@ -460,13 +465,13 @@ PeiServicesFfsGetFileInfo ( Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface
Specification for details.
- @param FileName A pointer to the name of the file to
- find within the firmware volume.
+ @param FileName A pointer to the name of the file to
+ find within the firmware volume.
- @param VolumeHandle The firmware volume to search FileHandle
- Upon exit, points to the found file's
- handle or NULL if it could not be found.
- @param FileHandle The pointer to found file handle
+ @param VolumeHandle The firmware volume to search FileHandle
+ Upon exit, points to the found file's
+ handle or NULL if it could not be found.
+ @param FileHandle The pointer to found file handle
@retval EFI_SUCCESS File was found.
@@ -493,10 +498,10 @@ PeiServicesFfsFindFileByName ( Table has been removed. See the Platform Initialization Pre-EFI Initialization Core Interface
Specification for details.
- @param VolumeHandle Handle of the volume.
+ @param VolumeHandle Handle of the volume.
- @param VolumeInfo Upon exit, points to the volume's
- information.
+ @param VolumeInfo Upon exit, points to the volume's
+ information.
@retval EFI_SUCCESS File information returned.
@@ -525,20 +530,26 @@ PeiServicesFfsGetVolumeInfo ( If the EFI_PEI_FIRMWARE_VOLUME_INFO_PPI can not be installed, then ASSERT().
- @param FvFormat Unique identifier of the format of the memory-mapped firmware volume.
- This parameter is optional and may be NULL.
- If NULL is specified, the EFI_FIRMWARE_FILE_SYSTEM2_GUID format is assumed.
- @param FvInfo Points to a buffer which allows the EFI_PEI_FIRMWARE_VOLUME_PPI to process the volume.
- The format of this buffer is specific to the FvFormat. For memory-mapped firmware volumes,
- this typically points to the first byte of the firmware volume.
- @param FvInfoSize The size, in bytes, of FvInfo. For memory-mapped firmware volumes,
- this is typically the size of the firmware volume.
- @param ParentFvName If the new firmware volume originated from a file in a different firmware volume,
- then this parameter specifies the GUID name of the originating firmware volume.
- Otherwise, this parameter must be NULL.
- @param ParentFileName If the new firmware volume originated from a file in a different firmware volume,
- then this parameter specifies the GUID file name of the originating firmware file.
- Otherwise, this parameter must be NULL.
+ @param FvFormat Unique identifier of the format of the memory-mapped
+ firmware volume. This parameter is optional and
+ may be NULL. If NULL is specified, the
+ EFI_FIRMWARE_FILE_SYSTEM2_GUID format is assumed.
+ @param FvInfo Points to a buffer which allows the
+ EFI_PEI_FIRMWARE_VOLUME_PPI to process the volume.
+ The format of this buffer is specific to the FvFormat.
+ For memory-mapped firmware volumes, this typically
+ points to the first byte of the firmware volume.
+ @param FvInfoSize The size, in bytes, of FvInfo. For memory-mapped
+ firmware volumes, this is typically the size of
+ the firmware volume.
+ @param ParentFvName If the new firmware volume originated from a file
+ in a different firmware volume, then this parameter
+ specifies the GUID name of the originating firmware
+ volume. Otherwise, this parameter must be NULL.
+ @param ParentFileName If the new firmware volume originated from a file
+ in a different firmware volume, then this parameter
+ specifies the GUID file name of the originating
+ firmware file. Otherwise, this parameter must be NULL.
**/
VOID
EFIAPI
diff --git a/MdePkg/Library/PeiServicesTablePointerLib/PeiServicesTablePointer.c b/MdePkg/Library/PeiServicesTablePointerLib/PeiServicesTablePointer.c index 7ed0c29bfa..9b02316af4 100644 --- a/MdePkg/Library/PeiServicesTablePointerLib/PeiServicesTablePointer.c +++ b/MdePkg/Library/PeiServicesTablePointerLib/PeiServicesTablePointer.c @@ -4,7 +4,7 @@ This library is used for PEIM which does executed from flash device directly but
executed in memory.
- Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>
+ Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
@@ -71,10 +71,10 @@ GetPeiServicesTablePointer ( The constructor function caches the pointer to PEI services.
It will always return EFI_SUCCESS.
- @param FileHandle Handle of FFS header the loaded driver.
- @param PeiServices The pointer to the PEI services.
+ @param FileHandle The handle of FFS header the loaded driver.
+ @param PeiServices The pointer to the PEI services.
- @retval EFI_SUCCESS The constructor always returns EFI_SUCCESS.
+ @retval EFI_SUCCESS The constructor always returns EFI_SUCCESS.
**/
EFI_STATUS
diff --git a/MdePkg/Library/PeiSmbusLibSmbus2Ppi/InternalSmbusLib.h b/MdePkg/Library/PeiSmbusLibSmbus2Ppi/InternalSmbusLib.h index 158b1a0f15..00f8078f76 100644 --- a/MdePkg/Library/PeiSmbusLibSmbus2Ppi/InternalSmbusLib.h +++ b/MdePkg/Library/PeiSmbusLibSmbus2Ppi/InternalSmbusLib.h @@ -1,7 +1,7 @@ /** @file
Internal header file for Smbus library.
-Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
@@ -52,14 +52,16 @@ InternalGetSmbusPpi ( as defined in the SmBus Specification. The data can either be of
the Length byte, word, or a block of data.
- @param SmbusOperation Signifies which particular SMBus hardware protocol instance that it will use to
- execute the SMBus transactions.
+ @param SmbusOperation Signifies which particular SMBus hardware protocol
+ instance that it will use to execute the SMBus transactions.
@param SmBusAddress The address that encodes the SMBUS Slave Address,
SMBUS Command, SMBUS Data Length, and PEC.
- @param Length Signifies the number of bytes that this operation will do. The maximum number of
- bytes can be revision specific and operation specific.
- @param Buffer Contains the value of data to execute to the SMBus slave device. Not all operations
- require this argument. The length of this buffer is identified by Length.
+ @param Length Signifies the number of bytes that this operation will
+ do. The maximum number of bytes can be revision specific
+ and operation specific.
+ @param Buffer Contains the value of data to execute to the SMBus slave
+ device. Not all operations require this argument. The
+ length of this buffer is identified by Length.
@param Status Return status for the executed command.
This is an optional parameter and may be NULL.
diff --git a/MdePkg/Library/PeiSmbusLibSmbus2Ppi/PeiSmbusLib.c b/MdePkg/Library/PeiSmbusLibSmbus2Ppi/PeiSmbusLib.c index 330ba45975..5821e9bb6d 100644 --- a/MdePkg/Library/PeiSmbusLibSmbus2Ppi/PeiSmbusLib.c +++ b/MdePkg/Library/PeiSmbusLibSmbus2Ppi/PeiSmbusLib.c @@ -1,7 +1,7 @@ /** @file
Implementation of SmBusLib class library for PEI phase.
-Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
@@ -46,14 +46,16 @@ InternalGetSmbusPpi ( as defined in the SmBus Specification. The data can either be of
the Length byte, word, or a block of data.
- @param SmbusOperation Signifies which particular SMBus hardware protocol instance that it will use to
- execute the SMBus transactions.
+ @param SmbusOperation Signifies which particular SMBus hardware protocol instance
+ that it will use to execute the SMBus transactions.
@param SmBusAddress The address that encodes the SMBUS Slave Address,
SMBUS Command, SMBUS Data Length, and PEC.
- @param Length Signifies the number of bytes that this operation will do. The maximum number of
- bytes can be revision specific and operation specific.
- @param Buffer Contains the value of data to execute to the SMBus slave device. Not all operations
- require this argument. The length of this buffer is identified by Length.
+ @param Length Signifies the number of bytes that this operation will
+ do. The maximum number of bytes can be revision specific
+ and operation specific.
+ @param Buffer Contains the value of data to execute to the SMBus slave
+ device. Not all operations require this argument. The
+ length of this buffer is identified by Length.
@param Status Return status for the executed command.
This is an optional parameter and may be NULL.
diff --git a/MdePkg/Library/PeiSmbusLibSmbus2Ppi/SmbusLib.c b/MdePkg/Library/PeiSmbusLibSmbus2Ppi/SmbusLib.c index 2d070ec544..42e9513f57 100644 --- a/MdePkg/Library/PeiSmbusLibSmbus2Ppi/SmbusLib.c +++ b/MdePkg/Library/PeiSmbusLibSmbus2Ppi/SmbusLib.c @@ -30,13 +30,15 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. SMBUS Command, SMBUS Data Length, and PEC.
@param Status Return status for the executed command.
This is an optional parameter and may be NULL.
- RETURN_SUCCESS The SMBUS command was executed.
- RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.
- RETURN_DEVICE_ERROR The request was not completed because a failure
- reflected in the Host Status Register bit. Device errors are a result
- of a transaction collision, illegal command field, unclaimed cycle
+ RETURN_SUCCESS: The SMBUS command was executed.
+ RETURN_TIMEOUT: A timeout occurred while executing the
+ SMBUS command.
+ RETURN_DEVICE_ERROR: The request was not completed because
+ a failure reflected in the Host Status Register bit.
+ Device errors are a result of a transaction collision,
+ illegal command field, unclaimed cycle
(host initiated), or bus errors (collisions).
- RETURN_UNSUPPORTED The SMBus operation is not supported.
+ RETURN_UNSUPPORTED: The SMBus operation is not supported.
**/
VOID
@@ -69,13 +71,15 @@ SmBusQuickRead ( SMBUS Command, SMBUS Data Length, and PEC.
@param Status Return status for the executed command.
This is an optional parameter and may be NULL.
- RETURN_SUCCESS The SMBUS command was executed.
- RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.
- RETURN_DEVICE_ERROR The request was not completed because a failure
- reflected in the Host Status Register bit. Device errors are a result
- of a transaction collision, illegal command field, unclaimed cycle
- (host initiated), or bus errors (collisions).
- RETURN_UNSUPPORTED The SMBus operation is not supported.
+ RETURN_SUCCESS: The SMBUS command was executed.
+ RETURN_TIMEOUT: A timeout occurred while executing the
+ SMBUS command.
+ RETURN_DEVICE_ERROR: The request was not completed because
+ a failure reflected in the Host Status Register bit. Device
+ errors are a result of a transaction collision, illegal
+ command field, unclaimed cycle (host initiated), or bus
+ errors (collisions).
+ RETURN_UNSUPPORTED:: The SMBus operation is not supported.
**/
VOID
@@ -108,14 +112,16 @@ SmBusQuickWrite ( SMBUS Command, SMBUS Data Length, and PEC.
@param Status Return status for the executed command.
This is an optional parameter and may be NULL.
- RETURN_SUCCESS The SMBUS command was executed.
- RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.
- RETURN_DEVICE_ERROR The request was not completed because a failure
- reflected in the Host Status Register bit. Device errors are a result
- of a transaction collision, illegal command field, unclaimed cycle
- (host initiated), or bus errors (collisions).
- RETURN_CRC_ERROR The checksum is not correct (PEC is incorrect)
- RETURN_UNSUPPORTED The SMBus operation is not supported.
+ RETURN_SUCCESS: The SMBUS command was executed.
+ RETURN_TIMEOUT: A timeout occurred while executing the
+ SMBUS command.
+ RETURN_DEVICE_ERROR: The request was not completed because
+ a failure reflected in the Host Status Register bit.
+ Device errors are a result of a transaction collision,
+ illegal command field, unclaimed cycle (host initiated),
+ or bus errors (collisions).
+ RETURN_CRC_ERROR: The checksum is not correct. (PEC is incorrect.)
+ RETURN_UNSUPPORTED: The SMBus operation is not supported.
@return The byte received from the SMBUS.
@@ -154,14 +160,16 @@ SmBusReceiveByte ( @param Value The 8-bit value to send.
@param Status Return status for the executed command.
This is an optional parameter and may be NULL.
- RETURN_SUCCESS The SMBUS command was executed.
- RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.
- RETURN_DEVICE_ERROR The request was not completed because a failure
- reflected in the Host Status Register bit. Device errors are a result
- of a transaction collision, illegal command field, unclaimed cycle
- (host initiated), or bus errors (collisions).
- RETURN_CRC_ERROR The checksum is not correct (PEC is incorrect)
- RETURN_UNSUPPORTED The SMBus operation is not supported.
+ RETURN_SUCCESS: The SMBUS command was executed.
+ RETURN_TIMEOUT: A timeout occurred while executing the
+ SMBUS command.
+ RETURN_DEVICE_ERROR: The request was not completed because
+ a failure reflected in the Host Status Register bit. Device
+ errors are a result of a transaction collision, illegal
+ command field, unclaimed cycle (host initiated), or bus
+ errors (collisions).
+ RETURN_CRC_ERROR: The checksum is not correct. (PEC is incorrect.)
+ RETURN_UNSUPPORTED: The SMBus operation is not supported.
@return The parameter of Value.
@@ -200,14 +208,16 @@ SmBusSendByte ( SMBUS Command, SMBUS Data Length, and PEC.
@param Status Return status for the executed command.
This is an optional parameter and may be NULL.
- RETURN_SUCCESS The SMBUS command was executed.
- RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.
- RETURN_DEVICE_ERROR The request was not completed because a failure
- reflected in the Host Status Register bit. Device errors are a result
- of a transaction collision, illegal command field, unclaimed cycle
- (host initiated), or bus errors (collisions).
- RETURN_CRC_ERROR The checksum is not correct (PEC is incorrect)
- RETURN_UNSUPPORTED The SMBus operation is not supported.
+ RETURN_SUCCESS: The SMBUS command was executed.
+ RETURN_TIMEOUT: A timeout occurred while executing the
+ SMBUS command.
+ RETURN_DEVICE_ERROR: The request was not completed because
+ a failure reflected in the Host Status Register bit.
+ Device errors are a result of a transaction collision,
+ illegal command field, unclaimed cycle (host initiated),
+ or bus errors (collisions).
+ RETURN_CRC_ERROR: The checksum is not correct. (PEC is incorrect.)
+ RETURN_UNSUPPORTED: The SMBus operation is not supported.
@return The byte read from the SMBUS.
@@ -245,14 +255,16 @@ SmBusReadDataByte ( @param Value The 8-bit value to write.
@param Status Return status for the executed command.
This is an optional parameter and may be NULL.
- RETURN_SUCCESS The SMBUS command was executed.
- RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.
- RETURN_DEVICE_ERROR The request was not completed because a failure
- reflected in the Host Status Register bit. Device errors are a result
- of a transaction collision, illegal command field, unclaimed cycle
- (host initiated), or bus errors (collisions).
- RETURN_CRC_ERROR The checksum is not correct (PEC is incorrect)
- RETURN_UNSUPPORTED The SMBus operation is not supported.
+ RETURN_SUCCESS: The SMBUS command was executed.
+ RETURN_TIMEOUT: A timeout occurred while executing the
+ SMBUS command.
+ RETURN_DEVICE_ERROR: The request was not completed because
+ a failure reflected in the Host Status Register bit.
+ Device errors are a result of a transaction collision,
+ illegal command field, unclaimed cycle (host initiated),
+ or bus errors (collisions).
+ RETURN_CRC_ERROR: The checksum is not correct. (PEC is incorrect.)
+ RETURN_UNSUPPORTED: The SMBus operation is not supported.
@return The parameter of Value.
@@ -290,14 +302,16 @@ SmBusWriteDataByte ( SMBUS Command, SMBUS Data Length, and PEC.
@param Status Return status for the executed command.
This is an optional parameter and may be NULL.
- RETURN_SUCCESS The SMBUS command was executed.
- RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.
- RETURN_DEVICE_ERROR The request was not completed because a failure
- reflected in the Host Status Register bit. Device errors are a result
- of a transaction collision, illegal command field, unclaimed cycle
- (host initiated), or bus errors (collisions).
- RETURN_CRC_ERROR The checksum is not correct (PEC is incorrect)
- RETURN_UNSUPPORTED The SMBus operation is not supported.
+ RETURN_SUCCESS: The SMBUS command was executed.
+ RETURN_TIMEOUT: A timeout occurred while executing the
+ SMBUS command.
+ RETURN_DEVICE_ERROR: The request was not completed because
+ a failure reflected in the Host Status Register bit.
+ Device errors are a result of a transaction collision,
+ illegal command field, unclaimed cycle (host initiated),
+ or bus errors (collisions).
+ RETURN_CRC_ERROR: The checksum is not correct. (PEC is incorrect.)
+ RETURN_UNSUPPORTED: The SMBus operation is not supported.
@return The byte read from the SMBUS.
@@ -335,14 +349,16 @@ SmBusReadDataWord ( @param Value The 16-bit value to write.
@param Status Return status for the executed command.
This is an optional parameter and may be NULL.
- RETURN_SUCCESS The SMBUS command was executed.
- RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.
- RETURN_DEVICE_ERROR The request was not completed because a failure
- reflected in the Host Status Register bit. Device errors are a result
- of a transaction collision, illegal command field, unclaimed cycle
- (host initiated), or bus errors (collisions).
- RETURN_CRC_ERROR The checksum is not correct (PEC is incorrect)
- RETURN_UNSUPPORTED The SMBus operation is not supported.
+ RETURN_SUCCESS: The SMBUS command was executed.
+ RETURN_TIMEOUT: A timeout occurred while executing the
+ SMBUS command.
+ RETURN_DEVICE_ERROR: The request was not completed because
+ a failure reflected in the Host Status Register bit.
+ Device errors are a result of a transaction collision,
+ illegal command field, unclaimed cycle (host initiated),
+ or bus errors (collisions).
+ RETURN_CRC_ERROR: The checksum is not correct. (PEC is incorrect.)
+ RETURN_UNSUPPORTED: The SMBus operation is not supported.
@return The parameter of Value.
@@ -382,14 +398,16 @@ SmBusWriteDataWord ( @param Value The 16-bit value to write.
@param Status Return status for the executed command.
This is an optional parameter and may be NULL.
- RETURN_SUCCESS The SMBUS command was executed.
- RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.
- RETURN_DEVICE_ERROR The request was not completed because a failure
- reflected in the Host Status Register bit. Device errors are a result
- of a transaction collision, illegal command field, unclaimed cycle
- (host initiated), or bus errors (collisions).
- RETURN_CRC_ERROR The checksum is not correct (PEC is incorrect)
- RETURN_UNSUPPORTED The SMBus operation is not supported.
+ RETURN_SUCCESS: The SMBUS command was executed.
+ RETURN_TIMEOUT: A timeout occurred while executing the
+ SMBUS command.
+ RETURN_DEVICE_ERROR: The request was not completed because
+ a failure reflected in the Host Status Register bit.
+ Device errors are a result of a transaction collision,
+ illegal command field, unclaimed cycle (host initiated),
+ or bus errors (collisions).
+ RETURN_CRC_ERROR: The checksum is not correct. (PEC is incorrect.)
+ RETURN_UNSUPPORTED: The SMBus operation is not supported.
@return The 16-bit value returned by the process call command.
@@ -429,14 +447,16 @@ SmBusProcessCall ( @param Buffer The pointer to the buffer to store the bytes read from the SMBUS.
@param Status Return status for the executed command.
This is an optional parameter and may be NULL.
- RETURN_SUCCESS The SMBUS command was executed.
- RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.
- RETURN_DEVICE_ERROR The request was not completed because a failure
- reflected in the Host Status Register bit. Device errors are a result
- of a transaction collision, illegal command field, unclaimed cycle
- (host initiated), or bus errors (collisions).
- RETURN_CRC_ERROR The checksum is not correct (PEC is incorrect)
- RETURN_UNSUPPORTED The SMBus operation is not supported.
+ RETURN_SUCCESS: The SMBUS command was executed.
+ RETURN_TIMEOUT: A timeout occurred while executing the
+ SMBUS command.
+ RETURN_DEVICE_ERROR: The request was not completed because
+ a failure reflected in the Host Status Register bit.
+ Device errors are a result of a transaction collision,
+ illegal command field, unclaimed cycle (host initiated),
+ or bus errors (collisions).
+ RETURN_CRC_ERROR: The checksum is not correct. (PEC is incorrect.)
+ RETURN_UNSUPPORTED: The SMBus operation is not supported.
@return The number of bytes read.
@@ -473,13 +493,15 @@ SmBusReadBlock ( @param Buffer The pointer to the buffer to store the bytes read from the SMBUS.
@param Status Return status for the executed command.
This is an optional parameter and may be NULL.
- RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.
- RETURN_DEVICE_ERROR The request was not completed because a failure
- reflected in the Host Status Register bit. Device errors are a result
- of a transaction collision, illegal command field, unclaimed cycle
- (host initiated), or bus errors (collisions).
- RETURN_CRC_ERROR The checksum is not correct (PEC is incorrect)
- RETURN_UNSUPPORTED The SMBus operation is not supported.
+ RETURN_TIMEOUT: A timeout occurred while executing the
+ SMBUS command.
+ RETURN_DEVICE_ERROR: The request was not completed because
+ a failure reflected in the Host Status Register bit.
+ Device errors are a result of a transaction collision,
+ illegal command field, unclaimed cycle (host initiated),
+ or bus errors (collisions).
+ RETURN_CRC_ERROR: The checksum is not correct (PEC is incorrect)
+ RETURN_UNSUPPORTED: The SMBus operation is not supported.
@return The number of bytes written.
@@ -523,13 +545,15 @@ SmBusWriteBlock ( @param ReadBuffer The pointer to the buffer of bytes to read from the SMBUS.
@param Status Return status for the executed command.
This is an optional parameter and may be NULL.
- RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.
- RETURN_DEVICE_ERROR The request was not completed because a failure
- reflected in the Host Status Register bit. Device errors are a result
- of a transaction collision, illegal command field, unclaimed cycle
- (host initiated), or bus errors (collisions).
- RETURN_CRC_ERROR The checksum is not correct (PEC is incorrect)
- RETURN_UNSUPPORTED The SMBus operation is not supported.
+ RETURN_TIMEOUT: A timeout occurred while executing the
+ SMBUS command.
+ RETURN_DEVICE_ERROR: The request was not completed because
+ a failure reflected in the Host Status Register bit.
+ Device errors are a result of a transaction collision,
+ illegal command field, unclaimed cycle (host initiated),
+ or bus errors (collisions).
+ RETURN_CRC_ERROR The checksum is not correct. (PEC is incorrect.)
+ RETURN_UNSUPPORTED: The SMBus operation is not supported.
@return The number of bytes written.
diff --git a/MdePkg/Library/PeimEntryPoint/PeimEntryPoint.c b/MdePkg/Library/PeimEntryPoint/PeimEntryPoint.c index 57ae73c07b..83a1bd8ccc 100644 --- a/MdePkg/Library/PeimEntryPoint/PeimEntryPoint.c +++ b/MdePkg/Library/PeimEntryPoint/PeimEntryPoint.c @@ -5,7 +5,7 @@ Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR> This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
-http://opensource.org/licenses/bsd-license.php
+http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
diff --git a/MdePkg/Library/SmmIoLibSmmCpuIo2/IoHighLevel.c b/MdePkg/Library/SmmIoLibSmmCpuIo2/IoHighLevel.c index 0f3b3755aa..5d2697e270 100644 --- a/MdePkg/Library/SmmIoLibSmmCpuIo2/IoHighLevel.c +++ b/MdePkg/Library/SmmIoLibSmmCpuIo2/IoHighLevel.c @@ -1242,7 +1242,7 @@ MmioAndThenOr8 ( If EndBit is greater than 7, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to read.
+ @param Address The MMIO register to read.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..7.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1274,7 +1274,7 @@ MmioBitFieldRead8 ( If EndBit is greater than 7, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..7.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1315,7 +1315,7 @@ MmioBitFieldWrite8 ( If EndBit is greater than 7, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..7.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1356,7 +1356,7 @@ MmioBitFieldOr8 ( If EndBit is greater than 7, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..7.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1398,7 +1398,7 @@ MmioBitFieldAnd8 ( If EndBit is greater than 7, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..7.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1524,7 +1524,7 @@ MmioAndThenOr16 ( If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to read.
+ @param Address The MMIO register to read.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..15.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1556,7 +1556,7 @@ MmioBitFieldRead16 ( If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..15.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1597,7 +1597,7 @@ MmioBitFieldWrite16 ( If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..15.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1638,7 +1638,7 @@ MmioBitFieldOr16 ( If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..15.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1680,7 +1680,7 @@ MmioBitFieldAnd16 ( If EndBit is greater than 15, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..15.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1806,7 +1806,7 @@ MmioAndThenOr32 ( If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to read.
+ @param Address The MMIO register to read.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..31.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1838,7 +1838,7 @@ MmioBitFieldRead32 ( If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..31.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1879,7 +1879,7 @@ MmioBitFieldWrite32 ( If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..31.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1920,7 +1920,7 @@ MmioBitFieldOr32 ( If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..31.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -1962,7 +1962,7 @@ MmioBitFieldAnd32 ( If EndBit is greater than 31, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..31.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -2088,7 +2088,7 @@ MmioAndThenOr64 ( If EndBit is greater than 63, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to read.
+ @param Address The MMIO register to read.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..63.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -2120,7 +2120,7 @@ MmioBitFieldRead64 ( If EndBit is greater than 63, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..63.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -2161,7 +2161,7 @@ MmioBitFieldWrite64 ( If EndBit is greater than 63, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..63.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -2202,7 +2202,7 @@ MmioBitFieldOr64 ( If EndBit is greater than 63, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..63.
@param EndBit The ordinal of the most significant bit in the bit field.
@@ -2244,7 +2244,7 @@ MmioBitFieldAnd64 ( If EndBit is greater than 63, then ASSERT().
If EndBit is less than StartBit, then ASSERT().
- @param Address MMIO register to write.
+ @param Address The MMIO register to write.
@param StartBit The ordinal of the least significant bit in the bit field.
Range 0..63.
@param EndBit The ordinal of the most significant bit in the bit field.
diff --git a/MdePkg/Library/SmmIoLibSmmCpuIo2/IoLibMmioBuffer.c b/MdePkg/Library/SmmIoLibSmmCpuIo2/IoLibMmioBuffer.c index ce1f93043a..8682d51dab 100644 --- a/MdePkg/Library/SmmIoLibSmmCpuIo2/IoLibMmioBuffer.c +++ b/MdePkg/Library/SmmIoLibSmmCpuIo2/IoLibMmioBuffer.c @@ -222,8 +222,9 @@ MmioReadBuffer64 ( @param StartAddress The starting address for the MMIO region to be copied to.
- @param Length The size in bytes of the copy.
- @param Buffer The pointer to a system memory buffer containing the data to write.
+ @param Length The size in bytes of the copy.
+ @param Buffer The pointer to a system memory buffer containing the
+ data to write.
@return Buffer
@@ -268,8 +269,9 @@ MmioWriteBuffer8 ( If Buffer is not aligned on a 16-bit boundary, then ASSERT().
@param StartAddress The starting address for the MMIO region to be copied to.
- @param Length The size in bytes of the copy.
- @param Buffer The pointer to a system memory buffer containing the data to write.
+ @param Length The size in bytes of the copy.
+ @param Buffer The pointer to a system memory buffer containing the
+ data to write.
@return Buffer
@@ -322,8 +324,9 @@ MmioWriteBuffer16 ( If Buffer is not aligned on a 32-bit boundary, then ASSERT().
@param StartAddress The starting address for the MMIO region to be copied to.
- @param Length The size in bytes of the copy.
- @param Buffer The pointer to a system memory buffer containing the data to write.
+ @param Length The size in bytes of the copy.
+ @param Buffer The pointer to a system memory buffer containing the
+ data to write.
@return Buffer
@@ -375,8 +378,9 @@ MmioWriteBuffer32 ( If Buffer is not aligned on a 64-bit boundary, then ASSERT().
@param StartAddress The starting address for the MMIO region to be copied to.
- @param Length The size in bytes of the copy.
- @param Buffer The pointer to a system memory buffer containing the data to write.
+ @param Length The size in bytes of the copy.
+ @param Buffer The pointer to a system memory buffer containing the
+ data to write.
@return Buffer
diff --git a/MdePkg/Library/SmmLibNull/SmmLibNull.c b/MdePkg/Library/SmmLibNull/SmmLibNull.c index a481c4ebd5..60c8adb133 100644 --- a/MdePkg/Library/SmmLibNull/SmmLibNull.c +++ b/MdePkg/Library/SmmLibNull/SmmLibNull.c @@ -51,11 +51,12 @@ TriggerRuntimeSoftwareSmi ( /**
Test if a boot time software SMI happened.
- This function tests if a software SMM interrupt happened. If a software SMM interrupt happened and
- it was triggered at boot time, it returns TRUE. Otherwise, it returns FALSE.
+ This function tests if a software SMM interrupt happened. If a software SMM
+ interrupt happened and it was triggered at boot time, it returns TRUE. Otherwise,
+ it returns FALSE.
@retval TRUE A software SMI triggered at boot time happened.
- @retval FLASE No software SMI happened or the software SMI was triggered at run time.
+ @retval FALSE No software SMI happened or the software SMI was triggered at run time.
**/
BOOLEAN
@@ -71,11 +72,12 @@ IsBootServiceSoftwareSmi ( /**
Test if a run time software SMI happened.
- This function tests if a software SMM interrupt happened. If a software SMM interrupt happened and
- it was triggered at run time, it returns TRUE. Otherwise, it returns FALSE.
+ This function tests if a software SMM interrupt happened. If a software SMM
+ interrupt happened and it was triggered at run time, it returns TRUE. Otherwise,
+ it returns FALSE.
@retval TRUE A software SMI triggered at run time happened.
- @retval FLASE No software SMI happened or the software SMI was triggered at boot time.
+ @retval FALSE No software SMI happened or the software SMI was triggered at boot time.
**/
BOOLEAN
diff --git a/MdePkg/Library/SmmMemoryAllocationLib/MemoryAllocationLib.c b/MdePkg/Library/SmmMemoryAllocationLib/MemoryAllocationLib.c index 3a539e3643..f8ab33a44a 100644 --- a/MdePkg/Library/SmmMemoryAllocationLib/MemoryAllocationLib.c +++ b/MdePkg/Library/SmmMemoryAllocationLib/MemoryAllocationLib.c @@ -32,9 +32,10 @@ /**
Allocates one or more 4KB pages of a certain memory type.
- Allocates the number of 4KB pages of a certain memory type and returns a pointer to the allocated
- buffer. The buffer returned is aligned on a 4KB boundary. If Pages is 0, then NULL is returned.
- If there is not enough memory remaining to satisfy the request, then NULL is returned.
+ Allocates the number of 4KB pages of a certain memory type and returns a pointer
+ to the allocated buffer. The buffer returned is aligned on a 4KB boundary. If
+ Pages is 0, then NULL is returned. If there is not enough memory remaining to
+ satisfy the request, then NULL is returned.
@param MemoryType The type of memory to allocate.
@param Pages The number of 4 KB pages to allocate.
@@ -65,10 +66,10 @@ InternalAllocatePages ( /**
Allocates one or more 4KB pages of type EfiBootServicesData.
- Allocates the number of 4KB pages of type EfiBootServicesData and returns a pointer to the
- allocated buffer. The buffer returned is aligned on a 4KB boundary. If Pages is 0, then NULL
- is returned. If there is not enough memory remaining to satisfy the request, then NULL is
- returned.
+ Allocates the number of 4KB pages of type EfiBootServicesData and returns a pointer
+ to the allocated buffer. The buffer returned is aligned on a 4KB boundary. If
+ Pages is 0, then NULL is returned. If there is not enough memory remaining to
+ satisfy the request, then NULL is returned.
@param Pages The number of 4 KB pages to allocate.
@@ -87,10 +88,10 @@ AllocatePages ( /**
Allocates one or more 4KB pages of type EfiRuntimeServicesData.
- Allocates the number of 4KB pages of type EfiRuntimeServicesData and returns a pointer to the
- allocated buffer. The buffer returned is aligned on a 4KB boundary. If Pages is 0, then NULL
- is returned. If there is not enough memory remaining to satisfy the request, then NULL is
- returned.
+ Allocates the number of 4KB pages of type EfiRuntimeServicesData and returns a
+ pointer to the allocated buffer. The buffer returned is aligned on a 4KB boundary.
+ If Pages is 0, then NULL is returned. If there is not enough memory remaining
+ to satisfy the request, then NULL is returned.
@param Pages The number of 4 KB pages to allocate.
@@ -109,10 +110,10 @@ AllocateRuntimePages ( /**
Allocates one or more 4KB pages of type EfiReservedMemoryType.
- Allocates the number of 4KB pages of type EfiReservedMemoryType and returns a pointer to the
- allocated buffer. The buffer returned is aligned on a 4KB boundary. If Pages is 0, then NULL
- is returned. If there is not enough memory remaining to satisfy the request, then NULL is
- returned.
+ Allocates the number of 4KB pages of type EfiReservedMemoryType and returns a
+ pointer to the allocated buffer. The buffer returned is aligned on a 4KB boundary.
+ If Pages is 0, then NULL is returned. If there is not enough memory remaining
+ to satisfy the request, then NULL is returned.
@param Pages The number of 4 KB pages to allocate.
@@ -132,13 +133,13 @@ AllocateReservedPages ( Frees one or more 4KB pages that were previously allocated with one of the page allocation
functions in the Memory Allocation Library.
- Frees the number of 4KB pages specified by Pages from the buffer specified by Buffer. Buffer
- must have been allocated on a previous call to the page allocation services of the Memory
- Allocation Library. If it is not possible to free allocated pages, then this function will
- perform no actions.
+ Frees the number of 4KB pages specified by Pages from the buffer specified by Buffer.
+ Buffer must have been allocated on a previous call to the page allocation services
+ of the Memory Allocation Library. If it is not possible to free allocated pages,
+ then this function will perform no actions.
- If Buffer was not allocated with a page allocation function in the Memory Allocation Library,
- then ASSERT().
+ If Buffer was not allocated with a page allocation function in the Memory Allocation
+ Library, then ASSERT().
If Pages is zero, then ASSERT().
@param Buffer The pointer to the buffer of pages to free.
@@ -162,15 +163,16 @@ FreePages ( /**
Allocates one or more 4KB pages of a certain memory type at a specified alignment.
- Allocates the number of 4KB pages specified by Pages of a certain memory type with an alignment
- specified by Alignment. The allocated buffer is returned. If Pages is 0, then NULL is returned.
- If there is not enough memory at the specified alignment remaining to satisfy the request, then
- NULL is returned.
+ Allocates the number of 4KB pages specified by Pages of a certain memory type
+ with an alignment specified by Alignment. The allocated buffer is returned.
+ If Pages is 0, then NULL is returned. If there is not enough memory at the
+ specified alignment remaining to satisfy the request, then NULL is returned.
If Alignment is not a power of two and Alignment is not zero, then ASSERT().
@param MemoryType The type of memory to allocate.
@param Pages The number of 4 KB pages to allocate.
- @param Alignment The requested alignment of the allocation. Must be a power of two.
+ @param Alignment The requested alignment of the allocation.
+ Must be a power of two.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
@@ -247,15 +249,16 @@ InternalAllocateAlignedPages ( /**
Allocates one or more 4KB pages of type EfiBootServicesData at a specified alignment.
- Allocates the number of 4KB pages specified by Pages of type EfiBootServicesData with an
- alignment specified by Alignment. The allocated buffer is returned. If Pages is 0, then NULL is
- returned. If there is not enough memory at the specified alignment remaining to satisfy the
- request, then NULL is returned.
+ Allocates the number of 4KB pages specified by Pages of type EfiBootServicesData
+ with an alignment specified by Alignment. The allocated buffer is returned.
+ If Pages is 0, then NULL is returned. If there is not enough memory at the
+ specified alignment remaining to satisfy the request, then NULL is returned.
If Alignment is not a power of two and Alignment is not zero, then ASSERT().
@param Pages The number of 4 KB pages to allocate.
- @param Alignment The requested alignment of the allocation. Must be a power of two.
+ @param Alignment The requested alignment of the allocation.
+ Must be a power of two.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
@@ -274,15 +277,16 @@ AllocateAlignedPages ( /**
Allocates one or more 4KB pages of type EfiRuntimeServicesData at a specified alignment.
- Allocates the number of 4KB pages specified by Pages of type EfiRuntimeServicesData with an
- alignment specified by Alignment. The allocated buffer is returned. If Pages is 0, then NULL is
- returned. If there is not enough memory at the specified alignment remaining to satisfy the
- request, then NULL is returned.
+ Allocates the number of 4KB pages specified by Pages of type EfiRuntimeServicesData
+ with an alignment specified by Alignment. The allocated buffer is returned.
+ If Pages is 0, then NULL is returned. If there is not enough memory at the
+ specified alignment remaining to satisfy the request, then NULL is returned.
If Alignment is not a power of two and Alignment is not zero, then ASSERT().
@param Pages The number of 4 KB pages to allocate.
- @param Alignment The requested alignment of the allocation. Must be a power of two.
+ @param Alignment The requested alignment of the allocation.
+ Must be a power of two.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
@@ -301,15 +305,16 @@ AllocateAlignedRuntimePages ( /**
Allocates one or more 4KB pages of type EfiReservedMemoryType at a specified alignment.
- Allocates the number of 4KB pages specified by Pages of type EfiReservedMemoryType with an
- alignment specified by Alignment. The allocated buffer is returned. If Pages is 0, then NULL is
- returned. If there is not enough memory at the specified alignment remaining to satisfy the
- request, then NULL is returned.
+ Allocates the number of 4KB pages specified by Pages of type EfiReservedMemoryType
+ with an alignment specified by Alignment. The allocated buffer is returned.
+ If Pages is 0, then NULL is returned. If there is not enough memory at the
+ specified alignment remaining to satisfy the request, then NULL is returned.
If Alignment is not a power of two and Alignment is not zero, then ASSERT().
@param Pages The number of 4 KB pages to allocate.
- @param Alignment The requested alignment of the allocation. Must be a power of two.
+ @param Alignment The requested alignment of the allocation.
+ Must be a power of two.
If Alignment is zero, then byte alignment is used.
@return A pointer to the allocated buffer or NULL if allocation fails.
@@ -329,13 +334,13 @@ AllocateAlignedReservedPages ( Frees one or more 4KB pages that were previously allocated with one of the aligned page
allocation functions in the Memory Allocation Library.
- Frees the number of 4KB pages specified by Pages from the buffer specified by Buffer. Buffer
- must have been allocated on a previous call to the aligned page allocation services of the Memory
- Allocation Library. If it is not possible to free allocated pages, then this function will
- perform no actions.
+ Frees the number of 4KB pages specified by Pages from the buffer specified by
+ Buffer. Buffer must have been allocated on a previous call to the aligned page
+ allocation services of the Memory Allocation Library. If it is not possible to
+ free allocated pages, then this function will perform no actions.
- If Buffer was not allocated with an aligned page allocation function in the Memory Allocation
- Library, then ASSERT().
+ If Buffer was not allocated with an aligned page allocation function in the
+ Memory Allocation Library, then ASSERT().
If Pages is zero, then ASSERT().
@param Buffer The pointer to the buffer of pages to free.
@@ -359,9 +364,10 @@ FreeAlignedPages ( /**
Allocates a buffer of a certain pool type.
- Allocates the number bytes specified by AllocationSize of a certain pool type and returns a
- pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is
- returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.
+ Allocates the number bytes specified by AllocationSize of a certain pool type
+ and returns a pointer to the allocated buffer. If AllocationSize is 0, then a
+ valid buffer of 0 size is returned. If there is not enough memory remaining to
+ satisfy the request, then NULL is returned.
@param MemoryType The type of memory to allocate.
@param AllocationSize The number of bytes to allocate.
@@ -388,9 +394,10 @@ InternalAllocatePool ( /**
Allocates a buffer of type EfiBootServicesData.
- Allocates the number bytes specified by AllocationSize of type EfiBootServicesData and returns a
- pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is
- returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.
+ Allocates the number bytes specified by AllocationSize of type EfiBootServicesData
+ and returns a pointer to the allocated buffer. If AllocationSize is 0, then a
+ valid buffer of 0 size is returned. If there is not enough memory remaining to
+ satisfy the request, then NULL is returned.
@param AllocationSize The number of bytes to allocate.
@@ -409,9 +416,10 @@ AllocatePool ( /**
Allocates a buffer of type EfiRuntimeServicesData.
- Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData and returns
- a pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is
- returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.
+ Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData
+ and returns a pointer to the allocated buffer. If AllocationSize is 0, then a
+ valid buffer of 0 size is returned. If there is not enough memory remaining to
+ satisfy the request, then NULL is returned.
@param AllocationSize The number of bytes to allocate.
@@ -430,9 +438,10 @@ AllocateRuntimePool ( /**
Allocates a buffer of type EfiReservedMemoryType.
- Allocates the number bytes specified by AllocationSize of type EfiReservedMemoryType and returns
- a pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is
- returned. If there is not enough memory remaining to satisfy the request, then NULL is returned.
+ Allocates the number bytes specified by AllocationSize of type EfiReservedMemoryType
+ and returns a pointer to the allocated buffer. If AllocationSize is 0, then a
+ valid buffer of 0 size is returned. If there is not enough memory remaining to
+ satisfy the request, then NULL is returned.
@param AllocationSize The number of bytes to allocate.
@@ -451,10 +460,10 @@ AllocateReservedPool ( /**
Allocates and zeros a buffer of a certain pool type.
- Allocates the number bytes specified by AllocationSize of a certain pool type, clears the buffer
- with zeros, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a valid
- buffer of 0 size is returned. If there is not enough memory remaining to satisfy the request,
- then NULL is returned.
+ Allocates the number bytes specified by AllocationSize of a certain pool type,
+ clears the buffer with zeros, and returns a pointer to the allocated buffer.
+ If AllocationSize is 0, then a valid buffer of 0 size is returned. If there is
+ not enough memory remaining to satisfy the request, then NULL is returned.
@param PoolType The type of memory to allocate.
@param AllocationSize The number of bytes to allocate and zero.
@@ -480,10 +489,10 @@ InternalAllocateZeroPool ( /**
Allocates and zeros a buffer of type EfiBootServicesData.
- Allocates the number bytes specified by AllocationSize of type EfiBootServicesData, clears the
- buffer with zeros, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a
- valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the
- request, then NULL is returned.
+ Allocates the number bytes specified by AllocationSize of type EfiBootServicesData,
+ clears the buffer with zeros, and returns a pointer to the allocated buffer.
+ If AllocationSize is 0, then a valid buffer of 0 size is returned. If there is
+ not enough memory remaining to satisfy the request, then NULL is returned.
@param AllocationSize The number of bytes to allocate and zero.
@@ -502,10 +511,10 @@ AllocateZeroPool ( /**
Allocates and zeros a buffer of type EfiRuntimeServicesData.
- Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData, clears the
- buffer with zeros, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a
- valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the
- request, then NULL is returned.
+ Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData,
+ clears the buffer with zeros, and returns a pointer to the allocated buffer.
+ If AllocationSize is 0, then a valid buffer of 0 size is returned. If there is
+ not enough memory remaining to satisfy the request, then NULL is returned.
@param AllocationSize The number of bytes to allocate and zero.
@@ -524,10 +533,10 @@ AllocateRuntimeZeroPool ( /**
Allocates and zeros a buffer of type EfiReservedMemoryType.
- Allocates the number bytes specified by AllocationSize of type EfiReservedMemoryType, clears the
- buffer with zeros, and returns a pointer to the allocated buffer. If AllocationSize is 0, then a
- valid buffer of 0 size is returned. If there is not enough memory remaining to satisfy the
- request, then NULL is returned.
+ Allocates the number bytes specified by AllocationSize of type EfiReservedMemoryType,
+ clears the buffer with zeros, and returns a pointer to the allocated buffer.
+ If AllocationSize is 0, then a valid buffer of 0 size is returned. If there is
+ not enough memory remaining to satisfy the request, then NULL is returned.
@param AllocationSize The number of bytes to allocate and zero.
@@ -546,11 +555,11 @@ AllocateReservedZeroPool ( /**
Copies a buffer to an allocated buffer of a certain pool type.
- Allocates the number bytes specified by AllocationSize of a certain pool type, copies
- AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the
- allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there
- is not enough memory remaining to satisfy the request, then NULL is returned.
- If Buffer is NULL, then ASSERT().
+ Allocates the number bytes specified by AllocationSize of a certain pool type,
+ copies AllocationSize bytes from Buffer to the newly allocated buffer, and returns
+ a pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer
+ of 0 size is returned. If there is not enough memory remaining to satisfy the
+ request, then NULL is returned. If Buffer is NULL, then ASSERT().
If AllocationSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
@param PoolType The type of pool to allocate.
@@ -582,10 +591,11 @@ InternalAllocateCopyPool ( /**
Copies a buffer to an allocated buffer of type EfiBootServicesData.
- Allocates the number bytes specified by AllocationSize of type EfiBootServicesData, copies
- AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the
- allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there
- is not enough memory remaining to satisfy the request, then NULL is returned.
+ Allocates the number bytes specified by AllocationSize of type EfiBootServicesData,
+ copies AllocationSize bytes from Buffer to the newly allocated buffer, and returns
+ a pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer
+ of 0 size is returned. If there is not enough memory remaining to satisfy the
+ request, then NULL is returned.
If Buffer is NULL, then ASSERT().
If AllocationSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
@@ -609,10 +619,11 @@ AllocateCopyPool ( /**
Copies a buffer to an allocated buffer of type EfiRuntimeServicesData.
- Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData, copies
- AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the
- allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there
- is not enough memory remaining to satisfy the request, then NULL is returned.
+ Allocates the number bytes specified by AllocationSize of type EfiRuntimeServicesData,
+ copies AllocationSize bytes from Buffer to the newly allocated buffer, and returns
+ a pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer
+ of 0 size is returned. If there is not enough memory remaining to satisfy the
+ request, then NULL is returned.
If Buffer is NULL, then ASSERT().
If AllocationSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
@@ -636,10 +647,11 @@ AllocateRuntimeCopyPool ( /**
Copies a buffer to an allocated buffer of type EfiReservedMemoryType.
- Allocates the number bytes specified by AllocationSize of type EfiReservedMemoryType, copies
- AllocationSize bytes from Buffer to the newly allocated buffer, and returns a pointer to the
- allocated buffer. If AllocationSize is 0, then a valid buffer of 0 size is returned. If there
- is not enough memory remaining to satisfy the request, then NULL is returned.
+ Allocates the number bytes specified by AllocationSize of type EfiReservedMemoryType,
+ copies AllocationSize bytes from Buffer to the newly allocated buffer, and returns
+ a pointer to the allocated buffer. If AllocationSize is 0, then a valid buffer
+ of 0 size is returned. If there is not enough memory remaining to satisfy the
+ request, then NULL is returned.
If Buffer is NULL, then ASSERT().
If AllocationSize is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
@@ -670,14 +682,14 @@ AllocateReservedCopyPool ( If NewSize is 0, then a valid buffer of 0 size is returned. If there is not
enough memory remaining to satisfy the request, then NULL is returned.
- If the allocation of the new buffer is successful and the smaller of NewSize and OldSize
- is greater than (MAX_ADDRESS - OldBuffer + 1), then ASSERT().
+ If the allocation of the new buffer is successful and the smaller of NewSize
+ and OldSize is greater than (MAX_ADDRESS - OldBuffer + 1), then ASSERT().
@param PoolType The type of pool to allocate.
@param OldSize The size, in bytes, of OldBuffer.
@param NewSize The size, in bytes, of the buffer to reallocate.
- @param OldBuffer The buffer to copy to the allocated buffer. This is an optional
- parameter that may be NULL.
+ @param OldBuffer The buffer to copy to the allocated buffer. This is an
+ optional parameter that may be NULL.
@return A pointer to the allocated buffer or NULL if allocation fails.
@@ -710,13 +722,13 @@ InternalReallocatePool ( If NewSize is 0, then a valid buffer of 0 size is returned. If there is not
enough memory remaining to satisfy the request, then NULL is returned.
- If the allocation of the new buffer is successful and the smaller of NewSize and OldSize
- is greater than (MAX_ADDRESS - OldBuffer + 1), then ASSERT().
+ If the allocation of the new buffer is successful and the smaller of NewSize
+ and OldSize is greater than (MAX_ADDRESS - OldBuffer + 1), then ASSERT().
@param OldSize The size, in bytes, of OldBuffer.
@param NewSize The size, in bytes, of the buffer to reallocate.
- @param OldBuffer The buffer to copy to the allocated buffer. This is an optional
- parameter that may be NULL.
+ @param OldBuffer The buffer to copy to the allocated buffer. This is an
+ optional parameter that may be NULL.
@return A pointer to the allocated buffer or NULL if allocation fails.
@@ -736,19 +748,19 @@ ReallocatePool ( Reallocates a buffer of type EfiRuntimeServicesData.
Allocates and zeros the number bytes specified by NewSize from memory of type
- EfiRuntimeServicesData. If OldBuffer is not NULL, then the smaller of OldSize and
- NewSize bytes are copied from OldBuffer to the newly allocated buffer, and
+ EfiRuntimeServicesData. If OldBuffer is not NULL, then the smaller of OldSize
+ and NewSize bytes are copied from OldBuffer to the newly allocated buffer, and
OldBuffer is freed. A pointer to the newly allocated buffer is returned.
If NewSize is 0, then a valid buffer of 0 size is returned. If there is not
enough memory remaining to satisfy the request, then NULL is returned.
- If the allocation of the new buffer is successful and the smaller of NewSize and OldSize
- is greater than (MAX_ADDRESS - OldBuffer + 1), then ASSERT().
+ If the allocation of the new buffer is successful and the smaller of NewSize
+ and OldSize is greater than (MAX_ADDRESS - OldBuffer + 1), then ASSERT().
@param OldSize The size, in bytes, of OldBuffer.
@param NewSize The size, in bytes, of the buffer to reallocate.
- @param OldBuffer The buffer to copy to the allocated buffer. This is an optional
- parameter that may be NULL.
+ @param OldBuffer The buffer to copy to the allocated buffer. This is an
+ optional parameter that may be NULL.
@return A pointer to the allocated buffer or NULL if allocation fails.
@@ -768,19 +780,19 @@ ReallocateRuntimePool ( Reallocates a buffer of type EfiReservedMemoryType.
Allocates and zeros the number bytes specified by NewSize from memory of type
- EfiReservedMemoryType. If OldBuffer is not NULL, then the smaller of OldSize and
- NewSize bytes are copied from OldBuffer to the newly allocated buffer, and
+ EfiReservedMemoryType. If OldBuffer is not NULL, then the smaller of OldSize
+ and NewSize bytes are copied from OldBuffer to the newly allocated buffer, and
OldBuffer is freed. A pointer to the newly allocated buffer is returned.
If NewSize is 0, then a valid buffer of 0 size is returned. If there is not
enough memory remaining to satisfy the request, then NULL is returned.
- If the allocation of the new buffer is successful and the smaller of NewSize and OldSize
- is greater than (MAX_ADDRESS - OldBuffer + 1), then ASSERT().
+ If the allocation of the new buffer is successful and the smaller of NewSize
+ and OldSize is greater than (MAX_ADDRESS - OldBuffer + 1), then ASSERT().
@param OldSize The size, in bytes, of OldBuffer.
@param NewSize The size, in bytes, of the buffer to reallocate.
- @param OldBuffer The buffer to copy to the allocated buffer. This is an optional
- parameter that may be NULL.
+ @param OldBuffer The buffer to copy to the allocated buffer. This is an
+ optional parameter that may be NULL.
@return A pointer to the allocated buffer or NULL if allocation fails.
@@ -797,15 +809,16 @@ ReallocateReservedPool ( }
/**
- Frees a buffer that was previously allocated with one of the pool allocation functions in the
- Memory Allocation Library.
+ Frees a buffer that was previously allocated with one of the pool allocation
+ functions in the Memory Allocation Library.
- Frees the buffer specified by Buffer. Buffer must have been allocated on a previous call to the
- pool allocation services of the Memory Allocation Library. If it is not possible to free pool
- resources, then this function will perform no actions.
+ Frees the buffer specified by Buffer. Buffer must have been allocated on a
+ previous call to the pool allocation services of the Memory Allocation Library.
+ If it is not possible to free pool resources, then this function will perform
+ no actions.
- If Buffer was not allocated with a pool allocation function in the Memory Allocation Library,
- then ASSERT().
+ If Buffer was not allocated with a pool allocation function in the Memory
+ Allocation Library, then ASSERT().
@param Buffer The pointer to the buffer to free.
diff --git a/MdePkg/Library/SmmPciLibPciRootBridgeIo/PciLib.c b/MdePkg/Library/SmmPciLibPciRootBridgeIo/PciLib.c index ec883c9e7a..d8b7e72dbd 100644 --- a/MdePkg/Library/SmmPciLibPciRootBridgeIo/PciLib.c +++ b/MdePkg/Library/SmmPciLibPciRootBridgeIo/PciLib.c @@ -83,7 +83,7 @@ PciLibConstructor ( @param Address The address that encodes the PCI Bus, Device, Function and
Register.
- @param Width Width of data to read
+ @param Width The width of data to read
@return The value read from the PCI configuration register.
@@ -117,7 +117,7 @@ SmmPciLibPciRootBridgeIoReadWorker ( @param Address The address that encodes the PCI Bus, Device, Function and
Register.
- @param Width Width of data to write
+ @param Width The width of data to write
@param Data The value to write.
@return The value written to the PCI configuration register.
diff --git a/MdePkg/Library/UefiApplicationEntryPoint/ApplicationEntryPoint.c b/MdePkg/Library/UefiApplicationEntryPoint/ApplicationEntryPoint.c index 43a3f32630..cb0d07032c 100644 --- a/MdePkg/Library/UefiApplicationEntryPoint/ApplicationEntryPoint.c +++ b/MdePkg/Library/UefiApplicationEntryPoint/ApplicationEntryPoint.c @@ -1,11 +1,11 @@ /** @file
Entry point library instance to a UEFI application.
-Copyright (c) 2007 - 2008, Intel Corporation. All rights reserved.<BR>
+Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
-http://opensource.org/licenses/bsd-license.php
+http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@@ -26,8 +26,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. If _gUefiDriverRevision is not zero and SystemTable->Hdr.Revision is less than _gUefiDriverRevison,
then return EFI_INCOMPATIBLE_VERSION.
- @param ImageHandle The image handle of the UEFI Application.
- @param SystemTable A pointer to the EFI System Table.
+ @param ImageHandle The image handle of the UEFI Application.
+ @param SystemTable A pointer to the EFI System Table.
@retval EFI_SUCCESS The UEFI Application exited normally.
@retval EFI_INCOMPATIBLE_VERSION _gUefiDriverRevision is greater than SystemTable->Hdr.Revision.
diff --git a/MdePkg/Library/UefiDebugLibConOut/DebugLib.c b/MdePkg/Library/UefiDebugLibConOut/DebugLib.c index e9eb06797e..7893ec675c 100644 --- a/MdePkg/Library/UefiDebugLibConOut/DebugLib.c +++ b/MdePkg/Library/UefiDebugLibConOut/DebugLib.c @@ -37,7 +37,7 @@ @param ErrorLevel The error level of the debug message.
@param Format Format string for the debug message to print.
- @param ... Variable argument list whose contents are accessed
+ @param ... A variable argument list whose contents are accessed
based on the format string specified by Format.
**/
@@ -97,8 +97,10 @@ DebugPrint ( If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.
If Description is NULL, then a <Description> string of "(NULL) Description" is printed.
- @param FileName The pointer to the name of the source file that generated the assert condition.
- @param LineNumber The line number in the source file that generated the assert condition
+ @param FileName The pointer to the name of the source file that generated
+ the assert condition.
+ @param LineNumber The line number in the source file that generated the
+ assert condition
@param Description The pointer to the description of the assert condition.
**/
diff --git a/MdePkg/Library/UefiDebugLibStdErr/DebugLib.c b/MdePkg/Library/UefiDebugLibStdErr/DebugLib.c index c7b60fffff..29a619b14a 100644 --- a/MdePkg/Library/UefiDebugLibStdErr/DebugLib.c +++ b/MdePkg/Library/UefiDebugLibStdErr/DebugLib.c @@ -38,8 +38,8 @@ If Format is NULL, then ASSERT().
@param ErrorLevel The error level of the debug message.
- @param Format Format string for the debug message to print.
- @param ... Variable argument list whose contents are accessed
+ @param Format The format string for the debug message to print.
+ @param ... The variable argument list whose contents are accessed
based on the format string specified by Format.
**/
@@ -98,8 +98,10 @@ DebugPrint ( If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.
If Description is NULL, then a <Description> string of "(NULL) Description" is printed.
- @param FileName The pointer to the name of the source file that generated the assert condition.
- @param LineNumber The line number in the source file that generated the assert condition
+ @param FileName The pointer to the name of the source file that generated
+ the assert condition.
+ @param LineNumber The line number in the source file that generated the
+ assert condition
@param Description The pointer to the description of the assert condition.
**/
diff --git a/MdePkg/Library/UefiDevicePathLib/UefiDevicePathLib.c b/MdePkg/Library/UefiDevicePathLib/UefiDevicePathLib.c index 69f9eb77b3..db065e4f3a 100644 --- a/MdePkg/Library/UefiDevicePathLib/UefiDevicePathLib.c +++ b/MdePkg/Library/UefiDevicePathLib/UefiDevicePathLib.c @@ -8,7 +8,7 @@ environment varibles. Multi-instance device paths should never be placed
on a Handle.
- Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>
+ Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
@@ -113,13 +113,15 @@ DevicePathNodeLength ( /**
Returns a pointer to the next node in a device path.
- Returns a pointer to the device path node that follows the device path node specified by Node.
+ Returns a pointer to the device path node that follows the device path node
+ specified by Node.
If Node is NULL, then ASSERT().
@param Node A pointer to a device path node data structure.
- @return a pointer to the device path node that follows the device path node specified by Node.
+ @return a pointer to the device path node that follows the device path node
+ specified by Node.
**/
EFI_DEVICE_PATH_PROTOCOL *
@@ -134,7 +136,8 @@ NextDevicePathNode ( /**
Determines if a device path node is an end node of a device path.
- This includes nodes that are the end of a device path instance and nodes that are the end of an entire device path.
+ This includes nodes that are the end of a device path instance and nodes that
+ are the end of an entire device path.
Determines if the device path node specified by Node is an end node of a device path.
This includes nodes that are the end of a device path instance and nodes that are the
@@ -145,8 +148,10 @@ NextDevicePathNode ( @param Node A pointer to a device path node data structure.
- @retval TRUE The device path node specified by Node is an end node of a device path.
- @retval FALSE The device path node specified by Node is not an end node of a device path.
+ @retval TRUE The device path node specified by Node is an end node of a
+ device path.
+ @retval FALSE The device path node specified by Node is not an end node of
+ a device path.
**/
BOOLEAN
@@ -162,15 +167,18 @@ IsDevicePathEndType ( /**
Determines if a device path node is an end node of an entire device path.
- Determines if a device path node specified by Node is an end node of an entire device path.
- If Node represents the end of an entire device path, then TRUE is returned. Otherwise, FALSE is returned.
+ Determines if a device path node specified by Node is an end node of an entire
+ device path. If Node represents the end of an entire device path, then TRUE is
+ returned. Otherwise, FALSE is returned.
If Node is NULL, then ASSERT().
@param Node A pointer to a device path node data structure.
- @retval TRUE The device path node specified by Node is the end of an entire device path.
- @retval FALSE The device path node specified by Node is not the end of an entire device path.
+ @retval TRUE The device path node specified by Node is the end of an entire
+ device path.
+ @retval FALSE The device path node specified by Node is not the end of an
+ entire device path.
**/
BOOLEAN
@@ -186,15 +194,18 @@ IsDevicePathEnd ( /**
Determines if a device path node is an end node of a device path instance.
- Determines if a device path node specified by Node is an end node of a device path instance.
- If Node represents the end of a device path instance, then TRUE is returned. Otherwise, FALSE is returned.
+ Determines if a device path node specified by Node is an end node of a device
+ path instance. If Node represents the end of a device path instance, then TRUE
+ is returned. Otherwise, FALSE is returned.
If Node is NULL, then ASSERT().
@param Node A pointer to a device path node data structure.
- @retval TRUE The device path node specified by Node is the end of a device path instance.
- @retval FALSE The device path node specified by Node is not the end of a device path instance.
+ @retval TRUE The device path node specified by Node is the end of a device
+ path instance.
+ @retval FALSE The device path node specified by Node is not the end of a
+ device path instance.
**/
BOOLEAN
@@ -265,13 +276,14 @@ SetDevicePathEndNode ( /**
Returns the size of a device path in bytes.
- This function returns the size, in bytes, of the device path data structure specified by
- DevicePath including the end of device path node. If DevicePath is NULL, then 0 is returned.
+ This function returns the size, in bytes, of the device path data structure
+ specified by DevicePath including the end of device path node. If DevicePath
+ is NULL, then 0 is returned.
- @param DevicePath A pointer to a device path data structure.
+ @param DevicePath A pointer to a device path data structure.
- @retval 0 If DevicePath is NULL.
- @retval Others The size of a device path in bytes.
+ @retval 0 If DevicePath is NULL.
+ @retval Others The size of a device path in bytes.
**/
UINTN
@@ -303,17 +315,17 @@ GetDevicePathSize ( /**
Creates a new copy of an existing device path.
- This function allocates space for a new copy of the device path specified by DevicePath. If
- DevicePath is NULL, then NULL is returned. If the memory is successfully allocated, then the
- contents of DevicePath are copied to the newly allocated buffer, and a pointer to that buffer
- is returned. Otherwise, NULL is returned.
+ This function allocates space for a new copy of the device path specified by DevicePath.
+ If DevicePath is NULL, then NULL is returned. If the memory is successfully
+ allocated, then the contents of DevicePath are copied to the newly allocated
+ buffer, and a pointer to that buffer is returned. Otherwise, NULL is returned.
The memory for the new device path is allocated from EFI boot services memory.
It is the responsibility of the caller to free the memory allocated.
- @param DevicePath A pointer to a device path data structure.
+ @param DevicePath A pointer to a device path data structure.
- @retval NULL If DevicePath is NULL.
- @retval Others A pointer to the duplicated device path.
+ @retval NULL If DevicePath is NULL.
+ @retval Others A pointer to the duplicated device path.
**/
EFI_DEVICE_PATH_PROTOCOL *
@@ -342,16 +354,17 @@ DuplicateDevicePath ( /**
Creates a new device path by appending a second device path to a first device path.
- This function creates a new device path by appending a copy of SecondDevicePath to a copy of
- FirstDevicePath in a newly allocated buffer. Only the end-of-device-path device node from
- SecondDevicePath is retained. The newly created device path is returned.
- If FirstDevicePath is NULL, then it is ignored, and a duplicate of SecondDevicePath is returned.
- If SecondDevicePath is NULL, then it is ignored, and a duplicate of FirstDevicePath is returned.
- If both FirstDevicePath and SecondDevicePath are NULL, then a copy of an end-of-device-path is
- returned.
+ This function creates a new device path by appending a copy of SecondDevicePath
+ to a copy of FirstDevicePath in a newly allocated buffer. Only the end-of-device-path
+ device node from SecondDevicePath is retained. The newly created device path is
+ returned. If FirstDevicePath is NULL, then it is ignored, and a duplicate of
+ SecondDevicePath is returned. If SecondDevicePath is NULL, then it is ignored,
+ and a duplicate of FirstDevicePath is returned. If both FirstDevicePath and
+ SecondDevicePath are NULL, then a copy of an end-of-device-path is returned.
+
If there is not enough memory for the newly allocated buffer, then NULL is returned.
- The memory for the new device path is allocated from EFI boot services memory. It is the
- responsibility of the caller to free the memory allocated.
+ The memory for the new device path is allocated from EFI boot services memory.
+ It is the responsibility of the caller to free the memory allocated.
@param FirstDevicePath A pointer to a device path data structure.
@param SecondDevicePath A pointer to a device path data structure.
@@ -411,17 +424,19 @@ AppendDevicePath ( /**
Creates a new path by appending the device node to the device path.
- This function creates a new device path by appending a copy of the device node specified by
- DevicePathNode to a copy of the device path specified by DevicePath in an allocated buffer.
- The end-of-device-path device node is moved after the end of the appended device node.
+ This function creates a new device path by appending a copy of the device node
+ specified by DevicePathNode to a copy of the device path specified by DevicePath
+ in an allocated buffer. The end-of-device-path device node is moved after the
+ end of the appended device node.
If DevicePathNode is NULL then a copy of DevicePath is returned.
- If DevicePath is NULL then a copy of DevicePathNode, followed by an end-of-device path device
- node is returned.
- If both DevicePathNode and DevicePath are NULL then a copy of an end-of-device-path device node
- is returned.
- If there is not enough memory to allocate space for the new device path, then NULL is returned.
- The memory is allocated from EFI boot services memory. It is the responsibility of the caller to
- free the memory allocated.
+ If DevicePath is NULL then a copy of DevicePathNode, followed by an end-of-device
+ path device node is returned.
+ If both DevicePathNode and DevicePath are NULL then a copy of an end-of-device-path
+ device node is returned.
+ If there is not enough memory to allocate space for the new device path, then
+ NULL is returned.
+ The memory is allocated from EFI boot services memory. It is the responsibility
+ of the caller to free the memory allocated.
@param DevicePath A pointer to a device path data structure.
@param DevicePathNode A pointer to a single device path node.
@@ -430,7 +445,8 @@ AppendDevicePath ( @retval Others A pointer to the new device path if success.
A copy of DevicePathNode followed by an end-of-device-path node
if both FirstDevicePath and SecondDevicePath are NULL.
- A copy of an end-of-device-path node if both FirstDevicePath and SecondDevicePath are NULL.
+ A copy of an end-of-device-path node if both FirstDevicePath
+ and SecondDevicePath are NULL.
**/
EFI_DEVICE_PATH_PROTOCOL *
@@ -477,15 +493,17 @@ AppendDevicePathNode ( Creates a new device path by appending the specified device path instance to the specified device
path.
- This function creates a new device path by appending a copy of the device path instance specified
- by DevicePathInstance to a copy of the device path secified by DevicePath in a allocated buffer.
- The end-of-device-path device node is moved after the end of the appended device path instance
- and a new end-of-device-path-instance node is inserted between.
+ This function creates a new device path by appending a copy of the device path
+ instance specified by DevicePathInstance to a copy of the device path specified
+ by DevicePath in a allocated buffer.
+ The end-of-device-path device node is moved after the end of the appended device
+ path instance and a new end-of-device-path-instance node is inserted between.
If DevicePath is NULL, then a copy if DevicePathInstance is returned.
If DevicePathInstance is NULL, then NULL is returned.
- If there is not enough memory to allocate space for the new device path, then NULL is returned.
- The memory is allocated from EFI boot services memory. It is the responsibility of the caller to
- free the memory allocated.
+ If there is not enough memory to allocate space for the new device path, then
+ NULL is returned.
+ The memory is allocated from EFI boot services memory. It is the responsibility
+ of the caller to free the memory allocated.
@param DevicePath A pointer to a device path data structure.
@param DevicePathInstance A pointer to a device path instance.
@@ -537,22 +555,25 @@ AppendDevicePathInstance ( Creates a copy of the current device path instance and returns a pointer to the next device path
instance.
- This function creates a copy of the current device path instance. It also updates DevicePath to
- point to the next device path instance in the device path (or NULL if no more) and updates Size
- to hold the size of the device path instance copy.
+ This function creates a copy of the current device path instance. It also updates
+ DevicePath to point to the next device path instance in the device path (or NULL
+ if no more) and updates Size to hold the size of the device path instance copy.
If DevicePath is NULL, then NULL is returned.
- If there is not enough memory to allocate space for the new device path, then NULL is returned.
- The memory is allocated from EFI boot services memory. It is the responsibility of the caller to
- free the memory allocated.
+ If there is not enough memory to allocate space for the new device path, then
+ NULL is returned.
+ The memory is allocated from EFI boot services memory. It is the responsibility
+ of the caller to free the memory allocated.
If Size is NULL, then ASSERT().
- @param DevicePath On input, this holds the pointer to the current device path
- instance. On output, this holds the pointer to the next device
- path instance or NULL if there are no more device path
- instances in the device path pointer to a device path data
- structure.
- @param Size On output, this holds the size of the device path instance, in
- bytes or zero, if DevicePath is NULL.
+ @param DevicePath On input, this holds the pointer to the current
+ device path instance. On output, this holds
+ the pointer to the next device path instance
+ or NULL if there are no more device path
+ instances in the device path pointer to a
+ device path data structure.
+ @param Size On output, this holds the size of the device
+ path instance, in bytes or zero, if DevicePath
+ is NULL.
@return A pointer to the current device path instance.
@@ -612,13 +633,14 @@ GetNextDevicePathInstance ( /**
Creates a device node.
- This function creates a new device node in a newly allocated buffer of size NodeLength and
- initializes the device path node header with NodeType and NodeSubType. The new device path node
- is returned.
+ This function creates a new device node in a newly allocated buffer of size
+ NodeLength and initializes the device path node header with NodeType and NodeSubType.
+ The new device path node is returned.
If NodeLength is smaller than a device path header, then NULL is returned.
- If there is not enough memory to allocate space for the new device path, then NULL is returned.
- The memory is allocated from EFI boot services memory. It is the responsibility of the caller to
- free the memory allocated.
+ If there is not enough memory to allocate space for the new device path, then
+ NULL is returned.
+ The memory is allocated from EFI boot services memory. It is the responsibility
+ of the caller to free the memory allocated.
@param NodeType The device node type for the new device node.
@param NodeSubType The device node sub-type for the new device node.
@@ -657,13 +679,15 @@ CreateDeviceNode ( /**
Determines if a device path is single or multi-instance.
- This function returns TRUE if the device path specified by DevicePath is multi-instance.
+ This function returns TRUE if the device path specified by DevicePath is
+ multi-instance.
Otherwise, FALSE is returned. If DevicePath is NULL, then FALSE is returned.
@param DevicePath A pointer to a device path data structure.
@retval TRUE DevicePath is multi-instance.
- @retval FALSE DevicePath is not multi-instance or DevicePath is NULL.
+ @retval FALSE DevicePath is not multi-instance or DevicePath
+ is NULL.
**/
BOOLEAN
@@ -694,10 +718,12 @@ IsDevicePathMultiInstance ( /**
Retrieves the device path protocol from a handle.
- This function returns the device path protocol from the handle specified by Handle. If Handle is
- NULL or Handle does not contain a device path protocol, then NULL is returned.
+ This function returns the device path protocol from the handle specified by Handle.
+ If Handle is NULL or Handle does not contain a device path protocol, then NULL
+ is returned.
- @param Handle The handle from which to retrieve the device path protocol.
+ @param Handle The handle from which to retrieve the device
+ path protocol.
@return The device path protocol from the handle specified by Handle.
@@ -736,8 +762,8 @@ DevicePathFromHandle ( If FileName is NULL, then ASSERT().
If FileName is not aligned on a 16-bit boundary, then ASSERT().
- @param Device A pointer to a device handle. This parameter is optional and
- may be NULL.
+ @param Device A pointer to a device handle. This parameter
+ is optional and may be NULL.
@param FileName A pointer to a Null-terminated Unicode string.
@return The allocated device path.
diff --git a/MdePkg/Library/UefiDevicePathLibDevicePathProtocol/UefiDevicePathLib.c b/MdePkg/Library/UefiDevicePathLibDevicePathProtocol/UefiDevicePathLib.c index 8b86eed3b0..8275dd611a 100644 --- a/MdePkg/Library/UefiDevicePathLibDevicePathProtocol/UefiDevicePathLib.c +++ b/MdePkg/Library/UefiDevicePathLibDevicePathProtocol/UefiDevicePathLib.c @@ -2,7 +2,7 @@ Library instance that implement UEFI Device Path Library class based on protocol
gEfiDevicePathUtilitiesProtocolGuid.
- Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>
+ Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
@@ -143,13 +143,15 @@ DevicePathNodeLength ( /**
Returns a pointer to the next node in a device path.
- Returns a pointer to the device path node that follows the device path node specified by Node.
+ Returns a pointer to the device path node that follows the device path node
+ specified by Node.
If Node is NULL, then ASSERT().
@param Node A pointer to a device path node data structure.
- @return a pointer to the device path node that follows the device path node specified by Node.
+ @return a pointer to the device path node that follows the device path node
+ specified by Node.
**/
EFI_DEVICE_PATH_PROTOCOL *
@@ -164,7 +166,8 @@ NextDevicePathNode ( /**
Determines if a device path node is an end node of a device path.
- This includes nodes that are the end of a device path instance and nodes that are the end of an entire device path.
+ This includes nodes that are the end of a device path instance and nodes that
+ are the end of an entire device path.
Determines if the device path node specified by Node is an end node of a device path.
This includes nodes that are the end of a device path instance and nodes that are the
@@ -176,7 +179,8 @@ NextDevicePathNode ( @param Node A pointer to a device path node data structure.
@retval TRUE The device path node specified by Node is an end node of a device path.
- @retval FALSE The device path node specified by Node is not an end node of a device path.
+ @retval FALSE The device path node specified by Node is not an end node of
+ a device path.
**/
BOOLEAN
@@ -192,8 +196,10 @@ IsDevicePathEndType ( /**
Determines if a device path node is an end node of an entire device path.
- Determines if a device path node specified by Node is an end node of an entire device path.
- If Node represents the end of an entire device path, then TRUE is returned. Otherwise, FALSE is returned.
+ Determines if a device path node specified by Node is an end node of an entire
+ device path.
+ If Node represents the end of an entire device path, then TRUE is returned.
+ Otherwise, FALSE is returned.
If Node is NULL, then ASSERT().
@@ -216,15 +222,19 @@ IsDevicePathEnd ( /**
Determines if a device path node is an end node of a device path instance.
- Determines if a device path node specified by Node is an end node of a device path instance.
- If Node represents the end of a device path instance, then TRUE is returned. Otherwise, FALSE is returned.
+ Determines if a device path node specified by Node is an end node of a device
+ path instance.
+ If Node represents the end of a device path instance, then TRUE is returned.
+ Otherwise, FALSE is returned.
If Node is NULL, then ASSERT().
@param Node A pointer to a device path node data structure.
- @retval TRUE The device path node specified by Node is the end of a device path instance.
- @retval FALSE The device path node specified by Node is not the end of a device path instance.
+ @retval TRUE The device path node specified by Node is the end of a device
+ path instance.
+ @retval FALSE The device path node specified by Node is not the end of a
+ device path instance.
**/
BOOLEAN
@@ -316,8 +326,9 @@ GetDevicePathSize ( /**
Creates a new copy of an existing device path.
- This function allocates space for a new copy of the device path specified by DevicePath. If
- DevicePath is NULL, then NULL is returned. If the memory is successfully allocated, then the
+ This function allocates space for a new copy of the device path specified by
+ DevicePath. If DevicePath is NULL, then NULL is returned.
+ If the memory is successfully allocated, then the
contents of DevicePath are copied to the newly allocated buffer, and a pointer to that buffer
is returned. Otherwise, NULL is returned.
The memory for the new device path is allocated from EFI boot services memory.
@@ -357,7 +368,8 @@ DuplicateDevicePath ( @retval NULL If there is not enough memory for the newly allocated buffer.
@retval Others A pointer to the new device path if success.
- Or a copy an end-of-device-path if both FirstDevicePath and SecondDevicePath are NULL.
+ Or a copy an end-of-device-path if both FirstDevicePath and
+ SecondDevicePath are NULL.
**/
EFI_DEVICE_PATH_PROTOCOL *
@@ -373,17 +385,19 @@ AppendDevicePath ( /**
Creates a new path by appending the device node to the device path.
- This function creates a new device path by appending a copy of the device node specified by
- DevicePathNode to a copy of the device path specified by DevicePath in an allocated buffer.
+ This function creates a new device path by appending a copy of the device node
+ specified by DevicePathNode to a copy of the device path specified by DevicePath
+ in an allocated buffer.
The end-of-device-path device node is moved after the end of the appended device node.
If DevicePathNode is NULL then a copy of DevicePath is returned.
- If DevicePath is NULL then a copy of DevicePathNode, followed by an end-of-device path device
- node is returned.
- If both DevicePathNode and DevicePath are NULL then a copy of an end-of-device-path device node
- is returned.
- If there is not enough memory to allocate space for the new device path, then NULL is returned.
- The memory is allocated from EFI boot services memory. It is the responsibility of the caller to
- free the memory allocated.
+ If DevicePath is NULL then a copy of DevicePathNode, followed by an end-of-device
+ path device node is returned.
+ If both DevicePathNode and DevicePath are NULL then a copy of an end-of-device-path
+ device node is returned.
+ If there is not enough memory to allocate space for the new device path, then
+ NULL is returned.
+ The memory is allocated from EFI boot services memory. It is the responsibility
+ of the caller to free the memory allocated.
@param DevicePath A pointer to a device path data structure.
@param DevicePathNode A pointer to a single device path node.
@@ -392,7 +406,8 @@ AppendDevicePath ( @retval Others A pointer to the new device path if success.
A copy of DevicePathNode followed by an end-of-device-path node
if both FirstDevicePath and SecondDevicePath are NULL.
- A copy of an end-of-device-path node if both FirstDevicePath and SecondDevicePath are NULL.
+ A copy of an end-of-device-path node if both FirstDevicePath
+ and SecondDevicePath are NULL.
**/
EFI_DEVICE_PATH_PROTOCOL *
@@ -406,18 +421,20 @@ AppendDevicePathNode ( }
/**
- Creates a new device path by appending the specified device path instance to the specified device
- path.
+ Creates a new device path by appending the specified device path instance to
+ the specified device path.
- This function creates a new device path by appending a copy of the device path instance specified
- by DevicePathInstance to a copy of the device path secified by DevicePath in a allocated buffer.
- The end-of-device-path device node is moved after the end of the appended device path instance
- and a new end-of-device-path-instance node is inserted between.
+ This function creates a new device path by appending a copy of the device path
+ instance specified by DevicePathInstance to a copy of the device path specified
+ by DevicePath in a allocated buffer.
+ The end-of-device-path device node is moved after the end of the appended device
+ path instance and a new end-of-device-path-instance node is inserted between.
If DevicePath is NULL, then a copy if DevicePathInstance is returned.
If DevicePathInstance is NULL, then NULL is returned.
- If there is not enough memory to allocate space for the new device path, then NULL is returned.
- The memory is allocated from EFI boot services memory. It is the responsibility of the caller to
- free the memory allocated.
+ If there is not enough memory to allocate space for the new device path, then
+ NULL is returned.
+ The memory is allocated from EFI boot services memory. It is the responsibility
+ of the caller to free the memory allocated.
@param DevicePath A pointer to a device path data structure.
@param DevicePathInstance A pointer to a device path instance.
@@ -436,25 +453,28 @@ AppendDevicePathInstance ( }
/**
- Creates a copy of the current device path instance and returns a pointer to the next device path
- instance.
+ Creates a copy of the current device path instance and returns a pointer to the
+ next device path instance.
- This function creates a copy of the current device path instance. It also updates DevicePath to
- point to the next device path instance in the device path (or NULL if no more) and updates Size
- to hold the size of the device path instance copy.
+ This function creates a copy of the current device path instance. It also updates
+ DevicePath to point to the next device path instance in the device path (or NULL
+ if no more) and updates Size to hold the size of the device path instance copy.
If DevicePath is NULL, then NULL is returned.
- If there is not enough memory to allocate space for the new device path, then NULL is returned.
- The memory is allocated from EFI boot services memory. It is the responsibility of the caller to
- free the memory allocated.
+ If there is not enough memory to allocate space for the new device path, then
+ NULL is returned.
+ The memory is allocated from EFI boot services memory. It is the responsibility
+ of the caller to free the memory allocated.
If Size is NULL, then ASSERT().
- @param DevicePath On input, this holds the pointer to the current device path
- instance. On output, this holds the pointer to the next device
- path instance or NULL if there are no more device path
- instances in the device path pointer to a device path data
- structure.
- @param Size On output, this holds the size of the device path instance, in
- bytes or zero, if DevicePath is NULL.
+ @param DevicePath On input, this holds the pointer to the current
+ device path instance. On output, this holds
+ the pointer to the next device path instance
+ or NULL if there are no more device path
+ instances in the device path pointer to a
+ device path data structure.
+ @param Size On output, this holds the size of the device
+ path instance, in bytes or zero, if DevicePath
+ is NULL.
@return A pointer to the current device path instance.
@@ -473,12 +493,14 @@ GetNextDevicePathInstance ( /**
Creates a device node.
- This function creates a new device node in a newly allocated buffer of size NodeLength and
- initializes the device path node header with NodeType and NodeSubType. The new device path node
- is returned.
+ This function creates a new device node in a newly allocated buffer of size
+ NodeLength and initializes the device path node header with NodeType and NodeSubType.
+ The new device path node is returned.
If NodeLength is smaller than a device path header, then NULL is returned.
- If there is not enough memory to allocate space for the new device path, then NULL is returned.
- The memory is allocated from EFI boot services memory. It is the responsibility of the caller to
+ If there is not enough memory to allocate space for the new device path, then
+ NULL is returned.
+ The memory is allocated from EFI boot services memory. It is the responsibility
+ of the caller to
free the memory allocated.
@param NodeType The device node type for the new device node.
@@ -502,13 +524,15 @@ CreateDeviceNode ( /**
Determines if a device path is single or multi-instance.
- This function returns TRUE if the device path specified by DevicePath is multi-instance.
+ This function returns TRUE if the device path specified by DevicePath is
+ multi-instance.
Otherwise, FALSE is returned. If DevicePath is NULL, then FALSE is returned.
@param DevicePath A pointer to a device path data structure.
@retval TRUE DevicePath is multi-instance.
- @retval FALSE DevicePath is not multi-instance or DevicePath is NULL.
+ @retval FALSE DevicePath is not multi-instance or DevicePath
+ is NULL.
**/
BOOLEAN
@@ -523,10 +547,12 @@ IsDevicePathMultiInstance ( /**
Retrieves the device path protocol from a handle.
- This function returns the device path protocol from the handle specified by Handle. If Handle is
- NULL or Handle does not contain a device path protocol, then NULL is returned.
+ This function returns the device path protocol from the handle specified by Handle.
+ If Handle is NULL or Handle does not contain a device path protocol, then NULL
+ is returned.
- @param Handle The handle from which to retrieve the device path protocol.
+ @param Handle The handle from which to retrieve the device
+ path protocol.
@return The device path protocol from the handle specified by Handle.
@@ -554,19 +580,20 @@ DevicePathFromHandle ( /**
Allocates a device path for a file and appends it to an existing device path.
- If Device is a valid device handle that contains a device path protocol, then a device path for
- the file specified by FileName is allocated and appended to the device path associated with the
- handle Device. The allocated device path is returned. If Device is NULL or Device is a handle
- that does not support the device path protocol, then a device path containing a single device
- path node for the file specified by FileName is allocated and returned.
- The memory for the new device path is allocated from EFI boot services memory. It is the responsibility
- of the caller to free the memory allocated.
+ If Device is a valid device handle that contains a device path protocol, then
+ a device path for the file specified by FileName is allocated and appended to
+ the device path associated with the handle Device. The allocated device path
+ is returned. If Device is NULL or Device is a handle that does not support the
+ device path protocol, then a device path containing a single device path node
+ for the file specified by FileName is allocated and returned.
+ The memory for the new device path is allocated from EFI boot services memory.
+ It is the responsibility of the caller to free the memory allocated.
If FileName is NULL, then ASSERT().
If FileName is not aligned on a 16-bit boundary, then ASSERT().
- @param Device A pointer to a device handle. This parameter is optional and
- may be NULL.
+ @param Device A pointer to a device handle. This parameter
+ is optional and may be NULL.
@param FileName A pointer to a Null-terminated Unicode string.
@return The allocated device path.
diff --git a/MdePkg/Library/UefiDriverEntryPoint/DriverEntryPoint.c b/MdePkg/Library/UefiDriverEntryPoint/DriverEntryPoint.c index c52ed9afa8..17eeaf396c 100644 --- a/MdePkg/Library/UefiDriverEntryPoint/DriverEntryPoint.c +++ b/MdePkg/Library/UefiDriverEntryPoint/DriverEntryPoint.c @@ -63,25 +63,28 @@ _DriverUnloadHandler ( /**
- The entry point of PE/COFF Image for a DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver.
+ The entry point of PE/COFF Image for a DXE Driver, DXE Runtime Driver, DXE SMM
+ Driver, or UEFI Driver.
This function is the entry point for a DXE Driver, DXE Runtime Driver, DXE SMM Driver,
or UEFI Driver. This function must call ProcessLibraryConstructorList() and
ProcessModuleEntryPointList(). If the return status from ProcessModuleEntryPointList()
- is an error status, then ProcessLibraryDestructorList() must be called. The return value
- from ProcessModuleEntryPointList() is returned. If _gDriverUnloadImageCount is greater
- than zero, then an unload handler must be registered for this image and the unload handler
- must invoke ProcessModuleUnloadList().
- If _gUefiDriverRevision is not zero and SystemTable->Hdr.Revision is less than _gUefiDriverRevison,
- then return EFI_INCOMPATIBLE_VERSION.
+ is an error status, then ProcessLibraryDestructorList() must be called. The return
+ value from ProcessModuleEntryPointList() is returned. If _gDriverUnloadImageCount
+ is greater than zero, then an unload handler must be registered for this image
+ and the unload handler must invoke ProcessModuleUnloadList().
+ If _gUefiDriverRevision is not zero and SystemTable->Hdr.Revision is less than
+ _gUefiDriverRevison, then return EFI_INCOMPATIBLE_VERSION.
- @param ImageHandle The image handle of the DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver.
+ @param ImageHandle The image handle of the DXE Driver, DXE Runtime Driver,
+ DXE SMM Driver, or UEFI Driver.
@param SystemTable A pointer to the EFI System Table.
- @retval EFI_SUCCESS The DXE Driver, DXE Runtime Driver, DXE SMM Driver,
- or UEFI Driver exited normally.
- @retval EFI_INCOMPATIBLE_VERSION _gUefiDriverRevision is greater than SystemTable->Hdr.Revision.
+ @retval EFI_SUCCESS The DXE Driver, DXE Runtime Driver, DXE SMM
+ Driver, or UEFI Driver exited normally.
+ @retval EFI_INCOMPATIBLE_VERSION _gUefiDriverRevision is greater than
+ SystemTable->Hdr.Revision.
@retval Other Return value from ProcessModuleEntryPointList().
**/
@@ -144,14 +147,17 @@ _ModuleEntryPoint ( /**
Required by the EBC compiler and identical in functionality to _ModuleEntryPoint().
- This function is required to call _ModuleEntryPoint() passing in ImageHandle, and SystemTable.
+ This function is required to call _ModuleEntryPoint() passing in ImageHandle,
+ and SystemTable.
- @param ImageHandle The image handle of the DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver.
+ @param ImageHandle The image handle of the DXE Driver, DXE Runtime Driver, DXE
+ SMM Driver, or UEFI Driver.
@param SystemTable A pointer to the EFI System Table.
- @retval EFI_SUCCESS The DXE Driver, DXE Runtime Driver, DXE SMM Driver,
- or UEFI Driver exited normally.
- @retval EFI_INCOMPATIBLE_VERSION _gUefiDriverRevision is greater than SystemTable->Hdr.Revision.
+ @retval EFI_SUCCESS The DXE Driver, DXE Runtime Driver, DXE SMM
+ Driver, or UEFI Driver exited normally.
+ @retval EFI_INCOMPATIBLE_VERSION _gUefiDriverRevision is greater than
+ SystemTable->Hdr.Revision.
@retval Other Return value from ProcessModuleEntryPointList().
**/
EFI_STATUS
diff --git a/MdePkg/Library/UefiLib/Console.c b/MdePkg/Library/UefiLib/Console.c index 8e7ca6dbe5..5a7684ecff 100644 --- a/MdePkg/Library/UefiLib/Console.c +++ b/MdePkg/Library/UefiLib/Console.c @@ -248,13 +248,13 @@ GetGlyphWidth ( /**
Computes the display length of a Null-terminated Unicode String.
- This function computes and returns the display length of the Null-terminated Unicode
- string specified by String. If String is NULL then 0 is returned. If any of the widths
- of the Unicode characters in String can not be determined, then 0 is returned. The display
- width of String can be computed by summing the display widths of each Unicode character
- in String. Unicode characters that are narrow glyphs have a width of 1, and Unicode
- characters that are width glyphs have a width of 2.
- If String is not aligned on a 16-bit boundary, then ASSERT().
+ This function computes and returns the display length of the Null-terminated
+ Unicode string specified by String. If String is NULL then 0 is returned. If
+ any of the widths of the Unicode characters in String can not be determined,
+ then 0 is returned. The display width of String can be computed by summing the
+ display widths of each Unicode character in String. Unicode characters that
+ are narrow glyphs have a width of 1, and Unicode characters that are width glyphs
+ have a width of 2. If String is not aligned on a 16-bit boundary, then ASSERT().
@param String A pointer to a Null-terminated Unicode string.
diff --git a/MdePkg/Library/UefiLib/UefiDriverModel.c b/MdePkg/Library/UefiLib/UefiDriverModel.c index 68be087c8a..05f6ec8427 100644 --- a/MdePkg/Library/UefiLib/UefiDriverModel.c +++ b/MdePkg/Library/UefiLib/UefiDriverModel.c @@ -33,7 +33,7 @@ @param DriverBindingHandle The handle that DriverBinding is to be installed onto. If this
parameter is NULL, then a new handle is created.
- @retval EFI_SUCCESS The protocol installation is completed successfully.
+ @retval EFI_SUCCESS The protocol installation successfully completed.
@retval EFI_OUT_OF_RESOURCES There was not enough system resources to install the protocol.
@retval Others Status from gBS->InstallMultipleProtocolInterfaces().
@@ -93,7 +93,7 @@ EfiLibInstallDriverBinding ( @param DriverConfiguration A Driver Configuration Protocol instance that this driver is producing.
@param DriverDiagnostics A Driver Diagnostics Protocol instance that this driver is producing.
- @retval EFI_SUCCESS The protocol installation is completed successfully.
+ @retval EFI_SUCCESS The protocol installation successfully completed.
@retval EFI_OUT_OF_RESOURCES There was not enough memory in pool to install all the protocols.
**/
@@ -222,7 +222,7 @@ EfiLibInstallAllDriverProtocols ( @param ComponentName A Component Name Protocol instance that this driver is producing.
@param ComponentName2 A Component Name 2 Protocol instance that this driver is producing.
- @retval EFI_SUCCESS The protocol installation is completed successfully.
+ @retval EFI_SUCCESS The protocol installation successfully completed.
@retval EFI_OUT_OF_RESOURCES There was not enough memory in pool to install all the protocols.
**/
@@ -315,7 +315,7 @@ EfiLibInstallDriverBindingComponentName2 ( @param DriverDiagnostics A Driver Diagnostics Protocol instance that this driver is producing.
@param DriverDiagnostics2 A Driver Diagnostics Protocol 2 instance that this driver is producing.
- @retval EFI_SUCCESS The protocol installation is completed successfully.
+ @retval EFI_SUCCESS The protocol installation successfully completed.
@retval EFI_OUT_OF_RESOURCES There was not enough memory in pool to install all the protocols.
**/
diff --git a/MdePkg/Library/UefiLib/UefiLib.c b/MdePkg/Library/UefiLib/UefiLib.c index e1e9f756f5..6fa3b34e83 100644 --- a/MdePkg/Library/UefiLib/UefiLib.c +++ b/MdePkg/Library/UefiLib/UefiLib.c @@ -5,7 +5,7 @@ EFI Driver Model related protocols, manage Unicode string tables for UEFI Drivers,
and print messages on the console output and standard error devices.
- Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>
+ Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
@@ -55,7 +55,7 @@ CompareIso639LanguageCode ( If TableGuid is NULL, then ASSERT().
If Table is NULL, then ASSERT().
- @param TableGuid The pointer to table's GUID type..
+ @param TableGuid The pointer to table's GUID type.
@param Table The pointer to the table associated with TableGuid in the EFI System Table.
@retval EFI_SUCCESS A configuration table matching TableGuid was found.
@@ -175,7 +175,7 @@ EfiCreateProtocolNotifyEvent( If NotifyTpl is not a legal TPL value, then ASSERT().
If NotifyFunction is NULL, then ASSERT().
- @param Name Supplies GUID name of the event.
+ @param Name Supplies the GUID name of the event.
@param NotifyTpl Supplies the task priority level of the event notifications.
@param NotifyFunction Supplies the function to notify when the event is signaled.
@param NotifyContext The context parameter to pass to NotifyFunction.
@@ -246,7 +246,7 @@ EfiNamedEventListen ( created with EfiNamedEventListen().
If Name is NULL, then ASSERT().
- @param Name Supplies GUID name of the event.
+ @param Name Supplies the GUID name of the event.
@retval EFI_SUCCESS A named event was signaled.
@retval EFI_OUT_OF_RESOURCES There are not enough resource to signal the named event.
@@ -320,7 +320,7 @@ EfiGetCurrentTpl ( If Priority is not a valid TPL value, then ASSERT().
@param Lock A pointer to the lock data structure to initialize.
- @param Priority EFI TPL associated with the lock.
+ @param Priority EFI TPL is associated with the lock.
@return The lock.
diff --git a/MdePkg/Library/UefiLib/UefiLibPrint.c b/MdePkg/Library/UefiLib/UefiLibPrint.c index e663e8d2b2..5ce73b0c17 100644 --- a/MdePkg/Library/UefiLib/UefiLibPrint.c +++ b/MdePkg/Library/UefiLib/UefiLibPrint.c @@ -45,12 +45,12 @@ GLOBAL_REMOVE_IF_UNREFERENCED EFI_GRAPHICS_OUTPUT_BLT_PIXEL mEfiColors[16] = { If Format is NULL, then ASSERT().
If Format is not aligned on a 16-bit boundary, then ASSERT().
- @param Format Null-terminated Unicode format string.
+ @param Format A Null-terminated Unicode format string.
@param Console The output console.
- @param Marker VA_LIST marker for the variable argument list.
+ @param Marker A VA_LIST marker for the variable argument list.
@return The number of Unicode characters in the produced
- output buffer not including the Null-terminator.
+ output buffer, not including the Null-terminator.
**/
UINTN
InternalPrint (
@@ -103,8 +103,8 @@ InternalPrint ( If Format is not aligned on a 16-bit boundary, then ASSERT().
If gST->ConOut is NULL, then ASSERT().
- @param Format Null-terminated Unicode format string.
- @param ... Variable argument list whose contents are accessed based
+ @param Format A Null-terminated Unicode format string.
+ @param ... A Variable argument list whose contents are accessed based
on the format string specified by Format.
@return The number of Unicode characters printed to ConOut.
@@ -142,7 +142,7 @@ Print ( If Format is not aligned on a 16-bit boundary, then ASSERT().
If gST->StdErr is NULL, then ASSERT().
- @param Format Null-terminated Unicode format string.
+ @param Format A Null-terminated Unicode format string.
@param ... Variable argument list whose contents are accessed based
on the format string specified by Format.
@@ -180,7 +180,7 @@ ErrorPrint ( If Format is NULL, then ASSERT().
- @param Format Null-terminated ASCII format string.
+ @param Format A Null-terminated ASCII format string.
@param Console The output console.
@param Marker VA_LIST marker for the variable argument list.
@@ -237,7 +237,7 @@ AsciiInternalPrint ( If Format is NULL, then ASSERT().
If gST->ConOut is NULL, then ASSERT().
- @param Format Null-terminated ASCII format string.
+ @param Format A Null-terminated ASCII format string.
@param ... Variable argument list whose contents are accessed based
on the format string specified by Format.
@@ -276,7 +276,7 @@ AsciiPrint ( If Format is NULL, then ASSERT().
If gST->StdErr is NULL, then ASSERT().
- @param Format Null-terminated ASCII format string.
+ @param Format A Null-terminated ASCII format string.
@param ... Variable argument list whose contents are accessed based
on the format string specified by Format.
@@ -320,8 +320,8 @@ AsciiErrorPrint ( If the EFI_HII_FONT_PROTOCOL is not present in the handle database, then no
string is printed, and 0 is returned.
- @param PointX X coordinate to print the string.
- @param PointY Y coordinate to print the string.
+ @param PointX An X coordinate to print the string.
+ @param PointY A Y coordinate to print the string.
@param Foreground The foreground color of the string being printed. This is
an optional parameter that may be NULL. If it is NULL,
then the foreground color of the current ConOut device
@@ -330,7 +330,7 @@ AsciiErrorPrint ( an optional parameter that may be NULL. If it is NULL,
then the background color of the current ConOut device
in the EFI_SYSTEM_TABLE is used.
- @param Buffer Null-terminated Unicode formatted string.
+ @param Buffer A Null-terminated Unicode formatted string.
@param PrintNum The number of Unicode formatted string to be printed.
@return The number of Unicode Characters printed. Zero means no any character
@@ -576,8 +576,8 @@ Error: If Format is not aligned on a 16-bit boundary, then ASSERT().
If gST->ConsoleOutputHandle is NULL, then ASSERT().
- @param PointX X coordinate to print the string.
- @param PointY Y coordinate to print the string.
+ @param PointX An X coordinate to print the string.
+ @param PointY A Y coordinate to print the string.
@param ForeGround The foreground color of the string being printed. This is
an optional parameter that may be NULL. If it is NULL,
then the foreground color of the current ConOut device
@@ -586,9 +586,9 @@ Error: an optional parameter that may be NULL. If it is NULL,
then the background color of the current ConOut device
in the EFI_SYSTEM_TABLE is used.
- @param Format Null-terminated Unicode format string. See Print Library
+ @param Format A Null-terminated Unicode format string. See Print Library
for the supported format string syntax.
- @param ... Variable argument list whose contents are accessed based on
+ @param ... A Variable argument list whose contents are accessed based on
the format string specified by Format.
@return The number of Unicode characters printed.
@@ -653,8 +653,8 @@ PrintXY ( If Format is NULL, then ASSERT().
If gST->ConsoleOutputHandle is NULL, then ASSERT().
- @param PointX X coordinate to print the string.
- @param PointY Y coordinate to print the string.
+ @param PointX An X coordinate to print the string.
+ @param PointY A Y coordinate to print the string.
@param ForeGround The foreground color of the string being printed. This is
an optional parameter that may be NULL. If it is NULL,
then the foreground color of the current ConOut device
@@ -663,7 +663,7 @@ PrintXY ( an optional parameter that may be NULL. If it is NULL,
then the background color of the current ConOut device
in the EFI_SYSTEM_TABLE is used.
- @param Format Null-terminated ASCII format string. See Print Library
+ @param Format A Null-terminated ASCII format string. See Print Library
for the supported format string syntax.
@param ... Variable argument list whose contents are accessed based on
the format string specified by Format.
diff --git a/MdePkg/Library/UefiLib/UefiNotTiano.c b/MdePkg/Library/UefiLib/UefiNotTiano.c index 7f5fa528e7..1869c066c7 100644 --- a/MdePkg/Library/UefiLib/UefiNotTiano.c +++ b/MdePkg/Library/UefiLib/UefiNotTiano.c @@ -138,7 +138,7 @@ EfiCreateEventLegacyBootEx ( change with the version of the specification supported.
If ReadyToBootEvent is NULL, then ASSERT().
- @param ReadyToBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex).
+ @param ReadyToBootEvent Returns the EFI event returned from gBS->CreateEvent(Ex).
@retval EFI_SUCCESS Event was created.
@retval Other Event was not created.
diff --git a/MdePkg/Library/UefiMemoryLib/MemLibGeneric.c b/MdePkg/Library/UefiMemoryLib/MemLibGeneric.c index f68272f2ae..2780cbfd9b 100644 --- a/MdePkg/Library/UefiMemoryLib/MemLibGeneric.c +++ b/MdePkg/Library/UefiMemoryLib/MemLibGeneric.c @@ -6,7 +6,7 @@ PeiMemoryLib
UefiMemoryLib
- Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>
+ Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
@@ -113,9 +113,9 @@ InternalMemZeroMem ( /**
Compares two memory buffers of a given length.
- @param DestinationBuffer First memory buffer
- @param SourceBuffer Second memory buffer
- @param Length Length of DestinationBuffer and SourceBuffer memory
+ @param DestinationBuffer The first memory buffer
+ @param SourceBuffer The second memory buffer
+ @param Length The length of DestinationBuffer and SourceBuffer memory
regions to compare. Must be non-zero.
@return 0 All Length bytes of the two buffers are identical.
diff --git a/MdePkg/Library/UefiMemoryLib/MemLibInternals.h b/MdePkg/Library/UefiMemoryLib/MemLibInternals.h index d64ea16a6e..0443b508bb 100644 --- a/MdePkg/Library/UefiMemoryLib/MemLibInternals.h +++ b/MdePkg/Library/UefiMemoryLib/MemLibInternals.h @@ -119,7 +119,7 @@ InternalMemSetMem64 ( /**
Set Buffer to 0 for Size bytes.
- @param Buffer Memory to set.
+ @param Buffer The memory to set.
@param Length The number of bytes to set
@return Buffer
@@ -135,9 +135,9 @@ InternalMemZeroMem ( /**
Compares two memory buffers of a given length.
- @param DestinationBuffer First memory buffer
- @param SourceBuffer Second memory buffer
- @param Length Length of DestinationBuffer and SourceBuffer memory
+ @param DestinationBuffer The first memory buffer
+ @param SourceBuffer The second memory buffer
+ @param Length The length of DestinationBuffer and SourceBuffer memory
regions to compare. Must be non-zero.
@return 0 All Length bytes of the two buffers are identical.
diff --git a/MdePkg/Library/UefiPciLibPciRootBridgeIo/PciLib.c b/MdePkg/Library/UefiPciLibPciRootBridgeIo/PciLib.c index 622a7ccd1a..4d4c7f2d58 100644 --- a/MdePkg/Library/UefiPciLibPciRootBridgeIo/PciLib.c +++ b/MdePkg/Library/UefiPciLibPciRootBridgeIo/PciLib.c @@ -1,7 +1,7 @@ /** @file
PCI Library using PCI Root Bridge I/O Protocol.
- Copyright (c) 2007 - 2009, Intel Corporation. All rights reserved.<BR>
+ Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are
licensed and made available under the terms and conditions of
the BSD License which accompanies this distribution. The full
@@ -85,7 +85,7 @@ PciLibConstructor ( @param Address The address that encodes the PCI Bus, Device, Function and
Register.
- @param Width Width of data to read
+ @param Width The width of data to read
@return The value read from the PCI configuration register.
@@ -119,7 +119,7 @@ DxePciLibPciRootBridgeIoReadWorker ( @param Address The address that encodes the PCI Bus, Device, Function and
Register.
- @param Width Width of data to write
+ @param Width The width of data to write
@param Data The value to write.
@return The value written to the PCI configuration register.
diff --git a/MdePkg/Library/UefiRuntimeLib/RuntimeLib.c b/MdePkg/Library/UefiRuntimeLib/RuntimeLib.c index 4ab1a90b33..63ae9761b2 100644 --- a/MdePkg/Library/UefiRuntimeLib/RuntimeLib.c +++ b/MdePkg/Library/UefiRuntimeLib/RuntimeLib.c @@ -10,7 +10,7 @@ Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR> This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
-http://opensource.org/licenses/bsd-license.php
+http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@@ -36,8 +36,8 @@ EFI_RUNTIME_SERVICES *mInternalRT; /**
Set AtRuntime flag as TRUE after ExitBootServices.
- @param[in] Event The Event that is being processed
- @param[in] Context Event Context
+ @param[in] Event The Event that is being processed.
+ @param[in] Context The Event Context.
**/
VOID
@@ -55,8 +55,8 @@ RuntimeLibExitBootServicesEvent ( Call the passed in Child Notify event and convert any pointers in
lib to virtual mode.
- @param[in] Event The Event that is being processed
- @param[in] Context Event Context
+ @param[in] Event The Event that is being processed.
+ @param[in] Context The Event Context.
**/
VOID
EFIAPI
@@ -133,8 +133,8 @@ RuntimeDriverLibConstruct ( @param[in] ImageHandle The firmware allocated handle for the EFI image.
@param[in] SystemTable A pointer to the EFI System Table.
- @retval EFI_SUCCESS Shutdown the Runtime Driver Lib successfully
- @retval EFI_UNSUPPORTED Runtime Driver lib was not initialized at all
+ @retval EFI_SUCCESS The Runtime Driver Lib shutdown successfully.
+ @retval EFI_UNSUPPORTED Runtime Driver lib was not initialized.
**/
EFI_STATUS
EFIAPI
@@ -320,7 +320,7 @@ EfiSetTime ( @param Time The current alarm setting. Type EFI_TIME is defined in the GetTime()
function description.
- @retval EFI_SUCCESS The alarm settings were returned.
+ @retval EFI_SUCCESS The alarm settings were returned.
@retval EFI_INVALID_PARAMETER Enabled is NULL.
@retval EFI_INVALID_PARAMETER Pending is NULL.
@retval EFI_INVALID_PARAMETER Time is NULL.
@@ -466,13 +466,13 @@ EfiGetNextVariableName ( Variables are stored by the firmware and may maintain their values across power cycles. Each vendor
may create and manage its own variables without the risk of name conflicts by using a unique VendorGuid.
- @param VariableName the name of the vendor's variable, it's a
- Null-Terminated Unicode String
+ @param VariableName The name of the vendor's variable; it's a Null-Terminated
+ Unicode String
@param VendorGuid Unify identifier for vendor.
- @param Attributes Point to memory location to return the attributes of variable. If the point
+ @param Attributes Points to a memory location to return the attributes of variable. If the point
is NULL, the parameter would be ignored.
@param DataSize The size in bytes of Data-Buffer.
- @param Data Point to the content of the variable.
+ @param Data Points to the content of the variable.
@retval EFI_SUCCESS The firmware has successfully stored the variable and its data as
defined by the Attributes.
@@ -766,7 +766,7 @@ EfiUpdateCapsule ( Undefined on input.
@param ResetType Returns the type of reset required for the capsule update.
- @retval EFI_SUCCESS Valid answer returned.
+ @retval EFI_SUCCESS A valid answer was returned.
@retval EFI_INVALID_PARAMETER MaximumCapsuleSize is NULL.
@retval EFI_UNSUPPORTED The capsule type is not supported on this platform, and
MaximumCapsuleSize and ResetType are undefined.
@@ -817,7 +817,7 @@ EfiQueryCapsuleCapabilities ( @param MaximumVariableSize Returns the maximum size of the individual EFI
variables associated with the attributes specified.
- @retval EFI_SUCCESS Valid answer returned.
+ @retval EFI_SUCCESS A valid answer was returned.
@retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied.
@retval EFI_UNSUPPORTED EFI_UNSUPPORTED The attribute is not supported on this platform, and the
MaximumVariableStorageSize,
diff --git a/MdePkg/Library/UefiSalLib/UefiSalLib.c b/MdePkg/Library/UefiSalLib/UefiSalLib.c index 6c6d5709c8..e79c7ce8a9 100644 --- a/MdePkg/Library/UefiSalLib/UefiSalLib.c +++ b/MdePkg/Library/UefiSalLib/UefiSalLib.c @@ -40,14 +40,14 @@ SAL_PROC mSalProcEntry; or undefined result may occur during the execution of the procedure.
This function is only available on IPF.
- @param Index The SAL procedure Index number
- @param Arg2 The 2nd parameter for SAL procedure calls
- @param Arg3 The 3rd parameter for SAL procedure calls
- @param Arg4 The 4th parameter for SAL procedure calls
- @param Arg5 The 5th parameter for SAL procedure calls
- @param Arg6 The 6th parameter for SAL procedure calls
- @param Arg7 The 7th parameter for SAL procedure calls
- @param Arg8 The 8th parameter for SAL procedure calls
+ @param Index The SAL procedure Index number.
+ @param Arg2 The 2nd parameter for SAL procedure calls.
+ @param Arg3 The 3rd parameter for SAL procedure calls.
+ @param Arg4 The 4th parameter for SAL procedure calls.
+ @param Arg5 The 5th parameter for SAL procedure calls.
+ @param Arg6 The 6th parameter for SAL procedure calls.
+ @param Arg7 The 7th parameter for SAL procedure calls.
+ @param Arg8 The 8th parameter for SAL procedure calls.
@return SAL returned registers.
diff --git a/MdePkg/Library/UefiScsiLib/UefiScsiLib.c b/MdePkg/Library/UefiScsiLib/UefiScsiLib.c index cb051eecdf..8f885fa9b4 100644 --- a/MdePkg/Library/UefiScsiLib/UefiScsiLib.c +++ b/MdePkg/Library/UefiScsiLib/UefiScsiLib.c @@ -213,7 +213,7 @@ ScsiTestUnitReadyCommand ( If FALSE, then the standard inquiry data is
returned in InquiryDataBuffer.
- @retval EFI_SUCCESS The command was executed successfully. See HostAdapterStatus,
+ @retval EFI_SUCCESS The command executed successfully. See HostAdapterStatus,
TargetStatus, SenseDataLength, and SenseData in that order
for additional status information.
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, but the entire
@@ -357,7 +357,7 @@ ScsiInquiryCommand ( @param[in] PageControl Specifies the PC field of the CDB for this SCSI Command.
@param[in] PageCode Specifies the Page Control field of the CDB for this SCSI Command.
- @retval EFI_SUCCESS The command was executed successfully.
+ @retval EFI_SUCCESS The command executed successfully.
See HostAdapterStatus, TargetStatus, SenseDataLength,
and SenseData in that order for additional status information.
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, but the
@@ -471,7 +471,7 @@ ScsiModeSense10Command ( @param[out] HostAdapterStatus The status of Host Adapter.
@param[out] TargetStatus The status of the target.
- @retval EFI_SUCCESS Command is executed successfully.
+ @retval EFI_SUCCESS The command executed successfully.
@retval EFI_NOT_READY The SCSI Request Packet could not be sent because there are
too many SCSI Command Packets already queued.
@retval EFI_DEVICE_ERROR A device error occurred while attempting to send SCSI Request Packet.
@@ -556,9 +556,9 @@ ScsiRequestSenseCommand ( @param[out] TargetStatus The status of the target.
@param[in, out] DataBuffer A pointer to a data buffer.
@param[in, out] DataLength The length of data buffer.
- @param[in] Pmi Partial medium indicator.
+ @param[in] Pmi A partial medium indicator.
- @retval EFI_SUCCESS Command is executed successfully.
+ @retval EFI_SUCCESS The command executed successfully.
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, but the entire
DataBuffer could not be transferred. The actual
number of bytes transferred is returned in DataLength.
@@ -660,7 +660,7 @@ ScsiReadCapacityCommand ( @param[in, out] DataLength The length of data buffer.
@param[in] Pmi Partial medium indicator.
- @retval EFI_SUCCESS Command is executed successfully.
+ @retval EFI_SUCCESS The command executed successfully.
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, but the entire
DataBuffer could not be transferred. The actual
number of bytes transferred is returned in DataLength.
@@ -766,7 +766,7 @@ ScsiReadCapacity16Command ( @param[in] StartLba The start address of LBA.
@param[in] SectorSize The sector size.
- @retval EFI_SUCCESS Command is executed successfully.
+ @retval EFI_SUCCESS The command is executed successfully.
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, but the entire DataBuffer could
not be transferred. The actual number of bytes transferred is returned in DataLength.
@retval EFI_NOT_READY The SCSI Request Packet could not be sent because there are too many
@@ -864,7 +864,7 @@ ScsiRead10Command ( @param[in] StartLba The start address of LBA.
@param[in] SectorSize The sector size.
- @retval EFI_SUCCESS Command is executed successfully.
+ @retval EFI_SUCCESS The command executed successfully.
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, but the entire DataBuffer could
not be transferred. The actual number of bytes transferred is returned in DataLength.
@retval EFI_NOT_READY The SCSI Request Packet could not be sent because there are too many
@@ -962,7 +962,7 @@ ScsiWrite10Command ( @param[in] StartLba The start address of LBA.
@param[in] SectorSize The sector size.
- @retval EFI_SUCCESS Command is executed successfully.
+ @retval EFI_SUCCESS The command executed successfully.
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, but the entire DataBuffer could
not be transferred. The actual number of bytes transferred is returned in DataLength.
@retval EFI_NOT_READY The SCSI Request Packet could not be sent because there are too many
@@ -1060,7 +1060,7 @@ ScsiRead16Command ( @param[in] StartLba The start address of LBA.
@param[in] SectorSize The sector size.
- @retval EFI_SUCCESS Command is executed successfully.
+ @retval EFI_SUCCESS The command is executed successfully.
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, but the entire DataBuffer could
not be transferred. The actual number of bytes transferred is returned in DataLength.
@retval EFI_NOT_READY The SCSI Request Packet could not be sent because there are too many
|