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@10269 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
myronporter
2010-03-17 20:48:52 +00:00
parent d96d37d8b9
commit 64a80549c8
37 changed files with 764 additions and 755 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,14 +1,14 @@
/** @file
EFI Deferred Procedure Call Protocol
EFI Deferred Procedure Call Protocol.
Copyright (c) 2007 - 2008, Intel Corporation
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) 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 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,
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
@@ -34,7 +34,7 @@ typedef struct _EFI_DPC_PROTOCOL EFI_DPC_PROTOCOL;
/**
Invoke a Deferred Procedure Call.
@param DpcContext Pointer to the Deferred Procedure Call's context,
@param DpcContext The pointer to the Deferred Procedure Call's context,
which is implementation dependent.
**/
@@ -47,10 +47,10 @@ VOID
/**
Add a Deferred Procedure Call to the end of the DPC queue.
@param This Protocol instance pointer.
@param This The protocol instance pointer.
@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
@param DpcProcedure The pointer to the DPC's function.
@param DpcContext The pointer to the DPC's context. Passed to DpcProcedure
when DpcProcedure is invoked.
@retval EFI_SUCCESS The DPC was queued.
@@ -73,8 +73,8 @@ EFI_STATUS
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).
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.
@@ -89,7 +89,7 @@ EFI_STATUS
);
///
/// DPC Protocol structure
/// DPC Protocol structure.
///
struct _EFI_DPC_PROTOCOL {
EFI_DPC_QUEUE_DPC QueueDpc;
@@ -97,7 +97,7 @@ struct _EFI_DPC_PROTOCOL {
};
///
/// DPC Protocol GUID variable
/// DPC Protocol GUID variable.
///
extern EFI_GUID gEfiDpcProtocolGuid;

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

@@ -1,15 +1,15 @@
/** @file
Fault Tolerant Write protocol provides boot-time service for fault tolerant
write capability for block devices. The protocol provides for non-volatile
storage of the intermediate data and private information a caller would need to
recover from a critical fault, such as a power failure.
Fault Tolerant Write protocol provides boot-time service for fault tolerant
write capability for block devices. The protocol provides for non-volatile
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 - 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.
Copyright (c) 2009 - 2010, Intel Corporation
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
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,7 +36,7 @@ typedef struct _EFI_FAULT_TOLERANT_WRITE_PROTOCOL EFI_FAULT_TOLERANT_WRITE_PROT
updated to indicate the size of the largest block
that can be updated.
@retval EFI_SUCCESS The function completed successfully
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_ABORTED The function could not complete successfully.
**/
@@ -83,7 +83,7 @@ EFI_STATUS
manner, ensuring at all times that either the original contents or
the modified contents are available.
@param This Calling context
@param This The calling context.
@param Lba The logical block address of the target block.
@param Offset The offset within the target block to place the
data.
@@ -95,7 +95,7 @@ EFI_STATUS
for reading, writing, and erasing the target block.
@param Buffer The data to write.
@retval EFI_SUCCESS The function completed successfully
@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
a valid action.
@@ -120,11 +120,11 @@ EFI_STATUS
Restarts a previously interrupted write. The caller must provide the
block protocol needed to complete the interrupted write.
@param This Calling context.
@param FvBlockProtocol The handle of FVB protocol that provides services
@param This The calling context.
@param FvBlockProtocol The handle of FVB protocol that provides services.
for reading, writing, and erasing the target block.
@retval EFI_SUCCESS The function completed successfully
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_ABORTED The function could not complete successfully.
@retval EFI_ACCESS_DENIED No pending writes exist.
@@ -139,9 +139,9 @@ EFI_STATUS
/**
Aborts all previously allocated writes.
@param This Calling context
@param This The calling context.
@retval EFI_SUCCESS The function completed successfully
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_ABORTED The function could not complete successfully.
@retval EFI_NOT_FOUND No allocated writes exist.
@@ -154,7 +154,7 @@ EFI_STATUS
/**
Starts a target block update. This function records information about the write
in fault tolerant storage and completes the write in a recoverable
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.
@@ -172,7 +172,7 @@ EFI_STATUS
@param Complete A Boolean value with TRUE indicating that the write
was completed.
@retval EFI_SUCCESS The function completed successfully
@retval EFI_SUCCESS The function completed successfully.
@retval EFI_ABORTED The function could not complete successfully.
@retval EFI_NOT_FOUND No allocated writes exist.

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

@@ -1,13 +1,13 @@
/** @file
This protocol defines the generic memory test interfaces in Dxe phase.
Copyright (c) 2006 - 2009, Intel Corporation. <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,
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
@@ -21,8 +21,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
typedef struct _EFI_GENERIC_MEMORY_TEST_PROTOCOL EFI_GENERIC_MEMORY_TEST_PROTOCOL;
///
/// Memory test coverage level
/// Ignore chooses not to test memory, Quick and Sparse test some memory, and Extensive performs a detailed memory test.
/// Memory test coverage level.
/// Ignore chooses not to test memory. Quick and Sparse test some memory, and Extensive performs a detailed memory test.
///
typedef enum {
IGNORE,
@@ -36,7 +36,7 @@ typedef enum {
/**
Initialize the generic memory test.
@param This Protocol instance pointer.
@param This The protocol instance pointer.
@param Level The coverage level of the memory test.
@param RequireSoftECCInit Indicate if the memory need software ECC init.
@@ -56,7 +56,7 @@ EFI_STATUS
/**
Perform the memory test.
@param This Protocol instance pointer.
@param This The protocol instance pointer.
@param TestedMemorySize Return the tested extended memory size.
@param TotalMemorySize Return the whole system physical memory size.
The total memory size does not include memory in a slot with a disabled DIMM.
@@ -82,7 +82,7 @@ EFI_STATUS
/**
Finish the memory test.
@param This Protocol instance pointer.
@param This The protocol instance pointer.
@retval EFI_SUCCESS Success. All resources used in the memory test are freed.
@@ -96,7 +96,7 @@ EFI_STATUS
/**
Provides the capability to test the compatible range used by some special drivers.
@param This Protocol instance pointer.
@param This The protocol instance pointer.
@param StartAddress The start address of the compatible memory range that
must be below 16M.
@param Length The compatible memory range's length.

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

@@ -1,15 +1,15 @@
/** @file
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.
This protocol uses File Device Path to get an EFI image.
Copyright (c) 2006 - 2009, Intel Corporation
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,
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,7 +30,7 @@ typedef struct _EFI_PE32_IMAGE_PROTOCOL EFI_PE32_IMAGE_PROTOCOL;
Loads an EFI image into memory and returns a handle to the image with extended parameters.
@param This Pointer to the LoadPe32Image protocol instance
@param This The pointer to the LoadPe32Image protocol instance
@param ParentImageHandle The caller's image handle.
@param FilePath The specific file path from which the image is loaded.
@param SourceBuffer If not NULL, a pointer to the memory location containing a copy of
@@ -39,8 +39,8 @@ typedef struct _EFI_PE32_IMAGE_PROTOCOL EFI_PE32_IMAGE_PROTOCOL;
@param DstBuffer The buffer to store the image.
@param NumberOfPages For input, specifies the space size of the image by caller if not NULL.
For output, specifies the actual space size needed.
@param ImageHandle Image handle for output.
@param EntryPoint Image entry point for output.
@param ImageHandle The image handle for output.
@param EntryPoint The image entry point for output.
@param Attribute The bit mask of attributes to set for the load PE image.
@retval EFI_SUCCESS The image was loaded into memory.
@@ -48,7 +48,7 @@ typedef struct _EFI_PE32_IMAGE_PROTOCOL EFI_PE32_IMAGE_PROTOCOL;
@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
@retval EFI_UNSUPPORTED The image type is not supported, or the device path cannot be
parsed to locate the proper protocol for loading the file.
@retval EFI_OUT_OF_RESOURCES Image was not loaded due to insufficient memory resources.
@retval EFI_OUT_OF_RESOURCES The image was not loaded due to insufficient memory resources.
**/
typedef
EFI_STATUS
@@ -69,12 +69,12 @@ EFI_STATUS
Unload the specified image.
@param This Pointer to the LoadPe32Image protocol instance
@param This The pointer to the LoadPe32Image protocol instance
@param ImageHandle The specified image handle to be unloaded.
@retval EFI_INVALID_PARAMETER Image handle is NULL.
@retval EFI_UNSUPPORTED Attempt to unload an unsupported image.
@retval EFI_SUCCESS Image is successfully unloaded.
@retval EFI_UNSUPPORTED Attempted to unload an unsupported image.
@retval EFI_SUCCESS The image successfully unloaded.
--*/
typedef

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

