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.12157.1647966215082881895 for ; Tue, 22 Mar 2022 09:23:35 -0700 Authentication-Results: mx.groups.io; dkim=fail reason="body hash did not verify" header.i=@linux.microsoft.com header.s=default header.b=lDnO5NgG; 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 C4AA320B4783; Tue, 22 Mar 2022 09:23:33 -0700 (PDT) DKIM-Filter: OpenDKIM Filter v2.11.0 linux.microsoft.com C4AA320B4783 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linux.microsoft.com; s=default; t=1647966214; bh=h/J5lHxUXJ2fMI6qDOEYHxwFrCqY8Sw/ZVb/SYtAAsE=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=lDnO5NgGuJsX7FxeqYUXsOJS57BTzvRfvde9zeRHJsEc8eVtgJCtzg4MPA7xH2Y60 UzTuTFkZBa1PB5nzRWTBz0fbNE2tRoCTjgwe7WsjxGLam8ssIIRGQvdmjpcSur6/qg I/2BnNaSE3u+o6UsXrmK/RnBU01u6hGN0r0TBIkA= 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 37/41] PrmPkg/Samples: Remove PrmSamplePrintModule Date: Tue, 22 Mar 2022 12:19:43 -0400 Message-Id: <20220322161947.9319-38-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-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable From: Michael Kubacki This sample module is removed since it directly depends on OS services which are no longer supported as of the current PRM design. 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/Samples/PrmSamplePrintModule/PrmSamplePrintModule.c | 157 -----= --------------- PrmPkg/PrmPkg.dsc | 1 - PrmPkg/PrmSsdtInstallDxe/Prm.asl | 5 - PrmPkg/Samples/PrmSamplePrintModule/PrmSamplePrintModule.inf | 41 ----- PrmPkg/Samples/Readme.md | 73 +----= ---- 5 files changed, 1 insertion(+), 276 deletions(-) diff --git a/PrmPkg/Samples/PrmSamplePrintModule/PrmSamplePrintModule.c b= /PrmPkg/Samples/PrmSamplePrintModule/PrmSamplePrintModule.c deleted file mode 100644 index 85e8eb28a231..000000000000 --- a/PrmPkg/Samples/PrmSamplePrintModule/PrmSamplePrintModule.c +++ /dev/null @@ -1,157 +0,0 @@ -/** @file - - A sample PRM Module implementation. This PRM Module provides 3 PRM han= dlers that simply take a DEBUG print - function from the OS and invoke it with a debug message internal the P= RM handler. - - Copyright (c) Microsoft Corporation - SPDX-License-Identifier: BSD-2-Clause-Patent - -**/ - -#include - -#include -#include - -// -// PRM Handler GUIDs -// - -// {d5f2ad5f-a347-4d3e-87bc-c2ce63029cc8} -#define PRM_HANDLER_1_GUID {0xd5f2ad5f, 0xa347, 0x4d3e, {0x87, 0xbc, 0xc= 2, 0xce, 0x63, 0x02, 0x9c, 0xc8}} - -// {a9e7adc3-8cd0-429a-8915-10946ebde318} -#define PRM_HANDLER_2_GUID {0xa9e7adc3, 0x8cd0, 0x429a, {0x89, 0x15, 0x= 10, 0x94, 0x6e, 0xbd, 0xe3, 0x18}} - -// {b688c214-4081-4eeb-8d26-1eb5a3bcf11a} -#define PRM_HANDLER_N_GUID {0xb688c214, 0x4081, 0x4eeb, {0x8d, 0x26, 0x1= e, 0xb5, 0xa3, 0xbc, 0xf1, 0x1a}} - -/** - A sample Platform Runtime Mechanism (PRM) handler. - - This sample handler currently uses the OS_SERVICES to write a debug me= ssage - indicating this is PRM handler 1. - - @param[in] ParameterBuffer A pointer to the PRM handler parameter= buffer - @param[in] ContextBUffer A pointer to the PRM handler context b= uffer - - @retval EFI_STATUS The PRM handler executed successfully. - @retval Others An error occurred in the PRM handler. - -**/ -EFI_STATUS -PRM_EXPORT_API -EFIAPI -PrmHandler1 ( - IN VOID *ParameterBuffer, - IN PRM_CONTEXT_BUFFER *ContextBUffer - ) -{ - PRM_OS_SERVICE_DEBUG_PRINT OsServiceDebugPrint; - - if (ParameterBuffer =3D=3D NULL) { - return EFI_INVALID_PARAMETER; - } - - // In the POC, the OS debug print service is assumed to be at the begi= nning of ParameterBuffer - OsServiceDebugPrint =3D *((PRM_OS_SERVICE_DEBUG_PRINT *) ParameterBuff= er); - if (OsServiceDebugPrint =3D=3D NULL) { - return EFI_INVALID_PARAMETER; - } - OsServiceDebugPrint ("PRM1 handler sample message!\n"); - - return EFI_SUCCESS; -} - -/** - A sample Platform Runtime Mechanism (PRM) handler. - - This sample handler currently uses the OS_SERVICES to write a debug me= ssage - indicating this is PRM handler 2. - - @param[in] ParameterBuffer A pointer to the PRM handler parameter = buffer - @param[in] ContextBUffer A pointer to the PRM handler context bu= ffer - - @retval EFI_STATUS The PRM handler executed successfully. - @retval Others An error occurred in the PRM handler. - -**/ -EFI_STATUS -PRM_EXPORT_API -EFIAPI -PrmHandler2 ( - IN VOID *ParameterBuffer, - IN PRM_CONTEXT_BUFFER *ContextBUffer - ) -{ - PRM_OS_SERVICE_DEBUG_PRINT OsServiceDebugPrint; - - if (ParameterBuffer =3D=3D NULL) { - return EFI_INVALID_PARAMETER; - } - - // In the POC, the OS debug print service is assumed to be at the begi= nning of ParameterBuffer - OsServiceDebugPrint =3D *((PRM_OS_SERVICE_DEBUG_PRINT *) ParameterBuff= er); - if (OsServiceDebugPrint =3D=3D NULL) { - return EFI_INVALID_PARAMETER; - } - OsServiceDebugPrint ("PRM2 handler sample message!\n"); - - return EFI_SUCCESS; -} - -/** - A sample Platform Runtime Mechanism (PRM) handler. - - This sample handler currently uses the OS_SERVICES to write a debug me= ssage - indicating this is PRM handler N. - - @param[in] ParameterBuffer A pointer to the PRM handler parameter = buffer - @param[in] ContextBUffer A pointer to the PRM handler context bu= ffer - - @retval EFI_STATUS The PRM handler executed successfully. - @retval Others An error occurred in the PRM handler. - -**/ -EFI_STATUS -PRM_EXPORT_API -EFIAPI -PrmHandlerN ( - IN VOID *ParameterBuffer, - IN PRM_CONTEXT_BUFFER *ContextBUffer - ) -{ - PRM_OS_SERVICE_DEBUG_PRINT OsServiceDebugPrint; - - if (ParameterBuffer =3D=3D NULL) { - return EFI_INVALID_PARAMETER; - } - - // In the POC, the OS debug print service is assumed to be at the begi= nning of ParameterBuffer - OsServiceDebugPrint =3D *((PRM_OS_SERVICE_DEBUG_PRINT *) ParameterBuff= er); - if (OsServiceDebugPrint =3D=3D NULL) { - return EFI_INVALID_PARAMETER; - } - OsServiceDebugPrint ("PRMN handler sample message!\n"); - - return EFI_SUCCESS; -} - -// -// Register the PRM export information for this PRM Module -// -PRM_MODULE_EXPORT ( - PRM_HANDLER_EXPORT_ENTRY (PRM_HANDLER_1_GUID, PrmHandler1), - PRM_HANDLER_EXPORT_ENTRY (PRM_HANDLER_2_GUID, PrmHandler2), - PRM_HANDLER_EXPORT_ENTRY (PRM_HANDLER_N_GUID, PrmHandlerN) - ); - -EFI_STATUS -EFIAPI -PrmSamplePrintModuleInit ( - IN EFI_HANDLE ImageHandle, - IN EFI_SYSTEM_TABLE *SystemTable - ) -{ - return EFI_SUCCESS; -} diff --git a/PrmPkg/PrmPkg.dsc b/PrmPkg/PrmPkg.dsc index c6e5a151eeca..68768c87f276 100644 --- a/PrmPkg/PrmPkg.dsc +++ b/PrmPkg/PrmPkg.dsc @@ -128,7 +128,6 @@ [Components] # # PRM Sample Modules # - $(PLATFORM_PACKAGE)/Samples/PrmSamplePrintModule/PrmSamplePrintModule.= inf $(PLATFORM_PACKAGE)/Samples/PrmSampleAcpiParameterBufferModule/PrmSamp= leAcpiParameterBufferModule.inf $(PLATFORM_PACKAGE)/Samples/PrmSampleHardwareAccessModule/PrmSampleHar= dwareAccessModule.inf { diff --git a/PrmPkg/PrmSsdtInstallDxe/Prm.asl b/PrmPkg/PrmSsdtInstallDxe/= Prm.asl index 20a6fef9be7b..e34336b4eee6 100644 --- a/PrmPkg/PrmSsdtInstallDxe/Prm.asl +++ b/PrmPkg/PrmSsdtInstallDxe/Prm.asl @@ -25,11 +25,6 @@ DefinitionBlock ( Name (_CID, "80860223") Name (_DDN, "PRM Test Device") =20 - // PrmSamplePrintModule handler GUIDs - Name (BUF1, ToUUID("d5f2ad5f-a347-4d3e-87bc-c2ce63029cc8")) - Name (BUF2, ToUUID("a9e7adc3-8cd0-429a-8915-10946ebde318")) - Name (BUFN, ToUUID("b688c214-4081-4eeb-8d26-1eb5a3bcf11a")) - //PRM operation region format OperationRegion (PRMR, PlatformRtMechanism, 0, 1) Field (PRMR, BufferAcc, NoLock, Preserve) //Make it ByteAcc = for parameter validation diff --git a/PrmPkg/Samples/PrmSamplePrintModule/PrmSamplePrintModule.inf= b/PrmPkg/Samples/PrmSamplePrintModule/PrmSamplePrintModule.inf deleted file mode 100644 index 7ac291bc6e8a..000000000000 --- a/PrmPkg/Samples/PrmSamplePrintModule/PrmSamplePrintModule.inf +++ /dev/null @@ -1,41 +0,0 @@ -## @file -# Sample PRM Driver -# -# This driver simply uses an OS-provided debug message print service to= write -# a debug message. Three PRM handlers are provided that each print a un= ique -# debug message. -# -# Copyright (c) 2020, Intel Corporation. All rights reserved.
-# Copyright (c) Microsoft Corporation -# -# SPDX-License-Identifier: BSD-2-Clause-Patent -# -## - -[Defines] - INF_VERSION =3D 0x00010005 - BASE_NAME =3D PrmSamplePrintModule - FILE_GUID =3D 1652B3C2-A7A1-46AC-AF93-DD6DEE44666= 9 - MODULE_TYPE =3D DXE_RUNTIME_DRIVER - VERSION_STRING =3D 1.0 - ENTRY_POINT =3D PrmSamplePrintModuleInit - -[Sources] - PrmSamplePrintModule.c - -[Packages] - MdePkg/MdePkg.dec - MdeModulePkg/MdeModulePkg.dec - PrmPkg/PrmPkg.dec - -[LibraryClasses] - BaseLib - UefiDriverEntryPoint - UefiLib - -[Depex] - TRUE - -[BuildOptions.common] - MSFT:*_*_*_DLINK_FLAGS =3D /DLL /SUBSYSTEM:CONSOLE /VERSION:1.0 - MSFT:*_*_*_GENFW_FLAGS =3D --keepoptionalheader diff --git a/PrmPkg/Samples/Readme.md b/PrmPkg/Samples/Readme.md index 4926be243018..d9f06f8b87de 100644 --- a/PrmPkg/Samples/Readme.md +++ b/PrmPkg/Samples/Readme.md @@ -21,7 +21,7 @@ Note that the build command does provide the option to = build a specific module i faster build time. If you would like to just build a single PRM module t= hat can be done by specifying the path to the module INF file with the "-m" argument to `build`. For example, this= command builds 32-bit and 64-bit binaries with Visual Studio 2019: \ -``build -p PrmPkg/PrmPkg.dsc -m PrmPkg/Samples/PrmSamplePrintModule/PrmS= amplePrintModule.inf -a IA32 -a X64 -t VS2019`` +``build -p PrmPkg/PrmPkg.dsc -m PrmPkg/Samples/PrmSampleContextBufferMod= ule/PrmSampleContextBufferModule.inf -a IA32 -a X64 -t VS2019`` =20 ## PRM Sample Module User's Guide =20 @@ -33,77 +33,6 @@ It is recommended that all PRM authors write a similar= set of documentation for and interact with their PRM modules. =20 --- -### Module: PRM Sample Print Module ->* Name: `PrmSamplePrintModule` ->* GUID: `1652b3c2-a7a1-46ac-af93-dd6dee446669` -> * Purpose: -> * Simplest PRM module example -> * Example of a PRM module with multiple PRM handlers - -**Handlers:** -#### Handler: PRM Handler 1 -* Name: `PrmHandler1` -* GUID: `d5f2ad5f-a347-4d3e-87bc-c2ce63029cc8` -* Actions: - * Use an OS-provided function pointer (pointer at the beginning of the= parameter buffer) to write the message - =E2=80=9CPRM1 handler sample message!=E2=80=9D - -* Parameter Buffer Required: Yes -* Parameter Buffer Contents: - ```c - typedef struct { - - PRM_OS_SERVICE_DEBUG_PRINT * - - } SAMPLE_OSDEBUGPRINT_PARAMETER_BUFFER; - ``` - -* Context Buffer Required: No - -* Runtime MMIO Range(s) Required: No - -#### Handler: PRM Handler 2 -* Name: `PrmHandler2` -* GUID: `a9e7adc3-8cd0-429a-8915-10946ebde318` -* Actions: - * Use an OS-provided function pointer (pointer at the beginning of the= parameter buffer) to write the message - =E2=80=9CPRM2 handler sample message!=E2=80=9D - -* Parameter Buffer Required: Yes -* Parameter Buffer Contents: - ```c - typedef struct { - - PRM_OS_SERVICE_DEBUG_PRINT * - - } SAMPLE_OSDEBUGPRINT_PARAMETER_BUFFER; - ``` - -* Context Buffer Required: No - -* Runtime MMIO Range(s) Required: No - -#### Handler: PRM Handler N -* Name: `PrmHandlerN` -* GUID: `b688c214-4081-4eeb-8d26-1eb5a3bcf11a` -* Actions: - * Use an OS-provided function pointer (pointer at the beginning of the= parameter buffer) to write the message - =E2=80=9CPRMN handler sample message!=E2=80=9D - -* Parameter Buffer Required: Yes -* Parameter Buffer Contents: - ```c - typedef struct { - - PRM_OS_SERVICE_DEBUG_PRINT * - - } SAMPLE_OSDEBUGPRINT_PARAMETER_BUFFER; - ``` - -* Context Buffer Required: No - -* Runtime MMIO Range(s) Required: No - ### Module: PRM Sample ACPI Parameter Buffer >* Name: `PrmSampleAcpiParameterBufferModule` >* GUID: `dc2a58a6-5927-4776-b995-d118a27335a2` --=20 2.28.0.windows.1