From nobody Sun May 5 02:11:29 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of groups.io designates 66.175.222.12 as permitted sender) client-ip=66.175.222.12; envelope-from=bounce+27952+42573+1787277+3901457@groups.io; helo=web01.groups.io; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zoho.com: domain of groups.io designates 66.175.222.12 as permitted sender) smtp.mailfrom=bounce+27952+42573+1787277+3901457@groups.io; dmarc=fail(p=none dis=none) header.from=intel.com ARC-Seal: i=1; a=rsa-sha256; t=1560923489; cv=none; d=zoho.com; s=zohoarc; b=acR6goWmu340ntp0kchaZsnMNDenZPztx1uoFmiJa5Suzy3mI9KKyWJ9AcQ3MXnx2DrXS0R96InIO6x3NEgkHKiCHkTfZeJZtkSkJSI8PaG0cYhz8G0wZUcMnjH8TEk+R8DoegnyYNN7Rfmh+/TWgbxkcjp/2zr9beDrdwrEOX8= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1560923489; h=Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Id:List-Unsubscribe:MIME-Version:Message-ID:Reply-To:References:Sender:Subject:To:ARC-Authentication-Results; bh=2/llxRTzb0xSAD1lGst/rUrFsD0GKVpekt684OxfUlo=; b=gD5cgs6bimTph2QXi4gqHpczrLqd++GzhVFTKMVTUb5OB9ZRaGFWCNq/Ky5q/BW1nVaCs9qET5DaiFxwmExdvt3s4Y8NOD6Eb4DNOlFpVY/3rhS7xtfZ3ULPVaZjtjpp7SVdd7JHXl/+XsDH2TWG8Dcn/LAUdOJbotvKTp5WJnA= ARC-Authentication-Results: i=1; mx.zoho.com; dkim=pass; spf=pass (zoho.com: domain of groups.io designates 66.175.222.12 as permitted sender) smtp.mailfrom=bounce+27952+42573+1787277+3901457@groups.io; dmarc=fail header.from= (p=none dis=none) header.from= Received: from web01.groups.io (web01.groups.io [66.175.222.12]) by mx.zohomail.com with SMTPS id 1560923489769474.7372038578404; Tue, 18 Jun 2019 22:51:29 -0700 (PDT) Return-Path: X-Received: from mga02.intel.com (mga02.intel.com []) by groups.io with SMTP; Tue, 18 Jun 2019 22:51:28 -0700 X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False X-Received: from orsmga007.jf.intel.com ([10.7.209.58]) by orsmga101.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 18 Jun 2019 22:51:28 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.63,392,1557212400"; d="scan'208";a="150508245" X-Received: from ydong10-win10.ccr.corp.intel.com ([10.239.158.133]) by orsmga007.jf.intel.com with ESMTP; 18 Jun 2019 22:51:27 -0700 From: "Dong, Eric" To: devel@edk2.groups.io Cc: Ray Ni , Laszlo Ersek Subject: [edk2-devel] [Patch 1/2] MdePkg: Add new MM MP Protocol definition. Date: Wed, 19 Jun 2019 13:51:13 +0800 Message-Id: <20190619055114.12744-2-eric.dong@intel.com> In-Reply-To: <20190619055114.12744-1-eric.dong@intel.com> References: <20190619055114.12744-1-eric.dong@intel.com> MIME-Version: 1.0 Precedence: Bulk List-Unsubscribe: Sender: devel@edk2.groups.io List-Id: Mailing-List: list devel@edk2.groups.io; contact devel+owner@edk2.groups.io Reply-To: devel@edk2.groups.io,eric.dong@intel.com Content-Transfer-Encoding: quoted-printable DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=groups.io; q=dns/txt; s=20140610; t=1560923489; bh=7ZWQPBE3doBqIW673d8QwrifG7GKhoMj3h/khdEj9P4=; h=Cc:Date:From:Reply-To:Subject:To; b=t7I3GTCeb9zvd7IuNqVYks1Hl2LmKkzGodkn65E715Qrt9W5FjOKZEn/qlKOdCl2Pgu k0zS+DeeN6xhUO8PUyMOgPXUqLSoWe/ED6YhVNNqZAQrGh7ZNEwhJFdlc0sSuKCQtZ6Pv Bh3Rj8LimLcDBWUzHQkFXwVyYt/5fO0zmP0= X-ZohoMail-DKIM: pass (identity @groups.io) Content-Type: text/plain; charset="utf-8" EFI MM MP Protocol is defined in the PI 1.7 specification. The MM MP protocol provides a set of functions to allow execution of procedures on processors that have entered MM. This protocol has the following properties: 1. The caller can invoke execution of a procedure on a processor, other than the caller, that has also entered MM. Supports blocking and non-blocking modes of operation. 2. The caller can invoke a procedure on multiple processors. Supports blocking and non-blocking modes of operation. Cc: Ray Ni Cc: Laszlo Ersek Signed-off-by: Eric Dong --- MdePkg/Include/Pi/PiMultiPhase.h | 16 ++ MdePkg/Include/Protocol/MmMp.h | 334 +++++++++++++++++++++++++++++++ MdePkg/Include/Protocol/SmmMp.h | 44 ++++ MdePkg/MdePkg.dec | 6 + 4 files changed, 400 insertions(+) create mode 100644 MdePkg/Include/Protocol/MmMp.h create mode 100644 MdePkg/Include/Protocol/SmmMp.h diff --git a/MdePkg/Include/Pi/PiMultiPhase.h b/MdePkg/Include/Pi/PiMultiPh= ase.h index eb12527767..a5056799e1 100644 --- a/MdePkg/Include/Pi/PiMultiPhase.h +++ b/MdePkg/Include/Pi/PiMultiPhase.h @@ -176,4 +176,20 @@ VOID IN OUT VOID *Buffer ); =20 +/** + The function prototype for invoking a function on an Application Process= or. + + This definition is used by the UEFI MM MP Serices Protocol. + + @param[in] ProcedureArgument The pointer to private data buffer. + + @retval EFI_SUCCESS Excutive the procedure successfully + +**/ +typedef +EFI_STATUS +(EFIAPI *EFI_AP_PROCEDURE2)( + IN VOID *ProcedureArgument +); + #endif diff --git a/MdePkg/Include/Protocol/MmMp.h b/MdePkg/Include/Protocol/MmMp.h new file mode 100644 index 0000000000..0467072bec --- /dev/null +++ b/MdePkg/Include/Protocol/MmMp.h @@ -0,0 +1,334 @@ +/** @file + EFI MM MP Protocol is defined in the PI 1.5 specification. + + The MM MP protocol provides a set of functions to allow execution of pro= cedures on processors that + have entered MM. This protocol has the following properties: + 1. The caller can only invoke execution of a procedure on a processor, o= ther than the caller, that + has also entered MM. + 2. It is possible to invoke a procedure on multiple processors. Supports= blocking and non-blocking + modes of operation. + + Copyright (c) 2019, Intel Corporation. All rights reserved.
+ SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef _MM_MP_H_ +#define _MM_MP_H_ + +#include + +#define EFI_MM_MP_PROTOCOL_GUID \ + { \ + 0x5d5450d7, 0x990c, 0x4180, {0xa8, 0x3, 0x8e, 0x63, 0xf0, 0x60, 0x83, = 0x7 } \ + } + +// +// Revision definition. +// +#define EFI_MM_MP_PROTOCOL_REVISION 0x00 + +// +// Attribute flags +// +#define EFI_MM_MP_TIMEOUT_SUPPORTED 0x01 + +// +// Completion token +// +typedef VOID* MM_COMPLETION; + +typedef struct { + MM_COMPLETION Completion; + EFI_STATUS Status; +} MM_DISPATCH_COMPLETION_TOKEN; + +typedef struct _EFI_MM_MP_PROTOCOL EFI_MM_MP_PROTOCOL; + +/** + Service to retrieves the number of logical processor in the platform. + + @param[in] This The EFI_MM_MP_PROTOCOL instance. + @param[out] NumberOfProcessors Pointer to the total number of logical p= rocessors in the system, + including the BSP and all APs. + + @retval EFI_SUCCESS The number of processors was retrieved s= uccessfully + @retval EFI_INVALID_PARAMETER NumberOfProcessors is NULL +**/ +typedef +EFI_STATUS +(EFIAPI *EFI_MM_GET_NUMBER_OF_PROCESSORS) ( + IN CONST EFI_MM_MP_PROTOCOL *This, + OUT UINTN *NumberOfProcessors +); + + +/** + This service allows the caller to invoke a procedure one of the applicat= ion processors (AP). This + function uses an optional token parameter to support blocking and non-bl= ocking modes. If the token + is passed into the call, the function will operate in a non-blocking fas= hion and the caller can + check for completion with CheckOnProcedure or WaitForProcedure. + + @param[in] This The EFI_MM_MP_PROTOCOL instance. + @param[in] Procedure A pointer to the procedure to be r= un on the designated target + AP of the system. Type EFI_AP_PROC= EDURE2 is defined below in + related definitions. + @param[in] CpuNumber The zero-based index of the proces= sor number of the target + AP, on which the code stream is su= pposed to run. If the number + points to the calling processor th= en it will not run the + supplied code. + @param[in] TimeoutInMicroseconds Indicates the time limit in micros= econds for this AP to + finish execution of Procedure, eit= her for blocking or + non-blocking mode. Zero means infi= nity. If the timeout + expires before this AP returns fro= m Procedure, then Procedure + on the AP is terminated. If the ti= meout expires in blocking + mode, the call returns EFI_TIMEOUT= . If the timeout expires + in non-blocking mode, the timeout = determined can be through + CheckOnProcedure or WaitForProcedu= re. + Note that timeout support is optio= nal. Whether an + implementation supports this featu= re, can be determined via + the Attributes data member. + @param[in,out] ProcedureArguments Allows the caller to pass a list o= f parameters to the code + that is run by the AP. It is an op= tional common mailbox + between APs and the caller to shar= e information. + @param[in,out] Token This is parameter is broken into t= wo components: + 1.Token->Completion is an optional= parameter that allows the + caller to execute the procedure in= a blocking or non-blocking + fashion. If it is NULL the call is= blocking, and the call will + not return until the AP has comple= ted the procedure. If the + token is not NULL, the call will r= eturn immediately. The caller + can check whether the procedure ha= s completed with + CheckOnProcedure or WaitForProcedu= re. + 2.Token->Status The implementation= updates the address pointed + at by this variable with the statu= s code returned by Procedure + when it completes execution on the= target AP, or with EFI_TIMEOUT + if the Procedure fails to complete= within the optional timeout. + The implementation will update thi= s variable with EFI_NOT_READY + prior to starting Procedure on the= target AP. + @param[in,out] CPUStatus This optional pointer may be used = to get the status code returned + by Procedure when it completes exe= cution on the target AP, or with + EFI_TIMEOUT if the Procedure fails= to complete within the optional + timeout. The implementation will u= pdate this variable with + EFI_NOT_READY prior to starting Pr= ocedure on the target AP. + + @retval EFI_SUCCESS In the blocking case, this indicat= es that Procedure has completed + execution on the target AP. + In the non-blocking case this indi= cates that the procedure has + been successfully scheduled for ex= ecution on the target AP. + @retval EFI_INVALID_PARAMETER The input arguments are out of ran= ge. Either the target AP is the + caller of the function, or the Pro= cedure or Token is NULL + @retval EFI_NOT_READY If the target AP is busy executing= another procedure + @retval EFI_ALREADY_STARTED Token is already in use for anothe= r procedure + @retval EFI_TIMEOUT In blocking mode, the timeout expi= red before the specified AP + has finished +**/ +typedef +EFI_STATUS +(EFIAPI *EFI_MM_DISPATCH_PROCEDURE) ( + IN CONST EFI_MM_MP_PROTOCOL *This, + IN EFI_AP_PROCEDURE2 Procedure, + IN UINTN CpuNumber, + IN UINTN TimeoutInMicroseconds, + IN OUT VOID *ProcedureArguments OPTIONAL, + IN OUT MM_COMPLETION *Token, + IN OUT EFI_STATUS *CPUStatus +); + +/** + This service allows the caller to invoke a procedure on all running appl= ication processors (AP) + except the caller. This function uses an optional token parameter to sup= port blocking and + nonblocking modes. If the token is passed into the call, the function wi= ll operate in a non-blocking + fashion and the caller can check for completion with CheckOnProcedure or= WaitForProcedure. + + It is not necessary for the implementation to run the procedure on every= processor on the platform. + Processors that are powered down in such a way that they cannot respond = to interrupts, may be + excluded from the broadcast. + + + @param[in] This The EFI_MM_MP_PROTOCOL instance. + @param[in] Procedure A pointer to the code stream to be= run on the APs that have + entered MM. Type EFI_AP_PROCEDURE = is defined below in related + definitions. + @param[in] TimeoutInMicroseconds Indicates the time limit in micros= econds for the APs to finish + execution of Procedure, either for= blocking or non-blocking mode. + Zero means infinity. If the timeou= t expires before all APs return + from Procedure, then Procedure on = the failed APs is terminated. If + the timeout expires in blocking mo= de, the call returns EFI_TIMEOUT. + If the timeout expires in non-bloc= king mode, the timeout determined + can be through CheckOnProcedure or= WaitForProcedure. + Note that timeout support is optio= nal. Whether an implementation + supports this feature can be deter= mined via the Attributes data + member. + @param[in,out] ProcedureArguments Allows the caller to pass a list o= f parameters to the code + that is run by the AP. It is an op= tional common mailbox + between APs and the caller to shar= e information. + @param[in,out] Token This is parameter is broken into t= wo components: + 1.Token->Completion is an optional= parameter that allows the + caller to execute the procedure in= a blocking or non-blocking + fashion. If it is NULL the call is= blocking, and the call will + not return until the AP has comple= ted the procedure. If the + token is not NULL, the call will r= eturn immediately. The caller + can check whether the procedure ha= s completed with + CheckOnProcedure or WaitForProcedu= re. + 2.Token->Status The implementation= updates the address pointed + at by this variable with the statu= s code returned by Procedure + when it completes execution on the= target AP, or with EFI_TIMEOUT + if the Procedure fails to complete= within the optional timeout. + The implementation will update thi= s variable with EFI_NOT_READY + prior to starting Procedure on the= target AP + @param[in,out] CPUStatus This optional pointer may be used = to get the individual status + returned by every AP that particip= ated in the broadcast. This + parameter if used provides the bas= e address of an array to hold + the EFI_STATUS value of each AP in= the system. The size of the + array can be ascertained by the Ge= tNumberOfProcessors function. + As mentioned above, the broadcast = may not include every processor + in the system. Some implementation= s may exclude processors that + have been powered down in such a w= ay that they are not responsive + to interrupts. Additionally the br= oadcast excludes the processor + which is making the BroadcastProce= dure call. For every excluded + processor, the array entry must co= ntain a value of EFI_NOT_STARTED + + @retval EFI_SUCCESS In the blocking case, this indicat= es that Procedure has completed + execution on the APs. In the non-b= locking case this indicates that + the procedure has been successfull= y scheduled for execution on the + APs. + @retval EFI_INVALID_PARAMETER Procedure or Token is NULL. + @retval EFI_NOT_READY If a target AP is busy executing a= nother procedure. + @retval EFI_TIMEOUT In blocking mode, the timeout expi= red before all enabled APs have + finished. + @retval EFI_ALREADY_STARTED Before the AP procedure associated= with the Token is finished, the + same Token cannot be used to dispa= tch or broadcast another procedure. + +**/ +typedef +EFI_STATUS +(EFIAPI *EFI_MM_BROADCAST_PROCEDURE) ( + IN CONST EFI_MM_MP_PROTOCOL *This, + IN EFI_AP_PROCEDURE2 Procedure, + IN UINTN TimeoutInMicroseconds, + IN OUT VOID *ProcedureArguments OPTIONAL, + IN OUT MM_COMPLETION *Token, + IN OUT EFI_STATUS *CPUStatus +); + + +/** + This service allows the caller to set a startup procedure that will be e= xecuted when an AP powers + up from a state where core configuration and context is lost. The proced= ure is execution has the + following properties: + 1. The procedure executes before the processor is handed over to the ope= rating system. + 2. All processors execute the same startup procedure. + 3. The procedure may run in parallel with other procedures invoked throu= gh the functions in this + protocol, or with processors that are executing an MM handler or running= in the operating system. + + + @param[in] This The EFI_MM_MP_PROTOCOL instance. + @param[in] Procedure A pointer to the code stream to be = run on the designated target AP + of the system. Type EFI_AP_PROCEDUR= E is defined below in Volume 2 + with the related definitions of + EFI_MP_SERVICES_PROTOCOL.StartupAll= APs. + If caller may pass a value of NULL = to deregister any existing + startup procedure. + @param[in,out] ProcedureArguments Allows the caller to pass a list of= parameters to the code that is + run by the AP. It is an optional co= mmon mailbox between APs and + the caller to share information + + @retval EFI_SUCCESS The Procedure has been set successf= ully. + @retval EFI_INVALID_PARAMETER The Procedure is NULL. +**/ +typedef +EFI_STATUS +(EFIAPI *EFI_MM_SET_STARTUP_PROCEDURE) ( + IN CONST EFI_MM_MP_PROTOCOL *This, + IN EFI_AP_PROCEDURE Procedure, + IN OUT VOID *ProcedureArguments OPTIONAL +); + +/** + When non-blocking execution of a procedure on an AP is invoked with Disp= atchProcedure, + via the use of a token, this function can be used to check for completio= n of the procedure on the AP. + The function takes the token that was passed into the DispatchProcedure = call. If the procedure + is complete, and therefore it is now possible to run another procedure o= n the same AP, this function + returns EFI_SUCESS. In this case the status returned by the procedure th= at executed on the AP is + returned in the token's Status field. If the procedure has not yet compl= eted, then this function + returns EFI_NOT_READY. + + When a non-blocking execution of a procedure is invoked with BroadcastPr= ocedure, via the + use of a token, this function can be used to check for completion of the= procedure on all the + broadcast APs. The function takes the token that was passed into the Bro= adcastProcedure + call. If the procedure is complete on all broadcast APs this function re= turns EFI_SUCESS. In this + case the Status field in the token passed into the function reflects the= overall result of the + invocation, which may be EFI_SUCCESS, if all executions succeeded, or th= e first observed failure. + If the procedure has not yet completed on the broadcast APs, the functio= n returns + EFI_NOT_READY. + + @param[in] This The EFI_MM_MP_PROTOCOL instance. + @param[in] Token This parameter describes the token = that was passed into + DispatchProcedure or BroadcastProce= dure. + + @retval EFI_SUCCESS Procedure has completed. + @retval EFI_NOT_READY The Procedure has not completed. + @retval EFI_INVALID_PARAMETER Token or Token->Completion is NULL + @retval EFI_NOT_FOUND Token is not currently in use for a= non-blocking call + +**/ +typedef +EFI_STATUS +(EFIAPI *EFI_CHECK_FOR_PROCEDURE) ( + IN CONST EFI_MM_MP_PROTOCOL *This, + IN MM_COMPLETION Token +); + +/** + When a non-blocking execution of a procedure on an AP is invoked via Dis= patchProcedure, + this function will block the caller until the remote procedure has compl= eted on the designated AP. + The non-blocking procedure invocation is identified by the Token paramet= er, which must match the + token that used when DispatchProcedure was called. Upon completion the s= tatus returned by + the procedure that executed on the AP is used to update the token's Stat= us field. + + When a non-blocking execution of a procedure on an AP is invoked via Bro= adcastProcedure + this function will block the caller until the remote procedure has compl= eted on all of the APs that + entered MM. The non-blocking procedure invocation is identified by the T= oken parameter, which + must match the token that used when BroadcastProcedure was called. Upon = completion the + overall status returned by the procedures that executed on the broadcast= AP is used to update the + token's Status field. The overall status may be EFI_SUCCESS, if all exec= utions succeeded, or the + first observed failure. + + + @param[in] This The EFI_MM_MP_PROTOCOL instance. + @param[in] Token This parameter describes the token = that was passed into + DispatchProcedure or BroadcastProce= dure. + + @retval EFI_SUCCESS Procedure has completed. + @retval EFI_INVALID_PARAMETER Token or Token->Completion is NULL + @retval EFI_NOT_FOUND Token is not currently in use for a= non-blocking call + +**/ +typedef +EFI_STATUS +(EFIAPI *EFI_WAIT_FOR_PROCEDURE) ( + IN CONST EFI_MM_MP_PROTOCOL *This, + IN MM_COMPLETION Token +); + + + +/// +/// The MM MP protocol provides a set of functions to allow execution of p= rocedures on processors that +/// have entered MM. +/// +struct _EFI_MM_MP_PROTOCOL { + UINT32 Revision; + UINT32 Attributes; + EFI_MM_GET_NUMBER_OF_PROCESSORS GetNumberOfProcessors; + EFI_MM_DISPATCH_PROCEDURE DispatchProcedure; + EFI_MM_BROADCAST_PROCEDURE BroadcastProcedure; + EFI_MM_SET_STARTUP_PROCEDURE SetStartupProcedure; + EFI_CHECK_FOR_PROCEDURE CheckForProcedure; + EFI_WAIT_FOR_PROCEDURE WaitForProcedure; +}; + +extern EFI_GUID gEfiMmMpProtocolGuid; + +#endif + diff --git a/MdePkg/Include/Protocol/SmmMp.h b/MdePkg/Include/Protocol/SmmM= p.h new file mode 100644 index 0000000000..5f391a3860 --- /dev/null +++ b/MdePkg/Include/Protocol/SmmMp.h @@ -0,0 +1,44 @@ +/** @file + EFI SMM MP Protocol is defined in the PI 1.5 specification. + + The SMM MP protocol provides a set of functions to allow execution of pr= ocedures on processors that + have entered SMM. This protocol has the following properties: + 1. The caller can only invoke execution of a procedure on a processor, o= ther than the caller, that + has also entered SMM. + 2. It is possible to invoke a procedure on multiple processors. Supports= blocking and non-blocking + modes of operation. + + Copyright (c) 2019, Intel Corporation. All rights reserved.
+ SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef _SMM_MP_H_ +#define _SMM_MP_H_ + +#include + +#define EFI_SMM_MP_PROTOCOL_GUID EFI_MM_MP_PROTOCOL_GUID + +#define EFI_SMM_MP_TIMEOUT_SUPPORTED EFI_MM_MP_TIMEOUT_SUPPORTED + +#define EFI_SMM_MP_PROTOCOL_REVISION EFI_MM_MP_PROTOCOL_REVISION + +typedef MM_COMPLETION SMM_COMPLETION; + +typedef MM_DISPATCH_COMPLETION_TOKEN SMM_DISPATCH_COMPLETION_TOKEN; + +typedef EFI_MM_MP_PROTOCOL EFI_SMM_MP_PROTOCOL; + +typedef EFI_MM_GET_NUMBER_OF_PROCESSORS EFI_SMM_GET_NUMBER_OF_PROCESSORS; + +typedef EFI_MM_DISPATCH_PROCEDURE EFI_SMM_DISPATCH_PROCEDURE; + +typedef EFI_MM_BROADCAST_PROCEDURE EFI_SMM_BROADCAST_PROCEDURE; + +typedef EFI_MM_SET_STARTUP_PROCEDURE EFI_SMM_SET_STARTUP_PROCEDURE; + +extern EFI_GUID gEfiSmmMpProtocolGuid; + +#endif + diff --git a/MdePkg/MdePkg.dec b/MdePkg/MdePkg.dec index 6c563375ee..0b8da9f2cb 100644 --- a/MdePkg/MdePkg.dec +++ b/MdePkg/MdePkg.dec @@ -1167,6 +1167,12 @@ # Protocols defined in PI 1.5. # =20 + ## Include/Protocol/SmmMp.h + gEfiSmmMpProtocolGuid =3D { 0x5d5450d7, 0x990c, 0x4180, { 0xa8, 0x3, 0x8= e, 0x63, 0xf0, 0x60, 0x83, 0x7 }} + + ## Include/Protocol/MmMp.h + gEfiMmMpProtocolGuid =3D { 0x5d5450d7, 0x990c, 0x4180, { 0xa8, 0x3, 0x8e= , 0x63, 0xf0, 0x60, 0x83, 0x7 }} + ## Include/Protocol/MmEndOfDxe.h gEfiMmEndOfDxeProtocolGuid =3D { 0x24e70042, 0xd5c5, 0x4260, { 0x8c, 0x3= 9, 0xa, 0xd3, 0xaa, 0x32, 0xe9, 0x3d }} =20 --=20 2.21.0.windows.1 -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#42573): https://edk2.groups.io/g/devel/message/42573 Mute This Topic: https://groups.io/mt/32120262/1787277 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org] -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D- From nobody Sun May 5 02:11:29 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of groups.io designates 66.175.222.12 as permitted sender) client-ip=66.175.222.12; envelope-from=bounce+27952+42574+1787277+3901457@groups.io; helo=web01.groups.io; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zoho.com: domain of groups.io designates 66.175.222.12 as permitted sender) smtp.mailfrom=bounce+27952+42574+1787277+3901457@groups.io; dmarc=fail(p=none dis=none) header.from=intel.com ARC-Seal: i=1; a=rsa-sha256; t=1560923492; cv=none; d=zoho.com; s=zohoarc; b=bQkcAt+32OCbwR0EApWBf2mRR/k3QYwnLrFzgaOuqnQnq/L4nMt56PrdSz6vaSSIfjU/wd6jIOjypX5xhLSEa6SRWk2ClyIevMOg005Q/EjIN54BVNSZPYwjQM1VWmIMvaAAe3CDGa0CDf98IMUIUq3PbzvCwDdG+hEbvEa7kY0= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1560923492; h=Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Id:List-Unsubscribe:MIME-Version:Message-ID:Reply-To:References:Sender:Subject:To:ARC-Authentication-Results; bh=Dc56hOj1QhylfxsJY7mLOgkARzZMP1+r+hE+ujL0xas=; b=XN9EVBpTQvesoRJmMrCVCZXAvqziilXlmJNgEt7/RgAlf/MjTjeMROjJoFaxM/0xDr3uXXX54m5kIWrx0xInCNntxmjDK9Bxam97rEopJgulC+BKDtT/61GpBFDAYDXP9XyVmhueUKpj6sgAyqlcYvZSdqIvAm+PsCueMWwSPkI= ARC-Authentication-Results: i=1; mx.zoho.com; dkim=pass; spf=pass (zoho.com: domain of groups.io designates 66.175.222.12 as permitted sender) smtp.mailfrom=bounce+27952+42574+1787277+3901457@groups.io; dmarc=fail header.from= (p=none dis=none) header.from= Received: from web01.groups.io (web01.groups.io [66.175.222.12]) by mx.zohomail.com with SMTPS id 1560923492043323.276068642821; Tue, 18 Jun 2019 22:51:32 -0700 (PDT) Return-Path: X-Received: from mga02.intel.com (mga02.intel.com []) by groups.io with SMTP; Tue, 18 Jun 2019 22:51:31 -0700 X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False X-Received: from orsmga007.jf.intel.com ([10.7.209.58]) by orsmga101.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 18 Jun 2019 22:51:30 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.63,392,1557212400"; d="scan'208";a="150508266" X-Received: from ydong10-win10.ccr.corp.intel.com ([10.239.158.133]) by orsmga007.jf.intel.com with ESMTP; 18 Jun 2019 22:51:28 -0700 From: "Dong, Eric" To: devel@edk2.groups.io Cc: Ray Ni , Laszlo Ersek Subject: [edk2-devel] [Patch 2/2] UefiCpuPkg/PiSmmCpuDxeSmm: Enable MM MP Protocol. Date: Wed, 19 Jun 2019 13:51:14 +0800 Message-Id: <20190619055114.12744-3-eric.dong@intel.com> In-Reply-To: <20190619055114.12744-1-eric.dong@intel.com> References: <20190619055114.12744-1-eric.dong@intel.com> MIME-Version: 1.0 Precedence: Bulk List-Unsubscribe: Sender: devel@edk2.groups.io List-Id: Mailing-List: list devel@edk2.groups.io; contact devel+owner@edk2.groups.io Reply-To: devel@edk2.groups.io,eric.dong@intel.com Content-Transfer-Encoding: quoted-printable DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=groups.io; q=dns/txt; s=20140610; t=1560923491; bh=2THRwtmAD8cnpIKuDVX+eLrr14FH8OobQBUV3B4Spx8=; h=Cc:Date:From:Reply-To:Subject:To; b=B0/LRE+RnXQXsOROpshFkdVTDfzAkxI4U/CCokkJi5ogvBDxMCsy0qoftSKPKEmacgK FzdQGsVDorLZaFSq46nLwH/hxvRDltxyfhXf0oLORoH/Si+LGSMZBmLpzBVbDCymMxQod xlkYGeUAJC1L/e8yGme5Lhv0Xa7RW3tkZnc= X-ZohoMail-DKIM: pass (identity @groups.io) Content-Type: text/plain; charset="utf-8" Add MM Mp Protocol in PiSmmCpuDxeSmm driver. Cc: Ray Ni Cc: Laszlo Ersek Signed-off-by: Eric Dong --- UefiCpuPkg/PiSmmCpuDxeSmm/MpProtocol.c | 375 +++++++++++++++ UefiCpuPkg/PiSmmCpuDxeSmm/MpProtocol.h | 283 +++++++++++ UefiCpuPkg/PiSmmCpuDxeSmm/MpService.c | 468 ++++++++++++++++++- UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.c | 11 + UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h | 172 ++++++- UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.inf | 3 + 6 files changed, 1296 insertions(+), 16 deletions(-) create mode 100644 UefiCpuPkg/PiSmmCpuDxeSmm/MpProtocol.c create mode 100644 UefiCpuPkg/PiSmmCpuDxeSmm/MpProtocol.h diff --git a/UefiCpuPkg/PiSmmCpuDxeSmm/MpProtocol.c b/UefiCpuPkg/PiSmmCpuDx= eSmm/MpProtocol.c new file mode 100644 index 0000000000..8cf69428c2 --- /dev/null +++ b/UefiCpuPkg/PiSmmCpuDxeSmm/MpProtocol.c @@ -0,0 +1,375 @@ +/** @file +SMM MP protocol implementation + +Copyright (c) 2019, Intel Corporation. All rights reserved.
+ +SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "PiSmmCpuDxeSmm.h" +#include "MpProtocol.h" + +/// +/// SMM MP Protocol instance +/// +EFI_SMM_MP_PROTOCOL mSmmMp =3D { + EFI_SMM_MP_PROTOCOL_REVISION, + 0, + SmmMpGetNumberOfProcessors, + SmmMpDispatchProcedure, + SmmMpBroadcastProcedure, + SmmMpSetStartupProcedure, + SmmMpCheckForProcedure, + SmmMpWaitForProcedure +}; + +/** + Service to retrieves the number of logical processor in the platform. + + @param[in] This The EFI_MM_MP_PROTOCOL instance. + @param[out] NumberOfProcessors Pointer to the total number of logical p= rocessors in the system, + including the BSP and all APs. + + @retval EFI_SUCCESS The number of processors was retrieved s= uccessfully + @retval EFI_INVALID_PARAMETER NumberOfProcessors is NULL +**/ + +EFI_STATUS +EFIAPI +SmmMpGetNumberOfProcessors ( + IN CONST EFI_SMM_MP_PROTOCOL *This, + OUT UINTN *NumberOfProcessors + ) +{ + if (NumberOfProcessors =3D=3D NULL) { + return EFI_INVALID_PARAMETER; + } + + *NumberOfProcessors =3D gSmmCpuPrivate->SmmCoreEntryContext.NumberOfCpus; + + return EFI_SUCCESS; +} + + +/** + This service allows the caller to invoke a procedure one of the applicat= ion processors (AP). This + function uses an optional token parameter to support blocking and non-bl= ocking modes. If the token + is passed into the call, the function will operate in a non-blocking fas= hion and the caller can + check for completion with CheckOnProcedure or WaitForProcedure. + + @param[in] This The EFI_MM_MP_PROTOCOL instance. + @param[in] Procedure A pointer to the procedure to be r= un on the designated target + AP of the system. Type EFI_AP_PROC= EDURE2 is defined below in + related definitions. + @param[in] CpuNumber The zero-based index of the proces= sor number of the target + AP, on which the code stream is su= pposed to run. If the number + points to the calling processor th= en it will not run the + supplied code. + @param[in] TimeoutInMicroseconds Indicates the time limit in micros= econds for this AP to + finish execution of Procedure, eit= her for blocking or + non-blocking mode. Zero means infi= nity. If the timeout + expires before this AP returns fro= m Procedure, then Procedure + on the AP is terminated. If the ti= meout expires in blocking + mode, the call returns EFI_TIMEOUT= . If the timeout expires + in non-blocking mode, the timeout = determined can be through + CheckOnProcedure or WaitForProcedu= re. + Note that timeout support is optio= nal. Whether an + implementation supports this featu= re, can be determined via + the Attributes data member. + @param[in,out] ProcedureArguments Allows the caller to pass a list o= f parameters to the code + that is run by the AP. It is an op= tional common mailbox + between APs and the caller to shar= e information. + @param[in,out] Token This is parameter is broken into t= wo components: + 1.Token->Completion is an optional= parameter that allows the + caller to execute the procedure in= a blocking or non-blocking + fashion. If it is NULL the call is= blocking, and the call will + not return until the AP has comple= ted the procedure. If the + token is not NULL, the call will r= eturn immediately. The caller + can check whether the procedure ha= s completed with + CheckOnProcedure or WaitForProcedu= re. + 2.Token->Status The implementation= updates the address pointed + at by this variable with the statu= s code returned by Procedure + when it completes execution on the= target AP, or with EFI_TIMEOUT + if the Procedure fails to complete= within the optional timeout. + The implementation will update thi= s variable with EFI_NOT_READY + prior to starting Procedure on the= target AP + @param[in,out] CPUStatus This optional pointer may be used = to get the status code returned + by Procedure when it completes exe= cution on the target AP, or with + EFI_TIMEOUT if the Procedure fails= to complete within the optional + timeout. The implementation will u= pdate this variable with + EFI_NOT_READY prior to starting Pr= ocedure on the target AP. + + @retval EFI_SUCCESS In the blocking case, this indicat= es that Procedure has completed + execution on the target AP. + In the non-blocking case this indi= cates that the procedure has + been successfully scheduled for ex= ecution on the target AP. + @retval EFI_INVALID_PARAMETER The input arguments are out of ran= ge. Either the target AP is the + caller of the function, or the Pro= cedure or Token is NULL + @retval EFI_NOT_READY If the target AP is busy executing= another procedure + @retval EFI_ALREADY_STARTED Token is already in use for anothe= r procedure + @retval EFI_TIMEOUT In blocking mode, the timeout expi= red before the specified AP + has finished +**/ +EFI_STATUS +EFIAPI +SmmMpDispatchProcedure ( + IN CONST EFI_SMM_MP_PROTOCOL *This, + IN EFI_AP_PROCEDURE2 Procedure, + IN UINTN CpuNumber, + IN UINTN TimeoutInMicroseconds, + IN OUT VOID *ProcedureArguments OPTIONAL, + IN OUT SMM_COMPLETION *Token, + IN OUT EFI_STATUS *CPUStatus + ) +{ + if (Token !=3D NULL) { + *Token =3D AllocatePool (sizeof (SPIN_LOCK)); + ASSERT (*Token !=3D NULL); + InitializeSpinLock ((SPIN_LOCK *)(*Token)); + + return InternalSmmStartupThisAp( + Procedure, + CpuNumber, + ProcedureArguments, + SmmCpuCallInNewType, + (SPIN_LOCK *)(*Token), + TimeoutInMicroseconds, + CPUStatus + ); + } + + return InternalSmmStartupThisAp( + Procedure, + CpuNumber, + ProcedureArguments, + SmmCpuCallInNewType, + NULL, + TimeoutInMicroseconds, + CPUStatus + ); +} + +/** + This service allows the caller to invoke a procedure on all running appl= ication processors (AP) + except the caller. This function uses an optional token parameter to sup= port blocking and + nonblocking modes. If the token is passed into the call, the function wi= ll operate in a non-blocking + fashion and the caller can check for completion with CheckOnProcedure or= WaitForProcedure. + + It is not necessary for the implementation to run the procedure on every= processor on the platform. + Processors that are powered down in such a way that they cannot respond = to interrupts, may be + excluded from the broadcast. + + + @param[in] This The EFI_MM_MP_PROTOCOL instance. + @param[in] Procedure A pointer to the code stream to be= run on the APs that have + entered MM. Type EFI_AP_PROCEDURE = is defined below in related + definitions. + @param[in] TimeoutInMicroseconds Indicates the time limit in micros= econds for the APs to finish + execution of Procedure, either for= blocking or non-blocking mode. + Zero means infinity. If the timeou= t expires before all APs return + from Procedure, then Procedure on = the failed APs is terminated. If + the timeout expires in blocking mo= de, the call returns EFI_TIMEOUT. + If the timeout expires in non-bloc= king mode, the timeout determined + can be through CheckOnProcedure or= WaitForProcedure. + Note that timeout support is optio= nal. Whether an implementation + supports this feature can be deter= mined via the Attributes data + member. + @param[in,out] ProcedureArguments Allows the caller to pass a list o= f parameters to the code + that is run by the AP. It is an op= tional common mailbox + between APs and the caller to shar= e information. + @param[in,out] Token This is parameter is broken into t= wo components: + 1.Token->Completion is an optional= parameter that allows the + caller to execute the procedure in= a blocking or non-blocking + fashion. If it is NULL the call is= blocking, and the call will + not return until the AP has comple= ted the procedure. If the + token is not NULL, the call will r= eturn immediately. The caller + can check whether the procedure ha= s completed with + CheckOnProcedure or WaitForProcedu= re. + 2.Token->Status The implementation= updates the address pointed + at by this variable with the statu= s code returned by Procedure + when it completes execution on the= target AP, or with EFI_TIMEOUT + if the Procedure fails to complete= within the optional timeout. + The implementation will update thi= s variable with EFI_NOT_READY + prior to starting Procedure on the= target AP + @param[in,out] CPUStatus This optional pointer may be used = to get the individual status + returned by every AP that particip= ated in the broadcast. This + parameter if used provides the bas= e address of an array to hold + the EFI_STATUS value of each AP in= the system. The size of the + array can be ascertained by the Ge= tNumberOfProcessors function. + As mentioned above, the broadcast = may not include every processor + in the system. Some implementation= s may exclude processors that + have been powered down in such a w= ay that they are not responsive + to interrupts. Additionally the br= oadcast excludes the processor + which is making the BroadcastProce= dure call. For every excluded + processor, the array entry must co= ntain a value of EFI_NOT_STARTED + + @retval EFI_SUCCESS In the blocking case, this indicat= es that Procedure has completed + execution on the APs. + In the non-blocking case this indi= cates that the procedure has + been successfully scheduled for ex= ecution on the APs. + @retval EFI_INVALID_PARAMETER The Procedure or Token is NULL + @retval EFI_NOT_READY If the target AP is busy executing= another procedure + @retval EFI_ALREADY_STARTED Token is already in use for anothe= r procedure + @retval EFI_TIMEOUT In blocking mode, the timeout expi= red before the specified AP + has finished. + +**/ +EFI_STATUS +EFIAPI +SmmMpBroadcastProcedure ( + IN CONST EFI_SMM_MP_PROTOCOL *This, + IN EFI_AP_PROCEDURE2 Procedure, + IN UINTN TimeoutInMicroseconds, + IN OUT VOID *ProcedureArguments OPTIONAL, + IN OUT SMM_COMPLETION *Token, + IN OUT EFI_STATUS *CPUStatus + ) +{ + if (Token !=3D NULL) { + *Token =3D AllocatePool (sizeof (SPIN_LOCK)); + ASSERT (*Token !=3D NULL); + InitializeSpinLock ((SPIN_LOCK *) (*Token)); + + return InternalSmmStartupAllAPs( + Procedure, + TimeoutInMicroseconds, + ProcedureArguments, + (SPIN_LOCK *) (*Token), + CPUStatus + ); + } + + return InternalSmmStartupAllAPs( + Procedure, + TimeoutInMicroseconds, + ProcedureArguments, + NULL, + CPUStatus + ); +} + + +/** + This service allows the caller to set a startup procedure that will be e= xecuted when an AP powers + up from a state where core configuration and context is lost. The proced= ure is execution has the + following properties: + 1. The procedure executes before the processor is handed over to the ope= rating system. + 2. All processors execute the same startup procedure. + 3. The procedure may run in parallel with other procedures invoked throu= gh the functions in this + protocol, or with processors that are executing an MM handler or running= in the operating system. + + + @param[in] This The EFI_MM_MP_PROTOCOL instance. + @param[in] Procedure A pointer to the code stream to be = run on the designated target AP + of the system. Type EFI_AP_PROCEDUR= E is defined below in Volume 2 + with the related definitions of + EFI_MP_SERVICES_PROTOCOL.StartupAll= APs. + If caller may pass a value of NULL = to deregister any existing + startup procedure. + @param[in,out] ProcedureArguments Allows the caller to pass a list of= parameters to the code that is + run by the AP. It is an optional co= mmon mailbox between APs and + the caller to share information + + @retval EFI_SUCCESS The Procedure has been set successf= ully. + @retval EFI_INVALID_PARAMETER The Procedure is NULL but Procedure= Arguments not NULL. + +**/ +EFI_STATUS +EFIAPI +SmmMpSetStartupProcedure ( + IN CONST EFI_SMM_MP_PROTOCOL *This, + IN EFI_AP_PROCEDURE Procedure, + IN OUT VOID *ProcedureArguments OPTIONAL + ) +{ + return RegisterStartupProcedure (Procedure, ProcedureArguments); +} + +/** + When non-blocking execution of a procedure on an AP is invoked with Disp= atchProcedure, + via the use of a token, this function can be used to check for completio= n of the procedure on the AP. + The function takes the token that was passed into the DispatchProcedure = call. If the procedure + is complete, and therefore it is now possible to run another procedure o= n the same AP, this function + returns EFI_SUCESS. In this case the status returned by the procedure th= at executed on the AP is + returned in the token's Status field. If the procedure has not yet compl= eted, then this function + returns EFI_NOT_READY. + + When a non-blocking execution of a procedure is invoked with BroadcastPr= ocedure, via the + use of a token, this function can be used to check for completion of the= procedure on all the + broadcast APs. The function takes the token that was passed into the Bro= adcastProcedure + call. If the procedure is complete on all broadcast APs this function re= turns EFI_SUCESS. In this + case the Status field in the token passed into the function reflects the= overall result of the + invocation, which may be EFI_SUCCESS, if all executions succeeded, or th= e first observed failure. + If the procedure has not yet completed on the broadcast APs, the functio= n returns + EFI_NOT_READY. + + @param[in] This The EFI_MM_MP_PROTOCOL instance. + @param[in] Token This parameter describes the token = that was passed into + DispatchProcedure or BroadcastProce= dure. + + @retval EFI_SUCCESS Procedure has completed. + @retval EFI_NOT_READY The Procedure has not completed. + @retval EFI_INVALID_PARAMETER Token or Token->Completion is NULL + @retval EFI_NOT_FOUND Token is not currently in use for a= non-blocking call + +**/ +EFI_STATUS +EFIAPI +SmmMpCheckForProcedure ( + IN CONST EFI_SMM_MP_PROTOCOL *This, + IN SMM_COMPLETION Token + ) +{ + if (Token =3D=3D NULL) { + return EFI_INVALID_PARAMETER; + } + + if (!CurrentUsedToken ((SPIN_LOCK *)Token)) { + return EFI_NOT_FOUND; + } + + return CheckStatusForThisAP ((SPIN_LOCK *)Token); +} + +/** + When a non-blocking execution of a procedure on an AP is invoked via Dis= patchProcedure, + this function will block the caller until the remote procedure has compl= eted on the designated AP. + The non-blocking procedure invocation is identified by the Token paramet= er, which must match the + token that used when DispatchProcedure was called. Upon completion the s= tatus returned by + the procedure that executed on the AP is used to update the token's Stat= us field. + + When a non-blocking execution of a procedure on an AP is invoked via Bro= adcastProcedure + this function will block the caller until the remote procedure has compl= eted on all of the APs that + entered MM. The non-blocking procedure invocation is identified by the T= oken parameter, which + must match the token that used when BroadcastProcedure was called. Upon = completion the + overall status returned by the procedures that executed on the broadcast= AP is used to update the + token's Status field. The overall status may be EFI_SUCCESS, if all exec= utions succeeded, or the + first observed failure. + + + @param[in] This The EFI_MM_MP_PROTOCOL instance. + @param[in] Token This parameter describes the token = that was passed into + DispatchProcedure or BroadcastProce= dure. + + @retval EFI_SUCCESS Procedure has completed. + @retval EFI_INVALID_PARAMETER Token or Token->Completion is NULL + @retval EFI_NOT_FOUND Token is not currently in use for a= non-blocking call + +**/ +EFI_STATUS +EFIAPI +SmmMpWaitForProcedure ( + IN CONST EFI_SMM_MP_PROTOCOL *This, + IN SMM_COMPLETION Token + ) +{ + EFI_STATUS Status; + + do { + Status =3D SmmMpCheckForProcedure (This, Token); + } while (Status =3D=3D EFI_NOT_READY); + + return Status; +} + diff --git a/UefiCpuPkg/PiSmmCpuDxeSmm/MpProtocol.h b/UefiCpuPkg/PiSmmCpuDx= eSmm/MpProtocol.h new file mode 100644 index 0000000000..a1b4a0a671 --- /dev/null +++ b/UefiCpuPkg/PiSmmCpuDxeSmm/MpProtocol.h @@ -0,0 +1,283 @@ +/** @file +Include file for SMM MP protocol implementation. + +Copyright (c) 2019, Intel Corporation. All rights reserved.
+ +SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#ifndef _SMM_MP_PROTOCOL_H_ +#define _SMM_MP_PROTOCOL_H_ + +// +// SMM MP Protocol function prototypes. +// + +/** + Service to retrieves the number of logical processor in the platform. + + @param[in] This The EFI_MM_MP_PROTOCOL instance. + @param[out] NumberOfProcessors Pointer to the total number of logical p= rocessors in the system, + including the BSP and all APs. + + @retval EFI_SUCCESS The number of processors was retrieved s= uccessfully + @retval EFI_INVALID_PARAMETER NumberOfProcessors is NULL +**/ + +EFI_STATUS +EFIAPI +SmmMpGetNumberOfProcessors ( + IN CONST EFI_SMM_MP_PROTOCOL *This, + OUT UINTN *NumberOfProcessors + ); + + +/** + This service allows the caller to invoke a procedure one of the applicat= ion processors (AP). This + function uses an optional token parameter to support blocking and non-bl= ocking modes. If the token + is passed into the call, the function will operate in a non-blocking fas= hion and the caller can + check for completion with CheckOnProcedure or WaitForProcedure. + + @param[in] This The EFI_MM_MP_PROTOCOL instance. + @param[in] Procedure A pointer to the procedure to be r= un on the designated target + AP of the system. Type EFI_AP_PROC= EDURE2 is defined below in + related definitions. + @param[in] CpuNumber The zero-based index of the proces= sor number of the target + AP, on which the code stream is su= pposed to run. If the number + points to the calling processor th= en it will not run the + supplied code. + @param[in] TimeoutInMicroseconds Indicates the time limit in micros= econds for this AP to + finish execution of Procedure, eit= her for blocking or + non-blocking mode. Zero means infi= nity. If the timeout + expires before this AP returns fro= m Procedure, then Procedure + on the AP is terminated. If the ti= meout expires in blocking + mode, the call returns EFI_TIMEOUT= . If the timeout expires + in non-blocking mode, the timeout = determined can be through + CheckOnProcedure or WaitForProcedu= re. + Note that timeout support is optio= nal. Whether an + implementation supports this featu= re, can be determined via + the Attributes data member. + @param[in,out] ProcedureArguments Allows the caller to pass a list o= f parameters to the code + that is run by the AP. It is an op= tional common mailbox + between APs and the caller to shar= e information. + @param[in,out] Token This is parameter is broken into t= wo components: + 1.Token->Completion is an optional= parameter that allows the + caller to execute the procedure in= a blocking or non-blocking + fashion. If it is NULL the call is= blocking, and the call will + not return until the AP has comple= ted the procedure. If the + token is not NULL, the call will r= eturn immediately. The caller + can check whether the procedure ha= s completed with + CheckOnProcedure or WaitForProcedu= re. + 2.Token->Status The implementation= updates the address pointed + at by this variable with the statu= s code returned by Procedure + when it completes execution on the= target AP, or with EFI_TIMEOUT + if the Procedure fails to complete= within the optional timeout. + The implementation will update thi= s variable with EFI_NOT_READY + prior to starting Procedure on the= target AP + @param[in,out] CPUStatus This optional pointer may be used = to get the status code returned + by Procedure when it completes exe= cution on the target AP, or with + EFI_TIMEOUT if the Procedure fails= to complete within the optional + timeout. The implementation will u= pdate this variable with + EFI_NOT_READY prior to starting Pr= ocedure on the target AP. + + @retval EFI_SUCCESS In the blocking case, this indicat= es that Procedure has completed + execution on the target AP. + In the non-blocking case this indi= cates that the procedure has + been successfully scheduled for ex= ecution on the target AP. + @retval EFI_INVALID_PARAMETER The input arguments are out of ran= ge. Either the target AP is the + caller of the function, or the Pro= cedure or Token is NULL + @retval EFI_NOT_READY If the target AP is busy executing= another procedure + @retval EFI_ALREADY_STARTED Token is already in use for anothe= r procedure + @retval EFI_TIMEOUT In blocking mode, the timeout expi= red before the specified AP + has finished +**/ +EFI_STATUS +EFIAPI +SmmMpDispatchProcedure ( + IN CONST EFI_SMM_MP_PROTOCOL *This, + IN EFI_AP_PROCEDURE2 Procedure, + IN UINTN CpuNumber, + IN UINTN TimeoutInMicroseconds, + IN OUT VOID *ProcedureArguments OPTIONAL, + IN OUT SMM_COMPLETION *Token, + IN OUT EFI_STATUS *CPUStatus + ); + +/** + This service allows the caller to invoke a procedure on all running appl= ication processors (AP) + except the caller. This function uses an optional token parameter to sup= port blocking and + nonblocking modes. If the token is passed into the call, the function wi= ll operate in a non-blocking + fashion and the caller can check for completion with CheckOnProcedure or= WaitForProcedure. + + It is not necessary for the implementation to run the procedure on every= processor on the platform. + Processors that are powered down in such a way that they cannot respond = to interrupts, may be + excluded from the broadcast. + + + @param[in] This The EFI_MM_MP_PROTOCOL instance. + @param[in] Procedure A pointer to the code stream to be= run on the APs that have + entered MM. Type EFI_AP_PROCEDURE = is defined below in related + definitions. + @param[in] TimeoutInMicroseconds Indicates the time limit in micros= econds for the APs to finish + execution of Procedure, either for= blocking or non-blocking mode. + Zero means infinity. If the timeou= t expires before all APs return + from Procedure, then Procedure on = the failed APs is terminated. If + the timeout expires in blocking mo= de, the call returns EFI_TIMEOUT. + If the timeout expires in non-bloc= king mode, the timeout determined + can be through CheckOnProcedure or= WaitForProcedure. + Note that timeout support is optio= nal. Whether an implementation + supports this feature can be deter= mined via the Attributes data + member. + @param[in,out] ProcedureArguments Allows the caller to pass a list o= f parameters to the code + that is run by the AP. It is an op= tional common mailbox + between APs and the caller to shar= e information. + @param[in,out] Token This is parameter is broken into t= wo components: + 1.Token->Completion is an optional= parameter that allows the + caller to execute the procedure in= a blocking or non-blocking + fashion. If it is NULL the call is= blocking, and the call will + not return until the AP has comple= ted the procedure. If the + token is not NULL, the call will r= eturn immediately. The caller + can check whether the procedure ha= s completed with + CheckOnProcedure or WaitForProcedu= re. + 2.Token->Status The implementation= updates the address pointed + at by this variable with the statu= s code returned by Procedure + when it completes execution on the= target AP, or with EFI_TIMEOUT + if the Procedure fails to complete= within the optional timeout. + The implementation will update thi= s variable with EFI_NOT_READY + prior to starting Procedure on the= target AP + @param[in,out] CPUStatus This optional pointer may be used = to get the individual status + returned by every AP that particip= ated in the broadcast. This + parameter if used provides the bas= e address of an array to hold + the EFI_STATUS value of each AP in= the system. The size of the + array can be ascertained by the Ge= tNumberOfProcessors function. + As mentioned above, the broadcast = may not include every processor + in the system. Some implementation= s may exclude processors that + have been powered down in such a w= ay that they are not responsive + to interrupts. Additionally the br= oadcast excludes the processor + which is making the BroadcastProce= dure call. For every excluded + processor, the array entry must co= ntain a value of EFI_NOT_STARTED + + @retval EFI_SUCCESS In the blocking case, this indicat= es that Procedure has completed + execution on the APs. + In the non-blocking case this indi= cates that the procedure has + been successfully scheduled for ex= ecution on the APs. + @retval EFI_INVALID_PARAMETER The Procedure or Token is NULL + @retval EFI_NOT_READY If the target AP is busy executing= another procedure + @retval EFI_ALREADY_STARTED Token is already in use for anothe= r procedure + @retval EFI_TIMEOUT In blocking mode, the timeout expi= red before the specified AP + has finished + +**/ +EFI_STATUS +EFIAPI +SmmMpBroadcastProcedure ( + IN CONST EFI_SMM_MP_PROTOCOL *This, + IN EFI_AP_PROCEDURE2 Procedure, + IN UINTN TimeoutInMicroseconds, + IN OUT VOID *ProcedureArguments OPTIONAL, + IN OUT SMM_COMPLETION *Token, + IN OUT EFI_STATUS *CPUStatus + ); + + +/** + This service allows the caller to set a startup procedure that will be e= xecuted when an AP powers + up from a state where core configuration and context is lost. The proced= ure is execution has the + following properties: + 1. The procedure executes before the processor is handed over to the ope= rating system. + 2. All processors execute the same startup procedure. + 3. The procedure may run in parallel with other procedures invoked throu= gh the functions in this + protocol, or with processors that are executing an MM handler or running= in the operating system. + + + @param[in] This The EFI_MM_MP_PROTOCOL instance. + @param[in] Procedure A pointer to the code stream to be = run on the designated target AP + of the system. Type EFI_AP_PROCEDUR= E is defined below in Volume 2 + with the related definitions of + EFI_MP_SERVICES_PROTOCOL.StartupAll= APs. + If caller may pass a value of NULL = to deregister any existing + startup procedure. + @param[in,out] ProcedureArguments Allows the caller to pass a list of= parameters to the code that is + run by the AP. It is an optional co= mmon mailbox between APs and + the caller to share information + + @retval EFI_SUCCESS The Procedure has been set successf= ully. + @retval EFI_INVALID_PARAMETER The Procedure is NULL but Procedure= Arguments not NULL. +**/ +EFI_STATUS +EFIAPI +SmmMpSetStartupProcedure ( + IN CONST EFI_SMM_MP_PROTOCOL *This, + IN EFI_AP_PROCEDURE Procedure, + IN OUT VOID *ProcedureArguments OPTIONAL + ); + +/** + When non-blocking execution of a procedure on an AP is invoked with Disp= atchProcedure, + via the use of a token, this function can be used to check for completio= n of the procedure on the AP. + The function takes the token that was passed into the DispatchProcedure = call. If the procedure + is complete, and therefore it is now possible to run another procedure o= n the same AP, this function + returns EFI_SUCESS. In this case the status returned by the procedure th= at executed on the AP is + returned in the token's Status field. If the procedure has not yet compl= eted, then this function + returns EFI_NOT_READY. + + When a non-blocking execution of a procedure is invoked with BroadcastPr= ocedure, via the + use of a token, this function can be used to check for completion of the= procedure on all the + broadcast APs. The function takes the token that was passed into the Bro= adcastProcedure + call. If the procedure is complete on all broadcast APs this function re= turns EFI_SUCESS. In this + case the Status field in the token passed into the function reflects the= overall result of the + invocation, which may be EFI_SUCCESS, if all executions succeeded, or th= e first observed failure. + If the procedure has not yet completed on the broadcast APs, the functio= n returns + EFI_NOT_READY. + + @param[in] This The EFI_MM_MP_PROTOCOL instance. + @param[in] Token This parameter describes the token = that was passed into + DispatchProcedure or BroadcastProce= dure. + + @retval EFI_SUCCESS Procedure has completed. + @retval EFI_NOT_READY The Procedure has not completed. + @retval EFI_INVALID_PARAMETER Token or Token->Completion is NULL + @retval EFI_NOT_FOUND Token is not currently in use for a= non-blocking call + +**/ +EFI_STATUS +EFIAPI +SmmMpCheckForProcedure ( + IN CONST EFI_SMM_MP_PROTOCOL *This, + IN SMM_COMPLETION Token + ); + +/** + When a non-blocking execution of a procedure on an AP is invoked via Dis= patchProcedure, + this function will block the caller until the remote procedure has compl= eted on the designated AP. + The non-blocking procedure invocation is identified by the Token paramet= er, which must match the + token that used when DispatchProcedure was called. Upon completion the s= tatus returned by + the procedure that executed on the AP is used to update the token's Stat= us field. + + When a non-blocking execution of a procedure on an AP is invoked via Bro= adcastProcedure + this function will block the caller until the remote procedure has compl= eted on all of the APs that + entered MM. The non-blocking procedure invocation is identified by the T= oken parameter, which + must match the token that used when BroadcastProcedure was called. Upon = completion the + overall status returned by the procedures that executed on the broadcast= AP is used to update the + token's Status field. The overall status may be EFI_SUCCESS, if all exec= utions succeeded, or the + first observed failure. + + + @param[in] This The EFI_MM_MP_PROTOCOL instance. + @param[in] Token This parameter describes the token = that was passed into + DispatchProcedure or BroadcastProce= dure. + + @retval EFI_SUCCESS Procedure has completed. + @retval EFI_INVALID_PARAMETER Token or Token->Completion is NULL + @retval EFI_NOT_FOUND Token is not currently in use for a= non-blocking call + +**/ +EFI_STATUS +EFIAPI +SmmMpWaitForProcedure ( + IN CONST EFI_SMM_MP_PROTOCOL *This, + IN SMM_COMPLETION Token + ); + +#endif diff --git a/UefiCpuPkg/PiSmmCpuDxeSmm/MpService.c b/UefiCpuPkg/PiSmmCpuDxe= Smm/MpService.c index 64fb4d6344..6b08dc0c4e 100644 --- a/UefiCpuPkg/PiSmmCpuDxeSmm/MpService.c +++ b/UefiCpuPkg/PiSmmCpuDxeSmm/MpService.c @@ -146,6 +146,56 @@ ReleaseAllAPs ( } } =20 +/** + Wheck whether task has been finished by all APs. + + @retval TRUE Task has been finished by all APs. + @retval FALSE Task not has been finished by all APs. + +**/ +BOOLEAN +TaskFinishInAllAPs ( + VOID + ) +{ + UINTN Index; + UINTN BspIndex; + + BspIndex =3D mSmmMpSyncData->BspIndex; + + for (Index =3D mMaxNumberOfCpus; Index-- > 0;) { + if (Index !=3D BspIndex && *(mSmmMpSyncData->CpuData[Index].Present) &= & !mSmmMpSyncData->FinishTask[Index]) { + return FALSE; + } + } + + return TRUE; +} + +/** + Checks whenther executive procedure in sync mode. + + @param[in] CallInType Which call for this function. + @param[in] Token Token input by caller. + + + @retval TRUE Executive procedure in sync mode. + @retval FALSE Executive procedure not in sync mode. + +**/ +BOOLEAN +ExecutiveInSyncMode ( + IN SMM_CPU_CALL_IN_TYPE CallInType, + IN SPIN_LOCK *Token + ) +{ + if (CallInType =3D=3D SmmCpuCallInOldSyncType) { + return TRUE; + } + + return Token =3D=3D NULL; +} + /** Checks if all CPUs (with certain exceptions) have checked in for this SM= I run =20 @@ -347,6 +397,30 @@ ReplaceOSMtrrs ( MtrrSetAllMtrrs (&gSmiMtrrs); } =20 +/** + Clear the flags used for execute one procedure. + + @param BlockStyle Is this procedure block style or non-block. + @param SingleProcessor Is this procedure only for single processor. + +**/ +VOID +ClearProcedureFlags ( + IN BOOLEAN BlockStyle, + IN BOOLEAN SingleProcessor + ) +{ + mSmmMpSyncData->CpuCheckMode =3D SmmCpuCheckModeMax; + + if (SingleProcessor) { + mSmmMpSyncData->CpuIndex =3D (UINTN) -1; + } + + if (!BlockStyle) { + ReleaseSpinLock (mSmmMpSyncData->CurrentToken); + } +} + /** SMI handler for BSP. =20 @@ -604,6 +678,7 @@ APHandler ( UINT64 Timer; UINTN BspIndex; MTRR_SETTINGS Mtrrs; + EFI_STATUS ProcedureStatus; =20 // // Timeout BSP @@ -730,14 +805,43 @@ APHandler ( // // Invoke the scheduled procedure // - (*mSmmMpSyncData->CpuData[CpuIndex].Procedure) ( - (VOID*)mSmmMpSyncData->CpuData[CpuIndex].Parameter - ); + ProcedureStatus =3D (*mSmmMpSyncData->CpuData[CpuIndex].Procedure) ( + (VOID*)mSmmMpSyncData->CpuData[CpuIndex].Paramet= er + ); + + if (mSmmMpSyncData->CurrentToken !=3D NULL) { + if (mSmmMpSyncData->CpuCheckMode =3D=3D SmmCpuCheckModeSingle) { + if (mSmmMpSyncData->CpuStatus !=3D NULL) { + *mSmmMpSyncData->CpuStatus =3D ProcedureStatus; + } + } else { + ASSERT (mSmmMpSyncData->CpuCheckMode =3D=3D SmmCpuCheckModeAll); + if (mSmmMpSyncData->CpuStatus !=3D NULL) { + mSmmMpSyncData->CpuStatus[CpuIndex] =3D ProcedureStatus; + } + } + } =20 // // Release BUSY // ReleaseSpinLock (mSmmMpSyncData->CpuData[CpuIndex].Busy); + + // + // In non-block mode, Update the sync flags (CpuCheckMode, CpuIndex, F= inishTask, CurrentToken) here. + // + if (mSmmMpSyncData->CurrentToken !=3D NULL) { + if (mSmmMpSyncData->CpuCheckMode =3D=3D SmmCpuCheckModeSingle) { + if (mSmmMpSyncData->CpuIndex =3D=3D CpuIndex) { + ClearProcedureFlags (FALSE, TRUE); + } + } else if (mSmmMpSyncData->CpuCheckMode =3D=3D SmmCpuCheckModeAll) { + mSmmMpSyncData->FinishTask[CpuIndex] =3D TRUE; + if (TaskFinishInAllAPs()) { + ClearProcedureFlags (FALSE, FALSE); + } + } + } } =20 if (SmmCpuFeaturesNeedConfigureMtrrs()) { @@ -906,13 +1010,82 @@ Gen4GPageTable ( return (UINT32)(UINTN)PageTable; } =20 +/** + Checks whether the input token is the current used token. + + + @param[in] Token This parameter describes the token that was passe= d into DispatchProcedure or + BroadcastProcedure. + + @retval TRUE The input token is the current used token. + @retval FALSE The input token is not the current used token. +**/ +BOOLEAN +CurrentUsedToken ( + IN SPIN_LOCK *Token + ) +{ + return mSmmMpSyncData->CurrentToken =3D=3D Token; +} + +/** + Checks status of specified AP. + + This function checks whether the specified AP has finished the task assi= gned + by StartupThisAP(), and whether timeout expires. + + @param[in] Token This parameter describes the token that wa= s passed into DispatchProcedure or + BroadcastProcedure. + + @retval EFI_SUCCESS Specified AP has finished task assigned by= StartupThisAPs(). + @retval EFI_NOT_READY Specified AP has not finished task and tim= eout has not expired. +**/ +EFI_STATUS +CheckStatusForThisAP ( + IN SPIN_LOCK *Token + ) +{ + if (AcquireSpinLockOrFail (Token)) { + ReleaseSpinLock (Token); + return EFI_SUCCESS; + } + + return EFI_NOT_READY; +} + + /** Schedule a procedure to run on the specified CPU. =20 @param[in] Procedure The address of the procedure t= o run @param[in] CpuIndex Target CPU Index @param[in, out] ProcArguments The parameter to pass to the p= rocedure - @param[in] BlockingMode Startup AP in blocking mode or= not + @param[in] CallInType Which call for this function. + @param[in, out] Token This is parameter is broken in= to two components: + 1.Token->Completion is an opti= onal parameter that allows the + caller to execute the procedur= e in a blocking or non-blocking + fashion. If it is NULL the cal= l is blocking, and the call will + not return until the AP has co= mpleted the procedure. If the + token is not NULL, the call wi= ll return immediately. The caller + can check whether the procedur= e has completed with + CheckOnProcedure or WaitForPro= cedure. + 2.Token->Status The implementa= tion updates the address pointed + at by this variable with the s= tatus code returned by Procedure + when it completes execution on= the target AP, or with EFI_TIMEOUT + if the Procedure fails to comp= lete within the optional timeout. + The implementation will update= this variable with EFI_NOT_READY + prior to starting Procedure on= the target AP + @param[in] TimeoutInMicroseconds Indicates the time limit in mi= croseconds for the APs to finish + execution of Procedure, either= for blocking or non-blocking mode. + Zero means infinity. If the ti= meout expires before all APs return + from Procedure, then Procedure= on the failed APs is terminated. If + the timeout expires in blockin= g mode, the call returns EFI_TIMEOUT. + If the timeout expires in non-= blocking mode, the timeout determined + can be through CheckOnProcedur= e or WaitForProcedure. + Note that timeout support is o= ptional. Whether an implementation + supports this feature can be d= etermined via the Attributes data + member. + =20 @retval EFI_INVALID_PARAMETER CpuNumber not valid @retval EFI_INVALID_PARAMETER CpuNumber specifying BSP @@ -923,10 +1096,13 @@ Gen4GPageTable ( **/ EFI_STATUS InternalSmmStartupThisAp ( - IN EFI_AP_PROCEDURE Procedure, - IN UINTN CpuIndex, - IN OUT VOID *ProcArguments OPTIONAL, - IN BOOLEAN BlockingMode + IN EFI_AP_PROCEDURE Procedure, + IN UINTN CpuIndex, + IN OUT VOID *ProcArguments OPTIONAL, + IN SMM_CPU_CALL_IN_TYPE CallInType, + IN SPIN_LOCK *Token, + IN UINTN TimeoutInMicroseconds, + IN EFI_STATUS *CpuStatus ) { if (CpuIndex >=3D gSmmCpuPrivate->SmmCoreEntryContext.NumberOfCpus) { @@ -952,27 +1128,231 @@ InternalSmmStartupThisAp ( } return EFI_INVALID_PARAMETER; } + if ((TimeoutInMicroseconds !=3D 0) && ((mSmmMp.Attributes & EFI_SMM_MP_T= IMEOUT_SUPPORTED) =3D=3D 0)) { + DEBUG((DEBUG_ERROR, "Input TimeoutInMicroseconds !=3D 0 but EFI_SMM_MP= _TIMEOUT_SUPPORTED not supported!\n")); + return EFI_INVALID_PARAMETER; + } + if (Procedure =3D=3D NULL) { + return EFI_INVALID_PARAMETER; + } + if (Token !=3D NULL && Token =3D=3D mSmmMpSyncData->CurrentToken) { + return EFI_ALREADY_STARTED; + } + if (!AcquireSpinLockOrFail (mSmmMpSyncData->CpuData[CpuIndex].Busy)) { + return EFI_NOT_READY; + } else { + ReleaseSpinLock (mSmmMpSyncData->CpuData[CpuIndex].Busy); + } =20 - if (BlockingMode) { + if (ExecutiveInSyncMode (CallInType, Token)) { AcquireSpinLock (mSmmMpSyncData->CpuData[CpuIndex].Busy); } else { + if (Token !=3D NULL && !AcquireSpinLockOrFail (Token)) { + DEBUG((DEBUG_ERROR, "Token->Completion can't acquire\n")); + return EFI_INVALID_PARAMETER; + } if (!AcquireSpinLockOrFail (mSmmMpSyncData->CpuData[CpuIndex].Busy)) { DEBUG((DEBUG_ERROR, "mSmmMpSyncData->CpuData[%d].Busy\n", CpuIndex)); - return EFI_INVALID_PARAMETER; + ReleaseSpinLock (Token); + return EFI_NOT_READY; } } =20 - mSmmMpSyncData->CpuData[CpuIndex].Procedure =3D Procedure; + // + // PI spec requirement in EFI_MM_MP_PROTOCOL.DispatchProcedure(): + // The implementation will update this variable with + // EFI_NOT_READY prior to starting Procedure on the target AP. + // + mSmmMpSyncData->CurrentToken =3D Token; + mSmmMpSyncData->CpuCheckMode =3D SmmCpuCheckModeSingle; + mSmmMpSyncData->CpuIndex =3D CpuIndex; + mSmmMpSyncData->CpuStatus =3D CpuStatus; + if (mSmmMpSyncData->CpuStatus !=3D NULL) { + *mSmmMpSyncData->CpuStatus =3D EFI_NOT_READY; + } + + mSmmMpSyncData->CpuData[CpuIndex].Procedure =3D (EFI_AP_PROCEDURE2) Proc= edure; mSmmMpSyncData->CpuData[CpuIndex].Parameter =3D ProcArguments; + ReleaseSemaphore (mSmmMpSyncData->CpuData[CpuIndex].Run); =20 - if (BlockingMode) { + if (ExecutiveInSyncMode (CallInType, Token)) { AcquireSpinLock (mSmmMpSyncData->CpuData[CpuIndex].Busy); ReleaseSpinLock (mSmmMpSyncData->CpuData[CpuIndex].Busy); + + // + // In block mode, update the sync flags (CpuCheckMode, CpuIndex, Finis= hTask, CurrentToken) here. + // + if (Token =3D=3D NULL) { + ClearProcedureFlags (TRUE, TRUE); + } + } + + return EFI_SUCCESS; +} + +/** + Worker function to execute a caller provided function on all enabled APs. + + @param[in] Procedure A pointer to the function to be run = on + enabled APs of the system. + @param[in] SingleThread If TRUE, then all the enabled APs ex= ecute + the function specified by Procedure = one by + one, in ascending order of processor= handle + number. If FALSE, then all the enab= led APs + execute the function specified by Pr= ocedure + simultaneously. + @param[in] WaitEvent The event created by the caller with= CreateEvent() + service. + @param[in] TimeoutInMicroseconds Indicates the time limit in microsec= onds for + APs to return from Procedure, either= for + blocking or non-blocking mode. + @param[in] ProcedureArgument The parameter passed into Procedure = for + all APs. + @param[out] FailedCpuList If all APs finish successfully, then= its + content is set to NULL. If not all A= Ps + finish before timeout expires, then = its + content is set to address of the buf= fer + holding handle numbers of the failed= APs. + + @retval EFI_SUCCESS In blocking mode, all APs have finished = before + the timeout expired. + @retval EFI_SUCCESS In non-blocking mode, function has been = dispatched + to all enabled APs. + @retval others Failed to Startup all APs. + +**/ +EFI_STATUS +InternalSmmStartupAllAPs ( + IN EFI_AP_PROCEDURE2 Procedure, + IN UINTN TimeoutInMicroseconds, + IN OUT VOID *ProcedureArguments OPTIONAL, + IN OUT SPIN_LOCK *Token, + IN OUT EFI_STATUS *CPUStatus + ) +{ + UINTN Index; + UINTN CpuCount; + + if (Procedure =3D=3D NULL) { + return EFI_INVALID_PARAMETER; + } + if ((TimeoutInMicroseconds !=3D 0) && ((mSmmMp.Attributes & EFI_SMM_MP_T= IMEOUT_SUPPORTED) =3D=3D 0)) { + return EFI_INVALID_PARAMETER; + } + if (Token !=3D NULL && Token =3D=3D mSmmMpSyncData->CurrentToken) { + return EFI_ALREADY_STARTED; + } + + CpuCount =3D 0; + for (Index =3D mMaxNumberOfCpus; Index-- > 0;) { + if (*mSmmMpSyncData->CpuData[Index].Present && (Index !=3D gSmmCpuPriv= ate->SmmCoreEntryContext.CurrentlyExecutingCpu)) { + CpuCount ++; + + if (gSmmCpuPrivate->Operation[Index] =3D=3D SmmCpuRemove) { + return EFI_INVALID_PARAMETER; + } + + if (!AcquireSpinLockOrFail(mSmmMpSyncData->CpuData[Index].Busy)) { + return EFI_NOT_READY; + } + ReleaseSpinLock (mSmmMpSyncData->CpuData[Index].Busy); + } + } + if (CpuCount =3D=3D 0) { + return EFI_NOT_STARTED; + } + + if (Token =3D=3D NULL) { + // + // Make sure all BUSY should be acquired. + // + for (Index =3D mMaxNumberOfCpus; Index-- > 0;) { + if (Index !=3D gSmmCpuPrivate->SmmCoreEntryContext.CurrentlyExecutin= gCpu && *(mSmmMpSyncData->CpuData[Index].Present)) { + AcquireSpinLock (mSmmMpSyncData->CpuData[Index].Busy); + } + } + } else { + if (!AcquireSpinLockOrFail (Token)) { + return EFI_INVALID_PARAMETER; + } + + // + // Make sure all BUSY should be acquired. + // + for (Index =3D mMaxNumberOfCpus; Index-- > 0;) { + if (Index !=3D gSmmCpuPrivate->SmmCoreEntryContext.CurrentlyExecutin= gCpu && *(mSmmMpSyncData->CpuData[Index].Present)) { + if (!AcquireSpinLockOrFail (mSmmMpSyncData->CpuData[Index].Busy)) { + DEBUG((DEBUG_ERROR, "mSmmMpSyncData->CpuData[%d].Busy\n", Index)= ); + + // + // Release BUSY accquired before. + // + for (CpuCount =3D mMaxNumberOfCpus; CpuCount -- > Index;) { + if (CpuCount !=3D gSmmCpuPrivate->SmmCoreEntryContext.Currentl= yExecutingCpu && *(mSmmMpSyncData->CpuData[CpuCount].Present)) { + ReleaseSpinLock (mSmmMpSyncData->CpuData[CpuCount].Busy); + } + } + + ReleaseSpinLock (Token); + return EFI_INVALID_PARAMETER; + } + } + } + } + + // + // PI spec requirement: + // The implementation will update this variable with + // EFI_NOT_READY prior to starting Procedure on the target AP. + // + mSmmMpSyncData->CurrentToken =3D Token; + mSmmMpSyncData->CpuCheckMode =3D SmmCpuCheckModeAll; + mSmmMpSyncData->CpuStatus =3D CPUStatus; + + for (Index =3D mMaxNumberOfCpus; Index-- > 0;) { + if (Index !=3D gSmmCpuPrivate->SmmCoreEntryContext.CurrentlyExecutingC= pu && *(mSmmMpSyncData->CpuData[Index].Present)) { + mSmmMpSyncData->CpuData[Index].Procedure =3D (EFI_AP_PROCEDURE2) Pro= cedure; + mSmmMpSyncData->CpuData[Index].Parameter =3D ProcedureArguments; + } else { + // + // PI spec requirement: + // For every excluded processor, the array entry must contain a valu= e of EFI_NOT_STARTED. + // + if (mSmmMpSyncData->CpuStatus !=3D NULL) { + mSmmMpSyncData->CpuStatus[Index] =3D EFI_NOT_STARTED; + } + } + // + // Clear all status no matter this processor is used or not. + // May not need to clear all but add it to make the status clear. + // + mSmmMpSyncData->FinishTask[Index] =3D FALSE; } + + ReleaseAllAPs (); + + if (Token =3D=3D NULL) { + // + // Make sure all APs have completed their tasks. + // + for (Index =3D mMaxNumberOfCpus; Index-- > 0;) { + if (Index !=3D gSmmCpuPrivate->SmmCoreEntryContext.CurrentlyExecutin= gCpu && *(mSmmMpSyncData->CpuData[Index].Present)) { + AcquireSpinLock (mSmmMpSyncData->CpuData[Index].Busy); + ReleaseSpinLock (mSmmMpSyncData->CpuData[Index].Busy); + } + } + + // + // Update the sync flags (CpuCheckMode, CpuIndex, FinishTask, CurrentT= oken) in block mode here. + // + ClearProcedureFlags (TRUE, FALSE); + } + return EFI_SUCCESS; } =20 + /** Schedule a procedure to run on the specified CPU in blocking mode. =20 @@ -995,7 +1375,7 @@ SmmBlockingStartupThisAp ( IN OUT VOID *ProcArguments OPTIONAL ) { - return InternalSmmStartupThisAp(Procedure, CpuIndex, ProcArguments, TRUE= ); + return InternalSmmStartupThisAp(Procedure, CpuIndex, ProcArguments, SmmC= puCallInOldSyncType, NULL, 0, NULL); } =20 /** @@ -1020,7 +1400,15 @@ SmmStartupThisAp ( IN OUT VOID *ProcArguments OPTIONAL ) { - return InternalSmmStartupThisAp(Procedure, CpuIndex, ProcArguments, Feat= urePcdGet (PcdCpuSmmBlockStartupThisAp)); + SMM_CPU_CALL_IN_TYPE CallInType; + + if (FeaturePcdGet (PcdCpuSmmBlockStartupThisAp)) { + CallInType =3D SmmCpuCallInOldSyncType; + } else { + CallInType =3D SmmCpuCallInOldAsyncType; + } + + return InternalSmmStartupThisAp(Procedure, CpuIndex, ProcArguments, Call= InType, NULL, 0, NULL); } =20 /** @@ -1112,6 +1500,13 @@ SmiRendezvous ( Cr2 =3D 0; SaveCr2 (&Cr2); =20 + // + // Call the user register Startup function first. + // + if (mSmmMpSyncData->StartupProcedure !=3D NULL) { + mSmmMpSyncData->StartupProcedure (mSmmMpSyncData->StartupProcArgs); + } + // // Perform CPU specific entry hooks // @@ -1332,6 +1727,7 @@ InitializeMpSyncData ( ZeroMem (mSmmMpSyncData, mSmmMpSyncDataSize); mSmmMpSyncData->CpuData =3D (SMM_CPU_DATA_BLOCK *)((UINT8 *)mSmmMpSync= Data + sizeof (SMM_DISPATCHER_MP_SYNC_DATA)); mSmmMpSyncData->CandidateBsp =3D (BOOLEAN *)(mSmmMpSyncData->CpuData += gSmmCpuPrivate->SmmCoreEntryContext.NumberOfCpus); + mSmmMpSyncData->FinishTask =3D (BOOLEAN *)(mSmmMpSyncData->CandidateBs= p + gSmmCpuPrivate->SmmCoreEntryContext.NumberOfCpus); if (FeaturePcdGet (PcdCpuSmmEnableBspElection)) { // // Enable BSP election by setting BspIndex to -1 @@ -1360,6 +1756,10 @@ InitializeMpSyncData ( *(mSmmMpSyncData->CpuData[CpuIndex].Run) =3D 0; *(mSmmMpSyncData->CpuData[CpuIndex].Present) =3D FALSE; } + + mSmmMpSyncData->CpuCheckMode =3D SmmCpuCheckModeMax; + mSmmMpSyncData->CpuIndex =3D CpuIndex; + mSmmMpSyncData->CurrentToken =3D NULL; } } =20 @@ -1399,7 +1799,7 @@ InitializeMpServiceData ( // Initialize mSmmMpSyncData // mSmmMpSyncDataSize =3D sizeof (SMM_DISPATCHER_MP_SYNC_DATA) + - (sizeof (SMM_CPU_DATA_BLOCK) + sizeof (BOOLEAN)) * = gSmmCpuPrivate->SmmCoreEntryContext.NumberOfCpus; + (sizeof (SMM_CPU_DATA_BLOCK) + sizeof (BOOLEAN) + s= izeof (BOOLEAN)) * gSmmCpuPrivate->SmmCoreEntryContext.NumberOfCpus; mSmmMpSyncData =3D (SMM_DISPATCHER_MP_SYNC_DATA*) AllocatePages (EFI_SIZ= E_TO_PAGES (mSmmMpSyncDataSize)); ASSERT (mSmmMpSyncData !=3D NULL); mCpuSmmSyncMode =3D (SMM_CPU_SYNC_MODE)PcdGet8 (PcdCpuSmmSyncMode); @@ -1469,3 +1869,41 @@ RegisterSmmEntry ( gSmmCpuPrivate->SmmCoreEntry =3D SmmEntryPoint; return EFI_SUCCESS; } + +/** + + Register the SMM Foundation entry point. + + @param[in] Procedure A pointer to the code stream to be = run on the designated target AP + of the system. Type EFI_AP_PROCEDUR= E is defined below in Volume 2 + with the related definitions of + EFI_MP_SERVICES_PROTOCOL.StartupAll= APs. + If caller may pass a value of NULL = to deregister any existing + startup procedure. + @param[in,out] ProcedureArguments Allows the caller to pass a list of= parameters to the code that is + run by the AP. It is an optional co= mmon mailbox between APs and + the caller to share information + + @retval EFI_SUCCESS The Procedure has been set successf= ully. + @retval EFI_INVALID_PARAMETER The Procedure is NULL but Procedure= Arguments not NULL. + +**/ +EFI_STATUS +RegisterStartupProcedure ( + IN EFI_AP_PROCEDURE Procedure, + IN VOID *ProcedureArguments OPTIONAL + ) +{ + if (Procedure =3D=3D NULL && ProcedureArguments !=3D NULL) { + return EFI_INVALID_PARAMETER; + } + if (mSmmMpSyncData =3D=3D NULL) { + return EFI_NOT_READY; + } + + mSmmMpSyncData->StartupProcedure =3D Procedure; + mSmmMpSyncData->StartupProcArgs =3D ProcedureArguments; + + return EFI_SUCCESS; +} + diff --git a/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.c b/UefiCpuPkg/PiSmmC= puDxeSmm/PiSmmCpuDxeSmm.c index 2f7d777ee7..e498f72801 100644 --- a/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.c +++ b/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.c @@ -996,6 +996,17 @@ PiCpuSmmEntry ( ); ASSERT_EFI_ERROR (Status); =20 + // + // Install the SMM Mp Protocol into SMM protocol database + // + Status =3D gSmst->SmmInstallProtocolInterface ( + &mSmmCpuHandle, + &gEfiSmmMpProtocolGuid, + EFI_NATIVE_INTERFACE, + &mSmmMp + ); + ASSERT_EFI_ERROR (Status); + // // Expose address of CPU Hot Plug Data structure if CPU hot plug is supp= orted. // diff --git a/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h b/UefiCpuPkg/PiSmmC= puDxeSmm/PiSmmCpuDxeSmm.h index 2bb35a424d..b321ff15ee 100644 --- a/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h +++ b/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h @@ -20,6 +20,7 @@ SPDX-License-Identifier: BSD-2-Clause-Patent #include #include #include +#include =20 #include #include @@ -226,6 +227,7 @@ extern CPU_HOT_PLUG_DATA mCpuHotPlugData; extern UINTN mMaxNumberOfCpus; extern UINTN mNumberOfCpus; extern EFI_SMM_CPU_PROTOCOL mSmmCpu; +extern EFI_SMM_MP_PROTOCOL mSmmMp; =20 /// /// The mode of the CPU at the time an SMI occurs @@ -363,7 +365,7 @@ SmmRelocationSemaphoreComplete ( /// typedef struct { SPIN_LOCK *Busy; - volatile EFI_AP_PROCEDURE Procedure; + volatile EFI_AP_PROCEDURE2 Procedure; volatile VOID *Parameter; volatile UINT32 *Run; volatile BOOLEAN *Present; @@ -375,6 +377,19 @@ typedef enum { SmmCpuSyncModeMax } SMM_CPU_SYNC_MODE; =20 +typedef enum { + SmmCpuCheckModeSingle, + SmmCpuCheckModeAll, + SmmCpuCheckModeMax +} SMM_CPU_CHECK_MODE; + +typedef enum { + SmmCpuCallInOldSyncType, + SmmCpuCallInOldAsyncType, + SmmCpuCallInNewType, + SmmCpuCallInTypeMax +} SMM_CPU_CALL_IN_TYPE; + typedef struct { // // Pointer to an array. The array should be located immediately after th= is structure @@ -388,6 +403,14 @@ typedef struct { volatile SMM_CPU_SYNC_MODE EffectiveSyncMode; volatile BOOLEAN SwitchBsp; volatile BOOLEAN *CandidateBsp; + SPIN_LOCK *CurrentToken; + SMM_CPU_CHECK_MODE CpuCheckMode; + UINTN CpuIndex; + EFI_STATUS *CpuStatus; + volatile BOOLEAN *FinishTask; + + EFI_AP_PROCEDURE StartupProcedure; + VOID *StartupProcArgs; } SMM_DISPATCHER_MP_SYNC_DATA; =20 #define SMM_PSD_OFFSET 0xfb00 @@ -1259,4 +1282,151 @@ RestoreCr2 ( IN UINTN Cr2 ); =20 +/** + Schedule a procedure to run on the specified CPU. + + @param[in] Procedure The address of the procedure t= o run + @param[in] CpuIndex Target CPU Index + @param[in, out] ProcArguments The parameter to pass to the p= rocedure + @param[in] CallInType Which call for this function. + @param[in, out] Token This is parameter is broken in= to two components: + 1.Token->Completion is an opti= onal parameter that allows the + caller to execute the procedur= e in a blocking or non-blocking + fashion. If it is NULL the cal= l is blocking, and the call will + not return until the AP has co= mpleted the procedure. If the + token is not NULL, the call wi= ll return immediately. The caller + can check whether the procedur= e has completed with + CheckOnProcedure or WaitForPro= cedure. + 2.Token->Status The implementa= tion updates the address pointed + at by this variable with the s= tatus code returned by Procedure + when it completes execution on= the target AP, or with EFI_TIMEOUT + if the Procedure fails to comp= lete within the optional timeout. + The implementation will update= this variable with EFI_NOT_READY + prior to starting Procedure on= the target AP + @param[in] TimeoutInMicroseconds Indicates the time limit in mi= croseconds for the APs to finish + execution of Procedure, either= for blocking or non-blocking mode. + Zero means infinity. If the ti= meout expires before all APs return + from Procedure, then Procedure= on the failed APs is terminated. If + the timeout expires in blockin= g mode, the call returns EFI_TIMEOUT. + If the timeout expires in non-= blocking mode, the timeout determined + can be through CheckOnProcedur= e or WaitForProcedure. + Note that timeout support is o= ptional. Whether an implementation + supports this feature can be d= etermined via the Attributes data + member. + + + @retval EFI_INVALID_PARAMETER CpuNumber not valid + @retval EFI_INVALID_PARAMETER CpuNumber specifying BSP + @retval EFI_INVALID_PARAMETER The AP specified by CpuNumber did not e= nter SMM + @retval EFI_INVALID_PARAMETER The AP specified by CpuNumber is busy + @retval EFI_SUCCESS The procedure has been successfully sch= eduled + +**/ +EFI_STATUS +InternalSmmStartupThisAp ( + IN EFI_AP_PROCEDURE Procedure, + IN UINTN CpuIndex, + IN OUT VOID *ProcArguments OPTIONAL, + IN SMM_CPU_CALL_IN_TYPE CallInType, + IN SPIN_LOCK *Token, + IN UINTN TimeoutInMicroseconds, + IN EFI_STATUS *CpuStatus + ); + +/** + Checks whether the input token is the current used token. + + + @param[in] Token This parameter describes the token that was passe= d into DispatchProcedure or + BroadcastProcedure. + + @retval TRUE The input token is the current used token. + @retval FALSE The input token is not the current used token. +**/ +BOOLEAN +CurrentUsedToken ( + IN SPIN_LOCK *Token + ); + +/** + Checks status of specified AP. + + This function checks whether the specified AP has finished the task assi= gned + by StartupThisAP(), and whether timeout expires. + + @param[in] Token This parameter describes the token that wa= s passed into DispatchProcedure or + BroadcastProcedure. + + @retval EFI_SUCCESS Specified AP has finished task assigned by= StartupThisAPs(). + @retval EFI_NOT_READY Specified AP has not finished task and tim= eout has not expired. +**/ +EFI_STATUS +CheckStatusForThisAP ( + IN SPIN_LOCK *Token + ); + +/** + Worker function to execute a caller provided function on all enabled APs. + + @param[in] Procedure A pointer to the function to be run = on + enabled APs of the system. + @param[in] SingleThread If TRUE, then all the enabled APs ex= ecute + the function specified by Procedure = one by + one, in ascending order of processor= handle + number. If FALSE, then all the enab= led APs + execute the function specified by Pr= ocedure + simultaneously. + @param[in] WaitEvent The event created by the caller with= CreateEvent() + service. + @param[in] TimeoutInMicroseconds Indicates the time limit in microsec= onds for + APs to return from Procedure, either= for + blocking or non-blocking mode. + @param[in] ProcedureArgument The parameter passed into Procedure = for + all APs. + @param[out] FailedCpuList If all APs finish successfully, then= its + content is set to NULL. If not all A= Ps + finish before timeout expires, then = its + content is set to address of the buf= fer + holding handle numbers of the failed= APs. + + @retval EFI_SUCCESS In blocking mode, all APs have finished = before + the timeout expired. + @retval EFI_SUCCESS In non-blocking mode, function has been = dispatched + to all enabled APs. + @retval others Failed to Startup all APs. + +**/ +EFI_STATUS +InternalSmmStartupAllAPs ( + IN EFI_AP_PROCEDURE2 Procedure, + IN UINTN TimeoutInMicroseconds, + IN OUT VOID *ProcedureArguments OPTIONAL, + IN OUT SPIN_LOCK *Token, + IN OUT EFI_STATUS *CPUStatus + ); + +/** + + Register the SMM Foundation entry point. + + @param[in] Procedure A pointer to the code stream to be = run on the designated target AP + of the system. Type EFI_AP_PROCEDUR= E is defined below in Volume 2 + with the related definitions of + EFI_MP_SERVICES_PROTOCOL.StartupAll= APs. + If caller may pass a value of NULL = to deregister any existing + startup procedure. + @param[in,out] ProcedureArguments Allows the caller to pass a list of= parameters to the code that is + run by the AP. It is an optional co= mmon mailbox between APs and + the caller to share information + + @retval EFI_SUCCESS The Procedure has been set successf= ully. + @retval EFI_INVALID_PARAMETER The Procedure is NULL but Procedure= Arguments not NULL. + +**/ +EFI_STATUS +RegisterStartupProcedure ( + IN EFI_AP_PROCEDURE Procedure, + IN VOID *ProcedureArguments OPTIONAL + ); + #endif diff --git a/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.inf b/UefiCpuPkg/PiSm= mCpuDxeSmm/PiSmmCpuDxeSmm.inf index 466c568d49..f478ae62a7 100644 --- a/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.inf +++ b/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.inf @@ -40,6 +40,8 @@ SmmProfileInternal.h SmramSaveState.c SmmCpuMemoryManagement.c + MpProtocol.h + MpProtocol.c =20 [Sources.Ia32] Ia32/Semaphore.c @@ -105,6 +107,7 @@ gEfiSmmReadyToLockProtocolGuid ## NOTIFY gEfiSmmCpuServiceProtocolGuid ## PRODUCES gEdkiiSmmMemoryAttributeProtocolGuid ## PRODUCES + gEfiSmmMpProtocolGuid ## PRODUCES =20 [Guids] gEfiAcpiVariableGuid ## SOMETIMES_CONSUMES ## HOB # = it is used for S3 boot. --=20 2.21.0.windows.1 -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D- Groups.io Links: You receive all messages sent to this group. View/Reply Online (#42574): https://edk2.groups.io/g/devel/message/42574 Mute This Topic: https://groups.io/mt/32120263/1787277 Group Owner: devel+owner@edk2.groups.io Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org] -=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-=3D-