]>
Commit | Line | Data |
---|---|---|
252b9c7a | 1 | /** @file\r |
2 | UEFI Firmware Management Protocol definition\r | |
3 | Firmware Management Protocol provides an abstraction for device to provide firmware \r | |
4 | management support. The base requirements for managing device firmware images include \r | |
5 | identifying firmware image revision level and programming the image into the device.\r | |
6 | \r | |
7 | GetImageInfo() is the only required function. GetImage(), SetImage(), \r | |
8 | CheckImage(), GetPackageInfo(), and SetPackageInfo() shall return \r | |
9 | EFI_UNSUPPORTED if not supported by the driver.\r | |
10 | \r | |
7076ecdb | 11 | Copyright (c) 2009 - 2013, Intel Corporation. All rights reserved.<BR>\r |
9df063a0 | 12 | This program and the accompanying materials \r |
252b9c7a | 13 | are licensed and made available under the terms and conditions of the BSD License \r |
14 | which accompanies this distribution. The full text of the license may be found at \r | |
15 | http://opensource.org/licenses/bsd-license.php \r | |
16 | \r | |
17 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
18 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
19 | \r | |
20 | @par Revision Reference: \r | |
21 | This Protocol is introduced in UEFI Specification 2.3 \r | |
22 | \r | |
23 | **/\r | |
24 | \r | |
25 | #ifndef __EFI_FIRMWARE_MANAGEMENT_PROTOCOL_H__\r | |
26 | #define __EFI_FIRMWARE_MANAGEMENT_PROTOCOL_H__\r | |
27 | \r | |
28 | \r | |
29 | #define EFI_FIRMWARE_MANAGEMENT_PROTOCOL_GUID \\r | |
30 | { \\r | |
31 | 0x86c77a67, 0xb97, 0x4633, {0xa1, 0x87, 0x49, 0x10, 0x4d, 0x6, 0x85, 0xc7 } \\r | |
32 | }\r | |
33 | \r | |
34 | typedef struct _EFI_FIRMWARE_MANAGEMENT_PROTOCOL EFI_FIRMWARE_MANAGEMENT_PROTOCOL;\r | |
35 | \r | |
36 | ///\r | |
37 | /// EFI_FIRMWARE_IMAGE_DESCRIPTOR\r | |
38 | ///\r | |
39 | typedef struct {\r | |
40 | /// \r | |
41 | /// A unique number identifying the firmware image within the device. The number is \r | |
42 | /// between 1 and DescriptorCount.\r | |
43 | /// \r | |
44 | UINT8 ImageIndex;\r | |
45 | ///\r | |
46 | /// A unique number identifying the firmware image type. \r | |
47 | /// \r | |
48 | EFI_GUID ImageTypeId;\r | |
49 | /// \r | |
50 | /// A unique number identifying the firmware image. \r | |
51 | /// \r | |
52 | UINT64 ImageId;\r | |
53 | /// \r | |
4f077902 | 54 | /// A pointer to a null-terminated string representing the firmware image name. \r |
252b9c7a | 55 | /// \r |
56 | CHAR16 *ImageIdName;\r | |
57 | /// \r | |
58 | /// Identifies the version of the device firmware. The format is vendor specific and new \r | |
59 | /// version must have a greater value than an old version.\r | |
60 | /// \r | |
61 | UINT32 Version;\r | |
62 | /// \r | |
4f077902 | 63 | /// A pointer to a null-terminated string representing the firmware image version name.\r |
252b9c7a | 64 | /// \r |
65 | CHAR16 *VersionName;\r | |
66 | /// \r | |
67 | /// Size of the image in bytes. If size=0, then only ImageIndex and ImageTypeId are valid.\r | |
68 | /// \r | |
69 | UINTN Size;\r | |
70 | /// \r | |
71 | /// Image attributes that are supported by this device. See 'Image Attribute Definitions' \r | |
72 | /// for possible returned values of this parameter. A value of 1 indicates the attribute is \r | |
73 | /// supported and the current setting value is indicated in AttributesSetting. A \r | |
74 | /// value of 0 indicates the attribute is not supported and the current setting value in \r | |
75 | /// AttributesSetting is meaningless.\r | |
76 | /// \r | |
77 | UINT64 AttributesSupported;\r | |
78 | /// \r | |
79 | /// Image attributes. See 'Image Attribute Definitions' for possible returned values of \r | |
80 | /// this parameter.\r | |
81 | /// \r | |
82 | UINT64 AttributesSetting;\r | |
83 | /// \r | |
84 | /// Image compatibilities. See 'Image Compatibility Definitions' for possible returned \r | |
85 | /// values of this parameter.\r | |
86 | /// \r | |
87 | UINT64 Compatibilities;\r | |
7076ecdb SQ |
88 | ///\r |
89 | /// Describes the lowest ImageDescriptor version that the device will accept. Only\r | |
90 | /// present in version 2 or higher.\r | |
91 | ///\r | |
92 | UINT32 LowestSupportedImageVersion;\r | |
252b9c7a | 93 | } EFI_FIRMWARE_IMAGE_DESCRIPTOR;\r |
94 | \r | |
95 | \r | |
96 | //\r | |
97 | // Image Attribute Definitions\r | |
98 | //\r | |
99 | ///\r | |
100 | /// The attribute IMAGE_ATTRIBUTE_IMAGE_UPDATABLE indicates this device supports firmware \r | |
101 | /// image update.\r | |
102 | ///\r | |
103 | #define IMAGE_ATTRIBUTE_IMAGE_UPDATABLE 0x0000000000000001\r | |
104 | ///\r | |
105 | /// The attribute IMAGE_ATTRIBUTE_RESET_REQUIRED indicates a reset of the device is required \r | |
106 | /// for the new firmware image to take effect after a firmware update. The device is the device hosting \r | |
107 | /// the firmware image.\r | |
108 | /// \r | |
109 | #define IMAGE_ATTRIBUTE_RESET_REQUIRED 0x0000000000000002\r | |
110 | ///\r | |
111 | /// The attribute IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED indicates authentication is \r | |
112 | /// required to perform the following image operations: GetImage(), SetImage(), and \r | |
113 | /// CheckImage(). See 'Image Attribute - Authentication'.\r | |
114 | /// \r | |
115 | #define IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED 0x0000000000000004\r | |
116 | ///\r | |
117 | /// The attribute IMAGE_ATTRIBUTE_IN_USE indicates the current state of the firmware image. \r | |
118 | /// This distinguishes firmware images in a device that supports redundant images. \r | |
119 | /// \r | |
120 | #define IMAGE_ATTRIBUTE_IN_USE 0x0000000000000008\r | |
121 | \r | |
122 | \r | |
123 | //\r | |
124 | // Image Compatibility Definitions\r | |
125 | //\r | |
126 | /// Values from 0x0000000000000002 thru 0x000000000000FFFF are reserved for future assignments.\r | |
127 | /// Values from 0x0000000000010000 thru 0xFFFFFFFFFFFFFFFF are used by firmware vendor for \r | |
128 | /// compatibility check.\r | |
129 | ///\r | |
130 | #define IMAGE_COMPATIBILITY_CHECK_SUPPORTED 0x0000000000000001\r | |
131 | \r | |
132 | ///\r | |
133 | /// Descriptor Version\r | |
134 | ///\r | |
7076ecdb | 135 | #define EFI_FIRMWARE_IMAGE_DESCRIPTOR_VERSION 2\r |
252b9c7a | 136 | \r |
137 | \r | |
138 | ///\r | |
fa3e7746 | 139 | /// Image Attribute -Authentication Required\r |
252b9c7a | 140 | ///\r |
141 | typedef struct {\r | |
142 | ///\r | |
143 | /// It is included in the signature of AuthInfo. It is used to ensure freshness/no replay. \r | |
144 | /// It is incremented during each firmware image operation. \r | |
145 | /// \r | |
146 | UINT64 MonotonicCount;\r | |
147 | ///\r | |
148 | /// Provides the authorization for the firmware image operations. It is a signature across \r | |
149 | /// the image data and the Monotonic Count value. Caller uses the private key that is \r | |
150 | /// associated with a public key that has been provisioned via the key exchange. \r | |
151 | ///\r | |
152 | WIN_CERTIFICATE_UEFI_GUID AuthInfo;\r | |
153 | } EFI_FIRMWARE_IMAGE_AUTHENTICATION;\r | |
154 | \r | |
155 | \r | |
156 | //\r | |
157 | // ImageUpdatable Definitions\r | |
158 | //\r | |
159 | ///\r | |
160 | /// IMAGE_UPDATABLE_VALID indicates SetImage() will accept the new image and update the \r | |
161 | /// device with the new image.\r | |
162 | ///\r | |
163 | #define IMAGE_UPDATABLE_VALID 0x0000000000000001\r | |
164 | ///\r | |
165 | /// IMAGE_UPDATABLE_INVALID indicates SetImage() will reject the new image. No additional \r | |
166 | /// information is provided for the rejection.\r | |
167 | ///\r | |
168 | #define IMAGE_UPDATABLE_INVALID 0x0000000000000002\r | |
169 | ///\r | |
170 | /// IMAGE_UPDATABLE_INVALID_TYPE indicates SetImage() will reject the new image. The \r | |
171 | /// rejection is due to the new image is not a firmware image recognized for this device.\r | |
172 | ///\r | |
173 | #define IMAGE_UPDATABLE_INVALID_TYPE 0x0000000000000004\r | |
174 | ///\r | |
175 | /// IMAGE_UPDATABLE_INVALID_OLD indicates SetImage() will reject the new image. The \r | |
176 | /// rejection is due to the new image version is older than the current firmware image\r | |
177 | /// version in the device. The device firmware update policy does not support firmware \r | |
178 | /// version downgrade.\r | |
179 | ///\r | |
180 | #define IMAGE_UPDATABLE_INVALID_OLD 0x0000000000000008\r | |
181 | \r | |
182 | \r | |
183 | //\r | |
184 | // Package Attribute Definitions\r | |
185 | //\r | |
186 | ///\r | |
187 | /// The attribute PACKAGE_ATTRIBUTE_VERSION_UPDATABLE indicates this device supports the \r | |
188 | /// update of the firmware package version.\r | |
189 | ///\r | |
190 | #define PACKAGE_ATTRIBUTE_VERSION_UPDATABLE 0x0000000000000001\r | |
191 | ///\r | |
192 | /// The attribute PACKAGE_ATTRIBUTE_RESET_REQUIRED indicates a reset of the device is \r | |
193 | /// required for the new package info to take effect after an update.\r | |
194 | ///\r | |
195 | #define PACKAGE_ATTRIBUTE_RESET_REQUIRED 0x0000000000000002\r | |
196 | ///\r | |
197 | /// The attribute PACKAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED indicates authentication \r | |
198 | /// is required to update the package info.\r | |
199 | ///\r | |
200 | #define PACKAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED 0x0000000000000004\r | |
201 | \r | |
202 | /** \r | |
203 | Callback funtion to report the process of the firmware updating.\r | |
204 | \r | |
205 | @param[in] Completion A value between 1 and 100 indicating the current completion\r | |
206 | progress of the firmware update. Completion progress is \r | |
207 | reported as from 1 to 100 percent. A value of 0 is used by\r | |
208 | the driver to indicate that progress reporting is not supported.\r | |
209 | \r | |
210 | @retval EFI_SUCCESS SetImage() continues to do the callback if supported.\r | |
211 | @retval other SetImage() discontinues the callback and completes\r | |
212 | the update and returns.\r | |
213 | \r | |
214 | **/\r | |
215 | typedef\r | |
216 | EFI_STATUS\r | |
217 | (EFIAPI *EFI_FIRMWARE_MANAGEMENT_UPDATE_IMAGE_PROGRESS)(\r | |
218 | IN UINTN Completion\r | |
219 | );\r | |
220 | \r | |
221 | /**\r | |
222 | Returns information about the current firmware image(s) of the device.\r | |
223 | \r | |
224 | This function allows a copy of the current firmware image to be created and saved.\r | |
225 | The saved copy could later been used, for example, in firmware image recovery or rollback.\r | |
226 | \r | |
227 | @param[in] This A pointer to the EFI_FIRMWARE_MANAGEMENT_PROTOCOL instance.\r | |
228 | @param[in, out] ImageInfoSize A pointer to the size, in bytes, of the ImageInfo buffer. \r | |
229 | On input, this is the size of the buffer allocated by the caller.\r | |
230 | On output, it is the size of the buffer returned by the firmware \r | |
231 | if the buffer was large enough, or the size of the buffer needed\r | |
232 | to contain the image(s) information if the buffer was too small.\r | |
233 | @param[in, out] ImageInfo A pointer to the buffer in which firmware places the current image(s)\r | |
234 | information. The information is an array of EFI_FIRMWARE_IMAGE_DESCRIPTORs.\r | |
235 | @param[out] DescriptorVersion A pointer to the location in which firmware returns the version number\r | |
236 | associated with the EFI_FIRMWARE_IMAGE_DESCRIPTOR. \r | |
237 | @param[out] DescriptorCount A pointer to the location in which firmware returns the number of\r | |
238 | descriptors or firmware images within this device.\r | |
239 | @param[out] DescriptorSize A pointer to the location in which firmware returns the size, in bytes,\r | |
240 | of an individual EFI_FIRMWARE_IMAGE_DESCRIPTOR.\r | |
241 | @param[out] PackageVersion A version number that represents all the firmware images in the device.\r | |
242 | The format is vendor specific and new version must have a greater value\r | |
243 | than the old version. If PackageVersion is not supported, the value is\r | |
244 | 0xFFFFFFFF. A value of 0xFFFFFFFE indicates that package version comparison\r | |
245 | is to be performed using PackageVersionName. A value of 0xFFFFFFFD indicates\r | |
246 | that package version update is in progress.\r | |
4f077902 | 247 | @param[out] PackageVersionName A pointer to a pointer to a null-terminated string representing the\r |
252b9c7a | 248 | package version name. The buffer is allocated by this function with \r |
249 | AllocatePool(), and it is the caller's responsibility to free it with a call\r | |
250 | to FreePool().\r | |
251 | \r | |
252 | @retval EFI_SUCCESS The device was successfully updated with the new image.\r | |
253 | @retval EFI_BUFFER_TOO_SMALL The ImageInfo buffer was too small. The current buffer size \r | |
254 | needed to hold the image(s) information is returned in ImageInfoSize. \r | |
255 | @retval EFI_INVALID_PARAMETER ImageInfoSize is NULL.\r | |
256 | @retval EFI_DEVICE_ERROR Valid information could not be returned. Possible corrupted image.\r | |
257 | \r | |
258 | **/ \r | |
259 | typedef\r | |
260 | EFI_STATUS\r | |
261 | (EFIAPI *EFI_FIRMWARE_MANAGEMENT_PROTOCOL_GET_IMAGE_INFO)(\r | |
262 | IN EFI_FIRMWARE_MANAGEMENT_PROTOCOL *This,\r | |
263 | IN OUT UINTN *ImageInfoSize,\r | |
264 | IN OUT EFI_FIRMWARE_IMAGE_DESCRIPTOR *ImageInfo,\r | |
265 | OUT UINT32 *DescriptorVersion,\r | |
266 | OUT UINT8 *DescriptorCount,\r | |
267 | OUT UINTN *DescriptorSize,\r | |
268 | OUT UINT32 *PackageVersion,\r | |
269 | OUT CHAR16 **PackageVersionName\r | |
270 | );\r | |
271 | \r | |
272 | /**\r | |
273 | Retrieves a copy of the current firmware image of the device. \r | |
274 | \r | |
275 | This function allows a copy of the current firmware image to be created and saved.\r | |
276 | The saved copy could later been used, for example, in firmware image recovery or rollback.\r | |
277 | \r | |
278 | @param[in] This A pointer to the EFI_FIRMWARE_MANAGEMENT_PROTOCOL instance.\r | |
279 | @param[in] ImageIndex A unique number identifying the firmware image(s) within the device.\r | |
280 | The number is between 1 and DescriptorCount.\r | |
281 | @param[out] Image Points to the buffer where the current image is copied to.\r | |
282 | @param[out] ImageSize On entry, points to the size of the buffer pointed to by Image, in bytes.\r | |
283 | On return, points to the length of the image, in bytes.\r | |
284 | \r | |
285 | @retval EFI_SUCCESS The device was successfully updated with the new image.\r | |
286 | @retval EFI_BUFFER_TOO_SMALL The buffer specified by ImageSize is too small to hold the \r | |
287 | image. The current buffer size needed to hold the image is returned \r | |
288 | in ImageSize.\r | |
289 | @retval EFI_INVALID_PARAMETER The Image was NULL.\r | |
290 | @retval EFI_NOT_FOUND The current image is not copied to the buffer.\r | |
291 | @retval EFI_UNSUPPORTED The operation is not supported.\r | |
292 | @retval EFI_SECURITY_VIOLATIO The operation could not be performed due to an authentication failure.\r | |
293 | \r | |
294 | **/ \r | |
295 | typedef\r | |
296 | EFI_STATUS\r | |
297 | (EFIAPI *EFI_FIRMWARE_MANAGEMENT_PROTOCOL_GET_IMAGE)(\r | |
298 | IN EFI_FIRMWARE_MANAGEMENT_PROTOCOL *This,\r | |
299 | IN UINT8 ImageIndex,\r | |
300 | IN OUT VOID *Image,\r | |
301 | IN OUT UINTN *ImageSize\r | |
302 | );\r | |
303 | \r | |
304 | /**\r | |
305 | Updates the firmware image of the device.\r | |
306 | \r | |
307 | This function updates the hardware with the new firmware image.\r | |
308 | This function returns EFI_UNSUPPORTED if the firmware image is not updatable.\r | |
309 | If the firmware image is updatable, the function should perform the following minimal validations\r | |
310 | before proceeding to do the firmware image update.\r | |
311 | - Validate the image authentication if image has attribute \r | |
312 | IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED. The function returns \r | |
313 | EFI_SECURITY_VIOLATION if the validation fails.\r | |
314 | - Validate the image is a supported image for this device. The function returns EFI_ABORTED if \r | |
315 | the image is unsupported. The function can optionally provide more detailed information on \r | |
316 | why the image is not a supported image.\r | |
317 | - Validate the data from VendorCode if not null. Image validation must be performed before \r | |
318 | VendorCode data validation. VendorCode data is ignored or considered invalid if image \r | |
319 | validation failed. The function returns EFI_ABORTED if the data is invalid.\r | |
320 | \r | |
321 | VendorCode enables vendor to implement vendor-specific firmware image update policy. Null if \r | |
322 | the caller did not specify the policy or use the default policy. As an example, vendor can implement \r | |
323 | a policy to allow an option to force a firmware image update when the abort reason is due to the new \r | |
324 | firmware image version is older than the current firmware image version or bad image checksum. \r | |
325 | Sensitive operations such as those wiping the entire firmware image and render the device to be\r | |
326 | non-functional should be encoded in the image itself rather than passed with the VendorCode.\r | |
327 | AbortReason enables vendor to have the option to provide a more detailed description of the abort\r | |
328 | reason to the caller.\r | |
329 | \r | |
330 | @param[in] This A pointer to the EFI_FIRMWARE_MANAGEMENT_PROTOCOL instance.\r | |
331 | @param[in] ImageIndex A unique number identifying the firmware image(s) within the device.\r | |
332 | The number is between 1 and DescriptorCount.\r | |
333 | @param[in] Image Points to the new image.\r | |
334 | @param[in] ImageSize Size of the new image in bytes.\r | |
335 | @param[in] VendorCode This enables vendor to implement vendor-specific firmware image update policy. \r | |
336 | Null indicates the caller did not specify the policy or use the default policy.\r | |
337 | @param[in] Progress A function used by the driver to report the progress of the firmware update.\r | |
4f077902 | 338 | @param[out] AbortReason A pointer to a pointer to a null-terminated string providing more\r |
252b9c7a | 339 | details for the aborted operation. The buffer is allocated by this function \r |
340 | with AllocatePool(), and it is the caller's responsibility to free it with a\r | |
341 | call to FreePool().\r | |
342 | \r | |
343 | @retval EFI_SUCCESS The device was successfully updated with the new image.\r | |
344 | @retval EFI_ABORTED The operation is aborted.\r | |
345 | @retval EFI_INVALID_PARAMETER The Image was NULL.\r | |
346 | @retval EFI_UNSUPPORTED The operation is not supported.\r | |
347 | @retval EFI_SECURITY_VIOLATIO The operation could not be performed due to an authentication failure.\r | |
348 | \r | |
349 | **/ \r | |
350 | typedef\r | |
351 | EFI_STATUS\r | |
352 | (EFIAPI *EFI_FIRMWARE_MANAGEMENT_PROTOCOL_SET_IMAGE)(\r | |
353 | IN EFI_FIRMWARE_MANAGEMENT_PROTOCOL *This,\r | |
354 | IN UINT8 ImageIndex,\r | |
355 | IN CONST VOID *Image,\r | |
356 | IN UINTN ImageSize,\r | |
357 | IN CONST VOID *VendorCode,\r | |
358 | IN EFI_FIRMWARE_MANAGEMENT_UPDATE_IMAGE_PROGRESS Progress,\r | |
359 | OUT CHAR16 **AbortReason\r | |
360 | );\r | |
361 | \r | |
362 | /**\r | |
363 | Checks if the firmware image is valid for the device.\r | |
364 | \r | |
365 | This function allows firmware update application to validate the firmware image without \r | |
366 | invoking the SetImage() first.\r | |
367 | \r | |
368 | @param[in] This A pointer to the EFI_FIRMWARE_MANAGEMENT_PROTOCOL instance.\r | |
369 | @param[in] ImageIndex A unique number identifying the firmware image(s) within the device.\r | |
370 | The number is between 1 and DescriptorCount.\r | |
371 | @param[in] Image Points to the new image.\r | |
372 | @param[in] ImageSize Size of the new image in bytes.\r | |
373 | @param[out] ImageUpdatable Indicates if the new image is valid for update. It also provides,\r | |
374 | if available, additional information if the image is invalid. \r | |
375 | \r | |
376 | @retval EFI_SUCCESS The image was successfully checked.\r | |
377 | @retval EFI_INVALID_PARAMETER The Image was NULL.\r | |
378 | @retval EFI_UNSUPPORTED The operation is not supported.\r | |
379 | @retval EFI_SECURITY_VIOLATIO The operation could not be performed due to an authentication failure.\r | |
380 | \r | |
381 | **/ \r | |
382 | typedef\r | |
383 | EFI_STATUS\r | |
384 | (EFIAPI *EFI_FIRMWARE_MANAGEMENT_PROTOCOL_CHECK_IMAGE)(\r | |
385 | IN EFI_FIRMWARE_MANAGEMENT_PROTOCOL *This,\r | |
386 | IN UINT8 ImageIndex,\r | |
387 | IN CONST VOID *Image,\r | |
388 | IN UINTN ImageSize,\r | |
389 | OUT UINT32 *ImageUpdatable\r | |
390 | );\r | |
391 | \r | |
392 | /**\r | |
393 | Returns information about the firmware package. \r | |
394 | \r | |
395 | This function returns package information.\r | |
396 | \r | |
397 | @param[in] This A pointer to the EFI_FIRMWARE_MANAGEMENT_PROTOCOL instance.\r | |
398 | @param[out] PackageVersion A version number that represents all the firmware images in the device.\r | |
399 | The format is vendor specific and new version must have a greater value\r | |
400 | than the old version. If PackageVersion is not supported, the value is\r | |
401 | 0xFFFFFFFF. A value of 0xFFFFFFFE indicates that package version\r | |
402 | comparison is to be performed using PackageVersionName. A value of\r | |
403 | 0xFFFFFFFD indicates that package version update is in progress.\r | |
4f077902 | 404 | @param[out] PackageVersionName A pointer to a pointer to a null-terminated string representing\r |
252b9c7a | 405 | the package version name. The buffer is allocated by this function with\r |
406 | AllocatePool(), and it is the caller's responsibility to free it with a\r | |
407 | call to FreePool().\r | |
408 | @param[out] PackageVersionNameMaxLen The maximum length of package version name if device supports update of\r | |
409 | package version name. A value of 0 indicates the device does not support\r | |
410 | update of package version name. Length is the number of Unicode characters,\r | |
411 | including the terminating null character.\r | |
412 | @param[out] AttributesSupported Package attributes that are supported by this device. See 'Package Attribute \r | |
413 | Definitions' for possible returned values of this parameter. A value of 1 \r | |
414 | indicates the attribute is supported and the current setting value is\r | |
415 | indicated in AttributesSetting. A value of 0 indicates the attribute is not\r | |
416 | supported and the current setting value in AttributesSetting is meaningless.\r | |
417 | @param[out] AttributesSetting Package attributes. See 'Package Attribute Definitions' for possible returned\r | |
418 | values of this parameter\r | |
419 | \r | |
420 | @retval EFI_SUCCESS The package information was successfully returned.\r | |
421 | @retval EFI_UNSUPPORTED The operation is not supported.\r | |
422 | \r | |
423 | **/\r | |
424 | typedef\r | |
425 | EFI_STATUS\r | |
426 | (EFIAPI *EFI_FIRMWARE_MANAGEMENT_PROTOCOL_GET_PACKAGE_INFO)(\r | |
427 | IN EFI_FIRMWARE_MANAGEMENT_PROTOCOL *This,\r | |
428 | OUT UINT32 *PackageVersion,\r | |
429 | OUT CHAR16 **PackageVersionName,\r | |
430 | OUT UINT32 *PackageVersionNameMaxLen,\r | |
431 | OUT UINT64 *AttributesSupported,\r | |
432 | OUT UINT64 *AttributesSetting\r | |
433 | );\r | |
434 | \r | |
435 | /**\r | |
436 | Updates information about the firmware package.\r | |
437 | \r | |
438 | This function updates package information.\r | |
439 | This function returns EFI_UNSUPPORTED if the package information is not updatable.\r | |
440 | VendorCode enables vendor to implement vendor-specific package information update policy.\r | |
441 | Null if the caller did not specify this policy or use the default policy.\r | |
442 | \r | |
443 | @param[in] This A pointer to the EFI_FIRMWARE_MANAGEMENT_PROTOCOL instance.\r | |
444 | @param[in] Image Points to the authentication image.\r | |
445 | Null if authentication is not required.\r | |
446 | @param[in] ImageSize Size of the authentication image in bytes.\r | |
447 | 0 if authentication is not required.\r | |
448 | @param[in] VendorCode This enables vendor to implement vendor-specific firmware\r | |
449 | image update policy. \r | |
450 | Null indicates the caller did not specify this policy or use\r | |
451 | the default policy.\r | |
452 | @param[in] PackageVersion The new package version.\r | |
453 | @param[in] PackageVersionName A pointer to the new null-terminated Unicode string representing\r | |
454 | the package version name. \r | |
455 | The string length is equal to or less than the value returned in \r | |
456 | PackageVersionNameMaxLen.\r | |
457 | \r | |
458 | @retval EFI_SUCCESS The device was successfully updated with the new package\r | |
459 | information.\r | |
460 | @retval EFI_INVALID_PARAMETER The PackageVersionName length is longer than the value \r | |
461 | returned in PackageVersionNameMaxLen.\r | |
462 | @retval EFI_UNSUPPORTED The operation is not supported.\r | |
463 | @retval EFI_SECURITY_VIOLATIO The operation could not be performed due to an authentication failure.\r | |
464 | \r | |
465 | **/\r | |
466 | typedef\r | |
467 | EFI_STATUS\r | |
468 | (EFIAPI *EFI_FIRMWARE_MANAGEMENT_PROTOCOL_SET_PACKAGE_INFO)(\r | |
469 | IN EFI_FIRMWARE_MANAGEMENT_PROTOCOL *This,\r | |
470 | IN CONST VOID *Image,\r | |
471 | IN UINTN ImageSize,\r | |
472 | IN CONST VOID *VendorCode,\r | |
473 | IN UINT32 PackageVersion,\r | |
474 | IN CONST CHAR16 *PackageVersionName\r | |
475 | );\r | |
476 | \r | |
477 | ///\r | |
478 | /// EFI_FIRMWARE_MANAGEMENT_PROTOCOL\r | |
479 | /// The protocol for managing firmware provides the following services.\r | |
480 | /// - Get the attributes of the current firmware image. Attributes include revision level.\r | |
481 | /// - Get a copy of the current firmware image. As an example, this service could be used by a \r | |
482 | /// management application to facilitate a firmware roll-back.\r | |
483 | /// - Program the device with a firmware image supplied by the user.\r | |
484 | /// - Label all the firmware images within a device with a single version.\r | |
485 | ///\r | |
486 | struct _EFI_FIRMWARE_MANAGEMENT_PROTOCOL {\r | |
487 | EFI_FIRMWARE_MANAGEMENT_PROTOCOL_GET_IMAGE_INFO GetImageInfo;\r | |
488 | EFI_FIRMWARE_MANAGEMENT_PROTOCOL_GET_IMAGE GetImage;\r | |
489 | EFI_FIRMWARE_MANAGEMENT_PROTOCOL_SET_IMAGE SetImage;\r | |
490 | EFI_FIRMWARE_MANAGEMENT_PROTOCOL_CHECK_IMAGE CheckImage;\r | |
491 | EFI_FIRMWARE_MANAGEMENT_PROTOCOL_GET_PACKAGE_INFO GetPackageInfo;\r | |
492 | EFI_FIRMWARE_MANAGEMENT_PROTOCOL_SET_PACKAGE_INFO SetPackageInfo;\r | |
493 | };\r | |
494 | \r | |
495 | extern EFI_GUID gEfiFirmwareManagementProtocolGuid;\r | |
496 | \r | |
497 | #endif\r |