SourceLevelDebugPkg: Fix spelling errors

REF:https://bugzilla.tianocore.org/show_bug.cgi?id=4091

Fixes spelling errors in the package so the SpellCheck CI plugin can
be enabled.

Cc: Hao A Wu <hao.a.wu@intel.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
Reviewed-by: Hao A Wu <hao.a.wu@intel.com>
Reviewed-by: Michael D Kinney <michael.d.kinney@intel.com>

diff --git a/SourceLevelDebugPkg/Include/Library/DebugCommunicationLib.h b/SourceLevelDebugPkg/Include/Library/DebugCommunicationLib.h
index ad7bccda285c1ae6b4f3ecb75f77a2de6a9cb007..ebb2168632dad756fea33fd4c2b2c5e502a7d256 100644 (file)
--- a/SourceLevelDebugPkg/Include/Library/DebugCommunicationLib.h
+++ b/SourceLevelDebugPkg/Include/Library/DebugCommunicationLib.h
@@ -71,7 +71,7 @@ DebugPortInitialize (
   );\r
 \r
 /**\r
-  Read data from debug device and save the datas in buffer.\r
+  Read data from debug device and save the data in a buffer.\r
 \r
   Reads NumberOfBytes data bytes from a debug device into the buffer\r
   specified by Buffer. The number of bytes actually read is returned.\r

diff --git a/SourceLevelDebugPkg/Library/DebugAgent/DebugAgentCommon/DebugAgent.c b/SourceLevelDebugPkg/Library/DebugAgent/DebugAgentCommon/DebugAgent.c
index a1e61a6ef90eb21e3b61b93302853d0b8efbe9d5..b553a2a9aa0c48c3e364013548fec55f74c5bac4 100644 (file)
--- a/SourceLevelDebugPkg/Library/DebugAgent/DebugAgentCommon/DebugAgent.c
+++ b/SourceLevelDebugPkg/Library/DebugAgent/DebugAgentCommon/DebugAgent.c
@@ -1,5 +1,5 @@
 /** @file\r
-  Commond Debug Agent library implementation. It mainly includes\r
+  Common 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
@@ -608,7 +608,7 @@ DebugAgentDataMsgPrint (
 }\r
 \r
 /**\r
-  Read remaing debug packet except for the start symbol\r
+  Read remaining debug packet except for the start symbol\r
 \r
   @param[in]      Handle        Pointer to Debug Port handle.\r
   @param[in, out] DebugHeader   Debug header buffer including start symbol.\r
@@ -616,7 +616,7 @@ DebugAgentDataMsgPrint (
   @retval EFI_SUCCESS        Read the symbol in BreakSymbol.\r
   @retval EFI_CRC_ERROR      CRC check fail.\r
   @retval EFI_TIMEOUT        Timeout occurs when reading debug packet.\r
-  @retval EFI_DEVICE_ERROR   Receive the old or responsed packet.\r
+  @retval EFI_DEVICE_ERROR   Receive the old or response packet.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -651,7 +651,7 @@ ReadRemainingBreakPacket (
   if (IS_REQUEST (DebugHeader)) {\r
     if (DebugHeader->SequenceNo == (UINT8)(Mailbox->HostSequenceNo + 1)) {\r
       //\r
-      // Only updagte HostSequenceNo for new command packet\r
+      // Only update HostSequenceNo for new command packet\r
       //\r
       UpdateMailboxContent (Mailbox, DEBUG_MAILBOX_HOST_SEQUENCE_NO_INDEX, DebugHeader->SequenceNo);\r
       return EFI_SUCCESS;\r

diff --git a/SourceLevelDebugPkg/Library/DebugAgent/DebugAgentCommon/DebugAgent.h b/SourceLevelDebugPkg/Library/DebugAgent/DebugAgentCommon/DebugAgent.h
index a0ede308efee99baec7db8a0e9a0a0f308794d06..4c72f8f3a90cf48b381853839f5d784900bcc3f3 100644 (file)
--- a/SourceLevelDebugPkg/Library/DebugAgent/DebugAgentCommon/DebugAgent.h
+++ b/SourceLevelDebugPkg/Library/DebugAgent/DebugAgentCommon/DebugAgent.h
@@ -452,7 +452,7 @@ DebugAgentDataMsgPrint (
   );\r
 \r
 /**\r
-  Read remaing debug packet except for the start symbol\r
+  Read remaining debug packet except for the start symbol\r
 \r
   @param[in]      Handle        Pointer to Debug Port handle.\r
   @param[in, out] DebugHeader   Debug header buffer including start symbol.\r

diff --git a/SourceLevelDebugPkg/Library/DebugAgent/DxeDebugAgent/SerialIo.c b/SourceLevelDebugPkg/Library/DebugAgent/DxeDebugAgent/SerialIo.c
index 6661275cc343cc423c785b3bf470d1ed6629053c..97d30c802df4f880d79cac4ac519441f21c54a73 100644 (file)
--- a/SourceLevelDebugPkg/Library/DebugAgent/DxeDebugAgent/SerialIo.c
+++ b/SourceLevelDebugPkg/Library/DebugAgent/DxeDebugAgent/SerialIo.c
@@ -213,10 +213,10 @@ SERIAL_IO_DEVICE_PATH  mSerialIoDevicePath = {
   }\r
 };\r
 \r
-#define DEBGU_SERIAL_IO_FIFO_DEPTH  10\r
+#define DEBUG_SERIAL_IO_FIFO_DEPTH  10\r
 //\r
 //  Data buffer for Terminal input character and Debug Symbols.\r
-//  The depth is DEBGU_SERIAL_IO_FIFO_DEPTH.\r
+//  The depth is DEBUG_SERIAL_IO_FIFO_DEPTH.\r
 //  Fields:\r
 //      First   UINT8: The index of the first data in array Data[].\r
 //      Last    UINT8: The index, which you can put a new data into array Data[].\r
@@ -227,7 +227,7 @@ typedef struct {
   UINT8    First;\r
   UINT8    Last;\r
   UINT8    Surplus;\r
-  UINT8    Data[DEBGU_SERIAL_IO_FIFO_DEPTH];\r
+  UINT8    Data[DEBUG_SERIAL_IO_FIFO_DEPTH];\r
 } DEBUG_SERIAL_FIFO;\r
 \r
 //\r
@@ -236,10 +236,10 @@ typedef struct {
 EFI_HANDLE         mSerialIoHandle        = NULL;\r
 UINTN              mLoopbackBuffer        = 0;\r
 DEBUG_SERIAL_FIFO  mSerialFifoForTerminal = {\r
-  0, 0, DEBGU_SERIAL_IO_FIFO_DEPTH, { 0 }\r
+  0, 0, DEBUG_SERIAL_IO_FIFO_DEPTH, { 0 }\r
 };\r
 DEBUG_SERIAL_FIFO  mSerialFifoForDebug = {\r
-  0, 0, DEBGU_SERIAL_IO_FIFO_DEPTH, { 0 }\r
+  0, 0, DEBUG_SERIAL_IO_FIFO_DEPTH, { 0 }\r
 };\r
 \r
 /**\r
@@ -251,11 +251,11 @@ DEBUG_SERIAL_FIFO  mSerialFifoForDebug = {
 \r
 **/\r
 BOOLEAN\r
