From: Thomas Huth <thuth@redhat.com>
Date: Mon, 12 Sep 2016 08:35:39 +0000 (-0700)
Subject: MdePkg: Fix some typing errors in the header files
X-Git-Tag: edk2-stable201903~5670
X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=commitdiff_plain;h=00b7cc0fe327fcd00d70a8d30f16245cca0c55f2

MdePkg: Fix some typing errors in the header files

Correct the typos in some header files of MdePkg.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Thomas Huth <thuth@redhat.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>
Reviewed-by: Michael Kinney <michael.d.kinney@intel.com>
---

diff --git a/MdePkg/Include/AArch64/ProcessorBind.h b/MdePkg/Include/AArch64/ProcessorBind.h
index c5fe874b1b..f100d96be0 100644
--- a/MdePkg/Include/AArch64/ProcessorBind.h
+++ b/MdePkg/Include/AArch64/ProcessorBind.h
@@ -32,7 +32,7 @@
 
 #if _MSC_EXTENSIONS
   //
-  // use Microsoft* C complier dependent integer width types 
+  // use Microsoft* C compiler dependent integer width types
   //
   typedef unsigned __int64    UINT64;
   typedef __int64             INT64;
diff --git a/MdePkg/Include/Arm/ProcessorBind.h b/MdePkg/Include/Arm/ProcessorBind.h
index 5ee7465c05..a543687e57 100644
--- a/MdePkg/Include/Arm/ProcessorBind.h
+++ b/MdePkg/Include/Arm/ProcessorBind.h
@@ -37,7 +37,7 @@
 
 #if _MSC_EXTENSIONS 
   //
-  // use Microsoft* C complier dependent integer width types 
+  // use Microsoft* C compiler dependent integer width types
   //
   typedef unsigned __int64    UINT64;
   typedef __int64             INT64;
