a6d73269b1
Cc: Michael D Kinney <michael.d.kinney@intel.com> Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Star Zeng <star.zeng@intel.com> Reviewed-by: Michael D Kinney <michael.d.kinney@intel.com>
121 lines
4.5 KiB
C
121 lines
4.5 KiB
C
/** @file
|
|
Provides platform policy services used during a capsule update.
|
|
|
|
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 __CAPSULE_UPDATE_POLICY_LIB__
|
|
#define __CAPSULE_UPDATE_POLICY_LIB__
|
|
|
|
/**
|
|
Determine if the system power state supports a capsule update.
|
|
|
|
@param[out] Good Returns 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.
|
|
|
|
@retval EFI_SUCCESS Good parameter has been updated with result.
|
|
@retval EFI_INVALID_PARAMETER Good is NULL.
|
|
@retval EFI_DEVICE_ERROR System power state can not be determined.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
CheckSystemPower (
|
|
OUT BOOLEAN *Good
|
|
);
|
|
|
|
/**
|
|
Determines if the system thermal state supports a capsule update.
|
|
|
|
@param[out] Good Returns 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.
|
|
|
|
@retval EFI_SUCCESS Good parameter has been updated with result.
|
|
@retval EFI_INVALID_PARAMETER Good is NULL.
|
|
@retval EFI_DEVICE_ERROR System thermal state can not be determined.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
CheckSystemThermal (
|
|
OUT BOOLEAN *Good
|
|
);
|
|
|
|
/**
|
|
Determines if the system environment state supports a capsule update.
|
|
|
|
@param[out] Good Returns 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.
|
|
|
|
@retval EFI_SUCCESS Good parameter has been updated with result.
|
|
@retval EFI_INVALID_PARAMETER Good is NULL.
|
|
@retval EFI_DEVICE_ERROR System environment state can not be determined.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
CheckSystemEnvironment (
|
|
OUT BOOLEAN *Good
|
|
);
|
|
|
|
/**
|
|
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.
|
|
|
|
@retval TRUE The lowest supported version check is required.
|
|
@retval FALSE Do not perform lowest support version check.
|
|
|
|
**/
|
|
BOOLEAN
|
|
EFIAPI
|
|
IsLowestSupportedVersionCheckRequired (
|
|
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.
|
|
|
|
@retval TRUE The FMP device lock action is required at lock event guid.
|
|
@retval FALSE Do not perform FMP device lock at lock event guid.
|
|
|
|
**/
|
|
BOOLEAN
|
|
EFIAPI
|
|
IsLockFmpDeviceAtLockEventGuidRequired (
|
|
VOID
|
|
);
|
|
|
|
#endif
|