-IsDebugTermianlFifoEmpty (\r
+IsDebugTerminalFifoEmpty (\r
   IN DEBUG_SERIAL_FIFO  *Fifo\r
   )\r
 {\r
-  if (Fifo->Surplus == DEBGU_SERIAL_IO_FIFO_DEPTH) {\r
+  if (Fifo->Surplus == DEBUG_SERIAL_IO_FIFO_DEPTH) {\r
     return TRUE;\r
   }\r
 \r
@@ -313,7 +313,7 @@ DebugTerminalFifoAdd (
   Fifo->Data[Fifo->Last] = Data;\r
   Fifo->Surplus--;\r
   Fifo->Last++;\r
-  if (Fifo->Last == DEBGU_SERIAL_IO_FIFO_DEPTH) {\r
+  if (Fifo->Last == DEBUG_SERIAL_IO_FIFO_DEPTH) {\r
     Fifo->Last = 0;\r
   }\r
 \r
@@ -339,7 +339,7 @@ DebugTerminalFifoRemove (
   //\r
   // if FIFO is empty, no data can remove\r
   //\r
-  if (IsDebugTermianlFifoEmpty (Fifo)) {\r
+  if (IsDebugTerminalFifoEmpty (Fifo)) {\r
     return EFI_OUT_OF_RESOURCES;\r
   }\r
 \r
@@ -349,7 +349,7 @@ DebugTerminalFifoRemove (
   *Data = Fifo->Data[Fifo->First];\r
   Fifo->Surplus++;\r
   Fifo->First++;\r
-  if (Fifo->First == DEBGU_SERIAL_IO_FIFO_DEPTH) {\r
+  if (Fifo->First == DEBUG_SERIAL_IO_FIFO_DEPTH) {\r
     Fifo->First = 0;\r
   }\r
 \r
@@ -532,7 +532,7 @@ SerialGetControl (
   // Check to see if the Terminal FIFO is empty and\r
   // check to see if the input buffer in the Debug Communication Library is empty\r
   //\r
-  if (!IsDebugTermianlFifoEmpty (&mSerialFifoForTerminal) || DebugPortPollBuffer (Handle)) {\r
+  if (!IsDebugTerminalFifoEmpty (&mSerialFifoForTerminal) || DebugPortPollBuffer (Handle)) {\r
     *Control &= ~EFI_SERIAL_INPUT_BUFFER_EMPTY;\r
   }\r
 \r

diff --git a/SourceLevelDebugPkg/Library/DebugCommunicationLibSerialPort/DebugCommunicationLibSerialPort.c b/SourceLevelDebugPkg/Library/DebugCommunicationLibSerialPort/DebugCommunicationLibSerialPort.c
index 34c269e6b5273927511cd51704371c7b946c2cca..9953904725acb644865b5e8dff5cedb82835d23b 100644 (file)
--- a/SourceLevelDebugPkg/Library/DebugCommunicationLibSerialPort/DebugCommunicationLibSerialPort.c
+++ b/SourceLevelDebugPkg/Library/DebugCommunicationLibSerialPort/DebugCommunicationLibSerialPort.c
@@ -70,7 +70,7 @@ DebugPortInitialize (
 }\r
 \r
 /**\r
-  Read data from debug device and save the datas in buffer.\r
+  Read data from debug device and save the data in a buffer.\r
 \r
   Reads NumberOfBytes data bytes from a debug device into the buffer\r
   specified by Buffer. The number of bytes actually read is returned.\r

diff --git a/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb/DebugCommunicationLibUsb.c b/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb/DebugCommunicationLibUsb.c
index 479757f5bae2e6efd10a1716e1c154c366f407d9..da55f3e69ef0bd64a7850cedf4c4618b45b49bf3 100644 (file)
--- a/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb/DebugCommunicationLibUsb.c
+++ b/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb/DebugCommunicationLibUsb.c
@@ -768,7 +768,7 @@ InitializeUsbDebugHardware (
 }\r
 \r
 /**\r
-  Read data from debug device and save the datas in buffer.\r
+  Read data from debug device and save the data in a buffer.\r
 \r
   Reads NumberOfBytes data bytes from a debug device into the buffer\r
   specified by Buffer. The number of bytes actually read is returned.\r

diff --git a/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommunicationLibUsb3Internal.h b/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommunicationLibUsb3Internal.h
index c73233ea49b0bd10a4316c336ddc30c22b086d76..cc5f294f334d14f99da6a424fd0cd883337fc7a7 100644 (file)
--- a/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommunicationLibUsb3Internal.h
+++ b/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommunicationLibUsb3Internal.h
@@ -586,7 +586,7 @@ XhcWriteDebugReg (
 /**\r
   Verifies if the bit positions specified by a mask are set in a register.\r
 \r
-  @param[in, out] Register    UNITN register\r
+  @param[in, out] Register    UINTN register\r
   @param[in]      BitMask     32-bit mask\r
 \r
   @return  BOOLEAN  - TRUE  if all bits specified by the mask are enabled.\r

diff --git a/SourceLevelDebugPkg/Library/PeCoffExtraActionLibDebug/Ia32/IntHandlerFuncs.c b/SourceLevelDebugPkg/Library/PeCoffExtraActionLibDebug/Ia32/IntHandlerFuncs.c
index 600bde10d656835fad36507ce7885cea4dc5c685..3e6db0db867911d91a8aa18f0d8c9aa69c403b37 100644 (file)
--- a/SourceLevelDebugPkg/Library/PeCoffExtraActionLibDebug/Ia32/IntHandlerFuncs.c
+++ b/SourceLevelDebugPkg/Library/PeCoffExtraActionLibDebug/Ia32/IntHandlerFuncs.c
@@ -15,7 +15,7 @@
   @param[in]  InterruptType      Interrupt type.\r
 \r
   @retval  TRUE     IDT entries were setup by Debug Agent.\r
-  @retval  FALSE    IDT entries were not setuo by Debug Agent.\r
+  @retval  FALSE    IDT entries were not setup by Debug Agent.\r
 \r
 **/\r
 BOOLEAN\r

diff --git a/SourceLevelDebugPkg/Library/PeCoffExtraActionLibDebug/PeCoffExtraActionLib.h b/SourceLevelDebugPkg/Library/PeCoffExtraActionLibDebug/PeCoffExtraActionLib.h
index 149186b226f4ea591c37ce919cf561235685c549..f428af96323118c396d0633a98b0dc2079819098 100644 (file)
--- a/SourceLevelDebugPkg/Library/PeCoffExtraActionLibDebug/PeCoffExtraActionLib.h
+++ b/SourceLevelDebugPkg/Library/PeCoffExtraActionLibDebug/PeCoffExtraActionLib.h
@@ -34,7 +34,7 @@ extern UINTN  AsmInterruptHandle;
   @param[in]  InterruptType      Interrupt type.\r
 \r
   @retval  TRUE     IDT entries were setup by Debug Agent.\r
-  @retval  FALSE    IDT entries were not setuo by Debug Agent.\r
+  @retval  FALSE    IDT entries were not setup by Debug Agent.\r
 \r
 **/\r
 BOOLEAN\r

diff --git a/SourceLevelDebugPkg/Library/PeCoffExtraActionLibDebug/X64/IntHandlerFuncs.c b/SourceLevelDebugPkg/Library/PeCoffExtraActionLibDebug/X64/IntHandlerFuncs.c
index 952285a8eac0815f12d053855a687d34f3f5ed47..1baa88206b06c163e59512b416238fcb3eee44f1 100644 (file)
--- a/SourceLevelDebugPkg/Library/PeCoffExtraActionLibDebug/X64/IntHandlerFuncs.c
+++ b/SourceLevelDebugPkg/Library/PeCoffExtraActionLibDebug/X64/IntHandlerFuncs.c
@@ -15,7 +15,7 @@
   @param[in]  InterruptType      Interrupt type.\r
 \r
   @retval  TRUE     IDT entries were setup by Debug Agent.\r
-  @retval  FALSE    IDT entries were not setuo by Debug Agent.\r
+  @retval  FALSE    IDT entries were not setup by Debug Agent.\r
 \r
 **/\r
 BOOLEAN\r