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