From nobody Fri Apr 26 06:11:38 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+43462+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+43462+1787277+3901457@groups.io; dmarc=fail(p=none dis=none) header.from=intel.com ARC-Seal: i=1; a=rsa-sha256; t=1562745388; cv=none; d=zoho.com; s=zohoarc; b=X9lGI3VE64vGfcFExva/+jT0HS2AiSnyzxhbZRuKKVC7UekLpK2AAJ8Ka1nFg4XE+ZT+tYRBkDcnMdLtytpfhs03tQz/YHq+YWySin4dy6oVobRiujv08f3OPT2ShgJ10nWXFYp34i9muPVptsHfdoBBjxNiKuP6tquIVtmiTAI= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1562745388; 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/6YYeeUvk9757GcRSD3a480tibVKl+hfSP3rqhv7Rw=; b=iQz8mXgW4EAqMTa0auYxfaJXxW6r26pmnc+L3vrbQbNJ6LvP16p3dBxoBZSaEW2BeV0GXVmKBMeyEY2pY9Q490w61aZ1he5N0v2vRygize/ps5djqRk4d5gLIce7h+B93iUQyYy46t2dP01EXq2PoDbGEkPyhjlkjsy2eDVlQv8= 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+43462+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 156274538802585.4663363609261; Wed, 10 Jul 2019 00:56:28 -0700 (PDT) Return-Path: X-Received: from mga14.intel.com (mga14.intel.com []) by groups.io with SMTP; Wed, 10 Jul 2019 00:56:27 -0700 X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False X-Received: from fmsmga007.fm.intel.com ([10.253.24.52]) by fmsmga103.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 10 Jul 2019 00:56:27 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.63,473,1557212400"; d="scan'208";a="167654046" X-Received: from ydong10-win10.ccr.corp.intel.com ([10.239.158.133]) by fmsmga007.fm.intel.com with ESMTP; 10 Jul 2019 00:56:25 -0700 From: "Dong, Eric" To: devel@edk2.groups.io Cc: Ray Ni , Laszlo Ersek Subject: [edk2-devel] [Patch v5 1/2] MdePkg: Add new MM MP Protocol definition. Date: Wed, 10 Jul 2019 15:56:23 +0800 Message-Id: <20190710075624.16420-2-eric.dong@intel.com> In-Reply-To: <20190710075624.16420-1-eric.dong@intel.com> References: <20190710075624.16420-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=1562745387; bh=WI1XLacWE5jp5oW29GoG/Ugl63pRacQ/HsATvHOYooE=; h=Cc:Date:From:Reply-To:Subject:To; b=r9CqbYAPkWO0pmwOlWZNRIUaS87Ao8o2JXTTx23jOpv1Ery4zly44vyDKzhSA5zFYzB +aoFgHebg7gbuRfTWgxB/wkmdjFUhjyKEgeZ4plNQCKa2JP/PC1Z6P9Q9nU+6gO8d1phU xHh+Cl+xCqLwp3U5THUfUyFN1IRv+uDhMgc= X-ZohoMail-DKIM: pass (identity @groups.io) Content-Type: text/plain; charset="utf-8" REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3D1937 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 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 Reviewed-by: Ray Ni Acked-by. (Standing for "I haven't reviewed in detail, but given the --- MdePkg/Include/Pi/PiMultiPhase.h | 16 ++ MdePkg/Include/Protocol/MmMp.h | 333 +++++++++++++++++++++++++++++++ MdePkg/MdePkg.dec | 3 + 3 files changed, 352 insertions(+) create mode 100644 MdePkg/Include/Protocol/MmMp.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..beace1386c --- /dev/null +++ b/MdePkg/Include/Protocol/MmMp.h @@ -0,0 +1,333 @@ +/** @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/MdePkg.dec b/MdePkg/MdePkg.dec index 6c563375ee..b382efd578 100644 --- a/MdePkg/MdePkg.dec +++ b/MdePkg/MdePkg.dec @@ -1167,6 +1167,9 @@ # Protocols defined in PI 1.5. # =20 + ## 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 (#43462): https://edk2.groups.io/g/devel/message/43462 Mute This Topic: https://groups.io/mt/32414081/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 Fri Apr 26 06:11:38 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+43463+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+43463+1787277+3901457@groups.io; dmarc=fail(p=none dis=none) header.from=intel.com ARC-Seal: i=1; a=rsa-sha256; t=1562745390; cv=none; d=zoho.com; s=zohoarc; b=W5D/02nZ2KLbp4XVDzBd+SEoFj30YLERHsdkjoHxSWTRBYLsr2hQO6ViwyqmcUUdRV5XvnBmSckx4PNr1DsGOUg1XzqdQhWg2JVBJnb41jzS5yQPbc1l7h4iI82Kq+a/MoPQxbNwg5pOhDAUusYdfAf/6CrZGLQ0nghXDsMfKW8= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1562745390; 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=VEwwXXmLBlyFFhir6TF9Kn0t9marP7Gj4PoniOV/2xY=; b=FKeDzL4XdApRbJM+EbHncAHS0dHnMcMo2kCMe7ROMC5DdbMFv7xGSbVg3v8WWa6Tai0xaREND5Uaxg6Hn82SdxRO+LE/BBfSAc00aqozjReX139Iexdbslz58yswnEuIR505Rj5buZigpszspysl75ubmXaA80DZe4LYIUd/EK8= 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+43463+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 1562745390033245.41013712154563; Wed, 10 Jul 2019 00:56:30 -0700 (PDT) Return-Path: X-Received: from mga14.intel.com (mga14.intel.com []) by groups.io with SMTP; Wed, 10 Jul 2019 00:56:29 -0700 X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False X-Received: from fmsmga007.fm.intel.com ([10.253.24.52]) by fmsmga103.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 10 Jul 2019 00:56:29 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.63,473,1557212400"; d="scan'208";a="167654054" X-Received: from ydong10-win10.ccr.corp.intel.com ([10.239.158.133]) by fmsmga007.fm.intel.com with ESMTP; 10 Jul 2019 00:56:26 -0700 From: "Dong, Eric" To: devel@edk2.groups.io Cc: Ray Ni , Laszlo Ersek Subject: [edk2-devel] [Patch v5 2/2] UefiCpuPkg/PiSmmCpuDxeSmm: Enable MM MP Protocol Date: Wed, 10 Jul 2019 15:56:24 +0800 Message-Id: <20190710075624.16420-3-eric.dong@intel.com> In-Reply-To: <20190710075624.16420-1-eric.dong@intel.com> References: <20190710075624.16420-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=1562745389; bh=X786yHPTbfspNUcS347xKzY+duA4WXJRRwRTsWEvHiI=; h=Cc:Date:From:Reply-To:Subject:To; b=g7Yqs7PzGiAeMwjXYPjEIWvdHinBJgE6pmsLcsx+idbGil2o6YEzqtglNRgOpLB8hrc y2GR2boV67JKieGaSq+k4PackpH612Y8sFUbQrCVRU+NMvGDTaDvb9uK1IyI27b7AwJDy SUhJ03BKadJNvEaiKaxfhgdGrGCdZCHKnuw= X-ZohoMail-DKIM: pass (identity @groups.io) Content-Type: text/plain; charset="utf-8" V5 changes: 1. some small enhancement. v4 changes: 1. Use link list to save the token info. v3 changes: 1. Fix Token clean up too early caused CheckProcedure return error. v2 changes: 1. Remove some duplicated global variables. 2. Enhance token design to support multiple task trig for different APs at = the same time. V1 changes: REF: https://bugzilla.tianocore.org/show_bug.cgi?id=3D1937 Add MM Mp Protocol in PiSmmCpuDxeSmm driver. Cc: Ray Ni Cc: Laszlo Ersek Signed-off-by: Eric Dong Reviewed-by: Ray Ni --- UefiCpuPkg/PiSmmCpuDxeSmm/MpService.c | 570 ++++++++++++++++++- UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.c | 18 + UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h | 193 ++++++- UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.inf | 3 + UefiCpuPkg/PiSmmCpuDxeSmm/SmmMp.c | 344 +++++++++++ UefiCpuPkg/PiSmmCpuDxeSmm/SmmMp.h | 286 ++++++++++ 6 files changed, 1391 insertions(+), 23 deletions(-) create mode 100644 UefiCpuPkg/PiSmmCpuDxeSmm/SmmMp.c create mode 100644 UefiCpuPkg/PiSmmCpuDxeSmm/SmmMp.h diff --git a/UefiCpuPkg/PiSmmCpuDxeSmm/MpService.c b/UefiCpuPkg/PiSmmCpuDxe= Smm/MpService.c index 64fb4d6344..f09e2738c3 100644 --- a/UefiCpuPkg/PiSmmCpuDxeSmm/MpService.c +++ b/UefiCpuPkg/PiSmmCpuDxeSmm/MpService.c @@ -140,7 +140,7 @@ ReleaseAllAPs ( =20 BspIndex =3D mSmmMpSyncData->BspIndex; for (Index =3D mMaxNumberOfCpus; Index-- > 0;) { - if (Index !=3D BspIndex && *(mSmmMpSyncData->CpuData[Index].Present)) { + if (IsPresentAp (Index)) { ReleaseSemaphore (mSmmMpSyncData->CpuData[Index].Run); } } @@ -347,6 +347,165 @@ ReplaceOSMtrrs ( MtrrSetAllMtrrs (&gSmiMtrrs); } =20 +/** + Wheck whether task has been finished by all APs. + + @param BlockMode Whether did it in block mode or non-block mode. + + @retval TRUE Task has been finished by all APs. + @retval FALSE Task not has been finished by all APs. + +**/ +BOOLEAN +WaitForAllAPsNotBusy ( + IN BOOLEAN BlockMode + ) +{ + UINTN Index; + + for (Index =3D mMaxNumberOfCpus; Index-- > 0;) { + // + // Ignore BSP and APs which not call in SMM. + // + if (!IsPresentAp(Index)) { + continue; + } + + if (BlockMode) { + AcquireSpinLock(mSmmMpSyncData->CpuData[Index].Busy); + ReleaseSpinLock(mSmmMpSyncData->CpuData[Index].Busy); + } else { + if (AcquireSpinLockOrFail (mSmmMpSyncData->CpuData[Index].Busy)) { + ReleaseSpinLock(mSmmMpSyncData->CpuData[Index].Busy); + } else { + return FALSE; + } + } + } + + return TRUE; +} + +/** + Check whether it is an present AP. + + @param CpuIndex The AP index which calls this function. + + @retval TRUE It's a present AP. + @retval TRUE This is not an AP or it is not present. + +**/ +BOOLEAN +IsPresentAp ( + IN UINTN CpuIndex + ) +{ + return ((CpuIndex !=3D gSmmCpuPrivate->SmmCoreEntryContext.CurrentlyExec= utingCpu) && + *(mSmmMpSyncData->CpuData[CpuIndex].Present)); +} + +/** + Check whether execute in single AP or all APs. + + Compare two Tokens used by different APs to know whether in StartAllAps = call. + + Whether is an valid AP base on AP's Present flag. + + @retval TRUE IN StartAllAps call. + @retval FALSE Not in StartAllAps call. + +**/ +BOOLEAN +InStartAllApsCall ( + VOID + ) +{ + UINTN ApIndex; + UINTN ApIndex2; + + for (ApIndex =3D mMaxNumberOfCpus; ApIndex-- > 0;) { + if (IsPresentAp (ApIndex) && (mSmmMpSyncData->CpuData[ApIndex].Token != =3D NULL)) { + for (ApIndex2 =3D ApIndex; ApIndex2-- > 0;) { + if (IsPresentAp (ApIndex2) && (mSmmMpSyncData->CpuData[ApIndex2].T= oken !=3D NULL)) { + return mSmmMpSyncData->CpuData[ApIndex2].Token =3D=3D mSmmMpSync= Data->CpuData[ApIndex].Token; + } + } + } + } + + return FALSE; +} + +/** + Clean up the status flags used during executing the procedure. + + @param CpuIndex The AP index which calls this function. + +**/ +VOID +ReleaseToken ( + IN UINTN CpuIndex + ) +{ + UINTN Index; + BOOLEAN Released; + + if (InStartAllApsCall ()) { + // + // In Start All APs mode, make sure all APs have finished task. + // + if (WaitForAllAPsNotBusy (FALSE)) { + // + // Clean the flags update in the function call. + // + Released =3D FALSE; + for (Index =3D mMaxNumberOfCpus; Index-- > 0;) { + // + // Only In SMM APs need to be clean up. + // + if (mSmmMpSyncData->CpuData[Index].Present && mSmmMpSyncData->CpuD= ata[Index].Token !=3D NULL) { + if (!Released) { + ReleaseSpinLock (mSmmMpSyncData->CpuData[Index].Token); + Released =3D TRUE; + } + mSmmMpSyncData->CpuData[Index].Token =3D NULL; + } + } + } + } else { + // + // In single AP mode. + // + if (mSmmMpSyncData->CpuData[CpuIndex].Token !=3D NULL) { + ReleaseSpinLock (mSmmMpSyncData->CpuData[CpuIndex].Token); + mSmmMpSyncData->CpuData[CpuIndex].Token =3D NULL; + } + } +} + +/** + Free the tokens in the maintained list. + +**/ +VOID +FreeTokens ( + VOID + ) +{ + LIST_ENTRY *Link; + PROCEDURE_TOKEN *ProcToken; + + while (!IsListEmpty (&gSmmCpuPrivate->TokenList)) { + Link =3D GetFirstNode (&gSmmCpuPrivate->TokenList); + ProcToken =3D PROCEDURE_TOKEN_FROM_LINK (Link); + + RemoveEntryList (&ProcToken->Link); + + FreePool ((VOID *)ProcToken->ProcedureToken); + FreePool (ProcToken); + } +} + /** SMI handler for BSP. =20 @@ -476,12 +635,7 @@ BSPHandler ( // // Make sure all APs have completed their pending none-block tasks // - for (Index =3D mMaxNumberOfCpus; Index-- > 0;) { - if (Index !=3D CpuIndex && *(mSmmMpSyncData->CpuData[Index].Present)) { - AcquireSpinLock (mSmmMpSyncData->CpuData[Index].Busy); - ReleaseSpinLock (mSmmMpSyncData->CpuData[Index].Busy); - } - } + WaitForAllAPsNotBusy (TRUE); =20 // // Perform the remaining tasks @@ -572,6 +726,11 @@ BSPHandler ( // WaitForAllAPs (ApCount); =20 + // + // Clean the tokens buffer. + // + FreeTokens (); + // // Reset BspIndex to -1, meaning BSP has not been elected. // @@ -604,6 +763,7 @@ APHandler ( UINT64 Timer; UINTN BspIndex; MTRR_SETTINGS Mtrrs; + EFI_STATUS ProcedureStatus; =20 // // Timeout BSP @@ -730,14 +890,19 @@ 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->CpuData[CpuIndex].Status !=3D NULL) { + *mSmmMpSyncData->CpuData[CpuIndex].Status =3D ProcedureStatus; + } =20 // // Release BUSY // ReleaseSpinLock (mSmmMpSyncData->CpuData[CpuIndex].Busy); + + ReleaseToken (CpuIndex); } =20 if (SmmCpuFeaturesNeedConfigureMtrrs()) { @@ -906,13 +1071,124 @@ 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 +IsTokenInUse ( + IN SPIN_LOCK *Token + ) +{ + LIST_ENTRY *Link; + PROCEDURE_TOKEN *ProcToken; + + if (Token =3D=3D NULL) { + return FALSE; + } + + Link =3D GetFirstNode (&gSmmCpuPrivate->TokenList); + while (!IsNull (&gSmmCpuPrivate->TokenList, Link)) { + ProcToken =3D PROCEDURE_TOKEN_FROM_LINK (Link); + + if (ProcToken->ProcedureToken =3D=3D Token) { + return TRUE; + } + + Link =3D GetNextNode (&gSmmCpuPrivate->TokenList, Link); + } + + return FALSE; +} + +/** + create token and save it to the maintain list. + + @retval return the spin lock used as token. + +**/ +SPIN_LOCK * +CreateToken ( + VOID + ) +{ + PROCEDURE_TOKEN *ProcToken; + SPIN_LOCK *CpuToken; + UINTN SpinLockSize; + + SpinLockSize =3D GetSpinLockProperties (); + CpuToken =3D AllocatePool (SpinLockSize); + ASSERT (CpuToken !=3D NULL); + InitializeSpinLock (CpuToken); + AcquireSpinLock (CpuToken); + + ProcToken =3D AllocatePool (sizeof (PROCEDURE_TOKEN)); + ASSERT (ProcToken !=3D NULL); + ProcToken->Signature =3D PROCEDURE_TOKEN_SIGNATURE; + ProcToken->ProcedureToken =3D CpuToken; + + InsertTailList (&gSmmCpuPrivate->TokenList, &ProcToken->Link); + + return CpuToken; +} + +/** + 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 +IsApReady ( + 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,out] ProcArguments The parameter to pass to the p= rocedure + @param[in] Token This 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 + completed the procedure. If th= e token is not NULL, the call will + return immediately. The caller= can check whether the procedure has + completed with CheckOnProcedur= e or WaitForProcedure. + @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. + @param[in,out] CpuStatus This optional pointer may be u= sed to get the status code returned + by Procedure when it completes= execution on the target AP, or with + EFI_TIMEOUT if the Procedure f= ails to complete within the optional + timeout. The implementation wi= ll update this variable with + EFI_NOT_READY prior to startin= g Procedure on the target AP. =20 @retval EFI_INVALID_PARAMETER CpuNumber not valid @retval EFI_INVALID_PARAMETER CpuNumber specifying BSP @@ -923,10 +1199,12 @@ Gen4GPageTable ( **/ EFI_STATUS InternalSmmStartupThisAp ( - IN EFI_AP_PROCEDURE Procedure, - IN UINTN CpuIndex, - IN OUT VOID *ProcArguments OPTIONAL, - IN BOOLEAN BlockingMode + IN EFI_AP_PROCEDURE2 Procedure, + IN UINTN CpuIndex, + IN OUT VOID *ProcArguments OPTIONAL, + IN MM_COMPLETION *Token, + IN UINTN TimeoutInMicroseconds, + IN OUT EFI_STATUS *CpuStatus ) { if (CpuIndex >=3D gSmmCpuPrivate->SmmCoreEntryContext.NumberOfCpus) { @@ -952,24 +1230,190 @@ InternalSmmStartupThisAp ( } return EFI_INVALID_PARAMETER; } + if ((TimeoutInMicroseconds !=3D 0) && ((mSmmMp.Attributes & EFI_MM_MP_TI= MEOUT_SUPPORTED) =3D=3D 0)) { + return EFI_INVALID_PARAMETER; + } + if (Procedure =3D=3D NULL) { + return EFI_INVALID_PARAMETER; + } =20 - if (BlockingMode) { + if (Token =3D=3D NULL) { AcquireSpinLock (mSmmMpSyncData->CpuData[CpuIndex].Busy); } else { if (!AcquireSpinLockOrFail (mSmmMpSyncData->CpuData[CpuIndex].Busy)) { - DEBUG((DEBUG_ERROR, "mSmmMpSyncData->CpuData[%d].Busy\n", CpuIndex)); - return EFI_INVALID_PARAMETER; + DEBUG((DEBUG_ERROR, "Can't acquire mSmmMpSyncData->CpuData[%d].Busy\= n", CpuIndex)); + return EFI_NOT_READY; } + + *Token =3D (MM_COMPLETION) CreateToken (); } =20 mSmmMpSyncData->CpuData[CpuIndex].Procedure =3D Procedure; mSmmMpSyncData->CpuData[CpuIndex].Parameter =3D ProcArguments; + if (Token !=3D NULL) { + mSmmMpSyncData->CpuData[CpuIndex].Token =3D (SPIN_LOCK *)(*Token); + } + mSmmMpSyncData->CpuData[CpuIndex].Status =3D CpuStatus; + if (mSmmMpSyncData->CpuData[CpuIndex].Status !=3D NULL) { + *mSmmMpSyncData->CpuData[CpuIndex].Status =3D EFI_NOT_READY; + } + ReleaseSemaphore (mSmmMpSyncData->CpuData[CpuIndex].Run); =20 - if (BlockingMode) { + if (Token =3D=3D NULL) { AcquireSpinLock (mSmmMpSyncData->CpuData[CpuIndex].Busy); ReleaseSpinLock (mSmmMpSyncData->CpuData[CpuIndex].Busy); } + + 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 r= un on + enabled APs of the system. + @param[in] TimeoutInMicroseconds Indicates the time limit in micro= seconds for + APs to return from Procedure, eit= her for + blocking or non-blocking mode. + @param[in,out] ProcedureArguments The parameter passed into Procedu= re for + all APs. + @param[in,out] Token This is an optional parameter tha= t allows the caller to execute the + procedure in a blocking or non-bl= ocking fashion. If it is NULL the + call is blocking, and the call wi= ll not return until the AP has + completed the procedure. If the t= oken is not NULL, the call will + return immediately. The caller ca= n check whether the procedure has + completed with CheckOnProcedure o= r WaitForProcedure. + @param[in,out] CPUStatus This optional pointer may be used= to get the status code returned + by Procedure when it completes ex= ecution on the target AP, or with + EFI_TIMEOUT if the Procedure fail= s to complete within the optional + timeout. The implementation will = update this variable with + EFI_NOT_READY prior to starting P= rocedure on the target AP. + + + @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 MM_COMPLETION *Token, + IN OUT EFI_STATUS *CPUStatus + ) +{ + UINTN Index; + UINTN CpuCount; + + if ((TimeoutInMicroseconds !=3D 0) && ((mSmmMp.Attributes & EFI_MM_MP_TI= MEOUT_SUPPORTED) =3D=3D 0)) { + return EFI_INVALID_PARAMETER; + } + if (Procedure =3D=3D NULL) { + return EFI_INVALID_PARAMETER; + } + + CpuCount =3D 0; + for (Index =3D mMaxNumberOfCpus; Index-- > 0;) { + if (IsPresentAp (Index)) { + 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 NULL) { + *Token =3D (MM_COMPLETION) CreateToken (); + } + + // + // Make sure all BUSY should be acquired. + // + // Because former code already check mSmmMpSyncData->CpuData[***].Busy f= or each AP. + // Here code always use AcquireSpinLock instead of AcquireSpinLockOrFail= for not + // block mode. + // + for (Index =3D mMaxNumberOfCpus; Index-- > 0;) { + if (IsPresentAp (Index)) { + AcquireSpinLock (mSmmMpSyncData->CpuData[Index].Busy); + } + } + + for (Index =3D mMaxNumberOfCpus; Index-- > 0;) { + if (IsPresentAp (Index)) { + mSmmMpSyncData->CpuData[Index].Procedure =3D (EFI_AP_PROCEDURE2) Pro= cedure; + mSmmMpSyncData->CpuData[Index].Parameter =3D ProcedureArguments; + if (Token !=3D NULL) { + mSmmMpSyncData->CpuData[Index].Token =3D (SPIN_LOCK *)(*Token); + } + if (CPUStatus !=3D NULL) { + mSmmMpSyncData->CpuData[Index].Status =3D &CPUStatus[Index]; + if (mSmmMpSyncData->CpuData[Index].Status !=3D NULL) { + *mSmmMpSyncData->CpuData[Index].Status =3D EFI_NOT_READY; + } + } + } else { + // + // PI spec requirement: + // For every excluded processor, the array entry must contain a valu= e of EFI_NOT_STARTED. + // + if (CPUStatus !=3D NULL) { + CPUStatus[Index] =3D EFI_NOT_STARTED; + } + } + } + + ReleaseAllAPs (); + + if (Token =3D=3D NULL) { + // + // Make sure all APs have completed their tasks. + // + WaitForAllAPsNotBusy (TRUE); + } + + return EFI_SUCCESS; +} + +/** + ISO C99 6.5.2.2 "Function calls", paragraph 9: + If the function is defined with a type that is not compatible with + the type (of the expression) pointed to by the expression that + denotes the called function, the behavior is undefined. + + So add below wrapper function to convert between EFI_AP_PROCEDURE + and EFI_AP_PROCEDURE2. + + Wrapper for Procedures. + + @param[in] Buffer Pointer to PROCEDURE_WRAPPER buffer. + +**/ +EFI_STATUS +EFIAPI +ProcedureWrapper ( + IN OUT VOID *Buffer + ) +{ + PROCEDURE_WRAPPER *Wrapper; + + Wrapper =3D Buffer; + Wrapper->Procedure (Wrapper->ProcedureArgument); + return EFI_SUCCESS; } =20 @@ -995,7 +1439,15 @@ SmmBlockingStartupThisAp ( IN OUT VOID *ProcArguments OPTIONAL ) { - return InternalSmmStartupThisAp(Procedure, CpuIndex, ProcArguments, TRUE= ); + PROCEDURE_WRAPPER Wrapper; + + Wrapper.Procedure =3D Procedure; + Wrapper.ProcedureArgument =3D ProcArguments; + + // + // Use wrapper function to convert EFI_AP_PROCEDURE to EFI_AP_PROCEDURE2. + // + return InternalSmmStartupThisAp (ProcedureWrapper, CpuIndex, &Wrapper, N= ULL, 0, NULL); } =20 /** @@ -1020,7 +1472,22 @@ SmmStartupThisAp ( IN OUT VOID *ProcArguments OPTIONAL ) { - return InternalSmmStartupThisAp(Procedure, CpuIndex, ProcArguments, Feat= urePcdGet (PcdCpuSmmBlockStartupThisAp)); + MM_COMPLETION Token; + + gSmmCpuPrivate->ApWrapperFunc[CpuIndex].Procedure =3D Procedure; + gSmmCpuPrivate->ApWrapperFunc[CpuIndex].ProcedureArgument =3D ProcArgume= nts; + + // + // Use wrapper function to convert EFI_AP_PROCEDURE to EFI_AP_PROCEDURE2. + // + return InternalSmmStartupThisAp ( + ProcedureWrapper, + CpuIndex, + &gSmmCpuPrivate->ApWrapperFunc[CpuIndex], + FeaturePcdGet (PcdCpuSmmBlockStartupThisAp) ? NULL : &Token, + 0, + NULL + ); } =20 /** @@ -1112,6 +1579,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 // @@ -1256,6 +1730,21 @@ Exit: RestoreCr2 (Cr2); } =20 +/** + Allocate buffer for SpinLock and Wrapper function buffer. + +**/ +VOID +InitializeDataForMmMp ( + VOID + ) +{ + gSmmCpuPrivate->ApWrapperFunc =3D AllocatePool (sizeof (PROCEDURE_WRAPPE= R) * gSmmCpuPrivate->SmmCoreEntryContext.NumberOfCpus); + ASSERT (gSmmCpuPrivate->ApWrapperFunc !=3D NULL); + + InitializeListHead (&gSmmCpuPrivate->TokenList); +} + /** Allocate buffer for all semaphores and spin locks. =20 @@ -1469,3 +1958,40 @@ 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] 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..69a04dfb23 100644 --- a/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.c +++ b/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.c @@ -34,6 +34,8 @@ SMM_CPU_PRIVATE_DATA mSmmCpuPrivateData =3D { mSmmCpuPrivateData.SmmReservedSmramRegion, // SmmConfiguration.SmramR= eservedRegions RegisterSmmEntry // SmmConfiguration.Regist= erSmmEntry }, + NULL, // pointer to Ap Wrapper F= unc array + {NULL, NULL}, // List_Entry for Tokens. }; =20 CPU_HOT_PLUG_DATA mCpuHotPlugData =3D { @@ -996,6 +998,22 @@ PiCpuSmmEntry ( ); ASSERT_EFI_ERROR (Status); =20 + // + // Initialize global buffer for MM MP. + // + InitializeDataForMmMp (); + + // + // Install the SMM Mp Protocol into SMM protocol database + // + Status =3D gSmst->SmmInstallProtocolInterface ( + &mSmmCpuHandle, + &gEfiMmMpProtocolGuid, + 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..186809f431 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 @@ -197,6 +198,25 @@ typedef UINT32 SMM_CPU_AR= RIVAL_EXCEPTIONS; #define ARRIVAL_EXCEPTION_DELAYED 0x2 #define ARRIVAL_EXCEPTION_SMI_DISABLED 0x4 =20 +// +// Wrapper used to convert EFI_AP_PROCEDURE2 and EFI_AP_PROCEDURE. +// +typedef struct { + EFI_AP_PROCEDURE Procedure; + VOID *ProcedureArgument; +} PROCEDURE_WRAPPER; + +#define PROCEDURE_TOKEN_SIGNATURE SIGNATURE_32 ('P', 'R', 'T', 'S') + +typedef struct { + UINTN Signature; + LIST_ENTRY Link; + + SPIN_LOCK *ProcedureToken; +} PROCEDURE_TOKEN; + +#define PROCEDURE_TOKEN_FROM_LINK(a) CR (a, PROCEDURE_TOKEN, Link, PROCED= URE_TOKEN_SIGNATURE) + // // Private structure for the SMM CPU module that is stored in DXE Runtime = memory // Contains the SMM Configuration Protocols that is produced. @@ -219,6 +239,10 @@ typedef struct { EFI_SMM_ENTRY_POINT SmmCoreEntry; =20 EFI_SMM_CONFIGURATION_PROTOCOL SmmConfiguration; + + PROCEDURE_WRAPPER *ApWrapperFunc; + LIST_ENTRY TokenList; + } SMM_CPU_PRIVATE_DATA; =20 extern SMM_CPU_PRIVATE_DATA *gSmmCpuPrivate; @@ -226,6 +250,7 @@ extern CPU_HOT_PLUG_DATA mCpuHotPlugData; extern UINTN mMaxNumberOfCpus; extern UINTN mNumberOfCpus; extern EFI_SMM_CPU_PROTOCOL mSmmCpu; +extern EFI_MM_MP_PROTOCOL mSmmMp; =20 /// /// The mode of the CPU at the time an SMI occurs @@ -363,10 +388,12 @@ 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; + SPIN_LOCK *Token; + EFI_STATUS *Status; } SMM_CPU_DATA_BLOCK; =20 typedef enum { @@ -388,6 +415,8 @@ typedef struct { volatile SMM_CPU_SYNC_MODE EffectiveSyncMode; volatile BOOLEAN SwitchBsp; volatile BOOLEAN *CandidateBsp; + EFI_AP_PROCEDURE StartupProcedure; + VOID *StartupProcArgs; } SMM_DISPATCHER_MP_SYNC_DATA; =20 #define SMM_PSD_OFFSET 0xfb00 @@ -410,6 +439,7 @@ typedef struct { SPIN_LOCK *Busy; volatile UINT32 *Run; volatile BOOLEAN *Present; + SPIN_LOCK *Token; } SMM_CPU_SEMAPHORE_CPU; =20 /// @@ -1259,4 +1289,165 @@ 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,out] Token This 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 + completed the procedure. If th= e token is not NULL, the call will + return immediately. The caller= can check whether the procedure has + completed with CheckOnProcedur= e or WaitForProcedure. + @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. + @param[in,out] CPUStatus This optional pointer may be u= sed to get the status code returned + by Procedure when it completes= execution on the target AP, or with + EFI_TIMEOUT if the Procedure f= ails to complete within the optional + timeout. The implementation wi= ll update this variable with + EFI_NOT_READY prior to startin= g Procedure on the target AP. + + @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_PROCEDURE2 Procedure, + IN UINTN CpuIndex, + IN OUT VOID *ProcArguments OPTIONAL, + IN MM_COMPLETION *Token, + IN UINTN TimeoutInMicroseconds, + IN OUT 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 +IsTokenInUse ( + 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 +IsApReady ( + IN SPIN_LOCK *Token + ); + +/** + Check whether it is an present AP. + + @param CpuIndex The AP index which calls this function. + + @retval TRUE It's a present AP. + @retval TRUE This is not an AP or it is not present. + +**/ +BOOLEAN +IsPresentAp ( + IN UINTN CpuIndex + ); + +/** + Worker function to execute a caller provided function on all enabled APs. + + @param[in] Procedure A pointer to the function to be r= un on + enabled APs of the system. + @param[in] TimeoutInMicroseconds Indicates the time limit in micro= seconds for + APs to return from Procedure, eit= her for + blocking or non-blocking mode. + @param[in,out] ProcedureArgument The parameter passed into Procedu= re for + all APs. + @param[in,out] Token This is an optional parameter tha= t allows the caller to execute the + procedure in a blocking or non-bl= ocking fashion. If it is NULL the + call is blocking, and the call wi= ll not return until the AP has + completed the procedure. If the t= oken is not NULL, the call will + return immediately. The caller ca= n check whether the procedure has + completed with CheckOnProcedure o= r WaitForProcedure. + @param[in,out] CPUStatus This optional pointer may be used= to get the status code returned + by Procedure when it completes ex= ecution on the target AP, or with + EFI_TIMEOUT if the Procedure fail= s to complete within the optional + timeout. The implementation will = update this variable with + EFI_NOT_READY prior to starting P= rocedure on the target AP. + + @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 MM_COMPLETION *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 + ); + +/** + Allocate buffer for SpinLock and Wrapper function buffer. + +**/ +VOID +InitializeDataForMmMp ( + VOID + ); + #endif diff --git a/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.inf b/UefiCpuPkg/PiSm= mCpuDxeSmm/PiSmmCpuDxeSmm.inf index 466c568d49..da0308c47f 100644 --- a/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.inf +++ b/UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.inf @@ -40,6 +40,8 @@ SmmProfileInternal.h SmramSaveState.c SmmCpuMemoryManagement.c + SmmMp.h + SmmMp.c =20 [Sources.Ia32] Ia32/Semaphore.c @@ -105,6 +107,7 @@ gEfiSmmReadyToLockProtocolGuid ## NOTIFY gEfiSmmCpuServiceProtocolGuid ## PRODUCES gEdkiiSmmMemoryAttributeProtocolGuid ## PRODUCES + gEfiMmMpProtocolGuid ## PRODUCES =20 [Guids] gEfiAcpiVariableGuid ## SOMETIMES_CONSUMES ## HOB # = it is used for S3 boot. diff --git a/UefiCpuPkg/PiSmmCpuDxeSmm/SmmMp.c b/UefiCpuPkg/PiSmmCpuDxeSmm/= SmmMp.c new file mode 100644 index 0000000000..9b2b191e03 --- /dev/null +++ b/UefiCpuPkg/PiSmmCpuDxeSmm/SmmMp.c @@ -0,0 +1,344 @@ +/** @file +SMM MP protocol implementation + +Copyright (c) 2019, Intel Corporation. All rights reserved.
+ +SPDX-License-Identifier: BSD-2-Clause-Patent + +**/ + +#include "PiSmmCpuDxeSmm.h" +#include "SmmMp.h" + +/// +/// SMM MP Protocol instance +/// +EFI_MM_MP_PROTOCOL mSmmMp =3D { + EFI_MM_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_MM_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 + @retval EFI_OUT_OF_RESOURCES Could not allocate a required reso= urce. + +**/ +EFI_STATUS +EFIAPI +SmmMpDispatchProcedure ( + 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 + ) +{ + return InternalSmmStartupThisAp ( + Procedure, + CpuNumber, + ProcedureArguments, + Token, + 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. + @retval EFI_OUT_OF_RESOURCES Could not allocate a required reso= urce. + +**/ +EFI_STATUS +EFIAPI +SmmMpBroadcastProcedure ( + 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 + ) +{ + return InternalSmmStartupAllAPs( + Procedure, + TimeoutInMicroseconds, + ProcedureArguments, + Token, + 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_MM_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_MM_MP_PROTOCOL *This, + IN MM_COMPLETION Token + ) +{ + if (Token =3D=3D NULL) { + return EFI_INVALID_PARAMETER; + } + + if (!IsTokenInUse ((SPIN_LOCK *)Token)) { + return EFI_NOT_FOUND; + } + + return IsApReady ((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_MM_MP_PROTOCOL *This, + IN MM_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/SmmMp.h b/UefiCpuPkg/PiSmmCpuDxeSmm/= SmmMp.h new file mode 100644 index 0000000000..e0d823a4b1 --- /dev/null +++ b/UefiCpuPkg/PiSmmCpuDxeSmm/SmmMp.h @@ -0,0 +1,286 @@ +/** @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_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 + @retval EFI_OUT_OF_RESOURCES Could not allocate a required reso= urce. + +**/ +EFI_STATUS +EFIAPI +SmmMpDispatchProcedure ( + 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-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 + @retval EFI_OUT_OF_RESOURCES Could not allocate a required reso= urce. + +**/ +EFI_STATUS +EFIAPI +SmmMpBroadcastProcedure ( + 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 but Procedure= Arguments not NULL. +**/ +EFI_STATUS +EFIAPI +SmmMpSetStartupProcedure ( + 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 + +**/ +EFI_STATUS +EFIAPI +SmmMpCheckForProcedure ( + 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 + +**/ +EFI_STATUS +EFIAPI +SmmMpWaitForProcedure ( + IN CONST EFI_MM_MP_PROTOCOL *This, + IN MM_COMPLETION Token + ); + +#endif --=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 (#43463): https://edk2.groups.io/g/devel/message/43463 Mute This Topic: https://groups.io/mt/32414082/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-