FmpDevicePkg[all]  0.1
 All Data Structures Files Functions Variables Typedefs Macros Pages
Functions
CapsuleUpdatePolicyLib.h File Reference

Functions

EFI_STATUS EFIAPI CheckSystemPower (OUT BOOLEAN *Good)
 
EFI_STATUS EFIAPI CheckSystemThermal (OUT BOOLEAN *Good)
 
EFI_STATUS EFIAPI CheckSystemEnvironment (OUT BOOLEAN *Good)
 
BOOLEAN EFIAPI IsLowestSupportedVersionCheckRequired (VOID)
 
BOOLEAN EFIAPI IsLockFmpDeviceAtLockEventGuidRequired (VOID)
 

Detailed Description

Provides platform policy services used during a capsule update.

Copyright (c) 2016, Microsoft Corporation. All rights reserved.
Copyright (c) 2018, Intel Corporation. All rights reserved.

SPDX-License-Identifier: BSD-2-Clause-Patent

Function Documentation

EFI_STATUS EFIAPI CheckSystemEnvironment ( OUT BOOLEAN *  Good)

Determines if the system environment state supports a capsule update.

Parameters
[out]GoodReturns TRUE if system environment state supports a capsule update. Returns FALSE if system environment state does not support a capsule update. Return value is only valid if return status is EFI_SUCCESS.
Return values
EFI_SUCCESSGood parameter has been updated with result.
EFI_INVALID_PARAMETERGood is NULL.
EFI_DEVICE_ERRORSystem environment state can not be determined.
EFI_STATUS EFIAPI CheckSystemPower ( OUT BOOLEAN *  Good)

Determine if the system power state supports a capsule update.

Parameters
[out]GoodReturns TRUE if system power state supports a capsule update. Returns FALSE if system power state does not support a capsule update. Return value is only valid if return status is EFI_SUCCESS.
Return values
EFI_SUCCESSGood parameter has been updated with result.
EFI_INVALID_PARAMETERGood is NULL.
EFI_DEVICE_ERRORSystem power state can not be determined.
EFI_STATUS EFIAPI CheckSystemThermal ( OUT BOOLEAN *  Good)

Determines if the system thermal state supports a capsule update.

Parameters
[out]GoodReturns TRUE if system thermal state supports a capsule update. Returns FALSE if system thermal state does not support a capsule update. Return value is only valid if return status is EFI_SUCCESS.
Return values
EFI_SUCCESSGood parameter has been updated with result.
EFI_INVALID_PARAMETERGood is NULL.
EFI_DEVICE_ERRORSystem thermal state can not be determined.
BOOLEAN EFIAPI IsLockFmpDeviceAtLockEventGuidRequired ( VOID  )

Determines if the FMP device should be locked when the event specified by PcdFmpDeviceLockEventGuid is signaled. The expected result from this function is TRUE so the FMP device is always locked. A platform can choose to return FALSE (e.g. during manufacturing) to allow FMP devices to remain unlocked.

Return values
TRUEThe FMP device lock action is required at lock event guid.
FALSEDo not perform FMP device lock at lock event guid.
BOOLEAN EFIAPI IsLowestSupportedVersionCheckRequired ( VOID  )

Determines if the Lowest Supported Version checks should be performed. The expected result from this function is TRUE. A platform can choose to return FALSE (e.g. during manufacturing or servicing) to allow a capsule update to a version below the current Lowest Supported Version.

Return values
TRUEThe lowest supported version check is required.
FALSEDo not perform lowest support version check.