]>
Commit | Line | Data |
---|---|---|
c40f7cc7 EJ |
1 | /** @file\r |
2 | Provides platform policy services used during a capsule update that uses the\r | |
3 | services of the EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL.\r | |
4 | \r | |
5 | Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>\r | |
6 | \r | |
7 | SPDX-License-Identifier: BSD-2-Clause-Patent\r | |
8 | \r | |
9 | **/\r | |
10 | \r | |
11 | #ifndef __CAPSULE_UPDATE_POLICY_DXE_H__\r | |
12 | #define __CAPSULE_UPDATE_POLICY_DXE_H__\r | |
13 | \r | |
14 | #include <PiDxe.h>\r | |
15 | \r | |
16 | #include <Protocol/CapsuleUpdatePolicy.h>\r | |
17 | \r | |
18 | #include <Library/BaseLib.h>\r | |
19 | #include <Library/DebugLib.h>\r | |
20 | #include <Library/UefiBootServicesTableLib.h>\r | |
21 | #include <Library/CapsuleUpdatePolicyLib.h>\r | |
22 | \r | |
23 | /**\r | |
24 | Determine if the system power state supports a capsule update.\r | |
25 | \r | |
26 | @param[in] This A pointer to the EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL instance.\r | |
27 | @param[out] Good Returns TRUE if system power state supports a capsule\r | |
28 | update. Returns FALSE if system power state does not\r | |
29 | support a capsule update. Return value is only valid if\r | |
30 | return status is EFI_SUCCESS.\r | |
31 | \r | |
32 | @retval EFI_SUCCESS Good parameter has been updated with result.\r | |
33 | @retval EFI_INVALID_PARAMETER Good is NULL.\r | |
34 | @retval EFI_DEVICE_ERROR System power state can not be determined.\r | |
35 | \r | |
36 | **/\r | |
37 | EFI_STATUS\r | |
38 | EFIAPI\r | |
39 | CapsuleUpdatePolicyCheckSystemPower (\r | |
40 | IN EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL *This,\r | |
41 | OUT BOOLEAN *Good\r | |
42 | );\r | |
43 | \r | |
44 | /**\r | |
45 | Determines if the system thermal state supports a capsule update.\r | |
46 | \r | |
47 | @param[in] This A pointer to the EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL instance.\r | |
48 | @param[out] Good Returns TRUE if system thermal state supports a capsule\r | |
49 | update. Returns FALSE if system thermal state does not\r | |
50 | support a capsule update. Return value is only valid if\r | |
51 | return status is EFI_SUCCESS.\r | |
52 | \r | |
53 | @retval EFI_SUCCESS Good parameter has been updated with result.\r | |
54 | @retval EFI_INVALID_PARAMETER Good is NULL.\r | |
55 | @retval EFI_DEVICE_ERROR System thermal state can not be determined.\r | |
56 | \r | |
57 | **/\r | |
58 | EFI_STATUS\r | |
59 | EFIAPI\r | |
60 | CapsuleUpdatePolicyCheckSystemThermal (\r | |
61 | IN EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL *This,\r | |
62 | OUT BOOLEAN *Good\r | |
63 | );\r | |
64 | \r | |
65 | /**\r | |
66 | Determines if the system environment state supports a capsule update.\r | |
67 | \r | |
68 | @param[in] This A pointer to the EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL instance.\r | |
69 | @param[out] Good Returns TRUE if system environment state supports a capsule\r | |
70 | update. Returns FALSE if system environment state does not\r | |
71 | support a capsule update. Return value is only valid if\r | |
72 | return status is EFI_SUCCESS.\r | |
73 | \r | |
74 | @retval EFI_SUCCESS Good parameter has been updated with result.\r | |
75 | @retval EFI_INVALID_PARAMETER Good is NULL.\r | |
76 | @retval EFI_DEVICE_ERROR System environment state can not be determined.\r | |
77 | \r | |
78 | **/\r | |
79 | EFI_STATUS\r | |
80 | EFIAPI\r | |
81 | CapsuleUpdatePolicyCheckSystemEnvironment (\r | |
82 | IN EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL *This,\r | |
83 | OUT BOOLEAN *Good\r | |
84 | );\r | |
85 | \r | |
86 | /**\r | |
87 | Determines if the Lowest Supported Version checks should be performed. The\r | |
88 | expected result from this function is TRUE. A platform can choose to return\r | |
89 | FALSE (e.g. during manufacturing or servicing) to allow a capsule update to a\r | |
90 | version below the current Lowest Supported Version.\r | |
91 | \r | |
92 | @param[in] This A pointer to the EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL instance.\r | |
93 | \r | |
94 | @retval TRUE The lowest supported version check is required.\r | |
95 | @retval FALSE Do not perform lowest support version check.\r | |
96 | \r | |
97 | **/\r | |
98 | BOOLEAN\r | |
99 | EFIAPI\r | |
100 | CapsuleUpdatePolicyIsLowestSupportedVersionCheckRequired (\r | |
101 | IN EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL *This\r | |
102 | );\r | |
103 | \r | |
104 | /**\r | |
105 | Determines if the FMP device should be locked when the event specified by\r | |
106 | PcdFmpDeviceLockEventGuid is signaled. The expected result from this function\r | |
107 | is TRUE so the FMP device is always locked. A platform can choose to return\r | |
108 | FALSE (e.g. during manufacturing) to allow FMP devices to remain unlocked.\r | |
109 | \r | |
110 | @param[in] This A pointer to the EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL instance.\r | |
111 | \r | |
112 | @retval TRUE The FMP device lock action is required at lock event guid.\r | |
113 | @retval FALSE Do not perform FMP device lock at lock event guid.\r | |
114 | \r | |
115 | **/\r | |
116 | BOOLEAN\r | |
117 | EFIAPI\r | |
118 | CapsuleUpdatePolicyIsLockFmpDeviceAtLockEventGuidRequired (\r | |
119 | IN EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL *This\r | |
120 | );\r | |
121 | \r | |
122 | /**\r | |
123 | The user Entry Point for module CapsuleUpdatePolicyDxe. The user code starts\r | |
124 | with this function.\r | |
125 | \r | |
126 | @param[in] ImageHandle The firmware allocated handle for the EFI image.\r | |
127 | @param[in] SystemTable A pointer to the EFI System Table.\r | |
128 | \r | |
129 | @retval EFI_SUCCESS The entry point is executed successfully.\r | |
130 | @retval other Some error occurs when executing this entry point.\r | |
131 | \r | |
132 | **/\r | |
133 | EFI_STATUS\r | |
134 | EFIAPI\r | |
135 | CapsuleUpdatePolicyInitialize (\r | |
136 | IN EFI_HANDLE ImageHandle,\r | |
137 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
138 | );\r | |
139 | \r | |
140 | #endif\r |