sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

FmpDevicePkg: Add library instances

Browse Source 
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

Add library instances for FmpDeviceLib, CapsuleUpdatePolicyLib,
and FmpPayloadHeaderLib.

Library Classes
===============
* FmpDeviceLibNull - Non-functional template of the FmpDeviceLib
  that can be used as a starting point for an FmpDeviceLib for
  a specific firmware storage device.
* CapsuleUpdatePolicyLibNull - Functional template of the
  CapsuleUpdatePolicyLib that can be used as a starting point
  of a platform specific implementation.
* FmpPayloadHeaderLibV1 - Version 1 of the FmpPayloadHeaderLib.
  This library is indented 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>
This commit is contained in:
Kinney, Michael D
2018-04-04 10:27:21 -07:00
parent cec7b8fb86
commit 403d4bcdec
9 changed files with 948 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

188
FmpDevicePkg/Library/FmpPayloadHeaderLibV1/FmpPayloadHeaderLib.c Normal file
View File

@ -0,0 +1,188 @@
/** @file
Provides services to retrieve values from Version 1 of a capsule's FMP Payload
Header. The FMP Payload Header structure is not defined 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.
**/
#include <PiDxe.h>
#include <Library/FmpPayloadHeaderLib.h>
///
/// Define FMP Payload Header structure here so it is not public
///
#pragma pack(1)
typedef struct {
UINT32 Signature;
UINT32 HeaderSize;
UINT32 FwVersion;
UINT32 LowestSupportedVersion;
} FMP_PAYLOAD_HEADER;
#pragma pack()
///
/// Identifier is used to make sure the data in the header is for this structure
/// and version. If the structure changes update the last digit.
///
#define FMP_PAYLOAD_HEADER_SIGNATURE SIGNATURE_32 ('M', 'S', 'S', '1')
/**
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
)
{
FMP_PAYLOAD_HEADER *FmpPayloadHeader;
FmpPayloadHeader = NULL;
if (Header == NULL || Size == NULL) {
return EFI_INVALID_PARAMETER;
}
FmpPayloadHeader = (FMP_PAYLOAD_HEADER *)Header;
if ((UINTN)FmpPayloadHeader + sizeof (FMP_PAYLOAD_HEADER) < (UINTN)FmpPayloadHeader ||
(UINTN)FmpPayloadHeader + sizeof (FMP_PAYLOAD_HEADER) >= (UINTN)FmpPayloadHeader + FmpPayloadSize ||
FmpPayloadHeader->HeaderSize < sizeof (FMP_PAYLOAD_HEADER)) {
return EFI_INVALID_PARAMETER;
}
if (FmpPayloadHeader->Signature != FMP_PAYLOAD_HEADER_SIGNATURE) {
return EFI_INVALID_PARAMETER;
}
*Size = FmpPayloadHeader->HeaderSize;
return EFI_SUCCESS;
}
/**
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
)
{
FMP_PAYLOAD_HEADER *FmpPayloadHeader;
FmpPayloadHeader = NULL;
if (Header == NULL || Version == NULL) {
return EFI_INVALID_PARAMETER;
}
FmpPayloadHeader = (FMP_PAYLOAD_HEADER *)Header;
if ((UINTN)FmpPayloadHeader + sizeof (FMP_PAYLOAD_HEADER) < (UINTN)FmpPayloadHeader ||
(UINTN)FmpPayloadHeader + sizeof (FMP_PAYLOAD_HEADER) >= (UINTN)FmpPayloadHeader + FmpPayloadSize ||
FmpPayloadHeader->HeaderSize < sizeof (FMP_PAYLOAD_HEADER)) {
return EFI_INVALID_PARAMETER;
}
if (FmpPayloadHeader->Signature != FMP_PAYLOAD_HEADER_SIGNATURE) {
return EFI_INVALID_PARAMETER;
}
*Version = FmpPayloadHeader->FwVersion;
return EFI_SUCCESS;
}
/**
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
)
{
FMP_PAYLOAD_HEADER *FmpPayloadHeader;
FmpPayloadHeader = NULL;
if (Header == NULL || LowestSupportedVersion == NULL) {
return EFI_INVALID_PARAMETER;
}
FmpPayloadHeader = (FMP_PAYLOAD_HEADER *)Header;
if ((UINTN)FmpPayloadHeader + sizeof (FMP_PAYLOAD_HEADER) < (UINTN)FmpPayloadHeader ||
(UINTN)FmpPayloadHeader + sizeof (FMP_PAYLOAD_HEADER) >= (UINTN)FmpPayloadHeader + FmpPayloadSize ||
FmpPayloadHeader->HeaderSize < sizeof (FMP_PAYLOAD_HEADER)) {
return EFI_INVALID_PARAMETER;
}
if (FmpPayloadHeader->Signature != FMP_PAYLOAD_HEADER_SIGNATURE) {
return EFI_INVALID_PARAMETER;
}
*LowestSupportedVersion = FmpPayloadHeader->LowestSupportedVersion;
return EFI_SUCCESS;
}