Upload BSD-licensed Vlv2TbltDevicePkg and Vlv2DeviceRefCodePkg to

[mirror_edk2.git] / Vlv2DeviceRefCodePkg / ValleyView2Soc / SouthCluster / Include / Library / PchPlatformLib.h

diff --git a/Vlv2DeviceRefCodePkg/ValleyView2Soc/SouthCluster/Include/Library/PchPlatformLib.h b/Vlv2DeviceRefCodePkg/ValleyView2Soc/SouthCluster/Include/Library/PchPlatformLib.h
new file mode 100644 (file)
index 0000000..8f0ca02
--- /dev/null
+++ b/Vlv2DeviceRefCodePkg/ValleyView2Soc/SouthCluster/Include/Library/PchPlatformLib.h
@@ -0,0 +1,121 @@
+/**\r
+**/\r
+/**\r
+\r
+Copyright (c) 2012  - 2014, Intel Corporation. All rights reserved\r
+\r
+  This program and the accompanying materials are licensed and made available under\r
+  the terms and conditions of the BSD License that accompanies this distribution.\r
+  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
+  @file\r
+  PchPlatformLib.h\r
+\r
+  @brief\r
+  Header file for PchPlatform Lib.\r
+\r
+**/\r
+#ifndef _PCH_PLATFORM_LIB_H_\r
+#define _PCH_PLATFORM_LIB_H_\r
+\r
+///\r
+/// Timeout value used when Sending / Receiving messages.\r
+/// NOTE: this must cover the longest possible wait time\r
+/// between message being sent and response being available.\r
+/// e.g. Virtual function readiness might take some time.\r
+///\r
+VOID\r
+EFIAPI\r
+PchPmTimerStall (\r
+  IN  UINTN   Microseconds\r
+  )\r
+/**\r
+\r
+  @brief\r
+  Delay for at least the request number of microseconds.\r
+  This function would be called by runtime driver, please do not use any MMIO marco here.\r
+\r
+  @param[in] Microseconds         Number of microseconds to delay.\r
+\r
+  @retval NONE\r
+\r
+**/\r
+;\r
+\r
+BOOLEAN\r
+EFIAPI\r
+PchIsSpiDescriptorMode (\r
+  IN  UINTN   SpiBase\r
+  )\r
+/**\r
+\r
+  @brief\r
+  Check whether SPI is in descriptor mode\r
+\r
+  @param[in] SpiBase              The PCH Spi Base Address\r
+\r
+  @retval TRUE                    SPI is in descriptor mode\r
+  @retval FALSE                   SPI is not in descriptor mode\r
+\r
+**/\r
+;\r
+\r
+PCH_STEPPING\r
+EFIAPI\r
+PchStepping (\r
+  VOID\r
+  )\r
+/**\r
+\r
+  @brief\r
+  Return Pch stepping type\r
+\r
+  @param[in] None\r
+\r
+  @retval PCH_STEPPING            Pch stepping type\r
+\r
+**/\r
+;\r
+\r
+BOOLEAN\r
+IsPchSupported (\r
+  VOID\r
+  )\r
+/**\r
+\r
+  @brief\r
+  Determine if PCH is supported\r
+\r
+  @param[in] None\r
+\r
+  @retval TRUE                    PCH is supported\r
+  @retval FALSE                   PCH is not supported\r
+\r
+**/\r
+;\r
+\r
+VOID\r
+EFIAPI\r
+PchAlternateAccessMode (\r
+  IN  UINTN         IlbBase,\r
+  IN  BOOLEAN       AmeCtrl\r
+  )\r
+/**\r
+\r
+  This function can be called to enable/disable Alternate Access Mode\r
+\r
+  @param[in] IlbBase              The PCH ILB Base Address\r
+  @param[in] AmeCtrl              If TRUE, enable Alternate Access Mode.\r
+                                  If FALSE, disable Alternate Access Mode.\r
+\r
+  @retval NONE\r
+\r
+**/\r
+;\r
+\r
+#endif\r