UefiCpuPkg: Add SmmCpuPlatformHookLib

[mirror_edk2.git] / UefiCpuPkg / Include / Library / SmmCpuPlatformHookLib.h

diff --git a/UefiCpuPkg/Include/Library/SmmCpuPlatformHookLib.h b/UefiCpuPkg/Include/Library/SmmCpuPlatformHookLib.h
new file mode 100644 (file)
index 0000000..e40084e
--- /dev/null
+++ b/UefiCpuPkg/Include/Library/SmmCpuPlatformHookLib.h
@@ -0,0 +1,109 @@
+/** @file\r
+  Public include file for the SMM CPU Platform Hook Library.\r
+\r
+  Copyright (c) 2010 - 2015, Intel Corporation. All rights reserved.<BR>\r
+  This program and the accompanying materials\r
+  are licensed and made available under the terms and conditions of the BSD License\r
+  which accompanies this distribution.  The full text of the license may be found at\r
+  http://opensource.org/licenses/bsd-license.php\r
+\r
+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+\r
+**/\r
+\r
+#ifndef __SMM_CPU_PLATFORM_HOOK_LIB_H__\r
+#define __SMM_CPU_PLATFORM_HOOK_LIB_H__\r
+\r
+///\r
+/// SMM Page Size Type\r
+///\r
+typedef enum {\r
+    SmmPageSize4K,\r
+    SmmPageSize2M,\r
+    SmmPageSize1G,\r
+    MaxSmmPageSizeType\r
+} SMM_PAGE_SIZE_TYPE;\r
+\r
+/**\r
+  Checks if platform produces a valid SMI.\r
+\r
+  This function checks if platform produces a valid SMI. This function is\r
+  called at SMM entry to detect if this is a spurious SMI. This function\r
+  must be implemented in an MP safe way because it is called by multiple CPU\r
+  threads.\r
+\r
+  @retval TRUE              There is a valid SMI\r
+  @retval FALSE             There is no valid SMI\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+PlatformValidSmi (\r
+  VOID\r
+  );\r
+\r
+/**\r
+  Clears platform top level SMI status bit.\r
+\r
+  This function clears platform top level SMI status bit.\r
+\r
+  @retval TRUE              The platform top level SMI status is cleared.\r
+  @retval FALSE             The platform top level SMI status cannot be cleared.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+ClearTopLevelSmiStatus (\r
+  VOID\r
+  );\r
+\r
+/**\r
+  Performs platform specific way of SMM BSP election.\r
+\r
+  This function performs platform specific way of SMM BSP election.\r
+\r
+  @param  IsBsp             Output parameter. TRUE: the CPU this function executes\r
+                            on is elected to be the SMM BSP. FALSE: the CPU this\r
+                            function executes on is to be SMM AP.\r
+\r
+  @retval EFI_SUCCESS       The function executes successfully.\r
+  @retval EFI_NOT_READY     The function does not determine whether this CPU should be\r
+                            BSP or AP. This may occur if hardware init sequence to\r
+                            enable the determination is yet to be done, or the function\r
+                            chooses not to do BSP election and will let SMM CPU driver to\r
+                            use its default BSP election process.\r
+  @retval EFI_DEVICE_ERROR  The function cannot determine whether this CPU should be\r
+                            BSP or AP due to hardware error.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+PlatformSmmBspElection (\r
+  OUT BOOLEAN     *IsBsp\r
+  );\r
+\r
+/**\r
+  Get platform page table attribute .\r
+\r
+  This function gets page table attribute of platform.\r
+\r
+  @param  Address        Input parameter. Obtain the page table entries attribute on this address.\r
+  @param  PageSize       Output parameter. The size of the page.\r
+  @param  NumOfPages     Output parameter. Number of page.\r
+  @param  PageAttribute  Output parameter. Paging Attributes (WB, UC, etc).\r
+\r
+  @retval EFI_SUCCESS      The platform page table attribute from the address is determined.\r
+  @retval EFI_UNSUPPORTED  The platform does not support getting page table attribute for the address.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+GetPlatformPageTableAttribute (\r
+  IN  UINT64                Address,\r
+  OUT SMM_PAGE_SIZE_TYPE    *PageSize,\r
+  OUT UINTN                 *NumOfPages,\r
+  OUT UINTN                 *PageAttribute\r
+  );\r
+\r
+#endif\r