]> git.proxmox.com Git - mirror_edk2.git/commitdiff
SourceLevelDebugPkg/DebugAgent: Fix various typos
authorAntoine Coeur <coeur@gmx.fr>
Fri, 7 Feb 2020 01:08:24 +0000 (02:08 +0100)
committermergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Mon, 10 Feb 2020 22:30:07 +0000 (22:30 +0000)
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>

13 files changed:
SourceLevelDebugPkg/DebugAgentDxe/DebugAgentDxe.c
SourceLevelDebugPkg/DebugAgentPei/DebugAgentPei.c
SourceLevelDebugPkg/Library/DebugAgent/DebugAgentCommon/DebugAgent.c
SourceLevelDebugPkg/Library/DebugAgent/DebugAgentCommon/DebugMp.h
SourceLevelDebugPkg/Library/DebugAgent/DebugAgentCommon/Ia32/ArchDebugSupport.h
SourceLevelDebugPkg/Library/DebugAgent/DebugAgentCommon/Ia32/AsmFuncs.nasm
SourceLevelDebugPkg/Library/DebugAgent/DebugAgentCommon/Ia32/DebugException.h
SourceLevelDebugPkg/Library/DebugAgent/DebugAgentCommon/X64/ArchDebugSupport.h
SourceLevelDebugPkg/Library/DebugAgent/DebugAgentCommon/X64/DebugException.h
SourceLevelDebugPkg/Library/DebugAgent/DxeDebugAgent/DxeDebugAgentLib.c
SourceLevelDebugPkg/Library/DebugAgent/DxeDebugAgent/SerialIo.c
SourceLevelDebugPkg/Library/DebugAgent/SecPeiDebugAgent/SecPeiDebugAgentLib.c
SourceLevelDebugPkg/Library/DebugAgent/SmmDebugAgent/SmmDebugAgentLib.c

