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