From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from linux.microsoft.com (linux.microsoft.com [13.77.154.182]) by mx.groups.io with SMTP id smtpd.web09.12103.1647966064390613169 for ; Tue, 22 Mar 2022 09:21:04 -0700 Authentication-Results: mx.groups.io; dkim=fail reason="body hash did not verify" header.i=@linux.microsoft.com header.s=default header.b=VbMxixSZ; spf=pass (domain: linux.microsoft.com, ip: 13.77.154.182, mailfrom: mikuback@linux.microsoft.com) Received: from localhost.localdomain (unknown [47.202.59.224]) by linux.microsoft.com (Postfix) with ESMTPSA id E9B1520B4783; Tue, 22 Mar 2022 09:21:02 -0700 (PDT) DKIM-Filter: OpenDKIM Filter v2.11.0 linux.microsoft.com E9B1520B4783 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linux.microsoft.com; s=default; t=1647966064; bh=31tKxCgfmEvhEjzJLq+cUGdleR8XuW7ssqDVdF/xOUA=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=VbMxixSZNKfvv/qnZpc65WLcshOSk8fY2i1pa9OExRjvV7WaXYTD6kNKxcZ54mcXZ Wg0eRRIY8TjbS/gllt9LKkPCL9u4gjVFq88slmBd+CAKTHsJPP5nUbVNVVViqMwbwZ SdaVC+j4+H3w3mnxwztMbeNsczh2GqfKDS7h89ik= From: "Michael Kubacki" To: devel@edk2.groups.io Cc: Andrew Fish , Kang Gao , Michael D Kinney , Michael Kubacki , Leif Lindholm , Benjamin You , Liu Yun , Ankit Sinha , Nate DeSimone Subject: [PATCH v1 11/41] PrmPkg: Add ALLOCATE_CONTEXT_BUFFER_IN_FW build option Date: Tue, 22 Mar 2022 12:19:17 -0400 Message-Id: <20220322161947.9319-12-mikuback@linux.microsoft.com> X-Mailer: git-send-email 2.28.0.windows.1 In-Reply-To: <20220322161947.9319-1-mikuback@linux.microsoft.com> References: <20220322161947.9319-1-mikuback@linux.microsoft.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable From: Michael Kubacki There's currently two approaches being considered for how to allocate the context buffer passed to PRM handlers: 1. The context buffer is allocated and populated in firmware. As such, th= e FW converts all pointers internal to the buffer to virtual memory addresses at the virtual address change event. A single context buffer pointer is given to the OS via the PRM ACPI table and the OS converts this single physical address to a virtual address when it passes the context buffer as a pointer to PRM handlers. 2. The context buffer is allocated and populated in the OS. The OS gets all the information needed to populate the context buffer from other pre-existing resources (mainly physical addresses in the PRM ACPI table). The OS converts all the physical addresses to virtual addresse= s, allocates the context buffer instances, and fills in the information. The OS passes the context buffer virtual address to PRM handlers. The prior behavior was (1). The current POR behavior has moved to (2). Until (2) is used more widely, it can be kept around with fairly minimal overhead via a build flag in a few places. So the default behavior is now (2) (the expected permanent behavior) with (1) easily enabled by defining "ALLOCATE_CONTEXT_BUFFER_IN_FW" in the compiler defined macros. A DSC define was added in PrmPkg.dsc to set this compiler macro in the package build. At some point in the future, all code (and some peripheral code) surrounded with this build flag can be removed if (2) is fully decided upon. Cc: Andrew Fish Cc: Kang Gao Cc: Michael D Kinney Cc: Michael Kubacki Cc: Leif Lindholm Cc: Benjamin You Cc: Liu Yun Cc: Ankit Sinha Cc: Nate DeSimone Signed-off-by: Michael Kubacki --- PrmPkg/PrmConfigDxe/PrmConfigDxe.c = | 51 +++++++++++++------- PrmPkg/PrmLoaderDxe/PrmLoaderDxe.c = | 6 ++- PrmPkg/Samples/PrmSampleContextBufferModule/Library/DxeContextBufferModu= leConfigLib/DxeContextBufferModuleConfigLib.c | 16 ++++++ PrmPkg/PrmLoaderDxe/PrmAcpiTable.h = | 4 ++ PrmPkg/PrmPkg.dsc = | 5 ++ PrmPkg/Readme.md = | 12 +++++ 6 files changed, 76 insertions(+), 18 deletions(-) diff --git a/PrmPkg/PrmConfigDxe/PrmConfigDxe.c b/PrmPkg/PrmConfigDxe/Prm= ConfigDxe.c index cb38146bc9e0..7215c2e1dc6f 100644 --- a/PrmPkg/PrmConfigDxe/PrmConfigDxe.c +++ b/PrmPkg/PrmConfigDxe/PrmConfigDxe.c @@ -28,8 +28,8 @@ STATIC UINTN mMaxRuntimeMmioRangeCount; STATIC UINTN mMaxStaticDataBufferCount; =20 -STATIC PRM_RUNTIME_MMIO_RANGES **mRuntimeMmioRanges; -STATIC PRM_DATA_BUFFER ***mStaticDataBuffers; +GLOBAL_REMOVE_IF_UNREFERENCED STATIC PRM_RUNTIME_MMIO_RANGES **mRunti= meMmioRanges; +GLOBAL_REMOVE_IF_UNREFERENCED STATIC PRM_DATA_BUFFER ***mStat= icDataBuffers; =20 /** Converts the runtime memory range physical addresses to virtual addres= ses. @@ -178,32 +178,23 @@ StoreVirtualMemoryAddressChangePointers ( ) { EFI_STATUS Status; - UINTN BufferIndex; UINTN HandleCount; UINTN HandleIndex; UINTN RangeIndex; +#ifdef ALLOCATE_CONTEXT_BUFFER_IN_FW + UINTN BufferIndex; UINTN StaticDataBufferIndex; + PRM_CONTEXT_BUFFER *CurrentContextBuffer; +#endif EFI_HANDLE *HandleBuffer; PRM_CONFIG_PROTOCOL *PrmConfigProtocol; - PRM_CONTEXT_BUFFER *CurrentContextBuffer; =20 DEBUG ((DEBUG_INFO, "%a %a - Entry.\n", _DBGMSGID_, __FUNCTION__)); =20 RangeIndex =3D 0; +#ifdef ALLOCATE_CONTEXT_BUFFER_IN_FW StaticDataBufferIndex =3D 0; =20 - mRuntimeMmioRanges =3D AllocateRuntimeZeroPool (sizeof (*mRuntimeMmioR= anges) * mMaxRuntimeMmioRangeCount); - if (mRuntimeMmioRanges =3D=3D NULL && mMaxRuntimeMmioRangeCount > 0) { - DEBUG (( - DEBUG_ERROR, - " %a %a: Memory allocation for runtime MMIO pointer array failed.= \n", - _DBGMSGID_, - __FUNCTION__ - )); - ASSERT (FALSE); - return; - } - mStaticDataBuffers =3D AllocateRuntimeZeroPool (sizeof (*mStaticDataBu= ffers) * mMaxStaticDataBufferCount); if (mStaticDataBuffers =3D=3D NULL && mMaxStaticDataBufferCount > 0) { DEBUG (( @@ -215,6 +206,19 @@ StoreVirtualMemoryAddressChangePointers ( ASSERT (FALSE); return; } +#endif + + mRuntimeMmioRanges =3D AllocateRuntimeZeroPool (sizeof (*mRuntimeMmioR= anges) * mMaxRuntimeMmioRangeCount); + if (mRuntimeMmioRanges =3D=3D NULL && mMaxRuntimeMmioRangeCount > 0) { + DEBUG (( + DEBUG_ERROR, + " %a %a: Memory allocation for runtime MMIO pointer array failed.= \n", + _DBGMSGID_, + __FUNCTION__ + )); + ASSERT (FALSE); + return; + } =20 HandleBuffer =3D NULL; Status =3D gBS->LocateHandleBuffer ( @@ -236,6 +240,7 @@ StoreVirtualMemoryAddressChangePointers ( continue; } =20 +#ifdef ALLOCATE_CONTEXT_BUFFER_IN_FW for (BufferIndex =3D 0; BufferIndex < PrmConfigProtocol->ModuleCon= textBuffers.BufferCount; BufferIndex++) { CurrentContextBuffer =3D &(PrmConfigProtocol->ModuleContextBuffe= rs.Buffer[BufferIndex]); =20 @@ -256,6 +261,7 @@ StoreVirtualMemoryAddressChangePointers ( mStaticDataBuffers[StaticDataBufferIndex++] =3D &CurrentContex= tBuffer->StaticDataBuffer; } } +#endif if (PrmConfigProtocol->ModuleContextBuffers.RuntimeMmioRanges !=3D= NULL) { if (RangeIndex >=3D mMaxRuntimeMmioRangeCount) { Status =3D EFI_BUFFER_TOO_SMALL; @@ -280,6 +286,7 @@ StoreVirtualMemoryAddressChangePointers ( __FUNCTION__, RangeIndex )); +#ifdef ALLOCATE_CONTEXT_BUFFER_IN_FW DEBUG (( DEBUG_INFO, " %a %a: %d static buffers saved for future virtual memory conver= sion.\n", @@ -287,6 +294,7 @@ StoreVirtualMemoryAddressChangePointers ( __FUNCTION__, StaticDataBufferIndex )); +#endif } } =20 @@ -388,12 +396,14 @@ PrmConfigVirtualAddressChangeEvent ( { UINTN Index; =20 +#ifdef ALLOCATE_CONTEXT_BUFFER_IN_FW // // Convert static data buffer pointers // for (Index =3D 0; Index < mMaxStaticDataBufferCount; Index++) { gRT->ConvertPointer (0x0, (VOID **) mStaticDataBuffers[Index]); } +#endif =20 // // Convert runtime MMIO ranges @@ -484,7 +494,7 @@ PrmConfigEndOfDxeNotification ( if (PrmConfigProtocol->ModuleContextBuffers.RuntimeMmioRanges !=3D= NULL) { DEBUG (( DEBUG_INFO, - " %a %a: Found %d PRM runtime MMIO ranges to convert.\n", + " %a %a: Found %d PRM runtime MMIO ranges.\n", _DBGMSGID_, __FUNCTION__, PrmConfigProtocol->ModuleContextBuffers.RuntimeMmioRanges->Co= unt @@ -541,6 +551,13 @@ PrmConfigEntryPoint ( ); ASSERT_EFI_ERROR (Status); =20 + DEBUG ((DEBUG_INFO, " %a %a: Context buffers will be allocated in ", = _DBGMSGID_, __FUNCTION__)); +#ifdef ALLOCATE_CONTEXT_BUFFER_IN_FW + DEBUG ((DEBUG_INFO, "firmware.\n")); +#else + DEBUG ((DEBUG_INFO, "the operating system.\n")); +#endif + // // Register a notification function for virtual address change // diff --git a/PrmPkg/PrmLoaderDxe/PrmLoaderDxe.c b/PrmPkg/PrmLoaderDxe/Prm= LoaderDxe.c index b43e6d6bf078..85fffdcbd9f1 100644 --- a/PrmPkg/PrmLoaderDxe/PrmLoaderDxe.c +++ b/PrmPkg/PrmLoaderDxe/PrmLoaderDxe.c @@ -755,7 +755,11 @@ ProcessPrmModules ( &CurrentContextBuffer ); if (!EFI_ERROR (Status)) { - CurrentHandlerInfoStruct->PrmContextBuffer =3D (UINT64) CurrentC= ontextBuffer; +#ifdef ALLOCATE_CONTEXT_BUFFER_IN_FW + CurrentHandlerInfoStruct->PrmContextBuffer =3D (UINT64) (UINTN) = CurrentContextBuffer; +#else + CurrentHandlerInfoStruct->StaticDataBuffer =3D (UINT64) (UINTN) = CurrentContextBuffer->StaticDataBuffer; +#endif } =20 Status =3D GetExportEntryAddress ( diff --git a/PrmPkg/Samples/PrmSampleContextBufferModule/Library/DxeConte= xtBufferModuleConfigLib/DxeContextBufferModuleConfigLib.c b/PrmPkg/Sample= s/PrmSampleContextBufferModule/Library/DxeContextBufferModuleConfigLib/Dx= eContextBufferModuleConfigLib.c index 3bf5beba7d4a..b0b12c012a41 100644 --- a/PrmPkg/Samples/PrmSampleContextBufferModule/Library/DxeContextBuffe= rModuleConfigLib/DxeContextBufferModuleConfigLib.c +++ b/PrmPkg/Samples/PrmSampleContextBufferModule/Library/DxeContextBuffe= rModuleConfigLib/DxeContextBufferModuleConfigLib.c @@ -151,10 +151,26 @@ ContextBufferModuleConfigLibConstructor ( // // Allocate and populate the context buffer // +#ifdef ALLOCATE_CONTEXT_BUFFER_IN_FW + // + // The context buffer allocated in FW will continue being used at OS r= untime so it must + // be a runtime services data buffer. + // // This sample module uses a single context buffer for all the handler= s // Todo: This can be done more elegantly in the future. Likely though = a library service. // PrmContextBuffer =3D AllocateRuntimeZeroPool (sizeof (*PrmContextBuffe= r)); +#else + // + // This context buffer is not actually used by PRM handler at OS runti= me. The OS will allocate + // the actual context buffer passed to the PRM handler. + // + // This context buffer is used internally in the firmware to associate= a PRM handler with a + // a static data buffer and a runtime MMIO ranges array so those can b= e placed into the + // PRM_HANDLER_INFORMATION_STRUCT and PRM_MODULE_INFORMATION_STRUCT re= spectively for the PRM handler. + // + PrmContextBuffer =3D AllocateZeroPool (sizeof (*PrmContextBuffer)); +#endif ASSERT (PrmContextBuffer !=3D NULL); if (PrmContextBuffer =3D=3D NULL) { Status =3D EFI_OUT_OF_RESOURCES; diff --git a/PrmPkg/PrmLoaderDxe/PrmAcpiTable.h b/PrmPkg/PrmLoaderDxe/Prm= AcpiTable.h index 6b9099ca7ba7..8a9c82347d93 100644 --- a/PrmPkg/PrmLoaderDxe/PrmAcpiTable.h +++ b/PrmPkg/PrmLoaderDxe/PrmAcpiTable.h @@ -30,8 +30,10 @@ typedef struct { UINT16 StructureLength; ///< L= ength in bytes of this structure GUID Identifier; ///< G= UID of the PRM handler for this structure UINT64 PhysicalAddress; ///< P= hysical address of this PRM handler +#ifdef ALLOCATE_CONTEXT_BUFFER_IN_FW UINT64 PrmContextBuffer; ///< P= hysical address of the context buffer for this ///< P= RM handler (PRM_CONTEXT_BUFFER *) +#else UINT64 StaticDataBuffer; ///< P= hysical address of the static data buffer for ///< t= his PRM handler (PRM_DATA_BUFFER *) UINT64 AcpiParameterBuffer; ///< P= hysical address of the parameter buffer @@ -39,6 +41,8 @@ typedef struct { ///< t= hat is only used in the case of _DSM invocation. ///< I= f _DSM invocation is not used, this value is ///< i= gnored. +#endif + } PRM_HANDLER_INFORMATION_STRUCT; =20 typedef struct { diff --git a/PrmPkg/PrmPkg.dsc b/PrmPkg/PrmPkg.dsc index a0237d1fe059..1a0ddc6ac181 100644 --- a/PrmPkg/PrmPkg.dsc +++ b/PrmPkg/PrmPkg.dsc @@ -105,3 +105,8 @@ [Components] [BuildOptions] # Force deprecated interfaces off *_*_*_CC_FLAGS =3D -D DISABLE_NEW_DEPRECATED_INTERFACES + +# Append package-specific build settings +!ifdef $(ALLOCATE_CONTEXT_BUFFER_IN_FW) + *_*_*_CC_FLAGS =3D -D ALLOCATE_CONTEXT_BUFFER_IN_FW +!endif diff --git a/PrmPkg/Readme.md b/PrmPkg/Readme.md index b67b3a391e37..00ef41bc5f42 100644 --- a/PrmPkg/Readme.md +++ b/PrmPkg/Readme.md @@ -68,6 +68,18 @@ record (POR) configuration. The following list are the currently defined build flags (if any) that m= ay be passed to the `build` command (e.g. -D FLAG=3DVALUE). =20 +* `ALLOCATE_CONTEXT_BUFFER_IN_FW` - Allocates the context buffer for eac= h PRM handler in the firmware instead of + the operating system (OS). + + Additional detail: The context buffer structure is defined in [PrmCon= textBuffer.h](PrmPkg/Include/PrmContextBuffer.h). + This structure can be instantiated by either firmware with a physical= pointer to the buffer placed in the + `PRM_HANDLER_INFORMATION_STRUCT` for each handler wherein the OS woul= d convert that physical pointer and pass it + as a virtual address pointer to each PRM handler. Alternatively, the = context buffer can be allocated and populated + by the OS where it would get all the information to populate the cont= ext buffer from other structures. + + The default is for the OS to allocate and populate the buffer. The al= ternative option of the firmware doing this + work is kept in the source code until broader OS testing is completed= . + ## Overview At a high-level, PRM can be viewed from three levels of granularity: =20 --=20 2.28.0.windows.1