From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mga05.intel.com (mga05.intel.com []) by mx.groups.io with SMTP id smtpd.web11.17938.1574147512882678979 for ; Mon, 18 Nov 2019 23:11:54 -0800 Authentication-Results: mx.groups.io; dkim=missing; spf=fail (domain: intel.com, ip: , mailfrom: michael.a.kubacki@intel.com) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga002.jf.intel.com ([10.7.209.21]) by fmsmga105.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 18 Nov 2019 23:11:50 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.68,322,1569308400"; d="scan'208";a="218155766" Received: from makuback-desk1.amr.corp.intel.com ([10.7.159.162]) by orsmga002.jf.intel.com with ESMTP; 18 Nov 2019 23:11:50 -0800 From: "Kubacki, Michael A" To: devel@edk2.groups.io Cc: Michael D Kinney , Liming Gao Subject: [PATCH V1 2/2] MdePkg PiPeiCis.h: Improve PeiInstallPeiMemory() description Date: Mon, 18 Nov 2019 23:11:41 -0800 Message-Id: <20191119071141.17192-3-michael.a.kubacki@intel.com> X-Mailer: git-send-email 2.16.2.windows.1 In-Reply-To: <20191119071141.17192-1-michael.a.kubacki@intel.com> References: <20191119071141.17192-1-michael.a.kubacki@intel.com> Updates the function description for PeiInstallPeiMemory () to be more helpful. The description is based on that given in the PI Specification Version 1.7. Cc: Michael D Kinney Cc: Liming Gao Signed-off-by: Michael Kubacki --- MdePkg/Include/Pi/PiPeiCis.h | 26 ++++++++++++++++---- 1 file changed, 21 insertions(+), 5 deletions(-) diff --git a/MdePkg/Include/Pi/PiPeiCis.h b/MdePkg/Include/Pi/PiPeiCis.h index d9d4ed7d41..e8c48acb21 100644 --- a/MdePkg/Include/Pi/PiPeiCis.h +++ b/MdePkg/Include/Pi/PiPeiCis.h @@ -422,13 +422,29 @@ EFI_STATUS ); /** - This function registers the found memory configuration with the PEI Foundation. + Registers the found memory configuration with the PEI Foundation. - @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. - @param MemoryBegin The value of a region of installed memory. - @param MemoryLength The corresponding length of a region of installed memory. + This service enables PEIMs to register the permanent memory configuration that has been initialized + with the PEI Foundation. The result of this call-set is the creation of the appropriate Hand-Off Block + (HOB) describing the physical memory. - @retval EFI_SUCCESS The region was successfully installed in a HOB. + The usage model is that the PEIM that discovers the permanent memory shall invoke this service. + This routine will store discovered memory information in the PeiCore's private data, and set the + SwitchStackSignal flag. After the PEIM who discovered memory is dispatched, the PeiDispatcher will + migrate temporary memory to permanent memory. + + The memory reported is a single contiguous run. It should be enough to allocate a PEI stack and + some HOB list. The full memory map will be reported using the appropriate memory HOBs. The + PEI Foundation will follow up with an installation of EFI_PEI_PERMANENT_MEMORY_INSTALLED_PPI. + + Any invocations of this service after the first invocation which returns EFI_SUCCESS will be ignored. + + @param[in] PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation. + @param[in] MemoryBegin Start of memory address. + @param[in] MemoryLength Length of memory. + + @retval EFI_SUCCESS The region was successfully installed in a HOB or this service was successfully + invoked earlier and no HOB modification will occur. @retval EFI_INVALID_PARAMETER MemoryBegin and MemoryLength are illegal for this system. @retval EFI_OUT_OF_RESOURCES There is no additional space for HOB creation. -- 2.16.2.windows.1