diff --git a/MdePkg/Include/Base.h b/MdePkg/Include/Base.h
index 93f6686b99..c666148464 100644
--- a/MdePkg/Include/Base.h
+++ b/MdePkg/Include/Base.h
@@ -302,7 +302,7 @@ struct _LIST_ENTRY {
 
 //
 //  UEFI specification claims 1 and 0. We are concerned about the
-//  complier portability so we did it this way.
+//  compiler portability so we did it this way.
 //
 
 ///
diff --git a/MdePkg/Include/Ia32/ProcessorBind.h b/MdePkg/Include/Ia32/ProcessorBind.h
index 458f7dd21b..086b1ff7b1 100644
--- a/MdePkg/Include/Ia32/ProcessorBind.h
+++ b/MdePkg/Include/Ia32/ProcessorBind.h
@@ -79,7 +79,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #pragma warning ( disable : 4057 )
 
 //
-// ASSERT(FALSE) or while (TRUE) are legal constructes so supress this warning
+// ASSERT(FALSE) or while (TRUE) are legal constructs so suppress this warning
 //
 #pragma warning ( disable : 4127 )
 
@@ -119,7 +119,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #if defined(_MSC_EXTENSIONS)
 
   //
-  // use Microsoft C complier dependent integer width types 
+  // use Microsoft C compiler dependent integer width types
   //
 
   ///
diff --git a/MdePkg/Include/Ipf/ProcessorBind.h b/MdePkg/Include/Ipf/ProcessorBind.h
index cead575262..c19e47d8f3 100644
--- a/MdePkg/Include/Ipf/ProcessorBind.h
+++ b/MdePkg/Include/Ipf/ProcessorBind.h
@@ -84,7 +84,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #pragma warning ( disable : 4054 )
 
 //
-// ASSERT(FALSE) or while (TRUE) are legal constructes so supress this warning
+// ASSERT(FALSE) or while (TRUE) are legal constructs so suppress this warning
 //
 #pragma warning ( disable : 4127 )
 
diff --git a/MdePkg/Include/Library/BaseLib.h b/MdePkg/Include/Library/BaseLib.h
index 7e085b93a6..6268e6fe46 100644
--- a/MdePkg/Include/Library/BaseLib.h
+++ b/MdePkg/Include/Library/BaseLib.h
@@ -1772,7 +1772,7 @@ PathRemoveLastItem(
 
   @param[in] Path       The pointer to the string containing the path.
 
-  @return       Returns Path, otherwise returns NULL to indicate that an error has occured.
+  @return       Returns Path, otherwise returns NULL to indicate that an error has occurred.
 **/
 CHAR16*
 EFIAPI
diff --git a/MdePkg/Include/Library/DebugPrintErrorLevelLib.h b/MdePkg/Include/Library/DebugPrintErrorLevelLib.h
index 2b051f4210..5a866d5fca 100644
--- a/MdePkg/Include/Library/DebugPrintErrorLevelLib.h
+++ b/MdePkg/Include/Library/DebugPrintErrorLevelLib.h
@@ -31,7 +31,7 @@ GetDebugPrintErrorLevel (
   
   @param   ErrorLevel     Global debug print error level
   
-  @retval  TRUE           The debug print error level mask was sucessfully set.
+  @retval  TRUE           The debug print error level mask was successfully set.
   @retval  FALSE          The debug print error level mask could not be set.
 
 **/
diff --git a/MdePkg/Include/Library/FileHandleLib.h b/MdePkg/Include/Library/FileHandleLib.h
index 00706f964d..e94f83e343 100644
--- a/MdePkg/Include/Library/FileHandleLib.h
+++ b/MdePkg/Include/Library/FileHandleLib.h
@@ -184,9 +184,9 @@ FileHandleDelete (
   has the effect of starting the read process of the directory entries over again.
 
   @param[in] FileHandle         The file handle on which the position is being set.
-  @param[in] Position           The byte position from the begining of the file.
+  @param[in] Position           The byte position from the beginning of the file.
 
-  @retval EFI_SUCCESS           The operation completed sucessfully.
+  @retval EFI_SUCCESS           The operation completed successfully.
   @retval EFI_UNSUPPORTED       The request for non-zero is not valid on
                                 directories.
   @retval INVALID_PARAMETER     One of the parameters has an invalid value.
@@ -207,7 +207,7 @@ FileHandleSetPosition (
   if FileHandle is a directory.
 
   @param[in] FileHandle         The open file handle on which to get the position.
-  @param[out] Position          The byte position from begining of file.
+  @param[out] Position          The byte position from beginning of file.
 
   @retval EFI_SUCCESS           The operation completed successfully.
   @retval INVALID_PARAMETER     One of the parameters has an invalid value.
@@ -322,7 +322,7 @@ FileHandleFindNextFile(
   @param[in] FileHandle         The file handle from which size is retrieved.
   @param[out] Size              The pointer to size.
 
-  @retval EFI_SUCCESS           Operation was completed sucessfully.
+  @retval EFI_SUCCESS           Operation was completed successfully.
   @retval EFI_DEVICE_ERROR      Cannot access the file.
   @retval EFI_INVALID_PARAMETER FileHandle is NULL.
                                 Size is NULL.
diff --git a/MdePkg/Include/Library/PeCoffLib.h b/MdePkg/Include/Library/PeCoffLib.h
index 9ed6d61be0..5a3f98810a 100644
--- a/MdePkg/Include/Library/PeCoffLib.h
+++ b/MdePkg/Include/Library/PeCoffLib.h
@@ -337,7 +337,7 @@ PeCoffLoaderImageReadFromMemory (
 
 
 /**
-  Reapply fixups on a fixed up PE32/PE32+ image to allow virutal calling at EFI
+  Reapply fixups on a fixed up PE32/PE32+ image to allow virtual calling at EFI
   runtime. 
   
   This function reapplies relocation fixups to the PE/COFF image specified by ImageBase 
diff --git a/MdePkg/Include/Pi/PiSmmCis.h b/MdePkg/Include/Pi/PiSmmCis.h
index 6d3ddabdf7..6cb28b7fb2 100644
--- a/MdePkg/Include/Pi/PiSmmCis.h
+++ b/MdePkg/Include/Pi/PiSmmCis.h
@@ -178,7 +178,7 @@ EFI_STATUS
 /**
   Registers a handler to execute within SMM.
 
-  @param[in]  Handler            Handler service funtion pointer.
+  @param[in]  Handler            Handler service function pointer.
   @param[in]  HandlerType        Points to the handler type or NULL for root SMI handlers.
   @param[out] DispatchHandle     On return, contains a unique handle which can be used to later
                                  unregister the handler function.
diff --git a/MdePkg/Include/Protocol/BlockIo2.h b/MdePkg/Include/Protocol/BlockIo2.h
index 6f0c280089..5fad107843 100644
--- a/MdePkg/Include/Protocol/BlockIo2.h
+++ b/MdePkg/Include/Protocol/BlockIo2.h
@@ -52,7 +52,7 @@ typedef struct {
 
   @param[in]  This                 Indicates a pointer to the calling context.
   @param[in]  ExtendedVerification Indicates that the driver may perform a more
-                                   exhausive verfication operation of the device
+                                   exhausive verification operation of the device
                                    during reset.
 
   @retval EFI_SUCCESS          The device was reset.
diff --git a/MdePkg/Include/Protocol/BlockIoCrypto.h b/MdePkg/Include/Protocol/BlockIoCrypto.h
index 77931e7e46..821b846d30 100644
--- a/MdePkg/Include/Protocol/BlockIoCrypto.h
+++ b/MdePkg/Include/Protocol/BlockIoCrypto.h
@@ -172,7 +172,7 @@ typedef struct {
 
   @param[in]  This                 Pointer to the EFI_BLOCK_IO_CRYPTO_PROTOCOL instance.
   @param[in]  ExtendedVerification Indicates that the driver may perform a more exhausive
-                                   verfication operation of the device during reset.
+                                   verification operation of the device during reset.
 
   @retval EFI_SUCCESS              The block device was reset.
   @retval EFI_DEVICE_ERROR         The block device is not functioning correctly and could
diff --git a/MdePkg/Include/Protocol/Dns4.h b/MdePkg/Include/Protocol/Dns4.h
index 24892687be..f96c50f9a7 100644
--- a/MdePkg/Include/Protocol/Dns4.h
+++ b/MdePkg/Include/Protocol/Dns4.h
@@ -310,7 +310,7 @@ EFI_STATUS
 
   @retval EFI_SUCCESS             The operation completed successfully.
   @retval EFI_UNSUPPORTED         The designated protocol is not supported.
-  @retval EFI_INVALID_PARAMTER    Thisis NULL.
+  @retval EFI_INVALID_PARAMETER   This is NULL.
                                   The StationIp address provided in DnsConfigData is not a 
                                   valid unicast.
                                   DnsServerList is NULL while DnsServerListCount
diff --git a/MdePkg/Include/Protocol/Dns6.h b/MdePkg/Include/Protocol/Dns6.h
index 1ea85bc5a8..813893addd 100644
--- a/MdePkg/Include/Protocol/Dns6.h
+++ b/MdePkg/Include/Protocol/Dns6.h
@@ -300,7 +300,7 @@ EFI_STATUS
                                   storage to be allocated and released by caller.
 
   @retval EFI_SUCCESS             The operation completed successfully.
-  @retval EFI_INVALID_PARAMTER    This is NULL.
+  @retval EFI_INVALID_PARAMETER   This is NULL.
                                   The StationIp address provided in DnsConfigData is not zero and not a valid unicast.
                                   DnsServerList is NULL while DnsServerList Count is not ZERO.
                                   DnsServerList Count is ZERO while DnsServerList is not NULL.
diff --git a/MdePkg/Include/Protocol/FirmwareManagement.h b/MdePkg/Include/Protocol/FirmwareManagement.h
index e615573a51..b199888fe1 100644
--- a/MdePkg/Include/Protocol/FirmwareManagement.h
+++ b/MdePkg/Include/Protocol/FirmwareManagement.h
@@ -241,7 +241,7 @@ typedef struct {
 #define  PACKAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED 0x0000000000000004
 
 /**
-  Callback funtion to report the process of the firmware updating.
+  Callback function to report the process of the firmware updating.
 
   @param[in]  Completion    A value between 1 and 100 indicating the current completion
                             progress of the firmware update. Completion progress is
diff --git a/MdePkg/Include/Protocol/HiiImageDecoder.h b/MdePkg/Include/Protocol/HiiImageDecoder.h
index fd14592237..48a1a976ed 100644
--- a/MdePkg/Include/Protocol/HiiImageDecoder.h
+++ b/MdePkg/Include/Protocol/HiiImageDecoder.h
@@ -142,7 +142,7 @@ EFI_STATUS
   @param This                    EFI_HII_IMAGE_DECODER_PROTOCOL instance.
   @param Image                   Pointer to the image raw data.
   @param SizeOfImage             Size of the entire image raw data.
-  @param ImageInfo               Pointer to recieve EFI_HII_IMAGE_DECODER_IMAGE_INFO_HEADER.
+  @param ImageInfo               Pointer to receive EFI_HII_IMAGE_DECODER_IMAGE_INFO_HEADER.
 
   @retval EFI_SUCCESS            Get image info success.
   @retval EFI_UNSUPPORTED        Unsupported format of image.
diff --git a/MdePkg/Include/Protocol/Mtftp4.h b/MdePkg/Include/Protocol/Mtftp4.h
index 1afac6cff5..ae2dc27b2f 100644
--- a/MdePkg/Include/Protocol/Mtftp4.h
+++ b/MdePkg/Include/Protocol/Mtftp4.h
@@ -1,5 +1,5 @@
 /** @file
-  EFI Multicast Trivial File Tranfer Protocol Definition
+  EFI Multicast Trivial File Transfer Protocol Definition
 
 Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
 This program and the accompanying materials are licensed and made available under 
@@ -212,7 +212,7 @@ EFI_STATUS
   );
 
 /**
-  Timeout callback funtion.
+  Timeout callback function.
 
   @param  This           The pointer to the EFI_MTFTP4_PROTOCOL instance.
   @param  Token          The token that is provided in the
diff --git a/MdePkg/Include/Protocol/Mtftp6.h b/MdePkg/Include/Protocol/Mtftp6.h
index b39575d175..4667addeec 100644
--- a/MdePkg/Include/Protocol/Mtftp6.h
+++ b/MdePkg/Include/Protocol/Mtftp6.h
@@ -1,5 +1,5 @@
 /** @file
-  UEFI Multicast Trivial File Tranfer Protocol v6 Definition, which is built upon
+  UEFI Multicast Trivial File Transfer Protocol v6 Definition, which is built upon
   the EFI UDPv6 Protocol and provides basic services for client-side unicast and/or
   multicast TFTP operations.
 
@@ -325,7 +325,7 @@ typedef struct {
   @param[in] PacketLen     Indicates the length of the packet.
   @param[in] Packet        Pointer to an MTFTPv6 packet.
 
-  @retval EFI_SUCCESS      Operation sucess.
+  @retval EFI_SUCCESS      Operation success.
   @retval Others           Aborts session.
 
 **/
@@ -352,7 +352,7 @@ EFI_STATUS
                            EFI_MTFTP6_PROTOCOL.WriteFile() or EFI_MTFTP6_PROTOCOL.ReadDirectory()
                            functions by the caller.
 
-  @retval EFI_SUCCESS      Operation sucess.
+  @retval EFI_SUCCESS      Operation success.
   @retval Others           Aborts session.
 
 **/
@@ -379,7 +379,7 @@ EFI_STATUS
                            length the data available on output.
   @param[out]     Buffer   Pointer to the buffer where the data is stored.
 
-  @retval EFI_SUCCESS      Operation sucess.
+  @retval EFI_SUCCESS      Operation success.
   @retval Others           Aborts session.
 
 **/
diff --git a/MdePkg/Include/Protocol/NvmExpressPassthru.h b/MdePkg/Include/Protocol/NvmExpressPassthru.h
index ebd7a8b78a..7a90c633ec 100644
--- a/MdePkg/Include/Protocol/NvmExpressPassthru.h
+++ b/MdePkg/Include/Protocol/NvmExpressPassthru.h
@@ -115,7 +115,7 @@ typedef struct {
 } EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET;
 
 //
-// Protocol funtion prototypes
+// Protocol function prototypes
 //
 /**
   Sends an NVM Express Command Packet to an NVM Express controller or namespace. This function supports
diff --git a/MdePkg/Include/Protocol/SimpleTextOut.h b/MdePkg/Include/Protocol/SimpleTextOut.h
index 5f64b64c2f..c1a23faada 100644
--- a/MdePkg/Include/Protocol/SimpleTextOut.h
+++ b/MdePkg/Include/Protocol/SimpleTextOut.h
@@ -160,7 +160,7 @@ typedef EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL   SIMPLE_TEXT_OUTPUT_INTERFACE;
   Reset the text output device hardware and optionaly run diagnostics
 
   @param  This                 The protocol instance pointer.
-  @param  ExtendedVerification Driver may perform more exhaustive verfication
+  @param  ExtendedVerification Driver may perform more exhaustive verification
                                operation of the device during reset.
 
   @retval EFI_SUCCESS          The text output device was reset.
diff --git a/MdePkg/Include/Protocol/Timer.h b/MdePkg/Include/Protocol/Timer.h
index c9a998e105..ffdb0a1468 100644
--- a/MdePkg/Include/Protocol/Timer.h
+++ b/MdePkg/Include/Protocol/Timer.h
@@ -30,7 +30,7 @@ typedef struct _EFI_TIMER_ARCH_PROTOCOL   EFI_TIMER_ARCH_PROTOCOL;
 
 /**
   This function of this type is called when a timer interrupt fires.  This 
-  function executes at TPL_HIGH_LEVEL.  The DXE Core will register a funtion
+  function executes at TPL_HIGH_LEVEL.  The DXE Core will register a function
   of this type to be called for the timer interrupt, so it can know how much 
   time has passed.  This information is used to signal timer based events.  
 
diff --git a/MdePkg/Include/Uefi/UefiPxe.h b/MdePkg/Include/Uefi/UefiPxe.h
index 0af9b90a6c..249a8c2d7a 100644
--- a/MdePkg/Include/Uefi/UefiPxe.h
+++ b/MdePkg/Include/Uefi/UefiPxe.h
@@ -1079,7 +1079,7 @@ typedef struct s_pxe_cpb_start_31 {
 
   ///
   /// protocol driver can provide anything for this Unique_ID, UNDI remembers
-  /// that as just a 64bit value assocaited to the interface specified by
+  /// that as just a 64bit value associated to the interface specified by
   /// the ifnum and gives it back as a parameter to all the call-back routines
   /// when calling for that interface!
   ///
diff --git a/MdePkg/Include/X64/ProcessorBind.h b/MdePkg/Include/X64/ProcessorBind.h
index ffcf2b0344..23e6e55abf 100644
--- a/MdePkg/Include/X64/ProcessorBind.h
+++ b/MdePkg/Include/X64/ProcessorBind.h
@@ -93,7 +93,7 @@
 #pragma warning ( disable : 4057 )
 
 //
-// ASSERT(FALSE) or while (TRUE) are legal constructes so supress this warning
+// ASSERT(FALSE) or while (TRUE) are legal constructs so suppress this warning
 //
 #pragma warning ( disable : 4127 )
 
@@ -132,7 +132,7 @@
 
 #if defined(_MSC_EXTENSIONS)
   //
-  // use Microsoft C complier dependent integer width types 
+  // use Microsoft C compiler dependent integer width types
   //
 
   ///
diff --git a/MdePkg/Library/BaseMemoryLibMmx/MemLibInternals.h b/MdePkg/Library/BaseMemoryLibMmx/MemLibInternals.h
index cc8997963c..95052651d0 100644
--- a/MdePkg/Library/BaseMemoryLibMmx/MemLibInternals.h
+++ b/MdePkg/Library/BaseMemoryLibMmx/MemLibInternals.h
@@ -103,7 +103,7 @@ InternalMemSetMem32 (
 /**
   Fills a target buffer with a 64-bit value, and returns the target buffer.
 
-  @param  Buffer  Teh pointer to the target buffer to fill.
+  @param  Buffer  The pointer to the target buffer to fill.
   @param  Length  The count of 64-bit value to fill.
   @param  Value   The value with which to fill Length bytes of Buffer.
 
diff --git a/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLibInternals.h b/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLibInternals.h
index 358c598c04..aba510c963 100644
--- a/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLibInternals.h
+++ b/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLibInternals.h
@@ -1,5 +1,5 @@
 /** @file
-  Internal data structure defintions for Base UEFI Decompress Libary.
+  Internal data structure defintions for Base UEFI Decompress Library.
 
   Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
   This program and the accompanying materials
diff --git a/MdePkg/Library/DxeIoLibCpuIo2/DxeCpuIo2LibInternal.h b/MdePkg/Library/DxeIoLibCpuIo2/DxeCpuIo2LibInternal.h
index b459214e1b..160bedfc3b 100644
--- a/MdePkg/Library/DxeIoLibCpuIo2/DxeCpuIo2LibInternal.h
+++ b/MdePkg/Library/DxeIoLibCpuIo2/DxeCpuIo2LibInternal.h
@@ -58,7 +58,7 @@ IoReadWorker (
   @param  Width         The width of the I/O operation.
   @param  Data          The value to write to the I/O port.
 
-  @return The paramter of Data.
+  @return The parameter of Data.
 
 **/
 UINT64
diff --git a/MdePkg/Library/SmmIoLibSmmCpuIo2/SmmCpuIoLibInternal.h b/MdePkg/Library/SmmIoLibSmmCpuIo2/SmmCpuIoLibInternal.h
index 0e94b20cac..ced6358c27 100644
--- a/MdePkg/Library/SmmIoLibSmmCpuIo2/SmmCpuIoLibInternal.h
+++ b/MdePkg/Library/SmmIoLibSmmCpuIo2/SmmCpuIoLibInternal.h
@@ -60,7 +60,7 @@ IoReadWorker (
   @param  Width         The width of the I/O operation.
   @param  Data          The value to write to the I/O port.
 
-  @return The paramter of Data.
+  @return The parameter of Data.
 
 **/
 UINT64