@@ -3,13 +3,13 @@
This print protocol defines six basic print functions to
print the format unicode and ascii string.
Copyright (c) 2006 - 2010, Intel Corporation
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,
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
@@ -222,7 +222,7 @@ UINTN
If both COMMA_TYPE and RADIX_HEX are set in Flags, then ASSERT().
If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()
@param Buffer Pointer to the output buffer for the produced Null-terminated
@param Buffer The pointer to the output buffer for the produced Null-terminated
Unicode string.
@param Flags The bitmask of flags that specify left justification, zero pad, and commas.
@param Value The 64-bit signed value to convert to a string.
@@ -432,7 +432,7 @@ UINTN
If both COMMA_TYPE and RADIX_HEX are set in Flags, then ASSERT().
If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()
@param Buffer Pointer to the output buffer for the produced Null-terminated
@param Buffer The pointer to the output buffer for the produced Null-terminated
ASCII string.
@param Flags The bitmask of flags that specify left justification, zero pad, and commas.
@param Value The 64-bit signed value to convert to a string.

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

@@ -1,16 +1,16 @@
/** @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
and backup block of FV. This swap is especially needed when updating the boot block of FV. If a
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 - 2010, Intel Corporation
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) 2009 - 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.
@@ -44,10 +44,10 @@ typedef UINT8 EFI_SWAP_LOCK_CAPABILITY;
boot block and backup block.
@param This Indicates the calling context.
@param BootBlockBase Base address of current boot block.
@param BootBlockSize Size (in bytes) of current boot block.
@param BackupBlockBase Base address of current backup block.
@param BackupBlockSize Size (in bytes) of current backup block.
@param BootBlockBase The base address of current boot block.
@param BootBlockSize The size (in bytes) of current boot block.
@param BackupBlockBase The base address of current backup block.
@param BackupBlockSize The size (in bytes) of current backup block.
@retval EFI_SUCCESS The call was successful.
@@ -89,7 +89,7 @@ EFI_STATUS
@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
@retval EFI_ABORTED Set swap state error.
**/
typedef
@@ -121,11 +121,12 @@ EFI_STATUS
);
/**
This service returns all lock methods for swap operations that the current platform supports. Could be software lock, hardware lock, or unsupport lock.
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.
@param LockCapability The current lock method for swap operations.
@retval EFI_SUCCESS The call was successful.
@@ -140,13 +141,13 @@ EFI_STATUS
/**
This service is used to acquire or release appointed kind of lock for Swap Address Range operation.
This service is used to acquire or release appointed kind of lock for Swap Address Range operations.
Note that software and hardware lock mothod can be used simultaneously.
@param This Indicates the calling context.
@param LockCapability Indicates which lock to acquire or release.
@param NewLockState True to acquire lock, False to release lock.
@param NewLockState True to acquire lock; False to release lock.
@retval EFI_SUCCESS The call was successful.