]>
Commit | Line | Data |
---|---|---|
a6d73269 | 1 | /** @file\r |
cec7b8fb KM |
2 | Provides platform policy services used during a capsule update.\r |
3 | \r | |
4 | Copyright (c) 2016, Microsoft Corporation. All rights reserved.<BR>\r | |
5 | Copyright (c) 2018, Intel Corporation. All rights reserved.<BR>\r | |
6 | \r | |
bcef758c | 7 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
cec7b8fb KM |
8 | \r |
9 | **/\r | |
10 | \r | |
11 | #ifndef __CAPSULE_UPDATE_POLICY_LIB__\r | |
12 | #define __CAPSULE_UPDATE_POLICY_LIB__\r | |
13 | \r | |
14 | /**\r | |
15 | Determine if the system power state supports a capsule update.\r | |
16 | \r | |
17 | @param[out] Good Returns TRUE if system power state supports a capsule\r | |
18 | update. Returns FALSE if system power state does not\r | |
19 | support a capsule update. Return value is only valid if\r | |
20 | return status is EFI_SUCCESS.\r | |
21 | \r | |
22 | @retval EFI_SUCCESS Good parameter has been updated with result.\r | |
23 | @retval EFI_INVALID_PARAMETER Good is NULL.\r | |
24 | @retval EFI_DEVICE_ERROR System power state can not be determined.\r | |
25 | \r | |
26 | **/\r | |
27 | EFI_STATUS\r | |
28 | EFIAPI\r | |
29 | CheckSystemPower (\r | |
30 | OUT BOOLEAN *Good\r | |
31 | );\r | |
32 | \r | |
33 | /**\r | |
34 | Determines if the system thermal state supports a capsule update.\r | |
35 | \r | |
36 | @param[out] Good Returns TRUE if system thermal state supports a capsule\r | |
37 | update. Returns FALSE if system thermal state does not\r | |
38 | support a capsule update. Return value is only valid if\r | |
39 | return status is EFI_SUCCESS.\r | |
40 | \r | |
41 | @retval EFI_SUCCESS Good parameter has been updated with result.\r | |
42 | @retval EFI_INVALID_PARAMETER Good is NULL.\r | |
43 | @retval EFI_DEVICE_ERROR System thermal state can not be determined.\r | |
44 | \r | |
45 | **/\r | |
46 | EFI_STATUS\r | |
47 | EFIAPI\r | |
48 | CheckSystemThermal (\r | |
45ce0a67 | 49 | OUT BOOLEAN *Good\r |
cec7b8fb KM |
50 | );\r |
51 | \r | |
52 | /**\r | |
53 | Determines if the system environment state supports a capsule update.\r | |
54 | \r | |
55 | @param[out] Good Returns TRUE if system environment state supports a capsule\r | |
56 | update. Returns FALSE if system environment state does not\r | |
57 | support a capsule update. Return value is only valid if\r | |
58 | return status is EFI_SUCCESS.\r | |
59 | \r | |
60 | @retval EFI_SUCCESS Good parameter has been updated with result.\r | |
61 | @retval EFI_INVALID_PARAMETER Good is NULL.\r | |
62 | @retval EFI_DEVICE_ERROR System environment state can not be determined.\r | |
63 | \r | |
64 | **/\r | |
65 | EFI_STATUS\r | |
66 | EFIAPI\r | |
67 | CheckSystemEnvironment (\r | |
45ce0a67 | 68 | OUT BOOLEAN *Good\r |
cec7b8fb KM |
69 | );\r |
70 | \r | |
71 | /**\r | |
72 | Determines if the Lowest Supported Version checks should be performed. The\r | |
73 | expected result from this function is TRUE. A platform can choose to return\r | |
74 | FALSE (e.g. during manufacturing or servicing) to allow a capsule update to a\r | |
75 | version below the current Lowest Supported Version.\r | |
76 | \r | |
77 | @retval TRUE The lowest supported version check is required.\r | |
78 | @retval FALSE Do not perform lowest support version check.\r | |
79 | \r | |
80 | **/\r | |
81 | BOOLEAN\r | |
82 | EFIAPI\r | |
83 | IsLowestSupportedVersionCheckRequired (\r | |
84 | VOID\r | |
85 | );\r | |
86 | \r | |
87 | /**\r | |
88 | Determines if the FMP device should be locked when the event specified by\r | |
89 | PcdFmpDeviceLockEventGuid is signaled. The expected result from this function\r | |
90 | is TRUE so the FMP device is always locked. A platform can choose to return\r | |
91 | FALSE (e.g. during manufacturing) to allow FMP devices to remain unlocked.\r | |
92 | \r | |
93 | @retval TRUE The FMP device lock action is required at lock event guid.\r | |
94 | @retval FALSE Do not perform FMP device lock at lock event guid.\r | |
95 | \r | |
96 | **/\r | |
97 | BOOLEAN\r | |
98 | EFIAPI\r | |
99 | IsLockFmpDeviceAtLockEventGuidRequired (\r | |
100 | VOID\r | |
101 | );\r | |
102 | \r | |
103 | #endif\r |