From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga01.intel.com (mga01.intel.com [192.55.52.88]) (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 DF62521A0483A for ; Sun, 23 Apr 2017 19:02:40 -0700 (PDT) Received: from fmsmga004.fm.intel.com ([10.253.24.48]) by fmsmga101.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 23 Apr 2017 19:02:40 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.37,242,1488873600"; d="scan'208";a="252586164" Received: from fmsmsx103.amr.corp.intel.com ([10.18.124.201]) by fmsmga004.fm.intel.com with ESMTP; 23 Apr 2017 19:02:39 -0700 Received: from FMSMSX110.amr.corp.intel.com (10.18.116.10) by FMSMSX103.amr.corp.intel.com (10.18.124.201) with Microsoft SMTP Server (TLS) id 14.3.319.2; Sun, 23 Apr 2017 19:02:39 -0700 Received: from shsmsx152.ccr.corp.intel.com (10.239.6.52) by fmsmsx110.amr.corp.intel.com (10.18.116.10) with Microsoft SMTP Server (TLS) id 14.3.319.2; Sun, 23 Apr 2017 19:02:39 -0700 Received: from shsmsx102.ccr.corp.intel.com ([169.254.2.246]) by SHSMSX152.ccr.corp.intel.com ([169.254.6.217]) with mapi id 14.03.0319.002; Mon, 24 Apr 2017 10:02:38 +0800 From: "Fan, Jeff" To: "Yao, Jiewen" , "edk2-devel@lists.01.org" CC: "Gao, Liming" Thread-Topic: [PATCH 2/4] MdePkg/SmmIoLib: Add sample instance. Thread-Index: AQHSurby39CIbaKubEiMv4TyMReB46HTx8OQ Date: Mon, 24 Apr 2017 02:02:37 +0000 Message-ID: <542CF652F8836A4AB8DBFAAD40ED192A4C5AC0C3@shsmsx102.ccr.corp.intel.com> References: <1492789793-22624-1-git-send-email-jiewen.yao@intel.com> <1492789793-22624-3-git-send-email-jiewen.yao@intel.com> In-Reply-To: <1492789793-22624-3-git-send-email-jiewen.yao@intel.com> Accept-Language: zh-CN, en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiM2UyNzQ0MjMtMmU4Mi00MjNhLWFjNzMtYjk1YzgyYjIxZjUwIiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX0lDIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE1LjkuNi42IiwiVHJ1c3RlZExhYmVsSGFzaCI6ImV5c2xiUGIzUUJuamNqWjNwRlwvWE0xMFRTd0R4OHVTOWlRRWlySUZFd1MwPSJ9 x-ctpclassification: CTP_IC x-originating-ip: [10.239.127.40] MIME-Version: 1.0 Subject: Re: [PATCH 2/4] MdePkg/SmmIoLib: Add sample instance. 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: Mon, 24 Apr 2017 02:02:41 -0000 Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Jiewen, Could the following ASSER() removed and let caller check the return value? Otherwise, there is no return on DEBUG build for this servcie. + if (!InValidRegion) { + DEBUG (( + DEBUG_ERROR, + "SmmIsMmioValid: Not in valid MMIO region: BaseAddress (0x%lx) - L= ength (0x%lx)\n", + BaseAddress, + Length + )); + ASSERT (FALSE); + return FALSE; + } Thank! Jeff -----Original Message----- From: Yao, Jiewen=20 Sent: Friday, April 21, 2017 11:50 PM To: edk2-devel@lists.01.org Cc: Fan, Jeff; Gao, Liming Subject: [PATCH 2/4] MdePkg/SmmIoLib: Add sample instance. The sample instance check if IO resource is valid one defined in GCD. A platform may choose add more check to exclude some other IO resource. Cc: Jeff Fan Cc: Liming Gao Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Jiewen Yao --- MdePkg/Library/SmmIoLib/SmmIoLib.c | 331 ++++++++++++++++++++ MdePkg/Library/SmmIoLib/SmmIoLib.inf | 53 ++++ MdePkg/Library/SmmIoLib/S= mmIoLib.uni | 23 ++ 3 files changed, 407 insertions(+) diff --git a/MdePkg/Library/SmmIoLib/SmmIoLib.c b/MdePkg/Library/SmmIoLib/S= mmIoLib.c new file mode 100644 index 0000000..995adac --- /dev/null +++ b/MdePkg/Library/SmmIoLib/SmmIoLib.c @@ -0,0 +1,331 @@ +/** @file + Instance of SMM IO check library. + + SMM IO check library library implementation. This library consumes=20 + GCD to collect all valid IO space defined by a platform. + A platform may have its own SmmIoLib instance to exclude more IO space. + + Copyright (c) 2017, Intel Corporation. All rights reserved.
This=20 + program and the accompanying materials are licensed and made=20 + available under the terms and conditions of the BSD License which=20 + accompanies this distribution. The full text of the license may be=20 + found at http://opensource.org/licenses/bsd-license.php + + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, =20 + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPL= IED. + +**/ + + +#include + +#include +#include +#include +#include #include=20 + +#include #include =20 +#include #include=20 + #include + +EFI_GCD_MEMORY_SPACE_DESCRIPTOR *mSmmIoLibGcdMemSpace =3D NULL; +UINTN mSmmIoLibGcdMemNumberOfDesc =3D 0; + +EFI_PHYSICAL_ADDRESS mSmmIoLibInternalMaximumSupportMemAddress =3D 0; + +VOID *mSmmIoLibRegistrationEndOfDxe; +VOID *mSmmIoLibRegistrationReadyToLock; + +BOOLEAN mSmmIoLibReadyToLock =3D FALSE; + +/** + Calculate and save the maximum support address. + +**/ +VOID +SmmIoLibInternalCalculateMaximumSupportAddress ( + VOID + ) +{ + VOID *Hob; + UINT32 RegEax; + UINT8 MemPhysicalAddressBits; + + // + // Get physical address bits supported. + // + Hob =3D GetFirstHob (EFI_HOB_TYPE_CPU); if (Hob !=3D NULL) { + MemPhysicalAddressBits =3D ((EFI_HOB_CPU *) Hob)->SizeOfMemorySpace; = =20 + } else { + AsmCpuid (0x80000000, &RegEax, NULL, NULL, NULL); + if (RegEax >=3D 0x80000008) { + AsmCpuid (0x80000008, &RegEax, NULL, NULL, NULL); + MemPhysicalAddressBits =3D (UINT8) RegEax; + } else { + MemPhysicalAddressBits =3D 36; + } + } + // + // IA-32e paging translates 48-bit linear addresses to 52-bit physical a= ddresses. + // + ASSERT (MemPhysicalAddressBits <=3D 52); if (MemPhysicalAddressBits >=20 + 48) { + MemPhysicalAddressBits =3D 48; + } + + // + // Save the maximum support address in one global variable + // + mSmmIoLibInternalMaximumSupportMemAddress =3D=20 +(EFI_PHYSICAL_ADDRESS)(UINTN)(LShiftU64 (1, MemPhysicalAddressBits) -=20 +1); + DEBUG ((DEBUG_INFO, "mSmmIoLibInternalMaximumSupportMemAddress =3D=20 +0x%lx\n", mSmmIoLibInternalMaximumSupportMemAddress)); +} + +/** + This function check if the MMIO resource is valid per processor=20 +architecture and + valid per platform design. + + @param BaseAddress The MMIO start address to be checked. + @param Length The MMIO length to be checked. + @param Owner A GUID representing the owner of the resource. + This GUID may be used by producer to correlate the d= evice ownership of the resource. + NULL means no specific owner. + + @retval TRUE This MMIO resource is valid per processor architecture and= valid per platform design. + @retval FALSE This MMIO resource is not valid per processor architecture= or valid per platform design. +**/ +BOOLEAN +EFIAPI +SmmIsMmioValid ( + IN EFI_PHYSICAL_ADDRESS BaseAddress, + IN UINT64 Length, + IN EFI_GUID *Owner OPTIONAL + ) +{ + UINTN Index; + EFI_GCD_MEMORY_SPACE_DESCRIPTOR *Desc; + BOOLEAN InValidRegion; + + // + // Check override. + // NOTE: (B:0->L:4G) is invalid for IA32, but (B:1->L:4G-1)/(B:4G-1->L:1= ) is valid. + // + if ((Length > mSmmIoLibInternalMaximumSupportMemAddress) || + (BaseAddress > mSmmIoLibInternalMaximumSupportMemAddress) || + ((Length !=3D 0) && (BaseAddress > (mSmmIoLibInternalMaximumSupportM= emAddress - (Length - 1)))) ) { + // + // Overflow happen + // + DEBUG (( + DEBUG_ERROR, + "SmmIsMmioValid: Overflow: BaseAddress (0x%lx) - Length (0x%lx), Max= imumSupportMemAddress (0x%lx)\n", + BaseAddress, + Length, + mSmmIoLibInternalMaximumSupportMemAddress + )); + return FALSE; + } + + // + // Check override for valid MMIO region // if=20 + (mSmmIoLibReadyToLock) { + InValidRegion =3D FALSE; + for (Index =3D 0; Index < mSmmIoLibGcdMemNumberOfDesc; Index ++) { + Desc =3D &mSmmIoLibGcdMemSpace[Index]; + if ((Desc->GcdMemoryType =3D=3D EfiGcdMemoryTypeMemoryMappedIo) && + (BaseAddress >=3D Desc->BaseAddress) && + ((BaseAddress + Length) <=3D (Desc->BaseAddress + Desc->Length))= ) { + InValidRegion =3D TRUE; + } + } + + if (!InValidRegion) { + DEBUG (( + DEBUG_ERROR, + "SmmIsMmioValid: Not in valid MMIO region: BaseAddress (0x%lx) - L= ength (0x%lx)\n", + BaseAddress, + Length + )); + ASSERT (FALSE); + return FALSE; + } + } + return TRUE; +} + +/** + Merge continous entries whose type is EfiGcdMemoryTypeMemoryMappedIo. + + @param[in, out] GcdMemoryMap A pointer to the buffer in which= firmware places + the current GCD memory map. + @param[in, out] NumberOfDescriptors A pointer to the number of the + GcdMemoryMap buffer. On input, t= his is the number of + the current GCD memory map. On = output, + it is the number of new GCD memo= ry map after merge. +**/ +STATIC +VOID +MergeGcdMmioEntry ( + IN OUT EFI_GCD_MEMORY_SPACE_DESCRIPTOR *GcdMemoryMap, + IN OUT UINTN *NumberOfDescriptors + ) +{ + EFI_GCD_MEMORY_SPACE_DESCRIPTOR *GcdMemoryMapEntry; + EFI_GCD_MEMORY_SPACE_DESCRIPTOR *GcdMemoryMapEnd; + EFI_GCD_MEMORY_SPACE_DESCRIPTOR *NewGcdMemoryMapEntry; + EFI_GCD_MEMORY_SPACE_DESCRIPTOR *NextGcdMemoryMapEntry; + + GcdMemoryMapEntry =3D GcdMemoryMap; + NewGcdMemoryMapEntry =3D GcdMemoryMap; + GcdMemoryMapEnd =3D (EFI_GCD_MEMORY_SPACE_DESCRIPTOR *) ((UINT8 *)=20 + GcdMemoryMap + (*NumberOfDescriptors) *=20 + sizeof(EFI_GCD_MEMORY_SPACE_DESCRIPTOR)); + while ((UINTN)GcdMemoryMapEntry < (UINTN)GcdMemoryMapEnd) { + CopyMem (NewGcdMemoryMapEntry, GcdMemoryMapEntry, sizeof(EFI_GCD_MEMOR= Y_SPACE_DESCRIPTOR)); + NextGcdMemoryMapEntry =3D GcdMemoryMapEntry + 1; + + do { + if (((UINTN)NextGcdMemoryMapEntry < (UINTN)GcdMemoryMapEnd) && + (GcdMemoryMapEntry->GcdMemoryType =3D=3D EfiGcdMemoryTypeMemoryM= appedIo) && (NextGcdMemoryMapEntry->GcdMemoryType =3D=3D EfiGcdMemoryTypeMe= moryMappedIo) && + ((GcdMemoryMapEntry->BaseAddress + GcdMemoryMapEntry->Length) = =3D=3D NextGcdMemoryMapEntry->BaseAddress)) { + GcdMemoryMapEntry->Length +=3D NextGcdMemoryMapEntry->Length; + if (NewGcdMemoryMapEntry !=3D GcdMemoryMapEntry) { + NewGcdMemoryMapEntry->Length +=3D NextGcdMemoryMapEntry->Length; + } + + NextGcdMemoryMapEntry =3D NextGcdMemoryMapEntry + 1; + continue; + } else { + GcdMemoryMapEntry =3D NextGcdMemoryMapEntry - 1; + break; + } + } while (TRUE); + + GcdMemoryMapEntry =3D GcdMemoryMapEntry + 1; + NewGcdMemoryMapEntry =3D NewGcdMemoryMapEntry + 1; } + + *NumberOfDescriptors =3D ((UINTN)NewGcdMemoryMapEntry -=20 + (UINTN)GcdMemoryMap) / sizeof(EFI_GCD_MEMORY_SPACE_DESCRIPTOR); + + return ; +} + +/** + Notification for SMM EndOfDxe protocol. + + @param[in] Protocol Points to the protocol's unique identifier. + @param[in] Interface Points to the interface instance. + @param[in] Handle The handle on which the interface was installed. + + @retval EFI_SUCCESS Notification runs successfully. +**/ +EFI_STATUS +EFIAPI +SmmIoLibInternalEndOfDxeNotify ( + IN CONST EFI_GUID *Protocol, + IN VOID *Interface, + IN EFI_HANDLE Handle + ) +{ + UINTN NumberOfDescriptors; + EFI_GCD_MEMORY_SPACE_DESCRIPTOR *MemSpaceMap; + EFI_STATUS Status; + + Status =3D gDS->GetMemorySpaceMap (&NumberOfDescriptors, &MemSpaceMap); = =20 + if (!EFI_ERROR (Status)) { + + MergeGcdMmioEntry (MemSpaceMap, &NumberOfDescriptors); + + mSmmIoLibGcdMemSpace =3D AllocateCopyPool (NumberOfDescriptors * sizeo= f (EFI_GCD_MEMORY_SPACE_DESCRIPTOR), MemSpaceMap); + ASSERT_EFI_ERROR (Status); + if (EFI_ERROR (Status)) { + gBS->FreePool (MemSpaceMap); + return Status; + } + + mSmmIoLibGcdMemNumberOfDesc =3D NumberOfDescriptors; + gBS->FreePool (MemSpaceMap); + } + + return EFI_SUCCESS; +} + +/** + Notification for SMM ReadyToLock protocol. + + @param[in] Protocol Points to the protocol's unique identifier. + @param[in] Interface Points to the interface instance. + @param[in] Handle The handle on which the interface was installed. + + @retval EFI_SUCCESS Notification runs successfully. +**/ +EFI_STATUS +EFIAPI +SmmIoLibInternalReadyToLockNotify ( + IN CONST EFI_GUID *Protocol, + IN VOID *Interface, + IN EFI_HANDLE Handle + ) +{ + mSmmIoLibReadyToLock =3D TRUE; + return EFI_SUCCESS; +} + +/** + The constructor function initializes the Smm IO library + + @param ImageHandle The firmware allocated handle for the EFI image. + @param SystemTable A pointer to the EFI System Table. + + @retval EFI_SUCCESS The constructor always returns EFI_SUCCESS. + +**/ +EFI_STATUS +EFIAPI +SmmIoLibConstructor ( + IN EFI_HANDLE ImageHandle, + IN EFI_SYSTEM_TABLE *SystemTable + ) +{ + EFI_STATUS Status; + + // + // Calculate and save maximum support address // =20 + SmmIoLibInternalCalculateMaximumSupportAddress (); + + // + // Register EndOfDxe to get GCD resource map // Status =3D=20 + gSmst->SmmRegisterProtocolNotify (&gEfiSmmEndOfDxeProtocolGuid,=20 + SmmIoLibInternalEndOfDxeNotify, &mSmmIoLibRegistrationEndOfDxe); =20 + ASSERT_EFI_ERROR (Status); + + // + // Register ready to lock so that we can know when to check valid=20 + resource region // Status =3D gSmst->SmmRegisterProtocolNotify=20 + (&gEfiSmmReadyToLockProtocolGuid, SmmIoLibInternalReadyToLockNotify,=20 + &mSmmIoLibRegistrationReadyToLock); + ASSERT_EFI_ERROR (Status); + + return EFI_SUCCESS; +} + +/** + The destructor function frees resource used in the Smm IO library + + @param[in] ImageHandle The firmware allocated handle for the EFI imag= e. + @param[in] SystemTable A pointer to the EFI System Table. + + @retval EFI_SUCCESS The deconstructor always returns EFI_SUCCESS. +**/ +EFI_STATUS +EFIAPI +SmmIoLibDestructor ( + IN EFI_HANDLE ImageHandle, + IN EFI_SYSTEM_TABLE *SystemTable + ) +{ + gSmst->SmmRegisterProtocolNotify (&gEfiSmmEndOfDxeProtocolGuid, NULL,=20 +&mSmmIoLibRegistrationEndOfDxe); + gSmst->SmmRegisterProtocolNotify (&gEfiSmmReadyToLockProtocolGuid,=20 +NULL, &mSmmIoLibRegistrationReadyToLock); + return EFI_SUCCESS; +} diff --git a/MdePkg/Library/SmmIoLib/SmmIoLib.inf b/MdePkg/Library/SmmIoLib= /SmmIoLib.inf new file mode 100644 index 0000000..d508408 --- /dev/null +++ b/MdePkg/Library/SmmIoLib/SmmIoLib.inf @@ -0,0 +1,53 @@ +## @file +# Instance of SMM IO check library. +# +# SMM IO check library library implementation. This library consumes=20 +GCD to collect all valid # IO space defined by a platform. +# A platform may have its own SmmIoLib instance to exclude more IO space. +# +# Copyright (c) 2017, Intel Corporation. All rights reserved.
# =20 +This program and the accompanying materials # are licensed and made=20 +available under the terms and conditions of the BSD License # which=20 +accompanies this distribution. The full text of the license may be=20 +found at # http://opensource.org/licenses/bsd-license.php +# +# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS"=20 +BASIS, # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRES= S OR IMPLIED. +# +## + +[Defines] + INF_VERSION =3D 0x00010005 + BASE_NAME =3D SmmIoLib + MODULE_UNI_FILE =3D SmmIoLib.uni + FILE_GUID =3D F0F5A845-E3ED-4C6E-82D6-4ECE85DAC00F + MODULE_TYPE =3D DXE_SMM_DRIVER + VERSION_STRING =3D 1.0 + LIBRARY_CLASS =3D SmmIoLib|DXE_SMM_DRIVER SMM_CORE + CONSTRUCTOR =3D SmmIoLibConstructor + DESTRUCTOR =3D SmmIoLibDestructor + +# +# The following information is for reference only and not required by the = build tools. +# +# VALID_ARCHITECTURES =3D IA32 X64 +# + +[Sources] + SmmIoLib.c + +[Packages] + MdePkg/MdePkg.dec + +[LibraryClasses] + SmmServicesTableLib + UefiBootServicesTableLib + DxeServicesTableLib + DebugLib + BaseMemoryLib + MemoryAllocationLib + HobLib + +[Protocols] + gEfiSmmReadyToLockProtocolGuid ## CONSUMES + gEfiSmmEndOfDxeProtocolGuid ## CONSUMES diff --git a/MdePkg/Library/SmmIoLib/SmmIoLib.uni b/MdePkg/Library/SmmIoLib= /SmmIoLib.uni new file mode 100644 index 0000000..5d20b4d --- /dev/null +++ b/MdePkg/Library/SmmIoLib/SmmIoLib.uni @@ -0,0 +1,23 @@ +// /** @file +// Instance of SMM IO check library. +// +// SMM IO check library library implementation. This library consumes=20 +GCD to collect all valid // IO space defined by a platform. +// A platform may have its own SmmIoLib instance to exclude more IO space= . +// +// Copyright (c) 2017, Intel Corporation. All rights reserved.
//=20 +// This program and the accompanying materials // are licensed and made=20 +available under the terms and conditions of the BSD License // which=20 +accompanies this distribution. The full text of the license may be=20 +found at // http://opensource.org/licenses/bsd-license.php. +// THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS"=20 +BASIS, // WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRES= S OR IMPLIED. +// +// **/ + + +#string STR_MODULE_ABSTRACT #language en-US "Instance of SMM I= O check library." + +#string STR_MODULE_DESCRIPTION #language en-US "SMM IO check libr= ary library implementation. This library consumes GCD to collect all valid = IO space defined by a platform. A platform may have its own SmmIoLib instan= ce to exclude more IO space." + -- 2.7.4.windows.1