Vlv2TbltDevicePkg/Include/Protocol/TcoReset.h

   1 /*++
   2
   3   Copyright (c) 2004  - 2014, Intel Corporation. All rights reserved.<BR>
   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 /**
  40   Enables the TCO timer to reset the system in case of a system hang.  This is
  41   used when writing the clock registers.
  42
  43   @param[in] RcrbGcsSaveValue  This is the value of the RCRB GCS register before it is
  44                                changed by this procedure.  This will be used to restore
  45                                the settings of this register in PpiDisableTcoReset.
  46 **/
  47 typedef
  48 EFI_STATUS
  49 (EFIAPI *EFI_TCO_RESET_PROTOCOL_ENABLE_TCO_RESET) (
  50   IN      UINT32            *RcrbGcsSaveValue
  51   );
  52
  53 /**
  54   Disables the TCO timer.  This is used after writing the clock registers.
  55
  56   @param[in] RcrbGcsRestoreValue  Value saved in PpiEnableTcoReset so that it can
  57                                   restored.
  58 **/
  59 typedef
  60 EFI_STATUS
  61 (EFIAPI *EFI_TCO_RESET_PROTOCOL_DISABLE_TCO_RESET) (
  62   OUT     UINT32    RcrbGcsRestoreValue
  63   );
  64
  65 typedef struct _EFI_TCO_RESET_PROTOCOL {
  66   EFI_TCO_RESET_PROTOCOL_ENABLE_TCO_RESET       EnableTcoReset;
  67   EFI_TCO_RESET_PROTOCOL_DISABLE_TCO_RESET      DisableTcoReset;
  68 } EFI_TCO_RESET_PROTOCOL;
  69
  70 extern EFI_GUID gEfiTcoResetProtocolGuid;
  71
  72 #endif