From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from us-smtp-1.mimecast.com (us-smtp-1.mimecast.com [207.211.31.120]) by mx.groups.io with SMTP id smtpd.web11.8432.1575389876123297169 for ; Tue, 03 Dec 2019 08:17:56 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@redhat.com header.s=mimecast20190719 header.b=VjtYo2gO; spf=pass (domain: redhat.com, ip: 207.211.31.120, mailfrom: philmd@redhat.com) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1575389875; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=VULMkwSpOgUy5qLc1u79SQxD6BoqFO1r4jGumO3PrAI=; b=VjtYo2gOEYd2Qp6Wo0Jb+RlK4jw6zCZXwktSC5Vxid+0OP3sTVe6rDZalmic29LOK4rZnN cyNickwfgrVlrTEo/yIDWnQ+bAfxFOiNqEprO+rUEndxP9G17n8XEAsSUq6wjx34A6F0xb RzCJo24LVbAH5jaL9kwl9nl8dUfN7nM= Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-103-ME4R5gkdMG-GwWZpRzBzPA-1; Tue, 03 Dec 2019 11:17:54 -0500 Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id B112518AAFA4; Tue, 3 Dec 2019 16:17:52 +0000 (UTC) Received: from x1w.redhat.com (ovpn-204-86.brq.redhat.com [10.40.204.86]) by smtp.corp.redhat.com (Postfix) with ESMTPS id E88BA60C63; Tue, 3 Dec 2019 16:17:50 +0000 (UTC) From: =?UTF-8?B?UGhpbGlwcGUgTWF0aGlldS1EYXVkw6k=?= To: devel@edk2.groups.io Cc: Antoine Coeur , Michael D Kinney , Liming Gao , Philippe Mathieu-Daude Subject: [PATCH 28/79] MdePkg/Library/Smm: Fix various typos Date: Tue, 3 Dec 2019 17:15:11 +0100 Message-Id: <20191203161602.15969-29-philmd@redhat.com> In-Reply-To: <20191203161602.15969-1-philmd@redhat.com> References: <20191203161602.15969-1-philmd@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 X-MC-Unique: ME4R5gkdMG-GwWZpRzBzPA-1 X-Mimecast-Spam-Score: 0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable From: Antoine Coeur Fix various typos in comments and documentation. Cc: Michael D Kinney Cc: Liming Gao Reviewed-by: Philippe Mathieu-Daude Signed-off-by: Philippe Mathieu-Daude --- MdePkg/Include/Library/SmmLib.h | 4 +- MdePkg/Include/Library/SmmMemLib.h | 4 +- MdePkg/Include/Library/SmmPeriodicSmiLib.h | 6 +-- MdePkg/Library/SmmMemLib/SmmMemLib.c | 4 +- MdePkg/Library/SmmPciExpressLib/PciExpressLib.c | 4 +- MdePkg/Library/SmmPciLibPciRootBridgeIo/PciLib.c | 6 +-- MdePkg/Library/SmmPeriodicSmiLib/SmmPeriodicSmiLib.c | 42 ++++++++++--= -------- MdePkg/Library/SmmServicesTableLib/SmmServicesTableLib.c | 2 +- 8 files changed, 36 insertions(+), 36 deletions(-) diff --git a/MdePkg/Include/Library/SmmLib.h b/MdePkg/Include/Library/SmmLi= b.h index 8d83df7fd737..bcb7045c1b65 100644 --- a/MdePkg/Include/Library/SmmLib.h +++ b/MdePkg/Include/Library/SmmLib.h @@ -45,7 +45,7 @@ TriggerRuntimeSoftwareSmi ( it was triggered at boot time, it returns TRUE. Otherwise, it returns FA= LSE. =20 @retval TRUE A software SMI triggered at boot time happened. - @retval FLASE No software SMI happened, or the software SMI was trigger= ed at run time. + @retval FALSE No software SMI happened, or the software SMI was trigger= ed at run time. =20 **/ BOOLEAN @@ -62,7 +62,7 @@ IsBootServiceSoftwareSmi ( it was triggered at run time, it returns TRUE. Otherwise, it returns FAL= SE. =20 @retval TRUE A software SMI triggered at run time happened. - @retval FLASE No software SMI happened or the software SMI was triggere= d at boot time. + @retval FALSE No software SMI happened or the software SMI was triggere= d at boot time. =20 **/ BOOLEAN diff --git a/MdePkg/Include/Library/SmmMemLib.h b/MdePkg/Include/Library/Sm= mMemLib.h index 72edc9adcde7..d92cbd9aabd2 100644 --- a/MdePkg/Include/Library/SmmMemLib.h +++ b/MdePkg/Include/Library/SmmMemLib.h @@ -67,7 +67,7 @@ SmmCopyMemToSmram ( @param SourceBuffer The pointer to the source buffer of the memo= ry copy. @param Length The number of bytes to copy from SourceBuffe= r to DestinationBuffer. =20 - @retval EFI_SECURITY_VIOLATION The DesinationBuffer is invalid per proce= ssor architecture or overlap with SMRAM. + @retval EFI_SECURITY_VIOLATION The DestinationBuffer is invalid per proc= essor architecture or overlap with SMRAM. @retval EFI_SUCCESS Memory is copied. =20 **/ @@ -92,7 +92,7 @@ SmmCopyMemFromSmram ( @param SourceBuffer The pointer to the source buffer of the memo= ry copy. @param Length The number of bytes to copy from SourceBuffe= r to DestinationBuffer. =20 - @retval EFI_SECURITY_VIOLATION The DesinationBuffer is invalid per proce= ssor architecture or overlap with SMRAM. + @retval EFI_SECURITY_VIOLATION The DestinationBuffer is invalid per proc= essor architecture or overlap with SMRAM. @retval EFI_SECURITY_VIOLATION The SourceBuffer is invalid per processor= architecture or overlap with SMRAM. @retval EFI_SUCCESS Memory is copied. =20 diff --git a/MdePkg/Include/Library/SmmPeriodicSmiLib.h b/MdePkg/Include/Li= brary/SmmPeriodicSmiLib.h index 6215aa2232ac..a3e086d02501 100644 --- a/MdePkg/Include/Library/SmmPeriodicSmiLib.h +++ b/MdePkg/Include/Library/SmmPeriodicSmiLib.h @@ -64,7 +64,7 @@ PeriodicSmiExit ( This function yields control back to the SMM Foundation. When the next periodic SMI for the currently executing handler is triggered, the perio= dic SMI handler will be resumed and this function will return. Use of this - function requires a seperate stack for the periodic SMI handler. A non = zero + function requires a separate stack for the periodic SMI handler. A non = zero stack size must be specified in PeriodicSmiEnable() for this function to= be used. =20 @@ -113,7 +113,7 @@ VOID @param[in] DispatchFunction A pointer to a periodic SMI handler fun= ction. @param[in] Context Optional content to pass into DispatchF= unction. @param[in] TickPeriod The requested tick period in 100ns unit= s that - control should be givien to the periodi= c SMI + control should be given to the periodic= SMI handler. Must be one of the supported = values returned by PeriodicSmiSupportedPickPer= iod(). @param[in] Cpu Specifies the CPU that is required to e= xecute @@ -137,7 +137,7 @@ VOID @retval EFI_OUT_OF_RESOURCES There are not enough resources to enable = the periodic SMI handler. @retval EFI_OUT_OF_RESOURCES There are not enough resources to allocat= e the - stack speficied by StackSize. + stack specified by StackSize. @retval EFI_SUCCESS The periodic SMI handler was enabled. =20 **/ diff --git a/MdePkg/Library/SmmMemLib/SmmMemLib.c b/MdePkg/Library/SmmMemLi= b/SmmMemLib.c index 7169bbdd10d8..63a4ff7a97f1 100644 --- a/MdePkg/Library/SmmMemLib/SmmMemLib.c +++ b/MdePkg/Library/SmmMemLib/SmmMemLib.c @@ -275,7 +275,7 @@ SmmCopyMemToSmram ( @param SourceBuffer The pointer to the source buffer of the memo= ry copy. @param Length The number of bytes to copy from SourceBuffe= r to DestinationBuffer. =20 - @retval EFI_SECURITY_VIOLATION The DesinationBuffer is invalid per proce= ssor architecture or overlap with SMRAM. + @retval EFI_SECURITY_VIOLATION The DestinationBuffer is invalid per proc= essor architecture or overlap with SMRAM. @retval EFI_SUCCESS Memory is copied. =20 **/ @@ -308,7 +308,7 @@ SmmCopyMemFromSmram ( @param SourceBuffer The pointer to the source buffer of the memo= ry copy. @param Length The number of bytes to copy from SourceBuffe= r to DestinationBuffer. =20 - @retval EFI_SECURITY_VIOLATION The DesinationBuffer is invalid per proce= ssor architecture or overlap with SMRAM. + @retval EFI_SECURITY_VIOLATION The DestinationBuffer is invalid per proc= essor architecture or overlap with SMRAM. @retval EFI_SECURITY_VIOLATION The SourceBuffer is invalid per processor= architecture or overlap with SMRAM. @retval EFI_SUCCESS Memory is copied. =20 diff --git a/MdePkg/Library/SmmPciExpressLib/PciExpressLib.c b/MdePkg/Libra= ry/SmmPciExpressLib/PciExpressLib.c index 80c0154f5fad..35b9f775a80b 100644 --- a/MdePkg/Library/SmmPciExpressLib/PciExpressLib.c +++ b/MdePkg/Library/SmmPciExpressLib/PciExpressLib.c @@ -1226,7 +1226,7 @@ PciExpressBitFieldAndThenOr32 ( Size into the buffer specified by Buffer. This function only allows the P= CI configuration registers from a single PCI function to be read. Size is returned. When possible 32-bit PCI configuration read cycles are used to = read - from StartAdress to StartAddress + Size. Due to alignment restrictions, 8= -bit + from StartAddress to StartAddress + Size. Due to alignment restrictions, = 8-bit and 16-bit PCI configuration read cycles may be used at the beginning and= the end of the range. =20 @@ -1329,7 +1329,7 @@ PciExpressReadBuffer ( Size from the buffer specified by Buffer. This function only allows the P= CI configuration registers from a single PCI function to be written. Size is returned. When possible 32-bit PCI configuration write cycles are used to - write from StartAdress to StartAddress + Size. Due to alignment restricti= ons, + write from StartAddress to StartAddress + Size. Due to alignment restrict= ions, 8-bit and 16-bit PCI configuration write cycles may be used at the beginn= ing and the end of the range. =20 diff --git a/MdePkg/Library/SmmPciLibPciRootBridgeIo/PciLib.c b/MdePkg/Libr= ary/SmmPciLibPciRootBridgeIo/PciLib.c index c9660f48d700..49ea99ce1f05 100644 --- a/MdePkg/Library/SmmPciLibPciRootBridgeIo/PciLib.c +++ b/MdePkg/Library/SmmPciLibPciRootBridgeIo/PciLib.c @@ -35,7 +35,7 @@ ((((A) << 4) & 0xff000000) | (((A) >> 4) & 0x00000700) | (((A) << 1) & 0= x001f0000) | (LShiftU64((A) & 0xfff, 32))) =20 // -// Global varible to cache pointer to PCI Root Bridge I/O protocol. +// Global variable to cache pointer to PCI Root Bridge I/O protocol. // EFI_SMM_PCI_ROOT_BRIDGE_IO_PROTOCOL *mSmmPciRootBridgeIo =3D NULL; =20 @@ -1238,7 +1238,7 @@ PciBitFieldAndThenOr32 ( Size into the buffer specified by Buffer. This function only allows the = PCI configuration registers from a single PCI function to be read. Size is returned. When possible 32-bit PCI configuration read cycles are used to= read - from StartAdress to StartAddress + Size. Due to alignment restrictions, = 8-bit + from StartAddress to StartAddress + Size. Due to alignment restrictions,= 8-bit and 16-bit PCI configuration read cycles may be used at the beginning an= d the end of the range. =20 @@ -1336,7 +1336,7 @@ PciReadBuffer ( Size from the buffer specified by Buffer. This function only allows the = PCI configuration registers from a single PCI function to be written. Size i= s returned. When possible 32-bit PCI configuration write cycles are used t= o - write from StartAdress to StartAddress + Size. Due to alignment restrict= ions, + write from StartAddress to StartAddress + Size. Due to alignment restric= tions, 8-bit and 16-bit PCI configuration write cycles may be used at the begin= ning and the end of the range. =20 diff --git a/MdePkg/Library/SmmPeriodicSmiLib/SmmPeriodicSmiLib.c b/MdePkg/= Library/SmmPeriodicSmiLib/SmmPeriodicSmiLib.c index ba01910b696b..8b1e780b76db 100644 --- a/MdePkg/Library/SmmPeriodicSmiLib/SmmPeriodicSmiLib.c +++ b/MdePkg/Library/SmmPeriodicSmiLib/SmmPeriodicSmiLib.c @@ -107,8 +107,8 @@ typedef struct { UINT64 DispatchTotalTime; /// /// The performance counter value that was captured the last time that t= he - /// periodic SMI handler called PeriodcSmiExecutionTime(). This allows = the - /// time value returned by PeriodcSmiExecutionTime() to be accurate even= when + /// periodic SMI handler called PeriodicSmiExecutionTime(). This allows= the + /// time value returned by PeriodicSmiExecutionTime() to be accurate eve= n when /// the performance counter rolls over. /// UINT64 DispatchCheckPointTime; @@ -127,7 +127,7 @@ typedef struct { /// /// Buffer used to save the context when a periodic SMI handler requests= to /// yield using PeriodicSmiYield(). This context is used to resume the - /// execution of a periodic SMI handler the next time control is transfe= rd + /// execution of a periodic SMI handler the next time control is transfe= rred /// to the periodic SMI handler that yielded. /// BASE_LIBRARY_JUMP_BUFFER YieldJumpBuffer; @@ -152,7 +152,7 @@ typedef struct { ) =20 /// -/// Pointer to the SMM Periodic Timer Disatch Protocol that was located in= the constuctor. +/// Pointer to the SMM Periodic Timer Dispatch Protocol that was located i= n the constructor. /// EFI_SMM_PERIODIC_TIMER_DISPATCH2_PROTOCOL *gSmmPeriodicTimerDispatch2 = =3D NULL; =20 @@ -522,7 +522,7 @@ PeriodicSmiExit ( This function yields control back to the SMM Foundation. When the next periodic SMI for the currently executing handler is triggered, the perio= dic SMI handler will be resumed and this function will return. Use of this - function requires a seperate stack for the periodic SMI handler. A non = zero + function requires a separate stack for the periodic SMI handler. A non = zero stack size must be specified in PeriodicSmiEnable() for this function to= be used. =20 @@ -572,7 +572,7 @@ PeriodicSmiYield ( SetJumpFlag =3D SetJump (&PeriodicSmiLibraryHandler->YieldJumpBuffer); if (SetJumpFlag =3D=3D 0) { // - // The intial call to SetJump() always returns 0. + // The initial call to SetJump() always returns 0. // If this is the initial call, then exit the current periodic SMI han= dler // PeriodicSmiExit (); @@ -588,7 +588,7 @@ PeriodicSmiYield ( PeriodicSmiLibraryHandler->YieldFlag =3D FALSE; =20 // - // Return the amount elapsed time that occured while yielded + // Return the amount elapsed time that occurred while yielded // return PeriodicSmiLibraryHandler->ElapsedTime; } @@ -620,7 +620,7 @@ PeriodicSmiDispatchFunctionSwitchStack ( // // Dispatch the registered handler passing in the context that was regis= tered // and the amount of time that has elapsed since the previous time this - // periodic SMI handler was dispacthed. + // periodic SMI handler was dispatched. // PeriodicSmiLibraryHandler->DispatchFunction ( PeriodicSmiLibraryHandler->Context, @@ -628,16 +628,16 @@ PeriodicSmiDispatchFunctionSwitchStack ( ); =20 // - // If this DispatchFunction() returns, then unconditially call PeriodicS= miExit() + // If this DispatchFunction() returns, then unconditionally call Periodi= cSmiExit() // to perform a LongJump() back to PeriodicSmiDispatchFunctionOnCpu(). T= he - // LongJump() will resume exection on the original stack. + // LongJump() will resume execution on the original stack. // PeriodicSmiExit (); } =20 /** Internal worker function that transfers control to an enabled periodic S= MI - handler on the specified logial CPU. This function determines if the pe= riodic + handler on the specified logical CPU. This function determines if the p= eriodic SMI handler yielded and needs to be resumed. It also and switches to an allocated stack if one was allocated in PeriodicSmiEnable(). =20 @@ -652,9 +652,9 @@ PeriodicSmiDispatchFunctionOnCpu ( ) { // - // Save context in DispatchJumpBuffer. The intial call to SetJump() alw= ays + // Save context in DispatchJumpBuffer. The initial call to SetJump() al= ways // returns 0. If this is the initial call, then either resume from a pr= ior - // call to PeriodicSmiYield() or call the DispatchFunction registerd in + // call to PeriodicSmiYield() or call the DispatchFunction registered in // PeriodicSmiEnable() using an allocated stack if one was specified. // if (SetJump (&PeriodicSmiLibraryHandler->DispatchJumpBuffer) !=3D 0) { @@ -679,7 +679,7 @@ PeriodicSmiDispatchFunctionOnCpu ( // // If Stack is NULL then call DispatchFunction using current stack pas= sing // in the context that was registered and the amount of time that has - // elapsed since the previous time this periodic SMI handler was dispa= cthed. + // elapsed since the previous time this periodic SMI handler was dispa= tched. // PeriodicSmiLibraryHandler->DispatchFunction ( PeriodicSmiLibraryHandler->Context, @@ -687,7 +687,7 @@ PeriodicSmiDispatchFunctionOnCpu ( ); =20 // - // If this DispatchFunction() returns, then unconditially call Periodi= cSmiExit() + // If this DispatchFunction() returns, then unconditionally call Perio= dicSmiExit() // to perform a LongJump() back to this function. // PeriodicSmiExit (); @@ -712,7 +712,7 @@ PeriodicSmiDispatchFunctionOnCpu ( =20 /** Internal worker function that transfers control to an enabled periodic S= MI - handler on the specified logial CPU. This worker function is only calle= d + handler on the specified logical CPU. This worker function is only call= ed using the SMM Services Table function SmmStartupThisAp() to execute the periodic SMI handler on a logical CPU that is different than the one tha= t is running the SMM Foundation. When the periodic SMI handler returns, a lo= ck is @@ -736,7 +736,7 @@ PeriodicSmiDispatchFunctionWithLock ( PeriodicSmiLibraryHandler =3D (PERIODIC_SMI_LIBRARY_HANDLER_CONTEXT *)B= uffer; =20 // - // Execute dispatch function on the currently excuting logical CPU + // Execute dispatch function on the currently executing logical CPU // PeriodicSmiDispatchFunctionOnCpu (PeriodicSmiLibraryHandler); =20 @@ -805,7 +805,7 @@ PeriodicSmiDispatchFunction ( (PeriodicSmiLibraryHandler->Cpu =3D=3D gSmst->CurrentlyExecutingCpu)= ) { // // Dispatch on the currently execution CPU if the CPU specified in Per= iodicSmiEnable() - // was PERIODIC_SMI_LIBARRY_ANY_CPU or the currently executing CPU mat= ches the CPU + // was PERIODIC_SMI_LIBRARY_ANY_CPU or the currently executing CPU mat= ches the CPU // that was specified in PeriodicSmiEnable(). // PeriodicSmiDispatchFunctionOnCpu (PeriodicSmiLibraryHandler); @@ -867,7 +867,7 @@ PeriodicSmiDispatchFunction ( @param[in] DispatchFunction A pointer to a periodic SMI handler fun= ction. @param[in] Context Optional content to pass into DispatchF= unction. @param[in] TickPeriod The requested tick period in 100ns unit= s that - control should be givien to the periodi= c SMI + control should be given to the periodic= SMI handler. Must be one of the supported = values returned by PeriodicSmiSupportedPickPer= iod(). @param[in] Cpu Specifies the CPU that is required to e= xecute @@ -891,7 +891,7 @@ PeriodicSmiDispatchFunction ( @retval EFI_OUT_OF_RESOURCES There are not enough resources to enable = the periodic SMI handler. @retval EFI_OUT_OF_RESOURCES There are not enough resources to allocat= e the - stack speficied by StackSize. + stack specified by StackSize. @retval EFI_SUCCESS The periodic SMI handler was enabled. =20 **/ @@ -1077,7 +1077,7 @@ SmmPeriodicSmiLibConstructor ( =20 // // Count the number of periodic SMI tick intervals that the SMM Periodic= Timer - // Dipatch 2 Protocol supports. + // Dispatch 2 Protocol supports. // SmiTickInterval =3D NULL; Count =3D 0; diff --git a/MdePkg/Library/SmmServicesTableLib/SmmServicesTableLib.c b/Mde= Pkg/Library/SmmServicesTableLib/SmmServicesTableLib.c index d95e9d473790..0f611cd25df7 100644 --- a/MdePkg/Library/SmmServicesTableLib/SmmServicesTableLib.c +++ b/MdePkg/Library/SmmServicesTableLib/SmmServicesTableLib.c @@ -36,7 +36,7 @@ SmmServicesTableLibConstructor ( // // Retrieve SMM Base2 Protocol, Do not use gBS from UefiBootServicesTab= leLib on purpose // to prevent inclusion of gBS, gST, and gImageHandle from SMM Drivers u= nless the - // SMM driver explicity declares that dependency. + // SMM driver explicitly declares that dependency. // Status =3D SystemTable->BootServices->LocateProtocol ( &gEfiSmmBase2ProtocolGuid, --=20 2.21.0