index 7ed4edb810a112b0ea1d02a4dd30bc953ea33240..33fc9f3646dc5be1d93edefc3fe5f0eea4ac31bc 100644 (file)
@@ -41,7 +41,7 @@ DisableDebugTimerExitBootService (
   @param[in] SystemTable    A pointer to the EFI System Table.\r
 \r
   @retval EFI_SUCCESS       The entry point is executed successfully.\r
-  @retval other             Some error occurs when initialzed Debug Agent.\r
+  @retval other             Some error occurs when initialized Debug Agent.\r
 \r
 **/\r
 EFI_STATUS\r
index 4ef1945cd88e94344ba8f7dda2edfb32c1a17e5e..fc2a8f75abf76a2a99954733e034fedfe8b53dfe 100644 (file)
@@ -21,7 +21,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent
   @param[in]  PeiServices  Pointer to PEI Services Table\r
 \r
   @retval EFI_SUCCESS    Debug Agent successfully initialized.\r
-  @retval other          Some error occurs when initialzed Debug Agent.\r
+  @retval other          Some error occurs when initialized Debug Agent.\r
 \r
 **/\r
 EFI_STATUS\r
index 3ab4a81589c845b19d742e2d44ec5a05d9f117fc..8021437ca903a52ac25d1b85cc928381a56270d1 100644 (file)
@@ -1,5 +1,5 @@
 /** @file\r
-  Commond Debug Agent library implementition. It mainly includes\r
+  Commond Debug Agent library implementation. It mainly includes\r
   the first C function called by exception/interrupt handlers,\r
   read/write debug packet to communication with HOST based on transfer\r
   protocol.\r
@@ -594,7 +594,7 @@ DebugAgentDataMsgPrint (
     Index ++;\r
     if (Index >= Length) {\r
       //\r
-      // The last character of debug message has been foramtted in buffer\r
+      // The last character of debug message has been formatted in buffer\r
       //\r
       DestBuffer += AsciiSPrint(DestBuffer, DEBUG_DATA_MAXIMUM_REAL_DATA - (DestBuffer - Buffer), "]\n");\r
       SendDebugMsgPacket (Buffer, DestBuffer - Buffer);\r
@@ -723,7 +723,7 @@ SetDebugSetting (
 }\r
 \r
 /**\r
-  Exectue GO command.\r
+  Execute GO command.\r
 \r
   @param[in] CpuContext        Pointer to saved CPU context.\r
 \r
@@ -1081,12 +1081,12 @@ DecompressDataInPlace (
   @param[out] IncompatibilityFlag If IncompatibilityFlag is not NULL, return\r
                                   TRUE:  Compatible packet received.\r
                                   FALSE: Incompatible packet received.\r
-  @param[in]  Timeout             Time out value to wait for acknowlege from HOST.\r
+  @param[in]  Timeout             Time out value to wait for acknowledge from HOST.\r
                                   The unit is microsecond.\r
   @param[in]  SkipStartSymbol     TRUE:  Skip time out when reading start symbol.\r
                                   FALSE: Does not Skip time out when reading start symbol.\r
 \r
-  @retval RETURN_SUCCESS   A valid package was reveived in InputPacket.\r
+  @retval RETURN_SUCCESS   A valid package was received in InputPacket.\r
   @retval RETURN_TIMEOUT   Timeout occurs.\r
 \r
 **/\r
@@ -1190,17 +1190,17 @@ ReceivePacket (
   Receive acknowledge packet OK from HOST in specified time.\r
 \r
   @param[in]  Command             The command type issued by TARGET.\r
-  @param[in]  Timeout             Time out value to wait for acknowlege from HOST.\r
+  @param[in]  Timeout             Time out value to wait for acknowledge from HOST.\r
                                   The unit is microsecond.\r
   @param[out] BreakReceived       If BreakReceived is not NULL,\r
-                                  TRUE is retured if break-in symbol received.\r
-                                  FALSE is retured if break-in symbol not received.\r
+                                  TRUE is returned if break-in symbol received.\r
+                                  FALSE is returned if break-in symbol not received.\r
   @param[out] IncompatibilityFlag If IncompatibilityFlag is not NULL, return\r
                                   TRUE:  Compatible packet received.\r
                                   FALSE: Incompatible packet received.\r
 \r
-  @retval  RETRUEN_SUCCESS  Succeed to receive acknowlege packet from HOST,\r
-                            the type of acknowlege packet saved in Ack.\r
+  @retval  RETURN_SUCCESS   Succeed to receive acknowledge packet from HOST,\r
+                            the type of acknowledge packet saved in Ack.\r
   @retval  RETURN_TIMEOUT   Specified timeout value was up.\r
 \r
 **/\r
@@ -1497,7 +1497,7 @@ CompressData (
 }\r
 \r
 /**\r
-  Read memory with speicifed width and send packet with response data to HOST.\r
+  Read memory with specified width and send packet with response data to HOST.\r
 \r
   @param[in] Data        Pointer to response data buffer.\r
   @param[in] Count       The number of data with specified Width.\r
@@ -1669,16 +1669,16 @@ SendDataResponsePacket (
   Try to attach the HOST.\r
 \r
   Send init break packet to HOST:\r
-  If no acknowlege received in specified Timeout, return RETURN_TIMEOUT.\r
-  If received acknowlege, check the revision of HOST.\r
+  If no acknowledge received in specified Timeout, return RETURN_TIMEOUT.\r
+  If received acknowledge, check the revision of HOST.\r
   Set Attach Flag if attach successfully.\r
 \r
   @param[in]  BreakCause     Break cause of this break event.\r
-  @param[in]  Timeout        Time out value to wait for acknowlege from HOST.\r
+  @param[in]  Timeout        Time out value to wait for acknowledge from HOST.\r
                              The unit is microsecond.\r
   @param[out] BreakReceived  If BreakReceived is not NULL,\r
-                             TRUE is retured if break-in symbol received.\r
-                             FALSE is retured if break-in symbol not received.\r
+                             TRUE is returned if break-in symbol received.\r
+                             FALSE is returned if break-in symbol not received.\r
 **/\r
 RETURN_STATUS\r
 AttachHost (\r
@@ -1732,8 +1732,8 @@ AttachHost (
   @param[in]  BreakCause     Break cause of this break event.\r
   @param[in]  ProcessorIndex Processor index value.\r
   @param[out] BreakReceived  If BreakReceived is not NULL,\r
-                             TRUE is retured if break-in symbol received.\r
-                             FALSE is retured if break-in symbol not received.\r
+                             TRUE is returned if break-in symbol received.\r
+                             FALSE is returned if break-in symbol not received.\r
 \r
 **/\r
 VOID\r
@@ -1777,7 +1777,7 @@ SendBreakPacketToHost (
 \r
   It received the command packet from HOST, and sent response data packet to HOST.\r
 \r
-  @param[in]      Vector         Vector value of exception or interrutp.\r
+  @param[in]      Vector         Vector value of exception or interrupt.\r
   @param[in, out] CpuContext     Pointer to saved CPU context.\r
   @param[in]      BreakReceived  TRUE means break-in symbol received.\r
                                  FALSE means break-in symbol not received.\r
@@ -1881,20 +1881,20 @@ CommandCommunication (
 \r
     Mailbox = GetMailboxPointer ();\r
     if (DebugHeader->SequenceNo == Mailbox->HostSequenceNo) {\r
-      DebugAgentMsgPrint (DEBUG_AGENT_WARNING, "TARGET: Receive one old command[%x] agaist command[%x]\n", DebugHeader->SequenceNo, Mailbox->HostSequenceNo);\r
+      DebugAgentMsgPrint (DEBUG_AGENT_WARNING, "TARGET: Receive one old command[%x] against command[%x]\n", DebugHeader->SequenceNo, Mailbox->HostSequenceNo);\r
       SendAckPacket (Mailbox->LastAck);\r
       ReleaseMpSpinLock (&mDebugMpContext.DebugPortSpinLock);\r
       continue;\r
     } else if (DebugHeader->SequenceNo == (UINT8) (Mailbox->HostSequenceNo + 1)) {\r
       UpdateMailboxContent (Mailbox, DEBUG_MAILBOX_HOST_SEQUENCE_NO_INDEX, (UINT8) DebugHeader->SequenceNo);\r
     } else {\r
-      DebugAgentMsgPrint (DEBUG_AGENT_WARNING, "Receive one invalid comamnd[%x] agaist command[%x]\n", DebugHeader->SequenceNo, Mailbox->HostSequenceNo);\r
+      DebugAgentMsgPrint (DEBUG_AGENT_WARNING, "Receive one invalid command[%x] against command[%x]\n", DebugHeader->SequenceNo, Mailbox->HostSequenceNo);\r
       ReleaseMpSpinLock (&mDebugMpContext.DebugPortSpinLock);\r
       continue;\r
     }\r
 \r
     //\r
-    // Save CPU content before executing HOST commond\r
+    // Save CPU content before executing HOST command\r
     //\r
     UpdateMailboxContent (Mailbox, DEBUG_MAILBOX_EXCEPTION_BUFFER_POINTER_INDEX, (UINT64)(UINTN) &AgentExceptionBuffer.JumpBuffer);\r
     if (SetJump (&AgentExceptionBuffer.JumpBuffer) != 0) {\r
@@ -2019,7 +2019,7 @@ CommandCommunication (
 \r
       } else {\r
         //\r
-        // If reveived HALT command, need to defer the GO command\r
+        // If received HALT command, need to defer the GO command\r
         //\r
         SendAckPacket (DEBUG_COMMAND_HALT_PROCESSED);\r
         HaltDeferred = FALSE;\r
@@ -2300,7 +2300,7 @@ CommandCommunication (
 /**\r
   C function called in interrupt handler.\r
 \r
-  @param[in] Vector      Vector value of exception or interrutp.\r
+  @param[in] Vector      Vector value of exception or interrupt.\r
   @param[in] CpuContext  Pointer to save CPU context.\r
 \r
 **/\r
@@ -2341,7 +2341,7 @@ InterruptProcess (
   if (MultiProcessorDebugSupport()) {\r
     ProcessorIndex = GetProcessorIndex ();\r
     //\r
-    // If this processor has alreay halted before, need to check it later\r
+    // If this processor has already halted before, need to check it later\r
     //\r
     if (IsCpuStopped (ProcessorIndex)) {\r
       IssuedViewPoint = ProcessorIndex;\r
@@ -2372,7 +2372,7 @@ InterruptProcess (
 \r
   if (MultiProcessorDebugSupport()) {\r
     //\r
-    // If RUN commmand is executing, wait for it done.\r
+    // If RUN command is executing, wait for it done.\r
     //\r
     while (mDebugMpContext.RunCommandSet) {\r
       CpuPause ();\r
index 71d7802d1548e12b63b72dbf0744eb8f2941dba3..07ddccad335d312595c5141a9cd9adcf70fa0565 100644 (file)
@@ -17,7 +17,7 @@ typedef struct {
 } DEBUG_CPU_DATA;\r
 \r
 typedef struct {\r
-  SPIN_LOCK                 MpContextSpinLock;   ///< Lock for writting MP context\r
+  SPIN_LOCK                 MpContextSpinLock;   ///< Lock for writing MP context\r
   SPIN_LOCK                 DebugPortSpinLock;   ///< Lock for access debug port\r
   SPIN_LOCK                 MailboxSpinLock;     ///< Lock for accessing mail box\r
   UINT8                     CpuBreakMask[DEBUG_CPU_MAX_COUNT/8];        ///< Bitmask of all breaking CPUs\r
@@ -26,8 +26,8 @@ typedef struct {
   UINT32                    BspIndex;            ///< Processor index value of BSP\r
   UINT32                    BreakAtCpuIndex;     ///< Processor index value of the current breaking CPU\r
   UINT32                    DebugTimerInitCount; ///< Record BSP's init timer count\r
-  BOOLEAN                   IpiSentByAp;         ///< TRUR: IPI is sent by AP. TALSE: IPI is sent by BSP\r
-  BOOLEAN                   RunCommandSet;       ///< TRUE: RUN commmand is executing. FALSE : RUN command has been executed.\r
+  BOOLEAN                   IpiSentByAp;         ///< TRUE: IPI is sent by AP. FALSE: IPI is sent by BSP\r
+  BOOLEAN                   RunCommandSet;       ///< TRUE: RUN command is executing. FALSE: RUN command has been executed.\r
 } DEBUG_MP_CONTEXT;\r
 \r
 extern DEBUG_MP_CONTEXT volatile   mDebugMpContext;\r
index d816bdaecdbe6a9d1f456c420c224f5771bab242..3acb0352bf76d05b4f5465bb2bac58d29f35b8e3 100644 (file)
@@ -1,5 +1,5 @@
 /** @file\r
-  IA32 specific defintions for debug agent library instance.\r
+  IA32 specific definitions for debug agent library instance.\r
 \r
   Copyright (c) 2010 - 2012, Intel Corporation. All rights reserved.<BR>\r
   SPDX-License-Identifier: BSD-2-Clause-Patent\r
index a5a734a463511cf6d3f2c2050e887f35d040e0ad..912256ba455afa0f870394937c6e8987e45e9ce5 100644 (file)
@@ -226,7 +226,7 @@ NoExtrPush:
     push    ebx         ; temporarily save value of ebx on stack\r
     cpuid               ; use CPUID to determine if FXSAVE/FXRESTOR and\r
                         ; DE are supported\r
-    pop     ebx         ; retore value of ebx that was overwritten by CPUID\r
+    pop     ebx         ; restore value of ebx that was overwritten by CPUID\r
     mov     eax, cr4\r
     push    eax         ; push cr4 firstly\r
     test    edx, BIT24  ; Test for FXSAVE/FXRESTOR support\r
@@ -407,7 +407,7 @@ NoExtrPush:
     mov     esp, ebp\r
     pop     ebp         ; restore ebp maybe updated\r
     pop     esp         ; restore esp maybe updated\r
-    sub     esp, 4 * 3  ; restore interupt pushced stack\r
+    sub     esp, 4 * 3  ; restore interrupt pushced stack\r
 \r
     iretd\r
 \r
index 750b3e4724eb19719c6072179afc084b59290189..9147fabe6c3e021129ba5b4a3485b341e7964d6d 100644 (file)
@@ -1,5 +1,5 @@
 /** @file\r
-  Exception defintions.\r
+  Exception definitions.\r
 \r
   Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>\r
   SPDX-License-Identifier: BSD-2-Clause-Patent\r
index 4ee12b771e9c57df608f93c297e509ac9593237e..1e45941a9927afbedf66833bebce58f1dfaee2d3 100644 (file)
@@ -1,5 +1,5 @@
 /** @file\r
-  X64 specific defintions for debug agent library instance.\r
+  X64 specific definitions for debug agent library instance.\r
 \r
   Copyright (c) 2010 - 2012, Intel Corporation. All rights reserved.<BR>\r
   SPDX-License-Identifier: BSD-2-Clause-Patent\r
index 750b3e4724eb19719c6072179afc084b59290189..9147fabe6c3e021129ba5b4a3485b341e7964d6d 100644 (file)
@@ -1,5 +1,5 @@
 /** @file\r
-  Exception defintions.\r
+  Exception definitions.\r
 \r
   Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>\r
   SPDX-License-Identifier: BSD-2-Clause-Patent\r
index 1f388d9c02818e723132a7120f3310f05b3fada1..bb37aa99b4d4fc0e0aa62dcafc86fba9e70598f4 100644 (file)
@@ -1,5 +1,5 @@
 /** @file\r
-  Debug Agent library implementition for Dxe Core and Dxr modules.\r
+  Debug Agent library implementation for Dxe Core and Dxr modules.\r
 \r
   Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>\r
   SPDX-License-Identifier: BSD-2-Clause-Patent\r
index 07f47262d24ea04efbcbbd1ba2a0219f487d17a1..3e64852e9027ad66c288db9fb5d8c7cce4665f42 100644 (file)
@@ -9,7 +9,7 @@
 #include "DxeDebugAgentLib.h"\r
 \r
 //\r
-// Serial I/O Protocol Interface defintions.\r
+// Serial I/O Protocol Interface definitions.\r
 //\r
 \r
 /**\r
@@ -231,7 +231,7 @@ typedef struct {
 } DEBUG_SERIAL_FIFO;\r
 \r
 //\r
-// Global Varibles\r
+// Global Variables\r
 //\r
 EFI_HANDLE                   mSerialIoHandle        = NULL;\r
 UINTN                        mLoopbackBuffer        = 0;\r
@@ -389,7 +389,7 @@ SerialReset (
   mSerialIoMode.ControlMask = SERIAL_PORT_DEFAULT_CONTROL_MASK;\r
   mLoopbackBuffer = 0;\r
   //\r
-  // Not reset serial devcie hardware indeed.\r
+  // Not reset serial device hardware indeed.\r
   //\r
   return EFI_SUCCESS;\r
 }\r
index da2a75e912461102442a21aa546dd3e0c4e58ed0..51e07f70e7bb7ed92da0a36f42f4fcdd2aa825e3 100644 (file)
@@ -1,5 +1,5 @@
 /** @file\r
-  SEC Core Debug Agent Library instance implementition.\r
+  SEC Core Debug Agent Library instance implementation.\r
 \r
   Copyright (c) 2010 - 2017, Intel Corporation. All rights reserved.<BR>\r
   SPDX-License-Identifier: BSD-2-Clause-Patent\r
@@ -198,7 +198,7 @@ GetMailboxPointer (
 \r
   MailboxLocationInHob = GetMailboxLocationFromHob ();\r
   //\r
-  // Compare mailbox in IDT enry with mailbox in HOB,\r
+  // Compare mailbox in IDT entry with mailbox in HOB,\r
   // need to fix mailbox location if HOB moved by PEI CORE\r
   //\r
   if (MailboxLocationInHob != MailboxLocationInIdt && MailboxLocationInHob != NULL) {\r
@@ -323,7 +323,7 @@ DebugAgentCallbackMemoryDiscoveredPpi (
 \r
   This function is used to set up debug environment for SEC and PEI phase.\r
 \r
-  If InitFlag is DEBUG_AGENT_INIT_PREMEM_SEC, it will overirde IDT table entries\r
+  If InitFlag is DEBUG_AGENT_INIT_PREMEM_SEC, it will override IDT table entries\r
   and initialize debug port. It will enable interrupt to support break-in feature.\r
   It will set up debug agent Mailbox in cache-as-ramfrom. It will be called before\r
   physical memory is ready.\r
@@ -546,7 +546,7 @@ InitializeDebugAgent (
     SetDebugFlag (DEBUG_AGENT_FLAG_INIT_ARCH, DEBUG_ARCH_SYMBOL);\r
     //\r
     // Register for a callback once memory has been initialized.\r
-    // If memery has been ready, the callback funtion will be invoked immediately\r
+    // If memory has been ready, the callback function will be invoked immediately\r
     //\r
     Status = PeiServicesNotifyPpi (&mDebugAgentMemoryDiscoveredNotifyList[0]);\r
     if (EFI_ERROR (Status)) {\r
@@ -626,7 +626,7 @@ InitializeDebugAgent (
     EnableInterrupts ();\r
   }\r
   //\r
-  // If Function is not NULL, invoke it always whatever debug agent was initialized sucesssfully or not.\r
+  // If Function is not NULL, invoke it always whatever debug agent was initialized successfully or not.\r
   //\r
   if (Function != NULL) {\r
     Function (Context);\r
index b759918e853110beb45c0d0f3ee156a5cb40144a..37b0e8f397593f820dc88592d7711fc432489f17 100644 (file)
@@ -1,5 +1,5 @@
 /** @file\r
-  Debug Agent library implementition.\r
+  Debug Agent library implementation.\r
 \r
   Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>\r
   SPDX-License-Identifier: BSD-2-Clause-Patent\r
@@ -152,13 +152,13 @@ RestoreDebugRegister (
 /**\r
   Initialize debug agent.\r
 \r
-  This function is used to set up debug enviroment for source level debug\r
+  This function is used to set up debug environment for source level debug\r
   in SMM code.\r
 \r
-  If InitFlag is DEBUG_AGENT_INIT_SMM, it will overirde IDT table entries\r
+  If InitFlag is DEBUG_AGENT_INIT_SMM, it will override IDT table entries\r
   and initialize debug port. It will get debug agent Mailbox from GUIDed HOB,\r
   it it exists, debug agent wiil copied it into the local Mailbox in SMM space.\r
-  it will overirde IDT table entries and initialize debug port. Context will be\r
+  it will override IDT table entries and initialize debug port. Context will be\r
   NULL.\r
   If InitFlag is DEBUG_AGENT_INIT_ENTER_SMI, debug agent will save Debug\r
   Registers and get local Mailbox in SMM space. Context will be NULL.\r
@@ -295,7 +295,7 @@ InitializeDebugAgent (
     Mailbox = GetMailboxPointer ();\r
     if (GetDebugFlag (DEBUG_AGENT_FLAG_AGENT_IN_PROGRESS) == 1) {\r
       //\r
-      // If Debug Agent has been communicaton state with HOST, we need skip\r
+      // If Debug Agent has been communication state with HOST, we need skip\r
       // any break points set in SMM, set Skip Breakpoint flag\r
       //\r
       mSkipBreakpoint = TRUE;\r