]> git.proxmox.com Git - mirror_edk2.git/commitdiff
MdePkg: Fix some typing errors in the header files
authorThomas Huth <thuth@redhat.com>
Mon, 12 Sep 2016 08:35:39 +0000 (01:35 -0700)
committerMichael Kinney <michael.d.kinney@intel.com>
Sat, 8 Oct 2016 01:09:09 +0000 (18:09 -0700)
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>
27 files changed:
MdePkg/Include/AArch64/ProcessorBind.h
MdePkg/Include/Arm/ProcessorBind.h
MdePkg/Include/Base.h
MdePkg/Include/Ia32/ProcessorBind.h
MdePkg/Include/Ipf/ProcessorBind.h
MdePkg/Include/Library/BaseLib.h
MdePkg/Include/Library/DebugPrintErrorLevelLib.h
MdePkg/Include/Library/FileHandleLib.h
MdePkg/Include/Library/PeCoffLib.h
MdePkg/Include/Pi/PiSmmCis.h
MdePkg/Include/Protocol/BlockIo2.h
MdePkg/Include/Protocol/BlockIoCrypto.h
MdePkg/Include/Protocol/Dns4.h
MdePkg/Include/Protocol/Dns6.h
MdePkg/Include/Protocol/FirmwareManagement.h
MdePkg/Include/Protocol/HiiImageDecoder.h
MdePkg/Include/Protocol/Mtftp4.h
MdePkg/Include/Protocol/Mtftp6.h
MdePkg/Include/Protocol/NvmExpressPassthru.h
MdePkg/Include/Protocol/SimpleTextOut.h
MdePkg/Include/Protocol/Timer.h
MdePkg/Include/Uefi/UefiPxe.h
MdePkg/Include/X64/ProcessorBind.h
MdePkg/Library/BaseMemoryLibMmx/MemLibInternals.h
MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLibInternals.h
MdePkg/Library/DxeIoLibCpuIo2/DxeCpuIo2LibInternal.h
MdePkg/Library/SmmIoLibSmmCpuIo2/SmmCpuIoLibInternal.h

index c5fe874b1bd016de2fc634bfaaaa2ca5a3d926a1..f100d96be079d0f4c9c2e0b1c289be3840b3e26d 100644 (file)
@@ -32,7 +32,7 @@
 \r
 #if _MSC_EXTENSIONS\r
   //\r
-  // use Microsoft* C complier dependent integer width types \r
+  // use Microsoft* C compiler dependent integer width types\r
   //\r
   typedef unsigned __int64    UINT64;\r
   typedef __int64             INT64;\r
index 5ee7465c05a346df182b8d0de0bcf6e93328e54d..a543687e57fdcf057f314cfda74c4dde56ad7e3b 100644 (file)
@@ -37,7 +37,7 @@
 \r
 #if _MSC_EXTENSIONS \r
   //\r
-  // use Microsoft* C complier dependent integer width types \r
+  // use Microsoft* C compiler dependent integer width types\r
   //\r
   typedef unsigned __int64    UINT64;\r
   typedef __int64             INT64;\r
