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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
|
/** @file
UEFI variable support functions for Firmware Management Protocol based
firmware updates.
Copyright (c) 2016, Microsoft Corporation. All rights reserved.<BR>
Copyright (c) 2018 - 2019, Intel Corporation. All rights reserved.<BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#ifndef __VARIABLE_SUPPORT_H__
#define __VARIABLE_SUPPORT_H__
///
/// Default values for FMP Controller State information
///
#define DEFAULT_VERSION 0x1
#define DEFAULT_LOWESTSUPPORTEDVERSION 0x0
#define DEFAULT_LASTATTEMPTSTATUS 0x0
#define DEFAULT_LASTATTEMPTVERSION 0x0
///
/// Base UEFI Variable names for FMP Controller State information stored in
/// separate variables.
///
#define VARNAME_VERSION L"FmpVersion"
#define VARNAME_LSV L"FmpLsv"
#define VARNAME_LASTATTEMPTSTATUS L"LastAttemptStatus"
#define VARNAME_LASTATTEMPTVERSION L"LastAttemptVersion"
///
/// Base UEFI Variable name for FMP Controller State information stored in a
/// merged UEFI Variable. If the separate UEFI Variables above are detected,
/// then they are merged into a single variable and the separate variables are
/// deleted.
///
#define VARNAME_FMPSTATE L"FmpState"
///
/// FMP Controller State structure that is used to store the state of
/// a controller in one combined UEFI Variable.
///
typedef struct {
BOOLEAN VersionValid;
BOOLEAN LsvValid;
BOOLEAN LastAttemptStatusValid;
BOOLEAN LastAttemptVersionValid;
UINT32 Version;
UINT32 Lsv;
UINT32 LastAttemptStatus;
UINT32 LastAttemptVersion;
} FMP_CONTROLLER_STATE;
/**
Generate the names of the UEFI Variables used to store state information for
a managed controller. The UEFI Variables names are a combination of a base
name and an optional hardware instance value as a 16 character hex value. If
the hardware instance value is 0, then the 16 character hex value is not
included. These storage for the UEFI Variable names are allocated using the
UEFI Boot Service AllocatePool() and the pointers are stored in the Private.
The following are examples of variable names produces for hardware instance
value 0 and value 0x1234567812345678.
FmpVersion
FmpLsv
LastAttemptStatus
LastAttemptVersion
FmpDxe
FmpVersion1234567812345678
FmpLsv1234567812345678
LastAttemptStatus1234567812345678
LastAttemptVersion1234567812345678
FmpDxe1234567812345678
@param[in,out] Private Private context structure for the managed controller.
**/
VOID
GenerateFmpVariableNames (
IN OUT FIRMWARE_MANAGEMENT_PRIVATE_DATA *Private
);
/**
Returns the value used to fill in the Version field of the
EFI_FIRMWARE_IMAGE_DESCRIPTOR structure that is returned by the GetImageInfo()
service of the Firmware Management Protocol. The value is read from a UEFI
variable. If the UEFI variables does not exist, then a default version value
is returned.
UEFI Variable accessed: GUID = gEfiCallerIdGuid, Name = L"FmpDxe"
@param[in] Private Private context structure for the managed controller.
@return The version of the firmware image in the firmware device.
**/
UINT32
GetVersionFromVariable (
IN FIRMWARE_MANAGEMENT_PRIVATE_DATA *Private
);
/**
Returns the value used to fill in the LowestSupportedVersion field of the
EFI_FIRMWARE_IMAGE_DESCRIPTOR structure that is returned by the GetImageInfo()
service of the Firmware Management Protocol. The value is read from a UEFI
variable. If the UEFI variables does not exist, then a default lowest
supported version value is returned.
UEFI Variable accessed: GUID = gEfiCallerIdGuid, Name = L"FmpDxe"
@param[in] Private Private context structure for the managed controller.
@return The lowest supported version of the firmware image in the firmware
device.
**/
UINT32
GetLowestSupportedVersionFromVariable (
IN FIRMWARE_MANAGEMENT_PRIVATE_DATA *Private
);
/**
Returns the value used to fill in the LastAttemptStatus field of the
EFI_FIRMWARE_IMAGE_DESCRIPTOR structure that is returned by the GetImageInfo()
service of the Firmware Management Protocol. The value is read from a UEFI
variable. If the UEFI variables does not exist, then a default last attempt
status value is returned.
UEFI Variable accessed: GUID = gEfiCallerIdGuid, Name = L"FmpDxe"
@param[in] Private Private context structure for the managed controller.
@return The last attempt status value for the most recent capsule update.
**/
UINT32
GetLastAttemptStatusFromVariable (
IN FIRMWARE_MANAGEMENT_PRIVATE_DATA *Private
);
/**
Returns the value used to fill in the LastAttemptVersion field of the
EFI_FIRMWARE_IMAGE_DESCRIPTOR structure that is returned by the GetImageInfo()
service of the Firmware Management Protocol. The value is read from a UEFI
variable. If the UEFI variables does not exist, then a default last attempt
version value is returned.
UEFI Variable accessed: GUID = gEfiCallerIdGuid, Name = L"FmpDxe"
@param[in] Private Private context structure for the managed controller.
@return The last attempt version value for the most recent capsule update.
**/
UINT32
GetLastAttemptVersionFromVariable (
IN FIRMWARE_MANAGEMENT_PRIVATE_DATA *Private
);
/**
Saves the version current of the firmware image in the firmware device to a
UEFI variable.
UEFI Variable accessed: GUID = gEfiCallerIdGuid, Name = L"FmpDxe"
@param[in] Private Private context structure for the managed controller.
@param[in] Version The version of the firmware image in the firmware device.
**/
VOID
SetVersionInVariable (
IN FIRMWARE_MANAGEMENT_PRIVATE_DATA *Private,
IN UINT32 Version
);
/**
Saves the lowest supported version current of the firmware image in the
firmware device to a UEFI variable.
UEFI Variable accessed: GUID = gEfiCallerIdGuid, Name = L"FmpDxe"
@param[in] Private Private context structure for the managed
controller.
@param[in] LowestSupportedVersion The lowest supported version of the
firmware image in the firmware device.
**/
VOID
SetLowestSupportedVersionInVariable (
IN FIRMWARE_MANAGEMENT_PRIVATE_DATA *Private,
IN UINT32 LowestSupportedVersion
);
/**
Saves the last attempt status value of the most recent FMP capsule update to a
UEFI variable.
UEFI Variable accessed: GUID = gEfiCallerIdGuid, Name = L"FmpDxe"
@param[in] Private Private context structure for the managed
controller.
@param[in] LastAttemptStatus The last attempt status of the most recent FMP
capsule update.
**/
VOID
SetLastAttemptStatusInVariable (
IN FIRMWARE_MANAGEMENT_PRIVATE_DATA *Private,
IN UINT32 LastAttemptStatus
);
/**
Saves the last attempt version value of the most recent FMP capsule update to
a UEFI variable.
UEFI Variable accessed: GUID = gEfiCallerIdGuid, Name = L"FmpDxe"
@param[in] Private Private context structure for the managed
controller.
@param[in] LastAttemptVersion The last attempt version value of the most
recent FMP capsule update.
**/
VOID
SetLastAttemptVersionInVariable (
IN FIRMWARE_MANAGEMENT_PRIVATE_DATA *Private,
IN UINT32 LastAttemptVersion
);
/**
Locks all the UEFI Variables that use gEfiCallerIdGuid of the currently
executing module.
@param[in] Private Private context structure for the managed controller.
@retval EFI_SUCCESS All UEFI variables are locked.
@retval EFI_UNSUPPORTED Variable Lock Protocol not found.
@retval Other One of the UEFI variables could not be locked.
**/
EFI_STATUS
LockAllFmpVariables (
IN FIRMWARE_MANAGEMENT_PRIVATE_DATA *Private
);
#endif
|
