Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Hao Wu <hao.a...@intel.com> Reviewed-by: Liming Gao <liming....@intel.com> Reviewed-by: Chao Zhang <chao.b.zh...@intel.com> --- MdePkg/Include/Guid/FmpCapsule.h | 14 +- MdePkg/Include/Protocol/FirmwareManagement.h | 214 +++++++++++++-------------- 2 files changed, 114 insertions(+), 114 deletions(-)
diff --git a/MdePkg/Include/Guid/FmpCapsule.h b/MdePkg/Include/Guid/FmpCapsule.h index 8c9ae6b..ccfb7c8 100644 --- a/MdePkg/Include/Guid/FmpCapsule.h +++ b/MdePkg/Include/Guid/FmpCapsule.h @@ -3,13 +3,13 @@ Management Protocol Copyright (c) 2013 - 2015, Intel Corporation. All rights reserved.<BR> - This program and the accompanying materials - are licensed and made available under the terms and conditions of the BSD License - which accompanies this distribution. The full text of the license may be found at - http://opensource.org/licenses/bsd-license.php + This program and the accompanying materials + are licensed and made available under the terms and conditions of the BSD License + which accompanies this distribution. The full text of the license may be found at + http://opensource.org/licenses/bsd-license.php - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: GUIDs defined in UEFI 2.4 spec. @@ -35,7 +35,7 @@ typedef struct { /// /// The number of drivers included in the capsule and the number of corresponding - /// offsets stored in ItemOffsetList array. + /// offsets stored in ItemOffsetList array. /// UINT16 EmbeddedDriverCount; diff --git a/MdePkg/Include/Protocol/FirmwareManagement.h b/MdePkg/Include/Protocol/FirmwareManagement.h index c4191a9..7425d69 100644 --- a/MdePkg/Include/Protocol/FirmwareManagement.h +++ b/MdePkg/Include/Protocol/FirmwareManagement.h @@ -1,25 +1,25 @@ /** @file UEFI Firmware Management Protocol definition - Firmware Management Protocol provides an abstraction for device to provide firmware - management support. The base requirements for managing device firmware images include + Firmware Management Protocol provides an abstraction for device to provide firmware + management support. The base requirements for managing device firmware images include identifying firmware image revision level and programming the image into the device. - GetImageInfo() is the only required function. GetImage(), SetImage(), - CheckImage(), GetPackageInfo(), and SetPackageInfo() shall return + GetImageInfo() is the only required function. GetImage(), SetImage(), + CheckImage(), GetPackageInfo(), and SetPackageInfo() shall return EFI_UNSUPPORTED if not supported by the driver. - + Copyright (c) 2009 - 2015, Intel Corporation. All rights reserved.<BR> - Copyright (c) 2013 - 2014, Hewlett-Packard Development Company, L.P.<BR> - This program and the accompanying materials - are licensed and made available under the terms and conditions of the BSD License - which accompanies this distribution. The full text of the license may be found at - http://opensource.org/licenses/bsd-license.php + Copyright (c) 2013 - 2014, Hewlett-Packard Development Company, L.P.<BR> + This program and the accompanying materials + are licensed and made available under the terms and conditions of the BSD License + which accompanies this distribution. The full text of the license may be found at + http://opensource.org/licenses/bsd-license.php - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. - @par Revision Reference: - This Protocol is introduced in UEFI Specification 2.3 + @par Revision Reference: + This Protocol is introduced in UEFI Specification 2.3 **/ @@ -38,53 +38,53 @@ typedef struct _EFI_FIRMWARE_MANAGEMENT_PROTOCOL EFI_FIRMWARE_MANAGEMENT_PROTOCO /// EFI_FIRMWARE_IMAGE_DESCRIPTOR /// typedef struct { - /// - /// A unique number identifying the firmware image within the device. The number is + /// + /// A unique number identifying the firmware image within the device. The number is /// between 1 and DescriptorCount. - /// + /// UINT8 ImageIndex; /// /// A unique GUID identifying the firmware image type. /// EFI_GUID ImageTypeId; - /// - /// A unique number identifying the firmware image. - /// + /// + /// A unique number identifying the firmware image. + /// UINT64 ImageId; - /// - /// A pointer to a null-terminated string representing the firmware image name. - /// + /// + /// A pointer to a null-terminated string representing the firmware image name. + /// CHAR16 *ImageIdName; - /// - /// Identifies the version of the device firmware. The format is vendor specific and new + /// + /// Identifies the version of the device firmware. The format is vendor specific and new /// version must have a greater value than an old version. - /// + /// UINT32 Version; - /// + /// /// A pointer to a null-terminated string representing the firmware image version name. - /// + /// CHAR16 *VersionName; - /// - /// Size of the image in bytes. If size=0, then only ImageIndex and ImageTypeId are valid. - /// + /// + /// Size of the image in bytes. If size=0, then only ImageIndex and ImageTypeId are valid. + /// UINTN Size; - /// - /// Image attributes that are supported by this device. See 'Image Attribute Definitions' - /// for possible returned values of this parameter. A value of 1 indicates the attribute is - /// supported and the current setting value is indicated in AttributesSetting. A - /// value of 0 indicates the attribute is not supported and the current setting value in + /// + /// Image attributes that are supported by this device. See 'Image Attribute Definitions' + /// for possible returned values of this parameter. A value of 1 indicates the attribute is + /// supported and the current setting value is indicated in AttributesSetting. A + /// value of 0 indicates the attribute is not supported and the current setting value in /// AttributesSetting is meaningless. - /// + /// UINT64 AttributesSupported; - /// - /// Image attributes. See 'Image Attribute Definitions' for possible returned values of + /// + /// Image attributes. See 'Image Attribute Definitions' for possible returned values of /// this parameter. - /// + /// UINT64 AttributesSetting; - /// - /// Image compatibilities. See 'Image Compatibility Definitions' for possible returned + /// + /// Image compatibilities. See 'Image Compatibility Definitions' for possible returned /// values of this parameter. - /// + /// UINT64 Compatibilities; /// /// Describes the lowest ImageDescriptor version that the device will accept. Only @@ -124,26 +124,26 @@ typedef struct { // Image Attribute Definitions // /// -/// The attribute IMAGE_ATTRIBUTE_IMAGE_UPDATABLE indicates this device supports firmware +/// The attribute IMAGE_ATTRIBUTE_IMAGE_UPDATABLE indicates this device supports firmware /// image update. /// #define IMAGE_ATTRIBUTE_IMAGE_UPDATABLE 0x0000000000000001 /// -/// The attribute IMAGE_ATTRIBUTE_RESET_REQUIRED indicates a reset of the device is required -/// for the new firmware image to take effect after a firmware update. The device is the device hosting +/// The attribute IMAGE_ATTRIBUTE_RESET_REQUIRED indicates a reset of the device is required +/// for the new firmware image to take effect after a firmware update. The device is the device hosting /// the firmware image. -/// +/// #define IMAGE_ATTRIBUTE_RESET_REQUIRED 0x0000000000000002 /// -/// The attribute IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED indicates authentication is -/// required to perform the following image operations: GetImage(), SetImage(), and +/// The attribute IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED indicates authentication is +/// required to perform the following image operations: GetImage(), SetImage(), and /// CheckImage(). See 'Image Attribute - Authentication'. -/// +/// #define IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED 0x0000000000000004 /// -/// The attribute IMAGE_ATTRIBUTE_IN_USE indicates the current state of the firmware image. -/// This distinguishes firmware images in a device that supports redundant images. -/// +/// The attribute IMAGE_ATTRIBUTE_IN_USE indicates the current state of the firmware image. +/// This distinguishes firmware images in a device that supports redundant images. +/// #define IMAGE_ATTRIBUTE_IN_USE 0x0000000000000008 /// /// The attribute IMAGE_ATTRIBUTE_UEFI_IMAGE indicates that this image is an EFI compatible image. @@ -155,7 +155,7 @@ typedef struct { // Image Compatibility Definitions // /// Values from 0x0000000000000002 thru 0x000000000000FFFF are reserved for future assignments. -/// Values from 0x0000000000010000 thru 0xFFFFFFFFFFFFFFFF are used by firmware vendor for +/// Values from 0x0000000000010000 thru 0xFFFFFFFFFFFFFFFF are used by firmware vendor for /// compatibility check. /// #define IMAGE_COMPATIBILITY_CHECK_SUPPORTED 0x0000000000000001 @@ -171,14 +171,14 @@ typedef struct { /// typedef struct { /// - /// It is included in the signature of AuthInfo. It is used to ensure freshness/no replay. - /// It is incremented during each firmware image operation. - /// + /// It is included in the signature of AuthInfo. It is used to ensure freshness/no replay. + /// It is incremented during each firmware image operation. + /// UINT64 MonotonicCount; /// - /// Provides the authorization for the firmware image operations. It is a signature across - /// the image data and the Monotonic Count value. Caller uses the private key that is - /// associated with a public key that has been provisioned via the key exchange. + /// Provides the authorization for the firmware image operations. It is a signature across + /// the image data and the Monotonic Count value. Caller uses the private key that is + /// associated with a public key that has been provisioned via the key exchange. /// Because this is defined as a signature, WIN_CERTIFICATE_UEFI_GUID.CertType must /// be EFI_CERT_TYPE_PKCS7_GUID. /// @@ -190,24 +190,24 @@ typedef struct { // ImageUpdatable Definitions // /// -/// IMAGE_UPDATABLE_VALID indicates SetImage() will accept the new image and update the +/// IMAGE_UPDATABLE_VALID indicates SetImage() will accept the new image and update the /// device with the new image. /// #define IMAGE_UPDATABLE_VALID 0x0000000000000001 /// -/// IMAGE_UPDATABLE_INVALID indicates SetImage() will reject the new image. No additional +/// IMAGE_UPDATABLE_INVALID indicates SetImage() will reject the new image. No additional /// information is provided for the rejection. /// #define IMAGE_UPDATABLE_INVALID 0x0000000000000002 /// -/// IMAGE_UPDATABLE_INVALID_TYPE indicates SetImage() will reject the new image. The +/// IMAGE_UPDATABLE_INVALID_TYPE indicates SetImage() will reject the new image. The /// rejection is due to the new image is not a firmware image recognized for this device. /// #define IMAGE_UPDATABLE_INVALID_TYPE 0x0000000000000004 /// -/// IMAGE_UPDATABLE_INVALID_OLD indicates SetImage() will reject the new image. The +/// IMAGE_UPDATABLE_INVALID_OLD indicates SetImage() will reject the new image. The /// rejection is due to the new image version is older than the current firmware image -/// version in the device. The device firmware update policy does not support firmware +/// version in the device. The device firmware update policy does not support firmware /// version downgrade. /// #define IMAGE_UPDATABLE_INVALID_OLD 0x0000000000000008 @@ -217,26 +217,26 @@ typedef struct { // Package Attribute Definitions // /// -/// The attribute PACKAGE_ATTRIBUTE_VERSION_UPDATABLE indicates this device supports the +/// The attribute PACKAGE_ATTRIBUTE_VERSION_UPDATABLE indicates this device supports the /// update of the firmware package version. /// #define PACKAGE_ATTRIBUTE_VERSION_UPDATABLE 0x0000000000000001 /// -/// The attribute PACKAGE_ATTRIBUTE_RESET_REQUIRED indicates a reset of the device is +/// The attribute PACKAGE_ATTRIBUTE_RESET_REQUIRED indicates a reset of the device is /// required for the new package info to take effect after an update. /// #define PACKAGE_ATTRIBUTE_RESET_REQUIRED 0x0000000000000002 /// -/// The attribute PACKAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED indicates authentication +/// The attribute PACKAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED indicates authentication /// is required to update the package info. /// #define PACKAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED 0x0000000000000004 -/** +/** Callback funtion to report the process of the firmware updating. @param[in] Completion A value between 1 and 100 indicating the current completion - progress of the firmware update. Completion progress is + progress of the firmware update. Completion progress is reported as from 1 to 100 percent. A value of 0 is used by the driver to indicate that progress reporting is not supported. @@ -258,15 +258,15 @@ EFI_STATUS The saved copy could later been used, for example, in firmware image recovery or rollback. @param[in] This A pointer to the EFI_FIRMWARE_MANAGEMENT_PROTOCOL instance. - @param[in, out] ImageInfoSize A pointer to the size, in bytes, of the ImageInfo buffer. + @param[in, out] ImageInfoSize A pointer to the size, in bytes, of the ImageInfo buffer. On input, this is the size of the buffer allocated by the caller. - On output, it is the size of the buffer returned by the firmware + On output, it is the size of the buffer returned by the firmware if the buffer was large enough, or the size of the buffer needed to contain the image(s) information if the buffer was too small. @param[in, out] ImageInfo A pointer to the buffer in which firmware places the current image(s) information. The information is an array of EFI_FIRMWARE_IMAGE_DESCRIPTORs. @param[out] DescriptorVersion A pointer to the location in which firmware returns the version number - associated with the EFI_FIRMWARE_IMAGE_DESCRIPTOR. + associated with the EFI_FIRMWARE_IMAGE_DESCRIPTOR. @param[out] DescriptorCount A pointer to the location in which firmware returns the number of descriptors or firmware images within this device. @param[out] DescriptorSize A pointer to the location in which firmware returns the size, in bytes, @@ -278,17 +278,17 @@ EFI_STATUS is to be performed using PackageVersionName. A value of 0xFFFFFFFD indicates that package version update is in progress. @param[out] PackageVersionName A pointer to a pointer to a null-terminated string representing the - package version name. The buffer is allocated by this function with + package version name. The buffer is allocated by this function with AllocatePool(), and it is the caller's responsibility to free it with a call to FreePool(). @retval EFI_SUCCESS The device was successfully updated with the new image. - @retval EFI_BUFFER_TOO_SMALL The ImageInfo buffer was too small. The current buffer size - needed to hold the image(s) information is returned in ImageInfoSize. + @retval EFI_BUFFER_TOO_SMALL The ImageInfo buffer was too small. The current buffer size + needed to hold the image(s) information is returned in ImageInfoSize. @retval EFI_INVALID_PARAMETER ImageInfoSize is NULL. @retval EFI_DEVICE_ERROR Valid information could not be returned. Possible corrupted image. -**/ +**/ typedef EFI_STATUS (EFIAPI *EFI_FIRMWARE_MANAGEMENT_PROTOCOL_GET_IMAGE_INFO)( @@ -303,7 +303,7 @@ EFI_STATUS ); /** - Retrieves a copy of the current firmware image of the device. + Retrieves a copy of the current firmware image of the device. This function allows a copy of the current firmware image to be created and saved. The saved copy could later been used, for example, in firmware image recovery or rollback. @@ -316,15 +316,15 @@ EFI_STATUS On return, points to the length of the image, in bytes. @retval EFI_SUCCESS The device was successfully updated with the new image. - @retval EFI_BUFFER_TOO_SMALL The buffer specified by ImageSize is too small to hold the - image. The current buffer size needed to hold the image is returned + @retval EFI_BUFFER_TOO_SMALL The buffer specified by ImageSize is too small to hold the + image. The current buffer size needed to hold the image is returned in ImageSize. @retval EFI_INVALID_PARAMETER The Image was NULL. @retval EFI_NOT_FOUND The current image is not copied to the buffer. @retval EFI_UNSUPPORTED The operation is not supported. @retval EFI_SECURITY_VIOLATIO The operation could not be performed due to an authentication failure. -**/ +**/ typedef EFI_STATUS (EFIAPI *EFI_FIRMWARE_MANAGEMENT_PROTOCOL_GET_IMAGE)( @@ -341,20 +341,20 @@ EFI_STATUS This function returns EFI_UNSUPPORTED if the firmware image is not updatable. If the firmware image is updatable, the function should perform the following minimal validations before proceeding to do the firmware image update. - - Validate the image authentication if image has attribute - IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED. The function returns + - Validate the image authentication if image has attribute + IMAGE_ATTRIBUTE_AUTHENTICATION_REQUIRED. The function returns EFI_SECURITY_VIOLATION if the validation fails. - - Validate the image is a supported image for this device. The function returns EFI_ABORTED if - the image is unsupported. The function can optionally provide more detailed information on + - Validate the image is a supported image for this device. The function returns EFI_ABORTED if + the image is unsupported. The function can optionally provide more detailed information on why the image is not a supported image. - - Validate the data from VendorCode if not null. Image validation must be performed before - VendorCode data validation. VendorCode data is ignored or considered invalid if image - validation failed. The function returns EFI_ABORTED if the data is invalid. - - VendorCode enables vendor to implement vendor-specific firmware image update policy. Null if - the caller did not specify the policy or use the default policy. As an example, vendor can implement - a policy to allow an option to force a firmware image update when the abort reason is due to the new - firmware image version is older than the current firmware image version or bad image checksum. + - Validate the data from VendorCode if not null. Image validation must be performed before + VendorCode data validation. VendorCode data is ignored or considered invalid if image + validation failed. The function returns EFI_ABORTED if the data is invalid. + + VendorCode enables vendor to implement vendor-specific firmware image update policy. Null if + the caller did not specify the policy or use the default policy. As an example, vendor can implement + a policy to allow an option to force a firmware image update when the abort reason is due to the new + firmware image version is older than the current firmware image version or bad image checksum. Sensitive operations such as those wiping the entire firmware image and render the device to be non-functional should be encoded in the image itself rather than passed with the VendorCode. AbortReason enables vendor to have the option to provide a more detailed description of the abort @@ -365,11 +365,11 @@ EFI_STATUS The number is between 1 and DescriptorCount. @param[in] Image Points to the new image. @param[in] ImageSize Size of the new image in bytes. - @param[in] VendorCode This enables vendor to implement vendor-specific firmware image update policy. + @param[in] VendorCode This enables vendor to implement vendor-specific firmware image update policy. Null indicates the caller did not specify the policy or use the default policy. @param[in] Progress A function used by the driver to report the progress of the firmware update. @param[out] AbortReason A pointer to a pointer to a null-terminated string providing more - details for the aborted operation. The buffer is allocated by this function + details for the aborted operation. The buffer is allocated by this function with AllocatePool(), and it is the caller's responsibility to free it with a call to FreePool(). @@ -379,7 +379,7 @@ EFI_STATUS @retval EFI_UNSUPPORTED The operation is not supported. @retval EFI_SECURITY_VIOLATIO The operation could not be performed due to an authentication failure. -**/ +**/ typedef EFI_STATUS (EFIAPI *EFI_FIRMWARE_MANAGEMENT_PROTOCOL_SET_IMAGE)( @@ -395,7 +395,7 @@ EFI_STATUS /** Checks if the firmware image is valid for the device. - This function allows firmware update application to validate the firmware image without + This function allows firmware update application to validate the firmware image without invoking the SetImage() first. @param[in] This A pointer to the EFI_FIRMWARE_MANAGEMENT_PROTOCOL instance. @@ -404,14 +404,14 @@ EFI_STATUS @param[in] Image Points to the new image. @param[in] ImageSize Size of the new image in bytes. @param[out] ImageUpdatable Indicates if the new image is valid for update. It also provides, - if available, additional information if the image is invalid. + if available, additional information if the image is invalid. @retval EFI_SUCCESS The image was successfully checked. @retval EFI_INVALID_PARAMETER The Image was NULL. @retval EFI_UNSUPPORTED The operation is not supported. @retval EFI_SECURITY_VIOLATIO The operation could not be performed due to an authentication failure. -**/ +**/ typedef EFI_STATUS (EFIAPI *EFI_FIRMWARE_MANAGEMENT_PROTOCOL_CHECK_IMAGE)( @@ -423,7 +423,7 @@ EFI_STATUS ); /** - Returns information about the firmware package. + Returns information about the firmware package. This function returns package information. @@ -442,8 +442,8 @@ EFI_STATUS package version name. A value of 0 indicates the device does not support update of package version name. Length is the number of Unicode characters, including the terminating null character. - @param[out] AttributesSupported Package attributes that are supported by this device. See 'Package Attribute - Definitions' for possible returned values of this parameter. A value of 1 + @param[out] AttributesSupported Package attributes that are supported by this device. See 'Package Attribute + Definitions' for possible returned values of this parameter. A value of 1 indicates the attribute is supported and the current setting value is indicated in AttributesSetting. A value of 0 indicates the attribute is not supported and the current setting value in AttributesSetting is meaningless. @@ -479,18 +479,18 @@ EFI_STATUS @param[in] ImageSize Size of the authentication image in bytes. 0 if authentication is not required. @param[in] VendorCode This enables vendor to implement vendor-specific firmware - image update policy. + image update policy. Null indicates the caller did not specify this policy or use the default policy. @param[in] PackageVersion The new package version. @param[in] PackageVersionName A pointer to the new null-terminated Unicode string representing - the package version name. - The string length is equal to or less than the value returned in + the package version name. + The string length is equal to or less than the value returned in PackageVersionNameMaxLen. @retval EFI_SUCCESS The device was successfully updated with the new package information. - @retval EFI_INVALID_PARAMETER The PackageVersionName length is longer than the value + @retval EFI_INVALID_PARAMETER The PackageVersionName length is longer than the value returned in PackageVersionNameMaxLen. @retval EFI_UNSUPPORTED The operation is not supported. @retval EFI_SECURITY_VIOLATIO The operation could not be performed due to an authentication failure. @@ -511,7 +511,7 @@ EFI_STATUS /// EFI_FIRMWARE_MANAGEMENT_PROTOCOL /// The protocol for managing firmware provides the following services. /// - Get the attributes of the current firmware image. Attributes include revision level. -/// - Get a copy of the current firmware image. As an example, this service could be used by a +/// - Get a copy of the current firmware image. As an example, this service could be used by a /// management application to facilitate a firmware roll-back. /// - Program the device with a firmware image supplied by the user. /// - Label all the firmware images within a device with a single version. -- 1.9.5.msysgit.0 ------------------------------------------------------------------------------ One dashboard for servers and applications across Physical-Virtual-Cloud Widest out-of-the-box monitoring support with 50+ applications Performance metrics, stats and reports that give you Actionable Insights Deep dive visibility with transaction tracing using APM Insight. http://ad.doubleclick.net/ddm/clk/290420510;117567292;y _______________________________________________ edk2-devel mailing list edk2-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/edk2-devel
