FmpDevicePkg: Add package, library classes, and PCDs

https://bugzilla.tianocore.org/show_bug.cgi?id=922

Based on content from the following branch:

https://github.com/Microsoft/MS_UEFI/tree/share/MsCapsuleSupport/MsCapsuleUpdatePkg

Create FmpDevicePkg with library classes and PCDs used to
customize the behavior of a Firmware Management Protocol
instance.

Library Classes
===============
* FmpDeviceLib - Provides firmware device specific services
  to support updates of a firmware image stored in a firmware
  device.
* CapsuleUpdatePolicyLib - Provides platform policy services
  used during a capsule update.
* FmpPayloadHeaderLib - Provides services to retrieve values
  from a capsule's FMP Payload Header.  The structure is not
  included in the library class.  Instead, services are
  provided to retrieve information from the FMP Payload Header.
  If information is added to the FMP Payload Header, then new
  services may be added to this library class to retrieve the
  new information.

PCDs set per module
====================
* PcdFmpDeviceSystemResetRequired - Indicates if a full
  system reset is required before a firmware update to a
  firmware devices takes effect
* PcdFmpDeviceTestKeySha256Digest - The SHA-256 hash of a
  PKCS7 test key that is used to detect if a test key is
  being used to authenticate capsules.  Test key detection
  is disabled by setting the value to {0}.
* PcdFmpDeviceProgressColor - The color of the progress bar
  during a firmware update.
* PcdFmpDeviceImageIdName - The Null-terminated Unicode
  string used to fill in the ImageIdName field of the
  EFI_FIRMWARE_IMAGE_DESCRIPTOR structure that is returned
  by the GetImageInfo() service of the Firmware Management
  Protocol for the firmware device.
* PcdFmpDeviceBuildTimeLowestSupportedVersion - The build
  time 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.
* PcdFmpDeviceProgressWatchdogTimeInSeconds - The time in
  seconds to arm a watchdog timer during the update of a
  firmware device.

PCDs set per module or for entire platform
==========================================
* PcdFmpDevicePkcs7CertBufferXdr - One or more PKCS7
  certificates used to verify a firmware device capsule
  update image.
* PcdFmpDeviceLockEventGuid - An event GUID that locks
  the firmware device when the event is signaled.

Cc: Sean Brogan <sean.brogan@microsoft.com>
Cc: Jiewen Yao <jiewen.yao@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com>
Reviewed-by: Star Zeng <star.zeng@intel.com>

1 files changed, 100 insertions, 0 deletions

diff --git a/FmpDevicePkg/Include/Library/FmpPayloadHeaderLib.h b/FmpDevicePkg/Include/Library/FmpPayloadHeaderLib.h
new file mode 100644
index 0000000000..cb5622e9ce
--- /dev/null
+++ b/FmpDevicePkg/Include/Library/FmpPayloadHeaderLib.h
@@ -0,0 +1,100 @@
+/**  @file

+  Provides services to retrieve values from a capsule's FMP Payload Header.

+  The structure is not included in the library class.  Instead, services are

+  provided to retrieve information from the FMP Payload Header.  If information

+  is added to the FMP Payload Header, then new services may be added to this

+  library class to retrieve the new information.

+

+  Copyright (c) 2016, Microsoft Corporation. All rights reserved.<BR>

+  Copyright (c) 2018, Intel Corporation. All rights reserved.<BR>

+

+  Redistribution and use in source and binary forms, with or without

+  modification, are permitted provided that the following conditions are met:

+  1. Redistributions of source code must retain the above copyright notice,

+  this list of conditions and the following disclaimer.

+  2. Redistributions in binary form must reproduce the above copyright notice,

+  this list of conditions and the following disclaimer in the documentation

+  and/or other materials provided with the distribution.

+

+  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND

+  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

+  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.

+  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,

+  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,

+  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

+  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF

+  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE

+  OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF

+  ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

+

+**/

+

+#ifndef _FMP_PAYLOAD_HEADER_LIB_H__

+#define _FMP_PAYLOAD_HEADER_LIB_H__

+

+/**

+  Returns the FMP Payload Header size in bytes.

+

+  @param[in]  Header          FMP Payload Header to evaluate

+  @param[in]  FmpPayloadSize  Size of FMP payload

+  @param[out] Size            The size, in bytes, of the FMP Payload Header.

+

+  @retval EFI_SUCCESS            The firmware version was returned.

+  @retval EFI_INVALID_PARAMETER  Header is NULL.

+  @retval EFI_INVALID_PARAMETER  Size is NULL.

+  @retval EFI_INVALID_PARAMETER  Header is not a valid FMP Payload Header.

+

+**/

+EFI_STATUS

+EFIAPI

+GetFmpPayloadHeaderSize (

+  IN  CONST VOID   *Header,

+  IN  CONST UINTN  FmpPayloadSize,

+  OUT UINT32       *Size

+  );

+

+/**

+  Returns the version described in the FMP Payload Header.

+

+  @param[in]  Header          FMP Payload Header to evaluate

+  @param[in]  FmpPayloadSize  Size of FMP payload

+  @param[out] Version         The firmware version described in the FMP Payload

+                              Header.

+

+  @retval EFI_SUCCESS            The firmware version was returned.

+  @retval EFI_INVALID_PARAMETER  Header is NULL.

+  @retval EFI_INVALID_PARAMETER  Version is NULL.

+  @retval EFI_INVALID_PARAMETER  Header is not a valid FMP Payload Header.

+

+**/

+EFI_STATUS

+EFIAPI

+GetFmpPayloadHeaderVersion (

+  IN  CONST VOID   *Header,

+  IN  CONST UINTN  FmpPayloadSize,

+  OUT UINT32       *Version

+  );

+

+/**

+  Returns the lowest supported version described in the FMP Payload Header.

+

+  @param[in]  Header                  FMP Payload Header to evaluate

+  @param[in]  FmpPayloadSize          Size of FMP payload

+  @param[out] LowestSupportedVersion  The lowest supported version described in

+                                      the FMP Payload Header.

+

+  @retval EFI_SUCCESS            The lowest support version was returned.

+  @retval EFI_INVALID_PARAMETER  Header is NULL.

+  @retval EFI_INVALID_PARAMETER  LowestSupportedVersion is NULL.

+  @retval EFI_INVALID_PARAMETER  Header is not a valid FMP Payload Header.

+

+**/

+EFI_STATUS

+EFIAPI

+GetFmpPayloadHeaderLowestSupportedVersion (

+  IN     CONST VOID   *Header,

+  IN     CONST UINTN  FmpPayloadSize,

+  IN OUT UINT32       *LowestSupportedVersion

+  );

+

+#endif