SourceLevelDebugPkg/DebugAgent: Fix various typos

Fix various typos in documentation, comments and debug strings.

Cc: Hao A Wu <hao.a.wu@intel.com>
Signed-off-by: Antoine Coeur <coeur@gmx.fr>
Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com>
Reviewed-by: Hao A Wu <hao.a.wu@intel.com>
Signed-off-by: Philippe Mathieu-Daude <philmd@redhat.com>
Message-Id: <20200207010831.9046-72-philmd@redhat.com>

SourceLevelDebugPkg/DebugAgentDxe/DebugAgentDxe.c

@@ -41,7 +41,7 @@ DisableDebugTimerExitBootService (
   @param[in] SystemTable    A pointer to the EFI System Table.
 
   @retval EFI_SUCCESS       The entry point is executed successfully.
-  @retval other             Some error occurs when initialzed Debug Agent.
+  @retval other             Some error occurs when initialized Debug Agent.
 
 **/
 EFI_STATUS

SourceLevelDebugPkg/DebugAgentPei/DebugAgentPei.c

@@ -21,7 +21,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
   @param[in]  PeiServices  Pointer to PEI Services Table
 
   @retval EFI_SUCCESS    Debug Agent successfully initialized.
-  @retval other          Some error occurs when initialzed Debug Agent.
+  @retval other          Some error occurs when initialized Debug Agent.
 
 **/
 EFI_STATUS

SourceLevelDebugPkg/Library/DebugAgent/DebugAgentCommon/DebugAgent.c

@@ -1,5 +1,5 @@
 /** @file
-  Commond Debug Agent library implementition. It mainly includes
+  Commond Debug Agent library implementation. It mainly includes
   the first C function called by exception/interrupt handlers,
   read/write debug packet to communication with HOST based on transfer
   protocol.
@@ -594,7 +594,7 @@ DebugAgentDataMsgPrint (
     Index ++;
     if (Index >= Length) {
       //
-      // The last character of debug message has been foramtted in buffer
+      // The last character of debug message has been formatted in buffer
       //
       DestBuffer += AsciiSPrint(DestBuffer, DEBUG_DATA_MAXIMUM_REAL_DATA - (DestBuffer - Buffer), "]\n");
       SendDebugMsgPacket (Buffer, DestBuffer - Buffer);
@@ -723,7 +723,7 @@ SetDebugSetting (
 }
 
 /**
-  Exectue GO command.
+  Execute GO command.
 
   @param[in] CpuContext        Pointer to saved CPU context.
 
@@ -1081,12 +1081,12 @@ DecompressDataInPlace (
   @param[out] IncompatibilityFlag If IncompatibilityFlag is not NULL, return
                                   TRUE:  Compatible packet received.
                                   FALSE: Incompatible packet received.
-  @param[in]  Timeout             Time out value to wait for acknowlege from HOST.
+  @param[in]  Timeout             Time out value to wait for acknowledge from HOST.
                                   The unit is microsecond.
   @param[in]  SkipStartSymbol     TRUE:  Skip time out when reading start symbol.
                                   FALSE: Does not Skip time out when reading start symbol.
 
-  @retval RETURN_SUCCESS   A valid package was reveived in InputPacket.
+  @retval RETURN_SUCCESS   A valid package was received in InputPacket.
   @retval RETURN_TIMEOUT   Timeout occurs.
 
 **/
@@ -1190,17 +1190,17 @@ ReceivePacket (
   Receive acknowledge packet OK from HOST in specified time.
 
   @param[in]  Command             The command type issued by TARGET.
-  @param[in]  Timeout             Time out value to wait for acknowlege from HOST.
+  @param[in]  Timeout             Time out value to wait for acknowledge from HOST.
                                   The unit is microsecond.
   @param[out] BreakReceived       If BreakReceived is not NULL,
-                                  TRUE is retured if break-in symbol received.
+                                  TRUE is returned if break-in symbol received.
-                                  FALSE is retured if break-in symbol not received.
+                                  FALSE is returned if break-in symbol not received.
   @param[out] IncompatibilityFlag If IncompatibilityFlag is not NULL, return
                                   TRUE:  Compatible packet received.
                                   FALSE: Incompatible packet received.
 
-  @retval  RETRUEN_SUCCESS  Succeed to receive acknowlege packet from HOST,
+  @retval  RETURN_SUCCESS   Succeed to receive acknowledge packet from HOST,
-                            the type of acknowlege packet saved in Ack.
+                            the type of acknowledge packet saved in Ack.
   @retval  RETURN_TIMEOUT   Specified timeout value was up.
 
 **/
@@ -1497,7 +1497,7 @@ CompressData (
 }
 
 /**
-  Read memory with speicifed width and send packet with response data to HOST.
+  Read memory with specified width and send packet with response data to HOST.
 
   @param[in] Data        Pointer to response data buffer.
   @param[in] Count       The number of data with specified Width.
@@ -1669,16 +1669,16 @@ SendDataResponsePacket (
   Try to attach the HOST.
 
   Send init break packet to HOST:
-  If no acknowlege received in specified Timeout, return RETURN_TIMEOUT.
+  If no acknowledge received in specified Timeout, return RETURN_TIMEOUT.
-  If received acknowlege, check the revision of HOST.
+  If received acknowledge, check the revision of HOST.
   Set Attach Flag if attach successfully.
 
   @param[in]  BreakCause     Break cause of this break event.
-  @param[in]  Timeout        Time out value to wait for acknowlege from HOST.
+  @param[in]  Timeout        Time out value to wait for acknowledge from HOST.
                              The unit is microsecond.
   @param[out] BreakReceived  If BreakReceived is not NULL,
-                             TRUE is retured if break-in symbol received.
+                             TRUE is returned if break-in symbol received.
-                             FALSE is retured if break-in symbol not received.
+                             FALSE is returned if break-in symbol not received.
 **/
 RETURN_STATUS
 AttachHost (
@@ -1732,8 +1732,8 @@ AttachHost (
   @param[in]  BreakCause     Break cause of this break event.
   @param[in]  ProcessorIndex Processor index value.
   @param[out] BreakReceived  If BreakReceived is not NULL,
-                             TRUE is retured if break-in symbol received.
+                             TRUE is returned if break-in symbol received.
-                             FALSE is retured if break-in symbol not received.
+                             FALSE is returned if break-in symbol not received.
 
 **/
 VOID
@@ -1777,7 +1777,7 @@ SendBreakPacketToHost (
 
   It received the command packet from HOST, and sent response data packet to HOST.
 
-  @param[in]      Vector         Vector value of exception or interrutp.
+  @param[in]      Vector         Vector value of exception or interrupt.
   @param[in, out] CpuContext     Pointer to saved CPU context.
   @param[in]      BreakReceived  TRUE means break-in symbol received.
                                  FALSE means break-in symbol not received.
@@ -1881,20 +1881,20 @@ CommandCommunication (
 
     Mailbox = GetMailboxPointer ();
     if (DebugHeader->SequenceNo == Mailbox->HostSequenceNo) {
-      DebugAgentMsgPrint (DEBUG_AGENT_WARNING, "TARGET: Receive one old command[%x] agaist command[%x]\n", DebugHeader->SequenceNo, Mailbox->HostSequenceNo);
+      DebugAgentMsgPrint (DEBUG_AGENT_WARNING, "TARGET: Receive one old command[%x] against command[%x]\n", DebugHeader->SequenceNo, Mailbox->HostSequenceNo);
       SendAckPacket (Mailbox->LastAck);
       ReleaseMpSpinLock (&mDebugMpContext.DebugPortSpinLock);
       continue;
     } else if (DebugHeader->SequenceNo == (UINT8) (Mailbox->HostSequenceNo + 1)) {
       UpdateMailboxContent (Mailbox, DEBUG_MAILBOX_HOST_SEQUENCE_NO_INDEX, (UINT8) DebugHeader->SequenceNo);
     } else {
-      DebugAgentMsgPrint (DEBUG_AGENT_WARNING, "Receive one invalid comamnd[%x] agaist command[%x]\n", DebugHeader->SequenceNo, Mailbox->HostSequenceNo);
+      DebugAgentMsgPrint (DEBUG_AGENT_WARNING, "Receive one invalid command[%x] against command[%x]\n", DebugHeader->SequenceNo, Mailbox->HostSequenceNo);
       ReleaseMpSpinLock (&mDebugMpContext.DebugPortSpinLock);
       continue;
     }
 
     //
-    // Save CPU content before executing HOST commond
+    // Save CPU content before executing HOST command
     //
     UpdateMailboxContent (Mailbox, DEBUG_MAILBOX_EXCEPTION_BUFFER_POINTER_INDEX, (UINT64)(UINTN) &AgentExceptionBuffer.JumpBuffer);
     if (SetJump (&AgentExceptionBuffer.JumpBuffer) != 0) {
@@ -2019,7 +2019,7 @@ CommandCommunication (
 
       } else {
         //
-        // If reveived HALT command, need to defer the GO command
+        // If received HALT command, need to defer the GO command
         //
         SendAckPacket (DEBUG_COMMAND_HALT_PROCESSED);
         HaltDeferred = FALSE;
@@ -2300,7 +2300,7 @@ CommandCommunication (
 /**
   C function called in interrupt handler.
 
-  @param[in] Vector      Vector value of exception or interrutp.
+  @param[in] Vector      Vector value of exception or interrupt.
   @param[in] CpuContext  Pointer to save CPU context.
 
 **/
@@ -2341,7 +2341,7 @@ InterruptProcess (
   if (MultiProcessorDebugSupport()) {
     ProcessorIndex = GetProcessorIndex ();
     //
-    // If this processor has alreay halted before, need to check it later
+    // If this processor has already halted before, need to check it later
     //
     if (IsCpuStopped (ProcessorIndex)) {
       IssuedViewPoint = ProcessorIndex;
@@ -2372,7 +2372,7 @@ InterruptProcess (
 
   if (MultiProcessorDebugSupport()) {
     //
-    // If RUN commmand is executing, wait for it done.
+    // If RUN command is executing, wait for it done.
     //
     while (mDebugMpContext.RunCommandSet) {
       CpuPause ();

SourceLevelDebugPkg/Library/DebugAgent/DebugAgentCommon/DebugMp.h

@@ -17,7 +17,7 @@ typedef struct {
 } DEBUG_CPU_DATA;
 
 typedef struct {
-  SPIN_LOCK                 MpContextSpinLock;   ///< Lock for writting MP context
+  SPIN_LOCK                 MpContextSpinLock;   ///< Lock for writing MP context
   SPIN_LOCK                 DebugPortSpinLock;   ///< Lock for access debug port
   SPIN_LOCK                 MailboxSpinLock;     ///< Lock for accessing mail box
   UINT8                     CpuBreakMask[DEBUG_CPU_MAX_COUNT/8];        ///< Bitmask of all breaking CPUs
@@ -26,8 +26,8 @@ typedef struct {
   UINT32                    BspIndex;            ///< Processor index value of BSP
   UINT32                    BreakAtCpuIndex;     ///< Processor index value of the current breaking CPU
   UINT32                    DebugTimerInitCount; ///< Record BSP's init timer count
-  BOOLEAN                   IpiSentByAp;         ///< TRUR: IPI is sent by AP. TALSE: IPI is sent by BSP
+  BOOLEAN                   IpiSentByAp;         ///< TRUE: IPI is sent by AP. FALSE: IPI is sent by BSP
-  BOOLEAN                   RunCommandSet;       ///< TRUE: RUN commmand is executing. FALSE : RUN command has been executed.
+  BOOLEAN                   RunCommandSet;       ///< TRUE: RUN command is executing. FALSE: RUN command has been executed.
 } DEBUG_MP_CONTEXT;
 
 extern DEBUG_MP_CONTEXT volatile   mDebugMpContext;

SourceLevelDebugPkg/Library/DebugAgent/DebugAgentCommon/Ia32/ArchDebugSupport.h

@@ -1,5 +1,5 @@
 /** @file
-  IA32 specific defintions for debug agent library instance.
+  IA32 specific definitions for debug agent library instance.
 
   Copyright (c) 2010 - 2012, Intel Corporation. All rights reserved.<BR>
   SPDX-License-Identifier: BSD-2-Clause-Patent

SourceLevelDebugPkg/Library/DebugAgent/DebugAgentCommon/Ia32/AsmFuncs.nasm

@@ -226,7 +226,7 @@ NoExtrPush:
     push    ebx         ; temporarily save value of ebx on stack
     cpuid               ; use CPUID to determine if FXSAVE/FXRESTOR and
                         ; DE are supported
-    pop     ebx         ; retore value of ebx that was overwritten by CPUID
+    pop     ebx         ; restore value of ebx that was overwritten by CPUID
     mov     eax, cr4
     push    eax         ; push cr4 firstly
     test    edx, BIT24  ; Test for FXSAVE/FXRESTOR support
@@ -407,7 +407,7 @@ NoExtrPush:
     mov     esp, ebp
     pop     ebp         ; restore ebp maybe updated
     pop     esp         ; restore esp maybe updated
-    sub     esp, 4 * 3  ; restore interupt pushced stack
+    sub     esp, 4 * 3  ; restore interrupt pushced stack
 
     iretd
 

SourceLevelDebugPkg/Library/DebugAgent/DebugAgentCommon/Ia32/DebugException.h

@@ -1,5 +1,5 @@
 /** @file
-  Exception defintions.
+  Exception definitions.
 
   Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>
   SPDX-License-Identifier: BSD-2-Clause-Patent

SourceLevelDebugPkg/Library/DebugAgent/DebugAgentCommon/X64/ArchDebugSupport.h

@@ -1,5 +1,5 @@
 /** @file
-  X64 specific defintions for debug agent library instance.
+  X64 specific definitions for debug agent library instance.
 
   Copyright (c) 2010 - 2012, Intel Corporation. All rights reserved.<BR>
   SPDX-License-Identifier: BSD-2-Clause-Patent

SourceLevelDebugPkg/Library/DebugAgent/DebugAgentCommon/X64/DebugException.h

@@ -1,5 +1,5 @@
 /** @file
-  Exception defintions.
+  Exception definitions.
 
   Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>
   SPDX-License-Identifier: BSD-2-Clause-Patent

SourceLevelDebugPkg/Library/DebugAgent/DxeDebugAgent/DxeDebugAgentLib.c

@@ -1,5 +1,5 @@
 /** @file
-  Debug Agent library implementition for Dxe Core and Dxr modules.
+  Debug Agent library implementation for Dxe Core and Dxr modules.
 
   Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>
   SPDX-License-Identifier: BSD-2-Clause-Patent

SourceLevelDebugPkg/Library/DebugAgent/DxeDebugAgent/SerialIo.c

@@ -9,7 +9,7 @@
 #include "DxeDebugAgentLib.h"
 
 //
-// Serial I/O Protocol Interface defintions.
+// Serial I/O Protocol Interface definitions.
 //
 
 /**
@@ -231,7 +231,7 @@ typedef struct {
 } DEBUG_SERIAL_FIFO;
 
 //
-// Global Varibles
+// Global Variables
 //
 EFI_HANDLE                   mSerialIoHandle        = NULL;
 UINTN                        mLoopbackBuffer        = 0;
@@ -389,7 +389,7 @@ SerialReset (
   mSerialIoMode.ControlMask = SERIAL_PORT_DEFAULT_CONTROL_MASK;
   mLoopbackBuffer = 0;
   //
-  // Not reset serial devcie hardware indeed.
+  // Not reset serial device hardware indeed.
   //
   return EFI_SUCCESS;
 }

SourceLevelDebugPkg/Library/DebugAgent/SecPeiDebugAgent/SecPeiDebugAgentLib.c

@@ -1,5 +1,5 @@
 /** @file
-  SEC Core Debug Agent Library instance implementition.
+  SEC Core Debug Agent Library instance implementation.
 
   Copyright (c) 2010 - 2017, Intel Corporation. All rights reserved.<BR>
   SPDX-License-Identifier: BSD-2-Clause-Patent
@@ -198,7 +198,7 @@ GetMailboxPointer (
 
   MailboxLocationInHob = GetMailboxLocationFromHob ();
   //
-  // Compare mailbox in IDT enry with mailbox in HOB,
+  // Compare mailbox in IDT entry with mailbox in HOB,
   // need to fix mailbox location if HOB moved by PEI CORE
   //
   if (MailboxLocationInHob != MailboxLocationInIdt && MailboxLocationInHob != NULL) {
@@ -323,7 +323,7 @@ DebugAgentCallbackMemoryDiscoveredPpi (
 
   This function is used to set up debug environment for SEC and PEI phase.
 
-  If InitFlag is DEBUG_AGENT_INIT_PREMEM_SEC, it will overirde IDT table entries
+  If InitFlag is DEBUG_AGENT_INIT_PREMEM_SEC, it will override IDT table entries
   and initialize debug port. It will enable interrupt to support break-in feature.
   It will set up debug agent Mailbox in cache-as-ramfrom. It will be called before
   physical memory is ready.
@@ -546,7 +546,7 @@ InitializeDebugAgent (
     SetDebugFlag (DEBUG_AGENT_FLAG_INIT_ARCH, DEBUG_ARCH_SYMBOL);
     //
     // Register for a callback once memory has been initialized.
-    // If memery has been ready, the callback funtion will be invoked immediately
+    // If memory has been ready, the callback function will be invoked immediately
     //
     Status = PeiServicesNotifyPpi (&mDebugAgentMemoryDiscoveredNotifyList[0]);
     if (EFI_ERROR (Status)) {
@@ -626,7 +626,7 @@ InitializeDebugAgent (
     EnableInterrupts ();
   }
   //
-  // If Function is not NULL, invoke it always whatever debug agent was initialized sucesssfully or not.
+  // If Function is not NULL, invoke it always whatever debug agent was initialized successfully or not.
   //
   if (Function != NULL) {
     Function (Context);

SourceLevelDebugPkg/Library/DebugAgent/SmmDebugAgent/SmmDebugAgentLib.c

@@ -1,5 +1,5 @@
 /** @file
-  Debug Agent library implementition.
+  Debug Agent library implementation.
 
   Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>
   SPDX-License-Identifier: BSD-2-Clause-Patent
@@ -152,13 +152,13 @@ RestoreDebugRegister (
 /**
   Initialize debug agent.
 
-  This function is used to set up debug enviroment for source level debug
+  This function is used to set up debug environment for source level debug
   in SMM code.
 
-  If InitFlag is DEBUG_AGENT_INIT_SMM, it will overirde IDT table entries
+  If InitFlag is DEBUG_AGENT_INIT_SMM, it will override IDT table entries
   and initialize debug port. It will get debug agent Mailbox from GUIDed HOB,
   it it exists, debug agent wiil copied it into the local Mailbox in SMM space.
-  it will overirde IDT table entries and initialize debug port. Context will be
+  it will override IDT table entries and initialize debug port. Context will be
   NULL.
   If InitFlag is DEBUG_AGENT_INIT_ENTER_SMI, debug agent will save Debug
   Registers and get local Mailbox in SMM space. Context will be NULL.
@@ -295,7 +295,7 @@ InitializeDebugAgent (
     Mailbox = GetMailboxPointer ();
     if (GetDebugFlag (DEBUG_AGENT_FLAG_AGENT_IN_PROGRESS) == 1) {
       //
-      // If Debug Agent has been communicaton state with HOST, we need skip
+      // If Debug Agent has been communication state with HOST, we need skip
       // any break points set in SMM, set Skip Breakpoint flag
       //
       mSkipBreakpoint = TRUE;