CapsuleUpdatePolicyDxe.c File Reference

#include "CapsuleUpdatePolicyDxe.h"

Go to the source code of this file.

Functions
EFI_STATUS EFIAPI	CapsuleUpdatePolicyCheckSystemPower (IN EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL *This, OUT BOOLEAN *Good)
EFI_STATUS EFIAPI	CapsuleUpdatePolicyCheckSystemThermal (IN EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL *This, OUT BOOLEAN *Good)
EFI_STATUS EFIAPI	CapsuleUpdatePolicyCheckSystemEnvironment (IN EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL *This, OUT BOOLEAN *Good)
BOOLEAN EFIAPI	CapsuleUpdatePolicyIsLowestSupportedVersionCheckRequired (IN EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL *This)
BOOLEAN EFIAPI	CapsuleUpdatePolicyIsLockFmpDeviceAtLockEventGuidRequired (IN EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL *This)
EFI_STATUS EFIAPI	CapsuleUpdatePolicyInitialize (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)

Variables
EFI_HANDLE	mHandle = NULL
EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL	mCapsuleUpdatePolicy

Detailed Description

Provides platform policy services used during a capsule update that uses the services of the EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL.

Copyright (c) 2019, Intel Corporation. All rights reserved.

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

Definition in file CapsuleUpdatePolicyDxe.c.

Function Documentation

CapsuleUpdatePolicyCheckSystemEnvironment()

EFI_STATUS EFIAPI CapsuleUpdatePolicyCheckSystemEnvironment	(	IN EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL *	This,
		OUT BOOLEAN *	Good
	)

Determines if the system environment state supports a capsule update.

Parameters

[in]	This	A pointer to the EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL instance.
[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.

Return values

EFI_SUCCESS	Good parameter has been updated with result.
EFI_INVALID_PARAMETER	Good is NULL.
EFI_DEVICE_ERROR	System environment state can not be determined.

Definition at line 93 of file CapsuleUpdatePolicyDxe.c.

CapsuleUpdatePolicyCheckSystemPower()

EFI_STATUS EFIAPI CapsuleUpdatePolicyCheckSystemPower	(	IN EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL *	This,
		OUT BOOLEAN *	Good
	)

Determine if the system power state supports a capsule update.

Parameters

[in]	This	A pointer to the EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL instance.
[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.

Return values

EFI_SUCCESS	Good parameter has been updated with result.
EFI_INVALID_PARAMETER	Good is NULL.
EFI_DEVICE_ERROR	System power state can not be determined.

Definition at line 45 of file CapsuleUpdatePolicyDxe.c.

CapsuleUpdatePolicyCheckSystemThermal()

EFI_STATUS EFIAPI CapsuleUpdatePolicyCheckSystemThermal	(	IN EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL *	This,
		OUT BOOLEAN *	Good
	)

Determines if the system thermal state supports a capsule update.

Parameters

[in]	This	A pointer to the EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL instance.
[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.

Return values

EFI_SUCCESS	Good parameter has been updated with result.
EFI_INVALID_PARAMETER	Good is NULL.
EFI_DEVICE_ERROR	System thermal state can not be determined.

Definition at line 69 of file CapsuleUpdatePolicyDxe.c.

CapsuleUpdatePolicyInitialize()

EFI_STATUS EFIAPI CapsuleUpdatePolicyInitialize	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

The user Entry Point for module CapsuleUpdatePolicyDxe. The user code starts with this function.

Parameters

[in]	ImageHandle	The firmware allocated handle for the EFI image.
[in]	SystemTable	A pointer to the EFI System Table.

Return values

EFI_SUCCESS	The entry point is executed successfully.
other	Some error occurs when executing this entry point.

Definition at line 156 of file CapsuleUpdatePolicyDxe.c.

CapsuleUpdatePolicyIsLockFmpDeviceAtLockEventGuidRequired()

BOOLEAN EFIAPI CapsuleUpdatePolicyIsLockFmpDeviceAtLockEventGuidRequired

(

IN EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL *

This

)

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.

Parameters

[in]

This

A pointer to the EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL instance.

Return values

TRUE	The FMP device lock action is required at lock event guid.
FALSE	Do not perform FMP device lock at lock event guid.

Definition at line 136 of file CapsuleUpdatePolicyDxe.c.

CapsuleUpdatePolicyIsLowestSupportedVersionCheckRequired()

BOOLEAN EFIAPI CapsuleUpdatePolicyIsLowestSupportedVersionCheckRequired

(

IN EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL *

This

)

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.

Parameters

[in]

This

A pointer to the EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL instance.

Return values

TRUE	The lowest supported version check is required.
FALSE	Do not perform lowest support version check.

Definition at line 115 of file CapsuleUpdatePolicyDxe.c.

Variable Documentation

mCapsuleUpdatePolicy

EDKII_CAPSULE_UPDATE_POLICY_PROTOCOL mCapsuleUpdatePolicy

Initial value:

= {
  CapsuleUpdatePolicyCheckSystemPower,
  CapsuleUpdatePolicyCheckSystemThermal,
  CapsuleUpdatePolicyCheckSystemEnvironment,
  CapsuleUpdatePolicyIsLowestSupportedVersionCheckRequired,
  CapsuleUpdatePolicyIsLockFmpDeviceAtLockEventGuidRequired
}

Capsule Update Policy Protocol instance

Definition at line 21 of file CapsuleUpdatePolicyDxe.c.

mHandle

EFI_HANDLE mHandle = NULL

Handle for the Capsule Update Policy Protocol

Definition at line 16 of file CapsuleUpdatePolicyDxe.c.