[edk2-devel] [PATCH v2 78/78] UefiCpuPkg/Smm: Fix various typos

Philippe Mathieu-Daudé posted 78 patches 6 years, 1 month ago
There is a newer version of this series
[edk2-devel] [PATCH v2 78/78] UefiCpuPkg/Smm: Fix various typos
Posted by Philippe Mathieu-Daudé 6 years, 1 month ago
From: Antoine Coeur <coeur@gmx.fr>

Fix various typos in comments and documentation.

Cc: Eric Dong <eric.dong@intel.com>
Cc: Ray Ni <ray.ni@intel.com>
Cc: Laszlo Ersek <lersek@redhat.com>
Signed-off-by: Antoine Coeur <coeur@gmx.fr>
Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com>
Reviewed-by: Laszlo Ersek <lersek@redhat.com>
Reviewed-by: Eric Dong <eric.dong@intel.com>
Signed-off-by: Philippe Mathieu-Daude <philmd@redhat.com>
---
 UefiCpuPkg/Include/Library/SmmCpuFeaturesLib.h                | 4 ++--
 UefiCpuPkg/Library/SmmCpuFeaturesLib/SmmStm.h                 | 4 ++--
 .../Library/CpuExceptionHandlerLib/PeiDxeSmmCpuException.c    | 4 ++--
 UefiCpuPkg/Library/CpuExceptionHandlerLib/SmmException.c      | 2 +-
 UefiCpuPkg/Library/SmmCpuFeaturesLib/SmmCpuFeaturesLib.c      | 4 ++--
 UefiCpuPkg/Library/SmmCpuFeaturesLib/SmmStm.c                 | 4 ++--
 UefiCpuPkg/Library/SmmCpuFeaturesLib/X64/SmiEntry.nasm        | 2 +-
 7 files changed, 12 insertions(+), 12 deletions(-)

