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

Grammatical and disclaimer changes (does not follow internal C coding stds.)

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10235 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
myronporter
2010-03-12 22:19:12 +00:00
parent 636f2be673
commit af2dc6a70b
85 changed files with 2610 additions and 2573 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
MdePkg/Include/Library/PeCoffLib.h
View File

@@ -5,12 +5,11 @@
IA-32, x86, IPF, and EBC processor types. The library functions are memory-based
and can be ported easily to any environment.
Copyright (c) 2006 - 2008, Intel Corporation<BR>
Portions copyright (c) 2008-2009 Apple Inc. All rights reserved.<BR>
All rights reserved. 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
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 that accompanies this distribution.
The full text of the license may be found at
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.
@@ -60,9 +59,10 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
On output, the number of bytes actually read.
@param Buffer Output buffer that contains the data read from the PE/COFF image.
@retval RETURN_SUCCESS The specified portion of the PE/COFF image was read and the size
@retval RETURN_DEVICE_ERROR The specified portion of the PE/COFF image could not be read due
to a device error.
@retval RETURN_SUCCESS The specified portion of the PE/COFF image was
read and the size
@retval RETURN_DEVICE_ERROR The specified portion of the PE/COFF image
could not be read due to a device error.
**/
typedef
@@ -75,20 +75,20 @@ RETURN_STATUS
);
///
/// Context structure used while PE/COFF image is being loaded and relocated
/// The context structure used while PE/COFF image is being loaded and relocated.
///
typedef struct {
///
/// Is set by PeCoffLoaderGetImageInfo() to the ImageBase in the PE/COFF header
/// Set by PeCoffLoaderGetImageInfo() to the ImageBase in the PE/COFF header.
///
PHYSICAL_ADDRESS ImageAddress;
///
/// Is set by PeCoffLoaderGetImageInfo() to the SizeOfImage in the PE/COFF header.
/// Set by PeCoffLoaderGetImageInfo() to the SizeOfImage in the PE/COFF header.
/// Image size includes the size of Debug Entry if it is present.
///
UINT64 ImageSize;
///
/// Is set to zero by PeCoffLoaderGetImageInfo(). If DestinationAddress is non zero,
/// Is set to zero by PeCoffLoaderGetImageInfo(). If DestinationAddress is non-zero,
/// PeCoffLoaderRelocateImage() will relocate the image using this base address.
/// If the DestinationAddress is zero, the ImageAddress will be used as the base
/// address of relocation.
@@ -115,18 +115,18 @@ typedef struct {
///
VOID *FixupData;
///
/// Is set by PeCoffLoaderGetImageInfo() to the Section Alignment in the PE/COFF header
/// Set by PeCoffLoaderGetImageInfo() to the Section Alignment in the PE/COFF header.
/// If the image is a TE image, then this field is set to 0.
///
UINT32 SectionAlignment;
///
/// Set by PeCoffLoaderGetImageInfo() to offset to the PE/COFF header.
/// If the PE/COFF image does not start with a DOS header, this value is zero;
/// otherwise, it's the offset to the PE/COFF header.
/// If the PE/COFF image does not start with a DOS header, this value is zero.
/// Otherwise, it's the offset to the PE/COFF header.
///
UINT32 PeCoffHeaderOffset;
///
/// Set by PeCoffLoaderGetImageInfo() to the Relative Virtual Address of the debug directory
/// Set by PeCoffLoaderGetImageInfo() to the Relative Virtual Address of the debug directory,
/// if it exists in the image
///
UINT32 DebugDirectoryEntryRva;
@@ -155,7 +155,7 @@ typedef struct {
/// Not used by this library class. Other library classes that layer on top of this library
/// class fill in this value as part of their GetImageInfo call.
/// This allows the caller of the library to know what type of memory needs to be allocated
/// to load and relocate the image
/// to load and relocate the image.
///
UINT32 ImageDataMemoryType;
///
@@ -164,11 +164,11 @@ typedef struct {
UINT32 ImageError;
///
/// Set by PeCoffLoaderLoadImage() to indicate the size of FixupData that the caller must
/// allocate before calling PeCoffLoaderRelocateImage()
/// allocate before calling PeCoffLoaderRelocateImage().
///
UINTN FixupDataSize;
///
/// Set by PeCoffLoaderGetImageInfo() to the machine type stored in the PE/COFF header
/// Set by PeCoffLoaderGetImageInfo() to the machine type stored in the PE/COFF header.
///
UINT16 Machine;
///
@@ -188,8 +188,8 @@ typedef struct {
BOOLEAN IsTeImage;
///
/// Set by PeCoffLoaderLoadImage() to the HII resource offset
/// if the image contains a custom PE/COFF resource with the type 'HII';
/// otherwise, the entry remains to be 0.
/// if the image contains a custom PE/COFF resource with the type 'HII'.
/// Otherwise, the entry remains to be 0.
///
PHYSICAL_ADDRESS HiiResourceData;
///
@@ -213,8 +213,9 @@ typedef struct {
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.
@param ImageContext The pointer to the image context structure that
describes the PE/COFF image that needs to be
examined by this function.
@retval RETURN_SUCCESS The information on the PE/COFF image was collected.
@retval RETURN_INVALID_PARAMETER ImageContext is NULL.
@@ -246,7 +247,7 @@ PeCoffLoaderGetImageInfo (
cache(s) in hardware, then the caller is responsible for performing cache maintenance operations
prior to transferring control to a PE/COFF image that is loaded using this library.
@param ImageContext Pointer to the image context structure that describes the PE/COFF
@param ImageContext The pointer to the image context structure that describes the PE/COFF
image that is being relocated.
@retval RETURN_SUCCESS The PE/COFF image was relocated.
@@ -280,7 +281,7 @@ PeCoffLoaderRelocateImage (
cache(s) in hardware, then the caller is responsible for performing cache maintenance operations
prior to transferring control to a PE/COFF image that is loaded using this library.
@param ImageContext Pointer to the image context structure that describes the PE/COFF
@param ImageContext The pointer to the image context structure that describes the PE/COFF
image that is being loaded.
@retval RETURN_SUCCESS The PE/COFF image was loaded into the buffer specified by
@@ -315,13 +316,13 @@ PeCoffLoaderLoadImage (
If ReadSize is NULL, then ASSERT().
If Buffer is NULL, then ASSERT().
@param FileHandle Pointer to base of the input stream
@param FileHandle The pointer to base of the input stream
@param FileOffset Offset into the PE/COFF image to begin the read operation.
@param ReadSize On input, the size in bytes of the requested read operation.
On output, the number of bytes actually read.
@param Buffer Output buffer that contains the data read from the PE/COFF image.
@retval RETURN_SUCCESS Data is read from FileOffset from the Handle into
@retval RETURN_SUCCESS The data is read from FileOffset from the Handle into
the buffer.
**/
RETURN_STATUS
@@ -348,7 +349,7 @@ PeCoffLoaderImageReadFromMemory (
cache(s) in hardware, then the caller is responsible for performing cache maintenance operations
prior to transferring control to a PE/COFF image that is loaded using this library.
@param ImageBase Base address of a PE/COFF image that has been loaded
@param ImageBase The base address of a PE/COFF image that has been loaded
and relocated into system memory.
@param VirtImageBase The request virtual address that the PE/COFF image is to
be fixed up for.