From mboxrd@z Thu Jan 1 00:00:00 1970 Authentication-Results: mx.groups.io; dkim=missing; spf=pass (domain: intel.com, ip: 134.134.136.65, mailfrom: ray.ni@intel.com) Received: from mga03.intel.com (mga03.intel.com [134.134.136.65]) by groups.io with SMTP; Thu, 29 Aug 2019 09:46:16 -0700 X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga006.jf.intel.com ([10.7.209.51]) by orsmga103.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 29 Aug 2019 09:46:16 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.64,444,1559545200"; d="scan'208";a="186030657" Received: from fmsmsx108.amr.corp.intel.com ([10.18.124.206]) by orsmga006.jf.intel.com with ESMTP; 29 Aug 2019 09:46:15 -0700 Received: from fmsmsx119.amr.corp.intel.com (10.18.124.207) by FMSMSX108.amr.corp.intel.com (10.18.124.206) with Microsoft SMTP Server (TLS) id 14.3.439.0; Thu, 29 Aug 2019 09:46:15 -0700 Received: from shsmsx107.ccr.corp.intel.com (10.239.4.96) by FMSMSX119.amr.corp.intel.com (10.18.124.207) with Microsoft SMTP Server (TLS) id 14.3.439.0; Thu, 29 Aug 2019 09:46:09 -0700 Received: from shsmsx104.ccr.corp.intel.com ([169.254.5.112]) by SHSMSX107.ccr.corp.intel.com ([169.254.9.65]) with mapi id 14.03.0439.000; Fri, 30 Aug 2019 00:46:07 +0800 From: "Ni, Ray" To: "Chen, Marc W" CC: "devel@edk2.groups.io" Subject: Re: [edk2-devel] [edk2-platforms:PATCH v5] IntelSiliconPkg/Feature Implement SmmAccess Thread-Topic: [edk2-devel] [edk2-platforms:PATCH v5] IntelSiliconPkg/Feature Implement SmmAccess Thread-Index: AQHVXLVIG9kS++fjV0uden7U6ObIBacR2v8AgAB9/wA= Date: Thu, 29 Aug 2019 16:46:06 +0000 Message-ID: <734D49CCEBEEF84792F5B80ED585239D5C2A3614@SHSMSX104.ccr.corp.intel.com> References: <15BEBBC3B4FDB1AB.15695@groups.io> In-Reply-To: Accept-Language: en-US, zh-CN X-MS-Has-Attach: X-MS-TNEF-Correlator: x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiOGU0NTFlMjYtZmY0Ni00ZjAzLWJhNzAtNzdmMjkwZWI1MzYzIiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX05UIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE3LjEwLjE4MDQuNDkiLCJUcnVzdGVkTGFiZWxIYXNoIjoiTks4SjZzbmZMS0lZNWQzTVVKdXhDeUt6a2NObWtScmJyMzNaa2Y3dEk0dVwvV0xXSDVoM21scXNCenFGV20xMzQifQ== x-ctpclassification: CTP_NT dlp-product: dlpe-windows dlp-version: 11.2.0.6 dlp-reaction: no-action x-originating-ip: [10.239.127.40] MIME-Version: 1.0 Return-Path: ray.ni@intel.com Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Reviewed-by: Ray Ni > > -----Original Message----- > > From: devel@edk2.groups.io On Behalf Of Marc W > > Chen > > Sent: Tuesday, August 27, 2019 4:56 PM > > To: devel@edk2.groups.io > > Cc: Chen, Marc W ; Ni, Ray ; > > Chaganty, Rangasai V > > Subject: [edk2-devel] [edk2-platforms:PATCH v5] IntelSiliconPkg/Featur= e > > Implement SmmAccess > > > > REF:https://bugzilla.tianocore.org/show_bug.cgi?id=3D2121 > > > > Implement SmmAccess for PEI and DXE phase in IntelSiliconPkg > > > > Signed-off-by: Marc Chen > > Cc: Ray Ni > > Cc: Rangasai V Chaganty > > --- > > .../Library/PeiSmmAccessLib/PeiSmmAccessLib.c | 339 > > +++++++++++++++++++++ > > .../Library/PeiSmmAccessLib/PeiSmmAccessLib.inf | 41 +++ > > .../Feature/SmmAccess/SmmAccessDxe/SmmAccess.inf | 46 +++ > > .../SmmAccess/SmmAccessDxe/SmmAccessDriver.c | 267 > > ++++++++++++++++ > > .../SmmAccess/SmmAccessDxe/SmmAccessDriver.h | 160 ++++++++++ > > .../IntelSiliconPkg/Include/Library/SmmAccessLib.h | 28 ++ > > 6 files changed, 881 insertions(+) > > create mode 100644 > > Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmmAccessLi= b/P > > eiSmmAccessLib.c > > create mode 100644 > > Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmmAccessLi= b/P > > eiSmmAccessLib.inf > > create mode 100644 > > Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAcces > > s.inf > > create mode 100644 > > Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAcces > > sDriver.c > > create mode 100644 > > Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAcces > > sDriver.h > > create mode 100644 > > Silicon/Intel/IntelSiliconPkg/Include/Library/SmmAccessLib.h > > > > diff --git > > a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmmAccess= Lib > > /PeiSmmAccessLib.c > > b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmmAccess= Lib > > /PeiSmmAccessLib.c > > new file mode 100644 > > index 0000000000..da141cfa0e > > --- /dev/null > > +++ > > b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmmAccess= Lib > > /PeiSmmAccessLib.c > > @@ -0,0 +1,339 @@ > > +/** @file > > + This is to publish the SMM Access Ppi instance. > > + > > + Copyright (c) 2019, Intel Corporation. All rights reserved.
> > + SPDX-License-Identifier: BSD-2-Clause-Patent > > + > > +**/ > > +#include > > +#include > > +#include > > +#include > > +#include > > +#include > > +#include > > +#include > > + > > +#include > > +#include > > + > > +#define SMM_ACCESS_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('4', '5', > > 's', 'a') > > + > > +/// > > +/// Private data > > +/// > > +typedef struct { > > + UINTN Signature; > > + EFI_HANDLE Handle; > > + EFI_PEI_MM_ACCESS_PPI SmmAccess; > > + // > > + // Local Data for SMM Access interface goes here > > + // > > + UINTN NumberRegions; > > + EFI_SMRAM_DESCRIPTOR *SmramDesc; > > +} SMM_ACCESS_PRIVATE_DATA; > > + > > +#define SMM_ACCESS_PRIVATE_DATA_FROM_THIS(a) \ > > + CR (a, \ > > + SMM_ACCESS_PRIVATE_DATA, \ > > + SmmAccess, \ > > + SMM_ACCESS_PRIVATE_DATA_SIGNATURE \ > > + ) > > + > > +/** > > + This routine accepts a request to "open" a region of SMRAM. The > > + region could be legacy ABSEG, HSEG, or TSEG near top of physical me= mory. > > + The use of "open" means that the memory is visible from all PEIM > > + and SMM agents. > > + > > + @param[in] This - Pointer to the SMM Access Interface. > > + @param[in] DescriptorIndex - Region of SMRAM to Open. > > + @param[in] PeiServices - General purpose services available t= o every > > PEIM. > > + > > + @retval EFI_SUCCESS - The region was successfully opene= d. > > + @retval EFI_DEVICE_ERROR - The region could not be opened be= cause > > locked by > > + chipset. > > + @retval EFI_INVALID_PARAMETER - The descriptor index was out of > > bounds. > > +**/ > > +EFI_STATUS > > +EFIAPI > > +Open ( > > + IN EFI_PEI_SERVICES **PeiServices, > > + IN EFI_PEI_MM_ACCESS_PPI *This, > > + IN UINTN DescriptorIndex > > + ) > > +{ > > + SMM_ACCESS_PRIVATE_DATA *SmmAccess; > > + > > + SmmAccess =3D SMM_ACCESS_PRIVATE_DATA_FROM_THIS (This); > > + if (DescriptorIndex >=3D SmmAccess->NumberRegions) { > > + DEBUG ((DEBUG_WARN, "SMRAM region out of range\n")); > > + > > + return EFI_INVALID_PARAMETER; > > + } else if (SmmAccess->SmramDesc[DescriptorIndex].RegionState & > > EFI_SMRAM_LOCKED) { > > + // > > + // Cannot open a "locked" region > > + // > > + DEBUG ((DEBUG_WARN, "Cannot open a locked SMRAM region\n")); > > + > > + return EFI_DEVICE_ERROR; > > + } > > + > > + SmmAccess->SmramDesc[DescriptorIndex].RegionState &=3D (UINT64) > > ~(EFI_SMRAM_CLOSED | EFI_ALLOCATED); > > + SmmAccess->SmramDesc[DescriptorIndex].RegionState |=3D (UINT64) > > EFI_SMRAM_OPEN; > > + SmmAccess->SmmAccess.OpenState =3D TRUE; > > + return EFI_SUCCESS; > > +} > > + > > +/** > > + This routine accepts a request to "close" a region of SMRAM. This = is valid > > for > > + compatible SMRAM region. > > + > > + @param[in] PeiServices - General purpose services available t= o every > > PEIM. > > + @param[in] This - Pointer to the SMM Access Interface. > > + @param[in] DescriptorIndex - Region of SMRAM to Close. > > + > > + @retval EFI_SUCCESS - The region was successfully close= d. > > + @retval EFI_DEVICE_ERROR - The region could not be closed be= cause > > locked by > > + chipset. > > + @retval EFI_INVALID_PARAMETER - The descriptor index was out of > > bounds. > > +**/ > > +EFI_STATUS > > +EFIAPI > > +Close ( > > + IN EFI_PEI_SERVICES **PeiServices, > > + IN EFI_PEI_MM_ACCESS_PPI *This, > > + IN UINTN DescriptorIndex > > + ) > > +{ > > + SMM_ACCESS_PRIVATE_DATA *SmmAccess; > > + BOOLEAN OpenState; > > + UINT8 Index; > > + > > + SmmAccess =3D SMM_ACCESS_PRIVATE_DATA_FROM_THIS (This); > > + if (DescriptorIndex >=3D SmmAccess->NumberRegions) { > > + DEBUG ((DEBUG_WARN, "SMRAM region out of range\n")); > > + > > + return EFI_INVALID_PARAMETER; > > + } else if (SmmAccess->SmramDesc[DescriptorIndex].RegionState & > > EFI_SMRAM_LOCKED) { > > + // > > + // Cannot close a "locked" region > > + // > > + DEBUG ((DEBUG_WARN, "Cannot close a locked SMRAM region\n")); > > + > > + return EFI_DEVICE_ERROR; > > + } > > + > > + if (SmmAccess->SmramDesc[DescriptorIndex].RegionState & > > EFI_SMRAM_CLOSED) { > > + return EFI_DEVICE_ERROR; > > + } > > + > > + SmmAccess->SmramDesc[DescriptorIndex].RegionState &=3D (UINT64) > > ~EFI_SMRAM_OPEN; > > + SmmAccess->SmramDesc[DescriptorIndex].RegionState |=3D (UINT64) > > (EFI_SMRAM_CLOSED | EFI_ALLOCATED); > > + > > + // > > + // Find out if any regions are still open > > + // > > + OpenState =3D FALSE; > > + for (Index =3D 0; Index < SmmAccess->NumberRegions; Index++) { > > + if ((SmmAccess->SmramDesc[Index].RegionState & EFI_SMRAM_OPEN) = =3D=3D > > EFI_SMRAM_OPEN) { > > + OpenState =3D TRUE; > > + } > > + } > > + > > + SmmAccess->SmmAccess.OpenState =3D OpenState; > > + return EFI_SUCCESS; > > +} > > + > > +/** > > + This routine accepts a request to "lock" SMRAM. The > > + region could be legacy AB or TSEG near top of physical memory. > > + The use of "lock" means that the memory can no longer be opened > > + to PEIM. > > + > > + @param[in] PeiServices - General purpose services available to= every > > PEIM. > > + @param[in] This - Pointer to the SMM Access Interface. > > + @param[in] DescriptorIndex - Region of SMRAM to Lock. > > + > > + @retval EFI_SUCCESS - The region was successfully locke= d. > > + @retval EFI_DEVICE_ERROR - The region could not be locked be= cause > > at least > > + one range is still open. > > + @retval EFI_INVALID_PARAMETER - The descriptor index was out of > > bounds. > > +**/ > > +EFI_STATUS > > +EFIAPI > > +Lock ( > > + IN EFI_PEI_SERVICES **PeiServices, > > + IN EFI_PEI_MM_ACCESS_PPI *This, > > + IN UINTN DescriptorIndex > > + ) > > +{ > > + SMM_ACCESS_PRIVATE_DATA *SmmAccess; > > + > > + SmmAccess =3D SMM_ACCESS_PRIVATE_DATA_FROM_THIS (This); > > + if (DescriptorIndex >=3D SmmAccess->NumberRegions) { > > + DEBUG ((DEBUG_WARN, "SMRAM region out of range\n")); > > + > > + return EFI_INVALID_PARAMETER; > > + } else if (SmmAccess->SmmAccess.OpenState) { > > + DEBUG ((DEBUG_WARN, "Cannot lock SMRAM when SMRAM regions are > > still open\n")); > > + > > + return EFI_DEVICE_ERROR; > > + } > > + > > + SmmAccess->SmramDesc[DescriptorIndex].RegionState |=3D (UINT64) > > EFI_SMRAM_LOCKED; > > + SmmAccess->SmmAccess.LockState =3D TRUE; > > + > > + return EFI_SUCCESS; > > +} > > + > > +/** > > + This routine services a user request to discover the SMRAM > > + capabilities of this platform. This will report the possible > > + ranges that are possible for SMRAM access, based upon the > > + memory controller capabilities. > > + > > + @param[in] PeiServices - General purpose services available to ev= ery > > PEIM. > > + @param[in] This - Pointer to the SMRAM Access Interface. > > + @param[in] SmramMapSize - Pointer to the variable containing size= of > > the > > + buffer to contain the description infor= mation. > > + @param[in] SmramMap - Buffer containing the data describing t= he > > Smram > > + region descriptors. > > + > > + @retval EFI_BUFFER_TOO_SMALL - The user did not provide a suffici= ent > > buffer. > > + @retval EFI_SUCCESS - The user provided a sufficiently-s= ized buffer. > > +**/ > > +EFI_STATUS > > +EFIAPI > > +GetCapabilities ( > > + IN EFI_PEI_SERVICES **PeiServices, > > + IN EFI_PEI_MM_ACCESS_PPI *This, > > + IN OUT UINTN *SmramMapSize, > > + IN OUT EFI_SMRAM_DESCRIPTOR *SmramMap > > + ) > > +{ > > + EFI_STATUS Status; > > + SMM_ACCESS_PRIVATE_DATA *SmmAccess; > > + UINTN NecessaryBufferSize; > > + > > + SmmAccess =3D SMM_ACCESS_PRIVATE_DATA_FROM_THIS (This); > > + NecessaryBufferSize =3D SmmAccess->NumberRegions * sizeof > > (EFI_SMRAM_DESCRIPTOR); > > + if (*SmramMapSize < NecessaryBufferSize) { > > + DEBUG ((DEBUG_WARN, "SMRAM Map Buffer too small\n")); > > + > > + Status =3D EFI_BUFFER_TOO_SMALL; > > + } else { > > + CopyMem (SmramMap, SmmAccess->SmramDesc, NecessaryBufferSize); > > + Status =3D EFI_SUCCESS; > > + } > > + > > + *SmramMapSize =3D NecessaryBufferSize; > > + return Status; > > +} > > + > > +/** > > + This function is to install an SMM Access PPI > > + - Introduction \n > > + A module to install a PPI for controlling SMM mode memory access > > basically for S3 resume usage. > > + > > + - @result > > + Publish _EFI_PEI_MM_ACCESS_PPI. > > + > > + @retval EFI_SUCCESS - Ppi successfully started and inst= alled. > > + @retval EFI_NOT_FOUND - Ppi can't be found. > > + @retval EFI_OUT_OF_RESOURCES - Ppi does not have enough resource= s > > to initialize the driver. > > +**/ > > +EFI_STATUS > > +EFIAPI > > +PeiInstallSmmAccessPpi ( > > + VOID > > + ) > > +{ > > + EFI_STATUS Status; > > + UINTN Index; > > + EFI_PEI_PPI_DESCRIPTOR *PpiList; > > + EFI_SMRAM_HOB_DESCRIPTOR_BLOCK *DescriptorBlock; > > + SMM_ACCESS_PRIVATE_DATA *SmmAccessPrivate; > > + VOID *HobList; > > + EFI_BOOT_MODE BootMode; > > + > > + Status =3D PeiServicesGetBootMode (&BootMode); > > + if (EFI_ERROR (Status)) { > > + // > > + // If not in S3 boot path. do nothing > > + // > > + return EFI_SUCCESS; > > + } > > + > > + if (BootMode !=3D BOOT_ON_S3_RESUME) { > > + return EFI_SUCCESS; > > + } > > + // > > + // Initialize private data > > + // > > + SmmAccessPrivate =3D AllocateZeroPool (sizeof (*SmmAccessPrivate))= ; > > + ASSERT (SmmAccessPrivate !=3D NULL); > > + if (SmmAccessPrivate =3D=3D NULL) { > > + return EFI_OUT_OF_RESOURCES; > > + } > > + PpiList =3D AllocateZeroPool (sizeof (*PpiList)); > > + ASSERT (PpiList !=3D NULL); > > + if (PpiList =3D=3D NULL) { > > + return EFI_OUT_OF_RESOURCES; > > + } > > + > > + SmmAccessPrivate->Signature =3D > > SMM_ACCESS_PRIVATE_DATA_SIGNATURE; > > + SmmAccessPrivate->Handle =3D NULL; > > + > > + // > > + // Get Hob list > > + // > > + HobList =3D GetFirstGuidHob (&gEfiSmmSmramMemoryGuid); > > + if (HobList =3D=3D NULL) { > > + DEBUG ((DEBUG_WARN, "SmramMemoryReserve HOB not found\n")); > > + return EFI_NOT_FOUND; > > + } > > + > > + DescriptorBlock =3D (EFI_SMRAM_HOB_DESCRIPTOR_BLOCK *) ((UINT8 *) > > HobList + sizeof (EFI_HOB_GUID_TYPE)); > > + > > + // > > + // Alloc space for SmmAccessPrivate->SmramDesc > > + // > > + SmmAccessPrivate->SmramDesc =3D AllocateZeroPool ((DescriptorBlock- > > >NumberOfSmmReservedRegions) * sizeof (EFI_SMRAM_DESCRIPTOR)); > > + if (SmmAccessPrivate->SmramDesc =3D=3D NULL) { > > + DEBUG ((DEBUG_WARN, "Alloc SmmAccessPrivate->SmramDesc fail.\n"))= ; > > + return EFI_OUT_OF_RESOURCES; > > + } > > + > > + DEBUG ((DEBUG_INFO, "Alloc SmmAccessPrivate->SmramDesc > > success.\n")); > > + > > + // > > + // use the hob to publish SMRAM capabilities > > + // > > + for (Index =3D 0; Index < DescriptorBlock->NumberOfSmmReservedRegio= ns; > > Index++) { > > + SmmAccessPrivate->SmramDesc[Index].PhysicalStart =3D DescriptorB= lock- > > >Descriptor[Index].PhysicalStart; > > + SmmAccessPrivate->SmramDesc[Index].CpuStart =3D DescriptorB= lock- > > >Descriptor[Index].CpuStart; > > + SmmAccessPrivate->SmramDesc[Index].PhysicalSize =3D DescriptorB= lock- > > >Descriptor[Index].PhysicalSize; > > + SmmAccessPrivate->SmramDesc[Index].RegionState =3D DescriptorB= lock- > > >Descriptor[Index].RegionState; > > + } > > + > > + SmmAccessPrivate->NumberRegions =3D Index; > > + SmmAccessPrivate->SmmAccess.Open =3D Open; > > + SmmAccessPrivate->SmmAccess.Close =3D Close; > > + SmmAccessPrivate->SmmAccess.Lock =3D Lock; > > + SmmAccessPrivate->SmmAccess.GetCapabilities =3D GetCapabilities; > > + SmmAccessPrivate->SmmAccess.LockState =3D FALSE; > > + SmmAccessPrivate->SmmAccess.OpenState =3D FALSE; > > + > > + // > > + // Install PPI > > + // > > + PpiList->Flags =3D (EFI_PEI_PPI_DESCRIPTOR_PPI | > > EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST); > > + PpiList->Guid =3D &gEfiPeiMmAccessPpiGuid; > > + PpiList->Ppi =3D &SmmAccessPrivate->SmmAccess; > > + > > + Status =3D PeiServicesInstallPpi (PpiList); > > + ASSERT_EFI_ERROR (Status); > > + > > + return EFI_SUCCESS; > > +} > > diff --git > > a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmmAccess= Lib > > /PeiSmmAccessLib.inf > > b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmmAccess= Lib > > /PeiSmmAccessLib.inf > > new file mode 100644 > > index 0000000000..0c2411ea57 > > --- /dev/null > > +++ > > b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/Library/PeiSmmAccess= Lib > > /PeiSmmAccessLib.inf > > @@ -0,0 +1,41 @@ > > +## @file > > +# Library description file for the SmmAccess > > +# > > +# Copyright (c) 2019, Intel Corporation. All rights reserved.
> > +# SPDX-License-Identifier: BSD-2-Clause-Patent > > +# > > +## > > + > > + > > +[Defines] > > +INF_VERSION =3D 0x00010017 > > +BASE_NAME =3D PeiSmmAccessLib > > +FILE_GUID =3D 54020881-B594-442A-8377-A57AFF98C7CF > > +VERSION_STRING =3D 1.0 > > +MODULE_TYPE =3D PEIM > > +LIBRARY_CLASS =3D SmmAccessLib > > + > > + > > +[LibraryClasses] > > +BaseLib > > +BaseMemoryLib > > +HobLib > > +PciSegmentLib > > +PeiServicesLib > > + > > + > > +[Packages] > > +MdePkg/MdePkg.dec > > +IntelSiliconPkg/IntelSiliconPkg.dec > > + > > + > > +[Sources] > > +PeiSmmAccessLib.c > > + > > + > > +[Ppis] > > +gEfiPeiMmAccessPpiGuid ## PRODUCES > > + > > + > > +[Guids] > > +gEfiSmmSmramMemoryGuid > > diff --git > > a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAcc > > ess.inf > > b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAcc > > ess.inf > > new file mode 100644 > > index 0000000000..34dc65d7a3 > > --- /dev/null > > +++ > > b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAcc > > ess.inf > > @@ -0,0 +1,46 @@ > > +## @file > > +# Component description file for the SmmAccess module > > +# > > +# Copyright (c) 2019, Intel Corporation. All rights reserved.
> > +# SPDX-License-Identifier: BSD-2-Clause-Patent > > +# > > +## > > + > > + > > +[Defines] > > +INF_VERSION =3D 0x00010017 > > +BASE_NAME =3D SmmAccess > > +FILE_GUID =3D 1323C7F8-DAD5-4126-A54B-7A05FBF41515 > > +VERSION_STRING =3D 1.0 > > +MODULE_TYPE =3D DXE_DRIVER > > +ENTRY_POINT =3D SmmAccessDriverEntryPoint > > + > > + > > +[LibraryClasses] > > +UefiDriverEntryPoint > > +BaseLib > > +BaseMemoryLib > > +DebugLib > > +HobLib > > + > > + > > +[Packages] > > +MdePkg/MdePkg.dec > > +IntelSiliconPkg/IntelSiliconPkg.dec > > + > > + > > +[Sources] > > +SmmAccessDriver.h > > +SmmAccessDriver.c > > + > > + > > +[Protocols] > > +gEfiSmmAccess2ProtocolGuid ## PRODUCES > > + > > + > > +[Guids] > > +gEfiSmmSmramMemoryGuid > > + > > + > > +[Depex] > > +TRUE > > diff --git > > a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAcc > > essDriver.c > > b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAcc > > essDriver.c > > new file mode 100644 > > index 0000000000..3d3c4ab206 > > --- /dev/null > > +++ > > b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAcc > > essDriver.c > > @@ -0,0 +1,267 @@ > > +/** @file > > + This is the driver that publishes the SMM Access Protocol > > + instance for System Agent. > > + > > + Copyright (c) 2019, Intel Corporation. All rights reserved.
> > + SPDX-License-Identifier: BSD-2-Clause-Patent > > + > > +**/ > > +#include "SmmAccessDriver.h" > > + > > +static SMM_ACCESS_PRIVATE_DATA mSmmAccess; > > + > > +/** > > + This is the standard EFI driver point that > > + installs an SMM Access Protocol > > + > > + @param[in] ImageHandle - Handle for the image of this driver > > + @param[in] SystemTable - Pointer to the EFI System Table > > + > > + @retval EFI_SUCCESS - Protocol was installed successfully > > + @exception EFI_UNSUPPORTED - Protocol was not installed > > + @retval EFI_NOT_FOUND - Protocol can't be found. > > + @retval EFI_OUT_OF_RESOURCES - Protocol does not have enough > > resources to initialize the driver. > > +**/ > > +EFI_STATUS > > +EFIAPI > > +SmmAccessDriverEntryPoint ( > > + IN EFI_HANDLE ImageHandle, > > + IN EFI_SYSTEM_TABLE *SystemTable > > + ) > > +{ > > + EFI_STATUS Status; > > + UINTN Index; > > + EFI_SMRAM_HOB_DESCRIPTOR_BLOCK *DescriptorBlock; > > + EFI_PEI_HOB_POINTERS *Hob; > > + > > + // > > + // Initialize Global variables > > + // > > + ZeroMem (&mSmmAccess, sizeof (mSmmAccess)); > > + > > + mSmmAccess.Signature =3D SMM_ACCESS_PRIVATE_DATA_SIGNATURE; > > + mSmmAccess.Handle =3D NULL; > > + > > + // > > + // Get Hob list > > + // > > + Hob =3D GetFirstGuidHob (&gEfiSmmSmramMemoryGuid); > > + if (Hob =3D=3D NULL) { > > + DEBUG ((DEBUG_WARN, "SmramMemoryReserve HOB not found\n")); > > + return EFI_NOT_FOUND; > > + } > > + > > + DescriptorBlock =3D (VOID *) ((UINT8 *) Hob + sizeof (EFI_HOB_GUID_= TYPE)); > > + > > + // > > + // Alloc space for mSmmAccess.SmramDesc > > + // > > + mSmmAccess.SmramDesc =3D AllocateZeroPool ((DescriptorBlock- > > >NumberOfSmmReservedRegions) * sizeof (EFI_SMRAM_DESCRIPTOR)); > > + if (mSmmAccess.SmramDesc =3D=3D NULL) { > > + DEBUG ((DEBUG_WARN, "Alloc mSmmAccess.SmramDesc fail.\n")); > > + return EFI_OUT_OF_RESOURCES; > > + } > > + > > + DEBUG ((DEBUG_INFO, "Alloc mSmmAccess.SmramDesc success.\n")); > > + > > + // > > + // Use the HOB to publish SMRAM capabilities > > + // > > + for (Index =3D 0; Index < DescriptorBlock->NumberOfSmmReservedRegio= ns; > > Index++) { > > + mSmmAccess.SmramDesc[Index].PhysicalStart =3D DescriptorBlock- > > >Descriptor[Index].PhysicalStart; > > + mSmmAccess.SmramDesc[Index].CpuStart =3D DescriptorBlock- > > >Descriptor[Index].CpuStart; > > + mSmmAccess.SmramDesc[Index].PhysicalSize =3D DescriptorBlock- > > >Descriptor[Index].PhysicalSize; > > + mSmmAccess.SmramDesc[Index].RegionState =3D DescriptorBlock- > > >Descriptor[Index].RegionState; > > + } > > + > > + mSmmAccess.NumberRegions =3D Index; > > + mSmmAccess.SmmAccess.Open =3D Open; > > + mSmmAccess.SmmAccess.Close =3D Close; > > + mSmmAccess.SmmAccess.Lock =3D Lock; > > + mSmmAccess.SmmAccess.GetCapabilities =3D GetCapabilities; > > + mSmmAccess.SmmAccess.LockState =3D FALSE; > > + mSmmAccess.SmmAccess.OpenState =3D FALSE; > > + > > + // > > + // Install our protocol interfaces on the device's handle > > + // > > + Status =3D gBS->InstallMultipleProtocolInterfaces ( > > + &mSmmAccess.Handle, > > + &gEfiSmmAccess2ProtocolGuid, > > + &mSmmAccess.SmmAccess, > > + NULL > > + ); > > + if (EFI_ERROR (Status)) { > > + DEBUG ((DEBUG_WARN, "InstallMultipleProtocolInterfaces returned > > %r\n", Status)); > > + return EFI_UNSUPPORTED; > > + } > > + > > + return EFI_SUCCESS; > > +} > > + > > +/** > > + This routine accepts a request to "open" a region of SMRAM. The > > + region could be legacy ABSEG, HSEG, or TSEG near top of physical me= mory. > > + The use of "open" means that the memory is visible from all boot-se= rvice > > + and SMM agents. > > + > > + @param[in] This - Pointer to the SMM Access Interface= . > > + > > + @retval EFI_SUCCESS - The region was successfully opened. > > + @retval EFI_DEVICE_ERROR - The region could not be opened beca= use > > locked by > > + chipset. > > + @retval EFI_INVALID_PARAMETER - The descriptor index was out of > > bounds. > > +**/ > > +EFI_STATUS > > +EFIAPI > > +Open ( > > + IN EFI_SMM_ACCESS2_PROTOCOL *This > > + ) > > +{ > > + SMM_ACCESS_PRIVATE_DATA *SmmAccess; > > + UINTN DescriptorIndex; > > + > > + SmmAccess =3D SMM_ACCESS_PRIVATE_DATA_FROM_THIS (This); > > + for (DescriptorIndex =3D 0; DescriptorIndex < SmmAccess->NumberRegi= ons; > > DescriptorIndex++) { > > + if (SmmAccess->SmramDesc[DescriptorIndex].RegionState & > > EFI_SMRAM_LOCKED) { > > + DEBUG ((DEBUG_WARN, "Cannot open a locked SMRAM region\n")); > > + return EFI_DEVICE_ERROR; > > + } > > + } > > + > > + for (DescriptorIndex =3D 0; DescriptorIndex < SmmAccess->NumberRegi= ons; > > DescriptorIndex++) { > > + SmmAccess->SmramDesc[DescriptorIndex].RegionState &=3D (UINT64) > > ~(EFI_SMRAM_CLOSED | EFI_ALLOCATED); > > + SmmAccess->SmramDesc[DescriptorIndex].RegionState |=3D (UINT64) > > EFI_SMRAM_OPEN; > > + } > > + SmmAccess->SmmAccess.OpenState =3D TRUE; > > + return EFI_SUCCESS; > > +} > > + > > +/** > > + This routine accepts a request to "close" a region of SMRAM. The > > + region could be legacy AB or TSEG near top of physical memory. > > + The use of "close" means that the memory is only visible from SMM a= gents, > > + not from BS or RT code. > > + > > + @param[in] This - Pointer to the SMM Access Interface= . > > + > > + @retval EFI_SUCCESS - The region was successfully closed. > > + @retval EFI_DEVICE_ERROR - The region could not be closed beca= use > > locked by chipset. > > + @retval EFI_INVALID_PARAMETER - The descriptor index was out of > > bounds. > > +**/ > > +EFI_STATUS > > +EFIAPI > > +Close ( > > + IN EFI_SMM_ACCESS2_PROTOCOL *This > > + ) > > +{ > > + SMM_ACCESS_PRIVATE_DATA *SmmAccess; > > + BOOLEAN OpenState; > > + UINT8 Index; > > + UINTN DescriptorIndex; > > + > > + SmmAccess =3D SMM_ACCESS_PRIVATE_DATA_FROM_THIS (This); > > + > > + for (DescriptorIndex =3D 0; DescriptorIndex < SmmAccess->NumberRegi= ons; > > DescriptorIndex++) { > > + if (SmmAccess->SmramDesc[DescriptorIndex].RegionState & > > EFI_SMRAM_LOCKED) { > > + DEBUG ((DEBUG_WARN, "Cannot close a locked SMRAM region\n")); > > + continue; > > + } > > + > > + SmmAccess->SmramDesc[DescriptorIndex].RegionState &=3D (UINT64) > > ~EFI_SMRAM_OPEN; > > + SmmAccess->SmramDesc[DescriptorIndex].RegionState |=3D (UINT64) > > (EFI_SMRAM_CLOSED | EFI_ALLOCATED); > > + } > > + > > + // > > + // Find out if any regions are still open > > + // > > + OpenState =3D FALSE; > > + for (Index =3D 0; Index < mSmmAccess.NumberRegions; Index++) { > > + if ((SmmAccess->SmramDesc[Index].RegionState & EFI_SMRAM_OPEN) = =3D=3D > > EFI_SMRAM_OPEN) { > > + OpenState =3D TRUE; > > + } > > + } > > + > > + SmmAccess->SmmAccess.OpenState =3D OpenState; > > + return EFI_SUCCESS; > > +} > > + > > +/** > > + This routine accepts a request to "lock" SMRAM. The > > + region could be legacy AB or TSEG near top of physical memory. > > + The use of "lock" means that the memory can no longer be opened > > + to BS state.. > > + > > + @param[in] This - Pointer to the SMM Access Interface= . > > + > > + @retval EFI_SUCCESS - The region was successfully locked. > > + @retval EFI_DEVICE_ERROR - The region could not be locked beca= use at > > least > > + one range is still open. > > + @retval EFI_INVALID_PARAMETER - The descriptor index was out of > > bounds. > > +**/ > > +EFI_STATUS > > +EFIAPI > > +Lock ( > > + IN EFI_SMM_ACCESS2_PROTOCOL *This > > + ) > > +{ > > + SMM_ACCESS_PRIVATE_DATA *SmmAccess; > > + UINTN DescriptorIndex; > > + > > + SmmAccess =3D SMM_ACCESS_PRIVATE_DATA_FROM_THIS (This); > > + > > + if (SmmAccess->SmmAccess.OpenState) { > > + DEBUG ((DEBUG_WARN, "Cannot lock SMRAM when SMRAM regions are > > still open\n")); > > + return EFI_DEVICE_ERROR; > > + } > > + for (DescriptorIndex =3D 0; DescriptorIndex < SmmAccess->NumberRegi= ons; > > DescriptorIndex++) { > > + SmmAccess->SmramDesc[DescriptorIndex].RegionState |=3D > > EFI_SMRAM_LOCKED; > > + } > > + SmmAccess->SmmAccess.LockState =3D TRUE; > > + > > + return EFI_SUCCESS; > > +} > > + > > +/** > > + This routine services a user request to discover the SMRAM > > + capabilities of this platform. This will report the possible > > + ranges that are possible for SMRAM access, based upon the > > + memory controller capabilities. > > + > > + @param[in] This - Pointer to the SMRAM Access Inte= rface. > > + @param[in] SmramMapSize - Pointer to the variable containi= ng size > > of the > > + buffer to contain the descriptio= n information. > > + @param[in] SmramMap - Buffer containing the data descr= ibing the > > Smram > > + region descriptors. > > + > > + @retval EFI_BUFFER_TOO_SMALL - The user did not provide a sufficie= nt > > buffer. > > + @retval EFI_SUCCESS - The user provided a sufficiently-si= zed buffer. > > +**/ > > +EFI_STATUS > > +EFIAPI > > +GetCapabilities ( > > + IN CONST EFI_SMM_ACCESS2_PROTOCOL *This, > > + IN OUT UINTN *SmramMapSize, > > + IN OUT EFI_SMRAM_DESCRIPTOR *SmramMap > > + ) > > +{ > > + EFI_STATUS Status; > > + SMM_ACCESS_PRIVATE_DATA *SmmAccess; > > + UINTN NecessaryBufferSize; > > + > > + SmmAccess =3D SMM_ACCESS_PRIVATE_DATA_FROM_THIS (This); > > + > > + NecessaryBufferSize =3D SmmAccess->NumberRegions * sizeof > > (EFI_SMRAM_DESCRIPTOR); > > + > > + if (*SmramMapSize < NecessaryBufferSize) { > > + DEBUG ((DEBUG_WARN, "SMRAM Map Buffer too small\n")); > > + Status =3D EFI_BUFFER_TOO_SMALL; > > + } else { > > + CopyMem (SmramMap, SmmAccess->SmramDesc, NecessaryBufferSize); > > + Status =3D EFI_SUCCESS; > > + } > > + > > + *SmramMapSize =3D NecessaryBufferSize; > > + > > + return Status; > > +} > > diff --git > > a/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAcc > > essDriver.h > > b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAcc > > essDriver.h > > new file mode 100644 > > index 0000000000..c0ff3a250b > > --- /dev/null > > +++ > > b/Silicon/Intel/IntelSiliconPkg/Feature/SmmAccess/SmmAccessDxe/SmmAcc > > essDriver.h > > @@ -0,0 +1,160 @@ > > +/** @file > > + Header file for SMM Access Driver. > > + > > + Copyright (c) 2019, Intel Corporation. All rights reserved.
> > + SPDX-License-Identifier: BSD-2-Clause-Patent > > + > > +**/ > > +#ifndef _SMM_ACCESS_DRIVER_H_ > > +#define _SMM_ACCESS_DRIVER_H_ > > + > > +#include > > +#include > > +#include > > +#include > > +#include > > +#include > > +#include > > + > > +#include > > +#include > > +#include > > + > > +#define SMM_ACCESS_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('4', '5', > > 's', 'a') > > + > > +/// > > +/// Private data > > +/// > > +typedef struct { > > + UINTN Signature; > > + EFI_HANDLE Handle; > > + EFI_SMM_ACCESS2_PROTOCOL SmmAccess; > > + > > + /// > > + /// Local Data for SMM Access interface goes here > > + /// > > + UINTN NumberRegions; > > + EFI_SMRAM_DESCRIPTOR *SmramDesc; > > +} SMM_ACCESS_PRIVATE_DATA; > > + > > +#define SMM_ACCESS_PRIVATE_DATA_FROM_THIS(a) \ > > + CR (a, \ > > + SMM_ACCESS_PRIVATE_DATA, \ > > + SmmAccess, \ > > + SMM_ACCESS_PRIVATE_DATA_SIGNATURE \ > > + ) > > + > > +// > > +// Prototypes > > +// Driver model protocol interface > > +// > > +/** > > + SMM Access Driver Entry Point > > + This driver installs an SMM Access Protocol > > + - Introduction \n > > + This module publishes the SMM access protocol. The protocol is u= sed by > > the SMM Base driver to access the SMRAM region when the processor is n= ot > > in SMM. > > + The SMM Base driver uses the services provided by the SMM access > > protocol to open SMRAM during post and copy the SMM handler. > > + SMM access protocol is also used to close the SMRAM region once t= he > > copying is done. > > + Finally, the SMM access protocol provides services to "Lock" the = SMRAM > > region. > > + Please refer the SMM Protocols section in the attached SMM CIS > > Specification version 0.9 for further details. > > + This driver is required if SMM is supported. Proper configuration= of SMM > > registers is recommended even if SMM is not supported. > > + > > + - @result > > + Publishes the _EFI_SMM_ACCESS_PROTOCOL: Documented in the System > > Management Mode Core Interface Specification, available at the URL: > > http://www.intel.com/technology/framework/spec.htm > > + > > + - Porting Recommendations \n > > + No modification of this module is recommended. Any modification > > should be done in compliance with the _EFI_SMM_ACCESS_PROTOCOL > > protocol definition. > > + > > + @param[in] ImageHandle - Handle for the image of this driver > > + @param[in] SystemTable - Pointer to the EFI System Table > > + > > + @retval EFI_SUCCESS - Protocol was installed successfully > > + @exception EFI_UNSUPPORTED - Protocol was not installed > > +**/ > > +EFI_STATUS > > +EFIAPI > > +SmmAccessDriverEntryPoint ( > > + IN EFI_HANDLE ImageHandle, > > + IN EFI_SYSTEM_TABLE *SystemTable > > + ); > > + > > +/** > > + This routine accepts a request to "open" a region of SMRAM. The > > + region could be legacy ABSEG, HSEG, or TSEG near top of physical me= mory. > > + The use of "open" means that the memory is visible from all boot-se= rvice > > + and SMM agents. > > + > > + @param[in] This - Pointer to the SMM Access Interf= ace. > > + > > + @retval EFI_SUCCESS - The region was successfully opened. > > + @retval EFI_DEVICE_ERROR - The region could not be opened beca= use > > locked by > > + chipset. > > + @retval EFI_INVALID_PARAMETER - The descriptor index was out of > > bounds. > > +**/ > > +EFI_STATUS > > +EFIAPI > > +Open ( > > + IN EFI_SMM_ACCESS2_PROTOCOL *This > > + ); > > + > > +/** > > + This routine accepts a request to "close" a region of SMRAM. The > > + region could be legacy AB or TSEG near top of physical memory. > > + The use of "close" means that the memory is only visible from SMM a= gents, > > + not from BS or RT code. > > + > > + @param[in] This - Pointer to the SMM Access Interf= ace. > > + > > + @retval EFI_SUCCESS - The region was successfully closed. > > + @retval EFI_DEVICE_ERROR - The region could not be closed beca= use > > locked by > > + chipset. > > + @retval EFI_INVALID_PARAMETER - The descriptor index was out of > > bounds. > > +**/ > > +EFI_STATUS > > +EFIAPI > > +Close ( > > + IN EFI_SMM_ACCESS2_PROTOCOL *This > > + ); > > + > > +/** > > + This routine accepts a request to "lock" SMRAM. The > > + region could be legacy AB or TSEG near top of physical memory. > > + The use of "lock" means that the memory can no longer be opened > > + to BS state.. > > + > > + @param[in] This - Pointer to the SMM Access Interf= ace. > > + > > + @retval EFI_SUCCESS - The region was successfully locked. > > + @retval EFI_DEVICE_ERROR - The region could not be locked beca= use at > > least > > + one range is still open. > > + @retval EFI_INVALID_PARAMETER - The descriptor index was out of > > bounds. > > +**/ > > +EFI_STATUS > > +EFIAPI > > +Lock ( > > + IN EFI_SMM_ACCESS2_PROTOCOL *This > > + ); > > + > > +/** > > + This routine services a user request to discover the SMRAM > > + capabilities of this platform. This will report the possible > > + ranges that are possible for SMRAM access, based upon the > > + memory controller capabilities. > > + > > + @param[in] This - Pointer to the SMRAM Access Inte= rface. > > + @param[in] SmramMapSize - Pointer to the variable containi= ng size > > of the > > + buffer to contain the description informa= tion. > > + @param[in] SmramMap - Buffer containing the data descr= ibing the > > Smram > > + region descriptors. > > + > > + @retval EFI_BUFFER_TOO_SMALL - The user did not provide a sufficie= nt > > buffer. > > + @retval EFI_SUCCESS - The user provided a sufficiently-si= zed buffer. > > +**/ > > +EFI_STATUS > > +EFIAPI > > +GetCapabilities ( > > + IN CONST EFI_SMM_ACCESS2_PROTOCOL *This, > > + IN OUT UINTN *SmramMapSize, > > + IN OUT EFI_SMRAM_DESCRIPTOR *SmramMap > > + ); > > +#endif > > diff --git a/Silicon/Intel/IntelSiliconPkg/Include/Library/SmmAccessLi= b.h > > b/Silicon/Intel/IntelSiliconPkg/Include/Library/SmmAccessLib.h > > new file mode 100644 > > index 0000000000..f658bac68c > > --- /dev/null > > +++ b/Silicon/Intel/IntelSiliconPkg/Include/Library/SmmAccessLib.h > > @@ -0,0 +1,28 @@ > > +/** @file > > + Header file for SMM Access Driver. > > + > > + Copyright (c) 2019, Intel Corporation. All rights reserved.
> > + SPDX-License-Identifier: BSD-2-Clause-Patent > > + > > +**/ > > +#ifndef _SMM_ACCESS_LIB_H_ > > +#define _SMM_ACCESS_LIB_H_ > > + > > +/** > > + This function is to install an SMM Access PPI > > + - Introduction \n > > + A module to install a PPI for controlling SMM mode memory access > > basically for S3 resume usage. > > + > > + - @result > > + Publish _PEI_MM_ACCESS_PPI. > > + > > + @retval EFI_SUCCESS - Ppi successfully started and inst= alled. > > + @retval EFI_NOT_FOUND - Ppi can't be found. > > + @retval EFI_OUT_OF_RESOURCES - Ppi does not have enough resource= s > > to initialize the driver. > > +**/ > > +EFI_STATUS > > +EFIAPI > > +PeiInstallSmmAccessPpi ( > > + VOID > > + ); > > +#endif > > -- > > 2.16.2.windows.1 > > > > > >=20