index 93f6686b995ef0653fcdccd899d51f861bd78c34..c66614846488861ec71354df454e8d08d9fabca2 100644 (file)
@@ -302,7 +302,7 @@ struct _LIST_ENTRY {
 \r
 //\r
 //  UEFI specification claims 1 and 0. We are concerned about the\r
-//  complier portability so we did it this way.\r
+//  compiler portability so we did it this way.\r
 //\r
 \r
 ///\r
index 458f7dd21b93cd35ebb77a373b2c3b657eb624e9..086b1ff7b1b3e594453c8add5b50be2e3a95e055 100644 (file)
@@ -79,7 +79,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #pragma warning ( disable : 4057 )\r
 \r
 //\r
-// ASSERT(FALSE) or while (TRUE) are legal constructes so supress this warning\r
+// ASSERT(FALSE) or while (TRUE) are legal constructs so suppress this warning\r
 //\r
 #pragma warning ( disable : 4127 )\r
 \r
@@ -119,7 +119,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #if defined(_MSC_EXTENSIONS)\r
 \r
   //\r
-  // use Microsoft C complier dependent integer width types \r
+  // use Microsoft C compiler dependent integer width types\r
   //\r
 \r
   ///\r
index cead575262832794e6088050fbfdb083215395af..c19e47d8f3ca9d566f3c4fc63e99554e97ac6a50 100644 (file)
@@ -84,7 +84,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #pragma warning ( disable : 4054 )\r
 \r
 //\r
-// ASSERT(FALSE) or while (TRUE) are legal constructes so supress this warning\r
+// ASSERT(FALSE) or while (TRUE) are legal constructs so suppress this warning\r
 //\r
 #pragma warning ( disable : 4127 )\r
 \r
index 7e085b93a66942ad7f0eab0fa458cd1f2547c43c..6268e6fe46c72b35fd0d63e80bc01accb52e8887 100644 (file)
@@ -1772,7 +1772,7 @@ PathRemoveLastItem(
 \r
   @param[in] Path       The pointer to the string containing the path.\r
 \r
-  @return       Returns Path, otherwise returns NULL to indicate that an error has occured.\r
+  @return       Returns Path, otherwise returns NULL to indicate that an error has occurred.\r
 **/\r
 CHAR16*\r
 EFIAPI\r
index 2b051f421054a712bb3cf59221338452faff8473..5a866d5fcaf3f022ee059ee2388a43a779caa9bf 100644 (file)
@@ -31,7 +31,7 @@ GetDebugPrintErrorLevel (
   \r
   @param   ErrorLevel     Global debug print error level\r
   \r
-  @retval  TRUE           The debug print error level mask was sucessfully set.\r
+  @retval  TRUE           The debug print error level mask was successfully set.\r
   @retval  FALSE          The debug print error level mask could not be set.\r
 \r
 **/\r
index 00706f964dfd723d4d9a99157bc36e04476083d2..e94f83e3436662e0654d5fc6a758e47cf7e471b3 100644 (file)
@@ -184,9 +184,9 @@ FileHandleDelete (
   has the effect of starting the read process of the directory entries over again.\r
 \r
   @param[in] FileHandle         The file handle on which the position is being set.\r
-  @param[in] Position           The byte position from the begining of the file.\r
+  @param[in] Position           The byte position from the beginning of the file.\r
 \r
-  @retval EFI_SUCCESS           The operation completed sucessfully.\r
+  @retval EFI_SUCCESS           The operation completed successfully.\r
   @retval EFI_UNSUPPORTED       The request for non-zero is not valid on\r
                                 directories.\r
   @retval INVALID_PARAMETER     One of the parameters has an invalid value.\r
@@ -207,7 +207,7 @@ FileHandleSetPosition (
   if FileHandle is a directory.\r
 \r
   @param[in] FileHandle         The open file handle on which to get the position.\r
-  @param[out] Position          The byte position from begining of file.\r
+  @param[out] Position          The byte position from beginning of file.\r
 \r
   @retval EFI_SUCCESS           The operation completed successfully.\r
   @retval INVALID_PARAMETER     One of the parameters has an invalid value.\r
@@ -322,7 +322,7 @@ FileHandleFindNextFile(
   @param[in] FileHandle         The file handle from which size is retrieved.\r
   @param[out] Size              The pointer to size.\r
 \r
-  @retval EFI_SUCCESS           Operation was completed sucessfully.\r
+  @retval EFI_SUCCESS           Operation was completed successfully.\r
   @retval EFI_DEVICE_ERROR      Cannot access the file.\r
   @retval EFI_INVALID_PARAMETER FileHandle is NULL.\r
                                 Size is NULL.\r
index 9ed6d61be01c4b502fb5612a35aad2ddd0fe4b5e..5a3f98810af64cf5476ec9f8e97021bb725ca119 100644 (file)
@@ -337,7 +337,7 @@ PeCoffLoaderImageReadFromMemory (
 \r
 \r
 /**\r
-  Reapply fixups on a fixed up PE32/PE32+ image to allow virutal calling at EFI\r
+  Reapply fixups on a fixed up PE32/PE32+ image to allow virtual calling at EFI\r
   runtime. \r
   \r
   This function reapplies relocation fixups to the PE/COFF image specified by ImageBase \r
index 6d3ddabdf737c9dc9bf18cf1167418eeeb7125ab..6cb28b7fb2c9aee7e028b45bb03fa4c5dd81205c 100644 (file)
@@ -178,7 +178,7 @@ EFI_STATUS
 /**\r
   Registers a handler to execute within SMM.\r
 \r
-  @param[in]  Handler            Handler service funtion pointer.\r
+  @param[in]  Handler            Handler service function pointer.\r
   @param[in]  HandlerType        Points to the handler type or NULL for root SMI handlers.\r
   @param[out] DispatchHandle     On return, contains a unique handle which can be used to later\r
                                  unregister the handler function.\r
index 6f0c280089b0926f0ed6c4f316e4df44578cc276..5fad1078430c135c47b573001392b17ca6da91b0 100644 (file)
@@ -52,7 +52,7 @@ typedef struct {
 \r
   @param[in]  This                 Indicates a pointer to the calling context.\r
   @param[in]  ExtendedVerification Indicates that the driver may perform a more\r
-                                   exhausive verfication operation of the device\r
+                                   exhausive verification operation of the device\r
                                    during reset.\r
 \r
   @retval EFI_SUCCESS          The device was reset.\r
index 77931e7e4648e4dd4c68a967285f7386f75402f0..821b846d306706cd54a85858521feb6376e30144 100644 (file)
@@ -172,7 +172,7 @@ typedef struct {
 \r
   @param[in]  This                 Pointer to the EFI_BLOCK_IO_CRYPTO_PROTOCOL instance.\r
   @param[in]  ExtendedVerification Indicates that the driver may perform a more exhausive\r
-                                   verfication operation of the device during reset.\r
+                                   verification operation of the device during reset.\r
 \r
   @retval EFI_SUCCESS              The block device was reset.\r
   @retval EFI_DEVICE_ERROR         The block device is not functioning correctly and could\r
index 24892687bebf00c2e3015126fd4af60e141d857e..f96c50f9a7a66825494058f5b1714336e0374e1a 100644 (file)
@@ -310,7 +310,7 @@ EFI_STATUS
 \r
   @retval EFI_SUCCESS             The operation completed successfully.\r
   @retval EFI_UNSUPPORTED         The designated protocol is not supported.\r
-  @retval EFI_INVALID_PARAMTER    Thisis NULL.\r
+  @retval EFI_INVALID_PARAMETER   This is NULL.\r
                                   The StationIp address provided in DnsConfigData is not a \r
                                   valid unicast.\r
                                   DnsServerList is NULL while DnsServerListCount\r
index 1ea85bc5a87b6f92126e2cd5f0e0668e9058c515..813893addd6b060ca6ac9badfcede3b9dd1a1b8e 100644 (file)
@@ -300,7 +300,7 @@ EFI_STATUS
                                   storage to be allocated and released by caller.\r
 \r
   @retval EFI_SUCCESS             The operation completed successfully.\r
-  @retval EFI_INVALID_PARAMTER    This is NULL.\r
+  @retval EFI_INVALID_PARAMETER   This is NULL.\r
                                   The StationIp address provided in DnsConfigData is not zero and not a valid unicast.\r
                                   DnsServerList is NULL while DnsServerList Count is not ZERO.\r
                                   DnsServerList Count is ZERO while DnsServerList is not NULL.\r
index e615573a51bf09bd40f5389ab4353ed181e701c6..b199888fe1eb617812638ba69e11cf2c10b6081b 100644 (file)
@@ -241,7 +241,7 @@ typedef struct {
 #define  PACKAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED 0x0000000000000004\r
 \r
 /**\r
-  Callback funtion to report the process of the firmware updating.\r
+  Callback function to report the process of the firmware updating.\r
 \r
   @param[in]  Completion    A value between 1 and 100 indicating the current completion\r
                             progress of the firmware update. Completion progress is\r
index fd14592237abd099edd6de26fe3e83961c9d7159..48a1a976ed4fe6f1e1a8cf02b0da5a309847cda9 100644 (file)
@@ -142,7 +142,7 @@ EFI_STATUS
   @param This                    EFI_HII_IMAGE_DECODER_PROTOCOL instance.\r
   @param Image                   Pointer to the image raw data.\r
   @param SizeOfImage             Size of the entire image raw data.\r
-  @param ImageInfo               Pointer to recieve EFI_HII_IMAGE_DECODER_IMAGE_INFO_HEADER.\r
+  @param ImageInfo               Pointer to receive EFI_HII_IMAGE_DECODER_IMAGE_INFO_HEADER.\r
 \r
   @retval EFI_SUCCESS            Get image info success.\r
   @retval EFI_UNSUPPORTED        Unsupported format of image.\r
index 1afac6cff5286024fb8f2922eb3f2740f0c1eb17..ae2dc27b2f85a8f166e4ab6f34aba184a22f16f8 100644 (file)
@@ -1,5 +1,5 @@
 /** @file\r
-  EFI Multicast Trivial File Tranfer Protocol Definition\r
+  EFI Multicast Trivial File Transfer Protocol Definition\r
 \r
 Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
 This program and the accompanying materials are licensed and made available under \r
@@ -212,7 +212,7 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  Timeout callback funtion.\r
+  Timeout callback function.\r
 \r
   @param  This           The pointer to the EFI_MTFTP4_PROTOCOL instance.\r
   @param  Token          The token that is provided in the\r
index b39575d1751a7a55f6e72470f547b1a3f68a3c0d..4667addeec37537d82c80f76cc37541ae0e084b2 100644 (file)
@@ -1,5 +1,5 @@
 /** @file\r
-  UEFI Multicast Trivial File Tranfer Protocol v6 Definition, which is built upon\r
+  UEFI Multicast Trivial File Transfer Protocol v6 Definition, which is built upon\r
   the EFI UDPv6 Protocol and provides basic services for client-side unicast and/or\r
   multicast TFTP operations.\r
 \r
@@ -325,7 +325,7 @@ typedef struct {
   @param[in] PacketLen     Indicates the length of the packet.\r
   @param[in] Packet        Pointer to an MTFTPv6 packet.\r
 \r
-  @retval EFI_SUCCESS      Operation sucess.\r
+  @retval EFI_SUCCESS      Operation success.\r
   @retval Others           Aborts session.\r
 \r
 **/\r
@@ -352,7 +352,7 @@ EFI_STATUS
                            EFI_MTFTP6_PROTOCOL.WriteFile() or EFI_MTFTP6_PROTOCOL.ReadDirectory()\r
                            functions by the caller.\r
 \r
-  @retval EFI_SUCCESS      Operation sucess.\r
+  @retval EFI_SUCCESS      Operation success.\r
   @retval Others           Aborts session.\r
 \r
 **/\r
@@ -379,7 +379,7 @@ EFI_STATUS
                            length the data available on output.\r
   @param[out]     Buffer   Pointer to the buffer where the data is stored.\r
 \r
-  @retval EFI_SUCCESS      Operation sucess.\r
+  @retval EFI_SUCCESS      Operation success.\r
   @retval Others           Aborts session.\r
 \r
 **/\r
index ebd7a8b78a9551234215275c75dee2ad8cf52955..7a90c633ec7ea89012907bc187470bee1384168a 100644 (file)
@@ -115,7 +115,7 @@ typedef struct {
 } EFI_NVM_EXPRESS_PASS_THRU_COMMAND_PACKET;\r
 \r
 //\r
-// Protocol funtion prototypes\r
+// Protocol function prototypes\r
 //\r
 /**\r
   Sends an NVM Express Command Packet to an NVM Express controller or namespace. This function supports\r
index 5f64b64c2f7d55866a4c920d7fd468df29a86864..c1a23faada3d7d80f74721e20c4c68a8b96d5fb0 100644 (file)
@@ -160,7 +160,7 @@ typedef EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL   SIMPLE_TEXT_OUTPUT_INTERFACE;
   Reset the text output device hardware and optionaly run diagnostics\r
 \r
   @param  This                 The protocol instance pointer.\r
-  @param  ExtendedVerification Driver may perform more exhaustive verfication\r
+  @param  ExtendedVerification Driver may perform more exhaustive verification\r
                                operation of the device during reset.\r
 \r
   @retval EFI_SUCCESS          The text output device was reset.\r
index c9a998e105870f1ac00535ab81ea4d8f21e76138..ffdb0a1468f0c35da823de4d9823c0c0f740979c 100644 (file)
@@ -30,7 +30,7 @@ typedef struct _EFI_TIMER_ARCH_PROTOCOL   EFI_TIMER_ARCH_PROTOCOL;
 \r
 /**\r
   This function of this type is called when a timer interrupt fires.  This \r
-  function executes at TPL_HIGH_LEVEL.  The DXE Core will register a funtion\r
+  function executes at TPL_HIGH_LEVEL.  The DXE Core will register a function\r
   of this type to be called for the timer interrupt, so it can know how much \r
   time has passed.  This information is used to signal timer based events.  \r
 \r
index 0af9b90a6c9536416f4cf4a3d8ed231831232791..249a8c2d7aae840cd63ae50b1e07c4d17c09a3e2 100644 (file)
@@ -1079,7 +1079,7 @@ typedef struct s_pxe_cpb_start_31 {
 \r
   ///\r
   /// protocol driver can provide anything for this Unique_ID, UNDI remembers\r
-  /// that as just a 64bit value assocaited to the interface specified by\r
+  /// that as just a 64bit value associated to the interface specified by\r
   /// the ifnum and gives it back as a parameter to all the call-back routines\r
   /// when calling for that interface!\r
   ///\r
index ffcf2b034414b1a1b925623989eb4b3be1bf35cb..23e6e55abff67cd02df8f9e92db456ea04c16006 100644 (file)
@@ -93,7 +93,7 @@
 #pragma warning ( disable : 4057 )\r
 \r
 //\r
-// ASSERT(FALSE) or while (TRUE) are legal constructes so supress this warning\r
+// ASSERT(FALSE) or while (TRUE) are legal constructs so suppress this warning\r
 //\r
 #pragma warning ( disable : 4127 )\r
 \r
 \r
 #if defined(_MSC_EXTENSIONS)\r
   //\r
-  // use Microsoft C complier dependent integer width types \r
+  // use Microsoft C compiler dependent integer width types\r
   //\r
 \r
   ///\r
index cc8997963c212e965f4854a9f9171864e5036ca9..95052651d07a848b441462e782c6ddd130138438 100644 (file)
@@ -103,7 +103,7 @@ InternalMemSetMem32 (
 /**\r
   Fills a target buffer with a 64-bit value, and returns the target buffer.\r
 \r
-  @param  Buffer  Teh pointer to the target buffer to fill.\r
+  @param  Buffer  The pointer to the target buffer to fill.\r
   @param  Length  The count of 64-bit value to fill.\r
   @param  Value   The value with which to fill Length bytes of Buffer.\r
 \r
index 358c598c043916b4db577cb464456acf12f2cb91..aba510c963d29a9ea5d7f9dbc68cadefa507a3fe 100644 (file)
@@ -1,5 +1,5 @@
 /** @file\r
-  Internal data structure defintions for Base UEFI Decompress Libary.\r
+  Internal data structure defintions for Base UEFI Decompress Library.\r
 \r
   Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
   This program and the accompanying materials\r
index b459214e1b6d8a05f941f9d364064f4cad1e0c09..160bedfc3b4e4cb9b64cd72fd9e973cba6e83670 100644 (file)
@@ -58,7 +58,7 @@ IoReadWorker (
   @param  Width         The width of the I/O operation.\r
   @param  Data          The value to write to the I/O port.\r
 \r
-  @return The paramter of Data.\r
+  @return The parameter of Data.\r
 \r
 **/\r
 UINT64\r
index 0e94b20cac1002a95bd7065334ac3a86638650d9..ced6358c27ff4ec30037da2bf2f0860c8ef35cdc 100644 (file)
@@ -60,7 +60,7 @@ IoReadWorker (
   @param  Width         The width of the I/O operation.\r
   @param  Data          The value to write to the I/O port.\r
 \r
-  @return The paramter of Data.\r
+  @return The parameter of Data.\r
 \r
 **/\r
 UINT64\r