Vlv2DeviceRefCodePkg/ValleyView2Soc/SouthCluster/Include/Library/PchPlatformLib.h

   1 /**
   2 **/
   3 /**
   4
   5 Copyright (c) 2012  - 2014, Intel Corporation. All rights reserved
   6
   7   This program and the accompanying materials are licensed and made available under
   8   the terms and conditions of the BSD License that accompanies this distribution.
   9   The full text of the license may be found at
  10   http://opensource.org/licenses/bsd-license.php.
  11
  12   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  13   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  14
  15
  16   @file
  17   PchPlatformLib.h
  18
  19   @brief
  20   Header file for PchPlatform Lib.
  21
  22 **/
  23 #ifndef _PCH_PLATFORM_LIB_H_
  24 #define _PCH_PLATFORM_LIB_H_
  25
  26 ///
  27 /// Timeout value used when Sending / Receiving messages.
  28 /// NOTE: this must cover the longest possible wait time
  29 /// between message being sent and response being available.
  30 /// e.g. Virtual function readiness might take some time.
  31 ///
  32 VOID
  33 EFIAPI
  34 PchPmTimerStall (
  35   IN  UINTN   Microseconds
  36   )
  37 /**
  38
  39   @brief
  40   Delay for at least the request number of microseconds.
  41   This function would be called by runtime driver, please do not use any MMIO marco here.
  42
  43   @param[in] Microseconds         Number of microseconds to delay.
  44
  45   @retval NONE
  46
  47 **/
  48 ;
  49
  50 BOOLEAN
  51 EFIAPI
  52 PchIsSpiDescriptorMode (
  53   IN  UINTN   SpiBase
  54   )
  55 /**
  56
  57   @brief
  58   Check whether SPI is in descriptor mode
  59
  60   @param[in] SpiBase              The PCH Spi Base Address
  61
  62   @retval TRUE                    SPI is in descriptor mode
  63   @retval FALSE                   SPI is not in descriptor mode
  64
  65 **/
  66 ;
  67
  68 PCH_STEPPING
  69 EFIAPI
  70 PchStepping (
  71   VOID
  72   )
  73 /**
  74
  75   @brief
  76   Return Pch stepping type
  77
  78   @param[in] None
  79
  80   @retval PCH_STEPPING            Pch stepping type
  81
  82 **/
  83 ;
  84
  85 BOOLEAN
  86 IsPchSupported (
  87   VOID
  88   )
  89 /**
  90
  91   @brief
  92   Determine if PCH is supported
  93
  94   @param[in] None
  95
  96   @retval TRUE                    PCH is supported
  97   @retval FALSE                   PCH is not supported
  98
  99 **/
 100 ;
 101
 102 VOID
 103 EFIAPI
 104 PchAlternateAccessMode (
 105   IN  UINTN         IlbBase,
 106   IN  BOOLEAN       AmeCtrl
 107   )
 108 /**
 109
 110   This function can be called to enable/disable Alternate Access Mode
 111
 112   @param[in] IlbBase              The PCH ILB Base Address
 113   @param[in] AmeCtrl              If TRUE, enable Alternate Access Mode.
 114                                   If FALSE, disable Alternate Access Mode.
 115
 116   @retval NONE
 117
 118 **/
 119 ;
 120
 121 #endif