mirror of https://github.com/acidanthera/audk.git
Function headers in .h and .c files synchronized with spec
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6731 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
parent
fc0c5b3a99
commit
122e219151
|
@ -165,7 +165,7 @@ PeiServicesCreateHob (
|
|||
|
||||
@param Instance This instance of the firmware volume to find. The value 0 is the
|
||||
Boot Firmware Volume (BFV).
|
||||
@param VolumeHandle Pointer to the firmware volume header of the volume to return.
|
||||
@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.
|
||||
|
@ -185,7 +185,7 @@ PeiServicesFfsFindNextVolume (
|
|||
@param SearchType A filter to find files only of this type.
|
||||
@param VolumeHandle Pointer to the firmware volume header of the volume to search.
|
||||
This parameter must point to a valid FFS volume.
|
||||
@param FileHandle Pointer to the current file from which to begin searching.
|
||||
@param FileHandle Handle of the current file from which to begin searching.
|
||||
|
||||
@retval EFI_SUCCESS The file was found.
|
||||
@retval EFI_NOT_FOUND The file was not found.
|
||||
|
|
|
@ -33,7 +33,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
|||
|
||||
@param Value The 32-bit value to write to the POST card.
|
||||
|
||||
@return Value The 32-bit value to write to the POST card.
|
||||
@return The 32-bit value to write to the POST card.
|
||||
|
||||
**/
|
||||
UINT32
|
||||
|
@ -55,16 +55,16 @@ PostCode (
|
|||
value on the status reporting device.
|
||||
|
||||
PostCodeWithDescription()must actively prevent recursion. If
|
||||
PostCodeWithDescription() is called while processing another any other
|
||||
Post Code Library function, then PostCodeWithDescription()
|
||||
must return Value immediately.
|
||||
PostCodeWithDescription() is called while processing another any other Post
|
||||
Code Library function, then PostCodeWithDescription() must return Value
|
||||
immediately.
|
||||
|
||||
@param Value The 32-bit value to write to the POST card.
|
||||
@param Description Pointer to an ASCII string that is a description of the
|
||||
POST code value. This is an optional parameter that may
|
||||
be NULL.
|
||||
|
||||
@return Value The 32-bit value to write to the POST card.
|
||||
@return The 32-bit value to write to the POST card.
|
||||
|
||||
**/
|
||||
UINT32
|
||||
|
|
|
@ -16,7 +16,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
|||
#define __RESOURCE_PUBLICATION_LIB__
|
||||
|
||||
/**
|
||||
|
||||
Declares the presence of permanent system memory in the platform.
|
||||
|
||||
Declares that the system memory buffer specified by MemoryBegin and MemoryLength
|
||||
|
|
|
@ -181,6 +181,8 @@ PeCoffLoaderGetPeHeader (
|
|||
If any errors occur while computing the fields of ImageContext,
|
||||
then the error status is returned in the ImageError field of ImageContext.
|
||||
If the image is a TE image, then SectionAlignment is set to 0.
|
||||
The ImageRead and Handle fields of ImageContext structure must be valid prior
|
||||
to invoking this service.
|
||||
|
||||
@param ImageContext Pointer to the image context structure that describes the PE/COFF
|
||||
image that needs to be examined by this function.
|
||||
|
|
|
@ -93,6 +93,7 @@ UnicodeVSPrint (
|
|||
@param FormatString Null-terminated Unicode format string.
|
||||
@param ... Variable argument list whose contents are accessed based on the
|
||||
format string specified by FormatString.
|
||||
|
||||
@return The number of Unicode characters in the produced output buffer not including the
|
||||
Null-terminator.
|
||||
|
||||
|
|
|
@ -51,7 +51,7 @@
|
|||
|
||||
@param Value The 32-bit value to write to the POST card.
|
||||
|
||||
@return Value The 32-bit value to write to the POST card.
|
||||
@return The 32-bit value to write to the POST card.
|
||||
|
||||
**/
|
||||
UINT32
|
||||
|
@ -86,7 +86,7 @@ PostCode (
|
|||
POST code value. This is an optional parameter that may
|
||||
be NULL.
|
||||
|
||||
@return Value The 32-bit value to write to the POST card.
|
||||
@return The 32-bit value to write to the POST card.
|
||||
|
||||
**/
|
||||
UINT32
|
||||
|
|
|
@ -273,23 +273,19 @@ PciSegmentOr8 (
|
|||
}
|
||||
|
||||
/**
|
||||
Performs a bitwise AND of an 8-bit PCI configuration register with an 8-bit
|
||||
value.
|
||||
|
||||
Reads the 8-bit PCI configuration register specified by Address, performs a
|
||||
bitwise AND between the read result and the value specified by AndData, and
|
||||
writes the result to the 8-bit PCI configuration register specified by
|
||||
Address. The value written to the PCI configuration register is returned.
|
||||
This function must guarantee that all PCI read and write operations are
|
||||
serialized.
|
||||
Performs a bitwise AND of an 8-bit PCI configuration register with an 8-bit value.
|
||||
|
||||
Reads the 8-bit PCI configuration register specified by Address,
|
||||
performs a bitwise AND between the read result and the value specified by AndData,
|
||||
and writes the result to the 8-bit PCI configuration register specified by Address.
|
||||
The value written to the PCI configuration register is returned.
|
||||
This function must guarantee that all PCI read and write operations are serialized.
|
||||
If any reserved bits in Address are set, then ASSERT().
|
||||
|
||||
@param Address Address that encodes the PCI Segment, Bus, Device, Function and
|
||||
Register.
|
||||
@param Address 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 back to the PCI configuration register.
|
||||
@return The value written to the PCI configuration register.
|
||||
|
||||
**/
|
||||
UINT8
|
||||
|
@ -303,25 +299,23 @@ PciSegmentAnd8 (
|
|||
}
|
||||
|
||||
/**
|
||||
Performs a bitwise AND of an 8-bit PCI configuration register with an 8-bit
|
||||
value, followed a bitwise inclusive OR with another 8-bit value.
|
||||
Performs a bitwise AND of an 8-bit PCI configuration register with an 8-bit value,
|
||||
followed a bitwise inclusive OR with another 8-bit value.
|
||||
|
||||
Reads the 8-bit PCI configuration register specified by Address, performs a
|
||||
bitwise AND between the read result and the value specified by AndData,
|
||||
performs a bitwise inclusive OR between the result of the AND operation and
|
||||
the value specified by OrData, and writes the result to the 8-bit PCI
|
||||
configuration register specified by Address. The value written to the PCI
|
||||
configuration register is returned. This function must guarantee that all PCI
|
||||
read and write operations are serialized.
|
||||
Reads the 8-bit PCI configuration register specified by Address,
|
||||
performs a bitwise AND between the read result and the value specified by AndData,
|
||||
performs a bitwise inclusive OR between the result of the AND operation and the value specified by OrData,
|
||||
and writes the result to the 8-bit PCI configuration register specified by Address.
|
||||
The value written to the PCI configuration register is returned.
|
||||
This function must guarantee that all PCI read and write operations are serialized.
|
||||
|
||||
If any reserved bits in Address are set, then ASSERT().
|
||||
|
||||
@param Address Address that encodes the PCI Segment, Bus, Device, Function and
|
||||
Register.
|
||||
@param Address 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 result of the AND operation.
|
||||
@param OrData The value to OR with the PCI configuration register.
|
||||
|
||||
@return The value written back to the PCI configuration register.
|
||||
@return The value written to the PCI configuration register.
|
||||
|
||||
**/
|
||||
UINT8
|
||||
|
@ -617,23 +611,21 @@ PciSegmentOr16 (
|
|||
}
|
||||
|
||||
/**
|
||||
Performs a bitwise AND of a 16-bit PCI configuration register with a 16-bit
|
||||
value.
|
||||
Performs a bitwise AND of a 16-bit PCI configuration register with a 16-bit value.
|
||||
|
||||
Reads the 16-bit PCI configuration register specified by Address, performs a
|
||||
bitwise AND between the read result and the value specified by AndData, and
|
||||
writes the result to the 16-bit PCI configuration register specified by
|
||||
Address. The value written to the PCI configuration register is returned.
|
||||
This function must guarantee that all PCI read and write operations are
|
||||
serialized.
|
||||
Reads the 16-bit PCI configuration register specified by Address,
|
||||
performs a bitwise AND between the read result and the value specified by AndData,
|
||||
and writes the result to the 16-bit PCI configuration register specified by Address.
|
||||
The value written to the PCI configuration register is returned.
|
||||
This function must guarantee that all PCI read and write operations are serialized.
|
||||
|
||||
If any reserved bits in Address are set, then ASSERT().
|
||||
If Address is not aligned on a 16-bit boundary, then ASSERT().
|
||||
|
||||
@param Address Address that encodes the PCI Segment, Bus, Device, Function and
|
||||
Register.
|
||||
@param Address 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 back to the PCI configuration register.
|
||||
@return The value written to the PCI configuration register.
|
||||
|
||||
**/
|
||||
UINT16
|
||||
|
@ -961,23 +953,21 @@ PciSegmentOr32 (
|
|||
}
|
||||
|
||||
/**
|
||||
Performs a bitwise AND of a 32-bit PCI configuration register with a 32-bit
|
||||
value.
|
||||
Performs a bitwise AND of a 32-bit PCI configuration register with a 32-bit value.
|
||||
|
||||
Reads the 32-bit PCI configuration register specified by Address, performs a
|
||||
bitwise AND between the read result and the value specified by AndData, and
|
||||
writes the result to the 32-bit PCI configuration register specified by
|
||||
Address. The value written to the PCI configuration register is returned.
|
||||
This function must guarantee that all PCI read and write operations are
|
||||
serialized.
|
||||
Reads the 32-bit PCI configuration register specified by Address,
|
||||
performs a bitwise AND between the read result and the value specified by AndData,
|
||||
and writes the result to the 32-bit PCI configuration register specified by Address.
|
||||
The value written to the PCI configuration register is returned.
|
||||
This function must guarantee that all PCI read and write operations are serialized.
|
||||
|
||||
If any reserved bits in Address are set, then ASSERT().
|
||||
If Address is not aligned on a 32-bit boundary, then ASSERT().
|
||||
|
||||
@param Address Address that encodes the PCI Segment, Bus, Device, Function and
|
||||
Register.
|
||||
@param Address 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 back to the PCI configuration register.
|
||||
@return The value written to the PCI configuration register.
|
||||
|
||||
**/
|
||||
UINT32
|
||||
|
@ -991,25 +981,24 @@ PciSegmentAnd32 (
|
|||
}
|
||||
|
||||
/**
|
||||
Performs a bitwise AND of a 32-bit PCI configuration register with a 32-bit
|
||||
value, followed a bitwise inclusive OR with another 32-bit value.
|
||||
Performs a bitwise AND of a 32-bit PCI configuration register with a 32-bit value,
|
||||
followed a bitwise inclusive OR with another 32-bit value.
|
||||
|
||||
Reads the 32-bit PCI configuration register specified by Address, performs a
|
||||
bitwise AND between the read result and the value specified by AndData,
|
||||
performs a bitwise inclusive OR between the result of the AND operation and
|
||||
the value specified by OrData, and writes the result to the 32-bit PCI
|
||||
configuration register specified by Address. The value written to the PCI
|
||||
configuration register is returned. This function must guarantee that all PCI
|
||||
read and write operations are serialized.
|
||||
Reads the 32-bit PCI configuration register specified by Address,
|
||||
performs a bitwise AND between the read result and the value specified by AndData,
|
||||
performs a bitwise inclusive OR between the result of the AND operation and the value specified by OrData,
|
||||
and writes the result to the 32-bit PCI configuration register specified by Address.
|
||||
The value written to the PCI configuration register is returned.
|
||||
This function must guarantee that all PCI read and write operations are serialized.
|
||||
|
||||
If any reserved bits in Address are set, then ASSERT().
|
||||
If Address is not aligned on a 32-bit boundary, then ASSERT().
|
||||
|
||||
@param Address Address that encodes the PCI Segment, Bus, Device, Function and
|
||||
Register.
|
||||
@param Address 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 result of the AND operation.
|
||||
@param OrData The value to OR with the PCI configuration register.
|
||||
|
||||
@return The value written back to the PCI configuration register.
|
||||
@return The value written to the PCI configuration register.
|
||||
|
||||
**/
|
||||
UINT32
|
||||
|
|
|
@ -23,7 +23,6 @@
|
|||
|
||||
|
||||
/**
|
||||
|
||||
Declares the presence of permanent system memory in the platform.
|
||||
|
||||
Declares that the system memory buffer specified by MemoryBegin and MemoryLength
|
||||
|
|
|
@ -282,7 +282,7 @@ 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 FfsFileHeader A pointer to the file header that contains the set of sections to
|
||||
@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.
|
||||
|
||||
|
@ -294,14 +294,14 @@ EFI_STATUS
|
|||
EFIAPI
|
||||
PeiServicesFfsFindSectionData (
|
||||
IN EFI_SECTION_TYPE SectionType,
|
||||
IN EFI_PEI_FILE_HANDLE FfsFileHeader,
|
||||
IN EFI_PEI_FILE_HANDLE FileHandle,
|
||||
OUT VOID **SectionData
|
||||
)
|
||||
{
|
||||
CONST EFI_PEI_SERVICES **PeiServices;
|
||||
|
||||
PeiServices = GetPeiServicesTablePointer ();
|
||||
return (*PeiServices)->FfsFindSectionData (PeiServices, SectionType, FfsFileHeader, SectionData);
|
||||
return (*PeiServices)->FfsFindSectionData (PeiServices, SectionType, FileHandle, SectionData);
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -384,8 +384,6 @@ PeiServicesAllocatePool (
|
|||
/**
|
||||
Resets the entire platform.
|
||||
|
||||
@param VOID
|
||||
|
||||
@retval EFI_SUCCESS The function completed successfully.
|
||||
@retval EFI_NOT_AVAILABLE_YET The service has not been installed yet.
|
||||
|
||||
|
|
Loading…
Reference in New Issue