1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
/** @file
Watchdog Timer protocol
Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#ifndef _DXE_WDT_H_
#define _DXE_WDT_H_
//
// Extern the GUID for protocol users.
//
extern EFI_GUID gWdtProtocolGuid;
//
// Forward reference for ANSI C compatibility
//
typedef struct _WDT_PROTOCOL WDT_PROTOCOL;
/**
Reloads WDT with new timeout value and starts it. Also sets Unexpected Reset bit, which
causes the next reset to be treated as watchdog expiration - unless AllowKnownReset()
function was called too.
@param[in] TimeoutValue Time in seconds before WDT times out. Supported range = 1 - 1024.
@retval EFI_SUCCESS if everything's OK
@retval EFI_INVALID_PARAMETER if TimeoutValue parameter is wrong
**/
typedef
EFI_STATUS
(EFIAPI *WDT_RELOAD_AND_START) (
UINT32 TimeoutValue
);
/**
Returns WDT failure status.
@retval V_PCH_OC_WDT_CTL_STATUS_FAILURE If there was WDT expiration or unexpected reset
@retval V_PCH_OC_WDT_CTL_STATUS_OK Otherwise
**/
typedef
UINT8
(EFIAPI *WDT_CHECK_STATUS) (
VOID
);
/**
Returns information if WDT coverage for the duration of BIOS execution
was requested by an OS application.
@retval TRUE if WDT was requested
@retval FALSE if WDT was not requested
**/
typedef
UINT8
(EFIAPI *IS_WDT_REQUIRED) (
VOID
);
/**
Returns WDT enabled/disabled status.
@retval TRUE if WDT is enabled
@retval FALSE if WDT is disabled
**/
typedef
UINT8
(EFIAPI *IS_WDT_ENABLED) (
VOID
);
/**
Disables WDT timer.
**/
typedef
VOID
(EFIAPI *WDT_DISABLE) (
VOID
);
/**
Normally, each reboot performed while watchdog runs is considered a failure.
This function allows platform to perform expected reboots with WDT running,
without being interpreted as failures.
In DXE phase, it is enough to call this function any time before reset.
In PEI phase, between calling this function and performing reset, ReloadAndStart()
must not be called.
**/
typedef
VOID
(EFIAPI *WDT_ALLOW_KNOWN_RESET) (
VOID
);
/**
These protocols and PPI allow a platform module to perform watch dog timer operations
through the Intel PCH LPC Host Controller Interface. The WDT protocol and WDT PPI
implement the Intel (R) Watch Dog timer for DXE, and PEI environments, respectively.
WDT_PROTOCOL referenced hereafter represents both WDT_PROTOCOL and WDT_PPI, as they
share the identical data structure.
**/
struct _WDT_PROTOCOL {
WDT_RELOAD_AND_START ReloadAndStart; ///< Reloads WDT with new timeout value and starts it.
WDT_CHECK_STATUS CheckStatus; ///< Returns WDT failure status.
WDT_DISABLE Disable; ///< Disables WDT timer.
WDT_ALLOW_KNOWN_RESET AllowKnownReset; ///< Perform expected reboots with WDT running, without being interpreted as failures.
IS_WDT_REQUIRED IsWdtRequired; ///< Returns information if WDT coverage for the duration of BIOS execution was requested by an OS application.
IS_WDT_ENABLED IsWdtEnabled; ///< Returns WDT enabled/disabled status.
};
#endif
|
