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>
This commit is contained in:
Michael Kubacki
2022-10-04 10:55:27 -04:00
committed by mergify[bot]
parent 1bd2ff1866
commit d6d4a81f8a
10 changed files with 23 additions and 23 deletions

View File

@ -71,7 +71,7 @@ DebugPortInitialize (
); );
/** /**
Read data from debug device and save the datas in buffer. Read data from debug device and save the data in a buffer.
Reads NumberOfBytes data bytes from a debug device into the buffer Reads NumberOfBytes data bytes from a debug device into the buffer
specified by Buffer. The number of bytes actually read is returned. specified by Buffer. The number of bytes actually read is returned.

View File

@ -1,5 +1,5 @@
/** @file /** @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, the first C function called by exception/interrupt handlers,
read/write debug packet to communication with HOST based on transfer read/write debug packet to communication with HOST based on transfer
protocol. protocol.
@ -608,7 +608,7 @@ DebugAgentDataMsgPrint (
} }
/** /**
Read remaing debug packet except for the start symbol Read remaining debug packet except for the start symbol
@param[in] Handle Pointer to Debug Port handle. @param[in] Handle Pointer to Debug Port handle.
@param[in, out] DebugHeader Debug header buffer including start symbol. @param[in, out] DebugHeader Debug header buffer including start symbol.
@ -616,7 +616,7 @@ DebugAgentDataMsgPrint (
@retval EFI_SUCCESS Read the symbol in BreakSymbol. @retval EFI_SUCCESS Read the symbol in BreakSymbol.
@retval EFI_CRC_ERROR CRC check fail. @retval EFI_CRC_ERROR CRC check fail.
@retval EFI_TIMEOUT Timeout occurs when reading debug packet. @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.
**/ **/
EFI_STATUS EFI_STATUS
@ -651,7 +651,7 @@ ReadRemainingBreakPacket (
if (IS_REQUEST (DebugHeader)) { if (IS_REQUEST (DebugHeader)) {
if (DebugHeader->SequenceNo == (UINT8)(Mailbox->HostSequenceNo + 1)) { if (DebugHeader->SequenceNo == (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_INDEX, DebugHeader->SequenceNo); UpdateMailboxContent (Mailbox, DEBUG_MAILBOX_HOST_SEQUENCE_NO_INDEX, DebugHeader->SequenceNo);
return EFI_SUCCESS; return EFI_SUCCESS;

View File

@ -452,7 +452,7 @@ DebugAgentDataMsgPrint (
); );
/** /**
Read remaing debug packet except for the start symbol Read remaining debug packet except for the start symbol
@param[in] Handle Pointer to Debug Port handle. @param[in] Handle Pointer to Debug Port handle.
@param[in, out] DebugHeader Debug header buffer including start symbol. @param[in, out] DebugHeader Debug header buffer including start symbol.

View File

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

View File

@ -70,7 +70,7 @@ DebugPortInitialize (
} }
/** /**
Read data from debug device and save the datas in buffer. Read data from debug device and save the data in a buffer.
Reads NumberOfBytes data bytes from a debug device into the buffer Reads NumberOfBytes data bytes from a debug device into the buffer
specified by Buffer. The number of bytes actually read is returned. specified by Buffer. The number of bytes actually read is returned.

View File

@ -768,7 +768,7 @@ InitializeUsbDebugHardware (
} }
/** /**
Read data from debug device and save the datas in buffer. Read data from debug device and save the data in a buffer.
Reads NumberOfBytes data bytes from a debug device into the buffer Reads NumberOfBytes data bytes from a debug device into the buffer
specified by Buffer. The number of bytes actually read is returned. specified by Buffer. The number of bytes actually read is returned.

View File

@ -586,7 +586,7 @@ XhcWriteDebugReg (
/** /**
Verifies if the bit positions specified by a mask are set in a register. Verifies if the bit positions specified by a mask are set in a register.
@param[in, out] Register UNITN register @param[in, out] Register UINTN register
@param[in] BitMask 32-bit mask @param[in] BitMask 32-bit mask
@return BOOLEAN - TRUE if all bits specified by the mask are enabled. @return BOOLEAN - TRUE if all bits specified by the mask are enabled.

View File

@ -15,7 +15,7 @@
@param[in] InterruptType Interrupt type. @param[in] InterruptType Interrupt type.
@retval TRUE IDT entries were setup by Debug Agent. @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.
**/ **/
BOOLEAN BOOLEAN

View File

@ -34,7 +34,7 @@ extern UINTN AsmInterruptHandle;
@param[in] InterruptType Interrupt type. @param[in] InterruptType Interrupt type.
@retval TRUE IDT entries were setup by Debug Agent. @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.
**/ **/
BOOLEAN BOOLEAN

View File

@ -15,7 +15,7 @@
@param[in] InterruptType Interrupt type. @param[in] InterruptType Interrupt type.
@retval TRUE IDT entries were setup by Debug Agent. @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.
**/ **/
BOOLEAN BOOLEAN