From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from linux.microsoft.com (linux.microsoft.com [13.77.154.182]) by mx.groups.io with SMTP id smtpd.web12.12048.1664896780834860185 for ; Tue, 04 Oct 2022 08:19:40 -0700 Authentication-Results: mx.groups.io; dkim=fail reason="body hash did not verify" header.i=@linux.microsoft.com header.s=default header.b=ZEYXeT4J; spf=pass (domain: linux.microsoft.com, ip: 13.77.154.182, mailfrom: mikuback@linux.microsoft.com) Received: from localhost.localdomain (unknown [47.201.8.94]) by linux.microsoft.com (Postfix) with ESMTPSA id E755B20E6F43; Tue, 4 Oct 2022 08:19:39 -0700 (PDT) DKIM-Filter: OpenDKIM Filter v2.11.0 linux.microsoft.com E755B20E6F43 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linux.microsoft.com; s=default; t=1664896780; bh=TdWd5/eFBzlax1FYl6/cVd47Y4gkSnxr8RfyuBgmoIE=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=ZEYXeT4JEy6KueWvvD373C7NHGITyQI9gR9IAm4SKX/MjyKEQHWWupCBacyL1fhuD xtqVnHTlemLxbLRuHiHkojqHBImaFrZANLSOLKqtu30RI0nxFhKg1nrX3/c+XOpSyD lJiaMk+IqcDcX7Lz4nQS+26teWrrhTEEQBD/Q1MA= From: "Michael Kubacki" To: devel@edk2.groups.io Cc: Hao A Wu , Michael D Kinney Subject: [PATCH v1 1/3] SourceLevelDebugPkg: Fix spelling errors Date: Tue, 4 Oct 2022 11:18:56 -0400 Message-Id: <20221004151858.870-2-mikuback@linux.microsoft.com> X-Mailer: git-send-email 2.28.0.windows.1 In-Reply-To: <20221004151858.870-1-mikuback@linux.microsoft.com> References: <20221004151858.870-1-mikuback@linux.microsoft.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable From: Michael Kubacki REF:https://bugzilla.tianocore.org/show_bug.cgi?id=3D4091 Fixes spelling errors in the package so the SpellCheck CI plugin can be enabled. Cc: Hao A Wu Cc: Michael D Kinney Signed-off-by: Michael Kubacki --- SourceLevelDebugPkg/Library/DebugAgent/DebugAgentCommon/DebugAgent.c = | 8 +++---- SourceLevelDebugPkg/Library/DebugAgent/DxeDebugAgent/SerialIo.c = | 22 ++++++++++---------- SourceLevelDebugPkg/Library/DebugCommunicationLibSerialPort/DebugCommuni= cationLibSerialPort.c | 2 +- SourceLevelDebugPkg/Library/DebugCommunicationLibUsb/DebugCommunicationL= ibUsb.c | 2 +- SourceLevelDebugPkg/Library/PeCoffExtraActionLibDebug/Ia32/IntHandlerFun= cs.c | 2 +- SourceLevelDebugPkg/Library/PeCoffExtraActionLibDebug/X64/IntHandlerFunc= s.c | 2 +- SourceLevelDebugPkg/Include/Library/DebugCommunicationLib.h = | 2 +- SourceLevelDebugPkg/Library/DebugAgent/DebugAgentCommon/DebugAgent.h = | 2 +- SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommunication= LibUsb3Internal.h | 2 +- SourceLevelDebugPkg/Library/PeCoffExtraActionLibDebug/PeCoffExtraActionL= ib.h | 2 +- 10 files changed, 23 insertions(+), 23 deletions(-) diff --git a/SourceLevelDebugPkg/Library/DebugAgent/DebugAgentCommon/Debu= gAgent.c b/SourceLevelDebugPkg/Library/DebugAgent/DebugAgentCommon/DebugA= gent.c index a1e61a6ef90e..b553a2a9aa0c 100644 --- a/SourceLevelDebugPkg/Library/DebugAgent/DebugAgentCommon/DebugAgent.= c +++ b/SourceLevelDebugPkg/Library/DebugAgent/DebugAgentCommon/DebugAgent.= c @@ -1,5 +1,5 @@ /** @file - Commond Debug Agent library implementation. It mainly includes + Common 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. @@ -608,7 +608,7 @@ DebugAgentDataMsgPrint ( } =20 /** - Read remaing debug packet except for the start symbol + Read remaining debug packet except for the start symbol =20 @param[in] Handle Pointer to Debug Port handle. @param[in, out] DebugHeader Debug header buffer including start symb= ol. @@ -616,7 +616,7 @@ DebugAgentDataMsgPrint ( @retval EFI_SUCCESS Read the symbol in BreakSymbol. @retval EFI_CRC_ERROR CRC check fail. @retval EFI_TIMEOUT Timeout occurs when reading debug packet. - @retval EFI_DEVICE_ERROR Receive the old or responsed packet. + @retval EFI_DEVICE_ERROR Receive the old or response packet. =20 **/ EFI_STATUS @@ -651,7 +651,7 @@ ReadRemainingBreakPacket ( if (IS_REQUEST (DebugHeader)) { if (DebugHeader->SequenceNo =3D=3D (UINT8)(Mailbox->HostSequenceNo += 1)) { // - // Only updagte HostSequenceNo for new command packet + // Only update HostSequenceNo for new command packet // UpdateMailboxContent (Mailbox, DEBUG_MAILBOX_HOST_SEQUENCE_NO_INDE= X, DebugHeader->SequenceNo); return EFI_SUCCESS; diff --git a/SourceLevelDebugPkg/Library/DebugAgent/DxeDebugAgent/SerialI= o.c b/SourceLevelDebugPkg/Library/DebugAgent/DxeDebugAgent/SerialIo.c index 6661275cc343..97d30c802df4 100644 --- a/SourceLevelDebugPkg/Library/DebugAgent/DxeDebugAgent/SerialIo.c +++ b/SourceLevelDebugPkg/Library/DebugAgent/DxeDebugAgent/SerialIo.c @@ -213,10 +213,10 @@ SERIAL_IO_DEVICE_PATH mSerialIoDevicePath =3D { } }; =20 -#define DEBGU_SERIAL_IO_FIFO_DEPTH 10 +#define DEBUG_SERIAL_IO_FIFO_DEPTH 10 // // Data buffer for Terminal input character and Debug Symbols. -// The depth is DEBGU_SERIAL_IO_FIFO_DEPTH. +// The depth is DEBUG_SERIAL_IO_FIFO_DEPTH. // Fields: // First UINT8: The index of the first data in array Data[]. // Last UINT8: The index, which you can put a new data into arra= y Data[]. @@ -227,7 +227,7 @@ typedef struct { UINT8 First; UINT8 Last; UINT8 Surplus; - UINT8 Data[DEBGU_SERIAL_IO_FIFO_DEPTH]; + UINT8 Data[DEBUG_SERIAL_IO_FIFO_DEPTH]; } DEBUG_SERIAL_FIFO; =20 // @@ -236,10 +236,10 @@ typedef struct { EFI_HANDLE mSerialIoHandle =3D NULL; UINTN mLoopbackBuffer =3D 0; DEBUG_SERIAL_FIFO mSerialFifoForTerminal =3D { - 0, 0, DEBGU_SERIAL_IO_FIFO_DEPTH, { 0 } + 0, 0, DEBUG_SERIAL_IO_FIFO_DEPTH, { 0 } }; DEBUG_SERIAL_FIFO mSerialFifoForDebug =3D { - 0, 0, DEBGU_SERIAL_IO_FIFO_DEPTH, { 0 } + 0, 0, DEBUG_SERIAL_IO_FIFO_DEPTH, { 0 } }; =20 /** @@ -251,11 +251,11 @@ DEBUG_SERIAL_FIFO mSerialFifoForDebug =3D { =20 **/ BOOLEAN -IsDebugTermianlFifoEmpty ( +IsDebugTerminalFifoEmpty ( IN DEBUG_SERIAL_FIFO *Fifo ) { - if (Fifo->Surplus =3D=3D DEBGU_SERIAL_IO_FIFO_DEPTH) { + if (Fifo->Surplus =3D=3D DEBUG_SERIAL_IO_FIFO_DEPTH) { return TRUE; } =20 @@ -313,7 +313,7 @@ DebugTerminalFifoAdd ( Fifo->Data[Fifo->Last] =3D Data; Fifo->Surplus--; Fifo->Last++; - if (Fifo->Last =3D=3D DEBGU_SERIAL_IO_FIFO_DEPTH) { + if (Fifo->Last =3D=3D DEBUG_SERIAL_IO_FIFO_DEPTH) { Fifo->Last =3D 0; } =20 @@ -339,7 +339,7 @@ DebugTerminalFifoRemove ( // // if FIFO is empty, no data can remove // - if (IsDebugTermianlFifoEmpty (Fifo)) { + if (IsDebugTerminalFifoEmpty (Fifo)) { return EFI_OUT_OF_RESOURCES; } =20 @@ -349,7 +349,7 @@ DebugTerminalFifoRemove ( *Data =3D Fifo->Data[Fifo->First]; Fifo->Surplus++; Fifo->First++; - if (Fifo->First =3D=3D DEBGU_SERIAL_IO_FIFO_DEPTH) { + if (Fifo->First =3D=3D DEBUG_SERIAL_IO_FIFO_DEPTH) { Fifo->First =3D 0; } =20 @@ -532,7 +532,7 @@ SerialGetControl ( // Check to see if the Terminal FIFO is empty and // check to see if the input buffer in the Debug Communication Library= is empty // - if (!IsDebugTermianlFifoEmpty (&mSerialFifoForTerminal) || DebugPortPo= llBuffer (Handle)) { + if (!IsDebugTerminalFifoEmpty (&mSerialFifoForTerminal) || DebugPortPo= llBuffer (Handle)) { *Control &=3D ~EFI_SERIAL_INPUT_BUFFER_EMPTY; } =20 diff --git a/SourceLevelDebugPkg/Library/DebugCommunicationLibSerialPort/= DebugCommunicationLibSerialPort.c b/SourceLevelDebugPkg/Library/DebugComm= unicationLibSerialPort/DebugCommunicationLibSerialPort.c index 34c269e6b527..9953904725ac 100644 --- a/SourceLevelDebugPkg/Library/DebugCommunicationLibSerialPort/DebugCo= mmunicationLibSerialPort.c +++ b/SourceLevelDebugPkg/Library/DebugCommunicationLibSerialPort/DebugCo= mmunicationLibSerialPort.c @@ -70,7 +70,7 @@ DebugPortInitialize ( } =20 /** - Read data from debug device and save the datas in buffer. + Read data from debug device and save the data in a buffer. =20 Reads NumberOfBytes data bytes from a debug device into the buffer specified by Buffer. The number of bytes actually read is returned. diff --git a/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb/DebugCo= mmunicationLibUsb.c b/SourceLevelDebugPkg/Library/DebugCommunicationLibUs= b/DebugCommunicationLibUsb.c index 479757f5bae2..da55f3e69ef0 100644 --- a/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb/DebugCommunica= tionLibUsb.c +++ b/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb/DebugCommunica= tionLibUsb.c @@ -768,7 +768,7 @@ InitializeUsbDebugHardware ( } =20 /** - Read data from debug device and save the datas in buffer. + Read data from debug device and save the data in a buffer. =20 Reads NumberOfBytes data bytes from a debug device into the buffer specified by Buffer. The number of bytes actually read is returned. diff --git a/SourceLevelDebugPkg/Library/PeCoffExtraActionLibDebug/Ia32/I= ntHandlerFuncs.c b/SourceLevelDebugPkg/Library/PeCoffExtraActionLibDebug/= Ia32/IntHandlerFuncs.c index 600bde10d656..3e6db0db8679 100644 --- a/SourceLevelDebugPkg/Library/PeCoffExtraActionLibDebug/Ia32/IntHandl= erFuncs.c +++ b/SourceLevelDebugPkg/Library/PeCoffExtraActionLibDebug/Ia32/IntHandl= erFuncs.c @@ -15,7 +15,7 @@ @param[in] InterruptType Interrupt type. =20 @retval TRUE IDT entries were setup by Debug Agent. - @retval FALSE IDT entries were not setuo by Debug Agent. + @retval FALSE IDT entries were not setup by Debug Agent. =20 **/ BOOLEAN diff --git a/SourceLevelDebugPkg/Library/PeCoffExtraActionLibDebug/X64/In= tHandlerFuncs.c b/SourceLevelDebugPkg/Library/PeCoffExtraActionLibDebug/X= 64/IntHandlerFuncs.c index 952285a8eac0..1baa88206b06 100644 --- a/SourceLevelDebugPkg/Library/PeCoffExtraActionLibDebug/X64/IntHandle= rFuncs.c +++ b/SourceLevelDebugPkg/Library/PeCoffExtraActionLibDebug/X64/IntHandle= rFuncs.c @@ -15,7 +15,7 @@ @param[in] InterruptType Interrupt type. =20 @retval TRUE IDT entries were setup by Debug Agent. - @retval FALSE IDT entries were not setuo by Debug Agent. + @retval FALSE IDT entries were not setup by Debug Agent. =20 **/ BOOLEAN diff --git a/SourceLevelDebugPkg/Include/Library/DebugCommunicationLib.h = b/SourceLevelDebugPkg/Include/Library/DebugCommunicationLib.h index ad7bccda285c..ebb2168632da 100644 --- a/SourceLevelDebugPkg/Include/Library/DebugCommunicationLib.h +++ b/SourceLevelDebugPkg/Include/Library/DebugCommunicationLib.h @@ -71,7 +71,7 @@ DebugPortInitialize ( ); =20 /** - Read data from debug device and save the datas in buffer. + Read data from debug device and save the data in a buffer. =20 Reads NumberOfBytes data bytes from a debug device into the buffer specified by Buffer. The number of bytes actually read is returned. diff --git a/SourceLevelDebugPkg/Library/DebugAgent/DebugAgentCommon/Debu= gAgent.h b/SourceLevelDebugPkg/Library/DebugAgent/DebugAgentCommon/DebugA= gent.h index a0ede308efee..4c72f8f3a90c 100644 --- a/SourceLevelDebugPkg/Library/DebugAgent/DebugAgentCommon/DebugAgent.= h +++ b/SourceLevelDebugPkg/Library/DebugAgent/DebugAgentCommon/DebugAgent.= h @@ -452,7 +452,7 @@ DebugAgentDataMsgPrint ( ); =20 /** - Read remaing debug packet except for the start symbol + Read remaining debug packet except for the start symbol =20 @param[in] Handle Pointer to Debug Port handle. @param[in, out] DebugHeader Debug header buffer including start symb= ol. diff --git a/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugC= ommunicationLibUsb3Internal.h b/SourceLevelDebugPkg/Library/DebugCommunic= ationLibUsb3/DebugCommunicationLibUsb3Internal.h index c73233ea49b0..cc5f294f334d 100644 --- a/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommunic= ationLibUsb3Internal.h +++ b/SourceLevelDebugPkg/Library/DebugCommunicationLibUsb3/DebugCommunic= ationLibUsb3Internal.h @@ -586,7 +586,7 @@ XhcWriteDebugReg ( /** Verifies if the bit positions specified by a mask are set in a registe= r. =20 - @param[in, out] Register UNITN register + @param[in, out] Register UINTN register @param[in] BitMask 32-bit mask =20 @return BOOLEAN - TRUE if all bits specified by the mask are enable= d. diff --git a/SourceLevelDebugPkg/Library/PeCoffExtraActionLibDebug/PeCoff= ExtraActionLib.h b/SourceLevelDebugPkg/Library/PeCoffExtraActionLibDebug/= PeCoffExtraActionLib.h index 149186b226f4..f428af963231 100644 --- a/SourceLevelDebugPkg/Library/PeCoffExtraActionLibDebug/PeCoffExtraAc= tionLib.h +++ b/SourceLevelDebugPkg/Library/PeCoffExtraActionLibDebug/PeCoffExtraAc= tionLib.h @@ -34,7 +34,7 @@ extern UINTN AsmInterruptHandle; @param[in] InterruptType Interrupt type. =20 @retval TRUE IDT entries were setup by Debug Agent. - @retval FALSE IDT entries were not setuo by Debug Agent. + @retval FALSE IDT entries were not setup by Debug Agent. =20 **/ BOOLEAN --=20 2.28.0.windows.1