FmpDevicePkg: Add FmpDxe module

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

The FmpDxe directory contains 2 INF files.  FmpDxe.inf
is a DXE driver that is used in a platform to add a
Firmware Management Protocol for firmware device that
supports firmware updates.

FmpDxeLib.inf is a NULL library instance with the exact
same functionality as FmpDxe.inf, but allows the the
Firmware Management Protocol feature to be added to
an existing device driver.

The FmpDxe component is intended to be used "as is"
with no need for any device specific or platform specific
changes.

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, 180 insertions, 0 deletions

diff --git a/FmpDevicePkg/FmpDxe/VariableSupport.h b/FmpDevicePkg/FmpDxe/VariableSupport.h
new file mode 100644
index 0000000..e7e34f5
--- /dev/null
+++ b/FmpDevicePkg/FmpDxe/VariableSupport.h
@@ -0,0 +1,180 @@
+/**  @file

+  UEFI variable support functions for Firmware Management Protocol based

+  firmware updates.

+

+  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 __VARIABLE_SUPPORT_H__

+#define __VARIABLE_SUPPORT_H__

+

+#define DEFAULT_VERSION                 0x1

+#define DEFAULT_LOWESTSUPPORTEDVERSION  0x0

+#define DEFAULT_LASTATTEMPT             0x0

+

+#define VARNAME_VERSION                 L"FmpVersion"

+#define VARNAME_LSV                     L"FmpLsv"

+

+#define VARNAME_LASTATTEMPTSTATUS       L"LastAttemptStatus"

+#define VARNAME_LASTATTEMPTVERSION      L"LastAttemptVersion"

+

+/**

+  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"FmpVersion"

+

+  @return  The version of the firmware image in the firmware device.

+

+**/

+UINT32

+GetVersionFromVariable (

+  VOID

+  );

+

+/**

+  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"FmpLsv"

+

+  @return  The lowest supported version of the firmware image in the firmware

+           device.

+

+**/

+UINT32

+GetLowestSupportedVersionFromVariable (

+  VOID

+  );

+

+/**

+  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"LastAttemptStatus"

+

+  @return  The last attempt status value for the most recent capsule update.

+

+**/

+UINT32

+GetLastAttemptStatusFromVariable (

+  VOID

+  );

+

+/**

+  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"LastAttemptVersion"

+

+  @return  The last attempt version value for the most recent capsule update.

+

+**/

+UINT32

+GetLastAttemptVersionFromVariable (

+  VOID

+  );

+

+/**

+  Saves the version current of the firmware image in the firmware device to a

+  UEFI variable.

+

+  UEFI Variable accessed: GUID = gEfiCallerIdGuid, Name = L"FmpVersion"

+

+  @param[in] Version  The version of the firmware image in the firmware device.

+

+**/

+VOID

+SetVersionInVariable (

+   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"FmpLsv"

+

+  @param[in] LowestSupported  The lowest supported version of the firmware image

+                              in the firmware device.

+

+**/

+VOID

+SetLowestSupportedVersionInVariable (

+   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"LastAttemptStatus"

+

+  @param[in] LastAttemptStatus  The last attempt status of the most recent FMP

+                                capsule update.

+

+**/

+VOID

+SetLastAttemptStatusInVariable (

+   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"LastAttemptVersion"

+

+  @param[in] LastAttemptVersion  The last attempt version value of the most

+                                 recent FMP capsule update.

+

+**/

+VOID

+SetLastAttemptVersionInVariable (

+   UINT32  LastAttemptVersion

+  );

+

+/**

+  Locks all the UEFI Variables that use gEfiCallerIdGuid of the currently

+  executing module.

+

+**/

+EFI_STATUS

+LockAllFmpVariables (

+  VOID

+  );

+

+#endif