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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
|
/** @file
Provides platform policy services used during a capsule update.
Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#ifndef __CAPSULE_UPDATE_POLICY_H__
#define __CAPSULE_UPDATE_POLICY_H__
#define EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL_GUID \
{ \
0x487784c5, 0x6299, 0x4ba6, { 0xb0, 0x96, 0x5c, 0xc5, 0x27, 0x7c, 0xf7, 0x57 } \
}
typedef struct _EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL;
/**
Determine if the system power state supports a capsule update.
@param[in] This A pointer to the EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL instance.
@param[out] Good Returns TRUE if system power state supports a capsule
update. Returns FALSE if system power state does not
support a capsule update. Return value is only valid if
return status is EFI_SUCCESS.
@retval EFI_SUCCESS Good parameter has been updated with result.
@retval EFI_INVALID_PARAMETER Good is NULL.
@retval EFI_DEVICE_ERROR System power state can not be determined.
**/
typedef
EFI_STATUS
(EFIAPI * EDKII_CAPSULE_UPDATE_POLICY_CHECK_SYSTEM_POWER) (
IN EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL *This,
OUT BOOLEAN *Good
);
/**
Determines if the system thermal state supports a capsule update.
@param[in] This A pointer to the EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL instance.
@param[out] Good Returns TRUE if system thermal state supports a capsule
update. Returns FALSE if system thermal state does not
support a capsule update. Return value is only valid if
return status is EFI_SUCCESS.
@retval EFI_SUCCESS Good parameter has been updated with result.
@retval EFI_INVALID_PARAMETER Good is NULL.
@retval EFI_DEVICE_ERROR System thermal state can not be determined.
**/
typedef
EFI_STATUS
(EFIAPI * EDKII_CAPSULE_UPDATE_POLICY_CHECK_SYSTEM_THERMAL) (
IN EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL *This,
OUT BOOLEAN *Good
);
/**
Determines if the system environment state supports a capsule update.
@param[in] This A pointer to the EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL instance.
@param[out] Good Returns TRUE if system environment state supports a capsule
update. Returns FALSE if system environment state does not
support a capsule update. Return value is only valid if
return status is EFI_SUCCESS.
@retval EFI_SUCCESS Good parameter has been updated with result.
@retval EFI_INVALID_PARAMETER Good is NULL.
@retval EFI_DEVICE_ERROR System environment state can not be determined.
**/
typedef
EFI_STATUS
(EFIAPI * EDKII_CAPSULE_UPDATE_POLICY_CHECK_SYSTEM_ENVIRONMENT) (
IN EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL *This,
OUT BOOLEAN *Good
);
/**
Determines if the Lowest Supported Version checks should be performed. The
expected result from this function is TRUE. A platform can choose to return
FALSE (e.g. during manufacturing or servicing) to allow a capsule update to a
version below the current Lowest Supported Version.
@param[in] This A pointer to the EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL instance.
@retval TRUE The lowest supported version check is required.
@retval FALSE Do not perform lowest support version check.
**/
typedef
BOOLEAN
(EFIAPI * EDKII_CAPSULE_UPDATE_POLICY_IS_LOWEST_SUPPORTED_VERSION_CHECK_REQUIRED) (
IN EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL *This
);
/**
Determines if the FMP device should be locked when the event specified by
PcdFmpDeviceLockEventGuid is signaled. The expected result from this function
is TRUE so the FMP device is always locked. A platform can choose to return
FALSE (e.g. during manufacturing) to allow FMP devices to remain unlocked.
@param[in] This A pointer to the EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL instance.
@retval TRUE The FMP device lock action is required at lock event guid.
@retval FALSE Do not perform FMP device lock at lock event guid.
**/
typedef
BOOLEAN
(EFIAPI * EDKII_CAPSULE_UPDATE_POLICY_IS_FMP_DEVICE_AT_LOCK_EVENT_REQUIRED) (
IN EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL *This
);
///
/// This protocol provides platform policy services used during a capsule update.
///
struct _EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL {
EDKII_CAPSULE_UPDATE_POLICY_CHECK_SYSTEM_POWER CheckSystemPower;
EDKII_CAPSULE_UPDATE_POLICY_CHECK_SYSTEM_THERMAL CheckSystemThermal;
EDKII_CAPSULE_UPDATE_POLICY_CHECK_SYSTEM_ENVIRONMENT CheckSystemEnvironment;
EDKII_CAPSULE_UPDATE_POLICY_IS_LOWEST_SUPPORTED_VERSION_CHECK_REQUIRED IsLowestSupportedVersionCheckRequired;
EDKII_CAPSULE_UPDATE_POLICY_IS_FMP_DEVICE_AT_LOCK_EVENT_REQUIRED IsLockFmpDeviceAtLockEventGuidRequired;
};
extern EFI_GUID gEdkiiCapsuleUpdatePolicyProtocolGuid;
#endif
|
