From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id DEB1721A6F108 for ; Tue, 28 Mar 2017 01:20:56 -0700 (PDT) Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.phx2.redhat.com [10.5.11.13]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 50558C04BD34; Tue, 28 Mar 2017 08:20:56 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mx1.redhat.com 50558C04BD34 Authentication-Results: ext-mx07.extmail.prod.ext.phx2.redhat.com; dmarc=none (p=none dis=none) header.from=redhat.com Authentication-Results: ext-mx07.extmail.prod.ext.phx2.redhat.com; spf=pass smtp.mailfrom=lersek@redhat.com DKIM-Filter: OpenDKIM Filter v2.11.0 mx1.redhat.com 50558C04BD34 Received: from lacos-laptop-7.usersys.redhat.com (ovpn-116-89.phx2.redhat.com [10.3.116.89]) by smtp.corp.redhat.com (Postfix) with ESMTP id 9E0FD8F88A; Tue, 28 Mar 2017 08:20:54 +0000 (UTC) References: <20170324223819.11377-1-lersek@redhat.com> <20170324223819.11377-5-lersek@redhat.com> Cc: edk2-devel-01 , Leif Lindholm , Ard Biesheuvel , "Gao, Liming" From: Laszlo Ersek To: Feng Tian , Star Zeng Message-ID: <485ab4c9-0169-84e9-8511-41668272128f@redhat.com> Date: Tue, 28 Mar 2017 10:20:53 +0200 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:45.0) Gecko/20100101 Thunderbird/45.8.0 MIME-Version: 1.0 In-Reply-To: <20170324223819.11377-5-lersek@redhat.com> X-Scanned-By: MIMEDefang 2.79 on 10.5.11.13 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.31]); Tue, 28 Mar 2017 08:20:56 +0000 (UTC) Subject: Re: [PATCH v3 04/12] MdeModulePkg: introduce EDKII Platform Has ACPI GUID X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.22 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 28 Mar 2017 08:20:57 -0000 Content-Type: text/plain; charset=windows-1252 Content-Transfer-Encoding: 7bit Star, Feng, are you okay with this patch? As we discussed under the v2 thread, BaseTools don't currently generate EDKII_PLATFORM_HAS_ACPI_GUID style macros that are usable for initializing static GUID variables, and GUID fields of static structures. Therefore the MdeModulePkg/Include/Guid/PlatformHasAcpi.h file in this patch adds functionality for which BaseTools have no substitute. So, we have the following two options: (1) I can file a BZ for BaseTools to generate the above static initializers, *but* for now, we go with this patch as-is, under MdeModulePkg. If you agree with this, please respond to this patch with your formal Reviewed-by. (2) Or else, I will post a v4 of the series, moving this patch back under ArmPkg, and updating the references in the rest of the patches. Thanks, Laszlo On 03/24/17 23:38, Laszlo Ersek wrote: > The presence of this GUID in the PPI database, and/or in the DXE protocol > database (as dictated by the platform's needs in these firmware phases) > implies that the platform provides the operating system with an ACPI-based > hardware description. This is not necessarily exclusive with other types > of hardware description (for example, a Device Tree-based one). > > A platform PEIM and/or DXE driver is supposed to produce a single instance > of the PPI and/or protocol (with NULL contents), if appropriate. The > decision to produce the PPI and/or protocol is platform specific; for > example, in the DXE phase, it could depend on an HII checkbox / underlying > non-volatile UEFI variable. > > In the DXE phase, the protocol is meant to be depended-upon by > "MdeModulePkg/Universal/Acpi/AcpiTableDxe", indirectly: > > * In the long term, interested platforms will establish this dependency by > hooking an (upcoming) NULL-class DepexLib instance into AcpiTableDxe in > their DSC files, pointing DepexLib's DEPEX through a FixedAtBuild PCD to > the GUID introduced here. (For the prerequisite BaseTools feature, refer > to ). > > * In the short term, an interested platform may hook a private NULL-class > library instance (called e.g. "PlatformHasAcpiLib") into AcpiTableDxe. > Such a library instance would be a specialization of the above described > generic DepexLib, with the DEPEX open-coded on the GUID introduced here. > > Either way, the platform makes EFI_ACPI_TABLE_PROTOCOL and (if enabled) > EFI_ACPI_SDT_PROTOCOL dependent on the platform's dynamic decision to > produce or not to produce a NULL protocol instance with this GUID. > > In turn, other (platform and universal) DXE drivers that produce ACPI > tables will wait for EFI_ACPI_TABLE_PROTOCOL / EFI_ACPI_SDT_PROTOCOL, via > DEPEX, protocol notify, or a simple gBS->LocateProtocol() in a "late > enough" callback (such as Ready To Boot). > > Because this GUID is not standard, it is prefixed with EDKII / Edkii, as > seen elsewhere in MdeModulePkg and SecurityPkg. In addition, an effort is > made to avoid the phrase "AcpiPlatform", as that belongs to drivers / > libraries that produce platform specific ACPI content (as opposed to > deciding whether the entire firmware will have access to > EFI_ACPI_TABLE_PROTOCOL, or any similar facilities in the PEI phase). > > Cc: Ard Biesheuvel > Cc: Feng Tian > Cc: Leif Lindholm > Cc: Star Zeng > Contributed-under: TianoCore Contribution Agreement 1.0 > Signed-off-by: Laszlo Ersek > --- > > Notes: > v3: > - rename gEdkiiPlatformHasAcpiProtocolGuid to gEdkiiPlatformHasAcpiGuid > [Star] > - update commit message and code comments to reflect possible use as a > PPI as well [Star] > - move GUID from ArmPkg to MdeModulePkg [Leif, Ard] > - split PlatformHasAcpiLib to a separate patch [Star] > > MdeModulePkg/MdeModulePkg.dec | 3 ++ > MdeModulePkg/Include/Guid/PlatformHasAcpi.h | 35 ++++++++++++++++++++ > 2 files changed, 38 insertions(+) > > diff --git a/MdeModulePkg/MdeModulePkg.dec b/MdeModulePkg/MdeModulePkg.dec > index 626e479f5e45..2d94881206d3 100644 > --- a/MdeModulePkg/MdeModulePkg.dec > +++ b/MdeModulePkg/MdeModulePkg.dec > @@ -382,6 +382,9 @@ [Guids] > gEdkiiNonDiscoverableUhciDeviceGuid = { 0xA8CDA0A2, 0x4F37, 0x4A1B, {0x8E, 0x10, 0x8E, 0xF3, 0xCC, 0x3B, 0xF3, 0xA8 } } > gEdkiiNonDiscoverableXhciDeviceGuid = { 0xB1BE0BC5, 0x6C28, 0x442D, {0xAA, 0x37, 0x15, 0x1B, 0x42, 0x57, 0xBD, 0x78 } } > > + ## Include/Guid/PlatformHasAcpi.h > + gEdkiiPlatformHasAcpiGuid = { 0xf0966b41, 0xc23f, 0x41b9, { 0x96, 0x04, 0x0f, 0xf7, 0xe1, 0x11, 0x96, 0x5a } } > + > [Ppis] > ## Include/Ppi/AtaController.h > gPeiAtaControllerPpiGuid = { 0xa45e60d1, 0xc719, 0x44aa, { 0xb0, 0x7a, 0xaa, 0x77, 0x7f, 0x85, 0x90, 0x6d }} > diff --git a/MdeModulePkg/Include/Guid/PlatformHasAcpi.h b/MdeModulePkg/Include/Guid/PlatformHasAcpi.h > new file mode 100644 > index 000000000000..ad517821375d > --- /dev/null > +++ b/MdeModulePkg/Include/Guid/PlatformHasAcpi.h > @@ -0,0 +1,35 @@ > +/** @file > + EDKII Platform Has ACPI GUID > + > + A NULL protocol instance with this GUID in the DXE protocol database, and/or > + a NULL PPI with this GUID in the PPI database, implies that the platform > + provides the operating system with an ACPI-based hardware description. Note > + that this is not necessarily exclusive with different kinds of hardware > + description (for example, a Device Tree-based one). A platform driver and/or > + PEIM is supposed to produce a single instance of the protocol and/or PPI > + (with NULL contents), if appropriate. > + > + Copyright (C) 2017, Red Hat, Inc. > + > + This program and the accompanying materials are licensed and made available > + under the terms and conditions of the BSD License that accompanies this > + distribution. The full text of the license may be found at > + http://opensource.org/licenses/bsd-license.php. > + > + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT > + WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. > +**/ > + > + > +#ifndef __EDKII_PLATFORM_HAS_ACPI_H__ > +#define __EDKII_PLATFORM_HAS_ACPI_H__ > + > +#define EDKII_PLATFORM_HAS_ACPI_GUID \ > + { \ > + 0xf0966b41, 0xc23f, 0x41b9, \ > + { 0x96, 0x04, 0x0f, 0xf7, 0xe1, 0x11, 0x96, 0x5a } \ > + } > + > +extern EFI_GUID gEdkiiPlatformHasAcpiGuid; > + > +#endif >