Vlv2DeviceRefCodePkg/ValleyView2Soc/SouthCluster/Include/Protocol/TcoReset.h

   1 /*++
   2
   3 Copyright (c)  1999  - 2014, Intel Corporation. All rights reserved
   4
   5   This program and the accompanying materials are licensed and made available under
   6   the terms and conditions of the BSD License that accompanies this distribution.
   7   The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php.
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13
  14
  15 Module Name:
  16
  17   TcoReset.h
  18
  19 Abstract:
  20
  21   Protocol to communicate with ICH TCO.
  22
  23 GUID Info:
  24  {A6A79162-E325-4c30-BCC3-59373064EFB3}
  25  0xa6a79162, 0xe325, 0x4c30, 0xbc, 0xc3, 0x59, 0x37, 0x30, 0x64, 0xef, 0xb3);
  26
  27
  28 --*/
  29
  30 #ifndef _TCO_RESET_H_
  31 #define _TCO_RESET_H_
  32
  33
  34 #define EFI_TCO_RESET_PROTOCOL_GUID  \
  35   {0xa6a79162, 0xe325, 0x4c30, 0xbc, 0xc3, 0x59, 0x37, 0x30, 0x64, 0xef, 0xb3}
  36
  37 typedef struct _EFI_TCO_RESET_PROTOCOL EFI_TCO_RESET_PROTOCOL;
  38
  39 typedef
  40 EFI_STATUS
  41 (EFIAPI *EFI_TCO_RESET_PROTOCOL_ENABLE_TCO_RESET) (
  42   IN      UINT32            *RcrbGcsSaveValue
  43   )
  44 /*++
  45
  46 Routine Description:
  47
  48   Enables the TCO timer to reset the system in case of a system hang.  This is
  49   used when writing the clock registers.
  50
  51 Arguments:
  52
  53   RcrbGcsSaveValue  - This is the value of the RCRB GCS register before it is
  54                       changed by this procedure.  This will be used to restore
  55                       the settings of this register in PpiDisableTcoReset.
  56
  57 Returns:
  58
  59   EFI_STATUS
  60
  61 --*/
  62 ;
  63
  64 typedef
  65 EFI_STATUS
  66 (EFIAPI *EFI_TCO_RESET_PROTOCOL_DISABLE_TCO_RESET) (
  67   OUT     UINT32    RcrbGcsRestoreValue
  68   )
  69 /*++
  70
  71 Routine Description:
  72
  73   Disables the TCO timer.  This is used after writing the clock registers.
  74
  75 Arguments:
  76
  77   RcrbGcsRestoreValue - Value saved in PpiEnableTcoReset so that it can
  78                         restored.
  79
  80 Returns:
  81
  82   EFI_STATUS
  83
  84 --*/
  85 ;
  86
  87 typedef struct _EFI_TCO_RESET_PROTOCOL {
  88   EFI_TCO_RESET_PROTOCOL_ENABLE_TCO_RESET       EnableTcoReset;
  89   EFI_TCO_RESET_PROTOCOL_DISABLE_TCO_RESET      DisableTcoReset;
  90 } EFI_TCO_RESET_PROTOCOL;
  91
  92 extern EFI_GUID gEfiTcoResetProtocolGuid;
  93
  94 #endif