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

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