diff --git a/UefiCpuPkg/Include/Library/SmmCpuFeaturesLib.h b/UefiCpuPkg/Include/Library/SmmCpuFeaturesLib.h
index 39ca304b31e6..dbcd57e0ad42 100644
--- a/UefiCpuPkg/Include/Library/SmmCpuFeaturesLib.h
+++ b/UefiCpuPkg/Include/Library/SmmCpuFeaturesLib.h
@@ -338,7 +338,7 @@ SmmCpuFeaturesSetSmmRegister (
                         from the save state.
 
   @retval EFI_SUCCESS           The register was read from Save State.
-  @retval EFI_INVALID_PARAMTER  Buffer is NULL.
+  @retval EFI_INVALID_PARAMETER  Buffer is NULL.
   @retval EFI_UNSUPPORTED       This function does not support reading Register.
 
 **/
@@ -364,7 +364,7 @@ SmmCpuFeaturesReadSaveStateRegister (
   @param[in] Buffer    Upon entry, this holds the new CPU register value.
 
   @retval EFI_SUCCESS           The register was written to Save State.
-  @retval EFI_INVALID_PARAMTER  Buffer is NULL.
+  @retval EFI_INVALID_PARAMETER  Buffer is NULL.
   @retval EFI_UNSUPPORTED       This function does not support writing Register.
 **/
 EFI_STATUS
diff --git a/UefiCpuPkg/Library/SmmCpuFeaturesLib/SmmStm.h b/UefiCpuPkg/Library/SmmCpuFeaturesLib/SmmStm.h
index 018e918360d3..da551cc4a6a6 100644
--- a/UefiCpuPkg/Library/SmmCpuFeaturesLib/SmmStm.h
+++ b/UefiCpuPkg/Library/SmmCpuFeaturesLib/SmmStm.h
@@ -138,7 +138,7 @@ GetPiResource (
   );
 
 /**
-  This functin initialize STM configuration table.
+  This function initialize STM configuration table.
 **/
 VOID
 StmSmmConfigurationTableInit (
@@ -169,7 +169,7 @@ GetStmResource (
 
 /**
   This function fixes up the address of the global variable or function
-  referred in SmiEntry assembly files to be the absoute address.
+  referred in SmiEntry assembly files to be the absolute address.
 **/
 VOID
 EFIAPI
diff --git a/UefiCpuPkg/Library/CpuExceptionHandlerLib/PeiDxeSmmCpuException.c b/UefiCpuPkg/Library/CpuExceptionHandlerLib/PeiDxeSmmCpuException.c
index 72c2aeca4c13..6a2670d55918 100644
--- a/UefiCpuPkg/Library/CpuExceptionHandlerLib/PeiDxeSmmCpuException.c
+++ b/UefiCpuPkg/Library/CpuExceptionHandlerLib/PeiDxeSmmCpuException.c
@@ -68,7 +68,7 @@ CommonExceptionHandlerWorker (
         //
         ArchRestoreExceptionContext (ExceptionType, SystemContext, ExceptionHandlerData);
         //
-        // Rlease spin lock for ApicId
+        // Release spin lock for ApicId
         //
         ReleaseSpinLock (&ReservedVectors[ExceptionType].SpinLock);
         break;
@@ -230,7 +230,7 @@ InitializeCpuExceptionHandlersWorker (
   IdtEntryCount = (IdtDescriptor.Limit + 1) / sizeof (IA32_IDT_GATE_DESCRIPTOR);
   if (IdtEntryCount > CPU_EXCEPTION_NUM) {
     //
-    // CPU exeption library only setup CPU_EXCEPTION_NUM exception handler at most
+    // CPU exception library only setup CPU_EXCEPTION_NUM exception handler at most
     //
     IdtEntryCount = CPU_EXCEPTION_NUM;
   }
diff --git a/UefiCpuPkg/Library/CpuExceptionHandlerLib/SmmException.c b/UefiCpuPkg/Library/CpuExceptionHandlerLib/SmmException.c
index ec705fc489af..e7977d49b771 100644
--- a/UefiCpuPkg/Library/CpuExceptionHandlerLib/SmmException.c
+++ b/UefiCpuPkg/Library/CpuExceptionHandlerLib/SmmException.c
@@ -1,5 +1,5 @@
 /** @file
-  CPU exception handler library implemenation for SMM modules.
+  CPU exception handler library implementation for SMM modules.
 
   Copyright (c) 2013 - 2017, Intel Corporation. All rights reserved.<BR>
   SPDX-License-Identifier: BSD-2-Clause-Patent
diff --git a/UefiCpuPkg/Library/SmmCpuFeaturesLib/SmmCpuFeaturesLib.c b/UefiCpuPkg/Library/SmmCpuFeaturesLib/SmmCpuFeaturesLib.c
index bddb7a219ce4..a00786a8ebef 100644
--- a/UefiCpuPkg/Library/SmmCpuFeaturesLib/SmmCpuFeaturesLib.c
+++ b/UefiCpuPkg/Library/SmmCpuFeaturesLib/SmmCpuFeaturesLib.c
@@ -540,7 +540,7 @@ SmmCpuFeaturesSetSmmRegister (
                         from the save state.
 
   @retval EFI_SUCCESS           The register was read from Save State.
-  @retval EFI_INVALID_PARAMTER  Buffer is NULL.
+  @retval EFI_INVALID_PARAMETER  Buffer is NULL.
   @retval EFI_UNSUPPORTED       This function does not support reading Register.
 
 **/
@@ -569,7 +569,7 @@ SmmCpuFeaturesReadSaveStateRegister (
   @param[in] Buffer    Upon entry, this holds the new CPU register value.
 
   @retval EFI_SUCCESS           The register was written to Save State.
-  @retval EFI_INVALID_PARAMTER  Buffer is NULL.
+  @retval EFI_INVALID_PARAMETER  Buffer is NULL.
   @retval EFI_UNSUPPORTED       This function does not support writing Register.
 **/
 EFI_STATUS
diff --git a/UefiCpuPkg/Library/SmmCpuFeaturesLib/SmmStm.c b/UefiCpuPkg/Library/SmmCpuFeaturesLib/SmmStm.c
index 52a376c27db1..f7f8afacffb5 100644
--- a/UefiCpuPkg/Library/SmmCpuFeaturesLib/SmmStm.c
+++ b/UefiCpuPkg/Library/SmmCpuFeaturesLib/SmmStm.c
@@ -913,7 +913,7 @@ AddPiResource (
     }
 
     //
-    // Copy EndResource for intialization
+    // Copy EndResource for initialization
     //
     mStmResourcesPtr = (UINT8 *)(UINTN)NewResource;
     mStmResourceTotalSize = NewResourceSize;
@@ -1236,7 +1236,7 @@ LoadMonitor (
 /**
   This function return BIOS STM resource.
   Produced by SmmStm.
-  Comsumed by SmmMpService when Init.
+  Consumed by SmmMpService when Init.
 
   @return BIOS STM resource
 
diff --git a/UefiCpuPkg/Library/SmmCpuFeaturesLib/X64/SmiEntry.nasm b/UefiCpuPkg/Library/SmmCpuFeaturesLib/X64/SmiEntry.nasm
index 5ee846e4f9ea..f09d8df1e6bc 100644
--- a/UefiCpuPkg/Library/SmmCpuFeaturesLib/X64/SmiEntry.nasm
+++ b/UefiCpuPkg/Library/SmmCpuFeaturesLib/X64/SmiEntry.nasm
@@ -15,7 +15,7 @@
 %include "StuffRsbNasm.inc"
 
 ;
-; Variables referrenced by C code
+; Variables referenced by C code
 ;
 
 %define MSR_IA32_MISC_ENABLE 0x1A0
-- 
2.21.0


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#52818): https://edk2.groups.io/g/devel/message/52818
Mute This Topic: https://groups.io/mt/69396198/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-

Re: [edk2-devel] [PATCH v2 78/78] UefiCpuPkg/Smm: Fix various typos
Posted by Dong, Eric 6 years, 1 month ago
Reviewed-by: Eric Dong <eric.dong@intel.com>

> -----Original Message-----
> From: Philippe Mathieu-Daude [mailto:philmd@redhat.com]
> Sent: Friday, January 3, 2020 5:08 PM
> To: devel@edk2.groups.io
> Cc: Antoine Coeur <coeur@gmx.fr>; Dong, Eric <eric.dong@intel.com>; Ni,
> Ray <ray.ni@intel.com>; Laszlo Ersek <lersek@redhat.com>; Philippe
> Mathieu-Daude <philmd@redhat.com>
> Subject: [PATCH v2 78/78] UefiCpuPkg/Smm: Fix various typos
> 
> From: Antoine Coeur <coeur@gmx.fr>
> 
> Fix various typos in comments and documentation.
> 
> Cc: Eric Dong <eric.dong@intel.com>
> Cc: Ray Ni <ray.ni@intel.com>
> Cc: Laszlo Ersek <lersek@redhat.com>
> Signed-off-by: Antoine Coeur <coeur@gmx.fr>
> Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com>
> Reviewed-by: Laszlo Ersek <lersek@redhat.com>
> Reviewed-by: Eric Dong <eric.dong@intel.com>
> Signed-off-by: Philippe Mathieu-Daude <philmd@redhat.com>
> ---
>  UefiCpuPkg/Include/Library/SmmCpuFeaturesLib.h                | 4 ++--
>  UefiCpuPkg/Library/SmmCpuFeaturesLib/SmmStm.h                 | 4 ++--
>  .../Library/CpuExceptionHandlerLib/PeiDxeSmmCpuException.c    | 4 ++--
>  UefiCpuPkg/Library/CpuExceptionHandlerLib/SmmException.c      | 2 +-
>  UefiCpuPkg/Library/SmmCpuFeaturesLib/SmmCpuFeaturesLib.c      | 4 ++--
>  UefiCpuPkg/Library/SmmCpuFeaturesLib/SmmStm.c                 | 4 ++--
>  UefiCpuPkg/Library/SmmCpuFeaturesLib/X64/SmiEntry.nasm        | 2 +-
>  7 files changed, 12 insertions(+), 12 deletions(-)
> 
> diff --git a/UefiCpuPkg/Include/Library/SmmCpuFeaturesLib.h
> b/UefiCpuPkg/Include/Library/SmmCpuFeaturesLib.h
> index 39ca304b31e6..dbcd57e0ad42 100644
> --- a/UefiCpuPkg/Include/Library/SmmCpuFeaturesLib.h
> +++ b/UefiCpuPkg/Include/Library/SmmCpuFeaturesLib.h
> @@ -338,7 +338,7 @@ SmmCpuFeaturesSetSmmRegister (
>                          from the save state.
> 
>    @retval EFI_SUCCESS           The register was read from Save State.
> -  @retval EFI_INVALID_PARAMTER  Buffer is NULL.
> +  @retval EFI_INVALID_PARAMETER  Buffer is NULL.
>    @retval EFI_UNSUPPORTED       This function does not support reading
> Register.
> 
>  **/
> @@ -364,7 +364,7 @@ SmmCpuFeaturesReadSaveStateRegister (
>    @param[in] Buffer    Upon entry, this holds the new CPU register value.
> 
>    @retval EFI_SUCCESS           The register was written to Save State.
> -  @retval EFI_INVALID_PARAMTER  Buffer is NULL.
> +  @retval EFI_INVALID_PARAMETER  Buffer is NULL.
>    @retval EFI_UNSUPPORTED       This function does not support writing
> Register.
>  **/
>  EFI_STATUS
> diff --git a/UefiCpuPkg/Library/SmmCpuFeaturesLib/SmmStm.h
> b/UefiCpuPkg/Library/SmmCpuFeaturesLib/SmmStm.h
> index 018e918360d3..da551cc4a6a6 100644
> --- a/UefiCpuPkg/Library/SmmCpuFeaturesLib/SmmStm.h
> +++ b/UefiCpuPkg/Library/SmmCpuFeaturesLib/SmmStm.h
> @@ -138,7 +138,7 @@ GetPiResource (
>    );
> 
>  /**
> -  This functin initialize STM configuration table.
> +  This function initialize STM configuration table.
>  **/
>  VOID
>  StmSmmConfigurationTableInit (
> @@ -169,7 +169,7 @@ GetStmResource (
> 
>  /**
>    This function fixes up the address of the global variable or function
> -  referred in SmiEntry assembly files to be the absoute address.
> +  referred in SmiEntry assembly files to be the absolute address.
>  **/
>  VOID
>  EFIAPI
> diff --git
> a/UefiCpuPkg/Library/CpuExceptionHandlerLib/PeiDxeSmmCpuException.c
> b/UefiCpuPkg/Library/CpuExceptionHandlerLib/PeiDxeSmmCpuException.c
> index 72c2aeca4c13..6a2670d55918 100644
> ---
> a/UefiCpuPkg/Library/CpuExceptionHandlerLib/PeiDxeSmmCpuException.c
> +++
> b/UefiCpuPkg/Library/CpuExceptionHandlerLib/PeiDxeSmmCpuException.c
> @@ -68,7 +68,7 @@ CommonExceptionHandlerWorker (
>          //
>          ArchRestoreExceptionContext (ExceptionType, SystemContext,
> ExceptionHandlerData);
>          //
> -        // Rlease spin lock for ApicId
> +        // Release spin lock for ApicId
>          //
>          ReleaseSpinLock (&ReservedVectors[ExceptionType].SpinLock);
>          break;
> @@ -230,7 +230,7 @@ InitializeCpuExceptionHandlersWorker (
>    IdtEntryCount = (IdtDescriptor.Limit + 1) / sizeof
> (IA32_IDT_GATE_DESCRIPTOR);
>    if (IdtEntryCount > CPU_EXCEPTION_NUM) {
>      //
> -    // CPU exeption library only setup CPU_EXCEPTION_NUM exception
> handler at most
> +    // CPU exception library only setup CPU_EXCEPTION_NUM exception
> + handler at most
>      //
>      IdtEntryCount = CPU_EXCEPTION_NUM;
>    }
> diff --git a/UefiCpuPkg/Library/CpuExceptionHandlerLib/SmmException.c
> b/UefiCpuPkg/Library/CpuExceptionHandlerLib/SmmException.c
> index ec705fc489af..e7977d49b771 100644
> --- a/UefiCpuPkg/Library/CpuExceptionHandlerLib/SmmException.c
> +++ b/UefiCpuPkg/Library/CpuExceptionHandlerLib/SmmException.c
> @@ -1,5 +1,5 @@
>  /** @file
> -  CPU exception handler library implemenation for SMM modules.
> +  CPU exception handler library implementation for SMM modules.
> 
>    Copyright (c) 2013 - 2017, Intel Corporation. All rights reserved.<BR>
>    SPDX-License-Identifier: BSD-2-Clause-Patent diff --git
> a/UefiCpuPkg/Library/SmmCpuFeaturesLib/SmmCpuFeaturesLib.c
> b/UefiCpuPkg/Library/SmmCpuFeaturesLib/SmmCpuFeaturesLib.c
> index bddb7a219ce4..a00786a8ebef 100644
> --- a/UefiCpuPkg/Library/SmmCpuFeaturesLib/SmmCpuFeaturesLib.c
> +++ b/UefiCpuPkg/Library/SmmCpuFeaturesLib/SmmCpuFeaturesLib.c
> @@ -540,7 +540,7 @@ SmmCpuFeaturesSetSmmRegister (
>                          from the save state.
> 
>    @retval EFI_SUCCESS           The register was read from Save State.
> -  @retval EFI_INVALID_PARAMTER  Buffer is NULL.
> +  @retval EFI_INVALID_PARAMETER  Buffer is NULL.
>    @retval EFI_UNSUPPORTED       This function does not support reading
> Register.
> 
>  **/
> @@ -569,7 +569,7 @@ SmmCpuFeaturesReadSaveStateRegister (
>    @param[in] Buffer    Upon entry, this holds the new CPU register value.
> 
>    @retval EFI_SUCCESS           The register was written to Save State.
> -  @retval EFI_INVALID_PARAMTER  Buffer is NULL.
> +  @retval EFI_INVALID_PARAMETER  Buffer is NULL.
>    @retval EFI_UNSUPPORTED       This function does not support writing
> Register.
>  **/
>  EFI_STATUS
> diff --git a/UefiCpuPkg/Library/SmmCpuFeaturesLib/SmmStm.c
> b/UefiCpuPkg/Library/SmmCpuFeaturesLib/SmmStm.c
> index 52a376c27db1..f7f8afacffb5 100644
> --- a/UefiCpuPkg/Library/SmmCpuFeaturesLib/SmmStm.c
> +++ b/UefiCpuPkg/Library/SmmCpuFeaturesLib/SmmStm.c
> @@ -913,7 +913,7 @@ AddPiResource (
>      }
> 
>      //
> -    // Copy EndResource for intialization
> +    // Copy EndResource for initialization
>      //
>      mStmResourcesPtr = (UINT8 *)(UINTN)NewResource;
>      mStmResourceTotalSize = NewResourceSize; @@ -1236,7 +1236,7 @@
> LoadMonitor (
>  /**
>    This function return BIOS STM resource.
>    Produced by SmmStm.
> -  Comsumed by SmmMpService when Init.
> +  Consumed by SmmMpService when Init.
> 
>    @return BIOS STM resource
> 
> diff --git a/UefiCpuPkg/Library/SmmCpuFeaturesLib/X64/SmiEntry.nasm
> b/UefiCpuPkg/Library/SmmCpuFeaturesLib/X64/SmiEntry.nasm
> index 5ee846e4f9ea..f09d8df1e6bc 100644
> --- a/UefiCpuPkg/Library/SmmCpuFeaturesLib/X64/SmiEntry.nasm
> +++ b/UefiCpuPkg/Library/SmmCpuFeaturesLib/X64/SmiEntry.nasm
> @@ -15,7 +15,7 @@
>  %include "StuffRsbNasm.inc"
> 
>  ;
> -; Variables referrenced by C code
> +; Variables referenced by C code
>  ;
> 
>  %define MSR_IA32_MISC_ENABLE 0x1A0
> --
> 2.21.0


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.

View/Reply Online (#52962): https://edk2.groups.io/g/devel/message/52962
Mute This Topic: https://groups.io/mt/69396198/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub  [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-