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

Committing changes to the comments, to improve code documentation.

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8533 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
pkandel
2009-06-11 14:17:23 +00:00
parent 9277fdf8e7
commit e9b67286ad
26 changed files with 306 additions and 329 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
MdeModulePkg/Include/Protocol/Dpc.h
View File

@ -48,7 +48,7 @@ VOID
Add a Deferred Procedure Call to the end of the DPC queue.
@param This Protocol instance pointer.
@param DpcTpl The EFI_TPL that the DPC should be invoked.
@param DpcTpl The EFI_TPL that the DPC should invoke.
@param DpcProcedure Pointer to the DPC's function.
@param DpcContext Pointer to the DPC's context. Passed to DpcProcedure
when DpcProcedure is invoked.
@ -70,10 +70,11 @@ EFI_STATUS
);
/**
Dispatch the queue of DPCs. ALL DPCs that have been queued with a DpcTpl
value greater than or equal to the current TPL are invoked in the order that
they were queued. DPCs with higher DpcTpl values are invoked before DPCs with
lower DpcTpl values.
Dispatch the queue of DPCs.
DPCs with DpcTpl value greater than the current TPL value are queued, and then DPCs
with DpcTpl value lower than the current TPL value are queued. All DPCs in the first group (higher DpcTpl values)
are invoked before DPCs in the second group (lower DpcTpl values).
@param This Protocol instance pointer.

52
MdeModulePkg/Include/Protocol/FaultTolerantWrite.h
View File

@ -1,8 +1,8 @@
/** @file
Fault Tolerant Write protocol provides boot-time service to do fault tolerant
Fault Tolerant Write protocol provides boot-time service for fault tolerant
write capability for block devices. The protocol provides for non-volatile
intermediate storage of the data and private information a caller would need to
recover from a critical fault, such as power failure.
storage of the intermediate data and private information a caller would need to
recover from a critical fault, such as a power failure.
Copyright (c) 2009, Intel Corporation
All rights reserved. This program and the accompanying materials
@ -29,11 +29,11 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
typedef struct _EFI_FAULT_TOLERANT_WRITE_PROTOCOL EFI_FAULT_TOLERANT_WRITE_PROTOCOL;
/**
Query the largest block that may be updated in a fault tolerant manner.
Get the size of the largest block that can be updated in a fault-tolerant manner.
@param This Indicates a pointer to the calling context.
@param BlockSize A pointer to a caller allocated UINTN that is
updated to indicate the size of the largest block
@param BlockSize A pointer to a caller-allocated UINTN that is
updated to indicate the size of the largest block
that can be updated.
@retval EFI_SUCCESS The function completed successfully
@ -49,22 +49,22 @@ EFI_STATUS
/**
Allocates space for the protocol to maintain information about writes.
Since writes must be completed in a fault tolerant manner and multiple
updates will require more resources to be successful, this function
Since writes must be completed in a fault-tolerant manner and multiple
writes require more resources to be successful, this function
enables the protocol to ensure that enough space exists to track
information about the upcoming writes.
information about upcoming writes.
@param This Indicates a pointer to the calling context.
@param This A pointer to the calling context.
@param CallerId The GUID identifying the write.
@param PrivateDataSize The size of the caller's private data that must be
recorded for each write.
@param NumberOfWrites The number of fault tolerant block writes that will
@param NumberOfWrites The number of fault tolerant block writes that will
need to occur.
@retval EFI_SUCCESS The function completed successfully
@retval EFI_ABORTED The function could not complete successfully.
@retval EFI_ACCESS_DENIED All allocated writes have not been completed. All
writes must be completed or aborted before another
@retval EFI_ACCESS_DENIED Not all allocated writes have been completed. All
writes must be completed or aborted before another
fault tolerant write can occur.
**/
@ -79,7 +79,7 @@ EFI_STATUS
/**
Starts a target block update. This records information about the write
in fault tolerant storage and will complete the write in a recoverable
in fault tolerant storage, and will complete the write in a recoverable
manner, ensuring at all times that either the original contents or
the modified contents are available.
@ -89,18 +89,18 @@ EFI_STATUS
data.
@param Length The number of bytes to write to the target block.
@param PrivateData A pointer to private data that the caller requires
to complete any pending writes in the event of a
to complete any pending writes in the event of a
fault.
@param FvBlockHandle The handle of FVB protocol that provides services
for reading, writing, and erasing the target block.
for reading, writing, and erasing the target block.
@param Buffer The data to write.
@retval EFI_SUCCESS The function completed successfully
@retval EFI_ABORTED The function could not complete successfully.
@retval EFI_BAD_BUFFER_SIZE The write would span a block boundary, which is not
@retval EFI_BAD_BUFFER_SIZE The write would span a block boundary, which is not
a valid action.
@retval EFI_ACCESS_DENIED No writes have been allocated.
@retval EFI_NOT_READY The last write has not been completed. Restart ()
@retval EFI_NOT_READY The last write has not been completed. Restart()
must be called to complete it.
**/
@ -122,7 +122,7 @@ EFI_STATUS
@param This Calling context.
@param FvBlockProtocol The handle of FVB protocol that provides services
for reading, writing, and erasing the target block.
for reading, writing, and erasing the target block.
@retval EFI_SUCCESS The function completed successfully
@retval EFI_ABORTED The function could not complete successfully.
@ -137,7 +137,7 @@ EFI_STATUS
);
/**
Aborts all previous allocated writes.
Aborts all previously allocated writes.
@param This Calling context
@ -153,8 +153,8 @@ EFI_STATUS
);
/**
Starts a target block update. This records information about the write
in fault tolerant storage and will complete the write in a recoverable
Starts a target block update. This function records information about the write
in fault tolerant storage and completes the write in a recoverable
manner, ensuring at all times that either the original contents or
the modified contents are available.
@ -163,13 +163,13 @@ EFI_STATUS
@param Lba The logical block address of the last write.
@param Offset The offset within the block of the last write.
@param Length The length of the last write.
@param PrivateDataSize On input, the size of the PrivateData buffer. On
output, the size of the private data stored for
@param PrivateDataSize On input, the size of the PrivateData buffer. On
output, the size of the private data stored for
this write.
@param PrivateData A pointer to a buffer. The function will copy
PrivateDataSize bytes from the private data stored
PrivateDataSize bytes from the private data stored
for this write.
@param Complete A Boolean value with TRUE indicating that the write
@param Complete A Boolean value with TRUE indicating that the write
was completed.
@retval EFI_SUCCESS The function completed successfully

29
MdeModulePkg/Include/Protocol/GenericMemoryTest.h
View File

@ -22,7 +22,7 @@ typedef struct _EFI_GENERIC_MEMORY_TEST_PROTOCOL EFI_GENERIC_MEMORY_TEST_PROTOC
///
/// Memory test coverage level
/// Ignore op not test memory, Quick and Sparse op test memory quickly, Extensive op test memory detailedly.
/// Ignore chooses not to test memory, Quick and Sparse test some memory, and Extensive performs a detailed memory test.
///
typedef enum {
IGNORE,
@ -41,9 +41,7 @@ typedef enum {
@param RequireSoftECCInit Indicate if the memory need software ECC init.
@retval EFI_SUCCESS The generic memory test is initialized correctly.
@retval EFI_NO_MEDIA There is not any non-tested memory found, which means
that the memory test driver have not detect any
non-tested extended memory in current system.
@retval EFI_NO_MEDIA The system had no memory to be tested.
**/
typedef
@ -60,15 +58,14 @@ EFI_STATUS
@param This Protocol instance pointer.
@param TestedMemorySize Return the tested extended memory size.
@param TotalMemorySize Return the whole system physical memory size, this
value may be changed if some error DIMMs is disabled in some case.
@param ErrorOut TRUE if the memory error occurs.
@param IfTestAbort Indicate if the user press "ESC" to skip the memory test.
@param TotalMemorySize Return the whole system physical memory size.
The total memory size does not include memory in a slot with a disabled DIMM.
@param ErrorOut TRUE if the memory error occured.
@param IfTestAbort Indicates that the user pressed "ESC" to skip the memory test.
@retval EFI_SUCCESS One block of memory pass test.
@retval EFI_NOT_FOUND Indicate all the non-tested memory blocks have been
already gone through.
@retval EFI_DEVICE_ERROR Memory device error occurs and no agent can handle it.
@retval EFI_SUCCESS One block of memory passed the test.
@retval EFI_NOT_FOUND All memory blocks have already been tested.
@retval EFI_DEVICE_ERROR Memory device error occured, and no agent can handle it.
**/
typedef
@ -87,9 +84,7 @@ EFI_STATUS
@param This Protocol instance pointer.
@retval EFI_SUCCESS Success. Then free all the generic memory test driver
allocated resource and notify to platform memory
test driver that memory test finished.
@retval EFI_SUCCESS Success. All resources used in the memory test are freed.
**/
typedef
@ -99,8 +94,8 @@ EFI_STATUS
);
/**
Provide capability to test compatible range used by some sepcial
driver before BDS perform memory test.
Provides the capability to test the compatible range used by a special
driver.
@param This Protocol instance pointer.
@param StartAddress The start address of the compatible memory range that

4
MdeModulePkg/Include/Protocol/LoadPe32Image.h
View File

@ -1,7 +1,7 @@
/** @file
Load Pe32 Image protocol provides capability to load and unload EFI image into memory and execute it.
This protocol bases on File Device Path to get EFI image.
Load Pe32 Image protocol enables loading and unloading EFI images into memory and executing those images.
This protocol uses File Device Path to get EFI image.
Copyright (c) 2006 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials

40
MdeModulePkg/Include/Protocol/Print2.h
View File

@ -26,15 +26,15 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
typedef struct _EFI_PRINT2_PROTOCOL EFI_PRINT2_PROTOCOL;
/**
Produces a Null-terminated Unicode string in an output buffer based on
Produces a Null-terminated Unicode string in an output buffer, based on
a Null-terminated Unicode format string and a BASE_LIST argument list
Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer
and BufferSize.
The Unicode string is produced by parsing the format string specified by FormatString.
Arguments are pulled from the variable argument list specified by Marker based on the
Arguments are pulled from the variable argument list specified by Marker. Marker is constructed based on the
contents of the format string.
The number of Unicode characters in the produced output buffer is returned not including
This function returns the number of Unicode characters in the produced output buffer, not including
the Null-terminator.
If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.
@ -55,7 +55,7 @@ typedef struct _EFI_PRINT2_PROTOCOL EFI_PRINT2_PROTOCOL;
@param FormatString Null-terminated Unicode format string.
@param Marker BASE_LIST marker for the variable argument list.
@return The number of Unicode characters in the produced output buffer not including the
@return The number of Unicode characters in the produced output buffer, not including the
Null-terminator.
**/
@ -76,7 +76,7 @@ UINTN
and BufferSize.
The Unicode string is produced by parsing the format string specified by FormatString.
Arguments are pulled from the variable argument list based on the contents of the format string.
The number of Unicode characters in the produced output buffer is returned not including
This function returns the number of Unicode characters in the produced output buffer, not including
the Null-terminator.
If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.
@ -112,7 +112,7 @@ UINTN
);
/**
Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated
Produces a Null-terminated Unicode string in an output buffer, based on a Null-terminated
ASCII format string and a BASE_LIST argument list
Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer
@ -120,7 +120,7 @@ UINTN
The Unicode string is produced by parsing the format string specified by FormatString.
Arguments are pulled from the variable argument list specified by Marker based on the
contents of the format string.
The number of Unicode characters in the produced output buffer is returned not including
This function returns the number of Unicode characters in the produced output buffer, not including
the Null-terminator.
If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.
@ -155,14 +155,14 @@ UINTN
/**
Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated
ASCII format string and variable argument list.
ASCII format string and a variable argument list.
Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer
and BufferSize.
The Unicode string is produced by parsing the format string specified by FormatString.
Arguments are pulled from the variable argument list based on the contents of the
format string.
The number of Unicode characters in the produced output buffer is returned not including
This function returns the number of Unicode characters in the produced output buffer, not including
the Null-terminator.
If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.
@ -201,11 +201,11 @@ UINTN
Converts the decimal number specified by Value to a Null-terminated Unicode
string specified by Buffer containing at most Width characters. No padding of spaces
is ever performed. If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed.
The number of Unicode characters in Buffer is returned not including the Null-terminator.
If the conversion contains more than Width characters, then only the first
Width characters are returned, and the total number of characters
required to perform the conversion is returned.
is ever performed. If Width is 0, then a width of MAXIMUM_VALUE_CHARACTERS is assumed.
This function returns the number of Unicode characters in Buffer, not including
the Null-terminator.
If the conversion contains more than Width characters, this function returns
the first Width characters in the conversion, along with the total number of characters in the conversion.
Additional conversion parameters are specified in Flags.
The Flags bit LEFT_JUSTIFY is always ignored.
@ -255,7 +255,7 @@ UINTN
The ASCII string is produced by parsing the format string specified by FormatString.
Arguments are pulled from the variable argument list specified by Marker based on
the contents of the format string.
The number of ASCII characters in the produced output buffer is returned not including
This function returns the number of ASCII characters in the output buffer, not including
the Null-terminator.
If BufferSize is 0, then no output buffer is produced and 0 is returned.
@ -289,14 +289,14 @@ UINTN
/**
Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated
ASCII format string and variable argument list.
ASCII format string and variable argument list.
Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer
and BufferSize.
The ASCII string is produced by parsing the format string specified by FormatString.
Arguments are pulled from the variable argument list based on the contents of the
format string.
The number of ASCII characters in the produced output buffer is returned not including
This function returns the number of ASCII characters in the output buffer, not including
the Null-terminator.
If BufferSize is 0, then no output buffer is produced and 0 is returned.
@ -338,7 +338,7 @@ UINTN
The ASCII string is produced by parsing the format string specified by FormatString.
Arguments are pulled from the variable argument list specified by Marker based on
the contents of the format string.
The number of ASCII characters in the produced output buffer is returned not including
This function returns the number of ASCII characters in the output buffer, not including
the Null-terminator.
If BufferSize is 0, then no output buffer is produced and 0 is returned.
@ -380,7 +380,7 @@ UINTN
The ASCII string is produced by parsing the format string specified by FormatString.
Arguments are pulled from the variable argument list based on the contents of the
format string.
The number of ASCII characters in the produced output buffer is returned not including
This function returns the number of ASCII characters in the output buffer, not including
the Null-terminator.
If BufferSize is 0, then no output buffer is produced and 0 is returned.
@ -420,7 +420,7 @@ UINTN
Converts the decimal number specified by Value to a Null-terminated ASCII string
specified by Buffer containing at most Width characters. No padding of spaces
is ever performed.
If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed.
If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed.
The number of ASCII characters in Buffer is returned not including the Null-terminator.
If the conversion contains more than Width characters, then only the first Width
characters are returned, and the total number of characters required to perform

35
MdeModulePkg/Include/Protocol/SwapAddressRange.h
View File

@ -1,9 +1,9 @@
/** @file
The EFI_SWAP_ADDRESS_RANGE_PROTOCOL is used to abstract the swap operation of boot block
and backup block of FV. This swap is especially needed when updating the boot block of FV. If any
power failure happens during updating boot block, the swapped backup block (now is the boot block)
can boot the machine with old boot block backuped in it. The swap operation is platform dependent, so
other protocols such as FTW (Fault Tolerant Write) should use this protocol instead of handling hardward directly.
power failure happens during the boot block update, the swapped backup block (now the boot block)
can boot the machine with the old boot block backed up in it. The swap operation is platform dependent, so
other protocols such as FTW (Fault Tolerant Write) should use this protocol instead of handling hardware directly.
Copyright (c) 2009, Intel Corporation
All rights reserved. This program and the accompanying materials
@ -36,12 +36,11 @@ typedef struct _EFI_SWAP_ADDRESS_RANGE_PROTOCOL EFI_SWAP_ADDRESS_RANGE_PROTOCOL
typedef UINT8 EFI_SWAP_LOCK_CAPABILITY;
//
// Protocl APIs
// Protocol APIs
//
/**
This service gets the address range location of boot block and backup block.
The EFI_GET_RANGE_LOCATION service allows caller to get the range location of
This function gets the address range location of
boot block and backup block.
@param This Indicates the calling context.
@ -66,8 +65,6 @@ EFI_STATUS
/**
This service checks if the boot block and backup block has been swapped.
The EFI_GET_SWAP_STATE service allows caller to get current swap state of boot block and backup block.
@param This Indicates the calling context.
@param SwapState True if the boot block and backup block has been swapped.
False if the boot block and backup block has not been swapped.
@ -85,12 +82,11 @@ EFI_STATUS
/**
This service swaps the boot block and backup block, or swaps them back.
The EFI_SET_SWAP_STATE service allows caller to set the swap state of boot block and backup block.
It also acquires and releases software swap lock during operation. Note the setting of new swap state
It also acquires and releases software swap lock during operation. The setting of the new swap state
is not affected by the old swap state.
@param This Indicates the calling context.
@param NewSwapState True to swap real boot block and backup block , False to swap them back..
@param NewSwapState True to swap real boot block and backup block, False to swap them back.
@retval EFI_SUCCESS The call was successful.
@retval EFI_ABORTED Set swap state error
@ -106,15 +102,13 @@ EFI_STATUS
/**
This service checks if a RTC (Real Time Clock) power failure happened.
This service checks if a Real Time Clock (RTC) power failure happened.
The EFI_GET_RTC_POWER_STATUS service allows caller to get Real Time Clock power failure status.
If parameter RtcPowerFailed is true after function returns, the trickle current (from the main battery or trickle supply)
has been removed or failed, this means the swap status was lost in some platform (such as IA32).
So it is recommended to check RTC power status before calling GetSwapState().
If parameter RtcPowerFailed is true after the function returns, RTC power supply failed or was removed.
It is recommended to check RTC power status before calling GetSwapState().
@param This Indicates the calling context.
@param RtcPowerFailed True if a RTC (Real Time Clock) power failure has happened.
@param RtcPowerFailed True if the RTC (Real Time Clock) power failed or was removed.
@retval EFI_SUCCESS The call was successful.
@ -127,10 +121,8 @@ EFI_STATUS
);
/**
This service returns supported lock methods for swap operation in current platform. Could be software lock, hardware lock, or unsupport lock.
The EFI_GET_SWAP_LOCK_CAPABILITY service allows caller to get supported lock method for swap operation in current platform.
Note that software and hardware lock mothod can be used simultaneously.
This service returns all lock methods for swap operations that the current platform supports. Could be software lock, hardware lock, or unsupport lock.
Note that software and hardware lock methods can be used simultaneously.
@param This Indicates the calling context.
@param LockCapability Current lock method for swap operation.
@ -150,7 +142,6 @@ EFI_STATUS
/**
This service is used to acquire or release appointed kind of lock for Swap Address Range operation.
The EFI_GET_SWAP_LOCK_CAPABILITY service allows caller to get supported lock method for swap operation in current platform.
Note that software and hardware lock mothod can be used simultaneously.
@param This Indicates the calling context.